m204wiki - User contributions [en]

RKTools installation

2017-07-04T21:05:27Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model 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 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
<blockquote class="warn">
Attention: 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. 

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

<ol>
<li>Allocate the RKTools files. The following table shows the RKTools files and their sizes:</li>
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>3000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file downloaded from the Rocket website.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

<li>Verify that the Online environment allows the use of file groups and application subsystems.
<ul>
<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>

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

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

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.

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the RKTools components, and install or reinstall Dictionary/204 and SQL utilities as needed:
<ol type="a">
<li>RKTools components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

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. 

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. 

The RKWeb interface, described further below, 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 privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.
</li>

<li>Review the next section, "Server size requirements," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

==Additional setup==

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

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

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

If the <var class="product">SirMon</var> [[SirMon background monitor|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 <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 [[#Janus Web rules for RKWeb|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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-07-03T21:15:47Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model 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 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
<blockquote class="warn">
Attention: 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. 

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

<ol>
<li>Allocate the RKTools files. The following table shows the RKTools files and their sizes:</li>
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file downloaded from the Rocket website.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

<li>Verify that the Online environment allows the use of file groups and application subsystems.
<ul>
<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>

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

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

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.

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the RKTools components, and install or reinstall Dictionary/204 and SQL utilities as needed:
<ol type="a">
<li>RKTools components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

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. 

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. 

The RKWeb interface, described further below, 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 privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.
</li>

<li>Review the next section, "Server size requirements," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

==Additional setup==

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

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

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

If the <var class="product">SirMon</var> [[SirMon background monitor|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 <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 [[#Janus Web rules for RKWeb|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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-07-03T21:12:05Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model 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 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
<blockquote class="warn">
Attention: 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. 

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

<ol>
<li>Allocate the RKTools files. The following table shows the RKTools files and their sizes:</li>
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file downloaded from the Rocket website.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

<li>Verify that the Online environment allows the use of file groups and application subsystems.
<ul>
<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>

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

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

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.

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the RKTools components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>RKTools components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

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. 

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. 

The RKWeb interface, described further below, 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 privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.
</li>

<li>Review the next section, "Server size requirements," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

==Additional setup==

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

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

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

If the <var class="product">SirMon</var> [[SirMon background monitor|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 <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 [[#Janus Web rules for RKWeb|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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-07-03T20:58:41Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model 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 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
<blockquote class="warn">
Attention: 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. 

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

<ol>
<li>Allocate the RKTools files. The following table shows the RKTools files and their sizes:</li>
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file downloaded from the Rocket website.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

<li>Verify that the Online environment allows the use of file groups and application subsystems.
<ul>
<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>

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

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

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.

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

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. 

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. 

The RKWeb interface, described further below, 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 privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.
</li>

<li>Review the next section, "Server size requirements," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

==Additional setup==

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

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

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

If the <var class="product">SirMon</var> [[SirMon background monitor|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 <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 [[#Janus Web rules for RKWeb|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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-07-03T20:48:51Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> component you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to <var class="product">Model 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 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
<blockquote class="warn">
Attention: 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. 

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

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the DUMP file downloaded from the Rocket website.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

<li>Verify that the Online environment allows the use of file groups and application subsystems.
<ul>
<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>

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

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

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.

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

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. 

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. 

The RKWeb interface, described further below, 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 privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.
</li>

<li>Review the next section, "Server size requirements," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

==Additional setup==

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

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

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

If the <var class="product">SirMon</var> [[SirMon background monitor|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 <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 [[#Janus Web rules for RKWeb|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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-06-29T13:46:01Z

Alan: /* Defining a Janus port and generating a self-signed SSL certificate */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: 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>. For SirMon owners <code>SIRSTATS</code> has been replaced by <code>MONDATA</code>. As of RKTools 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions, so leave then allocated and available, including <code>SIRLOCAL</code>.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server size," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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.

The RKWeb interface is controlled by the RKWEB subsystem. Some of the RKWeb options require system administrator privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-06-29T13:05:20Z

Alan: /* Defining a Janus port and generating a self-signed SSL certificate */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: 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>. For SirMon owners <code>SIRSTATS</code> has been replaced by <code>MONDATA</code>. As of RKTools 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions, so leave then allocated and available, including <code>SIRLOCAL</code>.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server size," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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.

The RKWeb interface is controlled by the RKWEB subsystem. Some of the RKWeb options require system administrator privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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 </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKWeb

2017-06-27T21:20:22Z

Alan: /* Overview */

This draft document describes RKWeb, which is still in pre-release. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystems, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface, the RKTools menu, or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
<li>[[#Command processor|Command processor]]</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>Works with all SOUL code and other code stored in M204 procedure files.</li>

<li>Uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>

<li>Respects Model 204 security, allowing users to see, browse, and/or edit only the procedures that they would have permission to see, browse, or edit in 3270.</li>

<li>Is available to all Model 204 owners.</li>
</ul>

The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
Note: Pop-ups must be enabled to use this feature.
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>If needed, click the Open Procedure List button.
<li>The Edit tool fetches a list of procedures in the current file. The list appears in a new window (or tab). </li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field. Then click the List button.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (Case-sensitivity of the string is set in the [[#To customize the procedure list settings|Procedure List Settings dialog box]].)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>

<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
</ul></li>
<li>Click a procedure name to open that procedure in a new window (or tab) and edit it in the [[#RKWeb editor|RKWeb editor]].</li>
<li>After editing, click Save and close the window to return to the procedure list window.</li>
<li>Close the procedure list window to return to the RKWeb main screen.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
<li>Click Save to save your changes.</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new window (or tab) opens, leaving your original RKWeb session in place in the original window (or tab).
Note: 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 you for a separate password.
</li>

<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the window to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th nowrap>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Users</code> menu presents a submenu of user statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th nowrap>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th nowrap>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up a journal scanning facility similar to the 3270 [[SirScan]].
The RKWeb journal scanning module is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. As it mimics SirScan functionality, access is restricted to owners of the SirScan subsystem.

The RKWeb journal scanner allows ADMIN users to view journal entries for the current online journal, or to browse the content of archival journals by ddname if they are allocated to the online as sequential files. The data is displayed on the web page with powerful searching commands, filtering and display options.

The Model 204 Journal scan form supports the same input as shown for SirScan, here: [[SirScan scan specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div> 

[[Category: RKTools]]

RKTools installation

2017-06-27T21:10:47Z

Alan: /* Installing RKTools */

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: 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>. For SirMon owners <code>SIRSTATS</code> has been replaced by <code>MONDATA</code>. As of RKTools 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions, so leave then allocated and available, including <code>SIRLOCAL</code>.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server size," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accommodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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.

The RKWeb interface is controlled by the RKWEB subsystem. Some of the RKWeb options require system administrator privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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.*'

JANUS START MYWEBPORT </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKTools installation

2017-06-27T21:02:44Z

Alan:

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server size|RKTools server size]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: If you are upgrading from a previous version, 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 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<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>NORQS</th>
<td>Minimum setting is 5.</td></tr>

<tr><th>SESNPUB</th>
<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>SESUMAX</th>
<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>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LFSCB</th>
<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>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>

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

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server size," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accomodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

<tr><th>JANSSL</th>
<td>300K</td></tr>

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

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

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

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

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

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

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

<tr><th>SIRSCAN</th>
<td>250K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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.

The RKWeb interface is controlled by the RKWEB subsystem. Some of the RKWeb options require system administrator privileges just as those options do when accessed with the RKTools TN3270 interface. To use these options in RKWeb requires Admin SCLASS membership and a grant of System Administrator privileges in the RKWEB subsystem.

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

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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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.*'

JANUS START MYWEBPORT </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

[[Category: RKTools]]

RKWeb

2017-06-27T19:56:23Z

Alan:

This draft document describes RKWeb, which is still in pre-release. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
<li>[[#Command processor|Command processor]]</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>Works with all SOUL code and other code stored in M204 procedure files.</li>

<li>Uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>

<li>Respects Model 204 security, allowing users to see, browse, and/or edit only the procedures that they would have permission to see, browse, or edit in 3270.</li>

<li>Is available to all Model 204 owners.</li>
</ul>

The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
Note: Pop-ups must be enabled to use this feature.
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>If needed, click the Open Procedure List button.
<li>The Edit tool fetches a list of procedures in the current file. The list appears in a new window (or tab). </li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field. Then click the List button.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (Case-sensitivity of the string is set in the [[#To customize the procedure list settings|Procedure List Settings dialog box]].)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>

<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
</ul></li>
<li>Click a procedure name to open that procedure in a new window (or tab) and edit it in the [[#RKWeb editor|RKWeb editor]].</li>
<li>After editing, click Save and close the window to return to the procedure list window.</li>
<li>Close the procedure list window to return to the RKWeb main screen.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
<li>Click Save to save your changes.</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new window (or tab) opens, leaving your original RKWeb session in place in the original window (or tab).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the window to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th nowrap>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Users</code> menu presents a submenu of user statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th nowrap>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th nowrap>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up a journal scanning facility similar to the 3270 [[SirScan]].
The RKWeb journal scanning module is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. As it mimics SirScan functionality, access is restricted to owners of the SirScan subsystem.

The RKWeb journal scanner allows ADMIN users to view journal entries for the current online journal, or to browse the content of archival journals by ddname if they are allocated to the online as sequential files. The data is displayed on the web page with powerful searching commands, filtering and display options.

The Model 204 Journal scan form supports the same input as shown for SirScan, here: [[SirScan scan specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div> 

[[Category: RKTools]]

RKWeb

2017-06-27T19:55:50Z

Alan:

This draft document describes RKWeb, which is still in pre-release. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
<li>[[#Command processor|Command processor]]</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>Works with all SOUL code and other code stored in M204 procedure files.</li>

<li>Uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>

<li>Respects Model 204 security, allowing users to see, browse, and/or edit only the procedures that they would have permission to see, browse, or edit in 3270.</li>

<li>Is available to all Model 204 owners.</li>
</ul>

The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
Note: Pop-ups must be enabled to use this feature.
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>If needed, click the Open Procedure List button.
<li>The Edit tool fetches a list of procedures in the current file. The list appears in a new window (or tab). </li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field. Then click the List button.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (Case-sensitivity of the string is set in the [[#To customize the procedure list settings|Procedure List Settings dialog box]].)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>

<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
</ul></li>
<li>Click a procedure name to open that procedure in a new window (or tab) and edit it in the [[#RKWeb editor|RKWeb editor]].</li>
<li>After editing, click Save and close the window to return to the procedure list window.</li>
<li>Close the procedure list window to return to the RKWeb main screen.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
<li>Click Save to save your changes.</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new window (or tab) opens, leaving your original RKWeb session in place in the original window (or tab).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the window to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th nowrap>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Users</code> menu presents a submenu of user statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th nowrap>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th nowrap>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up a journal scanning facility similar to the 3270 [[SirScan]].
The RKWeb journal scanning module is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. As it mimics SirScan functionality, access is restricted to owners of the SirScan subsystem.

The RKWeb journal scanner allows ADMIN users to view journal entries for the current online journal, or to browse the content of archival journals by ddname if they are allocated to the online as sequential files. The data is displayed on the web page with powerful searching commands, filtering and display options.

The Model 204 Journal scan form supports the same input as shown for SirScan, here: [[SirScan scan specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div> 

[[Category: RKTools]]
[[Category: Tools]]

RKWeb

2017-06-27T18:58:37Z

Alan: /* Journal Scan */

This draft document describes RKWeb, which is still in pre-release. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
<li>[[#Command processor|Command processor]]</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>Works with all SOUL code and other code stored in M204 procedure files.</li>

<li>Uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>

<li>Respects Model 204 security, allowing users to see, browse, and/or edit only the procedures that they would have permission to see, browse, or edit in 3270.</li>

<li>Is available to all Model 204 owners.</li>
</ul>

The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
Note: Pop-ups must be enabled to use this feature.
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>If needed, click the Open Procedure List button.
<li>The Edit tool fetches a list of procedures in the current file. The list appears in a new window (or tab). </li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field. Then click the List button.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (Case-sensitivity of the string is set in the [[#To customize the procedure list settings|Procedure List Settings dialog box]].)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>

<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
</ul></li>
<li>Click a procedure name to open that procedure in a new window (or tab) and edit it in the [[#RKWeb editor|RKWeb editor]].</li>
<li>After editing, click Save and close the window to return to the procedure list window.</li>
<li>Close the procedure list window to return to the RKWeb main screen.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
<li>Click Save to save your changes.</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new window (or tab) opens, leaving your original RKWeb session in place in the original window (or tab).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the window to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th nowrap>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Users</code> menu presents a submenu of user statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th nowrap>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens, including:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th nowrap>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up a journal scanning facility similar to the 3270 [[SirScan]].
The RKWeb journal scanning module is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. As it mimics SirScan functionality, access is restricted to owners of the SirScan subsystem.

The RKWeb journal scanner allows ADMIN users to view journal entries for the current online journal, or to browse the content of archival journals by ddname if they are allocated to the online as sequential files. The data is displayed on the web page with powerful searching commands, filtering and display options.

The Model 204 Journal scan form supports the same input as shown for SirScan, here: [[SirScan scan specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

Release notes for RKTools V7.7

2017-06-27T14:49:56Z

Alan:

Note: This draft document describes RKTools V7.7, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.

[[RKTools]] V7.7 is designed for use with Model 204 V7.7 and later but is backward compatible to Model 204 V7.6.

Release notes for the components of RKTools that have been updated for version 7.7 are listed below:
<ul>
<li>[[Release notes for SirPro V7.7]]</li>
<li>[[Release notes for SirLib V7.7]]</li>
<li>[[Release notes for SirScan V7.7]]</li>
<li>[[Release notes for SoulEdit V7.7]]</li>
</ul>

For information on installing RKTools V7.7, see [[RKTools installation]].

==Overview==
New features and enhancements in RKTools 7.7:
<ul>
<li>M204PROC

As of [[RKTools]] version 7.7 (mid-2017), all code for all Rocket-provided, SOUL-based products and utilities resides in the <code>M204PROC</code> file. This includes all the Dictionary/204 components (SUBSYSMGMT, FILEMGMT, etc.), all the SQL support code, and all code for the former [[UL/SPF]] products like SirPro, SirMon and SirScan. 

As described in [[Downloading and restoring SOUL files]]: 
<ul>
<li>The files <code>SIRIUS</code>, <code>TSFPROC</code>, <code>CATPROC</code>, and <code>DICTDIST</code> are no longer needed as of RKTools 7.7. </li>

<li>Older versions of the former UL/SPF products are still available on the download page in the <code>SIRIUS</code> file, but any site running Model 204 V7.6 or higher should use the version in <code>M204PROC</code>. </li>

<li>To use this RKTools version, a full installation must be performed at least once, because there are some new files, and because the application subsystem definitions need to be changed to point to the new procedure file. </li>
</ul></li>

<li>Dictionary/204

As of version 7.7, [[Dictionary/204 overview|Dictionary/204]] is integrated into [[RKTools]], and it is accessible through both the RKTools and [[RKWeb]] interfaces, as well as [[Dictionary/204 logon and commands#Logging on to Dictionary/204|from the Model 204 command line]] as before. The <var class="product">Dictionary/204</var> wiki pages primarily describe the TN3270 screens, as their appearance and functionality is mirrored in the RKWeb <code>Manage > Dictionary</code> view, which uses [[Janus Web Legacy Support]] to map the <var class="product">Dictionary/204</var> TN3270 screens to your web browser. 

The Dictionary/204 subsystem management tool (SUBSYSMGMT), however, is incorporated in non-Legacy views in RKWeb (the <code>Manage > Subsystem Management</code> menu options). </li>

<li>RKWeb

[[RKWeb]], an easy-to-use web interface for managing the entire Model 204 environment, is new in version 7.7. RKWeb provides an integrated environment, merging the members of RKTools without distinguishing them as individual products. The RKWeb tools framework provides a highly productive web interface to common Model 204 functionality.
RKWeb is mobile-ready and provides a task-based UI for SOUL application development. RKWeb includes utilities to build applications; manage SOUL code, passwords, groups and SSL Certificates; and monitor performance. RKWeb also includes a journal scanner, command interface, and readers for [[SirTune]] reports and [[SirFact]] dumps. Access is restricted to some components based on ownership of the underlying products.

For a summary of the RKTools components accessible from RKWeb, see [[RKWeb#Where's my RKTools 3270 functionality?|Where's my RKTools 3270 functionality?]]. 
Note: RKWeb requires that you have [[Janus Web Server]] set up on your system.</li>

<li>JANSSL interface

This [[Janus Network Security]] subsystem (controlling the certificate management application) and some associated files were formerly delivered in the <code>SIRIUS</code> file but were not otherwise a part of RKTools. In V7.7,
JANSSL has been overhauled and integrated with the other components in the RKWeb interface. Although it is a new technology "under the covers," from a user point of view it is essentially the same application. 

V7.7 JANSSL includes support for SHA2 SSL Certificates, including SHA384. </li>

<li>SIRTUNEREPORT interface

Prior to version 7.7 of RKTools, <var class="product">[[SirTune]]</var> reports are only generated by using a SOUL program invoking a call to the <var>[[SirTuneReport (Dataset function)|SirTuneReport]]</var> method of the <var>Dataset</var> class, as implemented in the <code>SIRTUNEREPORT</code> SOUL program delivered with RKTools. 

As of RKTools 7.7, the RKWeb interface (<code>Build > Tune Reports</code>) is equipped to invoke and display <code>SIRTUNEREPORT</code> results. Using RKWeb for SirTune reports requires the same set up of input and output files described on the [[SirTune report generation]] page.</li>

<li>SQL Server utilities

As of RKTools 7.7, the RKTools and RKWeb interfaces make available the SQL Server [[SQL DDL from the Table Specification Facility|Table Specification facility (TSF)]] and the [[SQL catalog reporting and querying|catalog reporting utility (CCACATREPT)]].
RKWeb options (<code>Manage > Dictionary > SQL Catalog Reports</code> and <code>Manage > Dictionary > Table Specifications</code>) use [[Janus Web Legacy Support]] to map the <var class="product">SQL Server</var> TN3270 screens to your web browser. 

Using RKWeb for SQL Server requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]].
</li>

<li>SoulEdit

SoulEdit in RKTools 7.7 includes a "railway track" formatting feature that lets you easily spot indentation problems and missing block-ending lines. The [[SoulEdit]] page explains other recent updates and has a training video.</li>
</ul>

Release notes for RKTools V7.7

2017-06-27T14:49:33Z

Alan:

RKWeb

2017-06-26T15:40:53Z

Alan:

This draft document describes RKWeb, which is still in pre-release. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. Access is restricted to owners of the SirScan subsystem.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:33:11Z

Alan: /* Journal Scan */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time. Access is restricted to owners of the SirScan subsystem.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:32:23Z

Alan: /* Performance */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application, and is restricted to Admin SCLASS users at sites that own SirMon. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:31:14Z

Alan: /* SSL Certificates */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. Access to this feature in RKWeb is restricted to Admin SCLASS members, who are granted System Administrator privileges. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:24:23Z

Alan: /* Group Definitions */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]]. Access to the Group Definition page is given to RKWeb admin users, who are granted System Administrator privileges.
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:23:31Z

Alan: /* Passwords */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]]. The Passwords interface is available to RKWeb Admin users, who are given System Administrator privileges.

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:21:53Z

Alan: /* Subsystem Management */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface. RKWEB's Subsysmgmt is available to RKWEB Admin users, who are given System Administrator privileges.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:20:30Z

Alan: /* Tune Reports */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]]. <code>Tune Reports</code> is available to all owners of [[SirTune]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:18:38Z

Alan: /* Edit */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
<li>The RKWeb editor is available to all Model 204 owners.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:10:50Z

Alan: /* Overview */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device. All existing security and product ownership is honored in RKWEB - for instance, an interface is provided for managing group definitions and passwords, but the option is only available to ADMIN users with System Administrator privileges.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:08:31Z

Alan: /* Configure */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> option is available to SirLib owners. It enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKWeb

2017-06-26T15:05:58Z

Alan: /* Overview */

This draft document describes RKWeb, which is still in development. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.
<div class="toclimit-3">
==Overview==
The RKTools 7.7 release is comprised of the RKTools subsystem, Dictionary/204,
and RKWeb.
<ul>
<li>The RKTools subsystem provides access to all TN3270-based RKTools (formerly UL/SPF tools).</li>
<li>Dictionary/204 is available from the TN3270 interface or from RKWeb.</li>
<li>RKWeb provides an easy-to-use web interface to almost all of the RKTools and Dictionary components.</li>
</ul>

The RKWEB system harnesses most of the Rocket M204 tools in a common framework, providing a highly productive web interface to common Model 204 functions. RKWeb is mobile-friendly, enabling you to perform most Model 204 operations from your smartphone or other mobile device.

RKWeb requires [[Janus Web Server]] and Model 204 version 7.6 or later. See [[RKTools Installation guide#RKWeb (Model 204 Tools on the Web)|RKWeb installation]] for more information. For sites that do not own Janus Web, a Limited Janus Web capability is included that allows a restricted number of web threads to use RKWeb.

RKWeb provides a task-based UI for SOUL application development. Tasks are divided into three functional areas: [[#Build|Build]], [[#Manage|Manage]], and [[#Monitor|Monitor]]. The [[#com_proc|Command processor]] is available in each functional area.

==Build==
The <code>Build</code> menu provides these options for building your application:
<ul>
<li>Edit procedures ([[#Edit|Edit]])</li>
<li>Configure change management for procedures ([[#Configure|Configure]])</li>
<li>Analyze dump files ([[#Fact Dump Analysis|Fact Dump Analysis]])</li>
<li>Tune procedure performance ([[#Tune Reports|Tune Reports]])</li>
</ul>

===Edit===
The <code>Build > Edit</code> menu option enables you to edit procedures within Model 204 files.
Note: You must enable pop-ups in your browser to edit a procedure (it is opened in a separate window).

====RKWeb editor====

The editor provided with RKWeb is based on the open-source [https://ace.c9.io/ Ace] editor.

The RKWeb editor:
<ul>
<li>works with all SOUL code and other code stored in M204 procedure files.</li>
<li>uses color coding in SOUL or JavaScript programs to highlight items such as function names, parameters, and labels.</li>
<li>respects Model 204 security, allowing users to see, browse and/or edit only the procedures that they would have permission to see, browse or edit in 3270.</li>
</ul>
The RKWeb editor enables you to perform basic editing tasks such as search and replace, skip words, insert and delete lines, Undo, and so on. For a list of default keyboard shortcuts in the Ace editor, see [https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts Default keyboard shortcuts].

====To edit a procedure====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Edit</code>.</li>
<li>The Edit tool fetches a list of procedures in the current file.</li>
To view a different file, enter a name in the File field. If the file is password-protected, enter a password in the Password field.</li>
<li>To filter the list of procedures:
<ul>
<li>Enter a string in the Filter field, such as <code>shared</code> or <code>EDITOR</code>. (By default, the field is not case-sensitive.)</li>
<li>Enter a number of hours in the Age(hours) field to filter the list by the age of the procedures.</li>
</ul></li>
<li>Press Enter or click List to refresh the list of procedures.</li>
To see the original unfiltered list, delete the criteria from the Filter and Age(hours) fields and press Enter or click List.</li>
<li>Click a procedure name to open that procedure in a new tab and edit it in the RKWeb editor.</li>
</ol>

====To customize the procedure list settings====
<ol>
<li>Click the Settings icon in the upper right corner of the screen.</li>
<li>In the Procedure List Settings dialog box, you can customize the following Procedure List settings:
<ul>
<li>Hiding of BASE.* and SEQ.* type procedures</li>
<li>Font size</li>
<li>Case sensitivity of procedure name Filter field</li>
<li>Double-clicking (vs. single-clicking) to open a procedure</li>
<li>Procedure colors:
<ul>
<li>Background color of the Procedure List toolbar.</li>
<li>Color of an open procedure.</li>
</ul>
Enter a color name, such as <code>red</code>, or its hexadecimal code, such as <code>#FF0000</code>, or its rgb value, such as <code>rgb(255,0,0)</code>.
</li>
</ul>
</li>
</ol>

===Configure===
The <code>Build > Configure</code> menu option enables you to configure and administer change management for SOUL procedures residing in Model 204 procedure files.

====To use SirLib change control====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Configure</code>.
This opens the [[SirLib change control|SirLib Configuration and Change Control System]].
SirLib functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]], operating outside the RKWeb menu framework. When you click the <code>Configure</code> menu option, a new tab (or window) opens, leaving your original RKWeb session in place in the original tab (or window).</li>
<li>Enter an action number to choose a menu option from the <code>Configuration and Change Control System</code> menu.
The Target file field, Fixes File field, and menu options are the same as on the [[SirLib change control#SirLib main menu|SirLib main menu]].
<table>
<tr class="head">
<th>Menu number</th><th>Item</th><th>Enables you to...</th></tr>
<tr><td>1</td><td>Project Definition List</td><td>[[SirLib_change_control#Project_definition|Add, delete, or change the project identifiers]] in the FixFile assigned to a managed file.</td></tr>
<tr><td>2</td><td nowrap>Apply changes (Reconfigure a file)</td><td>[[SirLib_change_control#Configuring_files_.28applying_updates.29|Apply file updates]].</td></tr>
<tr><td>3</td><td nowrap>Administration (specify a file or use default)</td> <td>[[SirLib_change_control#Administering_system_and_file_profiles|Administer system and file profiles]].</td></tr>
<tr><td>4</td><td>Security (specify a file or use default)</td> <td>Set [[SirLib_security|SirLib security]] settings.</td></tr>
<tr><td>5</td><td>Cutover</td> <td>Clean up and stabilize projects. [[SirLib_change_control#cutover|Release cutover]] returns a managed file to a pre-managed state, but with all existing updates applied.</td></tr>
<tr><td>6</td><td>Reports</td> <td>Run a [[SirLib_reports|SirLib report]] on Change History, Configuration, or Problem tracking.</td></tr>
<tr><td>7</td><td nowrap>View/Clear Procedure Locks</td><td>(Admin users only) See procedures that are [[SirLib_change_control#View.2FClear_procedure_locks|currently checked out]].</td></tr>
</table></li>
<li>When you have performed all desired tasks, close the tab to return to your RKWeb session.</li>
</ol>

===Fact Dump Analysis===
The <code>Fact Dump Analysis</code> menu item provides a UI to the [[SirFact FACT subsystem|SirFact FACT subsystem]], enabling you to analyze a diagnostic dump by selecting a dump file and its procedure that contains the dump. You can then choose which data to display.
Note: Your site must own <var class="product">SirFact</var> in order for you to use Fact Dump Analysis.

====To select and analyze a diagnostic dump====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Fact Dump Analysis</code>.</li>
<li>Click <code>Select</code> from the submenu.
In the File field, enter a dump file name. The SirFact dump selection screen displays a list of procedures in the selected dump file.
To choose a different file, enter its name in the File field and click Switch file.</li>
<li>Click a procedure name to analyze its dump information with the [[SirFact FACT subsystem]].
The screen displays basic information extracted from the dump: default context information for the error condition such as a date/time stamp, source procedure and file, user ID of the user for whom the error occurred, and so on.
Enter SirFact commands to extract additional information, which is appended to the information on the screen:
<ul>
<li>To view the context where an error occurred, enter the <code>
[[SirFact FACT subsystem#C.5Bontext.5D command: Setting program context for data extraction|Context]]</code> SirFact command, with an information context, in the Command field and click Send query.
The valid information contexts are:
<table>
<tr>
<td>* (asterisk)</td>
<td>Switches FACT context to the mainline of the executing program.</td>
</tr>
<tr>
<td>. (period)</td>
<td>Switches to whichever context the program was in at the time of the SirFact error.</td>
</tr>
<tr>
<td nowrap><var class="term">subroutine-name</var></td>
<td>Switches to the context of the named complex subroutine. Simple subroutines are not valid contexts, as they share the same context as the main body of the program.</td>
</tr>
</table>
</li>
<li>To display specific data from the dump, such as attributes, For Each Record loop fields, lists, and so on, enter the <var>Display</var> SirFact command and its
[[SirFact FACT subsystem#D.5Bisplay.5D command: Displaying data from the SirFact dump|parameters]] in the Command field and click Send query.</li>
</ul></li>
</ol>

===Tune Reports===
The <code>Tune Reports</code> menu item enables you to produce a listing of one or more [[SirTune reports]], which you can use to tune problem areas in an Online.
Note: The <code>Tune Reports</code> menu item is a quick way to generate SirTune reports that you have already configured. It is assumed that you are familiar with configuring and running SirTune reports. For more information, see [[SirTune Report Generator configuration]].

====To produce a report====
<ol>
<li>Click the <code>Build</code> tab.</li>
<li>In the <code>Build</code> menu, click <code>Tune Reports</code>.</li>
<li>Select Procedure or Dataset to choose either a procedure or data set report.
<ul>
<li>For Procedure:
In the SirTune input section, enter the File, Procedure, Data Source, and Volume (if desired).</li>
<li>For Dataset:
In the SirTune input section, enter the Configuration file name and Volume (if desired) and Data Source and Volume (if desired).</li>
</ul>
</li>
<li>In the SirTune Output section, select Page to see the report on your screen, or select Dataset and enter the Dataset name and Volume (if desired).</li>
<li>Click Generate to generate the report.</li>
</ol>

==Manage==
The <code>Manage</code> menu contains options to manage your applications, files, and user logins:
<ul>
<li>Define applications that run under the Application Subsystem facility ([[#Subsystem Management|Subsystem Management]])</li>
<li>Manage your procedures, files, and subsystems ([[#Dictionary|Dictionary]])</li>
<li>Maintain Model 204 passwords ([[#Passwords|Passwords]])</li>
<li>Manage Model 204 group definitions ([[#Group Definitions|Group Definitions]])</li>
<li>Manage SSL certificates ([[#SSL Certificates|SSL Certificates]])</li>
</ul>

===Subsystem Management===
The [[Subsystem Management facility#Overview of the Subsystem Management facility|Subsystem Management]] menus enable you to define user-written applications that run under the Application Subsystem facility (APSY).

A subsystem is an application consisting of a collection of procedures, files, and assigned characteristics that are defined as a subsystem to Model 204 through the Subsystem Management interface.

====Procedure====
Enter specifications for subsystem procedures on the Procedure screen.

=====To create specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Enter a name in the Subsystem field and press Enter.
<li>If the subsystem does not exist, a message appears. Click the icon beside the Subsystem field and select Create.</li>
<li>The item appears in the display, with its fields populated with default values. The item is now created and will be available in the Subsystem list.</li>
<li>Edit the [[SUBSYSMGMT#Procedure_prefixes|procedure prefixes]] as desired. </li>
<li>Edit the [[SUBSYSMGMT#Procedure_names|procedure names]] as desired.</li>
<li>Edit the [[SUBSYSMGMT#Global_variables|global variables]] as desired.</li>
<li>If you have made any edits, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To rename specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Rename Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Rename.</li>
<li>The renamed item appears as the selected subsystem.</li>
</ol>
=====To copy specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Copy Subsystem pop-up, enter the new subsystem name in the To field and click Confirm Copy.</li>
<li>The new copy appears as the selected subsystem.</li>
</ol>
=====To delete specifications for a subsystem procedure=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Procedure</code>.</li>
<li>Select an item in the Subsystem drop-down list.</li>
<li>Click the icon beside the Subsystem field and select Copy.</li>
<li>In the Delete Subsystem pop-up, click Confirm Delete.</li>
<li>The item disappears from the display and the subsystem list.</li>
</ol>

====Operational====
Operating options affect certain aspects of the overall behavior of a subsystem. Define and maintain them using the <code>Operational</code> menu options.
=====To specify subsystem operating options=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Operational</code>.</li>
<li>In the Subsystem field, select a subsystem name from the drop-down list.</li>
<li>Set the [[System_requirements_for_Application_Subsystems#Parameter_descriptions| operating options]] as needed.
The following table summarizes the operating options and what they determine.
<table>
<tr class="head">
<th>Operating option field</th>
<th>Determines whether...</th>
</tr>

<tr>
<td>Status</td>
<td>Specifies the level of availability of the subsystem to users</td>
<tr>

<tr>
<td>Auto Start </td>
<td>Subsystem automatically starts for the first user entering the subsystem. </td>
</tr>

<tr>
<td>Lock File/Group</td>
<td>Users from outside the subsystem can open and update subsystem files while the subsystem is active. </td>
</tr>

<tr>
<td>Log user into M204</td>
<td>Users are automatically logged into <var class="product">Model 204</var> upon entering a subsystem. </td>
</tr>

<tr>
<td>Log user out of M204</td>
<td>Users are automatically logged out of <var class="product">Model 204</var> upon exiting a subsystem. </td>
</tr>

<tr>
<td>Auto Commit</td>
<td>Any outstanding updates are committed automatically whenever a subsystem procedure ends and transfers control using the communications global variable.</td>
</tr>

<tr>
<td>Maximum Iterations</td>
<td>Specifies the maximum number of times a procedure can execute consecutively.</td>
</tr>

<tr>
<td>Account</td>
<td>Specifies an account value that overrides the login account.</td>
</tr>

<tr>
<td>Privileges (in hex)</td>
<td>Specifies user privileges independent of the Model 204 login privileges.</td>
</tr>

<tr>
<td>Start Login privileges (in hex)</td>
<td>Controls login privileges while starting a subsystem.</td>
</tr>

<tr>
<td>Subsystem can access Remote Files</td>
<td>For use with [[PQO:_Scattered_APSY_subsystems#Member_availability_to_APSY_subsystems|Parallel Query Option/204]] (PQO) applications. With PQO, application subsystem definitions and requests can refer to remote files. Check to enable access to remote files.</td>
</tr>

<tr>
<td>Message Display Options</td>
<td>Check the boxes to display Disconnect, informational, and/or error messages for subsystem users.</td>
</tr>

</table>
</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====Files====
The Files menu item enables you to define the files, including the procedure file, used by the subsystem.
=====To create or update a file specification=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Files</code>.</li>
<li>Select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>On the Files screen, enter the [[Subsystem_Management_facility#File_specifications|file specifications]] in each field.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>
====System Classes====
You define command and file privileges for each class of subsystem users on the System Classes screen. Each class of user requires a separate screen. User class privileges defined to the subsystem override settings for OPENCTL and file privileges that reside in the password table.
=====To create a system class=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>System Classes</code>.</li>
<li>On the System Classes screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>In a semi-public subsystem, the first class is automatically assigned the class name DEFAULT. To change the name, double-click the name DEFAULT and type in the new name, which can be up to eight characters long.</li>
<li>In the Command Privileges section, check the box beside each subsystem command that you want the user class (SCLASS) to be able to issue. Debug specifies entering the subsystem in DEBUG mode.</li>
<li>If you are a system manager, you can update the fields in the Login Privileges section.
<ul>
<li>Login is optional and specifies the user class login privileges for all, some, or none of the subsystem user classes.

Any individual user login privilege held at entry to the subsystem or specified on the Operational Parameters screen is overridden. The original value is restored when the user exits the subsystem.

Enter a hexadecimal value within the range of X'00' to X'FF', as described in [[Establishing_and_maintaining_security#PRIVDEF_parameter_settings|PRIVDEF parameter settings]]. 

<code>NULL</code> indicates default privileges from the Operational Parameters screen. </li>
<li>Record Security ID is optional and overrides any individual user record security ID held on entry to the subsystem. You can enter a maximum of eight characters.

<code>NULL</code> indicates the security activated on login.

The original value of the record security ID is restored when the user exits the subsystem. 
</li>
<li>Account is optional and specifies an account associated with specific user classes. The account can be specified for all, some, or none of the user classes. You can enter as many as ten characters.
Any individual value of Account held at entry to the subsystem or specified on the Operational screen is overridden. The original value is restored when the user exits the subsystem.
NULL indicates the user's login account or the value from the Operational screen.
</ul>
</li>
<li>In the File Privileges section, set privileges for the files or groups that can be accessed by the defined class of users.

This section displays the names of files or groups that you defined for this subsystem on the File Use screen. For each file, you can define the following privileges:
<ul>
<li>Prcldef specifies <var class="product">Model 204</var> procedure security. Values must be between 0 (default) and 255, where 0 specifies no procedure security and 255 specifies the highest security.</li>

<li>Privileges specifies file privileges. Values are hexadecimal 0 to X'BFFF' (default). </li>

<li>Select Level, Read Level, Update Level, and Add Level specify values for field-level security parameters. Values must be between 0 (default) and 255, where 0 specifies that all users can access field values, and 255 restricts access of field values to users having certain privileges.</li>
</ul></li>
<li>When done defining the system class, click the Save <var class="term">number</var> Updates button.</li>
</ol>

=====To add or delete another system class=====
<ol>
<li>Click the plus sign icon beside the titles of the existing system classes (such as DEFAULT).</li>
<li>A new title, CLASS<var class="term">x</var>, appears. (As each new class is added, <var class="term">x</var> is incremented by 1.) Click the title field to enter a different name, up to eight characters long.</li>
<li>Fill in the fields as described above.</li>
<li>To delete the class, click the trash can icon beside its name.</li>
</ol>

=====To view users=====
<ol>
<li>Click the <code>Manage</code> tab. </li>
<li>In the <code>Subsystem Management</code> menu, click the arrow to open the submenu, and select <code>Users</code>.</li>
<li>On the Users screen, select a subsystem from the drop-down list beside the Subsytem field.</li>
<li>The list of users appears.</li>
</ol>

===Dictionary===

Dictionary/204 functionality is provided as a [[Janus_Web_Legacy_Support|Janus legacy application]].

The <code>Dictionary</code> links provide convenient access to the existing 3270 [[Dictionary/204_overview|Dictionary/204]] screens.

RKWeb provides the following <code>Dictionary</code> submenu items:
<ul>
<li><code>Administration</code> - Brings up the [[Dictionary/204_administration#Using_the_Dictionary.2F204_Administration_main_menu |Administration Facility main menu]].</li>
<li><code>Documents</code> - Brings up the [[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu| Documentation Facility main menu]].</li>
<li><code>Reports</code> - Brings up the [[Dictionary/204_reports#Selecting_a_report_option|Reports main menu]].</li>
<li><code>Xref</code> - Brings up the [[Dictionary/204_Cross-Reference_facility#Cross-Reference_Selection_screen|Cross-reference selection screen]].
<li><code>File Management</code> - Brings up the [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|File Management primary screen]].</li>
<li><code>SQL Catalog Reports</code> - Brings up the [[SQL_catalog_reporting_and_querying#CCACATREPT_Main_Menu|SQL Catalog Reporting Facility main menu]].</li>
<li><code>Table Specifications</code> - Brings up the [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Table Specification Facility main menu]].</li>
</ul>

When you click each link a new tab opens. The Dictionary components operate outside the RKWeb menu framework, leaving your original session in place in the original tab. When your Dictionary session is finished, you can simply close the tab to return to your RKWeb session.
====Administration====
The Dictionary Administration Facility screen, available to administrators, contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_administration#Entity_type_maintenance|Entity Type Maintenance]]</code>. Enables you to define, update, or delete a Dictionary [[Dictionary/204_entity_type_definitions|entity type]].</li>
<li><code>[[Dictionary/204_administration#Path_maintenance|Path Maintenance]]</code>. Enables you to display, add, update, or delete a Dictionary [[Dictionary/204_overview#Path_relationships|path]] definition.</li>
<li><code>[[Dictionary/204_administration#Facility_administration|Facility Administration]]</code>. Enables you to:
<ul>
<li>Add, delete, or rename procedure names on a list of user-written procedures that produce reports</li>
<li>Determine command options and setting defaults for the File Management facility</li>
</ul></li>
<li><code>[[Dictionary/204_administration#Security_administration|Security Administration]]</code>. Enables you to specify the privileges of Dictionary/204 users.</li>
<li><code>[[Dictionary/204_administration#Printing_a_dictionary_inventory|Inventory Report]]</code>. Enables you to produce a report covering the entire contents of the dictionary. This facility reports on the attributes and references of all entries of each entity type.
Note: The processing time required to produce the dictionary inventory can be quite long, depending upon the complexity and number of dictionary entries.</li>
</ol>
====Documents====
The Documents facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of the other facilities listed on the Dictionary/204 main menu.
The <code>[[Dictionary/204_Documentation_facility#Using_the_Documentation_main_menu |Dictionary Document Facility]]</code> screen contains a menu with the following options:
<ol>
<li><code>[[Dictionary/204_Documentation_facility#Adding_an_entry|Add an Entry]]</code>. You can add an entry for an entity type that is either a VIEW or an entity type created by your installation through the Dictionary Administration facility, for example, REPORTs, USERs, and so on. You cannot add entries managed by other Dictionary/204 facilities (such as FILE and PROCEDURE entries).</li>
<li><code>[[Dictionary/204_Documentation_facility#Updating_an_entry|Update an Entry]]</code>. You can update an entry of any entity type. You can change only the attributes and relationships that are not managed by another Dictionary/204 facility.
Updating also allows you to create [[Dictionary/204_Documentation_facility#Dummy_entries|dummy entries]].</li>
<li><code>[[Dictionary/204_Documentation_facility#Deleting_an_entry|Delete an Entry]]</code>. You can delete an entry for either a VIEW or an entity of a type defined at your installation through the Dictionary Administration facility. You cannot delete entries managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Copying_an_entry|Copy an Entry]]</code>. You can copy an entry for an entity type that is either a VIEW or an entity type created by your installation. You cannot copy entries that are managed by another Dictionary/204 facility.</li>
<li><code>[[Dictionary/204_Documentation_facility#Renaming_an_entry|Rename an Entry]]</code>. You can rename an entry for an entity type that is either a VIEW or an entity of a type created by your installation, such as REPORT, USER, and so on. You cannot rename entries manages by another Dictionary/204 facility. </li>
</ol>

====Reports====
Dictionary/204 provides online interfaces for querying and reporting on the entries in the dictionary. The reports can include:
<ul>
<li>All the attributes and relationships for a given entry</li>
<li>List of all of the entries for a given type of entity -- all SCREENs, all FILEs, and so on</li>
<li>Entries selected by name, entity type, relationship with another specified entry, or specific keywords</li>
</ul>
To run Dictionary reports:
<ol>
<li>Select <code>Manage > Dictionary > Reports</code> from the main menu.</li>
<li>On the Dictionary Reports Main Menu that appears, select an option:
<ol>
<li><code>[[Dictionary/204_reports#Displaying_an_entry|Display an Entry]]</code>
Displays the attributes and/or relationships (or references) for an entry of a specified entity type.</li>
<li><code>[[Dictionary/204_reports#Listing_entries_of_an_entity_type|List Entries of an Entity Type]]</code>
Displays a list of entries of one or several entity types. For example, the names of all the files, all the procedures, and so on.</li>
<li><code>[[Dictionary/204_reports#Displaying_cross-reference_relationships|Display Cross-References for an Entry</code>]]
Displays relationships between entries based on cross-references only.
You can search all entries or only entries of a particular entity type.
</li>
<li><code>[[Dictionary/204_reports#Displaying_named_relationships|Display Named References for an Entry]]</code>
Displays relationships between entries based on named references only.
You can search all entries or only entries of a particular entity type.
Named references are unidirectional and take the form A ===> B; however, Dictionary/204 also allows you to search for entries that are related to B (including A).</li>
<li><code>[[Dictionary/204_reports#Displaying_all_relationships|Display All References for an Entry]]</code>
Displays any relationship between entries including cross-, named, or path (indirect) references.</li>
<li><code>[[Dictionary/204_reports#Browsing_dictionary_entries_by_attributes|Browse Entries by Attributes]]</code>
Browses through entries selected by the value of their KEYWORD attribute, the UNQUALIFIED NAME attribute, or optionally browsing entries selected by the value of specific standard attributes.
You can restrict browsing to a single entity type or browse all the dictionary entries, regardless of entity type.
<li><code>[[Dictionary/204_reports#Selecting_a_user-written_.28customized.29_report |Select User-Written Report]]</code>
Select a report that has been customized by the Dictionary administrator.
</li>
</ol>
</li>
</ol>

====Xref====
The [[Dictionary/204_Cross-Reference_facility#Using_the_Cross-Reference_facility| Dictionary cross-reference facility]] produces a cross-reference report for procedures in a selected file or group. The report shows the line numbers where language elements such as labels, functions, and variable names occur.
<ol>
<li>From the main menu, select <code>Manage > Dictionary > Xref</code>.</li>
<li>On the Dictionary cross-reference screen, select the procedure file or group that you want to cross-reference.</li>
<li>In the Report Options list, select the SOUL elements to be included in the report, or select All.</li>
<li>On the "Expand INCLUDEs" line, enter Y or N. If you select Y, then the Cross-Reference facility scans every INCLUDE command or statement in your procedure, searches for the included procedures or subroutines, and cross-references all included code that is found.</li>
<li>In the procedure selection criteria section, specify procedure names or patterns:
<ul>
<li>Enter <code>N</code> to use procedure names.
You can enter several procedure names on the same line by separating the names with semicolons or any number of spaces. For example, the following line is recognized as a valid request to process three procedures:
BILLSYS.PROC1;BILLSYS.PROC2 BILLSYS.PROC3
</li>
<li>Enter <code>P</code> to use a pattern. This informs the Cross-Reference facility that you want to use [[Record_retrievals#Pattern_matching|pattern-matching rules]].
For example, enter <code>BILLSYS*</code> to generate a report for all procedures in the selected file that begin with the string BILLSYS.
</li>
</ul>
</li>
</ol>

====File Management====
The Dictionary/204 File Management Subsystem facility, [[Dictionary/204_FILEMGMT_overview|FILEMGMT]], enables you to create Model 204 files quickly, reliably, and securely. You define a file and its contents on the series of screens that FILEMGMT provides. FILEMGMT uses your definitions to:
<ul>
<li>Construct the Model 204 commands that create the physical file</li>
<li>Store the appropriate entries in your installation's dictionary</li>
</ul>
By combining the two operations, FILEMGMT eliminates the need to enter this information twice. FILEMGMT validates the information for accuracy and consistency, and it creates and stores all necessary dictionary entries and references.

FILEMGMT does more than create new files. You can use the facility to:
<ul>
<li>View existing file data</li>
<li>Reset file parameters</li>
<li>Add fields, records, and field groups to existing files</li>
<li>Calculate and change the size of a file</li>
<li>Copy files, fields, and records</li>
</ul>
To invoke FILEMGMT:
<ol>
<li>Select <code>Manage > Dictionary > File Management</code> from the main menu.
The [[Logging_on_to_FILEMGMT#FILEMGMT_primary_screen|FILEMGMT primary screen]] appears.
<li>In the Filename field, enter the name of the file that you are working with.</li>
<li>In the prefix box beside a category (File, Field, Record, or Field Group), enter the number corresponding to the action you want to perform.</li>
</ol>
The categories are as follows:
<table>
<tr>
<td><code>[[Logging_on_to_FILEMGMT#File_maintenance|File maintenance]]</code></td>
<td>Creates a new <var class="product">Model 204</var> file, determines the size of a file, recreates or modifies the parameters of an existing file, deletes or copies a file, and performs other file maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Field_maintenance|Field maintenance]]</code></td>
<td>Defines fields for a new or existing file, changes existing field names or attributes, and performs other field maintenance functions.</td>
</tr>

<tr>
<td><code>[[Logging_on_to_FILEMGMT#Record_maintenance|Record maintenance]]</code></td>
<td>Defines records for a new or existing file, changes existing record names or characteristics, and performs other record maintenance functions.</td>
</tr>
<tr>
<td nowrap><code>[[Logging_on_to_FILEMGMT#Field_Group_maintenance|Field Group maintenance]]</code></td>
<td>Defines field groups for a new or existing file, changes existing field group names or contents, and performs other field group maintenance functions.</td>
</tr>
</table>

====SQL Catalog Reports====
The CCACATREPT subsystem is a reporting mechanism for data in the CCACAT SQL catalog file. CCACATREPT is a menu-driven utility that produces both online and printed output. With CCACATREPT you can produce a report that provides information about all SQL objects defined in the SQL catalog.

Catalog administrators can compare the CCACATREPT output to the Model 204 file data to determine the updates they need to make to the SQL catalog to obtain consistency with the file. They can modify the report's generated DDL and use it to repopulate the SQL catalog. SQL application programmers and SQL users can use the output to verify valid table, view, column names and column attributes.

In the Selection field, specify the number of the type of report that you want to generate:
<ol>
<li>File of valid DDL syntax, which you can use to rebuild the catalog </li>
<li>Fixed format report of a table or view </li>
<li>Privilege report by table or view name </li>
<li>Privilege report by user</li>
</ol>
Fill in the fields as needed for each report:
<table>
<tr class="head">
<th>Field</th><th>Used in report type...</th><th>Value</th></tr>
<tr><td>Schema Name</td><td>1,2, or 3</td><td>Enter the name of a specific schema or enter an asterisk (*) for all schemas.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all schemas.</td></tr>

<tr><td>Authorization ID</td><td>1 or 2</td><td>Enter the name of a specific authorization ID or enter an asterisk (*) for all authorization IDs.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all authorization IDs.</td></tr>

<tr><td>Table View/Name</td><td>1, 2, or 3</td><td>Enter the name of a specific table or view to be reported or enter an asterisk (*) for all tables and views.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all tables and views.</td></tr>

<tr><td>DDL Statement Type(s)</td><td>1</td><td>The output from Selection 1 is standard SQL DDL generated from the Model 204 SQL catalog. In the DDL Statement Type(s) field, you identify the DDL statement types to be generated.
Select one or more of the following identifiers:
<table>
<tr class="head">
<th>Identifier</th>
<th>Statement generated</th>
</tr>
<tr>
<td>T</td>
<td>CREATE TABLE</td>
</tr>
<tr>
<td>V</td>
<td>CREATE VIEW</td>
</tr>
<tr>
<td>G</td>
<td>GRANT</td>
</tr>
<tr>
<td>T, V, or G</td>
<td>CREATE SCHEMA or SET SCHEMA 
CREATE TABLE, CREATE VIEW, and GRANT</td>
</tr>
</table>
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs all the DDL.</td></tr>
<tr><td>Grantee</td><td>4</td><td>Enter the SQL identifier of a specific grantee to be reported or enter an asterisk (*) for all grantees. Privileges granted to PUBLIC are always reported.
If your Selection field entry requires an entry for this field and you do not enter a value, by default CCACATREPT outputs privileges for all grantees.</td></tr>

<tr><td>"USE" Command Arg</td><td>All</td><td>Use this field to route output to a destination other than to the terminal. The character string you enter in this field becomes the Model 204 USE command argument that identifies the output destination device.
You can enter any USE command argument that is valid in your operating environment, for example, <code>PRINTER FOO</code> or <code>$PRINT *</code>.
For more details, see [[SQL_catalog_reporting_and_querying#.22USE.22_Command_Arg|"USE" Command Arg]].</td></tr>
</table>

====Table Specifications====
The Model 204 SQL Table Specification facility (TSF) enables you to create a new SQL table by mapping a Model 204 file. TSF is not used to modify existing tables.

TSF looks at an existing Model 204 file, reads its field names and their attributes, and allows you to specify how to map the file to an SQL table. The TSF provides an interactive, menu-driven facility that generates a subset of DDL statements based on your specifications. You can use the generated DDL as input to the CVI utility to define your SQL table to the SQL catalog.

The following table summarizes the values to be entered on the main screen. For details, see [[SQL_DDL_from_the_Table_Specification_Facility#Creating_or_modifying_a_base_table_.28Main_Menu_panel.29|Creating or modifying a base table (Main Menu panel)]].

Unless otherwise noted, you must enter a value for each field.
<table>
<tr class="head">
<th>Field</th><th>Value</th></tr>
<tr><td>Schema Authorization</td><td>Authorization ID (default is the Model 204 login user ID)</td></tr>
<tr><td>Table Name</td><td>The name of the SQL table that you are defining. Multiple nested tables are allowed.</td></tr>
<tr><td>Schema Name</td><td>The SQL schema name as you want it to appear in the CREATE SCHEMA statement. (If left blank, Schema Name defaults to the authorization ID specified for Schema Authorization.)</td></tr>
<tr><td nowrap>Model 204 File Name</td><td>The name of the Model 204 file that you want defined as an SQL table.</td></tr>
<tr><td>Password</td><td>If applicable, enter the passowrd that gives the user the authority to read the file and all the field names that will be used as columns in the SQL table.</td></tr>
<tr><td>Table Type</td><td>The table type: B (Base), P (Parent), or N (Nested).
<tr><td>Primary Key</td><td>If the table type is P (Parent) or N (Nested), enter the value for the primary key.</td></tr>
<tr><td>Parent Table</td><td>If the table type is N (Nested), enter the name of the SQL table that each nested table references.</td></tr>
</table>

===Passwords===

Clicking the <code>Manage > Passwords</code> menu item enables you to use the [[SirPro CCASTAT password maintenance|SirPro password functionality]] to maintain passwords in [[Storing security information (CCASTAT)|CCASTAT]].

When viewing passwords for users, files, or groups, click a column header (such as Privileges) to sort the entries by that header.

Click the information icon (the letter i in a red circle) at the right of the screen to see the current values of the parameters that affect the password settings. Click the link to the Model 204 wiki to get to detailed parameter information.

====Users====
From the <code>Users</code> menu, you can add, change, or delete login user ID entries in the password table.

=====To add a user ID=====
<ol>
<li>Click the plus sign icon beside the Model 204 User Passwords header.</li>
<li>In the Add userid to CCASTAT dialog box that appears, enter the user ID, which can be one to ten characters long.
<li>In the Password field, enter the password. The password cannot contain commas and must be one to eight characters long.
For more information on mixed-case passwords and Password Expiration, see [[LOGCTL_command:_Modifying_user_ID_entries_in_the_password_table|LOGCTL for user ID entries]].</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Priority field, choose a [[PRIORITY_command#Usage_notes|user priority]] from the drop-down list.</li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new user ID is listed.</li>
</ol>

=====To change a User ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change user password or logon settings dialog box, change the user id, password, verify password, priority, privileges, and/or terminals.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a user ID=====
<ol>
<li>Click the icon to the left of the user ID that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete User pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the user ID has been removed from the list.</li>
</ol>
====Files====
From the <code>Files</code> menu, you can add, change, or delete file entries in the password table.
=====To add a file password=====
<ol>
<li>Click the plus sign icon beside the Model 204 File Passwords header.</li>
<li>In the Add File entry to CCASTAT dialog box that appears, enter the name, password, and privileges for the file. Hover over each field for pop-up help. For details on acceptable values, see [[LOGCTL_command:_Modifying_file_entries_in_the_password_table|LOGCTL for file entries]].</li>
<li>In the File name field, enter the File name, which can be 1-8 characters long and must start with a letter.</li>
<li>In the Password field, enter the password. The password cannot contain blanks, commas colons, or the LINEEND character. It must be 1 to 8 characters long.</li>
<li>Re-enter the password in the Verify Password field.</li>
<li>In the Privileges field, click the search icon beside the field and select from a checklist of privileges.</li>
<li>In the Index field, specify a single index character (a digit 0-9 or a letter A-Z). An index is required when a file has more than one password; it is used to differentiate entries for future changes or deletions.</li>
<li>In the User class field, enter the number of the [[Model_204_security_features#User_and_procedure_classes|user class]] that can access the file.</li>
<li>In the Select Privs, Read Privs, Update Privs, and Add Privs fields, enter the three-digit [[Establishing and maintaining security#Field-level security|field-level security]] for Select, Read, Update, and Add privileges. </li>
<li>In the Terminals field, leave the default of ALL if your installation does not use terminal security features. Otherwise, enter the number of a terminal from which a user can issue a LOGIN command for this user ID.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new file entry is listed.</li>
</ol>

=====To change a file password or logon settings=====
<ol>
<li>Click the icon to the left of the file ID that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change file password or logon settings dialog box, change the Password, general Privileges, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying file_entries in the password table|LOGCTL for file entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>

=====To delete a file=====
<ol>
<li>Click the icon to the left of the File that you want to delete.</li>
<li>Select <code>Delete</code> from the pop-up menu that appears.</li>
<li>In the Delete File pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the file has been removed from the list.</li>
</ol>
====Groups====
From the <code>Groups</code> menu, you can add, change, or delete group entries in the password table.
=====To add a group entry=====
<ol>
<li>Click the plus sign icon beside the Model 204 Group Passwords header.</li>
<li>In the Add Group entry to CCASTAT dialog box that appears, enter the Group name, Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals.
For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To set general Privileges, click the search icon beside the field to bring up a checklist of privileges.
</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the new group entry is listed.</li>
</ol>

=====To change a group password or logon settings=====
<ol>
<li>Click the icon to the left of the group id that you want to change.</li>
<li>Select Change from the pop-up menu that appears.</li>
<li>In the Change group password or logon settings dialog box, change the Password, general Privileges, Index, User class, Select/Update/Read/Add privileges, and/or Terminals. For information on acceptable values, see [[LOGCTL command: Modifying group entries in the password table|LOGCTL for group entries]].
Tip: To change general Privileges, click the search icon beside the field to bring up a checklist of privileges.</li>
<li>Click the Save updates button. The information is immediately committed to CCASTAT.
</li>
</ol>
=====To delete a group entry=====
<ol>
<li>Click the icon to the left of the group that you want to delete.</li>
<li>Select Delete from the pop-up menu that appears.</li>
<li>In the Delete Group pop-up that appears, click Confirm Delete. The information is immediately deleted from CCASTAT.
</li>
<li>Press F5 to refresh the screen and verify that the group entry has been removed from the list.</li>
</ol>

===Group Definitions===
The <code>Group Definitions</code> menu option enables system managers to manage the [[SirPro file-group maintenance|group definitions]] in [[Storing and using file group definitions (CCAGRP)|CCAGRP]].
====To add a group====
<ol>
<li>Click the plus sign icon beside the Model 204 Groups screen title.
The Create a new group screen appears.</li>
<li>Fill in or select the field values to set the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save changes button.</li>
<li>Press the <code>F5</code> key to refresh the display and see your group in the list.</li>
</ol>

====To copy a group====
<ol>
<li>Click the icon beside the group name that you want to copy, and click Copy in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the new name in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and see the new copy with the name that you entered.</li>
</ol>

====To rename a group====
<ol>
<li>Click the icon beside the group name that you want to rename, and click Rename in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Rename Group pop-up, enter the name of the new copy in the To field and click Confirm Rename.</li>
<li>Press F5 to refresh the screen and confirm the name change.</li>
</ol>

====To update a group====
<ol>
<li>Click the icon beside the group name that you want to update, and click Update in the Copy/Rename/Update/Delete pop-up list.</li>
The Update group definition dialog box appears.</li>
<li>Fill in or select new field values to change the group parameters. Hover the mouse over each field for help. These parameters are also described in the [[CREATE command: Permanent group|CREATE]] command.</li>
<li>Click the Save <var class="term">number</var> Updates button.</li>
</ol>

====To delete a group====
<ol>
<li>Click the icon beside the group name that you want to delete, and click Delete in the Copy/Rename/Update/Delete pop-up list.</li>
<li>In the Delete Group pop-up, click Confirm Delete.</li>
<li>Press F5 to refresh the screen and confirm that the group has been removed from the list.</li>
</ol>

===SSL Certificates===
Note: Before using the RKWeb SSL Certificates interface, click the <code>Manage > SSL Certificates > SSL Information</code> menu item and read the SSL Certificate Management - How to use this application screen.
====Overview====

Janus Network Security supports the SSL (Secure Socket Layer) and the TLS (Transport Layer Security) protocols, which provide secure communications for users of Janus products. In order to provide for secure communications and authentication, SSL employs several features, including public and private keys for encryption, and certificates and digital signatures for authentication.
Server certificates used by SSL typically contain the country, state or province, locality (city, town, village, etc.), organization, and organizational unit of the holder of the private key. In addition, SSL server certificates contain the TCP/IP host name of the server that holds the private key.

The information in a server certificate can normally be viewed in a client application such as a browser, so an end user can be sure that he or she is communicating with the correct server.

Note: An SSL client will automatically verify that the host name in a server certificate matches the name of the host to which it is connecting.

For more information on certificates, see [[Janus Network Security#keycert|About keys and certificates]].

RKWeb provides a convenient web interface for the tasks involved in generating an SSL certificate. (For an overview of the process, see [[SSL certificate management|SSL certificate management]].)

The process of getting a valid certificate and private key combination usually involves these steps:
<table>
<tr class="head">
<th>Step</th><th>Menu item</th><th>Notes</th></tr>
<tr>
<td>1. Generate a private key and an associated certificate request.</td><td>Create Request</td><td>The certificate request is basically a certificate without a digital signature. The private key should be stored in a secure location and (preferably) encrypted.</td></tr>
<tr><td>2. Forward the certificate request file to the certifying authority (CA).</td><td>N/A</td><td>Scroll down the screen to the "How to use this page" section.</td></tr>
<tr><td>3. The certifying authority digitally signs the certificate.</td><td>N/A</td> <td>Presumably, the certifying authority verifies that the information in the certificate is correct and valid, but this is not strictly necessary.</td></tr>
<tr><td>4. The certifying authority sends the digitally signed certificate back to the holder of the private key.</td><td>N/A</td><td>N/A</td></tr>
<tr><td>5. The holder of the private key receives the signed certificate. This usually involves associating the signed certificate with the private key in some way.</td><td>Receive Certificate</td><td>With Janus Network Security, the private key and the signed certificate must be placed into the same procedure.</td></tr>
</table>

====Create Request====
=====To generate a certificate request=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Create Request</code> menu item.</li>
<li>On the Generate Certificate Requests and Self-Signed Certificates screen, scroll down to read the online help. </li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Create certificate request button.</li>
</ol>

=====To generate a self-signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Sign Certificate</code> menu item.</li>
<li>On the Sign a Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Sign the Certificate button.
</ol>

=====To receive a signed certificate=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Receive Certificate</code> menu item.</li>
<li>On the Receive a Signed Certificate screen, scroll down to read the online help.</li>
<li>Fill in the fields as directed in the help. Hover the mouse over each field for pop-up help.</li>
<li>Click the Receive Certificate button.
</ol>

=====To manage SSL requests and certificates=====
<ol>
<li>Click the <code>Manage > SSL Certificates > Manage Certificates</code> menu item.</li>
<li>Click the equals sign icon beside a request name and select an option:
<ul>
<li>View the details of the certificate on a separate screen</li>
<li>Add an intermediate certificate. For information about intermediate certificates, see the online help on the SSL information screen.</li>
<li>Rename the selected certificate</li>
<li>Delete the selected certificate</li>
</ul></li>
</ol>

=====To learn about using the SSL application=====
Click the <code>Manage > SSL Certificates > SSL Information</code> menu item to bring up the SSL Certificate Management - How to use this application screen.
It is recommended that you read this screen before doing any SSL tasks.

==Monitor==
The <code>Monitor</code> menu enables you to monitor Model 204 performance, perform a journal scan, and run Model 204 commands.
===Performance===
The <code>Monitor > Performance</code> menu is the RKWeb interface to the [[SirMon]] monitoring application. SirMon combines the real time monitoring of Model 204 performance with intelligent full screen displays that facilitate System Manager duties. Displays may be scrolled, refreshed, and sorted by displayed statistics and parameters.

SirMon provides a collection of pre-defined monitoring options known to be useful for analyzing Model 204 performance and solving performance problems. SirMon features are designed to highlight significant resource consumers.

SirMon is completely integrated with the Model 204 security scheme, so users have access to commands in SirMon only if they have access to them at Model 204 command level.

SirMon divides the Model 204 Online into System, Subsystem, File, User, and Task statistics. In addition to those statistics collected by Model 204, SirMon provides an extensive collection of additional statistics and information that is invaluable for understanding the performance of a Model 204 Online.

To see the meaning of any statistic in the display, mouse over it for pop-up help.

Extensive customization facilities make it easy to design and implement screens or views that track information of interest to your particular site.

====System====
The <code>Monitor > Performance > System</code> menu option provides a submenu of system statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Above-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th nowrap>Above/Below the bar disk I/O </th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Below-the-bar Buffers</th>
<td>Locally defined selection.</td></tr>

<tr>
<th>Database I/O Performance</th>
<td>Overall view of physical and logical I/O for the various database files defined to the Online environment.</td></tr>

<tr>
<th>MP Performance</th>
<td>Measures of performance specific to a multi-processor <var class="product">Model 204</var> environment.</td></tr>

<tr>
<th>Request Profile</th>
<td>Overall view of database activity up to the current moment.
Displays total <var>Find</var> statements and various measures of record access and update.</td></tr>

<tr>
<th>System Performance</th>
<td>General view of system performance that includes CPU usage, I/O activity and other broad measures.</td></tr>

<tr>
<th>User State Distribution</th>
<td>Reports the total number of users in the various categories of activity (running, waiting, swapping, etc.) at a given moment.</td></tr>

<tr>
<th>User Wait Type Dist</th>
<td>Displays counts of users by wait type (waiting for disk I/O, or file
resource, etc.).</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the System Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in the [[#Custom|custom screen]] section.

====Files====
The <code>Monitor > Performance > Files</code> menu presents a submenu of file statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Buffer Usage</th>
<td>Detailed breakdown of each file's disk buffer usage by table together with disk read and write rates.</td></tr>

<tr>
<th>Critical File Resource</th>
<td>Shows each category of resource conflict as a rate and the total number if users waiting on various critical file resources.</td></tr>

<tr>
<th>File Activity</th>
<td>Display of disk activity, file enqueue counts, total page buffer utilization, and critical file resource conflicts.</td></tr>

<tr>
<th>File Table Usage</th>
<td>Shows file space utilization information for each open <var class="product">Model 204</var> file, broken down by table type.</td></tr>

<tr>
<th>Ordered Index Usage</th>
<td>Information about ordered index data density and usage.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the File Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Users====
The <code>Monitor > Performance > Files</code> menu presents a submenu of user statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Critical File Resources</th>
<td>Detailed statistics providing information about conflicts on critical file resources.</td></tr>

<tr>
<th>Disk Buffer Usage</th>
<td>Various DKxxx statistics for each user.</td></tr>

<tr>
<th>Misc. Resource Usage</th>
<td>Aggregate measures of activity, making it easy to spot significant resource consumers.</td></tr>

<tr>
<th>Record Locking Table Usage</th>
<td>Statistics useful in determining utilization of the record locking table and highlighting poor enqueueing behaviour in applications.</td></tr>

<tr>
<th>Resource Usage</th>
<td>Broad measurements of users' consumption of CPU and I/O activity.</td></tr>

<tr>
<th>Resource Usage and Subsys</th>
<td>Various resource consumption statistics and the current subsystem for each user.</td></tr>
<tr>
<th>User State Display</th>
<td>Displays users state, wait type and other measures to indicate their level of activity.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the User Monitor menu.
These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====Subsystems====
The <code>Monitor > Performance > Subsystems</code> menu presents a submenu of subsystem statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th nowrap>Active/Inactive Subsystems</th>
<td>Display of status, number of users, access (PRIVATE, PUBLIC, SEMIPUBLIC), non-precompiled prefix and precompiled prefix for all subsystems defined in the Online.
</td></tr>

<tr>
<th>Resident QTBL Usage</th>
<td>Detailed breakdown of key information about each subsystem's use of resident QTBL.</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.

Locally defined screens may also be accessed from the Subsystems menu. These screens are defined by a <var class="product">SirMon</var> administrator as described in [[#Performance Custom screens|Performance Custom screens]].

====MP Tasks====
The <code>Monitor > Performance > MP Tasks</code> menu presents a submenu of task statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>

<tr>
<th>Task Performance</th>
<td>Display of CPU usage, the PCPU statistic, and other statistics related to performance of <var class="product">Model 204</var> multitasking.
</td></tr>
</table>

For a description of each statistic, hover the mouse over the column heading to see pop-up help.
Locally defined screens may also be accessed from the Task
Monitor menu. These screens are defined by a <var class="product">SirMon</var> administrator, as described in [[#Performance Custom screens|Performance Custom screens]].

====Janus Ports====

The <code>Monitor > Performance > Janus Ports</code> menu presents a submenu of port statistics screens:

<table class="thJustBold">
<tr class="head">
<th>Option</th>
<th>Description</th></tr>
<tr>
<th>Janus SSLStat</th>
<td>A detailed display of the SSL activity for each combination of Janus port and network security protocol. "SSL activity" refers to <var class="product">[[Janus Network Security]]</var> encrypted communications on a Janus port whose definition includes an SSL parameter specification. Each port is listed under the <var>Portname</var> header.
For details on the Janus SSL statistics, see [[JANUS_SSLSTAT_or_SSLSTATUS|Janus SSLStat]].
</td></tr>

<tr>
<th>Janus Status</th>
<td>A detailed display of the current status of specified ports. </td></tr>

<tr>
<th>Janus TStat</th>
<td>A detailed display of thread usage activity on Janus ports. This information can prove useful in isolating problems with thread availability and in doing capacity planning.</td></tr>
</table>

For pop-up help for each statistic, hover the mouse over the column header.

====Custom====
The <code>Monitor > Performance > Custom</code> menu item enables you to build a custom performance screen.

=====To create a custom performance screen=====
<ol>
<li>Click the <code>Monitor</code> tab.</li>
<li>In the <code>Performance</code> menu, click the arrow to open the submenu, and select <code>Custom</code>.</li>
<li>In the Type section, select the type of performance statistics that you want to use.</li>
<li>In the Load From field, click the subsystem that you want to load from.
To start again, click Clear.</li>
<li>In the Non-Interval Statistics section, click one or more statistic buttons to select the statistics to be included. To see a description of each statistic, hover the mouse over the statistic button.
The selected statistics buttons will turn blue, and the buttons will be copied into the Sort order section. The statistics will be listed in the order that you select them, or you can click and drag them within the Sort order section to change their order.
To remove a statistic from the list to be included, click its blue button. Or click its button in the Sort order section to show a Remove Stat menu item. Click Remove Stat. To cancel the removal, click away from Remove Stat. </li>
<li>In the Interval Statistics section, click to select each statistic that you want to be included.
Most statistics viewable as rates (interval statistics) can alternatively be displayed as totals. To view a statistic as a total, click its button in the Sort order section and select Set as Total (#). The statistic name on the button appears with # appended to show it is a total. To undo, click the button again and select Clear Total (#).</li>
<li>To run the report, click Run. On the report screen that appears, hover the mouse over each statistic name to display pop-up help. Click Refresh to run the report again.</li>
<li>To save as an ad hoc listing, click Save as Adhoc. The listing will be saved to "Adhoc for <var class="term">username</var>."</li>
<li>To save under a report type, click Save.</li>
</ol>

===Journal Scan===
This link brings up the [[SirScan]] functionality.
SirScan is a high performance utility that allows users in a Model 204 Online to browse the contents of its journal in real time.

SirScan allows ordinary users to view journal entries generated by their own online session, and it allows users in SIRSCAN subsystem ADMIN [[SCLASS#User_class|SCLASSes]] to browse journal entries for any set of users. The data is displayed in a full-screen browser with powerful searching commands and filtering options.

The Model 204 Journal scan screen enables you to set the [[SirScan_scan_specification|journal scan specifications]]. When you have entered the desired field values, click Submit journal request to see the journal entries.

===Command processor===
With the command processor, you can run any [[Category:Commands|Model 204 command]] that your user role has permissions for.

====To run a Model 204 command====
<ol>
<li>Click the <code>Command processor</code> link to open the Model 204 command interface.</li>
<li>Enter any command as you would on a Model 204 command line, such as <code>VIEW ALL</code>, then click Submit to run it.</li>
<li>To see the command history, click Show stack. You can edit the stack by deleting unwanted commands and clicking Save stack.</li>
</ol>

==RKWeb Security==

RKWeb is implemented as a single application subsystem (APSY) and provides access to each of its Model 204 components as appropriate, based on your site's products and your user permissions.
<ul>
<li>Some RKWeb components are purchased as individual products and are not included in the Model 204 core. Those products are only available at sites that own them.</li>
<li>Some components, such as SirScan, check that your site owns the underlying product and verify user access by SCLASS. Other features, such as LOGCTL access, require the same UPRIV as at command level (typically System Manager or System Administrator).</li>
</ul>

If your site or your user role does not have access to a component, the component link is visible in the RKWeb UI but is inactive.

Privileges for the Command processor are handled as they are on the command line: you can run any commands that you have permissions for.

For details on configuring RKWeb security, see [[RKTools installation#RKWeb (Model 204 Tools on the Web)|RKWeb installation]].

==Where's my RKTools 3270 functionality?==
Want to use the RKWeb interface but looking for the familiar RKTools functionality?

The following table maps each RKWeb menu item to the existing RKTools 3270 interface. Be aware that not all the functionality present in each product's 3270 screens is reproduced in RKWeb.

The Available to... column shows which product you must own in order to access a specific component. "Model 204 Core" functionality is available to all users with proper permissions.

<table>
<tr class="head"><th>RKTools 3270</th><th nowrap>RKWeb component > menu item</th><th>Available to...</th></tr>

<tr><td>Model 204 command line, SirPro command processing</td><td nowrap>Build, Manage, Monitor > Command processor</td><td>Model 204 Core</td></tr>

<tr><td>CREATE GROUP command, SirPro</td><td>Manage > Group Definitions</td><td>Model 204 Core</td></tr>

<tr><td>Dictionary/204</td><td>Manage > Dictionary</td><td>Model 204 Core</td></tr>

<tr><td>JANSSL</td><td>Manage > SSL Certificates</td><td>Janus Network Security owners</td></tr>

<tr><td nowrap>LOGCTL/LOGADD commands, SirPro</td><td>Manage > Passwords</td><td>Model 204 Core</td></tr>

<tr><td>SirFact</td><td nowrap>Build > Fact Dump Analysis</td><td>SirFact owners</td></tr>

<tr><td>SirLib</td><td>Build > Configure</td><td>SirLib owners</td></tr>

<tr><td>SirMon</td><td>Monitor > Performance</td><td>SirMon owners</td></tr>

<tr><td>SirScan</td><td>Monitor > Journal Scan</td><td>SirScan owners</td></tr>

<tr><td>SirTune Reports</td><td>Build > Tune Reports</td><td>SirTune owners</td></tr>

<tr><td>SoulEdit</td><td>Build > Edit</td><td>SirPro owners</td></tr>

<tr><td>Subsystem Management</td><td>Manage > Subsystem Management</td><td>Model 204 Core</td></tr>
</table>
</div>

RKTools installation

2017-06-22T16:34:05Z

Alan:

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server sizes|RKTools server sizes]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: If you are upgrading from a previous version, 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 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<th>Adjustment</th></tr>
<tr><th>NFILES</th>
<td>Increase by the number of <var class="product">RKTools</var> files.</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>NORQS</th>
<td>Minimum setting is 5.</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>MAXBG</th>
<td>Minimum setting is 4.</td></tr>

<tr><th>SESUMAX</th>
<td>Minimum setting is 10. The right setting for your site might be higher, based on RKWeb usage.</td></tr>

<tr><th>SESNPUB</th>
<td>Minimum setting is 40. The right setting for your site might be higher, based on RKWeb usage.</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>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>
</table> </li>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

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

<tr><th>LIBUFF</th>
<td style="text-align:right">2000</td>
<td>Length of input buffer</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LGTBL</th>
<td style="text-align:right">2000</td>
<td>Length of global variable table</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>LITBL</th>
<td style="text-align:right">104</td>
<td>Length of ITBL</td></tr>

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

<tr><th>LFSCB</th>
<td style="text-align:right">21400</td>
<td>Length of full screen buffer</td></tr>

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

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>
</table></li>

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server sizes," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accomodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

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

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

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

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

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

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

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

<tr><th>JANSSL</th>
<td>300K</td></tr>

<tr><th>RKTools</th>
<td>135K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 <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 four 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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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.*'

JANUS START MYWEBPORT </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>

RKTools installation

2017-06-22T13:44:19Z

Alan:

==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 204</var> 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 <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 204 SOUL tools provided by Rocket are in a single file.

Tip: The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> file. If you might want to switch back to the previous version of RKTools, you should 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]]).

Installing <var class="product">RKTools</var> requires downloading the <code>M204PROC</code> file from the <var class="product">Model 204</var> maintenance website, 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.

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.

===Dictionary/204===
Because all Rocket Model 204 procedures are in one file in V7.7, including those for [[Dictionary/204 overview|Dictionary/204]], review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) might need to be run in addition to the RKTools installation.

==Download the installation file==
All <var class="product">RKTools</var> 7.7 code resides in the <code>M204PROC</code> <var class="product">Model 204</var> 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 <code>SIRIUS</code>.

To download from the Rocket website:
<ol>
<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 version of RKTools that is compatible with your version of Model 204. The procfile 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.
</li>
</ol>

You can bypass any step of the installation that applies only to an <var class="product">RKTools</var> module you are not installing.

==System requirements==
<ul>
<li>RKTools V7.7 was made specifically backward compatible to M204 version 7.6, though version 7.7 is recommended. Version 7.5 of <var class="product">RKTools</var> requires <var class="product">Model 204</var> version 7.5 or higher.

<li>Requirements for server sizes and parameter settings for each product are listed in [[#RKTools server sizes|RKTools server sizes]].</li>

<li>To verify the products for which your Online is authorized, enter <code>ROCKET</code> at the <var class="product">Model 204</var> command line.</li>

<li>The installing user must have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online</li>
<li>Model 204 System Manager privileges</li>
<li>Access to the [[SUBSYSMGMT]] facility and the JCL or EXEC that runs the Online <var class="product">Model 204</var> region.</li>
</ul>
</li>
</ul>

==Installing RKTools==
Attention: If you are upgrading from a previous version, 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 7.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 your existing RKTools files to determine whether to perform upgrade actions or new-installation actions.

<ol>
<li>Allocate the space required for the RKTools files. </li>

The following table shows the RKTools files and their sizes:
<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>

<tr><th>SIRLOCAL
</th><td>1200 pages</td>
<td>Always.</td></tr>

<tr><th>M204LOCL
</th><td>2000 pages</td>
<td>If using RKWeb.</td></tr>

<tr><th nowrap>MONDATA</th>
<td>4000 pages</td>
<td>Only if installing <var class="product">SirMon</var>. Note: <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer needed as of RKTools V7.7. </td></tr>

<tr><th>SIRFILED</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirFile.</var></td></tr>

<tr><th>SIRLIBD</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib.</var></td></tr>

<tr><th>SIRLIBP</th>
<td>1200 pages</td>
<td>Only if installing <var class="product">SirLib</var>.</td></tr>

<tr><th>JANCAT</th>
<td>1200 pages</td>
<td>Only if installing Janus OMNI.</td></tr>

<tr><th>JANSSL</th>
<td>1200 pages</td>
<td>Only if installing [[Janus Network Security|Janus SSL]] or RKWeb.</td></tr>
</table>

<li><var>RESTORE</var> <code>M204PROC</code> from the downloaded DUMP file.
<blockquote class="note">
Note: If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does not 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: 
CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>

</blockquote >

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<ol type="a">
<li>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.</li>

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

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

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

Adjust these parameters: 
<table class="thJustBold">
<tr><th>Parameter</th>
<th>Adjustment</th></tr>
<tr><th>NFILES</th>
<td>Increase by the number of <var class="product">RKTools</var> files.</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>NORQS</th>
<td>Minimum setting is 5.</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>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>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>
</table> </li>

<li>Verify you have adequate <var>[[UTABLE command|UTABLE]]</var> settings.

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. 

These are the recommended settings: 
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

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

<tr><th>LIBUFF</th>
<td style="text-align:right">2000</td>
<td>Length of input buffer</td></tr>

<tr><th>LOBUFF</th>
<td style="text-align:right">960</td>
<td>Length of output buffer</td></tr>

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

<tr><th>LQTBL</th>
<td style="text-align:right">2200</td>
<td>Length of QTBL</td></tr>

<tr><th>LNTBL</th>
<td style="text-align:right">450</td>
<td>Length of NTBL</td></tr>

<tr><th>LSTBL</th>
<td style="text-align:right">60000</td>
<td>Length of STBL</td></tr>

<tr><th>LTTBL</th>
<td style="text-align:right">2000</td>
<td>Length of TTBL</td></tr>

<tr><th>LVTBL</th>
<td style="text-align:right">1300</td>
<td>Length of VTBL</td></tr>

<tr><th>LGTBL</th>
<td style="text-align:right">2000</td>
<td>Length of global variable table</td></tr>

<tr><th>LFTBL</th>
<td style="text-align:right">1000</td>
<td>Length of FTBL</td></tr>

<tr><th>LXTBL</th>
<td style="text-align:right">1000</td>
<td>Length of XTBL</td></tr>

<tr><th>LITBL</th>
<td style="text-align:right">104</td>
<td>Length of ITBL</td></tr>

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

<tr><th>LFSCB</th>
<td style="text-align:right">21400</td>
<td>Length of full screen buffer</td></tr>

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

<tr><th>HTLEN </th>
<td style="text-align:right">220 </td>
<td>Max length of each header or trailer</td></tr>

<tr><th>MAXHDR</th>
<td style="text-align:right">7</td>
<td>Max number of headers</td></tr>

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

<tr><th>SCRNSTBL </th>
<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>.

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 <var>SCRNSTBL</var> will cause table-size resets to fail.</td></tr>
</table></li>

<li>Install the UL/SPF components, and install or reinstall Dictionary/204 and SQL utitilies as needed:
<ol type="a">
<li>UL/SPF components
Issue these commands:
OPEN FILE CCASYS
OPEN FILE M204PROC
INCLUDE RKTOOLS_INSTALL 

RKTOOLS_INSTALL 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, as long as your existing SIRLOCAL file is left in place.
If any problems are encountered while running this procedure, correct the problems and re-execute. 

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

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

<li>Dictionary/204
Though the [[Dictionary/204 overview|Dictionary/204]] components are delivered in <code>M204PROC</code> and accessible from RKWeb, they have their own installation process. Review the [[Dictionary/204 installation guide]] to see what steps, if any, related to the Dictionary/204 tools (SUBSYSMGMT, [[FILEMGMT overview|FILEMGMT]], and so on) you might need to run in addition to the RKTools installation. </li>

<li>SQL Server
The [[SQL Server overview|Model 204 SQL Server]] components continue to be delivered in <code>M204PROC</code> but they are also accessible from RKWeb. Using RKWeb for the SQL Server tools (CCACATREPT, CCATSF) requires the availability of additional supporting files and the inclusion of a separate installation procedure, as described in [[Model 204 SQL Server installation]]. </li>
</ol>
</li>

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

<li>Review the next section, "RKTools server sizes," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>

Note: CCATEMP usage might 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. 

===Server size requirements===
The server size requirements for RKTools, Dictionary/204, and Model 204 SQL Server are listed in this section.
Note: The actual server size requirements might vary slightly from the listings below because of table
settings in your <var class="product">Model 204</var> Online, and because of slight differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.

====RKTools server size====
The minimum <var class="product">RKTools</var> server size requirements are listed below.
Rocket recommends using one server size for the entire Online, making it at least 750,000 bytes to accomodate the largest RKTools component.
<table class="thJustBold">
<tr class="head"><th>Subsystem name</th>
<th>Minimum server size</th></tr>

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

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

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

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

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

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

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

<tr><th>JANSSL</th>
<td>300K</td></tr>

<tr><th>RKTools</th>
<td>135K</td></tr>
</table>

====Dictionary/204 server size====
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server size
</th></tr>

<tr><th>DICTIONARY
</th><td>455K</td></tr>

<tr><th>DOCUMENT
</th><td>455K</td></tr>

<tr><th>DICTADMIN
</th><td>455K</td></tr>

<tr><th>FILEMGMT
</th><td>455K</td></tr>

<tr><th>SUBSYSMGMT
</th><td>455K</td></tr>

<tr><th>DICTREPORT
</th><td>455K</td></tr>

<tr><th>XREF
</th><td>455K</td></tr>
</table>

====SQL Server size====
The minimum Model 204 SQL Server size requirements are listed below.

<table class="thJustBold">
<tr class="head"><th>Subsystem name</th><th>Minimum server size</th></tr>

<tr><th>CCACATREPT</th>
<td>250000</td></tr>

<tr><th>CCATSF</th>
<td>165000</td></tr>
</table>

===Additional setup for SirLib===
Read and follow the instructions in the [[SirLib "getting started" steps]].

===Additional setup for SirScan===
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]] for details.

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

If the <var class="product">SirMon</var> background monitor is to be used,
add the following line to User 0's input stream:
SIRMON BACKGROUND

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.

<var class="product">SirMon</var> has a feature to send warnings to
e-mail addresses and cell phones (via e-mail).
This feature requires <var class="product">[[Janus Sockets]]</var> and a started <var class="product">Janus Sockets</var> port.

===Additional setup for SirFile===
If the <var class="product">SirFile</var> background monitor is to be used, add the following line to User 0's input stream:
SIRFILE BACKGROUND

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.

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

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 <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 four 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 the bottom section, 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 [[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.

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


RKWeb 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
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:

*... 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/GIF
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 /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 /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, 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.

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

<nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki>

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

===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 rules in the section above 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:
<ol>
<li>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.*'

JANUS START MYWEBPORT </li>

<li>Use either of the following ways to connect to the JANSSL certificate management program:
<ul>
<li>With the following URL, invoke the Janus default home page:
<nowiki>http://</nowiki>www.mydomain.com:xxxx 

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. 

On the Janus default home page, click the link to the JANSSL certificate management program. </li>

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

<nowiki>http://</nowiki>www.mydomain.com:9999/janweb/sslmain.html </li>
</ul></li>

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

<li>Use the self-signed certificate to protect the port from which RKWeb will run. </li>
</ol>