RKTools installation

From m204wiki
Revision as of 12:55, 8 June 2017 by Alan (talk | contribs)
Jump to navigation Jump to search

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.

Also as of RKTools V7.7, all Rocket-provided, Soul-based tools are consolidated in the M204PROC file. The components formerly in the SIRIUS procedure file, and those formerly associated with the SQL interface are moved to M204PROC. This means that all Model 204 tools provided by Rocket are in a single file.

The RKTools 7.7 installation process modifies the application subsystem definitions to point to the M204PROC procedure file — if you might want to switch back to the previous version of RKTools, you should keep a backup of your current SIRIUS file and your current CCASYS file (though you can also change the subsystem definitions manually using SUBSYSMGMT).

Because all Rocket Model 204 procedures are in one file in V7.7, review the Dictionary/204 installation guide to see what steps, if any, related to SUBSYSMGMT, FILEMGMT, etc., might need to be run in addition to the RKTools installation.

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

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 contained in M204PROC version 7.7 work for Model 204 versions 7.6 and above. For older versions of Model 204, use the download labeled "RKTools V7.5".

    A "Click here" link 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 module you are not installing.

System requirements

  • RKTools operates in a Model 204 Online region of the same or higher version 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, though 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
    • Model 204 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 version, keep your old copies of SIRLOCAL, M204LOCL, and any application-specific data files, such as JANCAT, SIRLIBD, SIRFILED, or SIRSTATS. As of RKTools 7.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 For 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.
  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...
      M204PROC Always
      SIRLOCAL Always
      M204LOCL If using RKWeb
      MONDATA Only if installing SirMon and using the web interface.

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

      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 application 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 APSY subsystems, 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 APSY subsystems 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. Note that this is the 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.
  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 SCLASS classes 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 750,000 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 RKTools version 7.7 (and requiring at least Model 204 version 7.6), RKWeb 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, RKWeb can still be used by a limited number of Janus Web threads under the Janus TOGA agreement, which allows the running of up to 4 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.

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]

See the Janus Network Security page for information on how to use the JANSSL application to generate an SSL certificate.

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 WEBS ON /ACE/* OPEN FILE M204PROC SEND * TEXT JANUS WEB WEBS ON /ACE/EDITOR OPEN FILE M204PROC CMD 'I ACE.EDITOR' JANUS WEB WEBS ON /ACE/PROCLIST OPEN FILE M204PROC CMD 'I ACE.PROCLIST' JANUS WEB WEBS ON /ACE/S.SETTINGS.PNG OPEN FILE M204PROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999 JANUS WEB WEBS ON /ACE/S.SIRLIB_SEQ.PNG OPEN FILE M204PROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999 JANUS WEB WEBS ON /ACE/*.JS OPEN FILE M204PROC SEND *.JS TEXT JANUS WEB WEBS ON /ACE/SRC/SNIPPETS/*.JS OPEN FILE M204PROC SEND /ACE/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999 JANUS WEB WEBS ON /ACE/SRC/*.JS OPEN FILE M204PROC SEND /ACE/SRC/*.JS BINARY EXPIRE +999999 JANUS WEB WEBS ON /ACE/SRC/MODE-M204.JS OPEN FILE M204PROC SEND MODE-M204.JS TEXT JANUS WEB WEBS ON /ACE/LIB/*.JS OPEN FILE M204PROC SEND *.JS BINARY EXPIRE +999999 JANUS WEB WEBS ON /EDITOR/* OPEN FILE M204PROC 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 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, a couple 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 above web rules, some RKWeb applications are implemented with Janus Legacy, which launches them into a separate browser tab. Janus Legacy applications are not fully integrated with RKWeb, so you must use the security configured for those applications. For instance, FILEMGMT is implemented with Janus Legacy, and it might prompt the user for a separate password.

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