RKTools installation: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 5: Line 5:
Upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file.
Upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file.


==A summary of the RKTools installation steps==
===Obtaining product installation files===
Following is a brief checklist of installation steps. [[#Installing RKTools under CMS|Installing RKTools under CMS]] and [[#Installing RKTools under MVS|Installing RKTools under MVS]] describe these steps in greater detail.
<ol>
<li>Verify that your online is running <var class="product">Model 204</var> version 7.5 or higher.</li>
<li>Allocate the space required for the <code>SIRIUS</code> data set,
and <var>RESTORE</var> it 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">RKTools</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>


<li><var class="product">SirPro</var> and <var class="product">SirLib</var> users are encouraged to set ''SIREDIT=X'53' '', ''SIRCOMP=X'07' '' and ''COMPOPT=X'07' ''. These settings improve the programmer experience.</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 RKINSTALL</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 RKTools APSYs. </li>
<li>Verify success of the installation by compiling each RKTools APSY. </li>
<li>Read [[#RKTools server size and additional customization|RKTools 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">RKTools</var> environment. </li>
</ol>
==Preparing for RKTools installation== 
The <var class="product">RKTools</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 from the Rocket Software Model 204 maintenance website.
The files necessary for the installation are available from the Rocket Software Model 204 maintenance website.
   
   
Line 81: Line 31:
   
   
<li>To verify the products your online is authorized for, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line</li>
<li>To verify the products your online is authorized for, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line</li>
</ul>


===User privileges===
<li>The installing user '''must have''' update access to the JCL or EXECs that bring up the host Online, and 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.</li>
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">RKTools</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">RKTools</var>
<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,
may use the [[#A "Quick Install" for existing RKTools sites|quick-install]] or the full installation (some of which steps would already be complete, such as the allocation and initialization of <code>SIRLOCAL</code>).
as the installation process uses <code>SIRLOCAL</code> information to determine which features should be upgraded.</li>
 
<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>
</ul>


==A "Quick Install" for existing RKTools sites==
==Installing RKTools==
You can verify the <var class="product">RKTools</var> version either in the title of any <var class="product">RKTools</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>
<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 RKTools
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">RKTools</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">RKTools</var> APSYs default to <code>AUTOSTART</code> but you can undo that setting 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">RKTools</var> settings.
==Installing RKTools under CMS==
This section gives instructions for installing <var class="product">RKTools</var> under CMS,
including general system and software requirements.
It assumes you have reviewed [[#Preparing for RKTools installation|Preparing for RKTools installation]] for details about <var class="product">RKTools</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">RKTools</var>, [[#Obtaining product installation files|can be obtained from the Rocket website]]. If installing from physical media, delivered by Rocket, the media will contain 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>RKTools 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>RKTools 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">Model 204</var>.
<p>
<var class="product">RKTools</var> requires a matching or greater version number of <var class="product">Model 204</var>.
<li>Allocate space for the <var class="product">RKTools</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">RKTools</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">RKTools</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
</th><td>60000 pages; only if you are installing <var class="product">SirMon</var>.</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>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 RKTools under MVS" section, below.
</ol>
==Installing RKTools under MVS==
This section gives instructions for installing <var class="product">RKTools</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 RKTools sites|A "Quick Install" for existing RKTools 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">RKTools</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">RKTools</var> files to disk:
<p class="code">//LOADSIR  JOB  0,CLASS=A,MSGCLASS=X,NOTIFY=ME
//*
//*        Load RKTools 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.RKTools,
//            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.RKTools,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.RKTOOLS(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.RKFIX(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 <var class="product">Model 204</var>.<p class="note">
'''Note:''' The <var class="product">Model 204</var> version on the online in which <var class="product">RKTools</var> will run must match or be greater than the RKTools version.
   
   
<li>Allocate the space required for the RKTools 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:
<li>Allocate the space required for the RKTools 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:
Line 295: Line 46:
END CREATE
END CREATE
OPEN FILE SIRIUS
OPEN FILE SIRIUS
IN SIRIUS RESTORE 192 FROM <''whatever''>
IN SIRIUS RESTORE 192 FROM ''dumpfile''
</p>
</p>


Line 323: Line 74:
<td>1200 pages; only if you are installing Janus SSL.</td></tr>
<td>1200 pages; only if you are installing Janus SSL.</td></tr>
</table>
</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:
<p class="warn">If you are upgrading from a previous release, 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>.
<ul>
The installation process uses these files to determine whether to perform upgrade actions or new-installation actions.</p>
<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>
<li>RESTORE <code>SIRIUS</code> from the downloaded DUMP file.
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>  
<div id="updateJCL"></div>  
Line 402: Line 139:
</table> </li>
</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:
<li>Issue <code>OPEN FILE SIRIUS</code> (no password is required), and execute the following command:
<p class="code">INCLUDE RKINSTALL
<p class="code">INCLUDE RKTOOLS_INSTALL
</p>
</p>
   
   
Line 413: Line 147:
If any problems are encountered while running this procedure, correct the problem and re-execute.
If any problems are encountered while running this procedure, correct the problem and re-execute.
   
   
The procedure RKINSTALL also builds an APSY subsystem called <code>RKINSTALL</code>.
The procedure RKTOOLS_INSTALL also builds an APSY subsystem called <code>RKINSTALL</code>.
If installations need to be re-run, the subsystem may be invoked rather than the procedure.
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>
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 RKTools APSYs.  
<li>Use SUBSYSMGMT to add users to the appropriate SCLASSes for any private or semi-public RKTools APSYs.  
<p>  
<p>  
The installing user is automatically added to the administration SCLASS in all RKTools APSYs.</p> </li>
The installing user is automatically added to the administration SCLASS in all RKTools 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>Review the [[#RKTools server size and additional customization|RKTools server size and additional customization]] section, below, for specific requirements of individual APSY components of <var class="product">RKTools</var>.</li>
<li>Review the [[#RKTools server size and additional customization|RKTools server size and additional customization]] section, below, for specific requirements of individual APSY components of <var class="product">RKTools</var>.</li>
Line 542: Line 243:
   
   
====Additional setup for SirFile====
====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:
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 class="code">SIRFILE BACKGROUND
Line 552: Line 254:


====RKTools access privileges and SCLASSes====
====RKTools access privileges and SCLASSes====
Each component application of <var class="product">RKTools</var> has its own APSY definition and
Each component application of <var class="product">RKTools</var> has its own APSY definition and
privileges associated with SCLASSes.
privileges associated with SCLASSes.
Line 557: Line 260:
<var>SEMI-PUBLIC</var>, or <var>PRIVATE</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.
[[Contacting Rocket Software Technical Support|Contact Rocket Software]] if you are unsure of the effect of a proposed change.
RKTools components are installed as ''auto-start''. Use SUBSYSMGMT to disable this feature if you prefer the subsystems not start automatically at each user request.


==RKTools on the Web==
==RKTools on the Web==

Revision as of 19:24, 21 October 2015

RKTools (Rocket Tools for Model 204) is a set of application subsystems (aka APSYs) running inside a Model 204 Online that provide full-screen and web-based tools to aid programmers, DBAs, and system managers. RKTools was formerly known as UL/SPF.

Installing RKTools requires downloading the SIRIUS file from the Model 204 maintenance website, and restoring it to your environment, setting up some subsidiary Model 204 files, and verifying that the environment has the appropriate parameter settings.

Upgrades to RKTools can almost always be handled by restoring a fresh copy of the SIRIUS file. 

===Obtaining product installation files===

The files necessary for the installation are available from the Rocket Software Model 204 maintenance website.

To download product files from the Rocket website:

  1. On the Rocket M204 Customer Care page, select the "Download SOUL files" link in the "Downloads and Uploads" section to access the "SOUL files for Sirius Software Inc." page.
  2. Log in, and download the latest version of the SIRIUS file (which is labeled "All RKTools products in one file" followed by a version number).

    A "Click here" link on this page provides Help on downloading format, some information about different browser behaviors, file sizing information, and more.

Note that re-installing RKTools typically involves nothing more than downloading and restoring a new version of the SIRIUS file.

Any step of the installation process may be bypassed if it applies only to a RKTools module you are not installing.

System requirements

  • RKTools operates in a Model 204 Online region of the same or higher release number as RKTools. In other words, a RKTools 7.5 requires Model 204 version 7.5 or higher.
  • Requirements for server sizes and parameter settings for each product are listed in RKTools server size and additional customization.
  • To verify the products your online is authorized for, enter ROCKET at the Model 204 command line
  • The installing user must have update access to the JCL or EXECs that bring up the host Online, and system manager privileges, as well as access to the SUBSYSMGMT facility and the JCL or EXEC that runs the Online Model 204 region.
  • If you are upgrading from a previous version or maintenance level, your site already has a SIRLOCAL file, which holds users' profiles and other local customizations. Your existing SIRLOCAL should be left intact and allocated to the Online, as the installation process uses SIRLOCAL information to determine which features should be upgraded.

Installing RKTools

  1. Allocate the space required for the RKTools files. Note that the SIRIUS file has X'0221' privileges, which does not allow RESTORE. If you are creating a new SIRIUS file from scratch, this will not be a problem. But if you are restoring into your existing SIRIUS file, you will have to CREATE the file first (to wipe out existing content) before you execute the RESTORE. The command sequence is something like:

    CREATE FILE SIRIUS END CREATE OPEN FILE SIRIUS IN SIRIUS RESTORE 192 FROM dumpfile

    SIRIUS 4200 pages; must always be allocated.
    SIRLOCAL 1200 pages; must always be allocated.
    SIRSTATS 4000 pages; only if you are installing SirMon.
    SIRFILED 1200 pages; only if you are installing SirFile.
    SIRLIBD 1200 pages; only if you are installing SirLib.
    SIRLIBP 1200 pages; only if you are installing SirLib.
    JANCAT 1200 pages; only if you are installing Janus OMNI.
    JANSSL 1200 pages; only if you are installing Janus SSL.

    If you are upgrading from a previous release, keep your old copies of SIRLOCAL and any application-specific data files, like JANCAT, SIRLIBD, SIRFILED, or SIRSTATS. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions.

  2. RESTORE SIRIUS from the downloaded DUMP file.
  3. Update the Online JCL or EXEC:
    1. Add DD (MVS) cards or FILEDEFs (CMS) for the RKTools files. The following list identifies the files for which DD cards or FILEDEFs may be needed:
      SIRIUS Must always be allocated.
      SIRLOCAL Must always be allocated.
      SIRSTATS If installing SirMon and using the web interface.
      SIRFILED If installing SirFile.
      SIRLIBD, SIRLIBP If installing SirLib.
      JANCAT If installing JANUS OMNI Access Module.
      JANSSL If installing JANUS SSL Module.
    2. Verify that the Online environment allows the use of file groups and APSY subsystems.
      • To use permanent file groups, the Online must have allocated an initialized CCAGRP file, and the SYSOPT parameter must contain the 2 bit.
      • To use APSYs, an Online must have allocated an initialized CCASYS file (with all fields defined), and the SYSOPT parameter must contain the 1 bit.
      For more information about APSYs and file groups, see File groups and System requirements for Application Subsystems.
  4. Verify the Online has a minimum of 10 Sdaemon threads allocated. Each of these threads is typically defined as IODEV15.
  5. Modify the User 0 stream.

    Adjust these parameters:

    NFILES Increase by the number of RKTools files.
    NDCBS Increase by the number of RKTools files.
    NDIR Increase by the number of RKTools files.
    NORQS Verify setting is at least 5.
  6. Issue OPEN FILE SIRIUS (no password is required), and execute the following command:

    INCLUDE RKTOOLS_INSTALL

    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 RKTOOLS_INSTALL also builds an APSY subsystem called RKINSTALL. 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.
  7. Use SUBSYSMGMT to add users to the appropriate SCLASSes for any private or semi-public RKTools APSYs.

    The installing user is automatically added to the administration SCLASS in all RKTools APSYs.

  8. Review the RKTools server size and additional customization section, below, for specific requirements of individual APSY components of RKTools.

Note: CCATEMP usage may increase with RKTools. CCATEMP should be monitored (VIEW TEMPSIZE, VIEW TEMPMAX) to ensure that sufficient space is allocated to accommodate the additional activity.

RKTools server size and additional customization

The minimum RKTools server size requirements are listed below. The actual server size requirements may vary slightly, because of table settings in the local Online Model 204 regions, and because of slight differences between UTABLE requirements in different versions of Model 204.

Subsystem name Minimum server
SIRSCAN 180K
SIRDBA 180K
SIRFILE 230K
SIRPRO 750K
SIRLIB 135K
SIRADMIN 150K
SIRMON 220K
RKTools 135K

UTABLE and other parameter settings

Initial problems with RKTools subsystems are usually associated with one or two extremely small default UTABLE settings. Running the failing APSY in TEST DEBUG mode will highlight UTABLE parameters that need to be increased.

Note: One parameter that must be set for SIRMON, SIRPRO, and SIRSCAN is SCRNSTBL, which is necessary for the use of screen objects.

RKTools required parameter minimums
ParameterValue
SCRNSTBL 12000

Additional setup for SirLib

Read and follow the instructions in the appendix "Getting Started" in the SirLib User's Guide.

Additional setup for SirScan

The SirScan administrator may use SIRADMIN option 4 to set default I/O and record maximums for users in the various SirScan SCLASSes. This is described at the beginning of the SirScan User's Guide.

Additional setup for SirMon

When users are added to SCLASSes, note that there is a special BUMP SCLASS. Any user added to this SCLASS gains the ability to BUMP other users. This class does not provide access to customizing options in SirMon. Only users in the ADMIN SCLASS are able to add custom screen definitions to SirMon.

If the SirMon background monitor is to be used, add the following line to User 0's input stream:

SIRMON BACKGROUND

The background monitor may also be started automatically in a BATCH2 thread or an sdaemon thread. Consult the SirMon documentation for details.

You can customize statistic thresholds or use the supplied defaults to establish problem conditions.

As of RKTools Version 6.8, SirMon has a feature to send warnings to e-mail addresses and cell phones (via e-mail). This feature requires Janus Sockets and a started Janus Sockets port.

Additional setup for SirFile

If the SirFile background monitor is to be used, add the following line to User 0's input stream:

SIRFILE BACKGROUND

As with SirMon, the background monitor may be started automatically in a BATCH2 thread or in an sdaemon thread, and you can consult the SirFile User's Guide for details.

You can customize the system and file-specific thresholds or use the supplied defaults to establish problem conditions.

RKTools access privileges and SCLASSes

Each component application of RKTools 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 RKTools APSYs as PUBLIC, SEMI-PUBLIC, or PRIVATE. Contact Rocket Software if you are unsure of the effect of a proposed change.

RKTools components are installed as auto-start. Use SUBSYSMGMT to disable this feature if you prefer the subsystems not start automatically at each user request.

RKTools on the Web

Web-specific versions of the RKTools subsystems are actively being developed and supported, and they are available to sites that own Janus Web Server.

All the RKTools APSYs can be used on the web via Janus Web Legacy Support, which simply translates the 3270 screens of the underlying product into HTML. Web-specific versions of both SirScan and SirMon can be invoked by setting up some Janus Web Server web rules.

Setup for web-based SirScan

Web-based SirScan is very lightweight, and requires a minimum of web rules to run.

  1. Define a Janus Web Server port.
  2. Define the following rule to invoke SirScan:

    JANUS WEB portname ON /SIRSCAN/* CMD 'SIRSCAN *'

  3. The above rule will make SirScan 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:

    JANUS WEB portname DISALLOW /SIRSCAN/* JANUS WEB portname ALLOW /SIRSCAN/* USER *

  4. Because the above rules force users to login, the port on which SirScan runs should either:
    • Be only on a company intranet.
    • Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format.

    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.

Setup for web-based SirMon

This applies only to RKTools Version 8.1 and later.

Because web-based SirMon employs XML, XSLT, Javascript, a stylesheet and some graphics, the web rules needed to run SirMon on the web are a little more complex:

  1. Define a Janus Web Server port.
  2. Define the following rules to invoke SirMon:

    JANUS WEB portname TYPE ANY *.PNG IMAGE/PNG JANUS WEB portname TYPE ANY *.CSS TEXT/CSS JANUS WEB portname TYPE ANY *.JS APPLICATION/X-JAVASCRIPT JANUS WEB portname ON /*.CSS OPEN SIRIUS SEND *.CSS JANUS WEB portname ON /SIRMON/* CMD SIRMON JANUS WEB portname ON /SIRMON/*.GIF OPEN SIRIUS SEND *.GIF EXPIRE +2147483 JANUS WEB portname ON /SIRMON/*.PNG OPEN SIRIUS SEND *.PNG EXPIRE +2147483 JANUS WEB portname ON /SIRMON/*.JS OPEN SIRIUS SEND *.JS BINARY EXPIRE +2147483 JANUS WEB portname ON /AJAX/* OPEN SIRIUS SEND * JANUS WEB portname ON /AJAX/*.JS OPEN SIRIUS SEND *.JS TEXT JANUS WEB portname ON /AJAX/*.UL OPEN SIRIUS CMD 'INCLUDE *.UL' JANUS WEB portname DISALLOW /SIRMON/* JANUS WEB portname ALLOW /SIRMON/* USER * JANUS WEB portname TYPE ANY *.XML TEXT/XML JANUS WEB portname TYPE ANY *.XSL TEXT/XSL JANUS WEB portname ON /SIRMON/*.XSL OPEN SIRIUS SEND *.XSL EXPIRE +2147483 JANUS WEB portname ON /SIRMON/*.CSS OPEN SIRIUS SEND *.CSS EXPIRE +2147483 JANUS WEB portname ON /SIRMON/TEXTJS/*.JS OPEN SIRIUS SEND *.JS TEXT EXPIRE +2147483 JANUS WEB portname ON /SIRMON/BUILDJS/*.JS CMD SIRMON OPEN SIRSTATS IN SIRSTATS INITIALIZE KEEPDEFS

  3. The above rules will make SirMon 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:

    JANUS WEB portname DISALLOW /SIRMON/* JANUS WEB portname ALLOW /SIRMON/* USER *

  4. Because the above rules force users to login, the port on which SirMon runs should either:
    • Be only on a company intranet.
    • Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format.

    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.

    Note: Using SirMon on the web also requires the SIRSTATS file. As shown in the above web rules, SIRSTATS can be re-initialized each time the Online comes up. SIRSTATS contains historical snapshots of system performance, and the file will fill up if not archived or reinitialized on occasion.

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RKTools_installation&oldid=81275"