RKTools installation: Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
(130 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<var class="product">[[RKTools]]</var> (Rocket Tools for Model 204) 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. <var class="product">[[RKTools]]</var> was formerly known as UL/SPF.
==Overview==
<var class="product">[[RKTools]]</var> (Rocket Tools for Model 204) is a set of [[Application Subsystem development|application subsystems]] (aka APSYs) running inside a <var class="product">Model&nbsp;204</var> Online that provide TN3270 and web-based tools for programmers, database administrators, and system managers.  


Installing <var class="product">RKTools</var> requires downloading the <code>SIRIUS</code> file from the <var class="product">Model 204</var> maintenance website, 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.
As of RKTools V7.7, all Rocket-provided, SOUL-based tools are consolidated in the <code>M204PROC</code> procedure file. <code>M204PROC</code> includes all components from RKTools 7.5 in addition to Dictionary/204 and the [[SQL catalog#Generating DDL with SQL utilities|SQL Server utilities]]. This means that all Model&nbsp;204 SOUL tools provided by Rocket are in a single file.  


Upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file.
<p class="note"><b>Note:</b> Since the RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file, sites that are upgrading must perform a full installation and not merely an <code>M204PROC</code> file overlay. To allow for a switch back to RKTools 7.5, keep a backup of your current <code>SIRIUS</code> file and your current <code>CCASYS</code> file (though you can also change the subsystem definitions manually using [[SUBSYSMGMT]]).</p>


==A summary of the RKTools installation steps==
Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model&nbsp;204</var> maintenance website, restoring it to your environment, setting up some subsidiary <var class="product">Model&nbsp;204</var> files, and verifying that the Online environment has the appropriate parameter settings. Then you run a single procedure that installs or upgrades the RKTools subsystems.
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>
Once the installation is complete, upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>M204PROC</code> file.
</ol>


==Preparing for RKTools installation==
==Download the installation file==
The <var class="product">RKTools</var> products are implemented as <var class="product">Model 204</var> subsystems.
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model&nbsp;204</var> file. You need to download a dump version of this file from the Rocket Software Model&nbsp;204 maintenance website. The procedure file for RKTools 7.5 is <code>SIRIUS</code>.
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===
To download from the Rocket website:
The files necessary for the installation are available from the Rocket Software Model 204 maintenance website.
To download product files from the Rocket website:
<ol>
<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.  
<li>On the "Rocket M204 Customer Care" page ([http://m204.rocketsoftware.com/ http://m204.rocketsoftware.com]), go to the "Downloads and Uploads" section and select the "Download SOUL files" link to access the "SOUL files for Rocket Software" page.  


<li>Log in, and download the latest version of the <code>SIRIUS</code> file (which is labeled "All RKTools
<li>Log in, and download the version of RKTools that is compatible with your version of Model&nbsp;204. The procedure file contained in the "RKTools V7.7" link works for Model&nbsp;204 versions 7.6 and above. For Model&nbsp;204 version 7.5, use the download labeled "RKTools V7.5."
products in one file" followed by a version number).
<p>
<p>
A "Click here" link on this page provides Help on downloading format, some information about
A "Click here" link in the text above the file list on the SOUL files download page brings up  [[Downloading and restoring SOUL files]], which provides help about downloading and uploading files, file sizing, and more.</p>
different browser behaviors, file sizing information, and more.</p></li>
</li>
</ol>
</ol>


Note that re-installing <var class="product">RKTools</var> typically involves nothing more than downloading and restoring a new version of the <code>SIRIUS</code> file. </p>
You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.


Any step of the installation process may be bypassed if it applies only to a <var class="product">RKTools</var> module you are not installing.
==System requirements==
===System requirements===
<ul>
<ul>
<li><var class="product">RKTools</var> operates in a <var class="product">Model 204</var> Online region of the same or higher release number as <var class="product">RKTools</var>. In other words, a <var class="product">RKTools</var> 7.5 requires <var class="product">Model 204</var> version 7.5 or higher.
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model&nbsp;204</var> version 7.6, though version 7.7 is recommended.  Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model&nbsp;204</var> version 7.5 or higher.
   
   
<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size and additional customization|RKTools server size and additional customization]].</li>
<li>Requirements for [[#Server size requirements|server sizes]] for each product and Model&nbsp;204 [[#user0parms|User 0]] and [[#utableParms|UTABLE]] parameter settings are listed where appropriate in the installation steps in the next section.</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>
<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model&nbsp;204</var> command line.</li>
</ul>


===User privileges===
<li>The installing user <b>must have</b>:
The installing user '''must have''':
<ul>
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model&nbsp;204 System Manager privileges</li>
<li>System Manager privileges, as well as access to the SUBSYSMGMT facility and the JCL or EXEC that
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model&nbsp;204</var> region.</li>
runs the Online <var class="product">Model 204</var> region.
</ul></li>
</ul>
</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>
==Install RKTools==
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>).
<blockquote class="warn">
<p><b>Attention:</b> If you are upgrading from a previous version, keep your old copies of <code>SIRLOCAL</code>, <code>M204LOCL</code>, and most application-specific data files, such as <code>JANCAT</code>, <code>SIRLIBD</code>, and <code>SIRFILED</code>. The SirMon <code>SIRSTATS</code> file is replaced in version 7.7 by <code>MONDATA</code>. The <code>SIRIUS</code> file is no longer used as of RKTools 7.7, but there is no harm in keeping it in case you want to fall back to a previous RKTools version. </p>
<p>
The installation process uses your existing RKTools files to determine whether to perform upgrade actions or new-installation actions, so leave these files allocated and available, including <code>SIRLOCAL</code>.</p>
</blockquote>


<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.
<ol>
Your existing <code>SIRLOCAL</code> should be left intact and allocated to the Online,
<li>Allocate files.
as the installation process uses <code>SIRLOCAL</code> information to determine which features should be upgraded.
<p>The following table shows the RKTools files and their sizes: </p>
</ul>
<table class="thJustBold">
<caption>RKTools file allocations</caption>
<tr><th>File</th><th>Size</th><th>Allocation is required...</th></tr>
<tr><th>M204PROC</th>
<td nowrap>9800 pages</td>  
<td>Always.</td></tr>


==A "Quick Install" for existing RKTools sites==
<tr><th>SIRLOCAL
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.
</th><td>1200 pages</td>  
<td>Always.</td></tr>
Here are the "Quick Install" steps:


<ol>
<tr><th>M204LOCL
<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>
</th><td>3000 pages</td>
<td>If using RKWeb.</td></tr>


<li>Download the latest version of the <code>SIRIUS</code> file (which is labeled "All RKTools
<tr><th nowrap>MONDATA</th>
products in one file" followed by a version number).</li>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. <p class="note:><b>Note:</b> <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </p></td></tr>


<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>
<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>


<li>Restore the <code>SIRIUS</code> file into a 4200-page file on your mainframe.
<tr><th>SIRLIBD</th>
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>SIRIUS</code>.
<td>1200 pages</td>  
<p>
<td>Only if installing <var class="product">SirLib.</var></td></tr>
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.
<tr><th>SIRLIBP</th>
<p>
<td>1200 pages</td>  
In file <code>SIRIUS</code>, run the procedure <code>CREATE.SIRSTATS</code> to define the fields in the <code>SIRSTATS</code> file.</p></li>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>
</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.
<tr><th>JANCAT</th>
<td>1200 pages</td>  
<td>Only if installing Janus OMNI.</td></tr>


Use the APSY utility <code>SIRADMIN</code> to customize <var class="product">RKTools</var> settings.
<tr><th>JANSSL</th>
 
<td>1200 pages</td>  
==Installing RKTools under CMS==
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
This section gives instructions for installing <var class="product">RKTools</var> under CMS,
</table>
including general system and software requirements.
<p>
It assumes you have reviewed [[#Preparing for RKTools installation|Preparing for RKTools installation]] for details about <var class="product">RKTools</var> system requirements.
The following table shows the [[Dictionary/204 overview|Dictionary/204]] supporting files (in addition to M204PROC):</p>
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">
<table class="thJustBold">
<tr class="head"><th>File name</th>
<tr><th>File</th><th>Size</th><th>Allocation is required...</th></tr>
<th>Contents</th></tr>


<tr><th><i>various</i></th>
<tr><th>DATALINK</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>
<td>400 pages</td>
<td>For Dictionary/204 or SQL Server.</td></tr>


<tr><th nowrap>RKTools DUMPSIRI</th>
<tr><th>METADATA</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>
<td>400 pages</td>
<td>For Dictionary/204 or SQL Server.</td></tr>


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


<ol>
<tr><th>D204RPT</th>
<li>Install the <var class="product">Model 204</var>.
<td>400 pages</td>
<p>
<td>If installing Dictionary/204.</td></tr>
<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
<tr><th>D204SYS</th>
the distribution tape or from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]].
<td>400 pages</td>
<td>If installing Dictionary/204.</td></tr>


<ol type="A">
<tr><th>M204DCTL</th>
<li>Define and format a minidisk to hold the <var class="product">RKTools</var> installation files.
<td>400 pages</td>
3400 4096-byte CMS blocks should be sufficient in all cases.
<td>If installing Dictionary/204.</td></tr>
This requires a 44-cylinder CMS minidisk on a 3390.
</table>
<p>
<li>Attach a tape drive at virtual address 181 to the owner of the
The following table shows the [[SQL Server overview|SQL Server]] supporting files (in addition to M204PROC): </p>
installation minidisk defined in step A.
<table class="thJustBold" id="sqlfiles">
Mount the <var class="product">RKTools</var> distribution tape on this tape drive.
<caption>SQL Server file allocations</caption>
<tr><th>File</th><th>Size</th><th>Allocation is required...</th></tr>
<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
<tr><th>CCACAT</th>
</th><td>1200 pages; must always be allocated.</td></tr>
<td>700 pages</td>
<td>For RKWeb access to SQL Server. </td></tr>  


<tr><th>SIRSTATS
<tr><th>DATALINK</th>
</th><td>60000 pages; only if you are installing <var class="product">SirMon</var>.</td></tr>
<td>400 pages</td>
<td>For Dictionary/204 or SQL Server.</td></tr>


<tr><th>SIRFILED
<tr><th>METADATA</th>
</th><td>1200 pages; only if you are installing <var class="product">SirFile</var>.</td></tr>
<td>400 pages</td>
<td>For Dictionary/204 or SQL Server.</td></tr>


<tr><th>SIRLIBD
<tr><th>TSFDATA</th>
</th><td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>
<td>200 pages</td>
<td>For RKWeb access to SQL Server. </td></tr>


<tr><th>SIRLIBP
<tr><th>TSFTEMP</th>
</th><td>1200 pages; only if you are installing <var class="product">SirLib</var>.</td></tr>
<td>300 pages</td>
<td>For RKWeb access to SQL Server. </td></tr>
</table>
</li>


<tr><th>JANCAT
<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file [[#Download the installation file|downloaded from the Rocket website]].
</th><td>1200 pages; only if you are installing Janus OMNI.</td></tr>
<blockquote class="note">
 
<p><b>Note:</b> If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does <b>not</b> allow <var>RESTORE</var>. You will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>. A sample command sequence is: </p>
<tr><th>JANSSL
<p class="code">CREATE FILE M204PROC
</th><td>1200 pages; only if you are installing Janus Network Security.</td></tr>
END CREATE
</table>
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>
<blockquote class="warn">
</p>
'''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>
</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>
<p>
To run the <var>LOADPROC</var> exec, make sure the Online execs and load modules
To verify the <code>M204PROC</code> version, you can open <code>M204PROC</code> with [[SirPro]] and view the RKTOOLS_VERSION procedure. </p>
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==
<li id="updateJCL">Update the Online JCL or EXEC:
This section gives instructions for installing <var class="product">RKTools</var> under MVS,
<ol type="a">
including the general system and software requirements.
<li>Add DD (MVS) cards or FILEDEFs (CMS) for the RKTools files.
If you received your product on tape, the following instructions apply.
The "RKTools file allocations" table above lists the files for which DD cards or FILEDEFs might be needed.</li>
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">
<li>Verify that the Online environment allows the use of [[Storing and using file group definitions (CCAGRP)#File groups|file groups]] and [[System requirements for Application Subsystems|application subsystems]].
<p>'''Note:''' The product installation tape for MVS has an internal label of <code>SIRIUS</code>, and it contains
<ul>
<var class="product">RKTools</var> files in an IEBCOPY-unloaded PDS on file 3 of the tape.
<li>To use permanent file groups, the Online must have allocated a [[Storing and using file group definitions (CCAGRP)#Creating the CCAGRP data set|CCAGRP file]], and the <var>[[SYSOPT parameter|SYSOPT]]</var> parameter must include the <code>2</code> bit. </li>
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>
<li>To use APSY subsystems, an Online must have allocated a [[System requirements for Application Subsystems#Overview of CCASYS|CCASYS file]], and the <var>SYSOPT</var> parameter must include the <code>1</code> bit. </li>
<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.
</ul></li>
</td></tr>


<tr><th nowrap>3 / SIRIUS.RKTOOLS(DUMPSIRI)
<li id="Server size requirements">Review the RKTools, Dictionary/204, and Model&nbsp;204 SQL Server tables below for the minimum server-size requirements of individual subsystem components.
</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)
<p class="note"><b>Note:</b> The actual server size requirements might vary slightly from the listings below because of table
</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.
settings in your <var class="product">Model&nbsp;204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model&nbsp;204</var>.</p>
</td></tr></table>
<p>
</blockquote>
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component. For more information about server sizing, see [[Defining the runtime environment (CCAIN)#Sizing user server areas|Sizing user server areas]].
===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:
<p class="code">CREATE FILE SIRIUS
END CREATE
OPEN FILE SIRIUS
IN SIRIUS RESTORE 192 FROM <''whatever''>
</p>
</p>
<p class="note"><b>Note:</b> CCATEMP usage might increase with RKTools. 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>


<table class="thJustBold">
<table class="thJustBold">
<tr><th>SIRIUS</th>
<caption>RKTools server sizes</caption>
<td>4200 pages; must always be allocated.</td></tr>
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>


<tr><th>SIRLOCAL
<tr><th>JANSSL</th>
</th><td>1200 pages; must always be allocated.</td></tr>
<td>300K</td></tr>
 
<tr><th>RKTOOLS</th>
<td>135K</td></tr>
 
<tr><th>SIRADMIN</th>
<td>150K</td></tr>


<tr><th nowrap>SIRSTATS
<tr><th>SIRDBA</th>
</th><td>4000 pages; only if you are installing <var class="product">SirMon</var>.</td></tr>
<td>180K</td></tr>


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


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


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


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


<tr><th>JANSSL</th>
<tr><th>SIRSCAN</th>
<td>1200 pages; only if you are installing Janus SSL.</td></tr>
<td>250K</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:
<table class="thJustBold">
<ul>
<caption>Dictionary server sizes</caption>
<li>Modify <var>LOADPROC</var> in the JCL library created during the $functions
<tr class="head"><th>Subsystem name
installation (usually <code>SIRIUS.V<i>xxx</i>.LIB</code>, where <var class="term">xxx</var>
</th><th>Minimum server size
is a version number) to refer to an appropriate load module and CCA<i>xxxxx</i> files.
</th></tr>
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>  
<tr><th>DICTADMIN
<li>Update the Online JCL or EXEC:
</th><td>455K</td></tr>
<ol type="A">
<li>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:


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


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


<tr><th>SIRSTATS
<tr><th>DOCUMENT
</th><td>If installing <var class="product">SirMon</var> and using the web interface.</td></tr>
</th><td>455K</td></tr>


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


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


<tr><th>JANCAT
<tr><th>XREF
</th><td>If installing JANUS OMNI Access Module.</td></tr>
</th><td>455K</td></tr>
</table>


<tr><th>JANSSL
<table class="thJustBold">
</th><td>If installing JANUS SSL Module.</td></tr>
<caption>SQL Server server sizes</caption>
</table> </li>
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>


<li>Verify that the Online environment allows the use of file groups and APSY subsystems.
<tr><th>CCACATREPT</th>
<ul>
<td>250000</td></tr>
<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
<tr><th>CCATSF</th>
(with all fields defined), and the <var>SYSOPT</var> parameter must contain the <code>1</code> bit. </li>
<td>165000</td></tr>
</ul>
</table>
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>
</li>
</ol> </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>Verify that the Online has a minimum of 10 [[Sdaemons|Sdaemon]] threads allocated.  Each of these threads is typically defined as an <code>IODEV15</code> thread.


<li>Modify the User 0 stream.
If using RKWeb or any of the web interfaces to other components, you may need more IODEV15s available.</li>
 
<li id="user0parms">Modify the User 0 stream.
<p>  
<p>  
Adjust these parameters: </p>
Adjust these parameters: </p>
<table class="thJustBold">
<table class="thJustBold">
<tr><th>NFILES
<tr><th>Parameter</th>
</th><td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>
<th>Adjustment</th></tr>
 
<tr><th>COMPOPT</th>
<td>RKTools requires the <var>COMPOPT</var> X'03' bit, which enables mixed-case SOUL. RKTools makes extensive use of mixed-case coding, and the tools fail to compile if support is not enabled. If [[SirLib change control#Applying updates in batch mode|batch SirLib]] or other batch features are used, ensure that <var>COMPOPT</var> is set to X'03' in those jobs as well.</td></tr>
 
<tr><th>CUSTOM</th>
<td>RKWeb must include the 18 setting to enable a larger <var>[[SSLIBSIZE]]</var> on the Janus Web port, which must be secured.</td></tr><tr><th>MAXBG</th>
<td>Minimum setting is 4.</td></tr>
 
<tr><th>MAXDAEM</th>
<td>Minimum setting is 10.</td></tr>
 
<tr><th>MAXINCL</th>
<td>Minimum setting is 10.</td></tr>
 
<tr><th>NDCBS</th>
<td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>
 
<tr><th>NDIR</th>
<td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>
 
<tr><th>NFILES</th>
<td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>


<tr><th>NDCBS
<tr><th>NORQS</th>
</th><td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>
<td>Minimum setting is 5.</td></tr>


<tr><th>NDIR
<tr><th>SESNPUB</th>
</th><td>Increase by the number of <var class="product">RKTools</var> files.</td></tr>
<td>Minimum setting is 40. The right setting for your site might be higher, based on RKWeb usage (number of users).</td></tr>


<tr><th>NORQS
<tr><th>SESUMAX</th>
</th><td>Verify setting is at least 5.</td></tr>
<td>Minimum setting is 10. The right setting for your site might be higher, based on RKWeb usage (number of users).</td></tr>
</table> </li>
</table> </li>
   
   
<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
<li id="utableParms">Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.
to a load module containing the <var class="product">Sirius Mods</var>. </li>
<p>
Initial problems with <var class="product">RKTools</var> subsystems are usually associated with one or two extremely small default <var>UTABLE</var> settings.
Running the failing subsystem in <code>TEST DEBUG</code> mode will highlight <var>UTABLE</var> parameters that need to be increased. </p>
<p>
These are the recommended settings: </p>
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>


<li>Issue <code>OPEN FILE SIRIUS</code> (no password is required), and execute the following command:
<tr><th>HTLEN </th>
<p class="code">INCLUDE RKINSTALL
<td style="text-align:right">220 </td>
</p>
<td>Max length of each header or trailer</td></tr>
 
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
<tr><th>LFTBL</th>
No user profiles or other site-specific customization will be lost.
<td style="text-align:right">1000</td>
If any problems are encountered while running this procedure, correct the problem and re-execute.
<td>Length of FTBL</td></tr>
 
The procedure RKINSTALL also builds an APSY subsystem called <code>RKINSTALL</code>.
<tr><th>LFSCB</th>
If installations need to be re-run, the subsystem may be invoked rather than the procedure.
<td style="text-align:right">21400</td>
<td>Length of full screen buffer</td></tr>
 
<tr><th>LGTBL</th>
<td style="text-align:right">2000</td>
<td>Length of global variable table</td></tr>
 
<tr><th>LIBUFF</th>
<td style="text-align:right">2000</td>
<td>Length of input buffer</td></tr>
 
<tr><th>LITBL</th>
<td style="text-align:right">104</td>
<td>Length of ITBL</td></tr>


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>
<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<li>Add users to the appropriate SCLASSes for any private or semi-public RKTools APSYs.
<td>Length of NTBL</td></tr>
<p>
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
<tr><th>LOBUFF</th>
</th><td>Journal scanner</td></tr>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>


<tr><th>SIRFILE START
<tr><th>LOUTPB</th>
</th><td>File monitoring subsystem</td></tr>
<td style="text-align:right">10000</td>
<td>Length of output page buffer</td></tr>


<tr><th>SIRPRO START
<tr><th>LPDLST</th>
</th><td>Developers' environment</td></tr>
<td style="text-align:right">10000</td>
<td>Length of user push down list</td></tr>


<tr><th>SIRMON START
<tr><th>LQTBL</th>
</th><td>Online performance monitor</td></tr>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>


<tr><th>SIRLIB START
<tr><th>LSTBL</th>
</th><td>Change management system</td></tr>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>


<tr><th>JANCAT START
<tr><th>LTTBL</th>
</th><td>Janus OMNI Table manager</td></tr>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>


<tr><th>JANSSL START
<tr><th>LVTBL</th>
</th><td>Janus SSL certificate management system</td></tr>
<td style="text-align:right">1300</td>
</table>
<td>Length of VTBL</td></tr>
<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>
</ol>
<p class="note">
'''Note:''' CCATEMP usage may increase with <var class="product">RKTools</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>


===RKTools server size and additional customization===
<tr><th>LXTBL</th>
The minimum <var class="product">RKTools</var> server size requirements are listed below.
<td style="text-align:right">1000</td>
The actual server size requirements may vary slightly, because of table
<td>Length of XTBL</td></tr>
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
<tr><th>MAXHDR</th>
</th><td>180K</td></tr>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>


<tr><th>SIRDBA
<tr><th>MAXTRL</th>
</th><td>180K</td></tr>
<td style="text-align:right">7 </td>
<td>Max number of trailers</td></tr>


<tr><th>SIRFILE
<tr><th>NORQS</th>
</th><td>230K</td></tr>
<td style="text-align:right">10</td>
<td>Number of requests preserved</td></tr>


<tr><th>SIRPRO
<tr><th>SCRNSTBL </th>
</th><td>750K</td></tr>
<td style="text-align:right">12000 </td>
<td>STBL size for screen objects; this must be set for <code>SIRMON</code>, <code>SIRPRO</code>, and <code>SIRSCAN</code>.
<p>
A setting of 18000 is recommended for shops that use Mod 6 terminals with very large screen sizes (Rocket regularly tests with 3270 screen sizes of 50x150 characters). </p>
<p class="note"><b>Note:</b>
Either 12000 or 18000 is both a recommended minimum <em>and</em> maximum. Unless you have very large servers at your site (1 megabyte or larger), or you have very large screen objects in your own application code, a very large <var>SCRNSTBL</var> will cause table-size resets to fail.</p></td></tr>


<tr><th>SIRLIB
<tr><th>SEQPDL</th>
</th><td>135K</td></tr>
<td style="text-align:right">4096</td>
<td>Minimum PDL available for sequencer</td></tr>
</table></li>


<tr><th>SIRADMIN
<li>Bring up the Online and install all the RKTools components except Dictionary/204 and SQL Server; then install or reinstall Dictionary/204 and SQL utilities as needed:
</th><td>150K</td></tr>
<ol type="a">
<li><p><b>RKTools 7.5 components</b></p>
Issue these commands:
<p class="code">OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL </p>
<p>
RKTOOLS_INSTALL creates or updates the dozen or so RKTools application subsystems and sets up their supporting files. It performs all installation functions for new sites and all upgrade functions for reinstalling sites. No existing user profiles or other site-specific customization will be lost, as long as your existing SIRLOCAL file is left in place. </p>
<p>
The procedure produces a screen that lists all of the subsystems and whether they have loaded. It may be necessary to troubleshoot why expected subsystems did not load, then re-execute the procedure. You are encouraged to use the installation program's F1-key Help for detailed explanation of how the program is working with the subsystems. </p>
<p>
During APSY subsystem execution, error messages are not suppressed, which aids 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, and so on. </p>
<p>
The procedure <code>RKTOOLS_INSTALL</code> also builds a subsystem called <code>RKINSTALL</code>. If the installation needs to be re-run, you can invoke the subsystem (from command line or later with option 9 in the [[RKTools#mainmenu|RKTools main menu]]) rather than the procedure. </p>
<p>
Once the installation completes successfully, start the component subsystems (<var>[[START command: Starting an application subsystem|START SUBSYSTEM]]</var> command, invoke by name, or both) before using the RKTools 3270 or RKWeb interface. </p>
<p>
To verify that the subsystems are correctly installed, enter <code>RKTOOLS</code> at the command line, and use the main menu to test the individual RKTools components. You may also want to use SUBSYSMGMT to check that the component subsystem definitions are viewable, and use [[SirPro]] to display the newly restored M204PROC file to ensure its availability. </p></li>


<tr><th>SIRMON
<li><p><b>Dictionary/204</b></p>
</th><td>220K</td></tr>
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb as of version 7.7, they are not installed and set up by <code>RKTOOLS_INSTALL</code>. For example, on z/OS, an initial Dictionary/204 installation uses the <code>DDINST</code> JCL from the Model&nbsp;204 RKOBJLIB; for an upgrade, the <code>DDRINST</code> job.
<p>
Though the Dictionary/204 installation steps are largely included in the the RKTools installation process, you may want to review the [[Dictionary/204 installation guide]] for any additional actions you might need to take. </p></li>


<tr><th>RKTools
<li><p><b>SQL Server</b></p>
</th><td>135K</td></tr>
The [[SQL Server overview|Model 204 SQL Server]] components are delivered in <code>M204PROC</code>, and the SQL Server tools (CCACATREPT, CCATSF) are accessible from RKWeb. Support for this use of RKWeb requires the availability of the [[#sqlfiles|SQL Server supporting files]].
</table>
<p>
For an initial installation of the SQL Server subsystems, open <code>M204PROC</code> and execute the following command: </p>
<p class="code">INCLUDE SQLINST </p>
<p>
For a reinstallation: </p>
<p class="code">INCLUDE SQLRINST </p>
<p>
If you are installing and using SQL Server independently apart from RKTools and RKWeb, or you have additional questions about SQL Server installation, see [[Model 204 SQL Server installation]]. </p></li>
</ol>
</li>
   
   
====UTABLE and other parameter settings====
<li>Use SUBSYSMGMT to add users to the appropriate [[SCLASS]] classes for any private or semi-public RKTools subsystems.
<p>
Initial problems with <var class="product">RKTools</var> subsystems are usually associated with one or two extremely small default <var>UTABLE</var> settings.
For authority to do this, you need System Administrator log in privileges, and you need SUBSYSMGMT privileges authorized via the [[Dictionary/204 administration#Security administration|DICTADMIN facility]] of Dictionary/204. The ID of the user that runs the INSTALL_RKTOOLS procedure is automatically added to the ADMIN or to the highest-level administration SCLASS in each of the RKTools subsystems (though not necessarily to the Dictionary and SQL Server subsystems).</p>
Running the failing APSY in <code>TEST DEBUG</code> mode will highlight <var>UTABLE</var> parameters that need to be increased.
<p>
Each component application of <var class="product">RKTools</var> has its own APSY subsystem definition and privileges associated with SCLASS specifications.
If you have a good reason for doing so, you can redefine any of the <var class="product">RKTools</var> subsystems 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. </p>
<p>
RKTools components are typically installed as ''auto-start''. Use SUBSYSMGMT to disable this feature if you prefer that the subsystems not start automatically at each user request. </p>
<p>
The RKWeb interface, described further below in [[#Additional setup for RKWeb|Additional setup for RKWeb]], is controlled by the RKWEB subsystem, and you need to update the subsystem definition with the names of eligible users. Some of the RKWeb options require system administrator login privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires system administrator login privileges and ADMIN SCLASS membership <i>in the RKWEB subsystem</i>, as well as a [[RKWeb#RKWeb security|suitable product license]]. </p></li>
 
<li>See the "Additional setup" sections below for the components you use at your site. </li>
</ol>


<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.
==Additional setup==


<table class="thJustBold">
===Additional setup for SirLib===
<tr class="head"><th colspan="2">RKTools required parameter minimums</th></tr>
Read and follow the instructions in the [[SirLib "getting started" steps]].
<tr><th>Parameter</th><th>Value</th></tr>


<tr><th>SCRNSTBL</th>
===Additional setup for SirScan===
<td>12000</td></tr>
The <var class="product">SirScan</var> administrator can use SIRADMIN to set default I/O and record maximums for users in the various <var class="product">SirScan</var> SCLASSes. See [[SirScan setup#Updating the SirScan SCLASS maximums in SIRADMIN|SirScan setup]] for details.
</table>
</blockquote>


====Additional setup for SirLib====
===Additional setup for SirMon===
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.
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.
Any user added to this SCLASS gains the ability to <var>BUMP</var> other users.
Line 528: Line 461:
Only users in the ADMIN SCLASS are able to add custom screen definitions to <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,
If the <var class="product">SirMon</var> [[SirMon background monitor|background monitor]] is to be used, add the following line to the User 0 input stream:
add the following line to User 0's input stream:
<p class="code">SIRMON BACKGROUND
<p class="code">SIRMON BACKGROUND
</p>
</p>
The background monitor may also be started automatically in a BATCH2 thread or an sdaemon thread.
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.
You can customize statistic thresholds or use the supplied defaults to establish problem conditions.
   
   
As of <var class="product">RKTools</var> Version 6.8, <var class="product">SirMon</var> has a feature to send warnings to
The background monitor also lets you send warnings to
e-mail addresses and cell phones (via e-mail).
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.
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.
   
   
====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&nbsp;0's input stream:
<p class="code">SIRFILE BACKGROUND
<p class="code">SIRFILE BACKGROUND
</p>
</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
As with <var class="product">SirMon</var>, the background monitor may be started automatically in a BATCH2 thread or in an sdaemon thread. See [[SirFile refresh process]] for details.
<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
You can customize the system and file-specific thresholds or use the
supplied defaults to establish problem conditions.
supplied defaults to establish problem conditions.


====RKTools access privileges and SCLASSes====
===Additional setup for RKWeb===
Each component application of <var class="product">RKTools</var> has its own APSY definition and
New for RKTools version 7.7 (and requiring at least Model&nbsp;204 version 7.6), [[RKWeb]]  (Model 204 Tools on the Web) provides web access for all the important elements of Model&nbsp;204. Use of this product requires <var class="product">[[Janus Web Server]]</var>. If your site does not own Janus Web Server, RKWeb can still be used by a limited number of Janus Web threads under the Janus TOGA agreement, which allows the running of as many as five web threads.
privileges associated with SCLASSes.
<p>
If you have a good reason for doing so, you can redefine any of the <var class="product">RKTools</var> APSYs as <var>PUBLIC</var>,
Because RKWeb includes an interface for password maintenance and other protected Model&nbsp;204 entities, <i>it is mandatory to run it on an SSL-protected web port</i>. Experienced users of Janus Web will probably have Janus ports already defined and protected by SSL certificates. Users new to Janus Web might want to review [[#Defining a Janus port and generating a self-signed SSL certificate|Defining a Janus port and generating a self-signed SSL certificate]], below, on defining an unprotected port that can be used to generate an initial self-signed certificate. </p>
<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.
====Browser support and configuration====
RKWeb supports Edge, Chrome, and the latest versions of Firefox and Safari. IE (Internet Explorer) is explicitly <i>not</i> supported as it is deprecated by Microsoft.


==RKTools on the Web==
On some browsers, it might be necessary to allow pop-ups or to whitelist your RKWeb port so that pop-ups are authorized.
Web-specific versions of the <var class="product">RKTools</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">RKTools</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.
RKWeb makes extensive use of Javascript, which must be enabled for your browser.


===Setup for web-based SirScan===
====Janus Web port definition====
Web-based <var class="product">SirScan</var> is very lightweight, and requires a minimum of web rules to run.
Authorized Janus Web Server users will find that RKWeb works best with at least ten Janus Web threads available on the port definition. Non-Janus customers can still use RKWeb via the free [[Janus Web Server#Limited Janus Web Server|Limited Janus Web Server]] feature, which allows a Janus Web port to be defined with as many as five threads. Under this configuration, RKWeb might operate a little slowly and might require occasional forced-refreshes, but all features are otherwise allowed.
<ol>
<li>Define a <var class="product">Janus Web Server</var> port.


<li>Define the following rule to invoke <var class="product">SirScan</var>:
An SSL-protected web port can be defined like this:


<p class="code">JANUS WEB <var class="term">portname</var> ON /SIRSCAN/* CMD 'SIRSCAN *'
<p class="code">JANUS DEFINE <i>portname</i> 8205 WEBSERV 20 IBSIZE 4096 OBSIZE 65534 TRACE 1 -   
      RBSIZE 4096 UPCASE SESCOOKIE RKSESSION SSLSES VARIPADDR -                   
      SSL JANSSL JUNE2017.PKEY SSLCACHE 320 SSLMAXCERTL 2048 -         
      SSLIBSIZE 32767 SSLOBSIZE 16000 -                               
      WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 2000 COMPRESS 1         
JANUS START <i>portname</i>
<i>privateKeyPassword</i>
</p>
</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:
Such an SSL port as defined above will not start unless you have already obtained a signed certificate. To do so, you can start with an unsecured port and use the JANSSL application to [[#Defining a Janus port and generating a self-signed SSL certificate|generate a self-signed SSL certificate]].


<p class="code">JANUS WEB <var class="term">portname</var> DISALLOW /SIRSCAN/*
RKWeb also provides an interface (<code>Manage > SSL Certificates</code>) for running the [[Janus Network Security]] application (JANSSL) for obtaining and managing SSL certificates. The RKWeb version of this application mimics the
JANUS WEB <var class="term">portname</var> ALLOW /SIRSCAN/* USER *
operation of the application that is described in detail in the Janus Network Security wiki pages.
 
====Janus Web rules for RKWeb====
Following are the recommended and mandatory [[JANUS WEB rule matching order and examples|Janus rules]] to run RKWeb:
 
<p class="code" style = "font-size:80%"><b></b>*... Codepage 0037... json requires square brackets to be Unicode 5B & 5D
<b></b>*... translate EBCDIC BA/BB accordingly
UNICODE TABLE STANDARD MAP E=BA IS U=005B
UNICODE TABLE STANDARD MAP E=BB IS U=005D
 
<b></b>*... TYPE rules for serving up binaries
JANUS WEB <i>portname</i> TYPE ANY * TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTML TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY / TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTM TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.GIF IMAGE/GIF
JANUS WEB <i>portname</i> TYPE ANY *.PNG IMAGE/PNG
JANUS WEB <i>portname</i> TYPE ANY *.CSS TEXT/CSS
JANUS WEB <i>portname</i> TYPE ANY *.JS TEXT/JAVASCRIPT
JANUS WEB <i>portname</i> TYPE ANY *.JPEG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.JPG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.ICO IMAGE/X-ICON
 
<b></b>*... support for the Ace Editor, part of RKWeb
JANUS WEB <i>portname</i> ON /ACE/*                OPEN M204PROC SEND * TEXT
JANUS WEB <i>portname</i> ON /ACE/EDITOR            OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/EDITOR.JSON      OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST          OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST.JSON    OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/S.SETTINGS.PNG    OPEN M204PROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/S.SIRLIB_SEQ.PNG  OPEN M204PROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/*.JS              OPEN M204PROC SEND *.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/SRC/SNIPPETS/*.JS OPEN M204PROC SEND /ACE/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/*.JS          OPEN M204PROC SEND /ACE/SRC/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/MODE-M204.JS  OPEN M204PROC SEND MODE-M204.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/LIB/*.JS          OPEN M204PROC SEND *.JS BINARY EXPIRE +999999
 
<b></b>*... RKWeb rules:
JANUS WEB <i>portname</i> ON /RKWEB/* CMD RKWEB
JANUS WEB <i>portname</i> ON /RKWEB/*.CSS          OPEN FILE M204PROC SEND "1.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JS          OPEN FILE M204PROC SEND "1.JS  TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.GIF          OPEN FILE M204PROC SEND "1.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.PNG          OPEN FILE M204PROC SEND "1.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPG          OPEN FILE M204PROC SEND "1.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPEG        OPEN FILE M204PROC SEND "1.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.CSS        OPEN FILE M204PROC SEND "2.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JS        OPEN FILE M204PROC SEND "2.JS  TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.GIF        OPEN FILE M204PROC SEND "2.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.PNG        OPEN FILE M204PROC SEND "2.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPG        OPEN FILE M204PROC SEND "2.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPEG      OPEN FILE M204PROC SEND "2.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/RKWSEND/*.*  OPEN FILE M204PROC SEND "2."3  EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWSEND/*            OPEN FILE M204PROC SEND *      EXPIRE +7200
 
<b></b>*... Rules supporting the applications implemented as Janus Legacy apps.
JANUS WEB <i>portname</i>  DISALLOW /ACE*
JANUS WEB <i>portname</i>  DISALLOW /RKW*
JANUS WEB <i>portname</i>  DISALLOW /SIRLIB*
JANUS WEB <i>portname</i>  DISALLOW /DICTADMIN*
JANUS WEB <i>portname</i>  DISALLOW /DICTREPORT*
JANUS WEB <i>portname</i>  DISALLOW /DICTDOC*
JANUS WEB <i>portname</i>  DISALLOW /XREF*
JANUS WEB <i>portname</i>  DISALLOW /FILEMGMT*
JANUS WEB <i>portname</i>  DISALLOW /CCACATREPT*
JANUS WEB <i>portname</i>  DISALLOW /CCATSF*
 
JANUS WEB <i>portname</i>  ALLOW    /ACE*        USER *
JANUS WEB <i>portname</i>  ALLOW    /RKW*        USER *
JANUS WEB <i>portname</i>  ALLOW    /SIRLIB*    USER *
JANUS WEB <i>portname</i>  ALLOW    /DICTADMIN*  USER *
JANUS WEB <i>portname</i>  ALLOW    /DICTREPORT* USER *
JANUS WEB <i>portname</i>  ALLOW    /DICTDOC*    USER *
JANUS WEB <i>portname</i>  ALLOW    /XREF*      USER *
JANUS WEB <i>portname</i>  ALLOW   /FILEMGMT*  USER *
JANUS WEB <i>portname</i>  ALLOW    /CCACATREPT* USER *
JANUS WEB <i>portname</i>  ALLOW    /CCATSF*    USER *
 
JANUS WEB <i>portname</i>  ON /SIRLIB*    CMD 'SIRLIB *'
JANUS WEB <i>portname</i>  ON /DICTADMIN*  CMD 'DICTADMIN *'
JANUS WEB <i>portname</i>  ON /DICTREPORT* CMD 'DICTREPORT *'
JANUS WEB <i>portname</i>  ON /DICTDOC*    CMD 'DOCUMENT *'
JANUS WEB <i>portname</i>  ON /XREF*      CMD 'XREF *'
JANUS WEB <i>portname</i>  ON /FILEMGMT*  CMD 'FILEMGMT *'
JANUS WEB <i>portname</i>  ON /CCACATREPT*  CMD 'CCACATREPT *'
JANUS WEB <i>portname</i>  ON /CCATSF*  CMD 'CCATSF *'
 
JANUS WEB <i>portname</i> SCREEN /SIRLIB/* -
  EXITURL    '/rkweb/' EXITKEY 'Exit SirLib' AUTOPF ON CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' -
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /DICTADMIN* -
  EXITURL    '/rkweb/' EXITKEY 'Exit DictAdmin' AUTOPF ON  CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' -
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /DICTREPORT* -
  EXITURL    '/rkweb/' EXITKEY 'Exit DictReport' AUTOPF ON  CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' -
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /DICTDOC*  -
  EXITURL    '/rkweb/' EXITKEY 'Exit Document' AUTOPF ON  CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' -
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
JANUS WEB <i>portname</i> SCREEN /XREF*  -
  EXITURL    '/rkweb/' EXITKEY 'Exit Xref' AUTOPF ON  CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' -
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /FILEMGMT*    -
  EXITURL    '/rkweb/' EXITKEY 'Exit FileMgmt' AUTOPF ON CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' - 
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /CCACATREPT*    -
  EXITURL    '/rkweb/' EXITKEY 'Exit CCACatRept' AUTOPF ON CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' - 
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
 
JANUS WEB <i>portname</i> SCREEN /CCATSF*    -
  EXITURL    '/rkweb/' EXITKEY 'Exit CCATSF' AUTOPF ON CSS /styles/cool.css -
  BGCOLOR 'white' TEXT 'black' - 
  BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'
START SUBSYSTEM DICTADMIN
START SUBSYSTEM DICTREPORT
START SUBSYSTEM DOCUMENT
START SUBSYSTEM XREF
START SUBSYSTEM FILEMGMT
START SUBSYSTEM CCACATREPT
START SUBSYSTEM CCATSF
</p>
</p>


<li>Because the above rules force users to login, the port on which <var class="product">SirScan</var> runs should either:
Again, as described earlier in [[#Janus Web port definition|Janus Web port definition]], because the above rules force users to log in with their enterprise credentials, and because RKWeb provides an interface into protected elements like passwords and APSY definitions, the port on which <var class="product">RKWeb</var> runs must be SSL protected.
<ul>
 
<li>Be only on a company intranet. </li>
To verify that the Janus Web rules are defined and that the SSL and unsecured ports are started, issue a <code>[[JANUS STATUS|JANUS STATUS *]]</code> command.
 
Once the rules are implemented and the port is started, You can access RKWeb with a URL like this:
 
<p class="code"><nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki></p>
 
In addition to web rules, if low-privileged users are to be given access to RKWeb, certain system level methods need to be made available to those users. The following commands are required to implement this:


<li>Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format. </li>
<p class="code">SIRMETH ALLOW SYSTEMSET SUBSYSTEM RKW* NONPRE
</ul>
SIRMETH ALLOW SUBSYSTEMSET SUBSYSTEM RKW* NONPRE
<p>
SIRMETH ALLOW SYSTEMSET SUBSYSTEM SIR* NONPRE
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>
</p>
</ol>


===Setup for web-based SirMon===
As implied by the recommended and mandatory <var>JANUS WEB</var> rules above, some RKWeb applications are implemented with [[Janus Web Legacy Support|Janus Legacy]], which launches them into a separate browser tab. These Janus Legacy applications are not fully integrated with RKWeb, so you must use the security configured for those applications. For instance, [[Dictionary/204 FILEMGMT overview#Prerequisites|FILEMGMT]] is implemented as Janus Legacy, and it might prompt the user for a separate password.
This applies only to <var class="product">RKTools</var> Version 8.1 and later.


Because web-based <var class="product">SirMon</var> employs XML, XSLT, Javascript, a stylesheet and some graphics,
===Additional setup for JANSSL===
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>:
====Defining a Janus port and generating a self-signed SSL certificate====
You can run RKWeb on any SSL-protected Janus port, and experienced users are likely to add the [[#Janus Web rules for RKWeb|recommended Janus rules]] to a port or ports they already have configured.


<p class="code">JANUS WEB <var class="term">portname</var> TYPE ANY *.PNG IMAGE/PNG           
New users might need to define an initial <em>unprotected</em> Janus port that can then be used to generate a self-signed certificate. That certificate is then used to protect the port on which RKWeb is to run. Directions follow:
JANUS WEB <var class="term">portname</var> TYPE ANY *.CSS TEXT/CSS   
<ol>
JANUS WEB <var class="term">portname</var> TYPE ANY *.JS APPLICATION/X-JAVASCRIPT 
<li>Enter these rules to create a very basic Janus Web port:
JANUS WEB <var class="term">portname</var> ON /*.CSS OPEN SIRIUS SEND *.CSS
<p class="code">JANUS DEFINE MYWEBPORT 80 WEBSERV 10 IBSIZE 4096 OBSIZE 8192 TRACE 1 RBSIZE 4096 -
JANUS WEB <var class="term">portname</var> ON /SIRMON/* CMD SIRMON       
     UPCASE WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 1000
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
JANUS WEB MYWEBPORT ON / OPEN FILE M204PROC CMD 'INCLUDE JANWEB.HOMEPAGE.HTML'
IN SIRSTATS INITIALIZE KEEPDEFS                                         
JANUS WEB MYWEBPORT ON /JANSSL/* OPEN FILE M204PROC CMD 'INCLUDE JANSSL.*'   
</p> </li>
JANUS WEB MYWEBPORT ON /JANWEB/* OPEN FILE M204PROC CMD 'INCLUDE JANWEB.*'


<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:
* ALLOW rules that will force a logon for the JANSSL application.
* These will result in a warning, which is expected, but can be ignored.
JANUS WEB MYWEBPORT DISALLOW *
JANUS WEB MYWEBPORT ALLOW * USER * 


<p class="code">JANUS WEB <var class="term">portname</var> DISALLOW /SIRMON/*
JANUS START MYWEBPORT </p></li>
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:  
<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<ul>
<li>Be only on a company intranet.
<li>With the following URL, invoke the Janus default home page:
<p class="code"><nowiki>http://</nowiki>www.<i>mydomain</i>.com:<i>xxxx</i> </p>
<p>
where <var class="term">xxxx</var> is the port number. In the preceding port definition, <code>80</code> is the default port for web connections. Your network administrator might require a different port number. </p>
<p>
On the Janus default home page, click the link to the JANSSL certificate management program. </p></li>
 
<li>Using your own domain name and port number, connect directly to the JANSSL certificate management program:


<li>Be SSL protected, to prevent userids and passwords from being sent over the internet in clear text format. 
<p class="code"><nowiki>http://</nowiki>www.<i>mydomain</i>.com:9999/janweb/sslmain.html </p></li>
</ul>
</ul></li>


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.
<li>Use the certificate management program to generate a self-signed certificate.
<p>
The program contains ample online Help. Follow the instructions for generating a self-signed certificate. </p></li>


<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>
<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>
</ol>
[[Category: RKTools]]

Latest revision as of 17:03, 9 October 2017

Overview

RKTools (Rocket Tools for Model 204) is a set of application subsystems (aka APSYs) running inside a Model 204 Online that provide TN3270 and web-based tools for programmers, database administrators, and system managers.

As of RKTools V7.7, all Rocket-provided, SOUL-based tools are consolidated in the M204PROC procedure file. M204PROC includes all components from RKTools 7.5 in addition to Dictionary/204 and the SQL Server utilities. This means that all Model 204 SOUL tools provided by Rocket are in a single file.

Note: Since the RKTools 7.7 installation process modifies the application subsystem definitions to point to the M204PROC file, sites that are upgrading must perform a full installation and not merely an M204PROC file overlay. To allow for a switch back to RKTools 7.5, keep a backup of your current SIRIUS file and your current CCASYS file (though you can also change the subsystem definitions manually using SUBSYSMGMT).

Installing RKTools requires downloading the M204PROC file from the Model 204 maintenance website, restoring it to your environment, setting up some subsidiary Model 204 files, and verifying that the Online environment has the appropriate parameter settings. Then you run a single procedure that installs or upgrades the RKTools subsystems.

Once the installation is complete, upgrades to RKTools can almost always be handled by restoring a fresh copy of the M204PROC file.

Download the installation file

All RKTools 7.7 code resides in the M204PROC Model 204 file. You need to download a dump version of this file from the Rocket Software Model 204 maintenance website. The procedure file for RKTools 7.5 is SIRIUS.

To download from the Rocket website:

  1. On the "Rocket M204 Customer Care" page (http://m204.rocketsoftware.com), go to the "Downloads and Uploads" section and select the "Download SOUL files" link to access the "SOUL files for Rocket Software" page.
  2. Log in, and download the version of RKTools that is compatible with your version of Model 204. The procedure file contained in the "RKTools V7.7" link works for Model 204 versions 7.6 and above. For Model 204 version 7.5, use the download labeled "RKTools V7.5."

    A "Click here" link in the text above the file list on the SOUL files download page brings up Downloading and restoring SOUL files, which provides help about downloading and uploading files, file sizing, and more.

You can bypass any step of the installation that applies only to an RKTools component you are not installing.

System requirements

  • RKTools V7.7 was made specifically backward compatible to Model 204 version 7.6, though version 7.7 is recommended. Version 7.5 of RKTools requires Model 204 version 7.5 or higher.
  • Requirements for server sizes for each product and Model 204 User 0 and UTABLE parameter settings are listed where appropriate in the installation steps in the next section.
  • To verify the products for which your Online is authorized, 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
    • Model 204 System Manager privileges
    • Access to the SUBSYSMGMT facility and the JCL or EXEC that runs the Online Model 204 region.

Install RKTools

Attention: If you are upgrading from a previous version, keep your old copies of SIRLOCAL, M204LOCL, and most application-specific data files, such as JANCAT, SIRLIBD, and SIRFILED. The SirMon SIRSTATS file is replaced in version 7.7 by MONDATA. The SIRIUS file is no longer used as of RKTools 7.7, but there is no harm in keeping it in case you want to fall back to a previous RKTools version.

The installation process uses your existing RKTools files to determine whether to perform upgrade actions or new-installation actions, so leave these files allocated and available, including SIRLOCAL.

  1. Allocate files.

    The following table shows the RKTools files and their sizes:

    RKTools file allocations
    FileSizeAllocation is required...
    M204PROC 9800 pages Always.
    SIRLOCAL 1200 pages Always.
    M204LOCL 3000 pages If using RKWeb.
    MONDATA 4000 pages Only if installing SirMon.

    Note: MONDATA replaces SIRSTATS, which is no longer needed as of RKTools V7.7.

    SIRFILED 1200 pages Only if installing SirFile.
    SIRLIBD 1200 pages Only if installing SirLib.
    SIRLIBP 1200 pages Only if installing SirLib.
    JANCAT 1200 pages Only if installing Janus OMNI.
    JANSSL 1200 pages Only if installing Janus SSL or RKWeb.

    The following table shows the Dictionary/204 supporting files (in addition to M204PROC):

    FileSizeAllocation is required...
    DATALINK 400 pages For Dictionary/204 or SQL Server.
    METADATA 400 pages For Dictionary/204 or SQL Server.
    M204TEMP 400 pages If installing Dictionary/204.
    D204RPT 400 pages If installing Dictionary/204.
    D204SYS 400 pages If installing Dictionary/204.
    M204DCTL 400 pages If installing Dictionary/204.

    The following table shows the SQL Server supporting files (in addition to M204PROC):

    SQL Server file allocations
    FileSizeAllocation is required...
    CCACAT 700 pages For RKWeb access to SQL Server.
    DATALINK 400 pages For Dictionary/204 or SQL Server.
    METADATA 400 pages For Dictionary/204 or SQL Server.
    TSFDATA 200 pages For RKWeb access to SQL Server.
    TSFTEMP 300 pages For RKWeb access to SQL Server.
  2. RESTORE M204PROC from the DUMP file downloaded from the Rocket website.

    Note: If you are restoring into your existing M204PROC file, note that the M204PROC file has X'0221' privileges, which does not allow RESTORE. You will have to CREATE the file first (to wipe out existing content) before you execute the RESTORE. A sample command sequence is:

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

    To verify the M204PROC version, you can open M204PROC with SirPro and view the RKTOOLS_VERSION procedure.

  3. Update the Online JCL or EXEC:
    1. Add DD (MVS) cards or FILEDEFs (CMS) for the RKTools files. The "RKTools file allocations" table above lists the files for which DD cards or FILEDEFs might be needed.
    2. Verify that the Online environment allows the use of file groups and application subsystems.
      • To use permanent file groups, the Online must have allocated a CCAGRP file, and the SYSOPT parameter must include the 2 bit.
      • To use APSY subsystems, an Online must have allocated a CCASYS file, and the SYSOPT parameter must include the 1 bit.
    3. Review the RKTools, Dictionary/204, and Model 204 SQL Server tables below for the minimum server-size requirements of individual subsystem components.

      Note: The actual server size requirements might vary slightly from the listings below because of table settings in your Model 204 Online, and because of slight differences between UTABLE requirements in different versions of Model 204.

      Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component. For more information about server sizing, see Sizing user server areas.

      Note: CCATEMP usage might 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 sizes
      Subsystem name Minimum server size
      JANSSL 300K
      RKTOOLS 135K
      SIRADMIN 150K
      SIRDBA 180K
      SIRFILE 230K
      SIRLIB 135K
      SIRMON 220K
      SIRPRO 750K
      SIRSCAN 250K
      Dictionary server sizes
      Subsystem name Minimum server size
      DICTADMIN 455K
      DICTIONARY 455K
      DICTREPORT 455K
      DOCUMENT 455K
      FILEMGMT 455K
      SUBSYSMGMT 455K
      XREF 455K
      SQL Server server sizes
      Subsystem nameMinimum server size
      CCACATREPT 250000
      CCATSF 165000
  4. Verify that the Online has a minimum of 10 Sdaemon threads allocated. Each of these threads is typically defined as an IODEV15 thread. If using RKWeb or any of the web interfaces to other components, you may need more IODEV15s available.
  5. Modify the User 0 stream.

    Adjust these parameters:

    Parameter Adjustment
    COMPOPT RKTools requires the COMPOPT X'03' bit, which enables mixed-case SOUL. RKTools makes extensive use of mixed-case coding, and the tools fail to compile if support is not enabled. If batch SirLib or other batch features are used, ensure that COMPOPT is set to X'03' in those jobs as well.
    CUSTOM RKWeb must include the 18 setting to enable a larger SSLIBSIZE on the Janus Web port, which must be secured.
    MAXBG Minimum setting is 4.
    MAXDAEM Minimum setting is 10.
    MAXINCL Minimum setting is 10.
    NDCBS Increase by the number of RKTools files.
    NDIR Increase by the number of RKTools files.
    NFILES Increase by the number of RKTools files.
    NORQS Minimum setting is 5.
    SESNPUB Minimum setting is 40. The right setting for your site might be higher, based on RKWeb usage (number of users).
    SESUMAX Minimum setting is 10. The right setting for your site might be higher, based on RKWeb usage (number of users).
  6. Verify you have adequate UTABLE settings.

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

    These are the recommended settings:

    UTABLE parameter Value Description
    HTLEN 220 Max length of each header or trailer
    LFTBL 1000 Length of FTBL
    LFSCB 21400 Length of full screen buffer
    LGTBL 2000 Length of global variable table
    LIBUFF 2000 Length of input buffer
    LITBL 104 Length of ITBL
    LNTBL 450 Length of NTBL
    LOBUFF 960 Length of output buffer
    LOUTPB 10000 Length of output page buffer
    LPDLST 10000 Length of user push down list
    LQTBL 2200 Length of QTBL
    LSTBL 60000 Length of STBL
    LTTBL 2000 Length of TTBL
    LVTBL 1300 Length of VTBL
    LXTBL 1000 Length of XTBL
    MAXHDR 7 Max number of headers
    MAXTRL 7 Max number of trailers
    NORQS 10 Number of requests preserved
    SCRNSTBL 12000 STBL size for screen objects; this must be set for SIRMON, SIRPRO, and SIRSCAN.

    A setting of 18000 is recommended for shops that use Mod 6 terminals with very large screen sizes (Rocket regularly tests with 3270 screen sizes of 50x150 characters).

    Note: Either 12000 or 18000 is both a recommended minimum and maximum. Unless you have very large servers at your site (1 megabyte or larger), or you have very large screen objects in your own application code, a very large SCRNSTBL will cause table-size resets to fail.

    SEQPDL 4096 Minimum PDL available for sequencer
  7. Bring up the Online and install all the RKTools components except Dictionary/204 and SQL Server; then install or reinstall Dictionary/204 and SQL utilities as needed:

    1. RKTools 7.5 components

      Issue these commands:

      OPEN FILE CCASYS OPEN FILE M204PROC INCLUDE RKTOOLS_INSTALL

      RKTOOLS_INSTALL creates or updates the dozen or so RKTools application subsystems and sets up their supporting files. It performs all installation functions for new sites and all upgrade functions for reinstalling sites. No existing user profiles or other site-specific customization will be lost, as long as your existing SIRLOCAL file is left in place.

      The procedure produces a screen that lists all of the subsystems and whether they have loaded. It may be necessary to troubleshoot why expected subsystems did not load, then re-execute the procedure. You are encouraged to use the installation program's F1-key Help for detailed explanation of how the program is working with the subsystems.

      During APSY subsystem execution, error messages are not suppressed, which aids 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, and so on.

      The procedure RKTOOLS_INSTALL also builds a subsystem called RKINSTALL. If the installation needs to be re-run, you can invoke the subsystem (from command line or later with option 9 in the RKTools main menu) rather than the procedure.

      Once the installation completes successfully, start the component subsystems (START SUBSYSTEM command, invoke by name, or both) before using the RKTools 3270 or RKWeb interface.

      To verify that the subsystems are correctly installed, enter RKTOOLS at the command line, and use the main menu to test the individual RKTools components. You may also want to use SUBSYSMGMT to check that the component subsystem definitions are viewable, and use SirPro to display the newly restored M204PROC file to ensure its availability.

    2. Dictionary/204

      Though the Dictionary/204 components are delivered in M204PROC and accessible from RKWeb as of version 7.7, they are not installed and set up by RKTOOLS_INSTALL. For example, on z/OS, an initial Dictionary/204 installation uses the DDINST JCL from the Model 204 RKOBJLIB; for an upgrade, the DDRINST job.

      Though the Dictionary/204 installation steps are largely included in the the RKTools installation process, you may want to review the Dictionary/204 installation guide for any additional actions you might need to take.

    3. SQL Server

      The Model 204 SQL Server components are delivered in M204PROC, and the SQL Server tools (CCACATREPT, CCATSF) are accessible from RKWeb. Support for this use of RKWeb requires the availability of the SQL Server supporting files.

      For an initial installation of the SQL Server subsystems, open M204PROC and execute the following command:

      INCLUDE SQLINST

      For a reinstallation:

      INCLUDE SQLRINST

      If you are installing and using SQL Server independently apart from RKTools and RKWeb, or you have additional questions about SQL Server installation, see Model 204 SQL Server installation.

  8. Use SUBSYSMGMT to add users to the appropriate SCLASS classes for any private or semi-public RKTools subsystems.

    For authority to do this, you need System Administrator log in privileges, and you need SUBSYSMGMT privileges authorized via the DICTADMIN facility of Dictionary/204. The ID of the user that runs the INSTALL_RKTOOLS procedure is automatically added to the ADMIN or to the highest-level administration SCLASS in each of the RKTools subsystems (though not necessarily to the Dictionary and SQL Server subsystems).

    Each component application of RKTools has its own APSY subsystem definition and privileges associated with SCLASS specifications. If you have a good reason for doing so, you can redefine any of the RKTools subsystems as PUBLIC, SEMI-PUBLIC, or PRIVATE. Contact Rocket Software if you are unsure of the effect of a proposed change.

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

    The RKWeb interface, described further below in Additional setup for RKWeb, is controlled by the RKWEB subsystem, and you need to update the subsystem definition with the names of eligible users. Some of the RKWeb options require system administrator login privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires system administrator login privileges and ADMIN SCLASS membership in the RKWEB subsystem, as well as a suitable product license.

  9. See the "Additional setup" sections below for the components you use at your site.

Additional setup

Additional setup for SirLib

Read and follow the instructions in the SirLib "getting started" steps.

Additional setup for SirScan

The SirScan administrator can use SIRADMIN to set default I/O and record maximums for users in the various SirScan SCLASSes. See SirScan setup for details.

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 the User 0 input stream:

SIRMON BACKGROUND

The background monitor may also be started automatically in a BATCH2 thread or an sdaemon thread.

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

The background monitor also lets you 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. See SirFile refresh process for details.

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

Additional setup for RKWeb

New for RKTools version 7.7 (and requiring at least Model 204 version 7.6), RKWeb (Model 204 Tools on the Web) provides web access for all the important elements of Model 204. Use of this product requires Janus Web Server. If your site does not own Janus Web Server, RKWeb can still be used by a limited number of Janus Web threads under the Janus TOGA agreement, which allows the running of as many as five web threads.

Because RKWeb includes an interface for password maintenance and other protected Model 204 entities, it is mandatory to run it on an SSL-protected web port. Experienced users of Janus Web will probably have Janus ports already defined and protected by SSL certificates. Users new to Janus Web might want to review Defining a Janus port and generating a self-signed SSL certificate, below, on defining an unprotected port that can be used to generate an initial self-signed certificate.

Browser support and configuration

RKWeb supports Edge, Chrome, and the latest versions of Firefox and Safari. IE (Internet Explorer) is explicitly not supported as it is deprecated by Microsoft.

On some browsers, it might be necessary to allow pop-ups or to whitelist your RKWeb port so that pop-ups are authorized.

RKWeb makes extensive use of Javascript, which must be enabled for your browser.

Janus Web port definition

Authorized Janus Web Server users will find that RKWeb works best with at least ten Janus Web threads available on the port definition. Non-Janus customers can still use RKWeb via the free Limited Janus Web Server feature, which allows a Janus Web port to be defined with as many as five threads. Under this configuration, RKWeb might operate a little slowly and might require occasional forced-refreshes, but all features are otherwise allowed.

An SSL-protected web port can be defined like this:

JANUS DEFINE portname 8205 WEBSERV 20 IBSIZE 4096 OBSIZE 65534 TRACE 1 - RBSIZE 4096 UPCASE SESCOOKIE RKSESSION SSLSES VARIPADDR - SSL JANSSL JUNE2017.PKEY SSLCACHE 320 SSLMAXCERTL 2048 - SSLIBSIZE 32767 SSLOBSIZE 16000 - WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 2000 COMPRESS 1 JANUS START portname privateKeyPassword

Such an SSL port as defined above will not start unless you have already obtained a signed certificate. To do so, you can start with an unsecured port and use the JANSSL application to generate a self-signed SSL certificate.

RKWeb also provides an interface (Manage > SSL Certificates) for running the Janus Network Security application (JANSSL) for obtaining and managing SSL certificates. The RKWeb version of this application mimics the operation of the application that is described in detail in the Janus Network Security wiki pages.

Janus Web rules for RKWeb

Following are the recommended and mandatory Janus rules to run RKWeb:

*... Codepage 0037... json requires square brackets to be Unicode 5B & 5D *... translate EBCDIC BA/BB accordingly UNICODE TABLE STANDARD MAP E=BA IS U=005B UNICODE TABLE STANDARD MAP E=BB IS U=005D *... TYPE rules for serving up binaries JANUS WEB portname TYPE ANY * TEXT/HTML JANUS WEB portname TYPE ANY *.HTML TEXT/HTML JANUS WEB portname TYPE ANY / TEXT/HTML JANUS WEB portname TYPE ANY *.HTM TEXT/HTML JANUS WEB portname TYPE ANY *.GIF IMAGE/GIF JANUS WEB portname TYPE ANY *.PNG IMAGE/PNG JANUS WEB portname TYPE ANY *.CSS TEXT/CSS JANUS WEB portname TYPE ANY *.JS TEXT/JAVASCRIPT JANUS WEB portname TYPE ANY *.JPEG IMAGE/JPEG JANUS WEB portname TYPE ANY *.JPG IMAGE/JPEG JANUS WEB portname TYPE ANY *.ICO IMAGE/X-ICON *... support for the Ace Editor, part of RKWeb JANUS WEB portname ON /ACE/* OPEN M204PROC SEND * TEXT JANUS WEB portname ON /ACE/EDITOR OPEN M204PROC CMD 'RKWEB' JANUS WEB portname ON /ACE/EDITOR.JSON OPEN M204PROC CMD 'RKWEB' JANUS WEB portname ON /ACE/PROCLIST OPEN M204PROC CMD 'RKWEB' JANUS WEB portname ON /ACE/PROCLIST.JSON OPEN M204PROC CMD 'RKWEB' JANUS WEB portname ON /ACE/S.SETTINGS.PNG OPEN M204PROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999 JANUS WEB portname ON /ACE/S.SIRLIB_SEQ.PNG OPEN M204PROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999 JANUS WEB portname ON /ACE/*.JS OPEN M204PROC SEND *.JS TEXT JANUS WEB portname ON /ACE/SRC/SNIPPETS/*.JS OPEN M204PROC SEND /ACE/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999 JANUS WEB portname ON /ACE/SRC/*.JS OPEN M204PROC SEND /ACE/SRC/*.JS BINARY EXPIRE +999999 JANUS WEB portname ON /ACE/SRC/MODE-M204.JS OPEN M204PROC SEND MODE-M204.JS TEXT JANUS WEB portname ON /ACE/LIB/*.JS OPEN M204PROC SEND *.JS BINARY EXPIRE +999999 *... RKWeb rules: JANUS WEB portname ON /RKWEB/* CMD RKWEB JANUS WEB portname ON /RKWEB/*.CSS OPEN FILE M204PROC SEND "1.CSS TEXT EXPIRE +7200 JANUS WEB portname ON /RKWEB/*.JS OPEN FILE M204PROC SEND "1.JS TEXT EXPIRE +7200 JANUS WEB portname ON /RKWEB/*.GIF OPEN FILE M204PROC SEND "1.GIF EXPIRE +7200 JANUS WEB portname ON /RKWEB/*.PNG OPEN FILE M204PROC SEND "1.PNG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*.JPG OPEN FILE M204PROC SEND "1.JPG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*.JPEG OPEN FILE M204PROC SEND "1.JPEG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.CSS OPEN FILE M204PROC SEND "2.CSS TEXT EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.JS OPEN FILE M204PROC SEND "2.JS TEXT EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.GIF OPEN FILE M204PROC SEND "2.GIF EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.PNG OPEN FILE M204PROC SEND "2.PNG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.JPG OPEN FILE M204PROC SEND "2.JPG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/*.JPEG OPEN FILE M204PROC SEND "2.JPEG EXPIRE +7200 JANUS WEB portname ON /RKWEB/*/RKWSEND/*.* OPEN FILE M204PROC SEND "2."3 EXPIRE +7200 JANUS WEB portname ON /RKWSEND/* OPEN FILE M204PROC SEND * EXPIRE +7200 *... Rules supporting the applications implemented as Janus Legacy apps. JANUS WEB portname DISALLOW /ACE* JANUS WEB portname DISALLOW /RKW* JANUS WEB portname DISALLOW /SIRLIB* JANUS WEB portname DISALLOW /DICTADMIN* JANUS WEB portname DISALLOW /DICTREPORT* JANUS WEB portname DISALLOW /DICTDOC* JANUS WEB portname DISALLOW /XREF* JANUS WEB portname DISALLOW /FILEMGMT* JANUS WEB portname DISALLOW /CCACATREPT* JANUS WEB portname DISALLOW /CCATSF* JANUS WEB portname ALLOW /ACE* USER * JANUS WEB portname ALLOW /RKW* USER * JANUS WEB portname ALLOW /SIRLIB* USER * JANUS WEB portname ALLOW /DICTADMIN* USER * JANUS WEB portname ALLOW /DICTREPORT* USER * JANUS WEB portname ALLOW /DICTDOC* USER * JANUS WEB portname ALLOW /XREF* USER * JANUS WEB portname ALLOW /FILEMGMT* USER * JANUS WEB portname ALLOW /CCACATREPT* USER * JANUS WEB portname ALLOW /CCATSF* USER * JANUS WEB portname ON /SIRLIB* CMD 'SIRLIB *' JANUS WEB portname ON /DICTADMIN* CMD 'DICTADMIN *' JANUS WEB portname ON /DICTREPORT* CMD 'DICTREPORT *' JANUS WEB portname ON /DICTDOC* CMD 'DOCUMENT *' JANUS WEB portname ON /XREF* CMD 'XREF *' JANUS WEB portname ON /FILEMGMT* CMD 'FILEMGMT *' JANUS WEB portname ON /CCACATREPT* CMD 'CCACATREPT *' JANUS WEB portname ON /CCATSF* CMD 'CCATSF *' JANUS WEB portname SCREEN /SIRLIB/* - EXITURL '/rkweb/' EXITKEY 'Exit SirLib' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /DICTADMIN* - EXITURL '/rkweb/' EXITKEY 'Exit DictAdmin' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /DICTREPORT* - EXITURL '/rkweb/' EXITKEY 'Exit DictReport' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /DICTDOC* - EXITURL '/rkweb/' EXITKEY 'Exit Document' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /XREF* - EXITURL '/rkweb/' EXITKEY 'Exit Xref' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /FILEMGMT* - EXITURL '/rkweb/' EXITKEY 'Exit FileMgmt' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /CCACATREPT* - EXITURL '/rkweb/' EXITKEY 'Exit CCACatRept' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' JANUS WEB portname SCREEN /CCATSF* - EXITURL '/rkweb/' EXITKEY 'Exit CCATSF' AUTOPF ON CSS /styles/cool.css - BGCOLOR 'white' TEXT 'black' - BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00' START SUBSYSTEM DICTADMIN START SUBSYSTEM DICTREPORT START SUBSYSTEM DOCUMENT START SUBSYSTEM XREF START SUBSYSTEM FILEMGMT START SUBSYSTEM CCACATREPT START SUBSYSTEM CCATSF

Again, as described earlier in Janus Web port definition, because the above rules force users to log in with their enterprise credentials, and because RKWeb provides an interface into protected elements like passwords and APSY definitions, the port on which RKWeb runs must be SSL protected.

To verify that the Janus Web rules are defined and that the SSL and unsecured ports are started, issue a JANUS STATUS * command.

Once the rules are implemented and the port is started, You can access RKWeb with a URL like this:

https://www.mydomain.com/rkweb/welcome.html

In addition to web rules, if low-privileged users are to be given access to RKWeb, certain system level methods need to be made available to those users. The following commands are required to implement this:

SIRMETH ALLOW SYSTEMSET SUBSYSTEM RKW* NONPRE SIRMETH ALLOW SUBSYSTEMSET SUBSYSTEM RKW* NONPRE SIRMETH ALLOW SYSTEMSET SUBSYSTEM SIR* NONPRE

As implied by the recommended and mandatory JANUS WEB rules above, some RKWeb applications are implemented with Janus Legacy, which launches them into a separate browser tab. These Janus Legacy applications are not fully integrated with RKWeb, so you must use the security configured for those applications. For instance, FILEMGMT is implemented as Janus Legacy, and it might prompt the user for a separate password.

Additional setup for JANSSL

Defining a Janus port and generating a self-signed SSL certificate

You can run RKWeb on any SSL-protected Janus port, and experienced users are likely to add the recommended Janus rules to a port or ports they already have configured.

New users might need to define an initial unprotected Janus port that can then be used to generate a self-signed certificate. That certificate is then used to protect the port on which RKWeb is to run. Directions follow:

  1. Enter these rules to create a very basic Janus Web port:

    JANUS DEFINE MYWEBPORT 80 WEBSERV 10 IBSIZE 4096 OBSIZE 8192 TRACE 1 RBSIZE 4096 - UPCASE WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 1000 JANUS WEB MYWEBPORT ON / OPEN FILE M204PROC CMD 'INCLUDE JANWEB.HOMEPAGE.HTML' JANUS WEB MYWEBPORT ON /JANSSL/* OPEN FILE M204PROC CMD 'INCLUDE JANSSL.*' JANUS WEB MYWEBPORT ON /JANWEB/* OPEN FILE M204PROC CMD 'INCLUDE JANWEB.*' * ALLOW rules that will force a logon for the JANSSL application. * These will result in a warning, which is expected, but can be ignored. JANUS WEB MYWEBPORT DISALLOW * JANUS WEB MYWEBPORT ALLOW * USER * JANUS START MYWEBPORT

  2. Use either of the following ways to connect to the JANSSL certificate management program:
    • With the following URL, invoke the Janus default home page:

      http://www.mydomain.com:xxxx

      where xxxx is the port number. In the preceding port definition, 80 is the default port for web connections. Your network administrator might require a different port number.

      On the Janus default home page, click the link to the JANSSL certificate management program.

    • Using your own domain name and port number, connect directly to the JANSSL certificate management program:

      http://www.mydomain.com:9999/janweb/sslmain.html

  3. Use the certificate management program to generate a self-signed certificate.

    The program contains ample online Help. Follow the instructions for generating a self-signed certificate.

  4. Use the self-signed certificate to protect the port from which RKWeb will run.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=RKTools_installation&oldid=104375"