RKTools installation: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (add links)
No edit summary
Line 1: Line 1:
<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 3270 and web-based tools for programmers, database administrators, and system managers. <var class="product">RKTools</var> was formerly known as UL/SPF.
<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 3270 and web-based tools for programmers, database administrators, and system managers. <var class="product">RKTools</var> was formerly known as UL/SPF.


Installing <var class="product">RKTools</var> requires downloading the <code>SIRIUS</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 environment has the appropriate parameter settings.
Introduced in RKTools V7.7 (mid-2017), <var class="product">[[RKWeb]]</var> is a web-based version of the <var class="product">Model&nbsp;204</var> utilities and tools, including most of RKTools. RKWeb is installed as part of RKTools.


Upgrades to <var class="product">RKTools</var> can almost always be handled by restoring a fresh copy of the <code>SIRIUS</code> file.
Another important change in V7.7 is that tools formerly in the SIRIUS procedure have been moved to M204PROC, which means that all Model 204 tools provided by Rocket are in a single file. The RKTools install process will change the apsy definitions to point to the new procedure file - if you want to switch back to the previous version of RKTools you should keep a backup of your current CCASYS file (you could also change the apsy definitions manually via SUBSYSMGMT).
 
Because all Rocket Model204 procedure are now in one file, you should review the [[Dictionary/204 installation guide]] to see what steps, if any, related to SUBSYSMGMT, FILEMGMT, etc., might need to be run.
 
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 environment has the appropriate parameter settings.
 
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.


==Download the installation file==
==Download the installation file==
All <var class="product">RKTools</var> code resides in the <code>SIRIUS</code> <var class="product">[[Model 204]]</var> file. You will need to download a dump version of this file from the Rocket Software Model&nbsp;204 maintenance website.
All <var class="product">RKTools</var> code resides in the <code>M204PROC</code> <var class="product">[[Model 204]]</var> file. You will need to download a dump version of this file from the Rocket Software Model&nbsp;204 maintenance website.
   
   
To download from the Rocket website:
To download from the Rocket website:
Line 12: Line 18:
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, go to the "Downloads and Uploads" section and select the "Download SOUL files" link to access the "SOUL files for Rocket Software" page.  
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, 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 products in one file" followed by a version number).
<li>Log in, and download the latest version of the <code>M204PROC</code> file.  The RKTools held in M204PROC Version 7.7 will work for Model 204 releases 7.6 and above. For older releases of Model 204 use the download labeled "RKTools V7.5".
<p>
<p>
A "Click here" link on this page provides help about downloading and uploading files, file sizing, and more.</p></li>
A "Click here" link on the download page provides help about downloading and uploading files, file sizing, and more.</p></li>
</ol>
</ol>
Reinstalling <var class="product">RKTools</var> (for example, simply picking up the latest SOUL updates) typically involves nothing more than downloading and restoring a new version of the <code>SIRIUS</code> file.


You can bypass any step of the installation that applies only to a <var class="product">RKTools</var> module you are not installing.
You can bypass any step of the installation that applies only to a <var class="product">RKTools</var> module you are not installing.
Line 23: Line 27:
==System requirements==
==System requirements==
<ul>
<ul>
<li><var class="product">RKTools</var> operates in a <var class="product">Model&nbsp;204</var> Online region of the same or higher release number as <var class="product">RKTools</var>. In other words, version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model&nbsp;204</var> version 7.5 or higher.
<li><var class="product">RKTools</var> operates in a <var class="product">Model&nbsp;204</var> Online region of the same or higher release number as <var class="product">RKTools</var>. In other words, version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model&nbsp;204</var> version 7.5 or higher. RKTools V7.7 was made specifically backward compatible to M204 Version 7.6, thought Version 7.7 is recommended.
   
   
<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server sizes|RKTools server sizes]].</li>
<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server sizes|RKTools server sizes]].</li>
Line 36: Line 40:
</ul>
</ul>
</li>
</li>
<li>If you are upgrading from a previous version or maintenance level, your site already has a <code>SIRLOCAL</code> file, which holds users' profiles and other local customizations. Your existing <code>SIRLOCAL</code> should be left intact and allocated to the Online, because the installation process uses <code>SIRLOCAL</code> information to determine which features should be upgraded.</li>
</ul>
</ul>


==Installing RKTools==
==Installing RKTools==
<p class="warn"><b>Attention:</b> If you are upgrading from a previous release, keep your old copies of <code>SIRLOCAL</code> and any application-specific data files, such as <code>JANCAT</code>, <code>SIRLIBD</code>, <code>SIRFILED</code>, or <code>SIRSTATS</code>.
<p class="warn"><b>Attention:</b> If you are upgrading from a previous release, keep your old copies of <code>SIRLOCAL</code>, <code>M204LOCL</code> and any application-specific data files, such as <code>JANCAT</code>, <code>SIRLIBD</code>, <code>SIRFILED</code>, or <code>SIRSTATS</code>. As of RKTools V7.7, the <code>SIRIUS</code> file is no longer used, but there is no harm in keeping it in case you want to fall back to a previous release.
The installation process uses these files to determine whether to perform upgrade actions or new-installation actions.</p>
 
The installation process uses your existing RKTools files to determine whether to perform upgrade actions or new-installation actions.</p>


<ol>
<ol>
<li>Allocate the space required for the RKTools files. </li>
<li>Allocate the space required for the RKTools files. </li>
<ul>
<ul>
<li>If you are restoring into your existing <code>SIRIUS</code> file, note that the <code>SIRIUS</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:
<li>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 class="code">CREATE FILE SIRIUS
<p class="code">CREATE FILE M204PROC
END CREATE
END CREATE
OPEN FILE SIRIUS
OPEN FILE M204PROC
IN SIRIUS RESTORE 192 FROM <var class="term">dumpfile</var>
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>
</p>
</p>
</li>
</li>
Line 59: Line 62:
<table class="thJustBold">
<table class="thJustBold">
<tr><th>File</th><th>Size</th><th>Allocation is required...</th></tr>
<tr><th>File</th><th>Size</th><th>Allocation is required...</th></tr>
<tr><th>SIRIUS</th>
<tr><th>M204PROC</th>
<td>4200 pages</td> <td>always</td></tr>
<td>9800 pages</td> <td>always</td></tr>


<tr><th>SIRLOCAL
<tr><th>SIRLOCAL
</th><td>1200 pages</td> <td>always</td></tr>
</th><td>1200 pages</td> <td>always</td></tr>


<tr><th nowrap>SIRSTATS
<tr><th>M204LOCL
</th><td>4000 pages</td> <td>only if installing <var class="product">SirMon</var></td></tr>
</th><td>2000 pages</td> <td>required for RKWeb</td></tr>
 
<tr><th nowrap>MONDATA
</th><td>4000 pages</td> <td>only if installing <var class="product">SirMon</var>. Note that MONDATA replaces SIRSTATS, which is no longer needed as of RKTools V7.7</td></tr>


<tr><th>SIRFILED</th>
<tr><th>SIRFILED</th>
Line 81: Line 87:


<tr><th>JANSSL</th>
<tr><th>JANSSL</th>
<td>1200 pages</td> <td>only if installing Janus SSL</td></tr>
<td>1200 pages</td> <td>only if installing Janus SSL or RKWeb</td></tr>
</table>
</table>


<li><var>RESTORE</var> <code>SIRIUS</code> from the downloaded DUMP file.
<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.


<div id="updateJCL"></div>  
<div id="updateJCL"></div>  
Line 100: Line 106:
<td>always</td></tr>
<td>always</td></tr>


<tr><th>SIRSTATS</th>
<tr><th>M204LOCL</th>
<td>If using RKWeb</td></tr>
 
<tr><th>M204DATA</th>
<td>only if installing <var class="product">SirMon</var> and using the web interface</td></tr>
<td>only if installing <var class="product">SirMon</var> and using the web interface</td></tr>


Line 127: Line 136:
</ol> </li>
</ol> </li>


<li>Verify that 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 <code>IODEV15</code> thread.
 
If using RKWeb or any of the web interfaces to other components, you may need more IODEV15s available.</li>


<li>Modify the User 0 stream.
<li>Modify the User 0 stream.
Line 152: Line 163:
<tr><th>MAXINCL</th>
<tr><th>MAXINCL</th>
<td>Minimum setting is 10.</td></tr>
<td>Minimum setting is 10.</td></tr>
<tr><th>CUSTOM</th>
<td>RKWeb requires the 18 bit to be on, to enable a larger SSLIBSIZE on the Janus web port.</td></tr>


<tr><th>COMPOPT</th>
<tr><th>COMPOPT</th>
Line 244: Line 258:
</table>
</table>


<li>Issue <code>OPEN FILE SIRIUS</code> (no password is required), and execute the following command:
<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE RKTOOLS_INSTALL
<p class="code">INCLUDE RKTOOLS_INSTALL
</p>
</p>
Line 270: Line 284:
The minimum <var class="product">RKTools</var> server size requirements are listed below.
The minimum <var class="product">RKTools</var> server size requirements are listed below.
The actual server size requirements might vary slightly because of table
The actual server size requirements might vary slightly because of table
settings in the local Online <var class="product">Model&nbsp;204</var> regions, and because of slight
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>.
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model&nbsp;204</var>. Rocket recommends using one server size for the entire online, making it at least 750000 bytes to accomodate the largest RKTools component.
<table class="thJustBold">
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<tr class="head"><th>Subsystem name</th>
Line 364: Line 378:
RKTools components are installed as ''auto-start''. Use SUBSYSMGMT to disable this feature if you prefer that the subsystems not start automatically at each user request.
RKTools components are installed as ''auto-start''. Use SUBSYSMGMT to disable this feature if you prefer that the subsystems not start automatically at each user request.


==RKTools on the Web==
==RKWeb - Model 204 Tools on the Web==
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>.
New for version V7.7 (and requiring at least Model 204 Version 7.6 - RKWeb provides web access to all the important elements of Model 204. Use of this product requires <var class="product">[[Janus Web Server]]</var>. If your site does not own Janus Web, RKWeb can still be used by a limited number of Janus Web threads via the Janus TOGA agreement (which allows the running of up to 4 web threads).


All the <var class="product">RKTools</var> subsystems can be used on the web with <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.
Because RKWeb includes an interface for password maintenance, it is mandatory to run it on an SSL-protected web port.


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


<li>Define the following rule to invoke <var class="product">SirScan</var>:
<p class="code">
                                                                                                                     
*... 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                                                                           


<p class="syntax">JANUS WEB <span class="term">portname</span> ON /SIRSCAN/* CMD 'SIRSCAN *'
*... support for the Ace Editor, part of RKWeb
</p>
JANUS WEB [portname] ON /ACE/* OPEN FILE ACEPROC SEND * TEXT                                                         
JANUS WEB [portname] ON /ACE/EDITOR OPEN FILE ACEPROC CMD 'I EDITOR'                                                 
JANUS WEB [portname] ON /ACE/PROCLIST OPEN FILE ACEPROC CMD 'I PROCLIST'                                             
JANUS WEB [portname] ON /ACE/S.SETTINGS.PNG OPEN FILE ACEPROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999             
JANUS WEB [portname] ON /ACE/S.SIRLIB_SEQ.PNG OPEN FILE ACEPROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999         
JANUS WEB [portname] ON /ACE/*.JS OPEN FILE ACEPROC SEND *.JS TEXT                                                   
JANUS WEB [portname] ON /ACE/SRC/SNIPPETS/*.JS OPEN FILE ACEPROC SEND /ACEPROC/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999
JANUS WEB [portname] ON /ACE/SRC/*.JS OPEN FILE ACEPROC SEND /ACEPROC/SRC/*.JS BINARY EXPIRE +999999                 
JANUS WEB [portname] ON /ACE/SRC/MODE-M204.JS OPEN FILE ACEPROC SEND MODE-M204.JS TEXT                               
JANUS WEB [portname] ON /ACE/LIB/*.JS OPEN FILE ACEPROC SEND *.JS BINARY EXPIRE +999999                                                                                                                                   
JANUS WEB [portname] ON /EDITOR/* OPEN FILE ACEPROC CMD 'I UTIL_CODE_MANAGER.JSON'                                   
                                                                                                               
*... 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     


<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:
*... Rules supporting the applications implemented as Janus Legacy apps.
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]  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]  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 *' 


<p class="syntax">JANUS WEB <span class="term">portname</span> DISALLOW /SIRSCAN/*
JANUS WEB [portname] SCREEN /SIRLIB/*    -                                                                               
JANUS WEB <span class="term">portname</span> ALLOW /SIRSCAN/* USER *
    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'
                                                                                                                   
START SUBSYSTEM DICTADMIN                                                                                           
START SUBSYSTEM DICTREPORT                                                                                         
START SUBSYSTEM DOCUMENT                                                                                           
START SUBSYSTEM XREF                                                                                               
START SUBSYSTEM FILEMGMT                                                                                           
</p>
</p>
                                                 


<li>Because the above rules force users to log in, the port on which <var class="product">SirScan</var> runs should be either of these:
Again, 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>Only on a company intranet. </li>


<li>SSL protected, to prevent userids and passwords from being sent over the internet in clear text format. </li>
Once the rules are implemented and the port is started, RKWeb can be reached via a URL like this:
</ul>
<p>
The above rules work on an unprotected port, but it is <i><b>very strongly recommended</b></i> that this feature only be used when SSL protection is in effect.</p> </li>
</ol>


===Setup for web-based SirMon===
<p class="code">
This applies only to <var class="product">RKTools</var> version 7.5 and higher.
https://www.mydomain.com/rkweb/welcome.html
 
</p>
Because web-based <var class="product">SirMon</var> employs XML, XSLT, Javascript, a stylesheet, and some graphics,
the web rules needed to run <var class="product">SirMon</var> on the web are a little more complex:
<ol>
<li>Define a <var class="product">Janus Web Server</var> port. </li>
 
<li>Define the following rules to invoke <var class="product">SirMon</var>:
 
<p class="syntax">JANUS WEB <span class="term">portname</span> TYPE ANY *.PNG IMAGE/PNG           
JANUS WEB <span class="term">portname</span> TYPE ANY *.CSS TEXT/CSS   
JANUS WEB <span class="term">portname</span> TYPE ANY *.JS APPLICATION/X-JAVASCRIPT 
JANUS WEB <span class="term">portname</span> ON /*.CSS OPEN SIRIUS SEND *.CSS
JANUS WEB <span class="term">portname</span> ON /SIRMON/* CMD SIRMON       
JANUS WEB <span class="term">portname</span> ON /SIRMON/*.GIF OPEN SIRIUS SEND *.GIF EXPIRE +2147483
JANUS WEB <span class="term">portname</span> ON /SIRMON/*.PNG OPEN SIRIUS SEND *.PNG EXPIRE +2147483 
JANUS WEB <span class="term">portname</span> ON /SIRMON/*.JS OPEN SIRIUS SEND *.JS BINARY EXPIRE +2147483
JANUS WEB <span class="term">portname</span> ON /AJAX/* OPEN SIRIUS SEND *
JANUS WEB <span class="term">portname</span> ON /AJAX/*.JS OPEN SIRIUS SEND *.JS TEXT
JANUS WEB <span class="term">portname</span> ON /AJAX/*.UL OPEN SIRIUS CMD 'INCLUDE *.UL'
JANUS WEB <span class="term">portname</span> DISALLOW /SIRMON/*     
JANUS WEB <span class="term">portname</span> ALLOW /SIRMON/* USER * 
JANUS WEB <span class="term">portname</span> TYPE ANY *.XML TEXT/XML
JANUS WEB <span class="term">portname</span> TYPE ANY *.XSL TEXT/XSL 
JANUS WEB <span class="term">portname</span> ON /SIRMON/*.XSL OPEN SIRIUS SEND *.XSL EXPIRE +2147483   
JANUS WEB <span class="term">portname</span> ON /SIRMON/*.CSS OPEN SIRIUS SEND *.CSS EXPIRE +2147483   
JANUS WEB <span class="term">portname</span> ON /SIRMON/TEXTJS/*.JS OPEN SIRIUS SEND *.JS TEXT EXPIRE +2147483
JANUS WEB <span class="term">portname</span> ON /SIRMON/BUILDJS/*.JS CMD SIRMON                         
 
OPEN SIRSTATS
IN SIRSTATS INITIALIZE KEEPDEFS                                         
</p> </li>


<li>The above rules make <var class="product">SirMon</var> available, but they do not necessarily require a logon to the system, so you will need to add rules to force users to log in as well:
As implied by the above rules, some RKWeb applications are implemented with Janus Legacy, which launches them into a separate browser tab. Janus Legacy apps are not fully integrated with RKWeb, so use the security configured for those apps. For instance, FileMGMT is implemented with Janus Legacy and might prompt the user for a separate password.
 
<p class="syntax">JANUS WEB <span class="term">portname</span> DISALLOW /SIRMON/*
JANUS WEB <span class="term">portname</span> ALLOW /SIRMON/* USER *
</p> </li>
 
<li>Because the above rules force users to log in, the port on which <var class="product">SirMon</var> runs should be either:
<ul>
<li>Only on a company intranet.
 
<li>SSL protected, to prevent userids and passwords from being sent over the internet in clear text format.
</ul>
 
The above rules work on an unprotected port, but it is <i><b>very strongly recommended</b></i> that this feature only be used when SSL protection is in effect.
 
<p class="note"><b>Note:</b> Using <var class="product">SirMon</var> on the web also requires the <code>SIRSTATS</code> file. As shown in the above web rules, <code>SIRSTATS</code> can be re-initialized each time the Online comes up. <code>SIRSTATS</code> contains historical snapshots of system performance, and the file fills up if not archived or reinitialized on occasion.</p> </li>
</ol>

Revision as of 19:18, 29 May 2017

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

Introduced in RKTools V7.7 (mid-2017), RKWeb is a web-based version of the Model 204 utilities and tools, including most of RKTools. RKWeb is installed as part of RKTools.

Another important change in V7.7 is that tools formerly in the SIRIUS procedure have been moved to M204PROC, which means that all Model 204 tools provided by Rocket are in a single file. The RKTools install process will change the apsy definitions to point to the new procedure file - if you want to switch back to the previous version of RKTools you should keep a backup of your current CCASYS file (you could also change the apsy definitions manually via SUBSYSMGMT).

Because all Rocket Model204 procedure are now in one file, you should review the Dictionary/204 installation guide to see what steps, if any, related to SUBSYSMGMT, FILEMGMT, etc., might need to be run.

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 environment has the appropriate parameter settings.

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 code resides in the M204PROC Model 204 file. You will need to download a dump version of this file from the Rocket Software Model 204 maintenance website.

To download from the Rocket website:

  1. On the Rocket M204 Customer Care page, 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 latest version of the M204PROC file. The RKTools held in M204PROC Version 7.7 will work for Model 204 releases 7.6 and above. For older releases of Model 204 use the download labeled "RKTools V7.5".

    A "Click here" link on the download page provides help about downloading and uploading files, file sizing, and more.

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

System requirements

  • RKTools operates in a Model 204 Online region of the same or higher release number as RKTools. In other words, version 7.5 of RKTools requires Model 204 version 7.5 or higher. RKTools V7.7 was made specifically backward compatible to M204 Version 7.6, thought Version 7.7 is recommended.
  • Requirements for server sizes and parameter settings for each product are listed in RKTools server sizes.
  • 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
    • System manager privileges
    • Access to the SUBSYSMGMT facility and the JCL or EXEC that runs the Online Model 204 region.

Installing RKTools

Attention: If you are upgrading from a previous release, keep your old copies of SIRLOCAL, M204LOCL and any application-specific data files, such as JANCAT, SIRLIBD, SIRFILED, or SIRSTATS. As of RKTools V7.7, the SIRIUS file is no longer used, but there is no harm in keeping it in case you want to fall back to a previous release. The installation process uses your existing RKTools files to determine whether to perform upgrade actions or new-installation actions.

  1. Allocate the space required for the RKTools files.
    • 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

    The following table shows the RKTools files and their sizes.

    FileSizeAllocation is required...
    M204PROC 9800 pages always
    SIRLOCAL 1200 pages always
    M204LOCL 2000 pages required for RKWeb
    MONDATA 4000 pages only if installing SirMon. Note that 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
  2. RESTORE M204PROC from the downloaded DUMP file.
  3. Update the Online JCL or EXEC:
    1. Add DD (MVS) cards or FILEDEFs (CMS) for the RKTools files. The following table lists the files for which DD cards or FILEDEFs might be needed:
      File Allocation is required...
      SIRIUS always
      SIRLOCAL always
      M204LOCL If using RKWeb
      M204DATA only if installing SirMon and using the web interface
      SIRFILED only if installing SirFile
      SIRLIBD, SIRLIBP only if installing SirLib
      JANCAT only if installing JANUS OMNI Access Module
      JANSSL only if installing JANUS SSL Module
    2. Verify that the Online environment allows the use of file groups and APSY subsystems.
      • To use permanent file groups, the Online must have allocated an initialized CCAGRP file, and the SYSOPT parameter must contain the 2 bit.
      • To use APSYs, an Online must have allocated an initialized CCASYS file (with all fields defined), and the SYSOPT parameter must contain the 1 bit.
      For more information about APSYs and file groups, see File groups and System requirements for Application Subsystems.
  4. Verify that the Online has a minimum of 10 Sdaemon threads allocated. Each of these threads is typically defined as 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
    NFILES Increase by the number of RKTools files.
    NDCBS Increase by the number of RKTools files.
    NDIR Increase by the number of RKTools files.
    NORQS Minimum setting is 5.
    MAXDAEM Minimum setting is 10.
    MAXINCL Minimum setting is 10.
    CUSTOM RKWeb requires the 18 bit to be on, to enable a larger SSLIBSIZE on the Janus web port.
    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.
  6. Verify you have adequate UTABLE settings:
    UTABLE parameter Value Description
    SEQPDL 4096 Minimum PDL available for sequencer
    LIBUFF 2000 Length of input buffer
    LOBUFF 960 Length of output buffer
    LPDLST 10000 Length of user push down list
    LQTBL 2200 Length of QTBL
    LNTBL 50 Length of NTBL
    LSTBL 60000 Length of STBL
    LTTBL 2000 Length of TTBL
    LVTBL 1300 Length of VTBL
    LGTBL 2000 Length of global variable table
    LFTBL 1000 Length of FTBL
    LXTBL 1000 Length of XTBL
    LITBL 104 Length of ITBL
    LOUTPB 10000 Length of output page buffer
    LFSCB 21400 Length of full screen buffer
    NORQS 10 Number of requests preserved
    HTLEN 220 Max length of each header or trailer
    MAXHDR 7 Max number of headers
    MAXTRL 7 Max number of trailers
    SCRNSTBL 12000 STBL size for screen objects
  7. Issue OPEN FILE M204PROC (no password is required), and execute the following command:

    INCLUDE RKTOOLS_INSTALL

    This procedure performs all installation functions for new users and all upgrade functions for reinstalling users. No user profiles or other site-specific customization will be lost. If any problems are encountered while running this procedure, correct the problems and re-execute.

    The procedure RKTOOLS_INSTALL also builds an APSY subsystem called RKINSTALL. If installations need to be re-run, the subsystem may be invoked rather than the procedure.

    During APSY subsystem execution, some 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.
  8. Use SUBSYSMGMT to add users to the appropriate SCLASSes for any private or semi-public RKTools subsystems.

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

  9. Review the next section, "RKTools server sizes," for specific requirements of individual subsystem components of RKTools.

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

The minimum RKTools server size requirements are listed below. The actual server size requirements might vary slightly 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 750000 bytes to accomodate the largest RKTools component.

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

UTABLE and parameters

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.

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

RKTools required parameter minimums
Parameter Value
SCRNSTBL 12000.

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).

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

SIRMON BACKGROUND

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

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

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

Additional setup for SirFile

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

SIRFILE BACKGROUND

As with SirMon, the background monitor may be started automatically in a BATCH2 thread or in an sdaemon thread. See SirFile refresh process for details.

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

RKTools access privileges and SCLASSes

Each component application of RKTools has its own APSY 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 installed as auto-start. Use SUBSYSMGMT to disable this feature if you prefer that the subsystems not start automatically at each user request.

RKWeb - Model 204 Tools on the Web

New for version V7.7 (and requiring at least Model 204 Version 7.6 - RKWeb provides web access to all the important elements of Model 204. Use of this product requires Janus Web Server. If your site does not own Janus Web, RKWeb can still be used by a limited number of Janus Web threads via the Janus TOGA agreement (which allows the running of up to 4 web threads).

Because RKWeb includes an interface for password maintenance, it is mandatory to run it on an SSL-protected web port.

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

  • ... support for the Ace Editor, part of RKWeb

JANUS WEB [portname] ON /ACE/* OPEN FILE ACEPROC SEND * TEXT JANUS WEB [portname] ON /ACE/EDITOR OPEN FILE ACEPROC CMD 'I EDITOR' JANUS WEB [portname] ON /ACE/PROCLIST OPEN FILE ACEPROC CMD 'I PROCLIST' JANUS WEB [portname] ON /ACE/S.SETTINGS.PNG OPEN FILE ACEPROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999 JANUS WEB [portname] ON /ACE/S.SIRLIB_SEQ.PNG OPEN FILE ACEPROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999 JANUS WEB [portname] ON /ACE/*.JS OPEN FILE ACEPROC SEND *.JS TEXT JANUS WEB [portname] ON /ACE/SRC/SNIPPETS/*.JS OPEN FILE ACEPROC SEND /ACEPROC/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999 JANUS WEB [portname] ON /ACE/SRC/*.JS OPEN FILE ACEPROC SEND /ACEPROC/SRC/*.JS BINARY EXPIRE +999999 JANUS WEB [portname] ON /ACE/SRC/MODE-M204.JS OPEN FILE ACEPROC SEND MODE-M204.JS TEXT JANUS WEB [portname] ON /ACE/LIB/*.JS OPEN FILE ACEPROC SEND *.JS BINARY EXPIRE +999999 JANUS WEB [portname] ON /EDITOR/* OPEN FILE ACEPROC CMD 'I UTIL_CODE_MANAGER.JSON'

  • ... 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 /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] 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] 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] 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' START SUBSYSTEM DICTADMIN START SUBSYSTEM DICTREPORT START SUBSYSTEM DOCUMENT START SUBSYSTEM XREF START SUBSYSTEM FILEMGMT


Again, 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.

Once the rules are implemented and the port is started, RKWeb can be reached via a URL like this:

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

As implied by the above rules, some RKWeb applications are implemented with Janus Legacy, which launches them into a separate browser tab. Janus Legacy apps are not fully integrated with RKWeb, so use the security configured for those apps. For instance, FileMGMT is implemented with Janus Legacy and might prompt the user for a separate password.

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