View source for UL/SPF 707 installation



<p class="warn" style="font-size:110%"><b>Note:</b> <i>In the version of this product that follows 801, the product is renamed to [[RKTools]], the version number is changed to 7.5 to depend on its corresponding Model&nbsp;204 version, and the installation documentation is [[RKTools installation]].</i></p>


<var class="product">[[UL/SPF]]</var> (the User Language System Productivity Facilities) is a set of application subsystems (aka APSYs) running inside a <var class="product">Model 204</var> Online that provide full-screen and web-based tools to aid programmers, DBAs, and system managers to handle the complexities of <var class="product">User Language</var> and file and system management.

Installing <var class="product">UL/SPF</var> requires downloading the <code>SIRIUS</code> file and restoring it to your environment, setting up some subsidiary <var class="product">Model 204</var> files, and verifying that the environment has the appropriate parameter settings.

Upgrades to <var class="product">UL/SPF</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file. <br/><br/>

==A summary of the UL/SPF installation steps==
The following checklist specifies in brief the steps to follow installing
<var class="product">UL/SPF</var>, whether for MVS or CMS.
The sections [[#Installing UL/SPF under CMS|Installing UL/SPF under CMS]] and [[#Installing UL/SPF under MVS|Installing UL/SPF under MVS]] describe these steps in greater detail for each operating system.
<ol>
<li>Install and link the <var class="product">Sirius Mods</var> as described in the <var class="book">[[Media:SiriNew.pdf|Sirius Mods Installation Guide]]</var>.
<var class="product">UL/SPF</var> requires a matching or greater version number of the <var class="product">Sirius Mods</var>. </li>

<li>Allocate the space required for the <code>SIRIUS</code> data set,
and <var>RESTORE</var> it from tape, where they are stored in <var>DUMP</var>
format, or from the <var>DUMP</var> files found on the website.
<p>
In addition, there may be any number of other data sets required for
the <var class="product">UL/SPF</var> components you are installing.
These are listed in [[#Installation checklist (CMS)|Installation checklist (CMS)]] and [[#Installation checklist (MVS)|Installation checklist (MVS)]]. </p> </li>
 
<li>Update the Online JCL or EXEC:
<ul>
<li>Add the DD cards or FILEDEFs for the SIR<i>xxxxx</i> and/or JAN<i>xxx</i> files. </li>
 
<li>Verify that the <var>[[SYSOPT parameter|SYSOPT]]</var> parameter has the 1 and 2 bits set. </li>
</ul>
 
<li>Update CCAIN parameters:
<ul>
<li>Increase <var>[[NFILES parameter|NFILES]]</var>, <var>[[NDCBS parameter|NDCBS]]</var>, and <var>[[NDIR parameter|NDIR]]</var> for the SIR<i>xxxxx</i> and/or JAN<i>xxx</i> files. </li>
 
<li>Verify that <var>[[NORQS parameter|NORQS]]</var> is at least 5. </li>

<li>Verify the online has at least 10 [[Sdaemons|SDAEMON]] threads (each typically defined as an <var>IODEV15</var>). </li>
</ul> </li>
 
<li>Start the Online, using an <var>ONLINE</var> load module that contains the
<var class="product">Sirius Mods</var>. </li>
 
<li>Open file <code>SIRIUS</code> and execute the following command:
<p class="code">INCLUDE SETUP.EXE</p>
<p>
Follow the instructions on the installation screen (and in the Help
text for the screen).</p> </li>
 
<li>Add users to the appropriate SCLASSs for the UL/SPF APSYs. </li>
 
<li>Verify success of the installation by compiling each UL/SPF APSY. </li>
 
<li>Read [[#UL/SPF server size and additional customization|UL/SPF server size and additional customization]] to determine if additional APSY-specific customizations are required at your site. </li>

<li>Use the APSY named <var>SIRADMIN</var> to customize the <var class="product">UL/SPF</var> environment. </li>
</ol>

==Preparing for UL/SPF installation==  
The <var class="product">UL/SPF</var> products are implemented as <var class="product">Model 204</var> subsystems.  
The code for all the component subsystems resides in the file named <code>SIRIUS</code> which is typically downloaded from the product section of the website.
 
===Obtaining product installation files===
The files necessary for the installation are available either from
distribution tapes or from the Rocket Software website.
Downloading and installing from the website is generally easier, as you don't have to
wait for tapes to arrive and be cataloged onto your system.
 
To download product files from the Rocket website:
<ol>
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, select the [https://m204.rocketsoftware.com/maint/ullist?nickname=SIRIUS "Download SOUL files" link] in the "Downloads and Uploads" section to access the "SOUL files for Sirius Software Inc." page. 
<p class="note"><b>Note:</b>
Eventually you can also access the "SOUL files for Sirius Software Inc." page from the Rocket Customer Portal (RCP) accessed via the Support section of the Rocket website. </p></li>

<li>After providing your registered customer login information, download the latest version of the <code>SIRIUS</code> file (which is labeled "All UL/SPF
products in one file" followed by a version number).
<p>
A "Click here" link on this page provides Help on downloading format, some information about
different browser behaviors, file sizing information, and more.</p></li>
</ol>

<p class="note"><b>Note:</b> Re-installing <var class="product">UL/SPF</var> typically involves nothing more than downloading and restoring a new version of the <code>SIRIUS</code> file. </p>

===Determining eligible products===
To download files or maintenance from the Rocket M204 Customer Care area of the Rocket website, you must have a registered Sirius user ID ([[Contacting Rocket Software Technical Support|contact Technical Support]] if you need an ID).
The website will show only products for which your organization is up to date on maintenance or rental payments.
If a product does not appear on your download page and you believe it should,
contact Technical Support.

If you are working from a distribution tape, files for products
not purchased by your organization will be present but empty on the installation tape.
 
Any step of the installation process may be bypassed if it
applies only to a <var class="product">UL/SPF</var> module you are not
installing.
 
===System requirements===
<ul>
<li><var class="product">UL/SPF</var> operates in a <var class="product">Model 204</var> Online region.
<p> 
In the rest of this document, "Online" refers to a region of
<var class="product">Model 204</var> running an <var>ONLINE</var> load module containing the
<var class="product">Sirius Mods</var>.</p></li>
 
<li>Requirements for server sizes and parameter settings for each product are listed in [[#UL/SPF server size and additional customization|UL/SPF server size and additional customization]].</li>
 
<li><var class="product">Sirius Mods</var> custom methods and $functions must be activated.
<p>
The <var class="product">UL/SPF</var> products make extensive use of custom
$functions that are part of the <var class="product">Sirius Mods</var>.
Before continuing with installation, follow the instructions in the <var class="book">[[Media:SiriNew.pdf|Sirius Mods Installation Guide]]</var> to make the $functions active in the target Online.</p>
<p> 
To test that the <var class="product">Sirius Mods</var> is installed and linked, enter <code>SIRIUS</code>
at the <var class="product">Model 204</var> command line to display the status of the
<var class="product">Sirius Mods</var>.
An error results if the <var class="product">Sirius Mods</var> is not linked into the Online.</p></li>
</ul>

===User privileges===
The installing user '''must have''':
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>
 
<li>System Manager privileges, as well as access to the SUBSYSMGMT facility and the JCL or EXEC that
runs the Online <var class="product">Model 204</var> region.
</ul>
 
===Full Install or Quick Install===
<ul>
<li>Sites that have never installed <var class="product">UL/SPF</var> ''must'' use the full
installation, as there are a number of files to allocate and <var
class="product">Model 204</var> parameters to update.</li>

<li>Sites that are re-installing the latest version of <var class="product">UL/SPF</var>
may use the [[#A "Quick Install" for existing UL/SPF sites|quick-install]] or the full installation (some of whose steps would already be complete,
such as the allocation and initialization of <code>SIRLOCAL</code>).

<li>If you are upgrading from a previous version or maintenance level,
your site already has a <code>SIRLOCAL</code> file, which holds users' profiles and other local customizations.
Your existing <code>SIRLOCAL</code> should be left intact and allocated to the Online,
as the installation process uses <code>SIRLOCAL</code> information to determine which features should be upgraded.
</ul>

==A "Quick Install" for existing UL/SPF sites==
You can verify the <var class="product">UL/SPF</var> version either in the title of any <var class="product">UL/SPF</var> Help screen, or by looking at the content of the <code>VERSION</code> procedure in the <code>SIRIUS</code> file.
 
Here are the "Quick Install" steps:

<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, select the [https://m204.rocketsoftware.com/maint/ullist?nickname=SIRIUS "Download SOUL files" link] in the "Downloads and Uploads" section to access the "SOUL files for Sirius Software Inc." page. </li>

<li>Download the latest version of the <code>SIRIUS</code> file (which is labeled "All UL/SPF
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of the <var class="product">Sirius Mods</var> equal to or greater than the <var class="product">UL/SPF</var> version.</li>

<li>Restore the <code>SIRIUS</code> file into a 4200-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>SIRIUS</code>.  
<p>
If you are upgrading from a previous release, simply overlay your old <code>SIRIUS</code> file.</p></li>

<li>If your site uses the web version of <var class="product">[[SirMon]]</var>, there is a change between Version 7.7 and 8.1 to the file that holds historical performance information. You should delete from the <var class="product">SirMon</var> APSY definition the file <code>MONDATA</code>, and add the file <code>SIRSTATS</code>, allocated with at least 5000 pages. 
<p>
In file <code>SIRIUS</code>, run the procedure <code>CREATE.SIRSTATS</code> to define the fields in the <code>SIRSTATS</code> file.</p></li>
</ol>

The <var class="product">UL/SPF</var> APSYs can be set to <code>AUTOSTART</code> if you like.  <var class="product">SirScan</var>, <var class="product">SirMon</var>, and <var class="product">SirLib</var> have SCLASS-sensitive code, so SCLASSes should not be renamed or redefined for these systems.  

Use the APSY utility <code>SIRADMIN</code> to customize <var class="product">UL/SPF</var> settings.

==Installing UL/SPF under CMS==
This section gives instructions for installing <var class="product">UL/SPF</var> under CMS,
including general system and software requirements.
It assumes you have reviewed [[#Preparing for UL/SPF installation|Preparing for UL/SPF installation]] for details about <var class="product">UL/SPF</var> system requirements.
 
The <code>SIRIUS</code> <var class="product">Model 204</var> file, which contains the <var class="product">[[SOUL]]</var> code that runs <var class="product">UL/SPF</var>, [[#Obtaining product installation files|can be obtained from the Rocket website]] or from a UL/SPF distribution tape. If working from a tape, it is shipped with a single tape file in VMFPLC2 DUMP format that includes these files:
<table class="thJustBold">
<tr class="head"><th>File name</th>
<th>Contents</th></tr>

<tr><th><i>various</i></th>
<td>Files required for the installation of <var class="product">Sirius Mods</var>. See the <var class="book">[[Media:SiriNew.pdf|Sirius Mods Installation Guide]]</var> for more details. </td></tr>

<tr><th nowrap>ULSPF DUMPSIRI</th>
<td>A <var class="product">Model 204</var> dump of the <code>SIRIUS</code> file, which is required for all the subsystems. </td></tr>

<tr><th>ULSPF DUMPFIX</th>
<td>A <var class="product">Model 204</var> dump of the <code>SIRFIXES</code> file, (the use of which is now deprecated).
</td></tr></table>
 
Installation steps:

<ol>
<li>Install the <var class="product">Sirius Mods</var>.
<p>
<var class="product">UL/SPF</var> requires a matching or greater version number of the <var class="product">Sirius Mods</var>.
For information about installing the <var class="product">Sirius Mods</var>, see the <var class="book">Sirius Mods Installation Guide</var>.</p>

<li>Allocate space for the <var class="product">UL/SPF</var> files, and restore them from
the distribution tape or from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]].

<ol type="A">
<li>Define and format a minidisk to hold the <var class="product">UL/SPF</var> installation files.
3400 4096-byte CMS blocks should be sufficient in all cases.
This requires a 44-cylinder CMS minidisk on a 3390.
 
<li>Attach a tape drive at virtual address 181 to the owner of the
installation minidisk defined in step A.
Mount the <var class="product">UL/SPF</var> distribution tape on this tape drive.
 
<li>Load the files appropriate to your site with the <var>VMFPLC2 LOAD</var> command.
This can be done most simply with the following sequence of commands:
<p class="code">TAPE REW
VMFPLC2 LOAD (EOT
</p>
 
<li>Allocate space for the required <var class="product">Model 204</var> data sets. A skeleton exec,
<code>ULSPFAL</code>, is provided for this purpose.
Modify this exec to perform the allocations on the appropriate minidisks.
Allocate space for the following data sets:
<table class="thJustBold">
<tr><th>SIRIUS
</th><td>4200 pages; must always be allocated.</td></tr>

<tr><th>SIRLOCAL
</th><td>1200 pages; must always be allocated.</td></tr>

<tr><th>SIRSTATS or MONDATA
</th><td>60000 pages; only if you are installing <var class="product">SirMon</var>.  Use <code>MONDATA</code> for versions 7.7 and earlier.  Use <code>SIRSTATS</code> for versions 8.1 and later.</td></tr>

<tr><th>SIRFILED
</th><td>1200 pages; only if you are installing <var class="product">SirFile</var>.</td></tr>

<tr><th>SIRLIBD
</th><td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>

<tr><th>SIRLIBP
</th><td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>

<tr><th>SIRTPROC
</th><td>2000 pages; only if you are installing <var class="product">SirLib</var>.
This file can and should be sized much larger if you maintain hundreds or thousands of concurrent change decks in <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT
</th><td>1200 pages; only if you are installing Janus OMNI.</td></tr>

<tr><th>JANSSL
</th><td>1200 pages; only if you are installing Janus Network Security.</td></tr>
</table>
 
<blockquote class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copy of <code>SIRLOCAL</code> and any
application-specific data files, like <code>JANCAT</code>, <code>SIRLIBD</code>, <code>SIRFILED</code>, or <code>SIRSTATS</code>.
The installation process uses these files to determine whether to
perform upgrade actions or new-installation actions. 
</blockquote>

<li>Restore the <code>SIRIUS</code> file with the <var>LOADPROC</var> exec.
<p>
To restore, customize the FILEDEF inside the <var>LOADPROC</var> exec to conform to local standards.
In addition, modify <var>LOADPROC CCAIN</var> to contain a valid login ID and password.
If, for example, you are using the <code>SIRIUS</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </p>
<p>
To run the <var>LOADPROC</var> exec, make sure the Online execs and load modules
are on an accessed disk, then enter this command: </p>
<p class="code">ONLINE LOADPROC
</p>
</ol>
 
<li>Complete [[#updateJCL|steps 3 through the end]] in the "Installing UL/SPF under MVS" section, below.
</ol>

==Installing UL/SPF under MVS==
This section gives instructions for installing <var class="product">UL/SPF</var> under MVS,
including the general system and software requirements.
If you received your product on tape, the following instructions apply.
If like most sites, you download products and updates from the Rocket website,
see the instructions in [[#A "Quick Install" for existing UL/SPF sites|A "Quick Install" for existing UL/SPF sites]].

<blockquote class="note">
<p>'''Note:''' The product installation tape for MVS has an internal label of <code>SIRIUS</code>, and it contains
<var class="product">UL/SPF</var> files in an IEBCOPY-unloaded PDS on file 3 of the tape.
Before continuing, unless you have downloaded the product files from the website,
''you must load to disk the unloaded PDS before you can <var><i>RESTORE</i></var> the individual members to <var class="product">Model 204</var> files.'' </p>
 
The following JCL loads the <var class="product">UL/SPF</var> files to disk:
<p class="code">//LOADSIR  JOB  0,CLASS=A,MSGCLASS=X,NOTIFY=ME
//*
//*        Load UL/SPF products from tape
//*
//LIB      EXEC PGM=IEBCOPY,REGION=0M
//T1       DD   UNIT=TAPE,LABEL=(1,SL),DSN=SIRIUS.LIB,
//             DISP=(OLD,PASS),VOL=SER=SIRIUS
//T2       DD   UNIT=TAPE,LABEL=(2,SL),DSN=SIRIUS.LOAD,
//             DISP=(OLD,PASS),VOL=SER=SIRIUS
//T3       DD   UNIT=TAPE,LABEL=(3,SL),DSN=SIRIUS.ULSPF,
//             DISP=(OLD,PASS),VOL=SER=SIRIUS
//*
//D1       DD   DISP=(,CATLG),SPACE=(CYL,(10,0,5),
//             DSN=SIRIUS.LIB,UNIT=SYSDA
//D2       DD   DISP=(,CATLG),SPACE=(CYL,(5,0,2),
//             DSN=SIRIUS.LOAD,UNIT=SYSDA
//D3       DD   DISP=(,CATLG),SPACE=(CYL,(44,0,2),
//             DSN=SIRIUS.ULSPF,UNIT=SYSDA
//SYSPRINT DD   SYSOUT=*
//SYSIN    DD   *
COPY INDD=T1,OUTDD=D1
COPY INDD=T2,OUTDD=D2
COPY INDD=T3,OUTDD=D3
/*
</p>
 
The JCL includes references to these files:
<table class="thJustBold">
<tr class="head"><th>File Num / Name</th>
<th>Contents</th></tr>

<tr><th>1 / SIRIUS.LIB</th>
<td>File required for the installation of <var class="product">Sirius Mods</var>. See the <var class="book">[[Media:SiriNew.pdf|Sirius Mods Installation Guide]]</var> for more details.
</td></tr>

<tr><th nowrap>3 / SIRIUS.ULSPF(DUMPSIRI)
</th><td>A <var class="product">Model 204</var> DUMP of the <code>SIRIUS</code> file that is required for all the subsystems.
</td></tr>

<tr><th>3 / SIRIUS.ULSPF(DUMPFIX)
</th><td>A <var class="product">Model 204</var> DUMP of the <code>SIRFIXES</code> file.  This file is deprecated and not necessary for this installation.
</td></tr></table>
</blockquote>
 
===Installation checklist (MVS)===
<ol>
<li>Install the <var class="product">Sirius Mods</var>.
Refer to the <var class="book">[[Media:SiriNew.pdf|Sirius Mods Installation Guide]]</var> for details.
<p class="note">
'''Note:''' The Online in
which <var class="product">UL/SPF</var> will run must point to a load module containing the <var class="product">Sirius Mods</var>.
Also, <var class="product">UL/SPF</var> releases require a matching or greater version number of the <var class="product">Sirius Mods</var>. </p>
 
<li>Allocate the space required for the UL/SPF files.  Note that the <code>SIRIUS</code> file has X'0221' privileges, which does ''not'' allow <var>RESTORE</var>. If you are creating a new <code>SIRIUS</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>SIRIUS</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>. The command sequence is something like:
<p class="code">CREATE FILE SIRIUS
END CREATE
OPEN FILE SIRIUS
IN SIRIUS RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>SIRIUS</th>
<td>4200 pages; must always be allocated.</td></tr>

<tr><th>SIRLOCAL
</th><td>1200 pages; must always be allocated.</td></tr>

<tr><th nowrap>SIRSTATS or MONDATA
</th><td>4000 pages; only if you are installing <var class="product">SirMon</var>.  Use <code>MONDATA</code> for versions 7.7 and earlier.  Use <code>SIRSTATS</code> for versions 8.1 and later.</td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages; only if you are installing <var class="product">SirFile</var>.</td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>

<tr><th>SIRTPROC</th>
<td>2000 pages; only if you are installing <var class="product">SirLib</var>.
This file can and should be sized much larger if you maintain hundreds or thousands of concurrent change decks in <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages; only if you are installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages; only if you are installing Janus SSL.</td></tr>
</table>
 
<p class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <code>SIRLOCAL</code> and any application-specific data files, like <code>JANCAT</code>, <code>SIRLIBD</code>, <code>SIRFILED</code>, or <code>SIRSTATS</code>.
The installation process uses these files to determine whether to
perform upgrade actions or new-installation actions. </p>

<li>Restore <code>SIRIUS</code>, noting the following:
<ul>
<li>Modify <var>LOADPROC</var> in the JCL library created during the $functions
installation (usually <code>SIRIUS.V<i>xxx</i>.LIB</code>, where <var class="term">xxx</var>
is a version number) to refer to an appropriate load module and CCA<i>xxxxx</i> files.
Note that <var>LOADPROC</var> may have been customized for your site to include only those files relevant to your installation process. </li>
 
<li>Rename database DSNs to conform to local standards. </li>
 
<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>SIRIUS</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul>

<div id="updateJCL"></div> 
<li>Update the Online JCL or EXEC:
<ol type="A">
<li>Add DD (MVS) cards or FILEDEFs (CMS) for the UL/SPF files.
The following list identifies the files for which DD cards or FILEDEFs may be needed:

<table class="thJustBold">
<tr><th>SIRIUS</th>
<td>Must always be allocated.</td></tr>

<tr><th>SIRLOCAL
</th><td>Must always be allocated.</td></tr>

<tr><th>SIRSTATS or MONDATA
</th><td>If installing <var class="product">SirMon</var> and using the web interface.  Use <code>MONDATA</code> for UL/SPF versions 7.7 and prior. Use <code>SIRSTATS</code> for UL/SPF versions 8.1 and later.</td></tr>

<tr><th>SIRFILED
</th><td>If installing <var class="product">SirFile.</var></td></tr>

<tr><th nowrap>SIRLIBD, SIRLIBP, SIRTPROC
</th><td>If installing <var class="product">SirLib.</var></td></tr>

<tr><th>JANCAT
</th><td>If installing JANUS OMNI Access Module.</td></tr>

<tr><th>JANSSL
</th><td>If installing JANUS SSL Module.</td></tr>
</table> </li>

<li>Verify that the Online environment allows the use of file groups and APSY subsystems.
<ul>
<li>To use permanent file groups, the Online must have allocated an
initialized <code>CCAGRP</code> file, and the <var>[[SYSOPT parameter|SYSOPT]]</var> parameter must contain the <code>2</code> bit. </li>

<li>To use APSYs, an Online must have allocated an initialized CCASYS file
(with all fields defined), and the <var>SYSOPT</var> parameter must contain the <code>1</code> bit. </li>
</ul>
For more information about APSYs and file groups, see [[Storing and using file group definitions (CCAGRP)#File groups|File groups]] and [[System requirements for Application Subsystems]]. </li>
</ol> </li>

<li>Verify the Online has a minimum of 10 [[Sdaemons|Sdaemon]] threads allocated.  Each of these threads is typically defined as <code>IODEV15</code>. </li>

<li>Modify the User 0 stream.
<p> 
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">UL/SPF</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">UL/SPF</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">UL/SPF</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify setting is at least 5.</td></tr>
</table> </li>
 
<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Sirius Mods</var>. </li>

<li>Issue <code>OPEN FILE SIRIUS</code> (no password is required), and execute the following command:
<p class="code">INCLUDE SETUP.EXE
</p>
 
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute.
 
The procedure SETUP.EXE also builds an APSY subsystem called <code>SETUP.EXE</code>.
If installations need to be re-run, the subsystem may be invoked rather than the procedure.

During APSY execution, some error messages are not suppressed to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, etc. </li>
 
<li>Add users to the appropriate SCLASSes for any private or semi-public UL/SPF APSYs. 
<p> 
The installing user is automatically added to the administration SCLASS in all UL/SPF APSYs.</p> </li>
 
<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>SIRSCAN START
</th><td>Journal scanner</td></tr>

<tr><th>SIRFILE START
</th><td>File monitoring subsystem</td></tr>

<tr><th>SIRPRO START
</th><td>Developers' environment</td></tr>

<tr><th>SIRMON START
</th><td>Online performance monitor</td></tr>

<tr><th>SIRLIB START
</th><td>Change management system</td></tr>

<tr><th>JANCAT START
</th><td>Janus OMNI Table manager</td></tr>

<tr><th>JANSSL START
</th><td>Janus SSL certificate management system</td></tr>
</table>
<p> 
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode.
For example, to determine why SIRSCAN failed to compile, enter: </p>
<p class="code">TEST DEBUG SIRSCAN
</p> </li>
 
<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">UL/SPF</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">SIRSCAN START
SIRFILE START
SIRPRO START
SIRMON START
SIRLIB START
JANMAN START
JANCAT START
START SUBSYSTEM ULSPF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>
 
<li>Review the [[#UL/SPF server size and additional customization|UL/SPF server size and additional customization]] section, below, for specific requirements of individual APSY components of <var class="product">UL/SPF</var>.</li>
</ol>
<p class="note">
'''Note:''' CCATEMP usage may increase with <var class="product">UL/SPF</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity.  </p>

===UL/SPF server size and additional customization===
The minimum <var class="product">UL/SPF</var> server size requirements are listed below.
The actual server size requirements may vary slightly, because of table
settings in the local Online <var class="product">Model 204</var> regions, and because of slight
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.
<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server
</th></tr>

<tr><th>SIRSCAN
</th><td>180K</td></tr>

<tr><th>SIRDBA
</th><td>180K</td></tr>

<tr><th>SIRFILE
</th><td>230K</td></tr>

<tr><th>SIRPRO
</th><td>380K</td></tr>

<tr><th>SIRLIB
</th><td>135K</td></tr>

<tr><th>SIRADMIN
</th><td>150K</td></tr>

<tr><th>SIRMON
</th><td>120K</td></tr>

<tr><th>ULSPF
</th><td>135K</td></tr>
</table>
 
====UTABLE and other parameter settings====
As of <var class="product">UL/SPF</var> version 8.1 (June 2013), all <var class="product">UL/SPF</var> subsystems can be set to bypass <var>[[UTABLE command|UTABLE]]</var> resets.  Use the <code>SIRADMIN</code> subsystem to set this feature.
For versions prior to 8.1, and for those who choose to leave the <var>UTABLE</var> resets in place, <var class="product">UL/SPF</var> will capture local <var>UTABLE</var> settings before they reset them to those required by <var class="product">UL/SPF</var>.
 
Initial problems with <var class="product">UL/SPF</var> subsystems are usually associated with one or two extremely small default <var>UTABLE</var> settings.
Running the failing APSY in <code>TEST DEBUG</code> mode will highlight <var>UTABLE</var> parameters that need to be increased.

<blockquote class="note"><b>Note:</b> One parameter that must be set for <code>SIRMON, SIRPRO, and SIRSCAN</code> is <var>[[SCRNSTBL parameter|SCRNSTBL]]</var>, which is necessary for the use of screen objects. 

<table class="thJustBold">
<tr class="head"><th colspan="2">UL/SPF required parameter minimums</th></tr>
<tr><th>Parameter</th><th>Value</th></tr>

<tr><th>SCRNSTBL</th>
<td>12000</td></tr>
</table>
</blockquote>

====Additional setup for SirLib====
Read and follow the instructions in the appendix "Getting
Started" in the <var class="book">[[Media:LibrNew.pdf|SirLib User's Guide]]</var>.
 
====Additional setup for SirScan====
The <var class="product">SirScan</var> administrator may use SIRADMIN option 4 to set default I/O
and record maximums for users in the various <var class="product">SirScan</var> SCLASSes.
This is described at the beginning of the
<var class="book">[[Media:ScanrNew.pdf|SirScan User's Guide]]</var>.
 
====Additional setup for SirMon====
When users are added to SCLASSes, note that there is a special <var>BUMP</var> SCLASS.
Any user added to this SCLASS gains the ability to <var>BUMP</var> other users.
This class does not provide access to customizing options in <var class="product">SirMon</var>.
Only users in the ADMIN SCLASS are able to add custom screen definitions to <var class="product">SirMon</var>.
 
If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
<p class="code">SIRMON BACKGROUND
</p>
The background monitor may also be started automatically in a BATCH2 thread or an sdaemon thread.
Consult the <var class="product">[[SirMon]]</var> documentation for details.
 
You can customize statistic thresholds or use the supplied defaults to establish problem conditions.
 
As of <var class="product">UL/SPF</var> Version 6.8, <var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.
 
====Additional setup for SirFile====
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
<p class="code">SIRFILE BACKGROUND
</p>
As with <var class="product">SirMon</var>, the background monitor may be started automatically in a BATCH2 thread or in an sdaemon thread, and you can consult the
<var class="book">[[Media:FilrNew.pdf|SirFile User's Guide]]</var> for details.
 
You can customize the system and file-specific thresholds or use the
supplied defaults to establish problem conditions.

====UL/SPF access privileges and SCLASSes====
Each component application of <var class="product">UL/SPF</var> has its own APSY definition and
privileges associated with SCLASSes.
If you have a good reason for doing so, you can redefine any of the <var class="product">UL/SPF</var> APSYs as <var>PUBLIC</var>,
<var>SEMI-PUBLIC</var>, or <var>PRIVATE</var>.
[[Contacting Rocket Software Technical Support|Contact Rocket Software]] if you are unsure of the effect of a proposed change.

==UL/SPF on the Web==
Web-specific versions of the <var class="product">UL/SPF</var> subsystems are actively being developed and supported, and they are available to sites that own <var class="product">[[Janus Web Server]]</var>.

All the <var class="product">UL/SPF</var> APSYs can be used on the web via <var class="product">Janus Web Legacy Support</var>, which simply translates the 3270 screens of the underlying product into HTML.  Web-specific versions of both <var class="product">SirScan</var> and <var class="product">SirMon</var> can be invoked by setting up some <var class="product">Janus Web Server</var> web rules.

===Setup for web-based SirScan===
Web-based <var class="product">SirScan</var> is very lightweight, and requires a minimum of web rules to run.
<ol>
<li>Define a <var class="product">Janus Web Server</var> port.

<li>Define the following rule to invoke <var class="product">SirScan</var>:

<p class="code">JANUS WEB <var class="term">portname</var> ON /SIRSCAN/* CMD 'SIRSCAN *'
</p>

<li>The above rule will make <var class="product">SirScan</var> available, but it will not necessarily require a logon to the system, so you will need to add rules to force users to log in as well:

<p class="code">JANUS WEB <var class="term">portname</var> DISALLOW /SIRSCAN/*
JANUS WEB <var class="term">portname</var> ALLOW /SIRSCAN/* USER *
</p>

<li>Because the above rules force users to login, the port on which <var class="product">SirScan</var> runs should either:
<ul>
<li>Be only on a company intranet. </li>

<li>Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format. </li>
</ul>
<p>
The above rules will work on an unprotected port, but it is '''very strongly recommended''' that this feature only be used when SSL protection is in effect.</p> </li>
</ol>

===Setup for web-based SirMon===
This applies only to <var class="product">UL/SPF</var> Version 8.1 and later.

Because web-based <var class="product">SirMon</var> employs XML, XSLT, Javascript, a stylesheet and some graphics,
the web rules needed to run <var class="product">SirMon</var> on the web are a little more complex:
<ol>
<li>Define a <var class="product">Janus Web Server</var> port. </li>

<li>Define the following rules to invoke <var class="product">SirMon</var>:

<p class="code">JANUS WEB <var class="term">portname</var> TYPE ANY *.PNG IMAGE/PNG            
JANUS WEB <var class="term">portname</var> TYPE ANY *.CSS TEXT/CSS     
JANUS WEB <var class="term">portname</var> TYPE ANY *.JS APPLICATION/X-JAVASCRIPT   
JANUS WEB <var class="term">portname</var> ON /*.CSS OPEN SIRIUS SEND *.CSS 
JANUS WEB <var class="term">portname</var> ON /SIRMON/* CMD SIRMON        
JANUS WEB <var class="term">portname</var> ON /SIRMON/*.GIF OPEN SIRIUS SEND *.GIF EXPIRE +2147483     
JANUS WEB <var class="term">portname</var> ON /SIRMON/*.PNG OPEN SIRIUS SEND *.PNG EXPIRE +2147483     
JANUS WEB <var class="term">portname</var> ON /SIRMON/*.JS OPEN SIRIUS SEND *.JS BINARY EXPIRE +2147483
JANUS WEB <var class="term">portname</var> ON /AJAX/* OPEN SIRIUS SEND * 
JANUS WEB <var class="term">portname</var> ON /AJAX/*.JS OPEN SIRIUS SEND *.JS TEXT
JANUS WEB <var class="term">portname</var> ON /AJAX/*.UL OPEN SIRIUS CMD 'INCLUDE *.UL'
JANUS WEB <var class="term">portname</var> DISALLOW /SIRMON/*      
JANUS WEB <var class="term">portname</var> ALLOW /SIRMON/* USER *   
JANUS WEB <var class="term">portname</var> TYPE ANY *.XML TEXT/XML 
JANUS WEB <var class="term">portname</var> TYPE ANY *.XSL TEXT/XSL   
JANUS WEB <var class="term">portname</var> ON /SIRMON/*.XSL OPEN SIRIUS SEND *.XSL EXPIRE +2147483     
JANUS WEB <var class="term">portname</var> ON /SIRMON/*.CSS OPEN SIRIUS SEND *.CSS EXPIRE +2147483     
JANUS WEB <var class="term">portname</var> ON /SIRMON/TEXTJS/*.JS OPEN SIRIUS SEND *.JS TEXT EXPIRE +2147483         
JANUS WEB <var class="term">portname</var> ON /SIRMON/BUILDJS/*.JS CMD SIRMON                          

OPEN SIRSTATS 
IN SIRSTATS INITIALIZE KEEPDEFS                                          
</p> </li>

<li>The above rules will make <var class="product">SirMon</var> available, but they will not necessarily require a logon to the system, so you will need to add rules to force users to log in as well:

<p class="code">JANUS WEB <var class="term">portname</var> DISALLOW /SIRMON/*
JANUS WEB <var class="term">portname</var> ALLOW /SIRMON/* USER *
</p> </li>

<li>Because the above rules force users to login, the port on which <var class="product">SirMon</var> runs should either: 
<ul>
<li>Be only on a company intranet.

<li>Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format.  
</ul>

The above rules will work on an unprotected port, but it is '''very strongly recommended''' that this feature only be used when SSL protection is in effect.

<p class="note"><b>Note:</b> Using <var class="product">SirMon</var> on the web also requires the <code>SIRSTATS</code> file. As shown in the above web rules, <code>SIRSTATS</code> can be re-initialized each time the Online comes up. <code>SIRSTATS</code> contains historical snapshots of system performance, and the file will fill up if not archived or reinitialized on occasion.</p> </li>
</ol>