m204wiki - User contributions [en]

Release notes for SirScan V7.7

2017-09-07T20:36:48Z

MCosta:

This document lists the changes that have been made for <var class="product">SirScan</var> version 7.7.
<p><var class="product">SirScan</var> 7.7 is designed for use with Model 204 V7.7 and later but is backward compatible to Model 204 V7.6.</p>

<var class="product">SirScan</var> is a member of the <var class="product">[[RKTools]]</var> product family; see also the [[Release notes for RKTools V7.7|release notes for RKTools version 7.7]].

==RKWeb UI for SirScan functionality==
The [[RKWeb]] tool, new in RKTools 7.7, enables you to access SirScan journal browsing functionality using a task-based web UI. From RKWeb, you can set the journal scan specifications and then view the journal entries.
<p>The standard 3270 SirScan interface has not changed; RKWeb simply provides an easy to use, mobile-friendly alternative.</p>

<p>For more information, see the [[RKWeb#Journal Scan|Journal Scan section of RKWeb]].</p>

Release notes for SirLib V7.7

2017-09-07T20:28:14Z

MCosta:

This document lists the changes that have been made for <var class="product">SirLib</var> version 7.7.
<p><var class="product">SirLib</var> 7.7 is designed for use with Model 204 V7.7 and later but is backward compatible to Model 204 V7.6.</p>

<var class="product">SirLib</var> is a member of the <var class="product">[[RKTools]]</var> product family; see also the [[Release notes for RKTools V7.7|release notes for RKTools version 7.7]].

==SirLib access from RKWeb==
The [[RKWeb]] tool, new in RKTools 7.7, enables you to perform most Model 204 tasks using a mobile-friendly web interface.
<p>
You can access screens in the [[SirLib change control#SirLib main menu|SirLib Configuration and Change Control System]] from RKWeb without ending your RKWeb session.</p>
<p>
SirLib functionality is provided as a [[Janus Web Legacy Support|Janus Web legacy application]], operating outside the RKWeb menu framework. RKWeb menu items bring up all of the familiar SirLib screens and functionality. </p>
<p>
For more information, see the [[RKWeb#Configure|Configure section of RKWeb]].
</p>

Release notes for SirPro V7.7

2017-09-07T20:26:24Z

MCosta:

This document lists the changes that have been made for <var class="product">SirPro</var> version 7.7.
<p><var class="product">SirPro</var> 7.7 is designed for use with Model 204 V7.7 and later but is backward compatible to Model 204 V7.6.</p>

<var class="product">SirPro</var> is a member of the <var class="product">[[RKTools]]</var> product family; see also the [[Release notes for RKTools V7.7|release notes for RKTools version 7.7]].

==RKWeb UI for SirPro functionality==
The [[RKWeb]] user interface, new in RKTools 7.7, enables you to perform some SirPro tasks using a mobile-friendly web interface.
<p>
The standard 3270 SirPro interface with all functionality is still available; RKWeb simply offers an alternative, task-based UI.</p>
<p>
You can use the RKWeb interface to:</p>
<ul>
<li>Set user, file, and group passwords</li>
<li>Create group definitions</li>
</ul>
For more information, see the [[RKWeb#Passwords|Passwords]] and [[RKWeb#Groups|Groups]] sections of RKWeb.

RKTools installation

2017-06-14T21:28:23Z

MCosta:

<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 3270 and web-based tools for programmers, database administrators, and system managers. <var class="product">RKTools</var> was formerly known as UL/SPF.

Introduced in RKTools V7.7 (mid-2017), <var class="product">[[RKWeb]]</var> is a web-based version of the <var class="product">Model 204</var> utilities and tools, including most of RKTools. RKWeb is installed as part of RKTools.

Also as of RKTools V7.7, all Rocket-provided, SOUL-based tools are consolidated in the <code>M204PROC</code> file. The components formerly in the <code>SIRIUS</code> procedure file and those formerly associated with the [[SQL catalog#Using the SQL_catalog|SQL interface]] are moved to <code>M204PROC</code>. This means that all Model 204 tools provided by Rocket are in a single file.

The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> procedure 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]]).

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]], etc.), might need to be run in addition to the RKTools installation.

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 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."
<p>
A "Click here" link in the text above the file list on the SOUL files download page brings up [[Downloading and restoring SOUL files]], which provides help about downloading and uploading files, file sizing, and more.</p>
</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 <b>must have</b>:
<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==
<p class="warn"><b>Attention:</b> 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.</p>

<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>For RKWeb.</td></tr>

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

<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">
<p><b>Note:</b> If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does <b>not</b> allow <var>RESTORE</var>. You will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>. A sample command sequence is: </p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>
</p>
</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:

<table class="thJustBold">
<tr><th>File</th> <th>Allocation is required...</th></tr>
<tr><th>M204PROC</th>
<td>Always</td></tr>

<tr><th>SIRLOCAL</th>
<td>Always</td></tr>

<tr><th>M204LOCL</th>
<td>If using RKWeb</td></tr>

<tr><th>MONDATA</th>
<td>Only if installing <var class="product">SirMon</var> and using the web interface. <p class="note:><b>Note:</b> <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer used as of RKTools V7.7. </p>
</td></tr>

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

<tr><th nowrap>SIRLIBD, SIRLIBP</th>
<td>Only if installing <var class="product">SirLib</var></td></tr>

<tr><th>JANCAT</th>
<td>Only if installing JANUS OMNI Access Module</td></tr>

<tr><th>JANSSL</th>
<td>Only if installing JANUS SSL Module</td></tr>
</table> </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.
<p>
Adjust these parameters: </p>
<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.
<p>
Initial problems with <var class="product">RKTools</var> subsystems are usually associated with one or two extremely small default <var>UTABLE</var> settings.
Running the failing subsystem in <code>TEST DEBUG</code> mode will highlight <var>UTABLE</var> parameters that need to be increased. </p>
<p>
These are the recommended settings: </p>
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<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">50</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>.
<p>
A setting of 18000 is recommended for shops that use Mod 6 terminals with very large screen sizes (Rocket regularly tests with 3270 screen sizes of 50x150 characters). </p>
<p class="note"><b>Note:</b>
Either 12000 or 18000 is both a recommended minimum <em>and</em> maximum. Unless you have very large servers at your site (1 megabyte or larger), or you have very large screen objects in your own application code, a very large <var>SCRNSTBL</var> will cause table-size resets to fail.</p></td></tr>
</table></li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE RKTOOLS_INSTALL
</p>

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

The procedure <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, some error messages are not suppressed, which aids in diagnosing any installation problems. For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </li>

<li>Use SUBSYSMGMT to add users to the appropriate [[SCLASS]] classes for any private or semi-public RKTools subsystems.
<p>
The installing user is automatically added to the administration SCLASS in all RKTools subsystems.</p> </li>

<li>Review the next section, "RKTools server sizes," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>
<p class="note">
<b>Note:</b> 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. </p>

===RKTools server sizes===
The minimum <var class="product">RKTools</var> server size requirements are listed below.
The actual server size requirements might vary slightly 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>. 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>

===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:
<p class="code">SIRMON BACKGROUND
</p>
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:
<p class="code">SIRFILE BACKGROUND
</p>
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 <i>not</i> 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:

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

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:

<p class="code" style = "font-size:80%"><b></b>*... Codepage 0037... json requires square brackets to be Unicode 5B & 5D
<b></b>*... translate EBCDIC BA/BB accordingly
UNICODE TABLE STANDARD MAP E=BA IS U=005B
UNICODE TABLE STANDARD MAP E=BB IS U=005D

<b></b>*... TYPE rules for serving up binaries
JANUS WEB <i>portname</i> TYPE ANY * TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTML TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY / TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTM TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.GIF IMAGE/GIF
JANUS WEB <i>portname</i> TYPE ANY *.PNG IMAGE/GIF
JANUS WEB <i>portname</i> TYPE ANY *.CSS TEXT/CSS
JANUS WEB <i>portname</i> TYPE ANY *.JS TEXT/JAVASCRIPT
JANUS WEB <i>portname</i> TYPE ANY *.JPEG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.JPG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.ICO IMAGE/X-ICON

<b></b>*... support for the Ace Editor, part of RKWeb
JANUS WEB <i>portname</i> ON /ACE/* OPEN M204PROC SEND * TEXT
JANUS WEB <i>portname</i> ON /ACE/EDITOR OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/EDITOR.JSON OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST.JSON OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/S.SETTINGS.PNG OPEN M204PROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/S.SIRLIB_SEQ.PNG OPEN M204PROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/*.JS OPEN M204PROC SEND *.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/SRC/SNIPPETS/*.JS OPEN M204PROC SEND /ACE/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/*.JS OPEN M204PROC SEND /ACE/SRC/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/MODE-M204.JS OPEN M204PROC SEND MODE-M204.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/LIB/*.JS OPEN M204PROC SEND *.JS BINARY EXPIRE +999999
<b></b>*... RKWeb rules:
JANUS WEB <i>portname</i> ON /RKWEB/* CMD RKWEB
JANUS WEB <i>portname</i> ON /RKWEB/*.CSS OPEN FILE M204PROC SEND "1.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JS OPEN FILE M204PROC SEND "1.JS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.GIF OPEN FILE M204PROC SEND "1.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.PNG OPEN FILE M204PROC SEND "1.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPG OPEN FILE M204PROC SEND "1.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPEG OPEN FILE M204PROC SEND "1.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.CSS OPEN FILE M204PROC SEND "2.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JS OPEN FILE M204PROC SEND "2.JS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.GIF OPEN FILE M204PROC SEND "2.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.PNG OPEN FILE M204PROC SEND "2.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPG OPEN FILE M204PROC SEND "2.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPEG OPEN FILE M204PROC SEND "2.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/RKWSEND/*.* OPEN FILE M204PROC SEND "2."3 EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWSEND/* OPEN FILE M204PROC SEND * EXPIRE +7200

<b></b>*... Rules supporting the applications implemented as Janus Legacy apps.
JANUS WEB <i>portname</i> DISALLOW /SIRLIB*
JANUS WEB <i>portname</i> DISALLOW /DICTADMIN*
JANUS WEB <i>portname</i> DISALLOW /DICTREPORT*
JANUS WEB <i>portname</i> DISALLOW /DICTDOC*
JANUS WEB <i>portname</i> DISALLOW /XREF*
JANUS WEB <i>portname</i> DISALLOW /FILEMGMT*
JANUS WEB <i>portname</i> DISALLOW /CCACATREPT*
JANUS WEB <i>portname</i> DISALLOW /CCATSF*

JANUS WEB <i>portname</i> ALLOW /SIRLIB* USER *
JANUS WEB <i>portname</i> ALLOW /DICTADMIN* USER *
JANUS WEB <i>portname</i> ALLOW /DICTREPORT* USER *
JANUS WEB <i>portname</i> ALLOW /DICTDOC* USER *
JANUS WEB <i>portname</i> ALLOW /XREF* USER *
JANUS WEB <i>portname</i> ALLOW /FILEMGMT* USER *
JANUS WEB <i>portname</i> ALLOW /CCACATREPT* USER *
JANUS WEB <i>portname</i> ALLOW /CCATSF* USER *

JANUS WEB <i>portname</i> ON /SIRLIB* CMD 'SIRLIB *'
JANUS WEB <i>portname</i> ON /DICTADMIN* CMD 'DICTADMIN *'
JANUS WEB <i>portname</i> ON /DICTREPORT* CMD 'DICTREPORT *'
JANUS WEB <i>portname</i> ON /DICTDOC* CMD 'DOCUMENT *'
JANUS WEB <i>portname</i> ON /XREF* CMD 'XREF *'
JANUS WEB <i>portname</i> ON /FILEMGMT* CMD 'FILEMGMT *'
JANUS WEB <i>portname</i> ON /CCACATREPT* CMD 'CCACATREPT *'
JANUS WEB <i>portname</i> ON /CCATSF* CMD 'CCATSF *'

JANUS WEB <i>portname</i> SCREEN /SIRLIB/* -
EXITURL '/rkweb/' EXITKEY 'Exit SirLib' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTADMIN* -
EXITURL '/rkweb/' EXITKEY 'Exit DictAdmin' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTREPORT* -
EXITURL '/rkweb/' EXITKEY 'Exit DictReport' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTDOC* -
EXITURL '/rkweb/' EXITKEY 'Exit Document' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /XREF* -
EXITURL '/rkweb/' EXITKEY 'Exit Xref' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /FILEMGMT* -
EXITURL '/rkweb/' EXITKEY 'Exit FileMgmt' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /CCACATREPT* -
EXITURL '/rkweb/' EXITKEY 'Exit CCACatRept' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /CCATSF* -
EXITURL '/rkweb/' EXITKEY 'Exit CCATSF' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

START SUBSYSTEM DICTADMIN
START SUBSYSTEM DICTREPORT
START SUBSYSTEM DOCUMENT
START SUBSYSTEM XREF
START SUBSYSTEM FILEMGMT
START SUBSYSTEM CCACATREPT
START SUBSYSTEM CCATSF
</p>

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:

<p class="code"><nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki></p>

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

<p class="code">SIRMETH ALLOW SYSTEMSET SUBSYSTEM RKW* NONPRE
SIRMETH ALLOW SUBSYSTEMSET SUBSYSTEM RKW* NONPRE
SIRMETH ALLOW SYSTEMSET SUBSYSTEM SIR* NONPRE
</p>

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===
RKWeb can be run on any Janus port, and experienced users will most likely add the above Janus rules to ports they already have. New users might need to define an initial <em>unprotected</em> Janus port that they can use to generate a self-signed certificate. That certificate can then be used to protect the port on which RKWeb will be run.

Here are some rules to create a very basic Janus Web port:
<p class="code">
JANUS DEFINE MYWEBPORT 80 WEBSERV 10 IBSIZE 4096 OBSIZE 8192 TRACE 1 RBSIZE 4096 -
UPCASE WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 1000

JANUS WEB MYWEBPORTON / 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
</p>

In the above port definition, "80" is the default port for web connections. Your network administrator might tell you to use a different port number, but once you have that sorted out, you simply point your browser toward http://www.yourdomain.com:xxxx, where xxxx is the port number. The default home page will appear with a link to the JANSSL Certificate management program. You use this to generate a self-signed certificate, and then use that certificate to protect the port from which RKWeb will run.

RKTools installation

2017-06-14T20:18:05Z

MCosta:

<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 3270 and web-based tools for programmers, database administrators, and system managers. <var class="product">RKTools</var> was formerly known as UL/SPF.

Introduced in RKTools V7.7 (mid-2017), <var class="product">[[RKWeb]]</var> is a web-based version of the <var class="product">Model 204</var> utilities and tools, including most of RKTools. RKWeb is installed as part of RKTools.

Also as of RKTools V7.7, all Rocket-provided, SOUL-based tools are consolidated in the <code>M204PROC</code> file. The components formerly in the <code>SIRIUS</code> procedure file and those formerly associated with the [[SQL catalog#Using the SQL_catalog|SQL interface]] are moved to <code>M204PROC</code>. This means that all Model 204 tools provided by Rocket are in a single file.

The RKTools 7.7 installation process modifies the application subsystem definitions to point to the <code>M204PROC</code> procedure 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]]).

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]], etc.), might need to be run in addition to the RKTools installation.

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 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."
<p>
A "Click here" link in the text above the file list on the SOUL files download page brings up [[Downloading and restoring SOUL files]], which provides help about downloading and uploading files, file sizing, and more.</p>
</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 <b>must have</b>:
<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==
<p class="warn"><b>Attention:</b> 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.</p>

<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>For RKWeb.</td></tr>

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

<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">
<p><b>Note:</b> If you are restoring into your existing <code>M204PROC</code> file, note that the <code>M204PROC</code> file has X'0221' privileges, which does <b>not</b> allow <var>RESTORE</var>. You will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>. A sample command sequence is: </p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M204PROC RESTORE 192 FROM <var class="term">dumpfile</var>
</p>
</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:

<table class="thJustBold">
<tr><th>File</th> <th>Allocation is required...</th></tr>
<tr><th>M204PROC</th>
<td>Always</td></tr>

<tr><th>SIRLOCAL</th>
<td>Always</td></tr>

<tr><th>M204LOCL</th>
<td>If using RKWeb</td></tr>

<tr><th>MONDATA</th>
<td>Only if installing <var class="product">SirMon</var> and using the web interface. <p class="note:><b>Note:</b> <code>MONDATA</code> replaces <code>SIRSTATS</code>, which is no longer used as of RKTools V7.7. </p>
</td></tr>

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

<tr><th nowrap>SIRLIBD, SIRLIBP</th>
<td>Only if installing <var class="product">SirLib</var></td></tr>

<tr><th>JANCAT</th>
<td>Only if installing JANUS OMNI Access Module</td></tr>

<tr><th>JANSSL</th>
<td>Only if installing JANUS SSL Module</td></tr>
</table> </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.
<p>
Adjust these parameters: </p>
<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 requires the 18 bit to be on, 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.
<p>
Initial problems with <var class="product">RKTools</var> subsystems are usually associated with one or two extremely small default <var>UTABLE</var> settings.
Running the failing subsystem in <code>TEST DEBUG</code> mode will highlight <var>UTABLE</var> parameters that need to be increased. </p>
<p>
These are the recommended settings: </p>
<table class="thJustBold">
<tr class="head"><th>UTABLE parameter</th>
<th>Value</th>
<th>Description</th></tr>

<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">50</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>.
<p>
A setting of 18000 is recommended for shops that use Mod 6 terminals with very large screen sizes (Rocket regularly tests with 3270 screen sizes of 50x150 characters). </p>
<p class="note"><b>Note:</b>
Either 12000 or 18000 is both a recommended minimum <em>and</em> maximum. Unless you have very large servers at your site (1 megabyte or larger), or you have very large screen objects in your own application code, a very large <var>SCRNSTBL</var> will cause table-size resets to fail.</p></td></tr>
</table></li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE RKTOOLS_INSTALL
</p>

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

The procedure <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, some error messages are not suppressed, which aids in diagnosing any installation problems. For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </li>

<li>Use SUBSYSMGMT to add users to the appropriate [[SCLASS]] classes for any private or semi-public RKTools subsystems.
<p>
The installing user is automatically added to the administration SCLASS in all RKTools subsystems.</p> </li>

<li>Review the next section, "RKTools server sizes," for specific requirements of individual subsystem components of <var class="product">RKTools</var>.</li>
</ol>
<p class="note">
<b>Note:</b> 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. </p>

===RKTools server sizes===
The minimum <var class="product">RKTools</var> server size requirements are listed below.
The actual server size requirements might vary slightly 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>. 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>

===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:
<p class="code">SIRMON BACKGROUND
</p>
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:
<p class="code">SIRFILE BACKGROUND
</p>
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 <i>not</i> 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:

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

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:

<p class="code" style = "font-size:80%"><b></b>*... Codepage 0037... json requires square brackets to be Unicode 5B & 5D
<b></b>*... translate EBCDIC BA/BB accordingly
UNICODE TABLE STANDARD MAP E=BA IS U=005B
UNICODE TABLE STANDARD MAP E=BB IS U=005D

<b></b>*... TYPE rules for serving up binaries
JANUS WEB <i>portname</i> TYPE ANY * TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTML TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY / TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.HTM TEXT/HTML
JANUS WEB <i>portname</i> TYPE ANY *.GIF IMAGE/GIF
JANUS WEB <i>portname</i> TYPE ANY *.PNG IMAGE/GIF
JANUS WEB <i>portname</i> TYPE ANY *.CSS TEXT/CSS
JANUS WEB <i>portname</i> TYPE ANY *.JS TEXT/JAVASCRIPT
JANUS WEB <i>portname</i> TYPE ANY *.JPEG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.JPG IMAGE/JPEG
JANUS WEB <i>portname</i> TYPE ANY *.ICO IMAGE/X-ICON

<b></b>*... support for the Ace Editor, part of RKWeb
JANUS WEB <i>portname</i> ON /ACE/* OPEN M204PROC SEND * TEXT
JANUS WEB <i>portname</i> ON /ACE/EDITOR OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/EDITOR.JSON OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/PROCLIST.JSON OPEN M204PROC CMD 'RKWEB'
JANUS WEB <i>portname</i> ON /ACE/S.SETTINGS.PNG OPEN M204PROC SEND S.SETTINGS.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/S.SIRLIB_SEQ.PNG OPEN M204PROC SEND S.SIRLIB_SEQ.PNG BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/*.JS OPEN M204PROC SEND *.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/SRC/SNIPPETS/*.JS OPEN M204PROC SEND /ACE/SRC/SNIPPETS/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/*.JS OPEN M204PROC SEND /ACE/SRC/*.JS BINARY EXPIRE +999999
JANUS WEB <i>portname</i> ON /ACE/SRC/MODE-M204.JS OPEN M204PROC SEND MODE-M204.JS TEXT
JANUS WEB <i>portname</i> ON /ACE/LIB/*.JS OPEN M204PROC SEND *.JS BINARY EXPIRE +999999
<b></b>*... RKWeb rules:
JANUS WEB <i>portname</i> ON /RKWEB/* CMD RKWEB
JANUS WEB <i>portname</i> ON /RKWEB/*.CSS OPEN FILE M204PROC SEND "1.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JS OPEN FILE M204PROC SEND "1.JS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.GIF OPEN FILE M204PROC SEND "1.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.PNG OPEN FILE M204PROC SEND "1.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPG OPEN FILE M204PROC SEND "1.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*.JPEG OPEN FILE M204PROC SEND "1.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.CSS OPEN FILE M204PROC SEND "2.CSS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JS OPEN FILE M204PROC SEND "2.JS TEXT EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.GIF OPEN FILE M204PROC SEND "2.GIF EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.PNG OPEN FILE M204PROC SEND "2.PNG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPG OPEN FILE M204PROC SEND "2.JPG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/*.JPEG OPEN FILE M204PROC SEND "2.JPEG EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWEB/*/RKWSEND/*.* OPEN FILE M204PROC SEND "2."3 EXPIRE +7200
JANUS WEB <i>portname</i> ON /RKWSEND/* OPEN FILE M204PROC SEND * EXPIRE +7200

<b></b>*... Rules supporting the applications implemented as Janus Legacy apps.
JANUS WEB <i>portname</i> DISALLOW /SIRLIB*
JANUS WEB <i>portname</i> DISALLOW /DICTADMIN*
JANUS WEB <i>portname</i> DISALLOW /DICTREPORT*
JANUS WEB <i>portname</i> DISALLOW /DICTDOC*
JANUS WEB <i>portname</i> DISALLOW /XREF*
JANUS WEB <i>portname</i> DISALLOW /FILEMGMT*
JANUS WEB <i>portname</i> DISALLOW /CCACATREPT*
JANUS WEB <i>portname</i> DISALLOW /CCATSF*

JANUS WEB <i>portname</i> ALLOW /SIRLIB* USER *
JANUS WEB <i>portname</i> ALLOW /DICTADMIN* USER *
JANUS WEB <i>portname</i> ALLOW /DICTREPORT* USER *
JANUS WEB <i>portname</i> ALLOW /DICTDOC* USER *
JANUS WEB <i>portname</i> ALLOW /XREF* USER *
JANUS WEB <i>portname</i> ALLOW /FILEMGMT* USER *
JANUS WEB <i>portname</i> ALLOW /CCACATREPT* USER *
JANUS WEB <i>portname</i> ALLOW /CCATSF* USER *

JANUS WEB <i>portname</i> ON /SIRLIB* CMD 'SIRLIB *'
JANUS WEB <i>portname</i> ON /DICTADMIN* CMD 'DICTADMIN *'
JANUS WEB <i>portname</i> ON /DICTREPORT* CMD 'DICTREPORT *'
JANUS WEB <i>portname</i> ON /DICTDOC* CMD 'DOCUMENT *'
JANUS WEB <i>portname</i> ON /XREF* CMD 'XREF *'
JANUS WEB <i>portname</i> ON /FILEMGMT* CMD 'FILEMGMT *'
JANUS WEB <i>portname</i> ON /CCACATREPT* CMD 'CCACATREPT *'
JANUS WEB <i>portname</i> ON /CCATSF* CMD 'CCATSF *'

JANUS WEB <i>portname</i> SCREEN /SIRLIB/* -
EXITURL '/rkweb/' EXITKEY 'Exit SirLib' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTADMIN* -
EXITURL '/rkweb/' EXITKEY 'Exit DictAdmin' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTREPORT* -
EXITURL '/rkweb/' EXITKEY 'Exit DictReport' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /DICTDOC* -
EXITURL '/rkweb/' EXITKEY 'Exit Document' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /XREF* -
EXITURL '/rkweb/' EXITKEY 'Exit Xref' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /FILEMGMT* -
EXITURL '/rkweb/' EXITKEY 'Exit FileMgmt' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /CCACATREPT* -
EXITURL '/rkweb/' EXITKEY 'Exit CCACatRept' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

JANUS WEB <i>portname</i> SCREEN /CCATSF* -
EXITURL '/rkweb/' EXITKEY 'Exit CCATSF' AUTOPF ON CSS /styles/cool.css -
BGCOLOR 'white' TEXT 'black' -
BLUE '#000066' GREEN '#006600' PINK '#ff80ff' RED '#ff0000' TURQUOISE '#0033ff' WHITE '#0000ff' YELLOW '#ffff00'

START SUBSYSTEM DICTADMIN
START SUBSYSTEM DICTREPORT
START SUBSYSTEM DOCUMENT
START SUBSYSTEM XREF
START SUBSYSTEM FILEMGMT
START SUBSYSTEM CCACATREPT
START SUBSYSTEM CCATSF
</p>

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:

<p class="code"><nowiki>https://www.mydomain.com/rkweb/welcome.html
</nowiki></p>

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

<p class="code">SIRMETH ALLOW SYSTEMSET SUBSYSTEM RKW* NONPRE
SIRMETH ALLOW SUBSYSTEMSET SUBSYSTEM RKW* NONPRE
SIRMETH ALLOW SYSTEMSET SUBSYSTEM SIR* NONPRE
</p>

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===
RKWeb can be run on any Janus port, and experienced users will most likely add the above Janus rules to ports they already have. New users might need to define an initial <em>unprotected</em> Janus port that they can use to generate a self-signed certificate. That certificate can then be used to protect the port on which RKWeb will be run.

Here are some rules to create a very basic Janus Web port:
<p class="code">
JANUS DEFINE MYWEBPORT 80 WEBSERV 10 IBSIZE 4096 OBSIZE 8192 TRACE 1 RBSIZE 4096 -
UPCASE WEBUSER WEBUSER WEBACCT WEBUSER MAXTEMP 1000

JANUS WEB MYWEBPORTON / 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
</p>

In the above port definition, "80" is the default port for web connections. Your network administrator might tell you to use a different port number, but once you have that sorted out, you simply point your browser toward http://www.yourdomain.com:xxxx, where xxxx is the port number. The default home page will appear with a link to the JANSSL Certificate management program. You use this to generate a self-signed certificate, and then use that certificate to protect the port from which RKWeb will run.

Template:Model 204 installation components

2017-04-19T19:57:02Z

MCosta: /* Macro library (RKMACLIB) */

<div id="RKOBJLIB"></div>
====Object library (RKOBJLIB)====

The object library is used to link the ONLINE and various other Model 204 load modules.

See the [https://m204.rocketsoftware.com/maint/objlist object files download page].
<div id="jobstreams"></div>
=====JCL job streams=====

In addition to the object files, the object library contains a number of z/OS JCL job streams. You will copy each job stream that you need to a local TSO library, modify it according to your system, and submit the job to perform the installation steps.

The job streams in RKOBJLIB all have member names ending in the letter "J."

<div id="RKMACLIB"></div>

====Macro library (RKMACLIB)====

The macro library is used if your installation requires assembling of any ASSEMBLE files.

RKMACLIB contains:
<ul>
<li>Model 204 macros</li>
<li>Sample files for: FUNU, MSGU, RACFPARM, ACF2PARM, TOPSPARM, TSFS, ZFIELD proc</li>
</ul>

See the [https://m204.rocketsoftware.com/maint/maclist macro libraries download page].

Model 204 installation on IBM z/OS

2017-04-19T19:53:21Z

MCosta: /* Install the TSO interface */

<div class="toclimit-3">__TOC__</div>
==Overview==
This topic describes the steps required to upgrade to Rocket Model 204 version 7.5 or later on the IBM<sup>®</sup> z/OS<sup>®</sup> operating system.

The new version number is referred to as <var class="term">x</var>.<var class="term">y</var>, where <var class="term">x</var>.<var class="term">y</var> can be 7.5 or later.

For information on the new features available in each version, as well as any compatibility issues, see the [[Release_notes#Release_notes.2C_wishlists.2C_and_punch_lists|Model 204 release notes]].

If you are skipping any versions when upgrading (such as upgrading from 7.5 to 7.7), be sure to read the [[Release notes|release notes]] for those versions as well (such as 7.6).

==Before you begin==
<ul>
<li>You must have either a [[Rocket M204 user ID]] or a preexisting user ID to download the installation files.</li>

<li>The object library has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the Rocket website. <br />(The preapplied zap will authorize Model 204 itself and any separately purchased products, such as [[SirScan]].)</li>

<li>The object library also has the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to run [[RockZap]] to apply any new maintenance when it becomes available for this release.)</li>

<li>These upgrade instructions anticipate a default non-SVC installation of Model 204 into an APF-authorized load library and running as [[Performance monitoring and tuning#z/OS|non-swappable]].
<p>
If you are installing CRAM, it is also a non-SVC installation, the CRAM load library also needs APF authorization, and the address space should be non-swappable. </p></li>

<li>To use Model 204 SNA Communications Server terminal support, you must define Model 204 as an SNA Communications Server application program. For more information, see [[Defining the user environment (CCAIN)#SNA Communications Server network definition requirements|SNA Communications Server network definition requirements]].
<p>
If you are using SNA Communications Server for [[Horizon]] or [[PQO]], you
must define any Horizon or PQO links individually to SNA Communications
Server. See [[Horizon network management#Defining the network to SNA Communications Server|Defining the network to SNA Communications Server]] or [[PQO: Defining a PQO network#SNA Communications Server network definition|SNA Communications Server network definition]].</p></li>
</ul>

==<b id="steps"></b>Overview of upgrading steps==
Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version <var class="term">x</var>.<var class="term">y</var> files.
<p>Each step links to a section with detailed instructions. Note that some steps (such as assembling custom modules) might not apply to your installation. Once you have started, you can proceed directly through the steps (detail sections are consecutive) or return to this list for context.</p>
For a 7.5 example, see [[#Example workflow for 7.5: download through installation|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#Build the Model 204 object and macro libraries|Build]] the Model 204 object and macro libraries:
<ol style="list-style-type:lower-alpha;">
<li>Use your [[Rocket M204 user ID]] to [[#downloading|download]] the Model 204 object library and the Model 204 macro library.</li>

<li>[[#uploading|Upload]] the downloaded components to the z/OS system on the IBM mainframe.</li>

<li>[[#bldLibs|Build]] the RKOBJLIB object library and RKMACLIB macro library. (Once you have built these libraries, do not modify them.)</li>
</ol>
</li>

<li>Submit the job to [[#allocating|allocate the other data sets]] required for installation.</li>

<li>Modify and assemble these modules if you use them:
<ol style="list-style-type:lower-alpha;">
<li>Your [[#Assemble FUNU and optional MSGU|user $functions (FUNU)]] and, optionally, MSGU.
<li>An external authorizer (such as RACF) for Model 204. [[#secparm|Set up the security module]], including assembling the <i>xxxx</i>PARM security module (such as RACFPARM). The object file is then stored in your local object library.</li>
<li>[[#ul_db2|UL/DB2 interface]]: preprocess and assemble the USQL module.</li>
<li>Other customized modules, such as [[Customizing functions and translation tables#Encoding/Decoding facility|CDTB]]. Modify them as needed and [[#asm|assemble]] them.
</ol></li>

<li>Link the [[#lkonln|ONLINE]] load module.</li>

<li>If you use the [[#link_ifam1|IFAM1 and IFAM4]] load modules, link them.</li>

<li>Link the <var class="product">Model 204</var> [[#lkutils|utility load modules]].</li>

<li>If you use the [[#cics|CICS interface]], customize it, and then assemble and link the CICS modules.</li>

<li>If you use the [[#tso|TSO]] interface, assemble and link-edit the TSO source modules.</li>

<li>Link the [[#CRAM|CRAM]] load modules as needed.</li>

<li>If you use [[#softspy|SoftSpy]], upgrade it for <var class="term">x</var>.<var class="term">y</var>.</li>

<li>[[#verify|Verify]] the installation.</li>
</ol>

==Build the Model 204 object and macro libraries==
To build the object and macro libraries, you must download the object library and macro library; upload each library to the mainframe; and copy, modify, and run the NEW204LB job.

===Object and macro libraries===
{{Template:Model 204 installation components}}

===<b id="downloading"></b>Downloading===
<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://m204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download.</li>
<li>Go to the [https://m204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download.</li>
</ol>

===<b id="uploading"></b>Uploading===
Once the object file and macro library are downloaded to your workstation, upload them to the z/OS system on the IBM mainframe. You can use any file transfer mechanism, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for object and macro libraries</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for object and macro libraries</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

For details on how to download and upload, see [[Downloading and uploading Model 204 installation components]].

===<b id="bldLibs"></b>Building the object and macro libraries (NEW204LB job stream)===

After you upload the object and macro library input streams to the mainframe, build the object and macro libraries:

<ol>
<li>Access the [https://m204.rocketsoftware.com/download/new204lb.txt NEW204LB job stream] text file.</li>

<li>Copy the job stream file into a local TSO library for editing.</li>

<li>On the first line of the job stream, modify the JOB card according to your local job card parameters.</li>

<li>Edit the lines in the job stream that are marked with numbers followed by <<. The numbers correspond to the numbered steps at the end of the comment section.</li>
</li>
<li>Submit the <code>NEW204LB</code> job to build the object library ("RKOBJLIB") and macro library ("RKMACLIB") on your z/OS system.</li>
</ol>

<div id="notouch"></div>
<p class="warn"><b>Attention:</b> Once you have built RKOBJLIB and RKMACLIB on your z/OS system, <b>do not</b> modify them in any way.<br />

For example, <b>do not</b> store other members into the object library; it should only contain the members as supplied in a download from the web site. Place object files that you might assemble (such as FUNU or RACFPARM) into your local object library.</p>

====RKOBJLIB README file====
README, a member of RKOBJLIB, contains details on the object files and installation steps. Once you have built RKOBJLIB, you can use README as an installation checklist if desired.

==<b id="allocating"></b>Allocate the data sets for Model 204 upgrading==
Three basic data sets are used for the upgrade to Model 204 7.<var class="term">x</var>:

<ul>
<li>data set for the Model 204 load modules
<li>data set for the local source library
<li>data set for the local object library
</ul>
The data set for the load modules will contain, after linking, the modules for the Model 204 product, including: ONLINE, IFAM1, and IFAM4.

The local source library is used to store the customized source for modules such as FUNU, MSGU, and ACF2PARM, RACFPARM, or TOPSPARM. As described below, JALINSJ allocates the source library if it does not already exist.

When the source is assembled, it is stored in the local object library.

One of the members of the RKOBJLIB object library is named [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], which is a job stream to allocate data sets for the installation. <code>JALINSJ</code> contains information about naming conventions for the data sets.

===Allocating data sets (JALINSJ job stream)===
<ol>
<li>Copy <code>JALINSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JALINSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul>
</li>
<li id=submitJALINSJ>Submit the <code>JALINSJ</code> job to allocate the basic installation datasets:

<ul>
<li>hlq.M204V77.LOADLIB - the library for linking most load modules</li>
<li>hlq.M204V77.LOCAL.OBJLIB - the library for assembling optional object files: RACFPARM, FUNU, etc.</li>
<li>hlq.M204.LOCAL.SRCLIB - the library in which you store source for assembling modules such as FUNU and xxxPARM. Note that this DSN does <var class="term">not</var> have a version identifier (such as V75, V76, and so on). This library is only allocated if it does not already exist. It is used for installing all versions of Model 204.</li>
</ul>
<p class="note"><b>Note:</b> hlq.M204V77.LOADLIB and hlq.M204V77.LOCAL.OBJLIB are deleted and then allocated whenever you submit <code>JALINSJ</code>. If your local source lib (hlq.M204.LOCAL.SRCLIB) exists, it is retained. </p>
</li>
</ol>

==<b id="FUNU"></b>Assemble FUNU and optional MSGU==
This section lists installation considerations if you have your own user-written $functions module (FUNU).

<p class="note"><b>Note:</b> If you have your own FUNU or MSGU module, you must assemble it <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.</p>

Assemble your FUNU and/or optional MSGU modules with the following steps:
<ol>
<li>Modify FUNU for 64-bit addressing considerations and store the modified source in the [[#submitJALINSJ|local source library you allocated]].
<div id="FUNU_7.5"></div>
<p>FUNU changes for 7.x are:</p>
{{Template:FUNU changes for 7.5}}
</li>
<li>If you have any user-defined messages (MSGU), store them in your local source library.</li>

<li>Assemble FUNU (and MSGU, if applicable), with the output object file stored in your local object library.
<ol style="list-style-type:lower-alpha;">

<li>Run <code>JASMJ</code> to [[#asm|assemble]] FUNU into your local object library.</li>

<li>If applicable, run <code>JASMJ</code> to assemble MSGU.</li>

<p class="note"><b>Note:</b> You do <b>not</b> need to insert any INCLUDE statements for either FUNU nor MSGU; they are already present in the INCLUDE member (LKSQLONL or LKNOSONL) provided in the downloaded object library.</p></li>
</ol>
</li>
</ol>

==<b id="secparm"></b>Set up the security module==
This section describes how to install a [[Security interfaces overview|security interface]] such as CA-ACF2, RACF, or CA-Top Secret.

<ol>
<li>Review the Model 204 installation section for your interface and complete all of the steps:
<ul>
<li>[[CA-ACF2_MVS_interface#Installing_the_Model_204_CA-ACF2_MVS_Interface|CA-ACF2 (MVS)]]</li>
<li>[[CA-ACF2_VM_interface#Installing_the_CA-ACF2_VM_Interface|CA-ACF2 (VM)]]</li>
<li>[[Security_Server_(formerly_RACF)_interface#Installing_the_Security_Server_Interface|RACF]]</li>
<li>[[CA-Top_Secret_interface#Installing_the_CA-Top_Secret_Interface|CA-Top Secret]]</li>
</ul>
</li>
<li> [[#asm|Assemble]] the security module:
ACF2PARM, RACFPARM, or TOPSPARM.</li>
<li>Optional. Link the security module as described below if you want it to be dynamically loaded.</li>
</ol>

===Linking the security module (LKSECRJ job stream)===

Dynamic loading lets you modify the security parameters without having to relink Model 204, which would be required if the parameter module were linked into Model 204 directly.

If you want Model 204 to dynamically load your security module during Model 204 ACF2, RACF, or TOPSECRET interface initialization, then you must link the corresponding security parameter module.

One of the members of the RKOBJLIB object library is <code>LKSECRJ</code>, a job stream to link-edit the security parameter module.

<ol>
<li>Copy [[Model 204 security module link job stream for IBM z/OS|LKSECRJ]] into a local TSO library.
<li>Edit your copy of <code>LKSECRJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
<li>In the Security interfaces section, uncomment the appropriate two lines for your interface.
</ul>
<li>Submit the <code>LKSECRJ</code> job to link-edit the security parameter module (ACF2PARM, RACFPARM, or TOPSPARM).
</ol>

==<b id="ul_db2"></b>Install the UL/DB2 interface (JAUSQLJ job stream)==
To support the [[UL/DB2]] interface, USQL code is delivered in source for you to preprocess for your version of DB2. If you use the UL/DB2 interface, assemble the source as described below <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.

<ol>
<li>Copy [[Model 204 UL/DB2 job stream for IBM z/OS|JAUSQLJ]] into a local TSO library.
<li>Edit your copy of <code>JAUSQLJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul>
<li>Submit the <code>JAUSQLJ</code> job to preprocess and assemble the USQL module. The JAUSQLJ job executes the following two steps:
<ul>
<li>Run USQL (contained in RKMACLIB) through the DB2 preprocessor to process the EXEC SQL statements. This step produces two data sets: the DBRM and the expanded USQL source. The DBRM is saved as USQLDBRM in the local object library. The expanded USQL source is passed to step two for assembly.</li>
<li>Assemble expanded USQL source into local object library.</li>
</ul>
<li>Bind the DBRM as the plan with a site-specific plan name.</li>
</ol>

==<b id="asm"></b>Assemble customized modules into your local object library (LOCAL.OBJLIB)==
Copy the customized source module (such as, FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2) from your current release into your local source library, if you have not already done so.
The local source library is not version-specific, so modules copied into it can be used for future installations.

One of the members of the RKOBJLIB object library is [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], a job stream to assemble a member from your Model 204 local source library into your local object library (LOCAL.OBJLIB).

===Assembling customized modules (JASMJ job stream)===
<ol>
<li>Copy <code>JASMJ</code> into a local TSO library.
<li>Edit your copy of <code>JASMJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul>
<li>Submit the <code>JASMJ</code> job to assemble the module into your local object library.
</ol>

==<b id="lkonln"></b>Link the Model 204 ONLINE load module==
<div id="onlnTable"></div>
<blockquote class="note">
<p><b>Notes:</b> </p>
<ul>
<li>If you use customized modules (such as FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2), you must [[#FUNU_7.5|modify]] them (if needed) and [[#asm|assemble]] them <b>before you link the ONLINE/IFAM1/IFAM4</b> load modules.</li>

<li>There is not a separate link step for BATCH204. It is not maintained as a separate module; the same module as ONLINE is used, with a BATCH204 alias.</li>

<li>The INCLUDE TCPLIB(SNMPGSYS) statement for Horizon TCP/IP in the Online-link-edit job is no longer required and has been eliminated.</li>

<li>A number of INLUDE LELIB(CEE*) statements have also been eliminated from the Online-link-edit job. These were required to support several mathematical $functions but those $functions have been rewritten in Assembly language and are now automatically part of the Online load module.</li>

<li>The INCLUDE BLOCKPRT(IEFSD095) statement is required if block printing on separator pages is desired. Usually the BLOCKPRT DD points to DSN=SYS1.AOSB0.</li>

<li>As of Model 204 version 7.7, FastUnload is linked as an alias of the ONLINE load module, not as a standalone module. The FastUnload code is fully integrated into the Model 204 nucleus.</li>

<li id="xsvc">The Online, IFAM1, and IFAM4 load
modules INCLUDE object module M204XSVC, which executes cross-memory code inline rather than as an SVC. </li>
</ul>
</blockquote>

One of the members of the RKOBJLIB object library is [[Model 204 ONLINE link job stream for z/OS|LKONLNJ]], which is a job stream to link the <var class="product">Model 204</var> ONLINE load module.

===<b id="LKONLNJ"></b>Linking ONLINE (LKONLNJ job stream)===
<ol>
<li>Copy the <code>LKONLNJ</code> job stream from RKOBJLIB into a local TSO library. </li>

<li>Edit your copy of <code>LKONLNJ</code> for your configuration. Specific editing instructions are provided within the <code>LKONLNJ</code> file. In summary:
<ul>
<li>Replace the first line with a JOB card. </li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section. </li>
<li>As needed, edit the lines after <code>SYSLIN DD *</code> that are marked with <code><<</code>. See the comments at the top of the <code>SYSLIN</code> sections (<b>A</b>-<b>D</b>) for instructions. </li>
</ul></li>

<li>Submit the <code>LKONLNJ</code> job to link the ONLINE load module. </li>
</ol>

<div id="link_ifam1"></div>
<div id="link_ifam4"></div>

==Link the Model 204 IFAM1 and IFAM4 load modules==


Among the members of the RKOBJLIB object library are:
<ul>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM1_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM1_link_job_stream_for_IBM_z/OS&target=blank LKIFAM1J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM1 load module</li>

<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM4_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM4_link_job_stream_for_IBM_z/OS&target=blank LKIFAM4J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM4 load module.</li>
</ul>

===Linking IFAM1 (LKIFAM1J job stream)===
<ol>
<li>Copy the <code>LKIFAM1J</code> job stream from RKOBJLIB into a local TSO library. </li>

<li>Edit your copy of <code>LKIFAM1J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card. </li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section. </li>
<li>In the Security interfaces section, uncomment the appropriate two lines for your interface, if applicable. </li>
</ul></li>

<li>Submit the <code>LKIFAM1J</code> job to link the IFAM1 load module. </li>
</ol>

===Linking IFAM4 (LKIFAM4J job stream)===
<ol>
<li>Copy the <code>LKIFAM4J</code> job stream from RKOBJLIB into a local TSO library. </li>

<li>Edit your copy of <code>LKIFAM4J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card. </li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section. </li>
<li>In the Security interfaces section, uncomment the appropriate two lines for your interface, if applicable. </li>
</ul></li>

<li>Submit the <code>LKIFAM4J</code> job to link the IFAM4 load module. </li>
</ol>

==<b id="lkutils"></b>Link the Model 204 utility load modules==
Following are the utility load modules to be linked:
<table>
<tr class="head">
<th>Module</th><th>Description</th>
</tr>

<tr><td><b>AUDIT204</b></td>
<td> Generate an audit trail from the CCAJRNL or CCAJLOG data sets, with report stats and analysis</td></tr>

<tr><td><b>BATCH2</b></td>
<td>Enable batch users to access a Model 204 Online that is running in a separate region</td></tr>

<tr><td><b>HASH15</b></td>
<td>Sort exit for hash file index</td></tr>

<tr><td><b>HASH35</b></td>
<td>Sort exit for hash file index</td></tr>

<tr><td><b>M204LIST</b></td>
<td>A module to support the XREF cross-reference reporting subsystem.</td></tr>

<tr><td><b>M204XREF</b></td>
<td>Another module to support the XREF cross-reference reporting subsystem.</td></tr>

<tr><td><b>MERGEJ</b></td>
<td>Media recovery journal merge utility</td></tr>

<tr><td><b>OI15OS</b></td>
<td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>

<tr><td><b>OI35OS</b></td>
<td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>

<tr><td><b>UTILC</b></td>
<td>Information from checkpoint stream</td></tr>

<tr><td><b>UTILJ</b></td>
<td>Journal/Audit trail debug utility</td></tr>

<tr><td><b>ZBLDTAB</b></td>
<td>Build prototype password table</td></tr>

<tr><td><b>ZCTLTAB</b></td>
<td>Convert CCASTAT for the Password Expiration feature</td></tr>
</table>

===Linking the utility load modules (LKALLUTJ job stream)===
One of the members of the RKOBJLIB object library is [[Model 204 utilities link job stream for IBM z/OS|LKALLUTJ]], a job stream to link the <var class="product">Model 204</var> utility load modules.
<ol>
<li>Copy <code>LKALLUTJ</code> into a local TSO library. </li>

<li>Edit your copy of <code>LKALLUTJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card. </li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section. </li>
</ul></li>

<li>Submit the <code>LKALLUTJ</code> job to link the utility load modules. </li>
</ol>

==<b id="cics"></b>Install the CICS interface==
The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.

For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface configuration]].

<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 4.1, 4.2, and 5.3.</p></li>

<li>Supporting [[Program Communication facilities#TPROCESS .28terminal process.29 communication|TPROCESS]] COBOL applications
<p>
If your CICS TPROCESS application was originally linked with <code>AMODE=24</code>, you must relink the CICS TPROCESS application specifying <code>AMODE=31</code>, because <code>AMODE=24</code> is not supported.</p></li>
</ul>

===Installation steps===
<ol>
<li>[[#Customizing the CICS interface|Customize the interface]] by editing the CICFG copy member. </li>

<li>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]] using one of the following methods:
<ul>
<li>Resource Definition Online (CEDA). The supplied member CEDAM204 in RKMACLIB provides an example of the required PCT, PPT, and PLT definitions.</li>

<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
</ul></li>

<li>[[#CICS_alloc|Allocate]] a CICS user library.</li>

<li>[[#CICS_asm|Assemble and link]] the CICS modules.</li>
</ol>

====Customizing the CICS interface====
To customize the CICS interface, copy the CICFG copy member from RKMACLIB into your local source library and edit it as needed.
<p>
For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface configuration#Use the CICS Standard Mapping Service|Use the CICS Standard Mapping Service]].</p>

====Updating the CICS System Definition (CSD)====
You can update the CSD by using either CEDA or the DFHCSDUP utility and the CEDAM204 member of RKMACLIB. Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<table>
<caption>CICS System Definition values</caption>
<tr class="head">
<th>User program</th>
<th>Program name</th> <th>Transaction ID</th>
<th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td>
<td>DFHPSF</td>
<td>DFHPSF is accessed by using a CICS LINK. It is never
invoked with a transaction ID from a terminal.</td>
<td /> <td /><tr>

<tr><td>Full-screen interface</td>
<td>M204PSFS</td>
<td>M204</td>
<td>&TRN</td>
<td>88</td></tr>

<tr><td>Screen copy transaction</td>
<td>M204CRPS</td>
<td>U204</td>
<td /> <td /></tr>

<tr><td>Screen print transaction</td>
<td>M204PRNT</td>
<td>P204</td>
<td>&COP</td>
<td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using the CEDAM204 member, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
RSL(PUBLIC)
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
RSL(PUBLIC)
.
.
.

CEDA CHeck GRoup(group_name) </p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

====<b id="CICS_alloc"></b>Allocating a CICS user library (JALCICSJ job stream)====
One of the members of the RKOBJLIB object library is [[Model 204 CICS user library allocation job stream for IBM z/OS|JALCICSJ]], a job stream to allocate an empty CICS user library. You must allocate the CICS user library before assembling and linking the CICS modules.
<ol>
<li>Copy <code>JALCICSJ</code> into a local TSO library.</li>

<li>Edit your copy of <code>JACICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.</li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul></li>

<li>Submit the <code>JALCICSJ</code> job to allocate the CICS user library.</li>
</ol>

====<b id="CICS_asm"></b>Assembling and linking CICS modules (LKCICSJ job stream)====
One of the members of the RKOBJLIB object library is [[Model 204 CICS module assembly job stream for IBM z/OS|LKCICSJ]], a job stream to assemble and link the <var class="product">Model 204</var> CICS modules.
<ol>
<li>Copy <code>LKCICSJ</code> into a local TSO library. </li>
<li>Edit your copy of <code>LKCICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul></li>

<li>Submit the <code>LKCICSJ</code> job to assemble and link the CICS module. </li>
</ol>

==<b id="tso"></b>Install the TSO interface==
<p class="note"><b>Note:</b> It is not necessary to install the TSO interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

The Model 204 TSO Interface enables the TSO user to communicate with a Model 204 Online.

The TSO Interface consists of two load modules, M204FS and M204TTY. The modules are completely reentrant, reusable, and refreshable.

Installation requires link-editing of the TSO source modules using the [[Model 204 TSO module assembly job stream for IBM z/OS|LKTSOJ]] job stream from the RKOBJLIB library. Customers should not need to, but it is possible to modify M204FS prior to linking, as shown here:

<table>
<tr><td>
<ol>
<li>If you are using TSO extensions, copy the TSFS source from RKMACLIB to the [[#submitJALINSJ|local source library you allocated]] and continue with the following steps.</li>
<li>Modify TSFS in the local source library by changing:
<p class="code">&TSOV SETC 'TSO' </p>
<p>to:</p>
<p class="code">&TSOV SETC 'TSOE'</p></li>
<p>
Changing the <code>&TSOV SETC 'TSO'</code> code in TSFS causes assembly of the NOEDIT form of the TPUT macro in the TSFS module. The NOEDIT form, required for 3270 extended data streams, allows proper handling of colors or highlighting in TSO extensions. NOEDIT is recommended for all TSO extensions.</p></li>

<li>Run <code>JASMJ</code> to [[#asm|assemble]] TSFS into your local object library.</li>
</ol>
</td></tr></table>

===Linking the TSO modules===
<ol>
<li>Edit your copy of <code>LKTSOJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card. </li>
<li>Edit the lines in the job stream that are marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section. </li>
</ul></li>

<li>Submit the <code>LKTSOJ</code> job to assemble and link the TSO modules. </li>
</ol>

==<b id="lkcram"></b>CRAM==
<blockquote class="note"><b>Notes:</b> CRAM SVC installation is deprecated in version 7.5 and later. The following instructions are for [[Defining the user environment (CCAIN)#Two CRAM options|CRAM-XDM]].
<p>
This CRAM-XDM installation creates a separate CRAM load library (CRAMLIB). Since CRAM-XDM remains upwardly compatible (for [[Model 204 support lifecycle|supported Model 204 releases]]), a single CRAMLIB can be used by multiple versions of Model 204. It is not a necessity to immediately install the version of CRAM-XDM that corresponds to the version of Model 204 you are installing. That is, you may want to install and test your new version of Model 204 before you install and test your new version of CRAM.</p>
<p>
Since CRAM modules reside in a separate load library, an Online that requires a CRAM connection (<var>IODEV</var> 11, 23, or 29) must be brought up with CRAMLIB as a concatenated STEPLIB (or such that the Online is able to load the CRAM IGCLM244 module). </p>
<p>
The XDM load module, M204XDM, must run from an APF-authorized load library, because it must run non-swappable and non-cancellable.
</p></blockquote>

To install the CRAM load modules, proceed with the following steps:

<ol>
<li>Before linking the CRAM load modules, familiarize yourself with [[Defining the user environment (CCAIN)#CRAM (IODEV=11, 23, 29)|CRAM]]: what it does, which facilities require it, and available CRAM options.

<li>Install 7.<var class="term">x</var> CRAM-XDM by running [[Model 204 CRAM link job stream for IBM z/OS|LKCRAMJ]], the job stream to link the CRAM load modules. LKCRAMJ is found in RKOBJLIB.
<p>
CICS interface users: Unlike version 7.4 CRAM-XDM, the step in the link JCL for the CRAM modules specifies the <code>RENT</code> value for <code>PARM</code>. Read the Note in [[CICS interface configuration#Running with storage protection on|Running with storage protection on]] for details.</p></li>
</ol>

<p class="note"><b>Note:</b> After installation, you will need to perform additional tasks to [[Defining the user environment (CCAIN)#Activating CRAM-XDM|implement CRAM-XDM]].</p>

==<b id="softspy"></b>Upgrade SoftSpy==
To upgrade SoftSpy for version 7.<var class="term">x</var>, download, upload, and restore the SoftSpy procedure file, SPYPROC, which is distributed in a dump format.

<ol>
<li>Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>
For detailed instructions, see [[Downloading and restoring SOUL files#How can the dump file be uploaded to the mainframe?|Downloading and restoring SOUL files]].

For details on the SoftSpy installation, including customization and System Manager considerations, see the [[SoftSpy installation guide]].

==RSQL maintenance==
RKOBJLIB also contains the LKMAINTJ job stream. LKMAINTJ is used to relink the ONLINE, IFAM1, and IFAM4 load modules when a maintenance version of the RSQL (and sometimes EVCP) object files is distributed on the [https://m204.rocketsoftware.com/maint/fixlist Model 204 maintenance page].

When and if there are any fixes for them, the most recent versions of these object files will appear as <code>'Model 204 .. RSQL'</code> and <code>'Model 204 .. EVCP'</code> with your desired version number.

The description of the RSQL and EVCP fixes will be contained in the entire set of Model 204 fixes, which you can download from the maintenance page by clicking a 'Download Zaps' link. RSQL and EVCP fixes are listed in the zap file with the characters <code>'*77Lxx'</code> at the start of their comment boxes.

==<b id="verify"></b>Verify Model 204 <I>x</I>.<I>y</I> on your system==
To perform an initial verification that your upgrade to 7.<var class="term">x</var> was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th>
<th>You should see...</th></tr>

<tr><td>ROCKET</td>
<td>A list of authorized M204 products (including 7.<var class="term">x</var>) currently on your system.</td></tr>

<tr><td>DISPLAY ZAPS</td>
<td>A list of Model 204 zaps (including 7.<var class="term">x</var> zaps) on your system.</td></tr>

<tr><td>DICTADMIN</td>
<td>(if you have [[Dictionary/204 installation guide|installed Dictionary/204]]) <br />The Dictionary Administration subsystem, displaying <code>Release 7.<var class="term">x</var></code> on its menu screens.</td></tr>

<tr><td>SUBSYSMGMT</td>
<td>The Application Subsystem facility, displaying <code>VER 7 REL <var class="term">x</var></code> on its menu screens.</td></tr>
</table>

==Example workflow for 7.5: download through installation==
This example shows one typical installation workflow: the site does not use RSQL, it uses the RACF external authorizer, and it does not have its own FUNU. The IBM system MQ loadlib is <code>MQSERIES.SCSQLOAD</code> (this is typical in z/OS).
The high-level qualifier in this example is MYBUILD.

The other item needed is the member name <code>MYBLDOB</code>, which is chosen arbitrarily for this example, and the following DSNs:
<ul>
<li><code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKOBJLIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB</code>
<li><code>MYBUILD.M204V75.LOCAL.OBJLIB</code>
<li><code>MYBUILD.M204V75.LOADLIB</code>
</ul>

===Build RKOBJLIB===
<ol>
<li>Download the object library (M204V75.OBJ) from the downloads page. </li>

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>. </li>

<li>Download the macro library (M204V75_ZOS.MAC) from the downloads page. </li>

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>. </li>

<li>Create the member MYBLDOB in my TSO library from a [https://m204.rocketsoftware.com/download/new204lb.txt download] of the job stream to build the object and macro libraries, using the following at the end of the job stream:
<p class="code">//BLD EXEC NEW204LB,VERSION=75,
// HLQ=MYBUILD,
// OBJINP=MYBUILD.M204V75.RKOBJLIB.DISTRIB,
// MACINP=MYBUILD.M204V75.RKMACLIB.DISTRIB
</p></li>

<li>Run MYBLDOB from my TSO library. MYBLDOB deletes and then creates <code>MYBUILD.M204V75.RKOBJLIB</code> and
<code>MYBUILD.M204V75.RKMACLIB</code>. </li>

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>. </li>

<li>Create the member MYBLDDS in my TSO library by copying
the job stream from [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], using the following at the end of the job stream:
<p class="code">//BLD EXEC JALINSP,
// HLQ=MYBUILD
</p></li>

<li>Run MYBLDDS from my TSO library. MYBLDDS allocates an empty loadlib data set for the Model 204 load modules, an empty local source library for the customized source files, and an empty local object library for the customized local object modules, with the following names: <code>MYBUILD.M204V75.LOADLIB</code>, <code>MYBUILD.M204.LOCAL.SRCLIB</code>, and <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>. </li>
</ol>

===Assemble and link===
<ol >
<li>Copy the RACFPARM source to the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and make any necessary modifications. </li>

<li>Create the member JASMSECJ in my TSO library by copying
the job stream from [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], using the following at the end of the job stream:
<p class="code">//ASM EXEC JASMP,HLQ=MYBUILD,
// MEM=RACFPARM
</p></li>

<li>Run JASMSECJ from my TSO library; this assembles the RACFPARM source file in the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and stores the object in <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.</li>

<li>Copy the member LKONLNJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and customize LKONLN as follows:
<ul>
<li>Make these changes at the top of the job stream:
<p class="code">// JCLLIB ORDER=(MYBUILD.M204V75.RKOBJLIB)
//LKONLN EXEC LKM204P,
// HLQ=MYBUILD,
// MQ=MQSERIES.SCSQLOAD
</p></li>
<li>Uncomment the <code>INCLUDE</code> line for LKNOSONL (that is, without RSQL).</li>
<li>Uncomment the <code>INCLUDE</code> line for MQ.</li>
<li>Uncomment the <code>INCLUDE</code> line for my external authorizer module (such as RACFOS and RACFPARM).</li>
<li>Submit the LKONLNJ job from my TSO library; this creates ONLINE (and BATCH204 alias) in MYBUILD.M204V75.LOADLIB.</li>
</ul></li>

<li>Perform a simple smoke test: run BATCH204 with 'DISPLAY ZAPS' and 'ROCKET' commands.</li>

<li>To link the utilities, copy member LKALLUTJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and see all <code><<</code> lines to customize for my site; submit the LKALLUTJ job.</li>

<li>Ensure that any JCL that performs deferred index sorting for <var class="product">Model 204</var> version 7.5
(typically, FLOD jobs) uses the new <code>MYBUILD.M204V75.LOADLIB</code> for the E15 (OI15OS) and E35 (OI35OS) sort exits.</li>
</ol>

==See also==
<ul>
<li>[[Model 204 installation on IBM z/VSE]]</li>
</ul>

[[Category:Installation]]

Talk:Fast/Unload punch list (complete)

2017-01-25T22:09:57Z

MCosta: /* feature test - comment */ new section

== feature test ==

this is a comment on feature test

== feature test - comment ==

this is a second comment on feature test

Talk:Fast/Unload punch list (complete)

2017-01-25T22:09:02Z

MCosta: /* feature test */ new section

== feature test ==

this is a comment on feature test

Talk:Fast/Unload punch list (complete)

2017-01-25T22:08:23Z

MCosta: Blanked the page

Talk:Fast/Unload punch list (complete)

2017-01-25T22:06:40Z

MCosta: Undo revision 95337 by MCosta (talk)

this is a test

Talk:Fast/Unload punch list (complete)

2017-01-25T22:05:35Z

MCosta:

this is a test

ok ..

Talk:Fast/Unload punch list (complete)

2017-01-25T22:04:01Z

MCosta: Created page with "this is a test"

this is a test

Template:JALDEMOJ

2017-01-09T16:53:29Z

MCosta:

<p class="code"><nowiki>
//name JOB jobCardParameters
//JALDEMOP PROC HLQ=, High level qualifier(s) of install DSNs
// VER=, M204 Version
// UNIT=, Unit
// VOL= Volume
//*
//**********************************************************************
//* Job: M204ALOC created on: 19 JUL 2012 AT: 13:04:11
//* allocates and catalogs MODEL 204 libraries & product files
//**********************************************************************
//ALOC EXEC PGM=IEFBR14
//CLIENTS DD DSN=&HLQ..&VER..CLIENTS,
// DISP=(NEW,CATLG,DELETE),
// DCB=(DSORG=PS,RECFM=F,LRECL=6184,BLKSIZE=6184),
// SPACE=(6184,224),
// UNIT=&UNIT,VOL=SER=&VOL
//CLAIMS02 DD DSN=&HLQ..&VER..CLAIMS02,
// DISP=(NEW,CATLG,DELETE),
// DCB=(DSORG=PS,RECFM=F,LRECL=6184,BLKSIZE=6184),
// SPACE=(6184,42),
// UNIT=&UNIT,VOL=SER=&VOL
//CLAIMS03 DD DSN=&HLQ..&VER..CLAIMS03,
// DISP=(NEW,CATLG,DELETE),
// DCB=(DSORG=PS,RECFM=F,LRECL=6184,BLKSIZE=6184),
// SPACE=(6184,42),
// UNIT=&UNIT,VOL=SER=&VOL
//VEHICLES DD DSN=&HLQ..&VER..VEHICLES,
// DISP=(NEW,CATLG,DELETE),
// DCB=(DSORG=PS,RECFM=F,LRECL=6184,BLKSIZE=6184),
// SPACE=(6184,126),
// UNIT=&UNIT,VOL=SER=&VOL
//DAILY DD DSN=&HLQ..&VER..DAILY,
// DISP=(NEW,CATLG,DELETE),
// DCB=(DSORG=PS,RECFM=F,LRECL=6184,BLKSIZE=6184),
// SPACE=(6184,200),
// UNIT=&UNIT,VOL=SER=&VOL
//* End of M204ALOC *******
//**********************************************************************
//* Job: RESTDEMO created on: 19 JUL 2012 AT: 13:04:13
//* restores the demo database files
//**********************************************************************
//INSTALL EXEC PGM=BATCH204,REGION=8M,
// PARM='SYSOPT=128'
//STEPLIB DD DSN=&HLQ..&VER..LOADLIB,
// DISP=SHR
//CCASTAT DD DSN=&HLQ..&VER..CCASTAT,
// DISP=(SHR)
//CCAPRINT DD SYSOUT=*
//CCAAUDIT DD SYSOUT=*
//CCASNAP DD SYSOUT=*
//SYSUDUMP DD SYSOUT=*
//CCATEMP DD DSN=&&TEMP0,DISP=(NEW,DELETE,DELETE),
// UNIT=SYSDA,SPACE=(6184,100)
//DUMPCLNT DD DSN=&HLQ..&VER..DEMODB.DUMP(CLIENTS),
// DISP=SHR
//DUMPCL02 DD DSN=&HLQ..&VER..DEMODB.DUMP(CLAIMS02),
// DISP=SHR
//DUMPCL03 DD DSN=&HLQ..&VER..DEMODB.DUMP(CLAIMS03),
// DISP=SHR
//DUMPVEH DD DSN=&HLQ..&VER..DEMODB.DUMP(VEHICLES),
// DISP=SHR
//DUMPDLY DD DSN=&HLQ..&VER..DEMODB.DUMP(DAILY),
// DISP=SHR
//*
//CLIENTS DD DSN=&HLQ..&VER..CLIENTS,
// DISP=(SHR)
//CLAIMS02 DD DSN=&HLQ..&VER..CLAIMS02,
// DISP=(SHR)
//CLAIMS03 DD DSN=&HLQ..&VER..CLAIMS03,
// DISP=(SHR)
//VEHICLES DD DSN=&HLQ..&VER..VEHICLES,
// DISP=(SHR)
//DAILY DD DSN=&HLQ..&VER..DAILY,
// DISP=(SHR)
//CCAIN DD *
SPCORE=20000,NFILES=20,NDIR=20,NDCBS=20
LOGON SUPERKLUGE
PIGFLOUR
CREATE FILE CLIENTS
END
OPEN CLIENTS
RESTORE 128 FROM DUMPCLNT
CREATE FILE CLAIMS02
END
OPEN CLAIMS02
RESTORE 128 FROM DUMPCL02
CREATE FILE CLAIMS03
END
OPEN CLAIMS03
RESTORE 128 FROM DUMPCL03
CREATE FILE VEHICLES
END
OPEN VEHICLES
RESTORE 128 FROM DUMPVEH
CREATE FILE DAILY
END
CLOSE ALL
LOGOUT
EOJ
/*
//* End of RESTDEMO *******
// PEND ************** End of JALDEMOP PROC *************
**** DEMO database Installation JCL, JALDEMOJ ***
//* DEMO DB Installation JCL
//* 1: Provide the high level qualifier, HLQ, of all Model 204
//* installation DSNs
//*
//* 2: Provide the Release Version qualifier, VER, for Model 204
//*
//* 3: Provide the DASD Unit, UNIT
//*
//* 4: Provide the Volume, VOL
//*
//SQLINST EXEC JALDEMOP,
// HLQ=, required 1 <<
// VER=, required 2 <<
// UNIT=, required 3 <<
// VOL= required 4 <<
//</nowiki></p>

Dictionary/204 installation guide

2016-11-03T16:33:46Z

MCosta: /* Reinstallation for existing Dictionary/204 sites */

==Overview==
<var class="product">[[Media:M204_DictionaryGuide_V75.pdf | Dictionary/204]]</var> Is a set of application subsystems (known as APSYs) running inside a <var class="product">Model 204</var> Online that provide full-screen and web-based tools to help programmers, DBAs, and system managers handle the complexities of <var class="product">User Language</var> and file and system management.

Installing <var class="product">Dictionary/204</var> requires downloading the <code>M204PROC</code> file and restoring it to your environment, setting up some subsidiary <var class="product">Model 204</var> files, and verifying that the environment has the appropriate parameter settings.

Upgrades to <var class="product">Dictionary/204</var> can almost always be handled by restoring a fresh copy of the <code>M204PROC</code> file.

==A summary of the Dictionary/204 installation steps==
The following checklist specifies in brief the steps to follow installing
<var class="product">Dictionary/204</var>, whether for z/VM CMS, z/OS, or z/VSE.
The sections [[#Installing Dictionary/204 on IBM z/VM CMS|Installing Dictionary/204 on IBM z/VM CMS]], [[#Installing Dictionary/204 on IBM z/OS|Installing Dictionary/204 on IBM z/OS]], and [[#Installing Dictionary/204 on IBM z/VSE|Installing Dictionary/204 on IBM z/VSE]] describe these steps in greater detail for each operating system.
<ol>
<li>Allocate the space required for the <code>M204PROC</code> data set,
and <var>RESTORE</var> it from the <var>DUMP</var> files found on the website.
<p>
In addition, there might be any number of other data sets required for
the <var class="product">Dictionary/204</var> components you are installing.
These are listed in [[#Installation checklist (z/VM CMS)|Installation checklist (z/VM CMS)]], [[#Installation checklist (z/OS)|Installation checklist (z/OS)]], and [[#Installation checklist (z/VSE)|Installation checklist (z/VSE)]]. </p> </li>

<li>Update the Online JCL or EXEC:
<ul>
<li>Add the DD cards, FILEDEFs, or DLBLs for the Dictionary/204 files. </li>
</ul>

<li>Update CCAIN parameters:
<ul>
<li>Increase <var>[[NFILES parameter|NFILES]]</var>, <var>[[NDCBS parameter|NDCBS]]</var>, and <var>[[NDIR parameter|NDIR]]</var> for the Dictionary/204 files. </li>
</ul> </li>

<li>Start the Online, using an <code>ONLINE</code> load module that contains <var class="product">Model 204</var> version 7.5 or higher. </li>

<li>Make sure that the Online has dump files allocated for backing up the Dictionary files. </li>

<li>Create backups of all Dictionary/204 files. </li>

<li>To install an update to Dictionary/204,
open file <code>M204PROC</code> and execute the following command:
<p class="code">INCLUDE DICN.DDRINST</p>
<p>
Run DICN.DDRINST using the JCL provided in the <code>DDRINSTJ</code> job in RKOBJLIB.</p> </li>

<li>Verify the success of the installation by compiling each Dictionary/204 subsystem. </li>

<li>Use the subsystem named <code>DICTADMIN</code> to customize the <var class="product">Dictionary/204</var> environment. </li>
</ol>

==Preparing for Dictionary/204 installation==
The <var class="product">Dictionary/204</var> products are implemented as <var class="product">Model 204</var> subsystems.
The code for all the component subsystems resides in the file named <code>M204PROC</code> which is typically downloaded from the product section of the website.

===Obtaining product installation files===
The files necessary for the installation are available from the Rocket Software website.

To download product files from the Rocket website:
<ol>
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, click the [https://m204.rocketsoftware.com/maint/ullist Download SOUL files] link. </li>

<li>After providing your registered customer login information, download the latest version of the <code>Dictionary/204</code> file (which is labeled "M204PROC" followed by a version number).
<p>
A "Click here" link on this page provides Help on downloading format, some information about
different browser behaviors, file sizing information, and more.</p></li>
</ol>

===Determining eligible products===
To download files or maintenance from the Rocket M204 Customer Care area of the Rocket website, you must have a registered Rocket user ID ([[Contacting Rocket Software Technical Support|contact Technical Support]] if you need an ID).
The website will show only products for which your organization is up to date on maintenance or rental payments.
If a product does not appear on your download page and you believe it should,
contact Technical Support.

===System requirements===
<ul>
<li><var class="product">Dictionary/204</var> operates in a <var class="product">Model 204</var> Online region.
<p>
In the rest of this document, "Online" refers to a region of
<var class="product">Model 204</var> running an <var>ONLINE</var> load module containing Version 7.5 or higher
</p></li>
</ul>

===User privileges===
The installing user <i>must</i> have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>

<li>System Manager privileges, as well as access to all of the Dictionary/204 subsystems and the JCL or EXEC that
runs the Online <var class="product">Model 204</var> region. </li>
</ul>

===New installation or reinstallation===
<ul>
<li>Sites that have never installed <var class="product">Dictionary/204</var> ''must'' use the new installation, as there are a number of files to allocate and <var
class="product">Model 204</var> parameters to update.</li>

<li>Sites that are re-installing the latest version of <var class="product">Dictionary/204</var>
can either [[#Reinstallation for existing Dictionary/204 sites|reinstall]] Dictionary/204 (using DDRINST) or perform a [[#New installation|new installation]] (using DDINST) to create a new set of Dictionary/204 files.

<p>If you are upgrading from a previous version or maintenance level, your site already has the Dictionary files that contain information about your environment.</p> </li>
</ul>

==New installation==
<p class="note"><b>Note:</b> If you have never installed Dictionary/204 before, you must use these instructions. If you have installed Dictionary before, you can do a new install using these instructions if desired.</p>
You can verify the <var class="product">Dictionary/204</var> version in the title of any <var class="product">Dictionary/204</var> screen.
The installation steps are as follows:
<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, click the [https://m204.rocketsoftware.com/maint/ullist Download SOUL files] link. </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.

<p>
<li>In file <code>M204PROC</code>, run the procedure <code>DICN.DDINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Reinstallation for existing Dictionary/204 sites==
You can verify the <var class="product">Dictionary/204</var> version in the title of any <var class="product">Dictionary/204</var> screen.
The reinstallation steps are as follows:

<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, click the [https://m204.rocketsoftware.com/maint/ullist Download SOUL files] link.</li>

<li>Download the latest version of the <code>M204PROC</code> file (which is followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.
<p>
If you are upgrading from a previous release, simply overlay your old <code>M204PROC</code> file.</p></li>

<li>Since this update process requires updating CCASYS, you must bring up a single user Online,
or run the installation as a batch process with the <var>SYSOPT</var> X'01' bit turned <i>off</i>. </li>

<li>Make sure that dump files are allocated to the Online, as shown below:

<p class="code">//DUMPCSYS DD DISP=SHR,DSN=ccasys.dump.dataset
//DUMPLINK DD DISP=SHR,DSN=datalink.dump.dataset
//DUMPDCTL DD DISP=SHR,DSN=d204dctl.dump.dataset
//DUMPRPT DD DISP=SHR,DSN=d204rpt.dump.dataset
//DUMPDSYS DD DISP=SHR,DSN=d204sys.dump.dataset
//DUMPMETA DD DISP=SHR,DSN=metadata.dump.dataset
</p>
<p class="note"><b>Note:</b> No dump data set is required for M204TEMP or M204PROC. </p>
<p>
The size of each dump data set should be equal to the size of the corresponding Dictionary file. The DCB is: </p>
<p class="code">DCB=(LRECL=6184,BLKSIZE=6184,RECFM=F)</p>
<p>
Make sure these DD statements are also part of that JCL: </p>
<p class="code">//CCASYS DD DISP=SHR,DSN=your.current.ccasys
//DATALINK DD DISP=SHR,DSN=your.current.datalink
//D204RPT DD DISP=SHR,DSN=your.current.d204rpt
//D204SYS DD DISP=SHR,DSN=your.current.d204sys
//METADATA DD DISP=SHR,DSN=your.current.metadata
//M204DCTL DD DISP=SHR,DSN=your.current.m204dctl
//M204PROC DD DISP=SHR,DSN=v76.version.m204proc
//M204TEMP DD DISP=SHR,DSN=your.current.m204temp
</p>

<p class="note"><b>Note:</b> Running the installation job (<code>DICN.DDRINST</code>) creates the backups of the Dictionary files.</p></li>

<li>Run the procedure <code>DICN.DDRINST</code> (file <code>M204PROC</code>) to install the downloaded release.</li>
</ol>
<p>
Run DICN.DDRINST using the JCL provided in the <code>DDRINST</code> job in RKOBJLIB.</p>

The <var class="product">Dictionary/204</var> subsystems can be set to <code>AUTOSTART</code> if you like.

==Installing Dictionary/204 on IBM z/VM CMS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on z/VM CMS,
including z/VM CMS system and software requirements.

Review [[#Preparing for Dictionary/204 installation|Preparing for Dictionary/204 installation]] for details about general <var class="product">Dictionary/204</var> system requirements.

The <code>M204PROC</code> <var class="product">Model 204</var> file, which contains the <var class="product">[[SOUL]]</var> code that runs <var class="product">Dictionary/204</var>, can be [[#Obtaining product installation files|obtained from the Rocket website]].

The following table lists the required files needed to complete an installation of Dictionary/204.
<table class="thJustBold">
<tr class="head"><th>File name</th>
<th>Contents</th></tr>

<tr><th>METADATA</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th>DATALINK</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th>M204TEMP</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th>D204RPT</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th>D204SYS</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th>M204DCTL</th>
<td>Required for the installation of <var class="product">Dictionary/204</var>. </td></tr>
</table>

Allocate space for the <var class="product">Dictionary/204</var> files, and restore them from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]], as described in the following steps.

===Installation checklist (z/VM CMS)===

<ol>
<li>Define and format a minidisk to hold the <var class="product">Dictionary/204</var> installation files.
1500 4096-byte z/VM CMS blocks should be sufficient in all cases.
This requires a 22-cylinder z/VM CMS minidisk on a 3390. </li>

<li>Allocate space for the required <var class="product">Dictionary/204</var> data sets. A skeleton exec,
<code>D204FDEF</code>, is provided for this purpose.
Modify this exec to perform the allocations on the appropriate minidisks.
Allocate space for the following data sets:
<table class="thJustBold">
<tr><th>M204PROC
</th><td>6000 pages; must always be allocated.</td></tr>

<tr><th>METADATA
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>DATALINK
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204TEMP
</th><td>150 pages; must always be allocated.</td></tr>

<tr><th>D204RPT
</th><td>110 pages; must always be allocated.</td></tr>

<tr><th>D204SYS
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204DCTL
</th><td>100 pages; must always be allocated.</td></tr>
</table>

<blockquote class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, modify the D204FDEF EXEC to use the old Dictionary/204 files for the upgrade.
<p>
The installation process uses these files to install a new version of Dictionary/204.
</p>
</blockquote> </li>

<li>Modify the RESPROC EXEC to specify the <code>M204PROC</code> dump file and <code>M204PROC</code> file to be loaded.</li>

<li>Restore the <code>M204PROC</code> file with the <var>D204 RESPROC</var> exec.
<p>
To carry out the install, you must customize the FILEDEF inside the <var>D204FDEF</var> exec to conform to local standards.
In addition, modify <var>LOGONSM CCAIN</var> to contain a valid login ID and password.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </p></li>

<li>To run the <var>D204</var> exec for a new install, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 INSTALL</p></li>

<li>To run the <var>D204</var> exec for a REINSTALL, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 REINSTALL</p></li>

<li>Complete [[#updateJCL|steps 3 through the end]] in the [[#Installing Dictionary/204 on IBM z/OS|"Installing Dictionary/204 on IBM z/OS"]] section. </li>
</ol>

==Installing Dictionary/204 on IBM z/OS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/OS, including the z/OS system and software requirements.
If, like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/OS)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>
An example command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:

<p>Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

:M204PROC
:METADATA
:DATALINK
:M204TEMP
:M204DCTL
:D204SYS
:D204RPT

<li>Verify that the Online environment allows the use of file groups and APSY 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 APSYs, 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.
<p>
For more information about APSYs and file groups, see [[Storing and using file group definitions (CCAGRP)#File groups|File groups]] and [[System requirements for Application Subsystems]]. </p></li>
</ul> </li>

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
Run DICN.DDRINST using the JCL provided in the <code>DDRINSTJ</code> job in RKOBJLIB.</p>
<p>
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 subsystems.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 subsystems.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review the [[#Dictionary/204 server size |Dictionary/204 server size]] section, below, for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage may increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

==Installing Dictionary/204 on IBM z/VSE==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/VSE,
including z/VSE system and software requirements.

If like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/VSE)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>A sample command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<p>
Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

:M204PROC
:METADATA
:DATALINK
:M204TEMP
:M204DCTL
:D204SYS
:D204RPT

<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|UPSI]]</var> parameter must contain the <code>00000010</code> bit. </li>

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

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify that the setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review [[#Dictionary/204 server size|Dictionary/204 server size]] for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage might increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

===Dictionary/204 server size===
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.
The actual server size requirements might vary slightly because of table
settings in the local Online <var class="product">Model 204</var> regions, and because of slight
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.
<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server
</th></tr>

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

Model 204 installation on IBM z/OS

2016-11-02T22:47:28Z

MCosta: /* Assemble FUNU and optional MSGU */

<div class="toclimit-3">__TOC__</div>
==Overview==
This topic describes the steps required to upgrade to Rocket Model 204 version 7.5 or higher, on the IBM<sup>®</sup> z/OS<sup>®</sup> operating system.

The new version number is referred to as <var class="term">x</var>.<var class="term">y</var>, where <var class="term">x</var>.<var class="term">y</var> can be 7.5 or higher.

For information on the new features available in each version, as well as any compatibility issues, see the [[Release_notes#Release_notes.2C_wishlists.2C_and_punch_lists|Model 204 release notes]].

If you are skipping any versions when upgrading (such as upgrading from 7.5 to 7.7), be sure to read the release notes for those versions as well (such as 7.6).

==Before you begin==
<ul>
<li>You must have either a [[Rocket M204 user ID]] or a preexisting user ID to download the installation files.</li>

<li>The object library has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. <br />(The preapplied zap will authorize Model 204 itself and any separately purchased products such as [[SirScan]].)</li>

<li>The object library also has the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to run [[RockZap]] to apply any new maintenance when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version <var class="term">x</var>.<var class="term">y</var> files.
<p>Each step links to a section with detailed instructions. Note that some steps (such as assembling custom modules) might not apply to your installation. Once you have started, you can proceed directly through the steps (detail sections are consecutive) or return to this list for context.</p>
For a 7.5 example, see [[#Example_workflow_for_7.5:_download_through_installation|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#Build the Model 204 object and macro libraries|Build]] the Model 204 object and macro libraries:
<ol style="list-style-type:lower-alpha;">
<li>Use your [[Rocket M204 user ID]] to [[#downloading|download]] the Model 204 object library and the Model 204 macro library.</li>

<li>[[#uploading|Upload]] the downloaded components to the z/OS system on the IBM mainframe.</li>

<li>[[#bldLibs|Build]] the RKOBJLIB object library and RKMACLIB macro library. (Once you have built these libraries, do not modify them.)</li>
</ol>
</li>

<li>Submit the job to [[#allocating|allocate the other data sets]] required for installation.</li>

<li>Modify and assemble these modules if you use them:
<ol style="list-style-type:lower-alpha;">
<li>Your [[#Assemble FUNU and optional MSGU|user $functions (FUNU)]] and, optionally, MSGU.
<li>An external authorizer (such as RACF) for Model 204. [[#secparm|Set up the security module]], including assembling the <i>xxxx</i>PARM security module (such as RACFPARM). The object file is then stored in your local object library.</li>
<li>[[#ul_db2|UL/DB2 interface]]: preprocess and assemble the USQL module.</li>
<li>Other customized modules, such as CDTB. Modify them as needed and [[#asm|assemble]] them.
</ol></li>

<li>Link the [[#lkonln|ONLINE]] load module.</li>

<li>If you use the [[#link_ifam1|IFAM1 and IFAM4]] load modules, link them.</li>

<li>Link the <var class="product">Model 204</var> [[#lkutils|utility load modules]].</li>

<li>If you use the [[#cics|CICS interface]], customize it, and then assemble and link the CICS modules.</li>

<li>If you use the [[#tso|TSO]] interface, assemble and link-edit the TSO source modules.</li>

<li>Link the [[#CRAM|CRAM]] load modules as needed.</li>

<li>If you use [[#softspy|SoftSpy]], upgrade it for <var class="term">x</var>.<var class="term">y</var>.</li>

<li>[[#verify|Verify]] the installation.</li>
</ol>

==Build the Model 204 object and macro libraries==
To build the object and macro libraries, you must download the object library and macro library; upload each library to the mainframe; and copy, modify, and run the NEW204LB job.
===Object and macro libraries===
{{Template:Model 204 installation components}}

===<b id="downloading"></b>Downloading===
<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download.</li>
</ol>

===<b id="uploading"></b>Uploading===
Once the object file and macro library are downloaded to your workstation, upload them to the z/OS system on the IBM mainframe. You can use any file transfer mechanism, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for object and macro libraries</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for object and macro libraries</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

For details on how to download and upload, see [[Downloading and uploading Model 204 installation components]].

===<b id="bldLibs"></b>Building the object and macro libraries (NEW204LB job stream)===

After you upload the object and macro library input streams to the mainframe, build the object and macro libraries:

<ol>
<li>Access the [http://sirius.sirius-software.com/download/new204lb.txt NEW204LB job stream] text file.

<li>Copy the job stream file into a local TSO library for editing.

<li>On the first line of the job stream, modify the JOB card according to your local job card parameters.

<li>On the final four lines, marked <code>2 <<</code> ... <code>5 <<</code> on the right:
<ol style="list-style-type:lower-alpha;">
<li>Modify the <code>VERSION=</code> parameter, specifying the two-digit version of <var class="product">Model 204</var> you are installing, such as 75.
<li>Modify the <code>HLQ=</code> parameter, specifying the high-level qualifiers of all <var class="product">Model 204</var> installation data sets.
<li>Modify the <code>OBJINP=</code> parameter, using the DSN of the object library input file that you uploaded to the mainframe.
<li>Modify the <code>MACINP=</code> parameter, using the DSN of the macro library input file that you uploaded to the mainframe.
</ol>
<li>Submit the <code>NEW204LB</code> job to build the object library ("RKOBJLIB") and macro library ("RKMACLIB") on your z/OS system.</li>
</ol>

<div id="notouch"></div>
<p class="warn"><b>Attention:</b> Once you have built RKOBJLIB and RKMACLIB on your z/OS system, <b>do not</b> modify them in any way.<br />

For example, <b>do not</b> store other members into the object library; it should only contain the members as supplied in a download from the web site. Place object files that you might assemble (such as FUNU or RACFPARM) into your local object library.</p>

====RKOBJLIB README file====
README, a member of RKOBJLIB, contains details on the object files and installation steps. Once you have built RKOBJLIB, you can use README as an installation checklist if desired.

<div id="allocating"></div>

==Allocate the data sets for Model 204 upgrading==

There are three data sets used when upgrading to Model 204 7.<var class="term">x</var>:

<ul>
<li>data set for the Model 204 load modules
<li>data set for the local source library
<li>data set for the local object library
</ul>
The data set for the load modules will contain, after linking, the modules for the Model 204 product, including: ONLINE, IFAM1, and IFAM4.

The local source library is used to store the customized source for modules such as FUNU, MSGU, and ACF2PARM, RACFPARM, or TOPSPARM.

When the source is assembled, it is stored in the local object library.

One of the members of the RKOBJLIB object library is named [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], which is a job stream to allocate data sets for the installation. <code>JALINSJ</code> contains information about naming conventions for the data sets.

===Allocating data sets (JALINSJ job stream)===

<ol>
<li>Copy <code>JALINSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JALINSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul>
</li>
<li>Submit the <code>JALINSJ</code> job.
This job will allocate the basic installation datasets (the first two will be deleted before being allocated):
<ul>
<li>hlq.M204V77.LOADLIB - the library for linking most load modules</li>
<li>hlq.M204V77.LOCAL.OBJLIB - the library for assembling optional object files: RACFPARM, FUNU, etc.</li>
<li>hlq.M204.LOCAL.SRCLIB - the library in which you store source for assembling modules such as FUNU and xxxPARM. Note that this DSN does <var class="term">not</var> have a version identifier (such as V75, V76, and so on). This library is only allocated if it does not already exist. It is used for installing all versions of Model 204.</li>
</ul>
</li>
</ol>

<div id="FUNU"></div>

==Assemble FUNU and optional MSGU==


This section lists installation considerations if you have your own user-written $functions module (FUNU).

<p class="note"><b>Note:</b> If you have your own FUNU or MSGU module, you must assemble it <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.</p>

Assemble your FUNU and/or optional MSGU modules with the following steps:
<ol>
<li>Modify FUNU for 64-bit addressing considerations and store the modified source in your local source library.
<div id="FUNU_7.5"></div>
<p>FUNU changes for 7.x are:</p>
{{Template:FUNU changes for 7.5}}
</li>
<li>If you have any user-defined messages (MSGU), store them in your local source library.</li>

<li>Assemble FUNU (and MSGU, if applicable), with the output object file stored in your local object library.
<ol style="list-style-type:lower-alpha;">

<li>Run <code>JASMJ</code> to [[#asm|assemble]] FUNU into your local object library.</li>

<li>If applicable, run <code>JASMJ</code> to assemble MSGU.</li>

<p>You do <b>not</b> need to insert any INCLUDE statements for either FUNU nor MSGU; they are already present in the INCLUDE member (LKSQLONL or LKNOSONL) provided in the downloaded object library.</p></li>
</ol>
</li>
</ol>

<div id="secparm"></div>

==Set up the security module==

This section describes how to install a [[Security interfaces overview|security interface]] such as CA-ACF2, RACF, or CA-Top Secret.

<ol>
<li>Review the Model 204 installation section for your interface and complete all of the steps:
<ul>
<li>[[CA-ACF2_MVS_interface#Installing_the_Model_204_CA-ACF2_MVS_Interface|CA-ACF2 (MVS)]]</li>
<li>[[CA-ACF2_VM_interface#Installing_the_CA-ACF2_VM_Interface|CA-ACF2 (VM)]]</li>
<li>[[Security_Server_(formerly_RACF)_interface#Installing_the_Security_Server_Interface|RACF]]</li>
<li>[[CA-Top_Secret_interface#Installing_the_CA-Top_Secret_Interface|CA-Top Secret]]</li>
</ul>
</li>
<li> [[#asm|Assemble]] the security module:
ACF2PARM, RACFPARM, or TOPSPARM.</li>
<li>Optional. Link the security module as described below if you want it to be dynamically loaded.</li>
</ol>

===Linking the security module (LKSECRJ job stream)===

Dynamic loading lets you modify the security parameters without having to relink Model 204, which would be required if the parameter module were linked into Model 204 directly.

If you want Model 204 to dynamically load your security module during Model 204 ACF2, RACF, or TOPSECRET interface initialization, then you must link the corresponding security parameter module.

One of the members of the RKOBJLIB object library is <code>LKSECRJ</code>, a job stream to link-edit the security parameter module.

<ol>
<li>Copy [[Model 204 security module link job stream for IBM z/OS|LKSECRJ]] into a local TSO library.
<li>Edit your copy of <code>LKSECRJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKSECRJ</code> job to link-edit the security parameter module (ACF2PARM, RACFPARM, or TOPSPARM).
</ol>
<div id="ul_db2"></div>

==Install the UL/DB2 interface (JAUSQLJ job stream)==

To support the [[UL/DB2]] interface, USQL code is delivered in source for you to preprocess for your version of DB2. If you use the UL/DB2 interface, assemble the source as described below <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.

<ol>
<li>Copy [[Model 204 UL/DB2 job stream for IBM z/OS|JAUSQLJ]] into a local TSO library.
<li>Edit your copy of <code>JAUSQLJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>on the line after <code>EXEC JAUSQLP</code> at the bottom of the job stream set:
<ul>
<li><code>HLQ=</code>high level qualifier of all Model 204 installation DSNs</li>
<li><code>DB2HLQ=</code>high level qualifier for your DB2 maclib.</li>
</ul>
</ul>
</ul>
<li>Submit the <code>JAUSQLJ</code> job to preprocess and assemble the USQL module. The JAUSQLJ job executes the following two steps:
<ul>
<li>Run USQL (contained in RKMACLIB) through the DB2 preprocessor to process the EXEC SQL statements. This step produces two data sets: the DBRM and the expanded USQL source. The DBRM is saved as USQLDBRM in the local object library. The expanded USQL source is passed to step two for assembly.</li>
<li>Assemble expanded USQL source into local object library.</li>
</ul>
<li>Bind the DBRM as the plan with a site-specific plan name.</li>
</ol>

<div id="asm"></div>

==Assemble customized modules into your local object library (LOCAL.OBJLIB)==

Copy the customized source module (such as, FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2) from your current release into your local source library, if you have not already done so.
The local source library is not version-specific, so modules copied into it can be used for future installations.

One of the members of the RKOBJLIB object library is [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], a job stream to assemble a member from your Model 204 local source library into your local object library (LOCAL.OBJLIB).

===Assembling customized modules (JASMJ job stream)===
<ol>
<li>Copy <code>JASMJ</code> into a local TSO library.
<li>Edit your copy of <code>JASMJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the ASM line at the bottom of the job stream
</ul>
<li>Provide the member name to assemble (such as FUNU, MSGU, RACFPARM) on the <code>MEM=</code> line.
</ul>
<li>Submit the <code>JASMJ</code> job to assemble the module into your local object library.
</ol>

<div id="lkonln"></div>

==Link the Model 204 ONLINE load module==


<div id="onlnTable"></div>
<blockquote class="note">
<p><b>Notes:</b> </p>
<ul>
<li>If you use customized modules (such as FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2), you must [[#FUNU_7.5|modify]] them (if needed) and [[#asm|assemble]] them <b>before you link the ONLINE/IFAM1/IFAM4</b> load modules.</li>
<li>There is not a separate link step for BATCH204. It is not maintained as a separate module; the same module as ONLINE is used, with a BATCH204 alias.</li>
<li>The INCLUDE TCPLIB(SNMPGSYS) statement for Horizon TCP/IP in the Online-link-edit job is no longer required and has been eliminated.</li>
<li>A number of INLUDE LELIB(CEE*) statements have also been eliminated from the Online-link-edit job. These were required to support several mathematical $functions but those $functions have been rewritten in Assembly language and are now automatically part of the Online load module.</li>
<li>The INCLUDE BLOCKPRT(IEFSD095) statement is required if block printing on separator pages is desired. Usually the BLOCKPRT DD points to DSN=SYS1.AOSB0.</li>
<li>As of Model 204 version 7.7, FastUnload is linked as an alias of the ONLINE load module, not as a standalone module. The FastUnload code is fully integrated into the Model 204 nucleus.</li>
</ul>
</blockquote>

One of the members of the RKOBJLIB object library is [[Model 204 ONLINE link job stream for z/OS|LKONLNJ]], which is a job stream to link the <var class="product">Model 204</var> ONLINE load module.

<div id="LKONLNJ"></div>
===Linking ONLINE (LKONLNJ job stream)===


<ol>
<li>Copy the <code>LKONLNJ</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKONLNJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with 1-4 followed by <code><<</code>. The numbers correspond to numbered steps in the comments.
<li>As needed, edit the lines after <code>SYSLIN DD *</code> that are marked with <code><<</code>. See the comments at the top of the <code>SYSLIN</code> sections (<b>A</b>-<b>C</b>) for instructions.
</ul>
<li>Submit the <code>LKONLNJ</code> job to link the ONLINE load module.
</ol>

Concise editing instructions are provided in the <code>LKONLNJ</code> file itself. More details about link-editing the ONLINE load module are provided in the following table.

<table class="thJustBold">
<tr><th>1</th><td>You must specify a value for the HLQ symbolic parameter in the EXEC LKM204P statement. The value of HLQ corresponds to the high-level qualifier used for the DSN for:
<ul>
<li> the downloaded object library</li>
<li>the Model204 load library</li>
<li>other data sets that are required for installation</li>
</ul></td></tr>
<tr><th>2</th><td>One of the modifications is <b>always required</b>, based on whether the ONLINE is to use RSQL (for Connect*) or not.

Uncomment only one of the following statements:
<ul>
<li>To link an ONLINE that uses RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKSQLONL</b>) statement.
<li>To link an ONLINE that does not use RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKNOSONL</b>) statement.
</ul>
</td></tr>
<tr><th>3</th><td>If you use an external authorizer, such as RACF or ACF2, you must:
<ul>
<li>[[#asm|Assemble the xxxPARM]] for your external authorizer to add the object file (such as RACFPARM or ACF2PARM) to your local object library.
<li>In the SYSLIN DD *, uncomment the appropriate INCLUDE statement(s) for your external authorizer. <blockquote class="note"><b>Notes:</b>
<ul><li>Uncomment either the "static" or "dynamic" INCLUDE statement, depending on your configuration.<li>If you use ACF2, there are two INCLUDE statements to be uncommented; one refers to your system ACF2 library. You must also provide the DSN for the ACF2 library in the ACF2 symbolic parameter in the EXEC LKM204P statement.</ul>
</blockquote>
</ul>
</td></tr>

<tr><th>4</th><td>If you have other programs that you assemble for your Model 204 ONLINE module, for example, [[#FUNU|FUNU]], assemble them into your local object library. You <strong>do not</strong> need to add additional INCLUDE statements for FUNU or other locally assembled object files; they are already in the include streams from RKOBJLIB.
</td></tr>

<tr><th>5</th><td>If you have an MQ series load library, set the MQ symbolic parameter to the correct DSN in the EXEC LKM204P statement. This allows you to use the MQ Series feature of <var class="product">Model 204</var>, either if you are already authorized for it, or to support a trial of it, without requiring relinking of the load module. You must also uncomment the INCLUDE MQ statement in the SYSLIN input.
</td></tr>

</table>

<div id="link_ifam1"></div>
<div id="link_ifam4"></div>

==Link the Model 204 IFAM1 and IFAM4 load modules==


Among the members of the RKOBJLIB object library are:
<ul>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM1_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM1_link_job_stream_for_IBM_z/OS&target=blank LKIFAM1J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM1 load module</li>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM4_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM4_link_job_stream_for_IBM_z/OS&target=blank LKIFAM4J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM4 load module.</li>
</ul>

===Linking IFAM1 (LKIFAM1J job stream)===
<ol>
<li>Copy the <code>LKIFAM1J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM1J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM1J</code> job to link the IFAM1 load module.
</ol>

===Linking IFAM4 (LKIFAM4J job stream)===
<ol>
<li>Copy the <code>LKIFAM4J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM4J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM4J</code> job to link the IFAM4 load module.
</ol>

<div id="lkutils"></div>


==Link the Model 204 utility load modules==


Following are the utility load modules to be linked:
<table>
<tr class="head">
<th>Module</th><th>Description</th>
</tr>
<tr><td><b>AUDIT204</b></td> <td> Generate an audit trail from the CCAJRNL or CCAJLOG data sets, with report stats and analysis</td></tr>
<tr><td><b>BATCH2</b></td> <td>Enable batch users to access a Model 204 Online that is running in a separate region</td></tr>
<tr><td><b>HASH15</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>HASH35</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>MERGEJ</b></td> <td>Media recovery journal merge utility</td></tr>
<tr><td><b>M204LIST</b></td> <td></td></tr>
<tr><td><b>M204XREF</b></td> <td></td></tr>
<tr><td><b>OI15OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>OI35OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>UTILC</b></td> <td>Information from checkpoint stream</td></tr>
<tr><td><b>UTILJ</b></td> <td>Journal/Audit trail debug utility</td></tr>
<tr><td><b>ZBLDTAB</b></td> <td>Build prototype password table</td></tr>
<tr><td><b>ZCTLTAB</b></td> <td>Convert CCASTAT for the Password Expiration feature</td></tr>
</table>

===Linking the utility load modules (LKALLUTJ job stream)===

One of the members of the RKOBJLIB object library is [[Model 204 utilities link job stream for IBM z/OS|LKALLUTJ]], a job stream to link the <var class="product">Model 204</var> utility load modules.
<ol>
<li>Copy <code>LKALLUTJ</code> into a local TSO library.
<li>Edit your copy of <code>LKALLUTJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKALLUTJ</code> job to link the utility load modules.
</ol>

<div id="lkcram"></div>

==<b id="cics"></b>Install the CICS interface==
The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.

For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 4.1, 4.2 and 5.3.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===Installation steps===
<ol>
<li>[[#Customizing the CICS interface|Customize the interface]] by editing the CICFG copy member.

<li>[[#Update the CICS System Definition (CSD)|Update the CICS System Definition (CSD)]] using one of the following methods:
<ul>
<li>Resource Definition Online (CEDA). The supplied member CEDAM204 in RKMACLIB provides an example of the required PCT, PPT, and PLT definitions.</li>

<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
</ul>
<li>[[#CICS_alloc|Allocate]] a CICS user library.</li>

<li>[[#CICS_asm|Assemble and link]] the CICS modules.</li>
</ol>

====Customizing the CICS interface====
To customize the CICS interface, copy the CICFG copy member from RKMACLIB into your local source library and edit it as needed.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface#Use the CICS Standard Mapping Service|Use the CICS Standard Mapping Service]].</p>

====Updating the CICS System Definition (CSD)====
You can update the CSD by using either CEDA or the DFHCSDUP utility and the CEDAM204 member of RKMACLIB. Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>
<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. It is never
invoked with a transaction ID from a terminal.</td> <td /> <td /><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td /> <td /></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>
CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using the CEDAM204 member, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
RSL(PUBLIC)
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
RSL(PUBLIC)
.
.
.

CEDA CHeck GRoup(group_name) </p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

<div id="CICS_alloc"></div>

====Allocating a CICS user library (JALCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS user library allocation job stream for IBM z/OS|JALCICSJ]], a job stream to allocate an empty CICS user library. You must allocate the CICS user library before assembling and linking the CICS modules.
<ol>
<li>Copy <code>JALCICSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JACICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.</li>
<li>Supply your installation high level qualifier(s) in the following lines marked with <<:
<ul>
<li>for hlq in the JCLLIB ORDER=(hlq.... line after the JOB card </li>
<li>after HLQ=, on the line after EXEC LKALLUTP at the bottom of the job stream </li>
</ul>
</ul>
</li>
<li>Submit the <code>JALCICSJ</code> job to allocate the CICS user library.</li>
</ol>

<div id="CICS_asm"></div>

====Assembling and linking CICS modules (LKCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS module assembly job stream for IBM z/OS|LKCICSJ]], a job stream to assemble and link the <var class="product">Model 204</var> CICS modules.
<ol>
<li>Copy <code>LKCICSJ</code> into a local TSO library.
<li>Edit your copy of <code>LKCICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your Model 204 installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC JALCICSP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKCICSJ</code> job to assemble and link the CICS module.
</ol>

<div id="tso"></div>

==Install the TSO interface==

<p class="note"><b>Note:</b> It is not necessary to install the TSO interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

The Model 204 TSO Interface enables the TSO user to communicate with a Model 204 Online.

The TSO Interface consists of two assembly language modules, TSFS and TSUL, whose source is located in the macro library. The modules are completely reentrant, reusable, and refreshable.

Installation requires assembly and link-editing of the TSO source modules using the [[Model 204 TSO module assembly job stream for IBM z/OS|LKTSOJ]] job stream from the RKOBJLIB library.

===Assembling and linking the TSO modules===

<ol>
<li>If you are using TSO extensions, modify TSFS in the local source library by changing:
<p class="code">&TSOV SETC 'TSO' </p>
<p>to:</p>
<p class="code">&TSOV SETC 'TSOE'</p></li>
<p>Changing the &TSOV SETC 'TSO' code in TSFS causes assembly of the NOEDIT form of the TPUT macro in the TSFS module. The NOEDIT form, required for 3270 extended data streams, allows proper handling of colors or highlighting in TSO extensions. NOEDIT is recommended for all TSO extensions.</p>
<li>Copy <code>LKTSOJ</code> from the RKOBJLIB object library into a local TSO library.
<li>Edit your copy of <code>LKTSOJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKTSOJ</code> job to assemble and link the TSO modules.
</ol>

==CRAM==
<blockquote class="note"><b>Notes:</b> CRAM SVC installation is deprecated in version 7.5 and higher. The following instructions are for [[Defining the user environment (CCAIN)#CRAM_options for z.2FOS|CRAM-XDM]].

<p>It is recommended that you install the version of CRAM-XDM that corresponds to the version of Model 204 you are installing. However, you could run a 7.5 version of CRAM-XDM with 7.x Model 204, such as for testing.</p></blockquote>

To install the CRAM load modules, proceed with the following steps:

<ol>
<li>Before linking the CRAM load modules, familiarize yourself with [[Defining_the_user_environment_(CCAIN)#CRAM_.28IODEV.3D11.2C_23.2C_29.29|CRAM]]: what it does, which facilities require it, and available CRAM options.

<li>Install 7.<var class="term">x</var> CRAM-XDM by running [[Model 204 CRAM link job stream for IBM z/OS|LKCRAMJ]], the job stream to link the CRAM load modules. LKCRAMJ is found in RKOBJLIB.

<p>CICS interface users: Unlike version 7.4 CRAM-XDM, the step in the link JCL for the CRAM modules specifies the <code>RENT</code> value for <code>PARM</code>. Read the Note in [[CICS interface#Running with storage protection on|Running with storage protection on]] for details.</p></li>
</ol>

<p class="note"><b>Note:</b> After installation, you will need to perform additional tasks to [[Defining the user environment (CCAIN)#Implementing CRAM-XDM usage for z/OS operating systems|implement CRAM-XDM]].</p>

<div id="softspy"></div>

==Upgrade SoftSpy==

To upgrade SoftSpy for version 7.<var class="term">x</var>, download, upload, and restore the SoftSpy procedure file, SPYPROC, which is distributed in a dump format.

<ol>
<li>Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>
For detailed instructions, see [[Downloading and restoring SOUL files#How can the dump file be uploaded to the mainframe?|Downloading and restoring SOUL files]].

For details on the SoftSpy installation, including customization and System Manager considerations, see the [[SoftSpy installation guide]].

==RSQL maintenance==
RKOBJLIB also contains the LKMAINTJ job stream. LKMAINTJ is used to relink the ONLINE, IFAM1, and IFAM4 load modules when a maintenance version of the RSQL (and sometimes EVCP) object files is distributed on the [https://m204.rocketsoftware.com/maint/fixlist Model 204 maintenance page].

When and if there are any fixes for them, the most recent versions of these object files will appear as <code>'Model 204 .. RSQL'</code> and <code>'Model 204 .. EVCP'</code> with your desired version number.

The description of the RSQL and EVCP fixes will be contained in the entire set of Model 204 fixes, which you can download from the maintenance page by clicking a 'Download Zaps' link. RSQL and EVCP fixes are listed in the zap file with the characters <code>'*77Lxx'</code> at the start of their comment boxes.

<div id="verify"></div>

==Verify Model 204 <I>x</I>.<I>y</I> on your system==
To perform an initial verification that your upgrade to 7.<var class="term">x</var> was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized M204 products (including 7.<var class="term">x</var>) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.<var class="term">x</var> zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.<var class="term">x</var></code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL <var class="term">x</var></code> on its menu screens.</td></tr>
</table>

==Example workflow for 7.5: download through installation==
This example shows one typical installation workflow: the site does not use RSQL, it uses the RACF external authorizer, and it does not have its own FUNU. The IBM system MQ loadlib is <code>MQSERIES.SCSQLOAD</code> (this is typical in z/OS).
The high-level qualifier in this example is MYBUILD.

The other item needed is the member name <code>MYBLDOB</code>, which is chosen arbitrarily for this example, and the following DSNs:
<ul>
<li><code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKOBJLIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB</code>
<li><code>MYBUILD.M204V75.LOCAL.OBJLIB</code>
<li><code>MYBUILD.M204V75.LOADLIB</code>
</ul>
===Build RKOBJLIB===
<ol>

<li>Download the object library (M204V75.OBJ) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>.

<li>Download the macro library (M204V75_ZOS.MAC) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDOB in my TSO library from a [http://sirius-software.com/download/new204lb.txt download] of the job stream to build the object and macro libraries, using the following at the end of the job stream:
<p class="code">//BLD EXEC NEW204LB,VERSION=75,
// HLQ=MYBUILD,
// OBJINP=MYBUILD.M204V75.RKOBJLIB.DISTRIB,
// MACINP=MYBUILD.M204V75.RKMACLIB.DISTRIB
</p>

<li>Run MYBLDOB from my TSO library. MYBLDOB deletes and then creates <code>MYBUILD.M204V75.RKOBJLIB</code> and
<code>MYBUILD.M204V75.RKMACLIB</code>.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDDS in my TSO library by copying
the job stream from [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], using the following at the end of the job stream:
<p class="code">//BLD EXEC JALINSP,
// HLQ=MYBUILD
</p>

<li>Run MYBLDDS from my TSO library. MYBLDDS allocates an empty loadlib data set for the Model 204 load modules, an empty local source library for the customized source files, and an empty local object library for the customized local object modules, with the following names: <code>MYBUILD.M204V75.LOADLIB</code>, <code>MYBUILD.M204.LOCAL.SRCLIB</code>, and <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.

</ol>

===Assemble and link===
<ol >
<li>Copy the RACFPARM source to the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and make any necessary modifications.
<li>Create the member JASMSECJ in my TSO library by copying
the job stream from [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], using the following at the end of the job stream:
<p class="code">//ASM EXEC JASMP,HLQ=MYBUILD,
// MEM=RACFPARM
</p></li>

<li>Run JASMSECJ from my TSO library; this assembles the RACFPARM source file in the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and stores the object in <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.</li>

<li>Copy the member LKONLNJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and customize LKONLN as follows:
<ul>
<li>Make these changes at the top of the job stream:
<p class="code">// JCLLIB ORDER=(MYBUILD.M204V75.RKOBJLIB)
//LKONLN EXEC LKM204P,
// HLQ=MYBUILD,
// MQ=MQSERIES.SCSQLOAD
</p></li>
<li>Uncomment the <code>INCLUDE</code> line for LKNOSONL (that is, without RSQL).</li>
<li>Uncomment the <code>INCLUDE</code> line for MQ.</li>
<li>Uncomment the <code>INCLUDE</code> line for my external authorizer module (such as RACFOS and RACFPARM).</li>
<li>Submit the LKONLNJ job from my TSO library; this creates ONLINE (and BATCH204 alias) in MYBUILD.M204V75.LOADLIB.</li>
</ul></li>

<li>Perform a simple smoke test: run BATCH204 with 'DISPLAY ZAPS' and 'ROCKET' commands.</li>

<li>To link the utilities, copy member LKALLUTJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and see all <code><<</code> lines to customize for my site; submit the LKALLUTJ job.</li>

<li>Ensure that any JCL that performs deferred index sorting for <var class="product">Model 204</var> version 7.5
(typically, FLOD jobs) uses the new <code>MYBUILD.M204V75.LOADLIB</code> for the E15 (OI15OS) and E35 (OI35OS) sort exits.</li>
</ol>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VSE]]</li>
</ul>

[[Category:Installation]]

Model 204 installation on IBM z/OS

2016-11-02T22:09:25Z

MCosta: /* Allocating data sets (JALINSJ job stream) */

<div class="toclimit-3">__TOC__</div>
==Overview==
This topic describes the steps required to upgrade to Rocket Model 204 version 7.5 or higher, on the IBM<sup>®</sup> z/OS<sup>®</sup> operating system.

The new version number is referred to as <var class="term">x</var>.<var class="term">y</var>, where <var class="term">x</var>.<var class="term">y</var> can be 7.5 or higher.

For information on the new features available in each version, as well as any compatibility issues, see the [[Release_notes#Release_notes.2C_wishlists.2C_and_punch_lists|Model 204 release notes]].

If you are skipping any versions when upgrading (such as upgrading from 7.5 to 7.7), be sure to read the release notes for those versions as well (such as 7.6).

==Before you begin==
<ul>
<li>You must have either a [[Rocket M204 user ID]] or a preexisting user ID to download the installation files.</li>

<li>The object library has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. <br />(The preapplied zap will authorize Model 204 itself and any separately purchased products such as [[SirScan]].)</li>

<li>The object library also has the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to run [[RockZap]] to apply any new maintenance when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version <var class="term">x</var>.<var class="term">y</var> files.
<p>Each step links to a section with detailed instructions. Note that some steps (such as assembling custom modules) might not apply to your installation. Once you have started, you can proceed directly through the steps (detail sections are consecutive) or return to this list for context.</p>
For a 7.5 example, see [[#Example_workflow_for_7.5:_download_through_installation|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#Build the Model 204 object and macro libraries|Build]] the Model 204 object and macro libraries:
<ol style="list-style-type:lower-alpha;">
<li>Use your [[Rocket M204 user ID]] to [[#downloading|download]] the Model 204 object library and the Model 204 macro library.</li>

<li>[[#uploading|Upload]] the downloaded components to the z/OS system on the IBM mainframe.</li>

<li>[[#bldLibs|Build]] the RKOBJLIB object library and RKMACLIB macro library. (Once you have built these libraries, do not modify them.)</li>
</ol>
</li>

<li>Submit the job to [[#allocating|allocate the other data sets]] required for installation.</li>

<li>Modify and assemble these modules if you use them:
<ol style="list-style-type:lower-alpha;">
<li>Your [[#Assemble FUNU and optional MSGU|user $functions (FUNU)]] and, optionally, MSGU.
<li>An external authorizer (such as RACF) for Model 204. [[#secparm|Set up the security module]], including assembling the <i>xxxx</i>PARM security module (such as RACFPARM). The object file is then stored in your local object library.</li>
<li>[[#ul_db2|UL/DB2 interface]]: preprocess and assemble the USQL module.</li>
<li>Other customized modules, such as CDTB. Modify them as needed and [[#asm|assemble]] them.
</ol></li>

<li>Link the [[#lkonln|ONLINE]] load module.</li>

<li>If you use the [[#link_ifam1|IFAM1 and IFAM4]] load modules, link them.</li>

<li>Link the <var class="product">Model 204</var> [[#lkutils|utility load modules]].</li>

<li>If you use the [[#cics|CICS interface]], customize it, and then assemble and link the CICS modules.</li>

<li>If you use the [[#tso|TSO]] interface, assemble and link-edit the TSO source modules.</li>

<li>Link the [[#CRAM|CRAM]] load modules as needed.</li>

<li>If you use [[#softspy|SoftSpy]], upgrade it for <var class="term">x</var>.<var class="term">y</var>.</li>

<li>[[#verify|Verify]] the installation.</li>
</ol>

==Build the Model 204 object and macro libraries==
To build the object and macro libraries, you must download the object library and macro library; upload each library to the mainframe; and copy, modify, and run the NEW204LB job.
===Object and macro libraries===
{{Template:Model 204 installation components}}

===<b id="downloading"></b>Downloading===
<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download.</li>
</ol>

===<b id="uploading"></b>Uploading===
Once the object file and macro library are downloaded to your workstation, upload them to the z/OS system on the IBM mainframe. You can use any file transfer mechanism, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for object and macro libraries</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for object and macro libraries</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

For details on how to download and upload, see [[Downloading and uploading Model 204 installation components]].

===<b id="bldLibs"></b>Building the object and macro libraries (NEW204LB job stream)===

After you upload the object and macro library input streams to the mainframe, build the object and macro libraries:

<ol>
<li>Access the [http://sirius.sirius-software.com/download/new204lb.txt NEW204LB job stream] text file.

<li>Copy the job stream file into a local TSO library for editing.

<li>On the first line of the job stream, modify the JOB card according to your local job card parameters.

<li>On the final four lines, marked <code>2 <<</code> ... <code>5 <<</code> on the right:
<ol style="list-style-type:lower-alpha;">
<li>Modify the <code>VERSION=</code> parameter, specifying the two-digit version of <var class="product">Model 204</var> you are installing, such as 75.
<li>Modify the <code>HLQ=</code> parameter, specifying the high-level qualifiers of all <var class="product">Model 204</var> installation data sets.
<li>Modify the <code>OBJINP=</code> parameter, using the DSN of the object library input file that you uploaded to the mainframe.
<li>Modify the <code>MACINP=</code> parameter, using the DSN of the macro library input file that you uploaded to the mainframe.
</ol>
<li>Submit the <code>NEW204LB</code> job to build the object library ("RKOBJLIB") and macro library ("RKMACLIB") on your z/OS system.</li>
</ol>

<div id="notouch"></div>
<p class="warn"><b>Attention:</b> Once you have built RKOBJLIB and RKMACLIB on your z/OS system, <b>do not</b> modify them in any way.<br />

For example, <b>do not</b> store other members into the object library; it should only contain the members as supplied in a download from the web site. Place object files that you might assemble (such as FUNU or RACFPARM) into your local object library.</p>

====RKOBJLIB README file====
README, a member of RKOBJLIB, contains details on the object files and installation steps. Once you have built RKOBJLIB, you can use README as an installation checklist if desired.

<div id="allocating"></div>

==Allocate the data sets for Model 204 upgrading==

There are three data sets used when upgrading to Model 204 7.<var class="term">x</var>:

<ul>
<li>data set for the Model 204 load modules
<li>data set for the local source library
<li>data set for the local object library
</ul>
The data set for the load modules will contain, after linking, the modules for the Model 204 product, including: ONLINE, IFAM1, and IFAM4.

The local source library is used to store the customized source for modules such as FUNU, MSGU, and ACF2PARM, RACFPARM, or TOPSPARM.

When the source is assembled, it is stored in the local object library.

One of the members of the RKOBJLIB object library is named [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], which is a job stream to allocate data sets for the installation. <code>JALINSJ</code> contains information about naming conventions for the data sets.

===Allocating data sets (JALINSJ job stream)===

<ol>
<li>Copy <code>JALINSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JALINSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to the numbered steps at the end of the comment section.
</ul>
</li>
<li>Submit the <code>JALINSJ</code> job.
This job will allocate the basic installation datasets (the first two will be deleted before being allocated):
<ul>
<li>hlq.M204V77.LOADLIB - the library for linking most load modules</li>
<li>hlq.M204V77.LOCAL.OBJLIB - the library for assembling optional object files: RACFPARM, FUNU, etc.</li>
<li>hlq.M204.LOCAL.SRCLIB - the library in which you store source for assembling modules such as FUNU and xxxPARM. Note that this DSN does <var class="term">not</var> have a version identifier (such as V75, V76, and so on). This library is only allocated if it does not already exist. It is used for installing all versions of Model 204.</li>
</ul>
</li>
</ol>

<div id="FUNU"></div>

==Assemble FUNU and optional MSGU==


This section lists installation considerations if you have your own user-written $functions module (FUNU).

<p class="note"><b>Note:</b> If you have your own FUNU or MSGU module, you must assemble it <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.</p>

Assemble your FUNU and/or optional MSGU modules with the following steps:
<ol>
<li>Modify FUNU for 64-bit addressing considerations and store the modified source in your local source library.
<div id="FUNU_7.5"></div>
<p>FUNU changes for 7.x are:</p>
{{Template:FUNU changes for 7.5}}
</li>
<li>If you have any user-defined messages (MSGU), store them in your local source library.</li>

<li>Assemble FUNU (and MSGU, if applicable), with the output object file stored in your local object library.
<ol style="list-style-type:lower-alpha;">

<li>Copy the source from RKMACLIB into your local source library.</li>

<li>After making any changes required for this version of <var class="product">Model 204</var>, run <code>JASMJ</code> to [[#asm|assemble]] FUNU into your local object library.</li>

<li>If needed, modify and run <code>JASMJ</code> to assemble MSGU.</li>

<p>You do <b>not</b> need to insert any INCLUDE statements for either FUNU nor MSGU; they are already present in the INCLUDE member (LKSQLONL or LKNOSONL) provided in the downloaded object library.</p></li>
</ol>
</li>
</ol>

<div id="secparm"></div>
==Set up the security module==

This section describes how to install a [[Security interfaces overview|security interface]] such as CA-ACF2, RACF, or CA-Top Secret.

<ol>
<li>Review the Model 204 installation section for your interface and complete all of the steps:
<ul>
<li>[[CA-ACF2_MVS_interface#Installing_the_Model_204_CA-ACF2_MVS_Interface|CA-ACF2 (MVS)]]</li>
<li>[[CA-ACF2_VM_interface#Installing_the_CA-ACF2_VM_Interface|CA-ACF2 (VM)]]</li>
<li>[[Security_Server_(formerly_RACF)_interface#Installing_the_Security_Server_Interface|RACF]]</li>
<li>[[CA-Top_Secret_interface#Installing_the_CA-Top_Secret_Interface|CA-Top Secret]]</li>
</ul>
</li>
<li> [[#asm|Assemble]] the security module:
ACF2PARM, RACFPARM, or TOPSPARM.</li>
<li>Optional. Link the security module as described below if you want it to be dynamically loaded.</li>
</ol>

===Linking the security module (LKSECRJ job stream)===

Dynamic loading lets you modify the security parameters without having to relink Model 204, which would be required if the parameter module were linked into Model 204 directly.

If you want Model 204 to dynamically load your security module during Model 204 ACF2, RACF, or TOPSECRET interface initialization, then you must link the corresponding security parameter module.

One of the members of the RKOBJLIB object library is <code>LKSECRJ</code>, a job stream to link-edit the security parameter module.

<ol>
<li>Copy [[Model 204 security module link job stream for IBM z/OS|LKSECRJ]] into a local TSO library.
<li>Edit your copy of <code>LKSECRJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKSECRJ</code> job to link-edit the security parameter module (ACF2PARM, RACFPARM, or TOPSPARM).
</ol>
<div id="ul_db2"></div>

==Install the UL/DB2 interface (JAUSQLJ job stream)==

To support the [[UL/DB2]] interface, USQL code is delivered in source for you to preprocess for your version of DB2. If you use the UL/DB2 interface, assemble the source as described below <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.

<ol>
<li>Copy [[Model 204 UL/DB2 job stream for IBM z/OS|JAUSQLJ]] into a local TSO library.
<li>Edit your copy of <code>JAUSQLJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>on the line after <code>EXEC JAUSQLP</code> at the bottom of the job stream set:
<ul>
<li><code>HLQ=</code>high level qualifier of all Model 204 installation DSNs</li>
<li><code>DB2HLQ=</code>high level qualifier for your DB2 maclib.</li>
</ul>
</ul>
</ul>
<li>Submit the <code>JAUSQLJ</code> job to preprocess and assemble the USQL module. The JAUSQLJ job executes the following two steps:
<ul>
<li>Run USQL (contained in RKMACLIB) through the DB2 preprocessor to process the EXEC SQL statements. This step produces two data sets: the DBRM and the expanded USQL source. The DBRM is saved as USQLDBRM in the local object library. The expanded USQL source is passed to step two for assembly.</li>
<li>Assemble expanded USQL source into local object library.</li>
</ul>
<li>Bind the DBRM as the plan with a site-specific plan name.</li>
</ol>

<div id="asm"></div>

==Assemble customized modules into your local object library (LOCAL.OBJLIB)==

Copy the customized source module (such as, FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2) from your current release into your local source library, if you have not already done so.
The local source library is not version-specific, so modules copied into it can be used for future installations.

One of the members of the RKOBJLIB object library is [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], a job stream to assemble a member from your Model 204 local source library into your local object library (LOCAL.OBJLIB).

===Assembling customized modules (JASMJ job stream)===
<ol>
<li>Copy <code>JASMJ</code> into a local TSO library.
<li>Edit your copy of <code>JASMJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the ASM line at the bottom of the job stream
</ul>
<li>Provide the member name to assemble (such as FUNU, MSGU, RACFPARM) on the <code>MEM=</code> line.
</ul>
<li>Submit the <code>JASMJ</code> job to assemble the module into your local object library.
</ol>

<div id="lkonln"></div>

==Link the Model 204 ONLINE load module==


<div id="onlnTable"></div>
<blockquote class="note">
<p><b>Notes:</b> </p>
<ul>
<li>If you use customized modules (such as FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2), you must [[#FUNU_7.5|modify]] them (if needed) and [[#asm|assemble]] them <b>before you link the ONLINE/IFAM1/IFAM4</b> load modules.</li>
<li>There is not a separate link step for BATCH204. It is not maintained as a separate module; the same module as ONLINE is used, with a BATCH204 alias.</li>
<li>The INCLUDE TCPLIB(SNMPGSYS) statement for Horizon TCP/IP in the Online-link-edit job is no longer required and has been eliminated.</li>
<li>A number of INLUDE LELIB(CEE*) statements have also been eliminated from the Online-link-edit job. These were required to support several mathematical $functions but those $functions have been rewritten in Assembly language and are now automatically part of the Online load module.</li>
<li>The INCLUDE BLOCKPRT(IEFSD095) statement is required if block printing on separator pages is desired. Usually the BLOCKPRT DD points to DSN=SYS1.AOSB0.</li>
<li>As of Model 204 version 7.7, FastUnload is linked as an alias of the ONLINE load module, not as a standalone module. The FastUnload code is fully integrated into the Model 204 nucleus.</li>
</ul>
</blockquote>

One of the members of the RKOBJLIB object library is [[Model 204 ONLINE link job stream for z/OS|LKONLNJ]], which is a job stream to link the <var class="product">Model 204</var> ONLINE load module.

<div id="LKONLNJ"></div>
===Linking ONLINE (LKONLNJ job stream)===


<ol>
<li>Copy the <code>LKONLNJ</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKONLNJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with 1-4 followed by <code><<</code>. The numbers correspond to numbered steps in the comments.
<li>As needed, edit the lines after <code>SYSLIN DD *</code> that are marked with <code><<</code>. See the comments at the top of the <code>SYSLIN</code> sections (<b>A</b>-<b>C</b>) for instructions.
</ul>
<li>Submit the <code>LKONLNJ</code> job to link the ONLINE load module.
</ol>

Concise editing instructions are provided in the <code>LKONLNJ</code> file itself. More details about link-editing the ONLINE load module are provided in the following table.

<table class="thJustBold">
<tr><th>1</th><td>You must specify a value for the HLQ symbolic parameter in the EXEC LKM204P statement. The value of HLQ corresponds to the high-level qualifier used for the DSN for:
<ul>
<li> the downloaded object library</li>
<li>the Model204 load library</li>
<li>other data sets that are required for installation</li>
</ul></td></tr>
<tr><th>2</th><td>One of the modifications is <b>always required</b>, based on whether the ONLINE is to use RSQL (for Connect*) or not.

Uncomment only one of the following statements:
<ul>
<li>To link an ONLINE that uses RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKSQLONL</b>) statement.
<li>To link an ONLINE that does not use RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKNOSONL</b>) statement.
</ul>
</td></tr>
<tr><th>3</th><td>If you use an external authorizer, such as RACF or ACF2, you must:
<ul>
<li>[[#asm|Assemble the xxxPARM]] for your external authorizer to add the object file (such as RACFPARM or ACF2PARM) to your local object library.
<li>In the SYSLIN DD *, uncomment the appropriate INCLUDE statement(s) for your external authorizer. <blockquote class="note"><b>Notes:</b>
<ul><li>Uncomment either the "static" or "dynamic" INCLUDE statement, depending on your configuration.<li>If you use ACF2, there are two INCLUDE statements to be uncommented; one refers to your system ACF2 library. You must also provide the DSN for the ACF2 library in the ACF2 symbolic parameter in the EXEC LKM204P statement.</ul>
</blockquote>
</ul>
</td></tr>

<tr><th>4</th><td>If you have other programs that you assemble for your Model 204 ONLINE module, for example, [[#FUNU|FUNU]], assemble them into your local object library. You <strong>do not</strong> need to add additional INCLUDE statements for FUNU or other locally assembled object files; they are already in the include streams from RKOBJLIB.
</td></tr>

<tr><th>5</th><td>If you have an MQ series load library, set the MQ symbolic parameter to the correct DSN in the EXEC LKM204P statement. This allows you to use the MQ Series feature of <var class="product">Model 204</var>, either if you are already authorized for it, or to support a trial of it, without requiring relinking of the load module. You must also uncomment the INCLUDE MQ statement in the SYSLIN input.
</td></tr>

</table>

<div id="link_ifam1"></div>
<div id="link_ifam4"></div>

==Link the Model 204 IFAM1 and IFAM4 load modules==


Among the members of the RKOBJLIB object library are:
<ul>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM1_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM1_link_job_stream_for_IBM_z/OS&target=blank LKIFAM1J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM1 load module</li>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM4_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM4_link_job_stream_for_IBM_z/OS&target=blank LKIFAM4J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM4 load module.</li>
</ul>

===Linking IFAM1 (LKIFAM1J job stream)===
<ol>
<li>Copy the <code>LKIFAM1J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM1J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM1J</code> job to link the IFAM1 load module.
</ol>

===Linking IFAM4 (LKIFAM4J job stream)===
<ol>
<li>Copy the <code>LKIFAM4J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM4J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM4J</code> job to link the IFAM4 load module.
</ol>

<div id="lkutils"></div>


==Link the Model 204 utility load modules==


Following are the utility load modules to be linked:
<table>
<tr class="head">
<th>Module</th><th>Description</th>
</tr>
<tr><td><b>AUDIT204</b></td> <td> Generate an audit trail from the CCAJRNL or CCAJLOG data sets, with report stats and analysis</td></tr>
<tr><td><b>BATCH2</b></td> <td>Enable batch users to access a Model 204 Online that is running in a separate region</td></tr>
<tr><td><b>HASH15</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>HASH35</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>MERGEJ</b></td> <td>Media recovery journal merge utility</td></tr>
<tr><td><b>M204LIST</b></td> <td></td></tr>
<tr><td><b>M204XREF</b></td> <td></td></tr>
<tr><td><b>OI15OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>OI35OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>UTILC</b></td> <td>Information from checkpoint stream</td></tr>
<tr><td><b>UTILJ</b></td> <td>Journal/Audit trail debug utility</td></tr>
<tr><td><b>ZBLDTAB</b></td> <td>Build prototype password table</td></tr>
<tr><td><b>ZCTLTAB</b></td> <td>Convert CCASTAT for the Password Expiration feature</td></tr>
</table>

===Linking the utility load modules (LKALLUTJ job stream)===

One of the members of the RKOBJLIB object library is [[Model 204 utilities link job stream for IBM z/OS|LKALLUTJ]], a job stream to link the <var class="product">Model 204</var> utility load modules.
<ol>
<li>Copy <code>LKALLUTJ</code> into a local TSO library.
<li>Edit your copy of <code>LKALLUTJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKALLUTJ</code> job to link the utility load modules.
</ol>

<div id="lkcram"></div>

==<b id="cics"></b>Install the CICS interface==
The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.

For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 4.1, 4.2 and 5.3.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===Installation steps===
<ol>
<li>[[#Customizing the CICS interface|Customize the interface]] by editing the CICFG copy member.

<li>[[#Update the CICS System Definition (CSD)|Update the CICS System Definition (CSD)]] using one of the following methods:
<ul>
<li>Resource Definition Online (CEDA). The supplied member CEDAM204 in RKMACLIB provides an example of the required PCT, PPT, and PLT definitions.</li>

<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
</ul>
<li>[[#CICS_alloc|Allocate]] a CICS user library.</li>

<li>[[#CICS_asm|Assemble and link]] the CICS modules.</li>
</ol>

====Customizing the CICS interface====
To customize the CICS interface, copy the CICFG copy member from RKMACLIB into your local source library and edit it as needed.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface#Use the CICS Standard Mapping Service|Use the CICS Standard Mapping Service]].</p>

====Updating the CICS System Definition (CSD)====
You can update the CSD by using either CEDA or the DFHCSDUP utility and the CEDAM204 member of RKMACLIB. Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>
<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. It is never
invoked with a transaction ID from a terminal.</td> <td /> <td /><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td /> <td /></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>
CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using the CEDAM204 member, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
RSL(PUBLIC)
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
RSL(PUBLIC)
.
.
.

CEDA CHeck GRoup(group_name) </p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

<div id="CICS_alloc"></div>

====Allocating a CICS user library (JALCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS user library allocation job stream for IBM z/OS|JALCICSJ]], a job stream to allocate an empty CICS user library. You must allocate the CICS user library before assembling and linking the CICS modules.
<ol>
<li>Copy <code>JALCICSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JACICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.</li>
<li>Supply your installation high level qualifier(s) in the following lines marked with <<:
<ul>
<li>for hlq in the JCLLIB ORDER=(hlq.... line after the JOB card </li>
<li>after HLQ=, on the line after EXEC LKALLUTP at the bottom of the job stream </li>
</ul>
</ul>
</li>
<li>Submit the <code>JALCICSJ</code> job to allocate the CICS user library.</li>
</ol>

<div id="CICS_asm"></div>

====Assembling and linking CICS modules (LKCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS module assembly job stream for IBM z/OS|LKCICSJ]], a job stream to assemble and link the <var class="product">Model 204</var> CICS modules.
<ol>
<li>Copy <code>LKCICSJ</code> into a local TSO library.
<li>Edit your copy of <code>LKCICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your Model 204 installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC JALCICSP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKCICSJ</code> job to assemble and link the CICS module.
</ol>

<div id="tso"></div>

==Install the TSO interface==

<p class="note"><b>Note:</b> It is not necessary to install the TSO interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

The Model 204 TSO Interface enables the TSO user to communicate with a Model 204 Online.

The TSO Interface consists of two assembly language modules, TSFS and TSUL, whose source is located in the macro library. The modules are completely reentrant, reusable, and refreshable.

Installation requires assembly and link-editing of the TSO source modules using the [[Model 204 TSO module assembly job stream for IBM z/OS|LKTSOJ]] job stream from the RKOBJLIB library.

===Assembling and linking the TSO modules===

<ol>
<li>If you are using TSO extensions, modify TSFS in the local source library by changing:
<p class="code">&TSOV SETC 'TSO' </p>
<p>to:</p>
<p class="code">&TSOV SETC 'TSOE'</p></li>
<p>Changing the &TSOV SETC 'TSO' code in TSFS causes assembly of the NOEDIT form of the TPUT macro in the TSFS module. The NOEDIT form, required for 3270 extended data streams, allows proper handling of colors or highlighting in TSO extensions. NOEDIT is recommended for all TSO extensions.</p>
<li>Copy <code>LKTSOJ</code> from the RKOBJLIB object library into a local TSO library.
<li>Edit your copy of <code>LKTSOJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKTSOJ</code> job to assemble and link the TSO modules.
</ol>

==CRAM==
<blockquote class="note"><b>Notes:</b> CRAM SVC installation is deprecated in version 7.5 and higher. The following instructions are for [[Defining the user environment (CCAIN)#CRAM_options for z.2FOS|CRAM-XDM]].

<p>It is recommended that you install the version of CRAM-XDM that corresponds to the version of Model 204 you are installing. However, you could run a 7.5 version of CRAM-XDM with 7.x Model 204, such as for testing.</p></blockquote>

To install the CRAM load modules, proceed with the following steps:

<ol>
<li>Before linking the CRAM load modules, familiarize yourself with [[Defining_the_user_environment_(CCAIN)#CRAM_.28IODEV.3D11.2C_23.2C_29.29|CRAM]]: what it does, which facilities require it, and available CRAM options.

<li>Install 7.<var class="term">x</var> CRAM-XDM by running [[Model 204 CRAM link job stream for IBM z/OS|LKCRAMJ]], the job stream to link the CRAM load modules. LKCRAMJ is found in RKOBJLIB.

<p>CICS interface users: Unlike version 7.4 CRAM-XDM, the step in the link JCL for the CRAM modules specifies the <code>RENT</code> value for <code>PARM</code>. Read the Note in [[CICS interface#Running with storage protection on|Running with storage protection on]] for details.</p></li>
</ol>

<p class="note"><b>Note:</b> After installation, you will need to perform additional tasks to [[Defining the user environment (CCAIN)#Implementing CRAM-XDM usage for z/OS operating systems|implement CRAM-XDM]].</p>

<div id="softspy"></div>

==Upgrade SoftSpy==

To upgrade SoftSpy for version 7.<var class="term">x</var>, download, upload, and restore the SoftSpy procedure file, SPYPROC, which is distributed in a dump format.

<ol>
<li>Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>
For detailed instructions, see [[Downloading and restoring SOUL files#How can the dump file be uploaded to the mainframe?|Downloading and restoring SOUL files]].

For details on the SoftSpy installation, including customization and System Manager considerations, see the [[SoftSpy installation guide]].

==RSQL maintenance==
RKOBJLIB also contains the LKMAINTJ job stream. LKMAINTJ is used to relink the ONLINE, IFAM1, and IFAM4 load modules when a maintenance version of the RSQL (and sometimes EVCP) object files is distributed on the [https://m204.rocketsoftware.com/maint/fixlist Model 204 maintenance page].

When and if there are any fixes for them, the most recent versions of these object files will appear as <code>'Model 204 .. RSQL'</code> and <code>'Model 204 .. EVCP'</code> with your desired version number.

The description of the RSQL and EVCP fixes will be contained in the entire set of Model 204 fixes, which you can download from the maintenance page by clicking a 'Download Zaps' link. RSQL and EVCP fixes are listed in the zap file with the characters <code>'*77Lxx'</code> at the start of their comment boxes.

<div id="verify"></div>

==Verify Model 204 <I>x</I>.<I>y</I> on your system==
To perform an initial verification that your upgrade to 7.<var class="term">x</var> was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized M204 products (including 7.<var class="term">x</var>) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.<var class="term">x</var> zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.<var class="term">x</var></code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL <var class="term">x</var></code> on its menu screens.</td></tr>
</table>

==Example workflow for 7.5: download through installation==
This example shows one typical installation workflow: the site does not use RSQL, it uses the RACF external authorizer, and it does not have its own FUNU. The IBM system MQ loadlib is <code>MQSERIES.SCSQLOAD</code> (this is typical in z/OS).
The high-level qualifier in this example is MYBUILD.

The other item needed is the member name <code>MYBLDOB</code>, which is chosen arbitrarily for this example, and the following DSNs:
<ul>
<li><code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKOBJLIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB</code>
<li><code>MYBUILD.M204V75.LOCAL.OBJLIB</code>
<li><code>MYBUILD.M204V75.LOADLIB</code>
</ul>
===Build RKOBJLIB===
<ol>

<li>Download the object library (M204V75.OBJ) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>.

<li>Download the macro library (M204V75_ZOS.MAC) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDOB in my TSO library from a [http://sirius-software.com/download/new204lb.txt download] of the job stream to build the object and macro libraries, using the following at the end of the job stream:
<p class="code">//BLD EXEC NEW204LB,VERSION=75,
// HLQ=MYBUILD,
// OBJINP=MYBUILD.M204V75.RKOBJLIB.DISTRIB,
// MACINP=MYBUILD.M204V75.RKMACLIB.DISTRIB
</p>

<li>Run MYBLDOB from my TSO library. MYBLDOB deletes and then creates <code>MYBUILD.M204V75.RKOBJLIB</code> and
<code>MYBUILD.M204V75.RKMACLIB</code>.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDDS in my TSO library by copying
the job stream from [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], using the following at the end of the job stream:
<p class="code">//BLD EXEC JALINSP,
// HLQ=MYBUILD
</p>

<li>Run MYBLDDS from my TSO library. MYBLDDS allocates an empty loadlib data set for the Model 204 load modules, an empty local source library for the customized source files, and an empty local object library for the customized local object modules, with the following names: <code>MYBUILD.M204V75.LOADLIB</code>, <code>MYBUILD.M204.LOCAL.SRCLIB</code>, and <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.

</ol>

===Assemble and link===
<ol >
<li>Copy the RACFPARM source to the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and make any necessary modifications.
<li>Create the member JASMSECJ in my TSO library by copying
the job stream from [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], using the following at the end of the job stream:
<p class="code">//ASM EXEC JASMP,HLQ=MYBUILD,
// MEM=RACFPARM
</p></li>

<li>Run JASMSECJ from my TSO library; this assembles the RACFPARM source file in the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and stores the object in <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.</li>

<li>Copy the member LKONLNJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and customize LKONLN as follows:
<ul>
<li>Make these changes at the top of the job stream:
<p class="code">// JCLLIB ORDER=(MYBUILD.M204V75.RKOBJLIB)
//LKONLN EXEC LKM204P,
// HLQ=MYBUILD,
// MQ=MQSERIES.SCSQLOAD
</p></li>
<li>Uncomment the <code>INCLUDE</code> line for LKNOSONL (that is, without RSQL).</li>
<li>Uncomment the <code>INCLUDE</code> line for MQ.</li>
<li>Uncomment the <code>INCLUDE</code> line for my external authorizer module (such as RACFOS and RACFPARM).</li>
<li>Submit the LKONLNJ job from my TSO library; this creates ONLINE (and BATCH204 alias) in MYBUILD.M204V75.LOADLIB.</li>
</ul></li>

<li>Perform a simple smoke test: run BATCH204 with 'DISPLAY ZAPS' and 'ROCKET' commands.</li>

<li>To link the utilities, copy member LKALLUTJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and see all <code><<</code> lines to customize for my site; submit the LKALLUTJ job.</li>

<li>Ensure that any JCL that performs deferred index sorting for <var class="product">Model 204</var> version 7.5
(typically, FLOD jobs) uses the new <code>MYBUILD.M204V75.LOADLIB</code> for the E15 (OI15OS) and E35 (OI35OS) sort exits.</li>
</ol>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VSE]]</li>
</ul>

[[Category:Installation]]

Model 204 installation on IBM z/OS

2016-11-02T22:08:34Z

MCosta: /* Allocating data sets (JALINSJ job stream) */

<div class="toclimit-3">__TOC__</div>
==Overview==
This topic describes the steps required to upgrade to Rocket Model 204 version 7.5 or higher, on the IBM<sup>®</sup> z/OS<sup>®</sup> operating system.

The new version number is referred to as <var class="term">x</var>.<var class="term">y</var>, where <var class="term">x</var>.<var class="term">y</var> can be 7.5 or higher.

For information on the new features available in each version, as well as any compatibility issues, see the [[Release_notes#Release_notes.2C_wishlists.2C_and_punch_lists|Model 204 release notes]].

If you are skipping any versions when upgrading (such as upgrading from 7.5 to 7.7), be sure to read the release notes for those versions as well (such as 7.6).

==Before you begin==
<ul>
<li>You must have either a [[Rocket M204 user ID]] or a preexisting user ID to download the installation files.</li>

<li>The object library has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. <br />(The preapplied zap will authorize Model 204 itself and any separately purchased products such as [[SirScan]].)</li>

<li>The object library also has the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to run [[RockZap]] to apply any new maintenance when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version <var class="term">x</var>.<var class="term">y</var> files.
<p>Each step links to a section with detailed instructions. Note that some steps (such as assembling custom modules) might not apply to your installation. Once you have started, you can proceed directly through the steps (detail sections are consecutive) or return to this list for context.</p>
For a 7.5 example, see [[#Example_workflow_for_7.5:_download_through_installation|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#Build the Model 204 object and macro libraries|Build]] the Model 204 object and macro libraries:
<ol style="list-style-type:lower-alpha;">
<li>Use your [[Rocket M204 user ID]] to [[#downloading|download]] the Model 204 object library and the Model 204 macro library.</li>

<li>[[#uploading|Upload]] the downloaded components to the z/OS system on the IBM mainframe.</li>

<li>[[#bldLibs|Build]] the RKOBJLIB object library and RKMACLIB macro library. (Once you have built these libraries, do not modify them.)</li>
</ol>
</li>

<li>Submit the job to [[#allocating|allocate the other data sets]] required for installation.</li>

<li>Modify and assemble these modules if you use them:
<ol style="list-style-type:lower-alpha;">
<li>Your [[#Assemble FUNU and optional MSGU|user $functions (FUNU)]] and, optionally, MSGU.
<li>An external authorizer (such as RACF) for Model 204. [[#secparm|Set up the security module]], including assembling the <i>xxxx</i>PARM security module (such as RACFPARM). The object file is then stored in your local object library.</li>
<li>[[#ul_db2|UL/DB2 interface]]: preprocess and assemble the USQL module.</li>
<li>Other customized modules, such as CDTB. Modify them as needed and [[#asm|assemble]] them.
</ol></li>

<li>Link the [[#lkonln|ONLINE]] load module.</li>

<li>If you use the [[#link_ifam1|IFAM1 and IFAM4]] load modules, link them.</li>

<li>Link the <var class="product">Model 204</var> [[#lkutils|utility load modules]].</li>

<li>If you use the [[#cics|CICS interface]], customize it, and then assemble and link the CICS modules.</li>

<li>If you use the [[#tso|TSO]] interface, assemble and link-edit the TSO source modules.</li>

<li>Link the [[#CRAM|CRAM]] load modules as needed.</li>

<li>If you use [[#softspy|SoftSpy]], upgrade it for <var class="term">x</var>.<var class="term">y</var>.</li>

<li>[[#verify|Verify]] the installation.</li>
</ol>

==Build the Model 204 object and macro libraries==
To build the object and macro libraries, you must download the object library and macro library; upload each library to the mainframe; and copy, modify, and run the NEW204LB job.
===Object and macro libraries===
{{Template:Model 204 installation components}}

===<b id="downloading"></b>Downloading===
<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download.</li>
</ol>

===<b id="uploading"></b>Uploading===
Once the object file and macro library are downloaded to your workstation, upload them to the z/OS system on the IBM mainframe. You can use any file transfer mechanism, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for object and macro libraries</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for object and macro libraries</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

For details on how to download and upload, see [[Downloading and uploading Model 204 installation components]].

===<b id="bldLibs"></b>Building the object and macro libraries (NEW204LB job stream)===

After you upload the object and macro library input streams to the mainframe, build the object and macro libraries:

<ol>
<li>Access the [http://sirius.sirius-software.com/download/new204lb.txt NEW204LB job stream] text file.

<li>Copy the job stream file into a local TSO library for editing.

<li>On the first line of the job stream, modify the JOB card according to your local job card parameters.

<li>On the final four lines, marked <code>2 <<</code> ... <code>5 <<</code> on the right:
<ol style="list-style-type:lower-alpha;">
<li>Modify the <code>VERSION=</code> parameter, specifying the two-digit version of <var class="product">Model 204</var> you are installing, such as 75.
<li>Modify the <code>HLQ=</code> parameter, specifying the high-level qualifiers of all <var class="product">Model 204</var> installation data sets.
<li>Modify the <code>OBJINP=</code> parameter, using the DSN of the object library input file that you uploaded to the mainframe.
<li>Modify the <code>MACINP=</code> parameter, using the DSN of the macro library input file that you uploaded to the mainframe.
</ol>
<li>Submit the <code>NEW204LB</code> job to build the object library ("RKOBJLIB") and macro library ("RKMACLIB") on your z/OS system.</li>
</ol>

<div id="notouch"></div>
<p class="warn"><b>Attention:</b> Once you have built RKOBJLIB and RKMACLIB on your z/OS system, <b>do not</b> modify them in any way.<br />

For example, <b>do not</b> store other members into the object library; it should only contain the members as supplied in a download from the web site. Place object files that you might assemble (such as FUNU or RACFPARM) into your local object library.</p>

====RKOBJLIB README file====
README, a member of RKOBJLIB, contains details on the object files and installation steps. Once you have built RKOBJLIB, you can use README as an installation checklist if desired.

<div id="allocating"></div>

==Allocate the data sets for Model 204 upgrading==

There are three data sets used when upgrading to Model 204 7.<var class="term">x</var>:

<ul>
<li>data set for the Model 204 load modules
<li>data set for the local source library
<li>data set for the local object library
</ul>
The data set for the load modules will contain, after linking, the modules for the Model 204 product, including: ONLINE, IFAM1, and IFAM4.

The local source library is used to store the customized source for modules such as FUNU, MSGU, and ACF2PARM, RACFPARM, or TOPSPARM.

When the source is assembled, it is stored in the local object library.

One of the members of the RKOBJLIB object library is named [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], which is a job stream to allocate data sets for the installation. <code>JALINSJ</code> contains information about naming conventions for the data sets.

===Allocating data sets (JALINSJ job stream)===

<ol>
<li>Copy <code>JALINSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JALINSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps at the end of the comments sections.
</ul>
</li>
<li>Submit the <code>JALINSJ</code> job.
This job will allocate the basic installation datasets (the first two will be deleted before being allocated):
<ul>
<li>hlq.M204V77.LOADLIB - the library for linking most load modules</li>
<li>hlq.M204V77.LOCAL.OBJLIB - the library for assembling optional object files: RACFPARM, FUNU, etc.</li>
<li>hlq.M204.LOCAL.SRCLIB - the library in which you store source for assembling modules such as FUNU and xxxPARM. Note that this DSN does <var class="term">not</var> have a version identifier (such as V75, V76, and so on). This library is only allocated if it does not already exist. It is used for installing all versions of Model 204.</li>
</ul>
</li>
</ol>

<div id="FUNU"></div>

==Assemble FUNU and optional MSGU==


This section lists installation considerations if you have your own user-written $functions module (FUNU).

<p class="note"><b>Note:</b> If you have your own FUNU or MSGU module, you must assemble it <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.</p>

Assemble your FUNU and/or optional MSGU modules with the following steps:
<ol>
<li>Modify FUNU for 64-bit addressing considerations and store the modified source in your local source library.
<div id="FUNU_7.5"></div>
<p>FUNU changes for 7.x are:</p>
{{Template:FUNU changes for 7.5}}
</li>
<li>If you have any user-defined messages (MSGU), store them in your local source library.</li>

<li>Assemble FUNU (and MSGU, if applicable), with the output object file stored in your local object library.
<ol style="list-style-type:lower-alpha;">

<li>Copy the source from RKMACLIB into your local source library.</li>

<li>After making any changes required for this version of <var class="product">Model 204</var>, run <code>JASMJ</code> to [[#asm|assemble]] FUNU into your local object library.</li>

<li>If needed, modify and run <code>JASMJ</code> to assemble MSGU.</li>

<p>You do <b>not</b> need to insert any INCLUDE statements for either FUNU nor MSGU; they are already present in the INCLUDE member (LKSQLONL or LKNOSONL) provided in the downloaded object library.</p></li>
</ol>
</li>
</ol>

<div id="secparm"></div>
==Set up the security module==

This section describes how to install a [[Security interfaces overview|security interface]] such as CA-ACF2, RACF, or CA-Top Secret.

<ol>
<li>Review the Model 204 installation section for your interface and complete all of the steps:
<ul>
<li>[[CA-ACF2_MVS_interface#Installing_the_Model_204_CA-ACF2_MVS_Interface|CA-ACF2 (MVS)]]</li>
<li>[[CA-ACF2_VM_interface#Installing_the_CA-ACF2_VM_Interface|CA-ACF2 (VM)]]</li>
<li>[[Security_Server_(formerly_RACF)_interface#Installing_the_Security_Server_Interface|RACF]]</li>
<li>[[CA-Top_Secret_interface#Installing_the_CA-Top_Secret_Interface|CA-Top Secret]]</li>
</ul>
</li>
<li> [[#asm|Assemble]] the security module:
ACF2PARM, RACFPARM, or TOPSPARM.</li>
<li>Optional. Link the security module as described below if you want it to be dynamically loaded.</li>
</ol>

===Linking the security module (LKSECRJ job stream)===

Dynamic loading lets you modify the security parameters without having to relink Model 204, which would be required if the parameter module were linked into Model 204 directly.

If you want Model 204 to dynamically load your security module during Model 204 ACF2, RACF, or TOPSECRET interface initialization, then you must link the corresponding security parameter module.

One of the members of the RKOBJLIB object library is <code>LKSECRJ</code>, a job stream to link-edit the security parameter module.

<ol>
<li>Copy [[Model 204 security module link job stream for IBM z/OS|LKSECRJ]] into a local TSO library.
<li>Edit your copy of <code>LKSECRJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKSECRJ</code> job to link-edit the security parameter module (ACF2PARM, RACFPARM, or TOPSPARM).
</ol>
<div id="ul_db2"></div>

==Install the UL/DB2 interface (JAUSQLJ job stream)==

To support the [[UL/DB2]] interface, USQL code is delivered in source for you to preprocess for your version of DB2. If you use the UL/DB2 interface, assemble the source as described below <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.

<ol>
<li>Copy [[Model 204 UL/DB2 job stream for IBM z/OS|JAUSQLJ]] into a local TSO library.
<li>Edit your copy of <code>JAUSQLJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>on the line after <code>EXEC JAUSQLP</code> at the bottom of the job stream set:
<ul>
<li><code>HLQ=</code>high level qualifier of all Model 204 installation DSNs</li>
<li><code>DB2HLQ=</code>high level qualifier for your DB2 maclib.</li>
</ul>
</ul>
</ul>
<li>Submit the <code>JAUSQLJ</code> job to preprocess and assemble the USQL module. The JAUSQLJ job executes the following two steps:
<ul>
<li>Run USQL (contained in RKMACLIB) through the DB2 preprocessor to process the EXEC SQL statements. This step produces two data sets: the DBRM and the expanded USQL source. The DBRM is saved as USQLDBRM in the local object library. The expanded USQL source is passed to step two for assembly.</li>
<li>Assemble expanded USQL source into local object library.</li>
</ul>
<li>Bind the DBRM as the plan with a site-specific plan name.</li>
</ol>

<div id="asm"></div>

==Assemble customized modules into your local object library (LOCAL.OBJLIB)==

Copy the customized source module (such as, FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2) from your current release into your local source library, if you have not already done so.
The local source library is not version-specific, so modules copied into it can be used for future installations.

One of the members of the RKOBJLIB object library is [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], a job stream to assemble a member from your Model 204 local source library into your local object library (LOCAL.OBJLIB).

===Assembling customized modules (JASMJ job stream)===
<ol>
<li>Copy <code>JASMJ</code> into a local TSO library.
<li>Edit your copy of <code>JASMJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the ASM line at the bottom of the job stream
</ul>
<li>Provide the member name to assemble (such as FUNU, MSGU, RACFPARM) on the <code>MEM=</code> line.
</ul>
<li>Submit the <code>JASMJ</code> job to assemble the module into your local object library.
</ol>

<div id="lkonln"></div>

==Link the Model 204 ONLINE load module==


<div id="onlnTable"></div>
<blockquote class="note">
<p><b>Notes:</b> </p>
<ul>
<li>If you use customized modules (such as FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2), you must [[#FUNU_7.5|modify]] them (if needed) and [[#asm|assemble]] them <b>before you link the ONLINE/IFAM1/IFAM4</b> load modules.</li>
<li>There is not a separate link step for BATCH204. It is not maintained as a separate module; the same module as ONLINE is used, with a BATCH204 alias.</li>
<li>The INCLUDE TCPLIB(SNMPGSYS) statement for Horizon TCP/IP in the Online-link-edit job is no longer required and has been eliminated.</li>
<li>A number of INLUDE LELIB(CEE*) statements have also been eliminated from the Online-link-edit job. These were required to support several mathematical $functions but those $functions have been rewritten in Assembly language and are now automatically part of the Online load module.</li>
<li>The INCLUDE BLOCKPRT(IEFSD095) statement is required if block printing on separator pages is desired. Usually the BLOCKPRT DD points to DSN=SYS1.AOSB0.</li>
<li>As of Model 204 version 7.7, FastUnload is linked as an alias of the ONLINE load module, not as a standalone module. The FastUnload code is fully integrated into the Model 204 nucleus.</li>
</ul>
</blockquote>

One of the members of the RKOBJLIB object library is [[Model 204 ONLINE link job stream for z/OS|LKONLNJ]], which is a job stream to link the <var class="product">Model 204</var> ONLINE load module.

<div id="LKONLNJ"></div>
===Linking ONLINE (LKONLNJ job stream)===


<ol>
<li>Copy the <code>LKONLNJ</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKONLNJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with 1-4 followed by <code><<</code>. The numbers correspond to numbered steps in the comments.
<li>As needed, edit the lines after <code>SYSLIN DD *</code> that are marked with <code><<</code>. See the comments at the top of the <code>SYSLIN</code> sections (<b>A</b>-<b>C</b>) for instructions.
</ul>
<li>Submit the <code>LKONLNJ</code> job to link the ONLINE load module.
</ol>

Concise editing instructions are provided in the <code>LKONLNJ</code> file itself. More details about link-editing the ONLINE load module are provided in the following table.

<table class="thJustBold">
<tr><th>1</th><td>You must specify a value for the HLQ symbolic parameter in the EXEC LKM204P statement. The value of HLQ corresponds to the high-level qualifier used for the DSN for:
<ul>
<li> the downloaded object library</li>
<li>the Model204 load library</li>
<li>other data sets that are required for installation</li>
</ul></td></tr>
<tr><th>2</th><td>One of the modifications is <b>always required</b>, based on whether the ONLINE is to use RSQL (for Connect*) or not.

Uncomment only one of the following statements:
<ul>
<li>To link an ONLINE that uses RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKSQLONL</b>) statement.
<li>To link an ONLINE that does not use RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKNOSONL</b>) statement.
</ul>
</td></tr>
<tr><th>3</th><td>If you use an external authorizer, such as RACF or ACF2, you must:
<ul>
<li>[[#asm|Assemble the xxxPARM]] for your external authorizer to add the object file (such as RACFPARM or ACF2PARM) to your local object library.
<li>In the SYSLIN DD *, uncomment the appropriate INCLUDE statement(s) for your external authorizer. <blockquote class="note"><b>Notes:</b>
<ul><li>Uncomment either the "static" or "dynamic" INCLUDE statement, depending on your configuration.<li>If you use ACF2, there are two INCLUDE statements to be uncommented; one refers to your system ACF2 library. You must also provide the DSN for the ACF2 library in the ACF2 symbolic parameter in the EXEC LKM204P statement.</ul>
</blockquote>
</ul>
</td></tr>

<tr><th>4</th><td>If you have other programs that you assemble for your Model 204 ONLINE module, for example, [[#FUNU|FUNU]], assemble them into your local object library. You <strong>do not</strong> need to add additional INCLUDE statements for FUNU or other locally assembled object files; they are already in the include streams from RKOBJLIB.
</td></tr>

<tr><th>5</th><td>If you have an MQ series load library, set the MQ symbolic parameter to the correct DSN in the EXEC LKM204P statement. This allows you to use the MQ Series feature of <var class="product">Model 204</var>, either if you are already authorized for it, or to support a trial of it, without requiring relinking of the load module. You must also uncomment the INCLUDE MQ statement in the SYSLIN input.
</td></tr>

</table>

<div id="link_ifam1"></div>
<div id="link_ifam4"></div>

==Link the Model 204 IFAM1 and IFAM4 load modules==


Among the members of the RKOBJLIB object library are:
<ul>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM1_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM1_link_job_stream_for_IBM_z/OS&target=blank LKIFAM1J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM1 load module</li>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM4_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM4_link_job_stream_for_IBM_z/OS&target=blank LKIFAM4J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM4 load module.</li>
</ul>

===Linking IFAM1 (LKIFAM1J job stream)===
<ol>
<li>Copy the <code>LKIFAM1J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM1J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM1J</code> job to link the IFAM1 load module.
</ol>

===Linking IFAM4 (LKIFAM4J job stream)===
<ol>
<li>Copy the <code>LKIFAM4J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM4J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM4J</code> job to link the IFAM4 load module.
</ol>

<div id="lkutils"></div>


==Link the Model 204 utility load modules==


Following are the utility load modules to be linked:
<table>
<tr class="head">
<th>Module</th><th>Description</th>
</tr>
<tr><td><b>AUDIT204</b></td> <td> Generate an audit trail from the CCAJRNL or CCAJLOG data sets, with report stats and analysis</td></tr>
<tr><td><b>BATCH2</b></td> <td>Enable batch users to access a Model 204 Online that is running in a separate region</td></tr>
<tr><td><b>HASH15</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>HASH35</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>MERGEJ</b></td> <td>Media recovery journal merge utility</td></tr>
<tr><td><b>M204LIST</b></td> <td></td></tr>
<tr><td><b>M204XREF</b></td> <td></td></tr>
<tr><td><b>OI15OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>OI35OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>UTILC</b></td> <td>Information from checkpoint stream</td></tr>
<tr><td><b>UTILJ</b></td> <td>Journal/Audit trail debug utility</td></tr>
<tr><td><b>ZBLDTAB</b></td> <td>Build prototype password table</td></tr>
<tr><td><b>ZCTLTAB</b></td> <td>Convert CCASTAT for the Password Expiration feature</td></tr>
</table>

===Linking the utility load modules (LKALLUTJ job stream)===

One of the members of the RKOBJLIB object library is [[Model 204 utilities link job stream for IBM z/OS|LKALLUTJ]], a job stream to link the <var class="product">Model 204</var> utility load modules.
<ol>
<li>Copy <code>LKALLUTJ</code> into a local TSO library.
<li>Edit your copy of <code>LKALLUTJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKALLUTJ</code> job to link the utility load modules.
</ol>

<div id="lkcram"></div>

==<b id="cics"></b>Install the CICS interface==
The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.

For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 4.1, 4.2 and 5.3.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===Installation steps===
<ol>
<li>[[#Customizing the CICS interface|Customize the interface]] by editing the CICFG copy member.

<li>[[#Update the CICS System Definition (CSD)|Update the CICS System Definition (CSD)]] using one of the following methods:
<ul>
<li>Resource Definition Online (CEDA). The supplied member CEDAM204 in RKMACLIB provides an example of the required PCT, PPT, and PLT definitions.</li>

<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
</ul>
<li>[[#CICS_alloc|Allocate]] a CICS user library.</li>

<li>[[#CICS_asm|Assemble and link]] the CICS modules.</li>
</ol>

====Customizing the CICS interface====
To customize the CICS interface, copy the CICFG copy member from RKMACLIB into your local source library and edit it as needed.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface#Use the CICS Standard Mapping Service|Use the CICS Standard Mapping Service]].</p>

====Updating the CICS System Definition (CSD)====
You can update the CSD by using either CEDA or the DFHCSDUP utility and the CEDAM204 member of RKMACLIB. Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>
<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. It is never
invoked with a transaction ID from a terminal.</td> <td /> <td /><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td /> <td /></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>
CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using the CEDAM204 member, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
RSL(PUBLIC)
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
RSL(PUBLIC)
.
.
.

CEDA CHeck GRoup(group_name) </p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

<div id="CICS_alloc"></div>

====Allocating a CICS user library (JALCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS user library allocation job stream for IBM z/OS|JALCICSJ]], a job stream to allocate an empty CICS user library. You must allocate the CICS user library before assembling and linking the CICS modules.
<ol>
<li>Copy <code>JALCICSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JACICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.</li>
<li>Supply your installation high level qualifier(s) in the following lines marked with <<:
<ul>
<li>for hlq in the JCLLIB ORDER=(hlq.... line after the JOB card </li>
<li>after HLQ=, on the line after EXEC LKALLUTP at the bottom of the job stream </li>
</ul>
</ul>
</li>
<li>Submit the <code>JALCICSJ</code> job to allocate the CICS user library.</li>
</ol>

<div id="CICS_asm"></div>

====Assembling and linking CICS modules (LKCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS module assembly job stream for IBM z/OS|LKCICSJ]], a job stream to assemble and link the <var class="product">Model 204</var> CICS modules.
<ol>
<li>Copy <code>LKCICSJ</code> into a local TSO library.
<li>Edit your copy of <code>LKCICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your Model 204 installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC JALCICSP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKCICSJ</code> job to assemble and link the CICS module.
</ol>

<div id="tso"></div>

==Install the TSO interface==

<p class="note"><b>Note:</b> It is not necessary to install the TSO interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

The Model 204 TSO Interface enables the TSO user to communicate with a Model 204 Online.

The TSO Interface consists of two assembly language modules, TSFS and TSUL, whose source is located in the macro library. The modules are completely reentrant, reusable, and refreshable.

Installation requires assembly and link-editing of the TSO source modules using the [[Model 204 TSO module assembly job stream for IBM z/OS|LKTSOJ]] job stream from the RKOBJLIB library.

===Assembling and linking the TSO modules===

<ol>
<li>If you are using TSO extensions, modify TSFS in the local source library by changing:
<p class="code">&TSOV SETC 'TSO' </p>
<p>to:</p>
<p class="code">&TSOV SETC 'TSOE'</p></li>
<p>Changing the &TSOV SETC 'TSO' code in TSFS causes assembly of the NOEDIT form of the TPUT macro in the TSFS module. The NOEDIT form, required for 3270 extended data streams, allows proper handling of colors or highlighting in TSO extensions. NOEDIT is recommended for all TSO extensions.</p>
<li>Copy <code>LKTSOJ</code> from the RKOBJLIB object library into a local TSO library.
<li>Edit your copy of <code>LKTSOJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKTSOJ</code> job to assemble and link the TSO modules.
</ol>

==CRAM==
<blockquote class="note"><b>Notes:</b> CRAM SVC installation is deprecated in version 7.5 and higher. The following instructions are for [[Defining the user environment (CCAIN)#CRAM_options for z.2FOS|CRAM-XDM]].

<p>It is recommended that you install the version of CRAM-XDM that corresponds to the version of Model 204 you are installing. However, you could run a 7.5 version of CRAM-XDM with 7.x Model 204, such as for testing.</p></blockquote>

To install the CRAM load modules, proceed with the following steps:

<ol>
<li>Before linking the CRAM load modules, familiarize yourself with [[Defining_the_user_environment_(CCAIN)#CRAM_.28IODEV.3D11.2C_23.2C_29.29|CRAM]]: what it does, which facilities require it, and available CRAM options.

<li>Install 7.<var class="term">x</var> CRAM-XDM by running [[Model 204 CRAM link job stream for IBM z/OS|LKCRAMJ]], the job stream to link the CRAM load modules. LKCRAMJ is found in RKOBJLIB.

<p>CICS interface users: Unlike version 7.4 CRAM-XDM, the step in the link JCL for the CRAM modules specifies the <code>RENT</code> value for <code>PARM</code>. Read the Note in [[CICS interface#Running with storage protection on|Running with storage protection on]] for details.</p></li>
</ol>

<p class="note"><b>Note:</b> After installation, you will need to perform additional tasks to [[Defining the user environment (CCAIN)#Implementing CRAM-XDM usage for z/OS operating systems|implement CRAM-XDM]].</p>

<div id="softspy"></div>

==Upgrade SoftSpy==

To upgrade SoftSpy for version 7.<var class="term">x</var>, download, upload, and restore the SoftSpy procedure file, SPYPROC, which is distributed in a dump format.

<ol>
<li>Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>
For detailed instructions, see [[Downloading and restoring SOUL files#How can the dump file be uploaded to the mainframe?|Downloading and restoring SOUL files]].

For details on the SoftSpy installation, including customization and System Manager considerations, see the [[SoftSpy installation guide]].

==RSQL maintenance==
RKOBJLIB also contains the LKMAINTJ job stream. LKMAINTJ is used to relink the ONLINE, IFAM1, and IFAM4 load modules when a maintenance version of the RSQL (and sometimes EVCP) object files is distributed on the [https://m204.rocketsoftware.com/maint/fixlist Model 204 maintenance page].

When and if there are any fixes for them, the most recent versions of these object files will appear as <code>'Model 204 .. RSQL'</code> and <code>'Model 204 .. EVCP'</code> with your desired version number.

The description of the RSQL and EVCP fixes will be contained in the entire set of Model 204 fixes, which you can download from the maintenance page by clicking a 'Download Zaps' link. RSQL and EVCP fixes are listed in the zap file with the characters <code>'*77Lxx'</code> at the start of their comment boxes.

<div id="verify"></div>

==Verify Model 204 <I>x</I>.<I>y</I> on your system==
To perform an initial verification that your upgrade to 7.<var class="term">x</var> was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized M204 products (including 7.<var class="term">x</var>) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.<var class="term">x</var> zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.<var class="term">x</var></code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL <var class="term">x</var></code> on its menu screens.</td></tr>
</table>

==Example workflow for 7.5: download through installation==
This example shows one typical installation workflow: the site does not use RSQL, it uses the RACF external authorizer, and it does not have its own FUNU. The IBM system MQ loadlib is <code>MQSERIES.SCSQLOAD</code> (this is typical in z/OS).
The high-level qualifier in this example is MYBUILD.

The other item needed is the member name <code>MYBLDOB</code>, which is chosen arbitrarily for this example, and the following DSNs:
<ul>
<li><code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKOBJLIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB</code>
<li><code>MYBUILD.M204V75.LOCAL.OBJLIB</code>
<li><code>MYBUILD.M204V75.LOADLIB</code>
</ul>
===Build RKOBJLIB===
<ol>

<li>Download the object library (M204V75.OBJ) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>.

<li>Download the macro library (M204V75_ZOS.MAC) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDOB in my TSO library from a [http://sirius-software.com/download/new204lb.txt download] of the job stream to build the object and macro libraries, using the following at the end of the job stream:
<p class="code">//BLD EXEC NEW204LB,VERSION=75,
// HLQ=MYBUILD,
// OBJINP=MYBUILD.M204V75.RKOBJLIB.DISTRIB,
// MACINP=MYBUILD.M204V75.RKMACLIB.DISTRIB
</p>

<li>Run MYBLDOB from my TSO library. MYBLDOB deletes and then creates <code>MYBUILD.M204V75.RKOBJLIB</code> and
<code>MYBUILD.M204V75.RKMACLIB</code>.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDDS in my TSO library by copying
the job stream from [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], using the following at the end of the job stream:
<p class="code">//BLD EXEC JALINSP,
// HLQ=MYBUILD
</p>

<li>Run MYBLDDS from my TSO library. MYBLDDS allocates an empty loadlib data set for the Model 204 load modules, an empty local source library for the customized source files, and an empty local object library for the customized local object modules, with the following names: <code>MYBUILD.M204V75.LOADLIB</code>, <code>MYBUILD.M204.LOCAL.SRCLIB</code>, and <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.

</ol>

===Assemble and link===
<ol >
<li>Copy the RACFPARM source to the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and make any necessary modifications.
<li>Create the member JASMSECJ in my TSO library by copying
the job stream from [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], using the following at the end of the job stream:
<p class="code">//ASM EXEC JASMP,HLQ=MYBUILD,
// MEM=RACFPARM
</p></li>

<li>Run JASMSECJ from my TSO library; this assembles the RACFPARM source file in the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and stores the object in <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.</li>

<li>Copy the member LKONLNJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and customize LKONLN as follows:
<ul>
<li>Make these changes at the top of the job stream:
<p class="code">// JCLLIB ORDER=(MYBUILD.M204V75.RKOBJLIB)
//LKONLN EXEC LKM204P,
// HLQ=MYBUILD,
// MQ=MQSERIES.SCSQLOAD
</p></li>
<li>Uncomment the <code>INCLUDE</code> line for LKNOSONL (that is, without RSQL).</li>
<li>Uncomment the <code>INCLUDE</code> line for MQ.</li>
<li>Uncomment the <code>INCLUDE</code> line for my external authorizer module (such as RACFOS and RACFPARM).</li>
<li>Submit the LKONLNJ job from my TSO library; this creates ONLINE (and BATCH204 alias) in MYBUILD.M204V75.LOADLIB.</li>
</ul></li>

<li>Perform a simple smoke test: run BATCH204 with 'DISPLAY ZAPS' and 'ROCKET' commands.</li>

<li>To link the utilities, copy member LKALLUTJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and see all <code><<</code> lines to customize for my site; submit the LKALLUTJ job.</li>

<li>Ensure that any JCL that performs deferred index sorting for <var class="product">Model 204</var> version 7.5
(typically, FLOD jobs) uses the new <code>MYBUILD.M204V75.LOADLIB</code> for the E15 (OI15OS) and E35 (OI35OS) sort exits.</li>
</ol>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VSE]]</li>
</ul>

[[Category:Installation]]

Model 204 installation on IBM z/OS

2016-10-27T19:44:41Z

MCosta: /* Overview */

<div class="toclimit-3">__TOC__</div>
==Overview==
This topic describes the steps required to upgrade to Rocket Model 204 version 7.5 or higher, on the IBM<sup>®</sup> z/OS<sup>®</sup> operating system.

The new version number is referred to as 7.<var class="term">x</var>, where 7.<var class="term">x</var> can be 7.5 or higher.

For information on the new features available in the new version, as well as any compatibility issues, see the [[Release_notes#Release_notes.2C_wishlists.2C_and_punch_lists|7.<i>x</i> release notes]].

If you are skipping any versions when upgrading (such as upgrading from 7.5 to 7.7), be sure to read the release notes for those versions as well (such as 7.6).

==Before you begin==
<ul>
<li>You must have either a [[Rocket M204 user ID]] or a preexisting user ID to download the installation files.</li>

<li>The object library has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. <br />(The preapplied zap will authorize Model 204 itself and any separately purchased products such as [[SirScan]].)</li>

<li>The object library also has the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any new maintenance when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.<var class="term">x</var> files.
<p>Each step links to a section with detailed instructions. Note that some steps (such as assembling custom modules) might not apply to your installation. Once you have started, you can proceed directly through the steps (detail sections are consecutive) or return to this list for context.</p>
For a 7.5 example, see [[#Example_workflow_for_7.5:_download_through_installation|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#Build the Model 204 object and macro libraries|Build]] the Model 204 object and macro libraries:
<ol style="list-style-type:lower-alpha;">
<li>Use your [[Rocket M204 user ID]] to [[#downloading|download]] the Model 204 object library and the Model 204 macro library.</li>

<li>[[#uploading|Upload]] the downloaded components to the z/OS system on the IBM mainframe.</li>

<li>[[#bldLibs|Build]] the RKOBJLIB object library and RKMACLIB macro library. (Once you have built these libraries, do not modify them.)</li>
</ol>
</li>

<li>Submit the job to [[#allocating|allocate the other data sets]] required for installation.</li>

<li>Modify and assemble these modules if you use them:
<ol style="list-style-type:lower-alpha;">
<li>Your [[#Assemble FUNU and optional MSGU|user $functions (FUNU)]] and, optionally, MSGU.
<li>An external authorizer (such as RACF) for Model 204. [[#secparm|Set up the security module]], including assembling the <i>xxxx</i>PARM security module (such as RACFPARM). The object file is then stored in your local object library.</li>
<li>[[#ul_db2|UL/DB2 interface]]: preprocess and assemble the USQL module.</li>
<li>Other customized modules, such as CDTB. Modify them as needed and [[#asm|assemble]] them.
</ol></li>

<li>Link the [[#lkonln|ONLINE]] load module.</li>

<li>If you use the [[#link_ifam1|IFAM1 and IFAM4]] load modules, link them.</li>

<li>Link the <var class="product">Model 204</var> [[#lkutils|utility load modules]].</li>

<li>If you use the [[#cics|CICS interface]], customize it, and then assemble and link the CICS modules.</li>

<li>If you use the [[#tso|TSO]] interface, assemble and link-edit the TSO source modules.</li>

<li>Link the [[#CRAM|CRAM]] load modules as needed.</li>

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.<var class="term">x</var>.</li>

<li>[[#Verify Model 204 7.x on your system|Verify]] the installation.</li>
</ol>

==Build the Model 204 object and macro libraries==
To build the object and macro libraries, you must download the object library and macro library; upload each library to the mainframe; and copy, modify, and run the NEW204LB job.
===Object and macro libraries===
{{Template:Model 204 installation components}}

===<b id="downloading"></b>Downloading===
<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download.</li>
</ol>

===<b id="uploading"></b>Uploading===
Once the object file and macro library are downloaded to your workstation, upload them to the z/OS system on the IBM mainframe. You can use any file transfer mechanism, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for object and macro libraries</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for object and macro libraries</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

For details on how to download and upload, see [[Downloading and uploading Model 204 installation components]].

===<b id="bldLibs"></b>Building the object and macro libraries (NEW204LB job stream)===

After you upload the object and macro library input streams to the mainframe, build the object and macro libraries:

<ol>
<li>Access the [http://sirius.sirius-software.com/download/new204lb.txt NEW204LB job stream] text file.

<li>Copy the job stream file into a local TSO library for editing.

<li>On the first line of the job stream, modify the JOB card according to your local job card parameters.

<li>On the final four lines, marked <code>2 <<</code> ... <code>5 <<</code> on the right:
<ol style="list-style-type:lower-alpha;">
<li>Modify the <code>VERSION=</code> parameter, specifying the two-digit version of <var class="product">Model 204</var> you are installing, such as 75.
<li>Modify the <code>HLQ=</code> parameter, specifying the high-level qualifiers of all <var class="product">Model 204</var> installation data sets.
<li>Modify the <code>OBJINP=</code> parameter, using the DSN of the object library input file that you uploaded to the mainframe.
<li>Modify the <code>MACINP=</code> parameter, using the DSN of the macro library input file that you uploaded to the mainframe.
</ol>
<li>Submit the <code>NEW204LB</code> job to build the object library ("RKOBJLIB") and macro library ("RKMACLIB") on your z/OS system.</li>
</ol>

<div id="notouch"></div>
<p class="warn"><b>Attention:</b> Once you have built RKOBJLIB and RKMACLIB on your z/OS system, <b>do not</b> modify them in any way.<br />

For example, <b>do not</b> store other members into the object library; it should only contain the members as supplied in a download from the web site. Place object files that you might assemble (such as FUNU or RACFPARM) into your local object library.</p>

====RKOBJLIB README file====
README, a member of RKOBJLIB, contains details on the object files and installation steps. Once you have built RKOBJLIB, you can use README as an installation checklist if desired.

<div id="allocating"></div>

==Allocate the data sets for Model 204 upgrading==

There are three data sets used when upgrading to Model 204 7.<var class="term">x</var>:

<ul>
<li>data set for the Model 204 load modules
<li>data set for the local source library
<li>data set for the local object library
</ul>
The data set for the load modules will contain, after linking, the modules for the Model 204 product, including: ONLINE, IFAM1, and IFAM4.

The local source library is used to store the customized source for modules such as FUNU, MSGU, and ACF2PARM, RACFPARM, or TOPSPARM.

When the source is assembled, it is stored in the local object library.

One of the members of the RKOBJLIB object library is named [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], which is a job stream to allocate data sets for the installation. <code>JALINSJ</code> contains information about naming conventions for the data sets.

===Allocating data sets (JALINSJ job stream)===

<ol>
<li>Copy <code>JALINSJ</code> into a local TSO library.
<li>Edit your copy of <code>JALINSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>JALINSJ</code> job to allocate the data set.
</ol>

<div id="FUNU"></div>

==Assemble FUNU and optional MSGU==


This section lists installation considerations if you have your own user-written $functions module (FUNU).

<p class="note"><b>Note:</b> If you have your own FUNU or MSGU module, you must assemble it <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.</p>

Assemble your FUNU and/or optional MSGU modules with the following steps:
<ol>
<li>Modify FUNU for 64-bit addressing considerations and store the modified source in your local source library.
<div id="FUNU_7.5"></div>
<p>FUNU changes for 7.x are:</p>
{{Template:FUNU changes for 7.5}}
</li>
<li>If you have any user-defined messages (MSGU), store them in your local source library.</li>

<li>Assemble FUNU (and MSGU, if applicable), with the output object file stored in your local object library.
<ol style="list-style-type:lower-alpha;">

<li>Copy the source from RKMACLIB into your local source library.</li>

<li>After making any changes required for this version of <var class="product">Model 204</var>, run <code>JASMJ</code> to [[#asm|assemble]] FUNU into your local object library.</li>

<li>If needed, modify and run <code>JASMJ</code> to assemble MSGU.</li>

<p>You do <b>not</b> need to insert any INCLUDE statements for either FUNU nor MSGU; they are already present in the INCLUDE member (LKSQLONL or LKNOSONL) provided in the downloaded object library.</p></li>
</ol>
</li>
</ol>

<div id="secparm"></div>
==Set up the security module==

This section describes how to install a [[Security interfaces overview|security interface]] such as CA-ACF2, RACF, or CA-Top Secret.

<ol>
<li>Review the Model 204 installation section for your interface and complete all of the steps:
<ul>
<li>[[CA-ACF2_MVS_interface#Installing_the_Model_204_CA-ACF2_MVS_Interface|CA-ACF2 (MVS)]]</li>
<li>[[CA-ACF2_VM_interface#Installing_the_CA-ACF2_VM_Interface|CA-ACF2 (VM)]]</li>
<li>[[Security_Server_(formerly_RACF)_interface#Installing_the_Security_Server_Interface|RACF]]</li>
<li>[[CA-Top_Secret_interface#Installing_the_CA-Top_Secret_Interface|CA-Top Secret]]</li>
</ul>
</li>
<li> [[#asm|Assemble]] the security module:
ACF2PARM, RACFPARM, or TOPSPARM.</li>
<li>Optional. Link the security module as described below if you want it to be dynamically loaded.</li>
</ol>

===Linking the security module (LKSECRJ job stream)===

Dynamic loading lets you modify the security parameters without having to relink Model 204, which would be required if the parameter module were linked into Model 204 directly.

If you want Model 204 to dynamically load your security module during Model 204 ACF2, RACF, or TOPSECRET interface initialization, then you must link the corresponding security parameter module.

One of the members of the RKOBJLIB object library is <code>LKSECRJ</code>, a job stream to link-edit the security parameter module.

<ol>
<li>Copy [[Model 204 security module link job stream for IBM z/OS|LKSECRJ]] into a local TSO library.
<li>Edit your copy of <code>LKSECRJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKSECRJ</code> job to link-edit the security parameter module (ACF2PARM, RACFPARM, or TOPSPARM).
</ol>
<div id="ul_db2"></div>

==Install the UL/DB2 interface (JAUSQLJ job stream)==

To support the [[UL/DB2]] interface, USQL code is delivered in source for you to preprocess for your version of DB2. If you use the UL/DB2 interface, assemble the source as described below <b>before linking the ONLINE/IFAM1/IFAM4</b> load modules.

<ol>
<li>Copy [[Model 204 UL/DB2 job stream for IBM z/OS|JAUSQLJ]] into a local TSO library.
<li>Edit your copy of <code>JAUSQLJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>on the line after <code>EXEC JAUSQLP</code> at the bottom of the job stream set:
<ul>
<li><code>HLQ=</code>high level qualifier of all Model 204 installation DSNs</li>
<li><code>DB2HLQ=</code>high level qualifier for your DB2 maclib.</li>
</ul>
</ul>
</ul>
<li>Submit the <code>JAUSQLJ</code> job to preprocess and assemble the USQL module. The JAUSQLJ job executes the following two steps:
<ul>
<li>Run USQL (contained in RKMACLIB) through the DB2 preprocessor to process the EXEC SQL statements. This step produces two data sets: the DBRM and the expanded USQL source. The DBRM is saved as USQLDBRM in the local object library. The expanded USQL source is passed to step two for assembly.</li>
<li>Assemble expanded USQL source into local object library.</li>
</ul>
<li>Bind the DBRM as the plan with a site-specific plan name.</li>
</ol>

<div id="asm"></div>

==Assemble customized modules into your local object library (LOCAL.OBJLIB)==

Copy the customized source module (such as, FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2) from your current release into your local source library, if you have not already done so.
The local source library is not version-specific, so modules copied into it can be used for future installations.

One of the members of the RKOBJLIB object library is [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], a job stream to assemble a member from your Model 204 local source library into your local object library (LOCAL.OBJLIB).

===Assembling customized modules (JASMJ job stream)===
<ol>
<li>Copy <code>JASMJ</code> into a local TSO library.
<li>Edit your copy of <code>JASMJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the ASM line at the bottom of the job stream
</ul>
<li>Provide the member name to assemble (such as FUNU, MSGU, RACFPARM) on the <code>MEM=</code> line.
</ul>
<li>Submit the <code>JASMJ</code> job to assemble the module into your local object library.
</ol>

<div id="lkonln"></div>

==Link the Model 204 ONLINE load module==


<div id="onlnTable"></div>
<blockquote class="note">
<p><b>Notes:</b> </p>
<ul>
<li>If you use customized modules (such as FUNU, MSGU, ACF2PARM, RACFPARM, TOPSPARM, CDTB, or UL/DB2), you must [[#FUNU_7.5|modify]] them (if needed) and [[#asm|assemble]] them <b>before you link the ONLINE/IFAM1/IFAM4</b> load modules.</li>
<li>There is not a separate link step for BATCH204. It is not maintained as a separate module; the same module as ONLINE is used, with a BATCH204 alias.</li>
<li>The INCLUDE TCPLIB(SNMPGSYS) statement for Horizon TCP/IP in the Online-link-edit job is no longer required and has been eliminated.</li>
<li>A number of INLUDE LELIB(CEE*) statements have also been eliminated from the Online-link-edit job. These were required to support several mathematical $functions but those $functions have been rewritten in Assembly language and are now automatically part of the Online load module.</li>
<li>The INCLUDE BLOCKPRT(IEFSD095) statement is required if block printing on separator pages is desired. Usually the BLOCKPRT DD points to DSN=SYS1.AOSB0.</li>
<li>As of Model 204 version 7.7, FastUnload is linked as an alias of the ONLINE load module, not as a standalone module. The FastUnload code is fully integrated into the Model 204 nucleus.</li>
</ul>
</blockquote>

One of the members of the RKOBJLIB object library is [[Model 204 ONLINE link job stream for z/OS|LKONLNJ]], which is a job stream to link the <var class="product">Model 204</var> ONLINE load module.

<div id="LKONLNJ"></div>
===Linking ONLINE (LKONLNJ job stream)===


<ol>
<li>Copy the <code>LKONLNJ</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKONLNJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with 1-4 followed by <code><<</code>. The numbers correspond to numbered steps in the comments.
<li>As needed, edit the lines after <code>SYSLIN DD *</code> that are marked with <code><<</code>. See the comments at the top of the <code>SYSLIN</code> sections (<b>A</b>-<b>C</b>) for instructions.
</ul>
<li>Submit the <code>LKONLNJ</code> job to link the ONLINE load module.
</ol>

Concise editing instructions are provided in the <code>LKONLNJ</code> file itself. More details about link-editing the ONLINE load module are provided in the following table.

<table class="thJustBold">
<tr><th>1</th><td>You must specify a value for the HLQ symbolic parameter in the EXEC LKM204P statement. The value of HLQ corresponds to the high-level qualifier used for the DSN for:
<ul>
<li> the downloaded object library</li>
<li>the Model204 load library</li>
<li>other data sets that are required for installation</li>
</ul></td></tr>
<tr><th>2</th><td>One of the modifications is <b>always required</b>, based on whether the ONLINE is to use RSQL (for Connect*) or not.

Uncomment only one of the following statements:
<ul>
<li>To link an ONLINE that uses RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKSQLONL</b>) statement.
<li>To link an ONLINE that does not use RSQL, you must uncomment the INCLUDE RKOBJ204(<b>LKNOSONL</b>) statement.
</ul>
</td></tr>
<tr><th>3</th><td>If you use an external authorizer, such as RACF or ACF2, you must:
<ul>
<li>[[#asm|Assemble the xxxPARM]] for your external authorizer to add the object file (such as RACFPARM or ACF2PARM) to your local object library.
<li>In the SYSLIN DD *, uncomment the appropriate INCLUDE statement(s) for your external authorizer. <blockquote class="note"><b>Notes:</b>
<ul><li>Uncomment either the "static" or "dynamic" INCLUDE statement, depending on your configuration.<li>If you use ACF2, there are two INCLUDE statements to be uncommented; one refers to your system ACF2 library. You must also provide the DSN for the ACF2 library in the ACF2 symbolic parameter in the EXEC LKM204P statement.</ul>
</blockquote>
</ul>
</td></tr>

<tr><th>4</th><td>If you have other programs that you assemble for your Model 204 ONLINE module, for example, [[#FUNU|FUNU]], assemble them into your local object library. You <strong>do not</strong> need to add additional INCLUDE statements for FUNU or other locally assembled object files; they are already in the include streams from RKOBJLIB.
</td></tr>

<tr><th>5</th><td>If you have an MQ series load library, set the MQ symbolic parameter to the correct DSN in the EXEC LKM204P statement. This allows you to use the MQ Series feature of <var class="product">Model 204</var>, either if you are already authorized for it, or to support a trial of it, without requiring relinking of the load module. You must also uncomment the INCLUDE MQ statement in the SYSLIN input.
</td></tr>

</table>

<div id="link_ifam1"></div>
<div id="link_ifam4"></div>

==Link the Model 204 IFAM1 and IFAM4 load modules==


Among the members of the RKOBJLIB object library are:
<ul>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM1_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM1_link_job_stream_for_IBM_z/OS&target=blank LKIFAM1J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM1 load module</li>
<li><span class="plainlinks">[http://m204wiki.rocketsoftware.com/index.php/Model_204_IFAM4_link_job_stream_for_IBM_z/OS?title=Model_204_IFAM4_link_job_stream_for_IBM_z/OS&target=blank LKIFAM4J]</span>, which is a job stream to link the <var class="product">Model 204</var> IFAM4 load module.</li>
</ul>

===Linking IFAM1 (LKIFAM1J job stream)===
<ol>
<li>Copy the <code>LKIFAM1J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM1J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM1J</code> job to link the IFAM1 load module.
</ol>

===Linking IFAM4 (LKIFAM4J job stream)===
<ol>
<li>Copy the <code>LKIFAM4J</code> job stream from RKOBJLIB into a local TSO library.
<li>Edit your copy of <code>LKIFAM4J</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Edit the lines, near the top of the job stream, marked with numbers followed by <code><<</code>. The numbers correspond to numbered steps in the comments following these lines.
</ul>
<li>Submit the <code>LKIFAM4J</code> job to link the IFAM4 load module.
</ol>

<div id="lkutils"></div>


==Link the Model 204 utility load modules==


Following are the utility load modules to be linked:
<table>
<tr class="head">
<th>Module</th><th>Description</th>
</tr>
<tr><td><b>AUDIT204</b></td> <td> Generate an audit trail from the CCAJRNL or CCAJLOG data sets, with report stats and analysis</td></tr>
<tr><td><b>BATCH2</b></td> <td>Enable batch users to access a Model 204 Online that is running in a separate region</td></tr>
<tr><td><b>HASH15</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>HASH35</b></td> <td>Sort exit for hash file index</td></tr>
<tr><td><b>MERGEJ</b></td> <td>Media recovery journal merge utility</td></tr>
<tr><td><b>M204LIST</b></td> <td></td></tr>
<tr><td><b>M204XREF</b></td> <td></td></tr>
<tr><td><b>OI15OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>OI35OS</b></td> <td>Sort exit for variable length deferred updates (Ordered Index)</td></tr>
<tr><td><b>UTILC</b></td> <td>Information from checkpoint stream</td></tr>
<tr><td><b>UTILJ</b></td> <td>Journal/Audit trail debug utility</td></tr>
<tr><td><b>ZBLDTAB</b></td> <td>Build prototype password table</td></tr>
<tr><td><b>ZCTLTAB</b></td> <td>Convert CCASTAT for the Password Expiration feature</td></tr>
</table>

===Linking the utility load modules (LKALLUTJ job stream)===

One of the members of the RKOBJLIB object library is [[Model 204 utilities link job stream for IBM z/OS|LKALLUTJ]], a job stream to link the <var class="product">Model 204</var> utility load modules.
<ol>
<li>Copy <code>LKALLUTJ</code> into a local TSO library.
<li>Edit your copy of <code>LKALLUTJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKALLUTJ</code> job to link the utility load modules.
</ol>

<div id="lkcram"></div>

==<b id="cics"></b>Install the CICS interface==
The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.

For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 4.1, 4.2 and 5.3.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===Installation steps===
<ol>
<li>[[#Customizing the CICS interface|Customize the interface]] by editing the CICFG copy member.

<li>[[#Update the CICS System Definition (CSD)|Update the CICS System Definition (CSD)]] using one of the following methods:
<ul>
<li>Resource Definition Online (CEDA). The supplied member CEDAM204 in RKMACLIB provides an example of the required PCT, PPT, and PLT definitions.</li>

<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
</ul>
<li>[[#CICS_alloc|Allocate]] a CICS user library.</li>

<li>[[#CICS_asm|Assemble and link]] the CICS modules.</li>
</ol>

====Customizing the CICS interface====
To customize the CICS interface, copy the CICFG copy member from RKMACLIB into your local source library and edit it as needed.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface#Use the CICS Standard Mapping Service|Use the CICS Standard Mapping Service]].</p>

====Updating the CICS System Definition (CSD)====
You can update the CSD by using either CEDA or the DFHCSDUP utility and the CEDAM204 member of RKMACLIB. Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>
<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. It is never
invoked with a transaction ID from a terminal.</td> <td /> <td /><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td /> <td /></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>
CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using the CEDAM204 member, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
RSL(PUBLIC)
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
RSL(PUBLIC)
.
.
.

CEDA CHeck GRoup(group_name) </p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

<div id="CICS_alloc"></div>

====Allocating a CICS user library (JALCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS user library allocation job stream for IBM z/OS|JALCICSJ]], a job stream to allocate an empty CICS user library. You must allocate the CICS user library before assembling and linking the CICS modules.
<ol>
<li>Copy <code>JALCICSJ</code> into a local TSO library.</li>
<li>Edit your copy of <code>JACICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.</li>
<li>Supply your installation high level qualifier(s) in the following lines marked with <<:
<ul>
<li>for hlq in the JCLLIB ORDER=(hlq.... line after the JOB card </li>
<li>after HLQ=, on the line after EXEC LKALLUTP at the bottom of the job stream </li>
</ul>
</ul>
</li>
<li>Submit the <code>JALCICSJ</code> job to allocate the CICS user library.</li>
</ol>

<div id="CICS_asm"></div>

====Assembling and linking CICS modules (LKCICSJ job stream)====

One of the members of the RKOBJLIB object library is [[Model 204 CICS module assembly job stream for IBM z/OS|LKCICSJ]], a job stream to assemble and link the <var class="product">Model 204</var> CICS modules.
<ol>
<li>Copy <code>LKCICSJ</code> into a local TSO library.
<li>Edit your copy of <code>LKCICSJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your Model 204 installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC JALCICSP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKCICSJ</code> job to assemble and link the CICS module.
</ol>

<div id="tso"></div>

==Install the TSO interface==

<p class="note"><b>Note:</b> It is not necessary to install the TSO interface if it has been installed for a previous version of Model 204. The load modules from the older version are compatible with version 7.<var class="term">x</var> of Model 204.</p>

The Model 204 TSO Interface enables the TSO user to communicate with a Model 204 Online.

The TSO Interface consists of two assembly language modules, TSFS and TSUL, whose source is located in the macro library. The modules are completely reentrant, reusable, and refreshable.

Installation requires assembly and link-editing of the TSO source modules using the [[Model 204 TSO module assembly job stream for IBM z/OS|LKTSOJ]] job stream from the RKOBJLIB library.

===Assembling and linking the TSO modules===

<ol>
<li>If you are using TSO extensions, modify TSFS in the local source library by changing:
<p class="code">&TSOV SETC 'TSO' </p>
<p>to:</p>
<p class="code">&TSOV SETC 'TSOE'</p></li>
<p>Changing the &TSOV SETC 'TSO' code in TSFS causes assembly of the NOEDIT form of the TPUT macro in the TSFS module. The NOEDIT form, required for 3270 extended data streams, allows proper handling of colors or highlighting in TSO extensions. NOEDIT is recommended for all TSO extensions.</p>
<li>Copy <code>LKTSOJ</code> from the RKOBJLIB object library into a local TSO library.
<li>Edit your copy of <code>LKTSOJ</code> for your configuration:
<ul>
<li>Replace the first line with a JOB card.
<li>Supply your installation high level qualifier(s) in the following lines marked with <code><<</code>:
<ul>
<li>for <code>hlq</code> in the <code>JCLLIB ORDER=(hlq.</code>... line after the <code>JOB</code> card
<li>after <code>HLQ=</code>, on the line after <code>EXEC LKALLUTP</code> at the bottom of the job stream
</ul>
</ul>
<li>Submit the <code>LKTSOJ</code> job to assemble and link the TSO modules.
</ol>

==CRAM==
<p class="note"><b>Note:</b> It is recommended that you install the version of CRAM-XDM that corresponds to the version of Model 204 you are installing. However, you could run a 7.5 version of CRAM-XDM with 7.x, such as for testing.</p>

To install the CRAM load modules, proceed with the following steps:

<ol>
<li>Before linking the CRAM load modules, familiarize yourself with [[Defining_the_user_environment_(CCAIN)#CRAM_.28IODEV.3D11.2C_23.2C_29.29|CRAM]]: what it does, which facilities require it, and available CRAM options.

<p>[[Defining the user environment (CCAIN)#CRAM_options for z.2FOS|CRAM-XDM]] is recommended for Model 204 versions 7.5 and higher.</p></li>

<li>Install 7.<var class="term">x</var> CRAM-XDM by running [[Model 204 CRAM link job stream for IBM z/OS|LKCRAMJ]], the job stream to link the CRAM load modules. LKCRAMJ is found in RKOBJLIB.

<p>CICS interface users: Unlike version 7.4 CRAM-XDM, the step in the link JCL for the CRAM modules specifies the <code>RENT</code> value for <code>PARM</code>. Read the Note in [[CICS interface#Running with storage protection on|Running with storage protection on]] for details.</p></li>
</ol>

<p class="note"><b>Note:</b> After installation, you will need to perform additional tasks to [[Defining_the_user_environment_(CCAIN)#Implementing_CRAM_XDM_usage_for_z.2FOS_operating_systems|implement CRAM-XDM]].</p>

<div id="softspy"></div>

==Upgrade SoftSpy==

To upgrade SoftSpy for version 7.<var class="term">x</var>, download, upload, and restore the SoftSpy procedure file, SPYPROC, which is distributed in a dump format.

<ol>
<li>Download SPYPROC, in binary form, from the [https://m204.rocketsoftware.com/maint/ullist?nickname=ROCKET SOUL files download page] to a workstation file.</li>
<li>Upload the file from your workstation to your z/OS system.</li>
<li>RESTORE the file into a Model 204 SOUL file.</li>
</ol>
For detailed instructions, see [[Downloading and restoring SOUL files#How can the dump file be uploaded to the mainframe?|Downloading and restoring SOUL files]].

For details on the SoftSpy installation, including customization and System Manager considerations, see the [[SoftSpy installation guide]].

==Verify Model 204 7.<I>x</I> on your system==
To perform an initial verification that your upgrade to 7.<var class="term">x</var> was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized M204 products (including 7.<var class="term">x</var>) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.<var class="term">x</var> zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.<var class="term">x</var></code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL <var class="term">x</var></code> on its menu screens.</td></tr>
</table>

==Example workflow for 7.5: download through installation==
This example shows one typical installation workflow: the site does not use RSQL, it uses the RACF external authorizer, and it does not have its own FUNU. The IBM system MQ loadlib is <code>MQSERIES.SCSQLOAD</code> (this is typical in z/OS).
The high-level qualifier in this example is MYBUILD.

The other item needed is the member name <code>MYBLDOB</code>, which is chosen arbitrarily for this example, and the following DSNs:
<ul>
<li><code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKOBJLIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>
<li><code>MYBUILD.M204V75.RKMACLIB</code>
<li><code>MYBUILD.M204V75.LOCAL.OBJLIB</code>
<li><code>MYBUILD.M204V75.LOADLIB</code>
</ul>
===Build RKOBJLIB===
<ol>

<li>Download the object library (M204V75.OBJ) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKOBJLIB.DISTRIB</code>.

<li>Download the macro library (M204V75_ZOS.MAC) from the downloads page.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDOB in my TSO library from a [http://sirius-software.com/download/new204lb.txt download] of the job stream to build the object and macro libraries, using the following at the end of the job stream:
<p class="code">//BLD EXEC NEW204LB,VERSION=75,
// HLQ=MYBUILD,
// OBJINP=MYBUILD.M204V75.RKOBJLIB.DISTRIB,
// MACINP=MYBUILD.M204V75.RKMACLIB.DISTRIB
</p>

<li>Run MYBLDOB from my TSO library. MYBLDOB deletes and then creates <code>MYBUILD.M204V75.RKOBJLIB</code> and
<code>MYBUILD.M204V75.RKMACLIB</code>.

<li>Upload to the mainframe, in binary format, with settings FB/80/6400, as <code>MYBUILD.M204V75.RKMACLIB.DISTRIB</code>.

<li>Create the member MYBLDDS in my TSO library by copying
the job stream from [[Model 204 data set allocation job stream for IBM z/OS|JALINSJ]], using the following at the end of the job stream:
<p class="code">//BLD EXEC JALINSP,
// HLQ=MYBUILD
</p>

<li>Run MYBLDDS from my TSO library. MYBLDDS allocates an empty loadlib data set for the Model 204 load modules, an empty local source library for the customized source files, and an empty local object library for the customized local object modules, with the following names: <code>MYBUILD.M204V75.LOADLIB</code>, <code>MYBUILD.M204.LOCAL.SRCLIB</code>, and <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.

</ol>

===Assemble and link===
<ol >
<li>Copy the RACFPARM source to the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and make any necessary modifications.
<li>Create the member JASMSECJ in my TSO library by copying
the job stream from [[Model 204 local member assembly job stream for IBM z/OS|JASMJ]], using the following at the end of the job stream:
<p class="code">//ASM EXEC JASMP,HLQ=MYBUILD,
// MEM=RACFPARM
</p></li>

<li>Run JASMSECJ from my TSO library; this assembles the RACFPARM source file in the <code>MYBUILD.M204.LOCAL.SRCLIB</code> and stores the object in <code>MYBUILD.M204V75.LOCAL.OBJLIB</code>.</li>

<li>Copy the member LKONLNJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and customize LKONLN as follows:
<ul>
<li>Make these changes at the top of the job stream:
<p class="code">// JCLLIB ORDER=(MYBUILD.M204V75.RKOBJLIB)
//LKONLN EXEC LKM204P,
// HLQ=MYBUILD,
// MQ=MQSERIES.SCSQLOAD
</p></li>
<li>Uncomment the <code>INCLUDE</code> line for LKNOSONL (that is, without RSQL).</li>
<li>Uncomment the <code>INCLUDE</code> line for MQ.</li>
<li>Uncomment the <code>INCLUDE</code> line for my external authorizer module (such as RACFOS and RACFPARM).</li>
<li>Submit the LKONLNJ job from my TSO library; this creates ONLINE (and BATCH204 alias) in MYBUILD.M204V75.LOADLIB.</li>
</ul></li>

<li>Perform a simple smoke test: run BATCH204 with 'DISPLAY ZAPS' and 'ROCKET' commands.</li>

<li>To link the utilities, copy member LKALLUTJ from <code>MYBUILD.M204V75.RKOBJLIB</code> to my TSO library, and see all <code><<</code> lines to customize for my site; submit the LKALLUTJ job.</li>

<li>Ensure that any JCL that performs deferred index sorting for <var class="product">Model 204</var> version 7.5
(typically, FLOD jobs) uses the new <code>MYBUILD.M204V75.LOADLIB</code> for the E15 (OI15OS) and E35 (OI35OS) sort exits.</li>
</ol>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VSE]]</li>
</ul>

[[Category:Installation]]

Downloading and applying fixes

2016-10-19T22:10:33Z

MCosta:

RSQL maintenance: RKOBJLIB also contains the LKMAINTJ job stream.
LKMAINTJ is used to relink the ONLINE, IFAM1, and IFAM4 load modules
when a maintenance version of the RSQL (and sometimes EVCP) object
files is distributed on the Model 204 maintenance page:

https://m204.rocketsoftware.com/maint/fixlist

When and if there are any fixes for them, the most recent versions of
these object files will appear as 'Model 204 .. RSQL' and 'Model 204
.. EVCP' with your desired version number. The description of the
RSQL and EVCP fixes will be contained in the entire set of Model 204
fixes, which are also available at the above URL, using the links
with the 'Download Zaps' action on the right. RSQL and EVCP fixes
are listed in the zap file with the characters '*77Lxx' at the start
of their comment boxes.

Release notes for Model 204 version 7.7

2016-08-22T19:42:33Z

MCosta: /* Journal and checkpoint processing enhancements */

These release notes list the enhancements and other changes contained in Model 204 version 7.7.

<p style="color:red"><b>******THIS IS A DRAFT DOCUMENT.******</b></p>

These release notes list the enhancements and other changes contained in Model 204 version 7.7, <b><i>which is still in development</i></b>. Until the commercial release of the software, Rocket reserves the right to add to, remove, or change anything described herein.

==Overview==
These release notes contain installation and features information for the Rocket Model 204 version 7.7 release.
Before beginning your installation, please read through this information about product installation and changes.

==New features==

===Long password support===
<p>
Logon passwords, maintained in CCASTAT, can now contain as many as 127 characters. </p>
<p>
This feature includes support for: </p>
<ul>
<li><var>LOGON</var> command</li>
<li><var>LOGONCP</var> command, used to change a password</li>

<li><var>LOGCTL C USERID</var> command</li>

<li><var>$Sir_Login</var> function</li>

<li>Mixed-case passwords (if the <var>[[CUSTOM parameter|CUSTOM]]</var> parameter includes the value 11)</li>

<li>CCASTAT data sets created with or without password expiration support</li>

<li>Long passwords (password phrases) for use with the external security interfaces: ACF2, RACF, or TOPSECRET</li>
</ul>
<p class="note"><b>Note:</b> This feature is available for logon passwords only; it does not apply to file passwords.</p>
<p>
No changes to CCASTAT and no new CCAIN parameters are required to enable long password support.</p>

===Large checkpoint data sets===
Support is added for large data sets (as many as 16 million tracks) for the Model 204 Checkpoint facility [[Checkpoints: Storing before-images of changed pages#Creating the CHKPOINT.2FCHKPNT .28and CHKPNTS.29 data set|CHKPOINT or CHKPNTS data sets]]. For details, see [[System_and_media_recovery#ROLL_BACK_processing.2C_Pass_2|ROLL BACK processing, Pass 2]].

==Operating system and hardware requirements==

===Operating system requirements===

<ul>
<li><b>IBM z/OS</b>
<ul>
<li>Versions supported: z/OS version 1.07 through [[IBM z/OS 2.2 PTF requirement|2.2]].</li>
<p>Version 1.07 is sufficient for all functionality except for the following features:</p>
<ul>
<li>zHPF support requires version [[Model 204 technical specifications#z/OS 2.1 compatibility issues|2.1]].</li>
<li>Large (1 MB) page support requires version 1.9.</li>
<li>Extended address volumes (EAV) requires version 1.12.</li>
</ul>
</li>
</ul>
On z/OS, Model 204 release 7.7 operates as an APF authorized load module, as required by many 7.7 features. <br />
To run Model 204 unauthorized, [[Contacting Rocket Software Technical Support|contact Technical Support]].

<li><b>IBM z/VM</b>
<ul>
<li>Versions supported: z/VM version 5.4 through 6.3.</li>
</ul>
</li>

<li><b>IBM z/VSE</b>
<ul>
<li>Versions supported: z/VSE version 5.1 and 5.2.</li>
</ul>
</li>
</ul>

=== Hardware requirements ===

In general, Model 204 version 7.7 requires the IBM z/890 or above processor.
<p>However, the IBM z10 or above processor is required for the following features:
<ul>
<li>large (1 MB) page support</li>
<li>IBM's High Performance FICON (zHPF) support</li>
</ul></p>

===Model 204 compatibility with operating systems===

For information on Model 204 certification with IBM operating systems, see [[Model 204 system requirements]].

==SOUL (User Language) enhancements==

===New and changed classes and methods===

====New exception class: Write Error====
<var>[[WriteError class|WriteError]]</var> exceptions are thrown by the <var>Close</var>, <var>WriteBlock</var>, <var>WriteRecord</var>, and <var>WriteRecords</var> methods in the [[Dataset class]] if they encounter a full output <var>Dataset</var> object.

====New default certificate-signing algorithm====
[[Janus Network Security]] as well as the <var>[[Stringlist_class|StringList]]</var> methods <var>[[AppendSignedCertificate (Stringlist function)|AppendSignedCertificate]]</var> and <var>[[AppendSignedClientCertificate (Stringlist function)|AppendSignedClientCertificate]]</var> methods have changed their default signature algorithm from SHA-1 to SHA-256.

This change is propagated by zap maintenance to versions 7.6 and 7.5 of Model 204.

===="SSL" String methods====
These new methods are added:
<table>
<tr class="head"><th>Method</th><th>Description</th></tr>
<tr><td>[[SHA384digest (String function)|SHA384digest]]</td><td>SHA-384 digest</td></tr>
<tr><td>[[SHA512digest (String function)|SHA512digest]]</td><td>SHA-512 digest</td></tr>
</table>

====New LoadMsgctl method====
The new <var>[[LoadMsgctl (XmlDoc subroutine)|LoadMsgctl]]</var> method lets you view what <var class="product">Model </var> messages have been affected by <var>[[MSGCTL command|MSGCTL]]</var> commands. The method also displays the current attributes of those messages. 

In addition, to better understand the effect of the <var>MSGCTL</var> command, the [[RKTools]] <code>SIRIUS</code> file will contain a procedure you can use to display the <var>MSGCTL</var> commands that have been specified in the Online session.

====New DigestAlgorithm values====
Values <var>SHA384</var> and <var>SHA512</var> are added to the [[DigestAlgorithm enumeration]].

====Method variable invocation====
[[Method variables]] can now be invoked using <code>%var()</code> or <code>%obj:var()</code>, as in JavaScript.

====X509CertificateToXmlDoc method support for unknown elements====
A certificate's <code><RelativeDistinguishedName></code> element can contain a wide variety of attributes that <var>X509CertificateToXmlDoc</var> does not understand. Under Model 204 7.6 and earlier, this results in a parse exception, but under 7.7 and later, such attributes are added as <code><unknown></code> elements with an <code><ObjectIdentifier></code> element that indicates the ASN.1 object identifier.

<p class="note"><b>Note:</b> You are advised not to refer to such an <code><unknown></code> element in your programs, since future updates to the <var>X509CertificateToXmlDoc</var> method might add support for the element, in which case the element name will change to a proper name. If such an element is of interest, [[Contacting Rocket Software Technical Support|contact Rocket Software technical support]]. </p>

====Resulting element length in "ToXmlDoc" String methods====
Prior to version 7.7 of Model 204, the <var>[[DerToXmlDoc (String function)|DerToXmlDoc]]</var>, <var>[[X509CertificateToXmlDoc (String function)|X509CertificateToXmlDoc]]</var>, <var>[[X509CrlToXmlDoc (String function)|X509CrlToXmlDoc]]</var>, and
<var>[[RSAPrivateKeyToXmlDoc (String function)|RSAPrivateKeyToXmlDoc]]</var> methods failed if input to them created any element in the result <var>XmlDoc</var> with a text child whose length exceeded 650 characters.
An example of such input is a 4096-bit key (which requires 1024 hex characters).

As of version 7.7, the lengths of the created text nodes are not restricted.

===New XHTML entities for square-bracket characters===
<b>[</b> and <b>]</b> are newly supported as [[XML processing in Janus SOAP#Entity references|XMHTL entities]] (notably in the [[U (String function)#brackets|U method]]). This provides a better approach to specifying square brackets (such as for [[XPath#Some notes on XPath usage|XPath]] expressions) than the formerly recommended use of <var>Static</var> %variables initialized to the correct values.

(This change is propagated by zap maintenance to version 7.6 of Model 204.)

For example, to produce an XPath expression equivalent to the following:
<p class="code"><nowiki>*/pers[@name="Hector"] </nowiki></p>
Code like this was recommended under version 7.5 of Model 204:
<p class="code">%lsq is string len 1 static initial('&#x5B;'):u
%rsq is string len 1 static initial('&#x5D;'):u
. . .
%myXmldoc:print('*/pers' %lsq '@name="Hector"' %rsq) </p>

Under version 7.6 and above, you can instead use the new entities and avoid the declarations, concatenations, and runtime conversions required above:
<p class="code">%myXmldoc:print('*/pers<b>[</b>@name="Hector"<b>]</b>':u)</p>

===Procedure names can begin with zero===
Formerly, a procedure name was not allowed to begin with a zero or a minus sign. As of version 7.7, a procedure name can begin with a zero, and alphanumeric procedure names can begin with a minus sign character (-), which is interpreted as a hyphen. For example, <code>00123</code>, <code>-1myproc</code>, and <code>-myproc</code> are valid procedure names. <br />See the <var>[[PROCEDURE command|PROCEDURE]]</var> command for details.

==Janus product enhancements==

===Janus Network Security ciphers===
Support for certificates signed using SHA-384 and SHA-512 are added to [[Janus Network Security]]. This makes it possible to generate certificates signed with these algorithms and to accept server or client certificates signed with these algorithms.

===Janus Web Server rules===
The following changes have been made in version 7.7:
<ul>
<li>Janus Web used to automatically implement [[Defining Web rules#Notes|two web server ON rules]] to set up access to the Janus Web sample home page and to demonstration application procedures. These rules were removed in version 7.6 (by zap maintenance) and are not present in version 7.7.</li>

<li>You can now specify a method name in the command for a <var>JANUS WEB ON</var> rule. See [[#JANUS WEB ON (method name substitution)|JANUS WEB ON (method name substitution)]] for details.</li>

<li>The automatic <var>JANUS WEB ALLOW</var> rule, which allowed any user to access the port without requiring a login, is changed to the following to force login for any URL on a Janus Web port:
<p class="code">JANUS WEB <i>portname</i> ALLOW * USER *
</p>
This rule applies, in version 7.6 (by zap maintenance) and in version 7.7, unless overridden by user-added rules.</li>

<li>As described below in [[#JANUS WEB (additional rule support)|JANUS WEB (additional rule support)]], the <var>JANUS WEB</var> command <var>ALLOW</var> and <var>DISALLOW</var> rules are updated to include support for RESTful and WebDAV HTTP methods. </li>
</ul>

===Janus Web access to HTTP authorization and authentication headers===
Under version 7.7, Janus Web lets you access HTTP user authentication headers. You can capture the HTTP "Authorization" request header value, and you can set the "WWW-Authenticate" response header. See [[Janus Web Server security#Authorization and WWW-Authenticate headers|Authorization and WWW-Authenticate headers]].

==Fast/Unload enhancements==

===Integration of Fast/Unload with the Online load module ===

Starting with version 7.7 of Model 204, Fast/Unload is entirely linked with the Model 204 Online load module, maintenance zaps applied to the Online load module will include all Fast/Unload maintenance, and the version number of Fast/Unload is the same as the version number of Model 204.

Previously (for all versions of Fast/Unload through version 4.7), the standalone FUNLOAD load module was downloaded and linked separately and independently from Model 204.

===zIIP exploitation===
If you have an authorization zap that contains the base zIIP support product of Model 204 and contains the Fast/Unload HPO product, your standalone PGM=FUNLOAD jobs will run on a zIIP processor, if one is available. See [[Fast/Unload overview#fuhpo|Fast/Unload HPO]].

===New #VIEW function===
The <var>[[Fast/Unload standard functions#.23VIEW204: Value of Model 204 parameter|#VIEW204]]</var> function returns the value of the [[List of Model 204 parameters|Model 204 parameter]] you specify as an argument.

===PUT statement enhancements===


====Length prefix for PUT output values====

New <var>PUT</var> statement syntax is added to insert a one-byte or two-byte binary integer, containing the byte length of a <var>PUT</var> value, in the output stream before the value.

This addition provides better readability and lower CPU cost than the techniques currently used to achieve the same result.

====COUNTED keyword for AS clause====

The <var>AS</var> clause of a <var>PUT</var> statement will now allow the <var>COUNTED</var> keyword:
<p class="code"><nowiki>... PUT info .. AS [type] COUNTED[1|2] </nowiki></p>
<p>
For example, <code>PUT FIRST.NAME AS COUNTED2</code> puts the first occurrence of field <code>FIRST.NAME</code> as a string value, preceded by a two-byte binary integer containing the length of that occurrence.</p>
<p>
This feature will allow FUEL code such as the following: </p>
<p class="code">%VAL = ITEM.CODE(%OCC)
%LEN = #LEN( %VAL )
PUT %LEN AS FIXED(2)
PUT %VAL </p>

To be replaced by the more readable and more efficient:
<p class="code">PUT %VAL AS COUNTED2 </p>

====#function as PUT "info" argument====

New in this version, a #function call is allowed as the <var>PUT</var> <var class="term">info</var> argument. For example, instead of FUEL code such as the following:
<p class="code">%VAL = #STRIP(ITEM.VALUE(%OCC), 'L', 0)
PUT %VAL </p>
You can use this more readable and somewhat more efficient equivalent:
<p class="code">PUT #STRIP(ITEM.VALUE(%OCC), 'L', 0) </p>

===#STRIP function enhancements===


====New #STRIP fourth argument====

The new fourth argument of <var>#STRIP</var> lets you designate a <var>#STRIP</var> first-argument value to be nullified. That is, when the value of the first argument is equal to the value of the fourth argument, <var>#STRIP</var> returns a null string. You might use this optional argument for fields that have a "placeholder value" or "default value" which is not actual data.

This argument can be conveniently combined with the
new <var>[[#COUNTED keyword for AS clause|COUNTED]]</var> option for <var>PUT</var>, because a length-prefixed format allows a reliable, unambiguous representation of a series of null strings.
<p>
Combining the new fourth argument, the new <var>COUNTED</var> option, and the new [[#optn|N option]] of the second argument provides a simpler alternative to FUEL code such as the following:</p>
<p class="code">%VAL = ITEM.STRING(%OCC)
IF %VAL EQ '_' THEN
PUT 0 AS FIXED(2)
ELSE
%LEN = #LEN(%VAL)
PUT %LEN AS FIXED(2)
PUT %VAL
END IF
</p>
<p>
You can replace the above statements by the more readable and efficient: </p>
<p class="code">PUT #STRIP(ITEM.STRING(%OCC), 'N', , '_') AS COUNTED2
</p>

====New #STRIP type options====

<var>LK</var>, <var>N</var>, and <var>P</var> strip-type options are added to the <var>#STRIP</var> function:
<ul>
<li>The new <var>LK</var> option lets you strip leading zeroes from numeric value output.
<p>
<var>LK</var>, together with other new Fast/Unload <var>PUT</var> features, provides a simpler alternative to FUEL code such as the following:</p>
<p class="code">%VAL = ITEM.NUMBER(%OCC)
IF %VAL EQ '_' OR %VAL EQ '' THEN
PUT 0 AS FIXED(2)
ELSE
%VAL = #STRIP(%VAL, 'L', '0')
IF %VAL EQ '' THEN
%VAL = '0'
END IF
%LEN = #LEN(%VAL)
PUT %LEN AS FIXED(2)
PUT %VAL
END IF </p>
<p>
You can replace the above statements by the more readable and efficient: </p>
<p class="code">PUT #STRIP(ITEM.NUMBER(%OCC), 'LK', '0', '_') AS COUNTED2
</p></li>

<li id="optn">The new <var>N</var> option prevents leading-character stripping, trailing-character stripping, or both.
<p>
For an example, see [[#New #STRIP fourth argument|New #STRIP fourth argument]], above.</p></li>

<li>The new <var>P</var> option strips all but one leading <var class="term">pad</var>-argument characters from the #STRIP first argument returned value, if that value contains a non-zero length string of only <var class="term">pad</var> characters.
<p>
<var>P</var>, together with other new Fast/Unload <var>PUT</var> features, provides a simpler alternative to FUEL code such as the following, which outputs a numeric value with leading zeroes stripped:</p>
<p class="code"><nowiki>%VAL = ITEM.NUMBER(%OCC)
IF %VAL EQ '_' OR VAL EQ '' THEN
PUT 0 AS FIXED(2)
ELSE
%VAL = #STRIP(%VAL, 'L', '0')
IF %VAL EQ '' THEN
%VAL = '0'
END IF
%LEN = #LEN(%VAL)
PUT %LEN AS FIXED(2)
PUT %VAL
END IF
</nowiki></p>
<p>
You can replace the above statements by the more readable and efficient: </p>
<p class="code">PUT #STRIP(ITEM.NUMBER(%OCC), 'P', '0', '_') AS COUNTED2
</p>

<p class="note"><b>Note:</b> A FUEL <var>IF</var> statement oddity is that the precedence of <var>AND</var> and <var>OR</var> are the same.</p>
</li>
</ul>

==New and changed commands==


===DISPLAY MODMAP (new parameter: <var>UEX</var>)===
The <var>[[DISPLAY MODMAP command|DISPLAY MODMAP]]</var> command now has a <var>UEX</var> parameter that displays the entry point addresses of all defined user exits.

===FREE command===
The FREE command now indicates success or failure with the following messages:
<p class="code">M204.0509: No action taken by FREE command; <i>ddname</i> not allocated
M204.0510: FREE command successful; <i>ddname</i> freed
</p>

===JANUS DEFINE (new parameter: <var>SSLTRUST</var>)===
The <var>[[JANUS DEFINE]]</var> command now has an <var>[[SSLTRUST (JANUS DEFINE parameter)|SSLTRUST]]</var> parameter that indicates that the certificate presented by the other side of a TLS/SSL connection is to be accepted even if it is not signed by a known certifying authority.

===JANUS WEB (additional rule support)===

The <var>[[JANUS WEB]]</var> command <var>ALLOW</var>/<var>DISALLOW</var> rules are updated to include support for these HTTP methods:
<ul>
<li>The RESTful ([https://en.wikipedia.org/wiki/Representational_state_transfer Representational State Transfer]) methods CONNECT, DELETE, OPTIONS, PATCH, and TRACE. </li>

<li>The WebDAV ([http://www.webdav.org/specs/rfc4918.html Distributed Authoring and Versioning]) methods PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. </li>
</ul>

====JANUS WEB ON (method name substitution)====
You can now specify a method name in the command for a <var>[[JANUS WEB ON|JANUS WEB ON]]</var> rule. To do this, specify an <code>M</code> after the escape (<tt>"</tt>) character, as in:

<p class="code">JANUS WEB WEBPORT ON /TEST/* OPEN FILE TEST CMD 'I "M.*'</p>

A GET request for URL <code>/test/foo</code> would result in the file <code>TEST</code> being opened and the command <code>I GET.FOO</code> being issued. A POST for the same URL would result in the command <code>I POST.FOO</code> being issued.

<p class="note"><b>Note:</b> This behavior is a change from past releases, when <code>"M</code> was simply converted to <code>M</code>.</p>

===LOGINCP or LOGONCP (new)===
Because colons are now valid password characters, the <var>[[LOGINCP or LOGONCP command|LOGINCP]]</var> (LOGIN and Change Password) command replaces the former technique for changing passwords using <var>LOGIN</var>.
<p>Before version 7.7, with <var>LOGIN</var>, you specified <var class="term">oldpassword</var><tt>:</tt><var class="term">newpassword</var> in response to the <code>M204.0347: Password</code> prompt.</p>
With the <var>LOGINCP</var> command, you are prompted and re-prompted for the new password after successful logon:
<p class="code"><b>LOGINCP USER1</b>
M204.0347: Password
M204.0353: USER1 USER1 login 16 JUL 29 12.38
M204.2633: Enter new password
M204.2633: Re-enter new password
M204.0350: New password accepted
M204.0345: CCASTAT updated
</p>
<var>LOGONCP</var> is a synonym for <var>LOGINCP</var>.

===ZHPF (new parameters: <i>filename</i> and *)===
The <var>[[ZHPF command|ZHPF]]</var> command checks zHPF ability for the file currently opened by the user.

As of Model 204 7.7, you can specify parameters to <var>ZHPF</var>:
<ul>
<li><var class="term">filename</var>, to check a specific file</li>
<li>An asterisk (<tt>*</tt>), to check local files opened by all users</li>
</ul>

==New and changed parameters==


===CUSTOM (new values)===
The following values have been added to the <var>[[CUSTOM_parameter|CUSTOM]]</var> parameter in this release:
<ul>
<li>The CUSTOM=23 value always truncates the userid to 10 characters.</li>

<li>The CUSTOM=41 value allows recording of data on successful RACF user logins. The login data is shown in RACFRW batch reports.</li>

<li>The CUSTOM=42 value allows the editing of procedure names containing the following special characters: comma, equal sign, space, single quote, semicolon.</li>
</ul>

===LFSCB (new default/minimum value)===
The default (and minimum) value of <var>[[LFSCB parameter|LFSCB]]</var> is now 8 bytes.

===LITBL (new default/minimum value)===
The default (and minimum) value of <var>[[LITBL parameter|LITBL]]</var> is now 8 bytes.

===MINDEBCL (new)===
The new system parameter, <var>[[MINDEBCL parameter|MINDEBCL]]</var>, can be set in an Online to specify the minimum [[Debugger]] Client build number that can be used with that Online.

===MPDELAY and MPDELAYZ (new)===
For an [[Performance monitoring and tuning#Multiprocessing .28MP.2F204.29|MP/204]] Online, the <var>[[MPDELAY parameter|MPDELAY]]</var> and <var>[[MPDELAYZ parameter|MPDELAYZ]]</var> parameters are added to improve the efficiency of the MP scheduler. They reduce the cost of starting too many new subtasks for the amount of work to be done.

===NUMBUF and NUMBUFG===
As described below in [[#Elimination of BTB buffers|Elimination of BTB buffers]], setting <var>NUMBUFG</var> greater than 0 in version 7.7 forces <var>NUMBUF</var> to 0 (no buffer pool buffers reside below the bar). Not setting <var>NUMBUFG</var> or setting it to 0 (no buffers above the bar) allows the calculation of BTB buffers to remain as in previous versions.

===SCHDOFL and SCHDOFLZ (new minimum value)===
The new minimum value of <var>[[SCHDOFL parameter|SCHDOFL]]</var> and <var>[[SCHDOFLZ parameter|SCHDOFLZ]]</var> is 0. Before Model 204 7.7, their minimum allowed value was 1.

===SCHDOFLS (new)===
For z/OS system customers using <var class="product">Model 204</var> zIIP support, the new <var>[[SCHDOFLS parameter|SCHDOFLS]]</var> system parameter helps you to regulate the zIIP processor workload.

<var>SCHDOFLS</var> specifies both of the following:
<ul>
<li>The target number of threads on the zIIP offload queue before a non-SRB MP subtask is dispatched to help the zIIP subtasks. </li>

<li>If started, how aggressively non-SRB MP subtasks pick up work from the zIIP offload queue. </li>
</ul>
<p>
This parameter applies to z/OS only.</p>

===SCHDOPT (change to X'20' bit processing)===
The <var>[[SCHDOPT parameter|SCHDOPT]]</var> X'20' bit prevents the maintask from running work that is intended to run on a zIIP subtask (when zIIP subtasks are defined and activated). As of Model 204 7.7, when this bit is off, the maintask will run some of the zIIP work only if the zIIP subtasks appear to be saturated. Saturation is defined as a zIIP subtask queue length of at least <code>[[SCHDOFLZ parameter|SCHDOFLZ]]*[[AMPSUBZ parameter|AMPSUBZ]]</code>.

Formerly, this saturation requirement was absent, allowing the maintask to take on more (possibly too much) of the zIIP workload.

===SERVSIZE (new default/minimum value)===
The minimum value for <var>[[SERVSIZE parameter|SERVSIZE ]]</var> is changed from zero to 65536. If <var>SERVSIZE</var> is explicitly set in CCAIN and its value is less than 64K, the following message is issued:
<p class="code">M204.1149: SERVSIZE has been set to its minimum value: 65536
</p>

If <var>SERVSIZE</var> was not set but was [[Defining the runtime environment (CCAIN)#Sizing user server areas|calculated by the system]] to a value less than 64K, the following message is issued:
<p class="code">M204.0163: SERVSIZE increased to 65536
</p>
<p>
This change is also applied by zap maintenance in versions 7.6, 7.5, and 7.4 of Model 204. </p>

==Performance enhancements==

===Elimination of BTB buffers===
As of version 7.7, any use of above-the-bar buffer pool (as invoked by a setting of the <var>[[NUMBUFG parameter|NUMBUFG]]</var> parameter greater than 0) will force all buffer pool buffers above the bar — no below-the-bar buffers will exist. In this case, the <var>[[NUMBUF parameter|NUMBUF]]</var> and <var>[[MINBUF parameter|MINBUF]]</var> parameters will be forced to 0, and the other parameters that affect BTB storage (<var>MAXBUF</var>, <var>SPCORE</var>, <var>LDKBMWND</var>, and <var>NLRUQ</var>) will be ignored.

If you set <var>NUMBUFG</var> to 0, all buffers will be below the bar, and the settings of the BTB-related parameters will be respected and calculated as in pre-7.7 versions.

===Increase in request limit for number of images, screens, and menus===
These limits are increased to 4095 per request:
<ul>
<li>The total number of [[Images|images]] for all blocks (formerly 256)</li>

<li>The maximum number of [[Menu statement or block#Menus and screens|menus and screens]] combined (formerly 256)</li>
</ul>

==Statistics enhancements==
===BLKO===
The performance statistic BLKO now reports invisible users as blocked out. In previous releases, invisible users were not reported and BLKO remained virtually zero. The new BLKO value is more precise, and by summing BLKO, WTSV, BLKI, REDY, SWPG and RUNG, you can now approximate USRS (average active users).

For the MONITOR command, the QUE column now reports BLKO instead of OFFQ for invisible users and displays new values OFFO and OFFI.
OFFO is invisible and blocked out; OFFI is invisible and blocked in.
BLKO now means blocked out and on some queue. BLKI now means blocked in and on some queue.

==Other enhancements==

===MODEL 6 screen size and back-paging===
As of Model 204 version 7.7 (and 7.5 or 7.6 with maintenance applied), a large <var>[[LOUTPB parameter|LOUTPB]]</var> value for [[Terminal MODEL 6 support|MODEL 6]] geometries is allowed, even if screen back-paging has been enabled.

In previous releases, during initialization, if back-paging was enabled for the IODEV, <var>LOUTPB</var> was automatically reset to the limit that supported back-paging.

Back-paging will now be disabled for any terminal with a <code>MODEL 6</code> screen geometry that requires more than 6142 bytes.

===ECF calls to the IBM IDCAMS utility===
The new <var>IDCAMS</var> option for the <var>External Module</var> statement of the Model 204 [[External Call Facility]] lets a SOUL program invoke IDCAMS without using the SYSIN and SYSPRINT DD statements. Instead, the Model 204 Universal Buffer is used to pass the input lines and receive the output lines from IDCAMS.

===Running ECF requests under the invoking user’s profile===
If the new system parameter <var>[[ECPRIV parameter|ECPRIV]]</var> 4 bit is set, the job invoked by a privileged [[External Call Facility]] statement runs under the job's external authorizer (ACF2, RACF, or Top/Secret) profile, rather than that of the user that invoked an External Call.

==Debugger updates==

===SoftSpy authorization===
<p>
SoftSpy and Muse are now authorized using the standard zap AUTH mechanism.</p>
<p>
EDIT CONFIG is no longer used to enter authorization keys, and the second (key entry) screen of SPY EDIT CONFIG no longer appears.</p>

===SoftSpy Error message for DBCSENV===
<p>
As in previous releases, SoftSpy is not supported in a DBCS (double-byte character set) environment. As of version 7.7, if the CCAIN parameter DBCSENV is set to a non-zero value, the SPY command is rejected with the following message:</p>
<p class="code">Message 207: SoftSpy may not be used in a DBCS environment.</p>

===Debugger Client version information display on mainframe===
As of version 7.7, Debugger build 64, the most recent version of the Debugger Client sends its build and tag number to the mainframe, and this information is displayed in message [[MSIR.1077]].

This information is not sent if the Debugger Client build number is less than 64.

===Enforcing use of a minimum version of the Debugger Client===
A new system parameter, <var>[[MINDEBCL parameter|MINDEBCL]]</var>, lets you specify the minimum build number of a Debugger Client that can be used with an Online.
Normally, when you use the TN3270 or Janus Debugger, no restrictions are placed on which version of the Debugger workstation client is used. Versions of the Client are identified by a build number, which is displayed in the Audit Trail tab when the client starts:
<p class="code">2016 07 30 17:21:47 The Rocket Software Debugger Client
2016 07 30 17:21:47 Build: 65 (01 August 2016) Tag: 1 GA
</p>
You can also view the build number of the Client at any time by selecting <code>Help > About</code>.
On Debugger Client build 65 and higher, you can also get the build number from the Client function <var>&&buildNumber()</var>.

Build 64 (and higher) of the Debugger Client transmits its build number to the mainframe side when a debugging session is initiated. The mainframe side uses this information to construct the MSIR.1077 message:
<p class="code">MSIR.1077: Begin debug session, user 3, client: Build: 65, Tag: 1 (Janus debugger session)</p>

Since Client builds before 64 do not transmit their build number, the mainframe side views all Client versions prior to build 64 as build 63.

If you set <var>[[MINDEBCL parameter|MINDEBCL]]</var> to a positive value and try to use a version of the Debugger Client whose build number is less than <var>MINDEBCL</var>, you see the following error on the Audit Trail (and on the terminal if you are using <code>TN3270 DEBUG ON</code>):
<p class="code">MSIR.1079: Debugger Client Build: ''xx'' < MINDEBCL: ''yy'' debugger client connection refused
</p>
The debugging session is rejected. An error message is also shown by the Client.

====Debugger Client Build 65====
Shortly after the GA release of Model 204 7.7, Build 65 of the Debugger Client will be released. It has better error message display for various connection errors and also for <var>MINDEBCL</var> violations. Although earlier Client builds work fine with Model 204 7.7 and <var>MINDEBCL</var>, you are encouraged to upgrade to Build 65 when it is released to get the improved error reporting. Build 65 also will work fine with Model 204 releases prior to 7.7.

==Compatibility issues==

===APSYPAGE parameter cannot be non-zero===
<p>(Applies to the IBM z/OS system.)</p>
The <var>APSYPAGE</var> parameter was disabled (but still allowed) in version 7.6. As of version 7.7, if <var>APSYPAGE</var> is non-zero, the Online will not come up and the following error message will appear:

<p class="code">M204.2958: APSYPAGE is obsolete as of 7.6.
Rocket recommends using RESPAGE and/or TEMPPAGE as the alternative</p>

See [[APSYPAGE parameter]] for information about alternatives to <var>APSYPAGE</var>.

===Unlabeled FDV statement compilation errors===
Version 7.7 introduced an edge case incompatibility by disallowing code which is very questionable or clearly wrong; that is, previously the compiler allowed pretty much any statements between the label and the FDV. Such statements are no longer allowed.

For example, the following was allowed in older versions of Model 204:
<p class="code"> a: audit 'About to FDV'
fdv foo
b: frv in a</p>

Inserting SOUL code between a label and an FDV statement is no longer allowed, and so the result of the above is:

<p class="code">M204.0311 Unacceptable statement reference</p>

This change was also introduced as maintenance in both version 7.5 (as zaps 75Z408 and 75Z414) and version 7.6 (as zaps 76Z175 and 76Z182).

===KOMM addressing changes===
<ul>
<li>KU is no longer 4K addressable from KOMM. It has been relocated to KOMM+1100 and must be addressed using grande (‘G’) instructions.</li>
<li>KHEOC has been renamed to KGEOC.</li>
<li>KUUSRNO has been renamed to KBUSRNO.</li>
<li>In addition, all KUP… fields have been removed and replaced by their 64-bit equivalent KUG… fields. <br />
For example, before 7.7, VTBL might be addressed by using <code>L R1,KUPVT</code>. <br />
As of version 7.7, that reference would require <code>LG R1,KUGVT</code>.</li>
</ul>

For context, see [[Customizing functions and translation tables#Converting user-written functions|Converting user-written functions]].

===JANUS WEB ON -- "M substitution===
In the command for a JANUS WEB ON rule, <code>"M</code> can now be used to specify a method name.
This behavior is a change from past releases, when <code>"M</code> was simply converted to <code>M</code>. See [[#JANUS WEB ON (method name substitution)|JANUS WEB ON (method name substitution)]] for details.

===IODEV=37 is no longer supported===
Line-at-a-time terminals used on IBM z/OS via the IBM Network Terminal Option (2741s, teletypes, and teletype-compatibles) are no longer supported.

===Journal format compatibility===
A recovery code error unintentionally allowed recovery to be run using Model 204 7.6 against a version 7.5 journal, and vice versa. Although the error was benign because the journal formats were the same in those versions, mixing of journal versions and Model 204 versions is no longer allowed.

==New and updated messages==

See [[New and updated messages in Model 204 version 7.7 -- DRAFT|New and updated messages in Model 204 version 7.7]] for details.

[[Category: Release notes]]

Dictionary/204 installation guide

2016-07-20T21:46:53Z

MCosta: /* New installation */

==Overview==
<var class="product">[[Media:M204_DictionaryGuide_V75.pdf | Dictionary/204]]</var> Is a set of application subsystems (known as APSYs) running inside a <var class="product">Model 204</var> Online that provide full-screen and web-based tools to help programmers, DBAs, and system managers handle the complexities of <var class="product">User Language</var> and file and system management.

Installing <var class="product">Dictionary/204</var> requires downloading the <code>M204PROC</code> file and restoring it to your environment, setting up some subsidiary <var class="product">Model 204</var> files, and verifying that the environment has the appropriate parameter settings.

Upgrades to <var class="product">Dictionary/204</var> can almost always be handled by restoring a fresh copy of the <code>M204PROC</code> file.

==A summary of the Dictionary/204 installation steps==
The following checklist specifies in brief the steps to follow installing
<var class="product">Dictionary/204</var>, whether for z/VM CMS, z/OS, or z/VSE.
The sections [[#Installing Dictionary/204 under z/VM CMS|Installing Dictionary/204 under z/VM CMS]], [[#Installing Dictionary/204 under z/OS|Installing Dictionary/204 under z/OS]], and [[#Installing Dictionary/204 under z/VSE|Installing Dictionary/204 under z/VSE]] describe these steps in greater detail for each operating system.
<ol>
<li>Allocate the space required for the <code>M204PROC</code> data set,
and <var>RESTORE</var> it from the <var>DUMP</var> files found on the website.
<p>
In addition, there might be any number of other data sets required for
the <var class="product">Dictionary/204</var> components you are installing.
These are listed in [[#Installation checklist (z/VM CMS)|Installation checklist (z/VM CMS)]], [[#Installation checklist (z/OS)|Installation checklist (z/OS)]], and [[#Installation checklist (z/VSE)|Installation checklist (z/VSE)]]. </p> </li>

<li>Update the Online JCL or EXEC:
<ul>
<li>Add the DD cards, FILEDEFs or DLBLs for the Dictionary/204 files. </li>
</ul>

<li>Update CCAIN parameters:
<ul>
<li>Increase <var>[[NFILES parameter|NFILES]]</var>, <var>[[NDCBS parameter|NDCBS]]</var>, and <var>[[NDIR parameter|NDIR]]</var> for the Dictionary/204 files. </li>

</ul> </li>

<li>Start the Online, using an <var>ONLINE</var> load module that contains the
<var class="product">Model 204 Version 7.5 or higher</var>. </li>

<li>To install an update to Dictionary/204,
open file <code>M204PROC</code> and execute the following command:
<p class="code">INCLUDE DICN.DDRINST</p>
<p>
Follow the instructions presented on the installation screen (and in the Help
text for the screen).</p> </li>

<li>Verify success of the installation by compiling each Dictionary/204 APSY. </li>

<li>Use the APSY named <var>DICTADMIN</var> to customize the <var class="product">Dictionary/204</var> environment. </li>
</ol>

==Preparing for Dictionary/204 installation==
The <var class="product">Dictionary/204</var> products are implemented as <var class="product">Model 204</var> subsystems.
The code for all the component subsystems resides in the file named <code>M204PROC</code> which is typically downloaded from the product section of the website.

===Obtaining product installation files===
The files necessary for the installation are available from the Rocket Software website.

To download product files from the Rocket website:
<ol>
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, (under construction) </li>

<li>After providing your registered customer login information, download the latest version of the <code>Dictionary/204</code> file (which is labeled "Dictionary/204 products in one file" followed by a version number).
<p>
A "Click here" link on this page provides Help on downloading format, some information about
different browser behaviors, file sizing information, and more.</p></li>
</ol>

===Determining eligible products===
To download files or maintenance from the Rocket M204 Customer Care area of the Rocket website, you must have a registered Rocket user ID ([[Contacting Rocket Software Technical Support|contact Technical Support]] if you need an ID).
The website will show only products for which your organization is up to date on maintenance or rental payments.
If a product does not appear on your download page and you believe it should,
contact Technical Support.

===System requirements===
<ul>
<li><var class="product">Dictionary/204</var> operates in a <var class="product">Model 204</var> Online region.
<p>
In the rest of this document, "Online" refers to a region of
<var class="product">Model 204</var> running an <var>ONLINE</var> load module containing Version 7.5 or higher
</p></li>
</ul>

===User privileges===
The installing user <i>must</i> have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>

<li>System Manager privileges, as well as access to all of the Dictionary/204 subsystems and the JCL or EXEC that
runs the Online <var class="product">Model 204</var> region. </li>
</ul>

===New installation or reinstallation===
<ul>
<li>Sites that have never installed <var class="product">Dictionary/204</var> ''must'' use the new installation, as there are a number of files to allocate and <var
class="product">Model 204</var> parameters to update.</li>

<li>Sites that are re-installing the latest version of <var class="product">Dictionary/204</var>
can either [[#Reinstallation for existing Dictionary/204 sites|reinstall]] Dictionary/204 (using DDRINST) or perform a [[#New installation|new installation]] (using DDINST) to create a new set of Dictionary/204 files.

<p>If you are upgrading from a previous version or maintenance level, your site already has the Dictionary files that contain information about your environment.</p> </li>
</ul>

==New installation==
<p class="note"><b>Note:</b> If you have never installed Dictionary/204 before, you must use these instructions. If you have installed Dictionary before, you can do a new install using these instructions if desired.</p>
You can verify the <var class="product">Dictionary/204</var> version in the title of any <var class="product">Dictionary/204</var> screen.
The installation steps are as follows:
<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, (under construction) </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.

<p>
<li>In file <code>M204PROC</code>, run the procedure <code>DICN.DDINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Reinstallation for existing Dictionary/204 sites==
You can verify the <var class="product">Dictionary/204</var> version either in the title of any <var class="product">Dictionary/204</var> screen.
The reinstallation steps are as follows:

<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, (under construction) </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.
<p>
If you are upgrading from a previous release, simply overlay your old <code>M204PROC</code> file.</p>
<p>
In file <code>M204PROC</code>, run the procedure <code>DICN.DDRINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Installing Dictionary/204 on IBM z/VM CMS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on z/VM CMS,
including z/VM CMS system and software requirements.

Review [[#Preparing for Dictionary/204 installation|Preparing for Dictionary/204 installation]] for details about general <var class="product">Dictionary/204</var> system requirements.

The <code>M204PROC</code> <var class="product">Model 204</var> file, which contains the <var class="product">[[SOUL]]</var> code that runs <var class="product">Dictionary/204</var>, can be [[#Obtaining product installation files|obtained from the Rocket website]].

The following table lists the required files needed to complete an installation of Dictionary/204.
<table class="thJustBold">
<tr class="head"><th>File name</th>
<th>Contents</th></tr>

<tr><th><i>Metadata</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>Datalink</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204temp</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204rpt</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204sys</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204dctl</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>
</table>

Allocate space for the <var class="product">Dictionary/204</var> files, and restore them from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]], as described in the following steps.

===Installation checklist (z/VM CMS)===

<ol>
<li>Define and format a minidisk to hold the <var class="product">Dictionary/204</var> installation files.
1500 4096-byte z/VM CMS blocks should be sufficient in all cases.
This requires a 22-cylinder z/VM CMS minidisk on a 3390. </li>

<li>Allocate space for the required <var class="product">Dictionary/204</var> data sets. A skeleton exec,
<code>D204FDEF</code>, is provided for this purpose.
Modify this exec to perform the allocations on the appropriate minidisks.
Allocate space for the following data sets:
<table class="thJustBold">
<tr><th>M204PROC
</th><td>6000 pages; must always be allocated.</td></tr>

<tr><th>Metadata
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>Datalink
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204temp
</th><td>150 pages; must always be allocated.</td></tr>

<tr><th>D204rpt
</th><td>110 pages; must always be allocated.</td></tr>

<tr><th>D204sys
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204dctl
</th><td>100 pages; must always be allocated.</td></tr>

</table>

<blockquote class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, modify the D204FDEF EXEC to use the old Dictionary/204 files for the upgrade.
<p>
The installation process uses these files to install a new version of Dictionary/204.
</p>
</blockquote> </li>

<li>Modify the RESPROC EXEC to specify the <code>M204PROC</code> dump file and <code>M204PROC</code> file to be loaded.</li>

<li>Restore the <code>M204PROC</code> file with the <var>D204 RESPROC</var> exec.
<p>To carry out the install, you must customize the FILEDEF inside the <var>D204FDEF</var> exec to conform to local standards.
In addition, modify <var>LOGONSM CCAIN</var> to contain a valid login ID and password.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </p></li>

<li>To run the <var>D204</var> exec for a new install, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 INSTALL</p></li>

<li>To run the <var>D204</var> exec for a REINSTALL, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 REINSTALL</p></li>

<li>Complete [[#updateJCL|steps 3 through the end]] in the [[#Installing Dictionary/204 on IBM z/OS|"Installing Dictionary/204 on IBM z/OS"]] section. </li>
</ol>

==Installing Dictionary/204 on IBM z/OS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/OS, including the z/OS system and software requirements.
If, like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/OS)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>An example command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:

<p>Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

<li>Verify that the Online environment allows the use of file groups and APSY 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 APSYs, 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.
<p>
For more information about APSYs and file groups, see [[Storing and using file group definitions (CCAGRP)#File groups|File groups]] and [[System requirements for Application Subsystems]]. </p></li>
</ul> </li>

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review the [[#Dictionary/204 server size |Dictionary/204 server size]] section, below, for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage may increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

==Installing Dictionary/204 on IBM z/VSE==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/VSE,
including z/VSE system and software requirements.

If like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/VSE)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>A sample command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<p>
Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

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

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

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify that the setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review [[#Dictionary/204 server size|Dictionary/204 server size]] for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage might increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

===Dictionary/204 server size===
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.
The actual server size requirements might vary slightly because of table
settings in the local Online <var class="product">Model 204</var> regions, and because of slight
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.
<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server
</th></tr>

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

Dictionary/204 installation guide

2016-07-20T21:46:03Z

MCosta: /* Reinstallation for existing Dictionary/204 sites */

==Overview==
<var class="product">[[Media:M204_DictionaryGuide_V75.pdf | Dictionary/204]]</var> Is a set of application subsystems (known as APSYs) running inside a <var class="product">Model 204</var> Online that provide full-screen and web-based tools to help programmers, DBAs, and system managers handle the complexities of <var class="product">User Language</var> and file and system management.

Installing <var class="product">Dictionary/204</var> requires downloading the <code>M204PROC</code> file and restoring it to your environment, setting up some subsidiary <var class="product">Model 204</var> files, and verifying that the environment has the appropriate parameter settings.

Upgrades to <var class="product">Dictionary/204</var> can almost always be handled by restoring a fresh copy of the <code>M204PROC</code> file.

==A summary of the Dictionary/204 installation steps==
The following checklist specifies in brief the steps to follow installing
<var class="product">Dictionary/204</var>, whether for z/VM CMS, z/OS, or z/VSE.
The sections [[#Installing Dictionary/204 under z/VM CMS|Installing Dictionary/204 under z/VM CMS]], [[#Installing Dictionary/204 under z/OS|Installing Dictionary/204 under z/OS]], and [[#Installing Dictionary/204 under z/VSE|Installing Dictionary/204 under z/VSE]] describe these steps in greater detail for each operating system.
<ol>
<li>Allocate the space required for the <code>M204PROC</code> data set,
and <var>RESTORE</var> it from the <var>DUMP</var> files found on the website.
<p>
In addition, there might be any number of other data sets required for
the <var class="product">Dictionary/204</var> components you are installing.
These are listed in [[#Installation checklist (z/VM CMS)|Installation checklist (z/VM CMS)]], [[#Installation checklist (z/OS)|Installation checklist (z/OS)]], and [[#Installation checklist (z/VSE)|Installation checklist (z/VSE)]]. </p> </li>

<li>Update the Online JCL or EXEC:
<ul>
<li>Add the DD cards, FILEDEFs or DLBLs for the Dictionary/204 files. </li>
</ul>

<li>Update CCAIN parameters:
<ul>
<li>Increase <var>[[NFILES parameter|NFILES]]</var>, <var>[[NDCBS parameter|NDCBS]]</var>, and <var>[[NDIR parameter|NDIR]]</var> for the Dictionary/204 files. </li>

</ul> </li>

<li>Start the Online, using an <var>ONLINE</var> load module that contains the
<var class="product">Model 204 Version 7.5 or higher</var>. </li>

<li>To install an update to Dictionary/204,
open file <code>M204PROC</code> and execute the following command:
<p class="code">INCLUDE DICN.DDRINST</p>
<p>
Follow the instructions presented on the installation screen (and in the Help
text for the screen).</p> </li>

<li>Verify success of the installation by compiling each Dictionary/204 APSY. </li>

<li>Use the APSY named <var>DICTADMIN</var> to customize the <var class="product">Dictionary/204</var> environment. </li>
</ol>

==Preparing for Dictionary/204 installation==
The <var class="product">Dictionary/204</var> products are implemented as <var class="product">Model 204</var> subsystems.
The code for all the component subsystems resides in the file named <code>M204PROC</code> which is typically downloaded from the product section of the website.

===Obtaining product installation files===
The files necessary for the installation are available from the Rocket Software website.

To download product files from the Rocket website:
<ol>
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, (under construction) </li>

<li>After providing your registered customer login information, download the latest version of the <code>Dictionary/204</code> file (which is labeled "Dictionary/204 products in one file" followed by a version number).
<p>
A "Click here" link on this page provides Help on downloading format, some information about
different browser behaviors, file sizing information, and more.</p></li>
</ol>

===Determining eligible products===
To download files or maintenance from the Rocket M204 Customer Care area of the Rocket website, you must have a registered Rocket user ID ([[Contacting Rocket Software Technical Support|contact Technical Support]] if you need an ID).
The website will show only products for which your organization is up to date on maintenance or rental payments.
If a product does not appear on your download page and you believe it should,
contact Technical Support.

===System requirements===
<ul>
<li><var class="product">Dictionary/204</var> operates in a <var class="product">Model 204</var> Online region.
<p>
In the rest of this document, "Online" refers to a region of
<var class="product">Model 204</var> running an <var>ONLINE</var> load module containing Version 7.5 or higher
</p></li>
</ul>

===User privileges===
The installing user <i>must</i> have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>

<li>System Manager privileges, as well as access to all of the Dictionary/204 subsystems and the JCL or EXEC that
runs the Online <var class="product">Model 204</var> region. </li>
</ul>

===New installation or reinstallation===
<ul>
<li>Sites that have never installed <var class="product">Dictionary/204</var> ''must'' use the new installation, as there are a number of files to allocate and <var
class="product">Model 204</var> parameters to update.</li>

<li>Sites that are re-installing the latest version of <var class="product">Dictionary/204</var>
can either [[#Reinstallation for existing Dictionary/204 sites|reinstall]] Dictionary/204 (using DDRINST) or perform a [[#New installation|new installation]] (using DDINST) to create a new set of Dictionary/204 files.

<p>If you are upgrading from a previous version or maintenance level, your site already has the Dictionary files that contain information about your environment.</p> </li>
</ul>

==New installation==
<p class="note"><b>Note:</b> If you have never installed Dictionary/204 before, you must use these instructions. If you have installed Dictionary before, you can do a new install using these instructions if desired.</p>
You can verify the <var class="product">Dictionary/204</var> version in the title of any <var class="product">Dictionary/204</var> screen.
The installation steps are as follows:
<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, select the [https://m204.rocketsoftware.com/maint/ullist?nickname=M204 "Download Dictionary/204 files" link] in the "Downloads and Uploads" section to access the "Dictionary/204 files for Rocket Software Inc." page. </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.

<p>
<li>In file <code>M204PROC</code>, run the procedure <code>DICN.DDINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Reinstallation for existing Dictionary/204 sites==
You can verify the <var class="product">Dictionary/204</var> version either in the title of any <var class="product">Dictionary/204</var> screen.
The reinstallation steps are as follows:

<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, (under construction) </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.
<p>
If you are upgrading from a previous release, simply overlay your old <code>M204PROC</code> file.</p>
<p>
In file <code>M204PROC</code>, run the procedure <code>DICN.DDRINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Installing Dictionary/204 on IBM z/VM CMS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on z/VM CMS,
including z/VM CMS system and software requirements.

Review [[#Preparing for Dictionary/204 installation|Preparing for Dictionary/204 installation]] for details about general <var class="product">Dictionary/204</var> system requirements.

The <code>M204PROC</code> <var class="product">Model 204</var> file, which contains the <var class="product">[[SOUL]]</var> code that runs <var class="product">Dictionary/204</var>, can be [[#Obtaining product installation files|obtained from the Rocket website]].

The following table lists the required files needed to complete an installation of Dictionary/204.
<table class="thJustBold">
<tr class="head"><th>File name</th>
<th>Contents</th></tr>

<tr><th><i>Metadata</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>Datalink</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204temp</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204rpt</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204sys</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204dctl</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>
</table>

Allocate space for the <var class="product">Dictionary/204</var> files, and restore them from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]], as described in the following steps.

===Installation checklist (z/VM CMS)===

<ol>
<li>Define and format a minidisk to hold the <var class="product">Dictionary/204</var> installation files.
1500 4096-byte z/VM CMS blocks should be sufficient in all cases.
This requires a 22-cylinder z/VM CMS minidisk on a 3390. </li>

<li>Allocate space for the required <var class="product">Dictionary/204</var> data sets. A skeleton exec,
<code>D204FDEF</code>, is provided for this purpose.
Modify this exec to perform the allocations on the appropriate minidisks.
Allocate space for the following data sets:
<table class="thJustBold">
<tr><th>M204PROC
</th><td>6000 pages; must always be allocated.</td></tr>

<tr><th>Metadata
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>Datalink
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204temp
</th><td>150 pages; must always be allocated.</td></tr>

<tr><th>D204rpt
</th><td>110 pages; must always be allocated.</td></tr>

<tr><th>D204sys
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204dctl
</th><td>100 pages; must always be allocated.</td></tr>

</table>

<blockquote class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, modify the D204FDEF EXEC to use the old Dictionary/204 files for the upgrade.
<p>
The installation process uses these files to install a new version of Dictionary/204.
</p>
</blockquote> </li>

<li>Modify the RESPROC EXEC to specify the <code>M204PROC</code> dump file and <code>M204PROC</code> file to be loaded.</li>

<li>Restore the <code>M204PROC</code> file with the <var>D204 RESPROC</var> exec.
<p>To carry out the install, you must customize the FILEDEF inside the <var>D204FDEF</var> exec to conform to local standards.
In addition, modify <var>LOGONSM CCAIN</var> to contain a valid login ID and password.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </p></li>

<li>To run the <var>D204</var> exec for a new install, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 INSTALL</p></li>

<li>To run the <var>D204</var> exec for a REINSTALL, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 REINSTALL</p></li>

<li>Complete [[#updateJCL|steps 3 through the end]] in the [[#Installing Dictionary/204 on IBM z/OS|"Installing Dictionary/204 on IBM z/OS"]] section. </li>
</ol>

==Installing Dictionary/204 on IBM z/OS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/OS, including the z/OS system and software requirements.
If, like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/OS)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>An example command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:

<p>Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

<li>Verify that the Online environment allows the use of file groups and APSY 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 APSYs, 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.
<p>
For more information about APSYs and file groups, see [[Storing and using file group definitions (CCAGRP)#File groups|File groups]] and [[System requirements for Application Subsystems]]. </p></li>
</ul> </li>

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review the [[#Dictionary/204 server size |Dictionary/204 server size]] section, below, for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage may increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

==Installing Dictionary/204 on IBM z/VSE==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/VSE,
including z/VSE system and software requirements.

If like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/VSE)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>A sample command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<p>
Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

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

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

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify that the setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review [[#Dictionary/204 server size|Dictionary/204 server size]] for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage might increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

===Dictionary/204 server size===
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.
The actual server size requirements might vary slightly because of table
settings in the local Online <var class="product">Model 204</var> regions, and because of slight
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.
<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server
</th></tr>

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

Dictionary/204 installation guide

2016-07-20T21:44:10Z

MCosta: /* Obtaining product installation files */

==Overview==
<var class="product">[[Media:M204_DictionaryGuide_V75.pdf | Dictionary/204]]</var> Is a set of application subsystems (known as APSYs) running inside a <var class="product">Model 204</var> Online that provide full-screen and web-based tools to help programmers, DBAs, and system managers handle the complexities of <var class="product">User Language</var> and file and system management.

Installing <var class="product">Dictionary/204</var> requires downloading the <code>M204PROC</code> file and restoring it to your environment, setting up some subsidiary <var class="product">Model 204</var> files, and verifying that the environment has the appropriate parameter settings.

Upgrades to <var class="product">Dictionary/204</var> can almost always be handled by restoring a fresh copy of the <code>M204PROC</code> file.

==A summary of the Dictionary/204 installation steps==
The following checklist specifies in brief the steps to follow installing
<var class="product">Dictionary/204</var>, whether for z/VM CMS, z/OS, or z/VSE.
The sections [[#Installing Dictionary/204 under z/VM CMS|Installing Dictionary/204 under z/VM CMS]], [[#Installing Dictionary/204 under z/OS|Installing Dictionary/204 under z/OS]], and [[#Installing Dictionary/204 under z/VSE|Installing Dictionary/204 under z/VSE]] describe these steps in greater detail for each operating system.
<ol>
<li>Allocate the space required for the <code>M204PROC</code> data set,
and <var>RESTORE</var> it from the <var>DUMP</var> files found on the website.
<p>
In addition, there might be any number of other data sets required for
the <var class="product">Dictionary/204</var> components you are installing.
These are listed in [[#Installation checklist (z/VM CMS)|Installation checklist (z/VM CMS)]], [[#Installation checklist (z/OS)|Installation checklist (z/OS)]], and [[#Installation checklist (z/VSE)|Installation checklist (z/VSE)]]. </p> </li>

<li>Update the Online JCL or EXEC:
<ul>
<li>Add the DD cards, FILEDEFs or DLBLs for the Dictionary/204 files. </li>
</ul>

<li>Update CCAIN parameters:
<ul>
<li>Increase <var>[[NFILES parameter|NFILES]]</var>, <var>[[NDCBS parameter|NDCBS]]</var>, and <var>[[NDIR parameter|NDIR]]</var> for the Dictionary/204 files. </li>

</ul> </li>

<li>Start the Online, using an <var>ONLINE</var> load module that contains the
<var class="product">Model 204 Version 7.5 or higher</var>. </li>

<li>To install an update to Dictionary/204,
open file <code>M204PROC</code> and execute the following command:
<p class="code">INCLUDE DICN.DDRINST</p>
<p>
Follow the instructions presented on the installation screen (and in the Help
text for the screen).</p> </li>

<li>Verify success of the installation by compiling each Dictionary/204 APSY. </li>

<li>Use the APSY named <var>DICTADMIN</var> to customize the <var class="product">Dictionary/204</var> environment. </li>
</ol>

==Preparing for Dictionary/204 installation==
The <var class="product">Dictionary/204</var> products are implemented as <var class="product">Model 204</var> subsystems.
The code for all the component subsystems resides in the file named <code>M204PROC</code> which is typically downloaded from the product section of the website.

===Obtaining product installation files===
The files necessary for the installation are available from the Rocket Software website.

To download product files from the Rocket website:
<ol>
<li>On the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page, (under construction) </li>

<li>After providing your registered customer login information, download the latest version of the <code>Dictionary/204</code> file (which is labeled "Dictionary/204 products in one file" followed by a version number).
<p>
A "Click here" link on this page provides Help on downloading format, some information about
different browser behaviors, file sizing information, and more.</p></li>
</ol>

===Determining eligible products===
To download files or maintenance from the Rocket M204 Customer Care area of the Rocket website, you must have a registered Rocket user ID ([[Contacting Rocket Software Technical Support|contact Technical Support]] if you need an ID).
The website will show only products for which your organization is up to date on maintenance or rental payments.
If a product does not appear on your download page and you believe it should,
contact Technical Support.

===System requirements===
<ul>
<li><var class="product">Dictionary/204</var> operates in a <var class="product">Model 204</var> Online region.
<p>
In the rest of this document, "Online" refers to a region of
<var class="product">Model 204</var> running an <var>ONLINE</var> load module containing Version 7.5 or higher
</p></li>
</ul>

===User privileges===
The installing user <i>must</i> have:
<ul>
<li>Update access to the JCL or EXECs that bring up the host Online.</li>

<li>System Manager privileges, as well as access to all of the Dictionary/204 subsystems and the JCL or EXEC that
runs the Online <var class="product">Model 204</var> region. </li>
</ul>

===New installation or reinstallation===
<ul>
<li>Sites that have never installed <var class="product">Dictionary/204</var> ''must'' use the new installation, as there are a number of files to allocate and <var
class="product">Model 204</var> parameters to update.</li>

<li>Sites that are re-installing the latest version of <var class="product">Dictionary/204</var>
can either [[#Reinstallation for existing Dictionary/204 sites|reinstall]] Dictionary/204 (using DDRINST) or perform a [[#New installation|new installation]] (using DDINST) to create a new set of Dictionary/204 files.

<p>If you are upgrading from a previous version or maintenance level, your site already has the Dictionary files that contain information about your environment.</p> </li>
</ul>

==New installation==
<p class="note"><b>Note:</b> If you have never installed Dictionary/204 before, you must use these instructions. If you have installed Dictionary before, you can do a new install using these instructions if desired.</p>
You can verify the <var class="product">Dictionary/204</var> version in the title of any <var class="product">Dictionary/204</var> screen.
The installation steps are as follows:
<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, select the [https://m204.rocketsoftware.com/maint/ullist?nickname=M204 "Download Dictionary/204 files" link] in the "Downloads and Uploads" section to access the "Dictionary/204 files for Rocket Software Inc." page. </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.

<p>
<li>In file <code>M204PROC</code>, run the procedure <code>DICN.DDINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Reinstallation for existing Dictionary/204 sites==
You can verify the <var class="product">Dictionary/204</var> version either in the title of any <var class="product">Dictionary/204</var> screen.
The reinstallation steps are as follows:

<ol>
<li>In the [https://m204.rocketsoftware.com/ Rocket M204 Customer Care] page of the Rocket website, select the [https://m204.rocketsoftware.com/maint/ullist?nickname=M204 "Download Dictionary/204 files" link] in the "Downloads and Uploads" section to access the "Dictionary/204 files for Rocket Software Inc." page. </li>

<li>Download the latest version of the <code>M204PROC</code> file (which is labeled "All Dictionary/204
products in one file" followed by a version number).</li>

<li>Verify that the Online in which you are installing contains a version of <var class="product">Model204</var> equal to or greater than the <var class="product">Dictionary/204</var> version.</li>

<li>Restore the <code>M204PROC</code> file into a 6000-page file on your mainframe.
The DDNAME for this file in your <var class="product">Model 204</var> regions is also <code>M204PROC</code>.
<p>
If you are upgrading from a previous release, simply overlay your old <code>M204PROC</code> file.</p>
<p>
In file <code>M204PROC</code>, run the procedure <code>DICN.DDRINST</code> to install the downloaded release.</p></li>
</ol>

The <var class="product">Dictionary/204</var> APSYs can be set to <code>AUTOSTART</code> if you like.

==Installing Dictionary/204 on IBM z/VM CMS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on z/VM CMS,
including z/VM CMS system and software requirements.

Review [[#Preparing for Dictionary/204 installation|Preparing for Dictionary/204 installation]] for details about general <var class="product">Dictionary/204</var> system requirements.

The <code>M204PROC</code> <var class="product">Model 204</var> file, which contains the <var class="product">[[SOUL]]</var> code that runs <var class="product">Dictionary/204</var>, can be [[#Obtaining product installation files|obtained from the Rocket website]].

The following table lists the required files needed to complete an installation of Dictionary/204.
<table class="thJustBold">
<tr class="head"><th>File name</th>
<th>Contents</th></tr>

<tr><th><i>Metadata</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>Datalink</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204temp</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204rpt</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>D204sys</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>

<tr><th><i>M204dctl</i></th>
<td>File required for the installation of <var class="product">Dictionary/204</var>. </td></tr>
</table>

Allocate space for the <var class="product">Dictionary/204</var> files, and restore them from the dump files [[#Obtaining product installation files|downloaded from the Rocket website]], as described in the following steps.

===Installation checklist (z/VM CMS)===

<ol>
<li>Define and format a minidisk to hold the <var class="product">Dictionary/204</var> installation files.
1500 4096-byte z/VM CMS blocks should be sufficient in all cases.
This requires a 22-cylinder z/VM CMS minidisk on a 3390. </li>

<li>Allocate space for the required <var class="product">Dictionary/204</var> data sets. A skeleton exec,
<code>D204FDEF</code>, is provided for this purpose.
Modify this exec to perform the allocations on the appropriate minidisks.
Allocate space for the following data sets:
<table class="thJustBold">
<tr><th>M204PROC
</th><td>6000 pages; must always be allocated.</td></tr>

<tr><th>Metadata
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>Datalink
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204temp
</th><td>150 pages; must always be allocated.</td></tr>

<tr><th>D204rpt
</th><td>110 pages; must always be allocated.</td></tr>

<tr><th>D204sys
</th><td>400 pages; must always be allocated.</td></tr>

<tr><th>M204dctl
</th><td>100 pages; must always be allocated.</td></tr>

</table>

<blockquote class="warn">
'''Attention:''' <i>If you are upgrading from a previous release</i>, modify the D204FDEF EXEC to use the old Dictionary/204 files for the upgrade.
<p>
The installation process uses these files to install a new version of Dictionary/204.
</p>
</blockquote> </li>

<li>Modify the RESPROC EXEC to specify the <code>M204PROC</code> dump file and <code>M204PROC</code> file to be loaded.</li>

<li>Restore the <code>M204PROC</code> file with the <var>D204 RESPROC</var> exec.
<p>To carry out the install, you must customize the FILEDEF inside the <var>D204FDEF</var> exec to conform to local standards.
In addition, modify <var>LOGONSM CCAIN</var> to contain a valid login ID and password.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </p></li>

<li>To run the <var>D204</var> exec for a new install, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 INSTALL</p></li>

<li>To run the <var>D204</var> exec for a REINSTALL, make sure the Online execs and load modules are on an accessed disk, then enter this command:
<p class="code">EXEC D204 REINSTALL</p></li>

<li>Complete [[#updateJCL|steps 3 through the end]] in the [[#Installing Dictionary/204 on IBM z/OS|"Installing Dictionary/204 on IBM z/OS"]] section. </li>
</ol>

==Installing Dictionary/204 on IBM z/OS==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/OS, including the z/OS system and software requirements.
If, like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/OS)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>An example command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:

<p>Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

<li>Verify that the Online environment allows the use of file groups and APSY 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 APSYs, 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.
<p>
For more information about APSYs and file groups, see [[Storing and using file group definitions (CCAGRP)#File groups|File groups]] and [[System requirements for Application Subsystems]]. </p></li>
</ul> </li>

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users, and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review the [[#Dictionary/204 server size |Dictionary/204 server size]] section, below, for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage may increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

==Installing Dictionary/204 on IBM z/VSE==
This section gives instructions for installing <var class="product">Dictionary/204</var> on IBM z/VSE,
including z/VSE system and software requirements.

If like most sites, you download products and updates from the Rocket website,
see the instructions in [[#Reinstallation for existing Dictionary/204 sites|Reinstallation for existing Dictionary/204 sites]].

===Installation checklist (z/VSE)===
<ol>
<li>Allocate the space required for the Dictionary/204 files. If you are creating a new <code>M204PROC</code> file from scratch, this will not be a problem. But if you are restoring into your existing <code>M204PROC</code> file, you will have to <var>CREATE</var> the file first (to wipe out existing content) before you execute the <var>RESTORE</var>.
<p>A sample command sequence follows:</p>
<p class="code">CREATE FILE M204PROC
END CREATE
OPEN FILE M204PROC
IN M024PROC RESTORE 192 FROM <''whatever''>
</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
<td>6000 pages</td></tr>

<tr><th>METADATA
</th><td>400 pages</td></tr>

<tr><th nowrap>DATALINK</th><td>400 pages

<tr><th>M204TEMP</th>
<td>150 pages</td></tr>

<tr><th>D204RPT</th>
<td>110 pages</td></tr>

<tr><th>D204SYS</th>
<td>400 pages</td></tr>

<tr><th>M204DCTL</th>
<td>100 pages
</td></tr>
</table>

<p class="warn">'''Attention:''' <i>If you are upgrading from a previous release</i>, keep your old copies of <b>Dictionary/204 files</b>. The installation process uses these files to determine whether to perform upgrade actions or new-installation actions. </p> </li>

<li>Restore <code>M204PROC</code>, noting the following:
<ul>

<li>Rename database DSNs to conform to local standards. </li>

<li>Provide a valid logon ID and password for the CCAIN stream for this job.
If, for example, you are using the <code>M204PROC</code> file for the first time,
make sure it is created, opened, and initialized before the <var>RESTORE</var>. </li>
</ul> </li>

<div id="updateJCL"></div>
<li>Update the Online JCL or EXEC:
<p>
Add DD (z/OS) cards or FILEDEFs (z/VM CMS) or DLBLs (z/VSE) for the Dictionary/204 files.
The following list identifies the files for which DD cards or FILEDEFs might be needed:</p>

<table class="thJustBold">
<tr><th>M204PROC</th>
</tr>

<tr><th>METADATA
</th></tr>

<tr><th>DATALINK
</th></tr>

<tr><th>M204TEMP</th>
</tr>

<tr><th nowrap>M204DCTL</th></tr>

<tr><th>D204SYS
</th></tr>

<tr><th>D204RPT
</th></tr>
</table>

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

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

<li>Modify the User 0 stream.
<p>
Adjust these parameters: </p>
<table class="thJustBold">
<tr><th>NFILES
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDCBS
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NDIR
</th><td>Increase by the number of <var class="product">Dictionary/204</var> files.</td></tr>

<tr><th>NORQS
</th><td>Verify that the setting is at least 5.</td></tr>
</table> </li>

<li>Start the <var class="product">Model 204</var> Online region, verifying that it points
to a load module containing the <var class="product">Model204 Online</var>. </li>

<li>Issue <code>OPEN FILE M204PROC</code> (no password is required), and execute the following command:
<p class="code">INCLUDE DICN.DDRINST
</p>
<p>
This procedure performs all installation functions for new users and all upgrade functions for reinstalling users.
No user profiles or other site-specific customization will be lost.
If any problems are encountered while running this procedure, correct the problem and re-execute. </p>
<p>
During APSY execution, some error messages are not suppressed, to aid in diagnosing any installation problems.
For example, you will be able to see if an installation failed because a file was enqueued in a different Online, and so on. </p></li>

<li>Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.
<p>
The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.</p> </li>

<li>Verify the installation of the subsystem(s) by compiling all of the subsystems.
<table class="thJustBold">
<tr class="head"><th>Enter ...
</th><th>To test the ...
</th></tr>

<tr><th>START SUBSYS DICTIONARY
</th><td>DICTIONARY MENU</td></tr>

<tr><th>START SUBSYS DICTADMIN
</th><td>DICTIONARY ADMINISTRATION</td></tr>

<tr><th>START SUBSYS DOCUMENT
</th><td>Documentation environment</td></tr>

<tr><th>START SUBSYS FILEMGMT
</th><td>File building tool</td></tr>

<tr><th>START SUBSYS SUBSYSMGMT
</th><td>Defining APSY subsystems</td></tr>

<tr><th>START SUBSYS DICTREPORT
</th><td>Dictionary report subsystem</td></tr>

<tr><th>START SUBSYS XREF
</th><td>Cross reference reporting subsystem</td></tr>
</table>
<p>
If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under <code>TEST DEBUG</code> mode. For example, to determine why DICTIONARY failed to compile, enter: </p>
<p class="code">TEST DEBUG DICTIONARY
</p> </li>

<li>This step is optional.
Modify the online input stream so User 0 initializes (compiles) the <var class="product">Dictionary/204</var> subsystems.
Do this by placing one or more of the following in User 0's input stream:
<p class="code">START SUBSYS DICTIONARY
START SUBSYS DOCUMENT
START SUBSYS DICTADMIN
START SUBSYS FILEMGMT
START SUBSYS SUBSYSMGMT
START SUBSYS DICTREPORT
START SUBSYS XREF
</p>
<p>
This ensures that the subsystems are started for non-administrative
users, and it shifts the overhead of compilation to a non-peak
computing period. </p></li>

<li>Review [[#Dictionary/204 server size|Dictionary/204 server size]] for specific requirements of individual APSY components of <var class="product">Dictionary/204</var>.</li>
</ol>
<p class="note">'''Note:''' CCATEMP usage might increase with <var class="product">Dictionary/204</var>.
CCATEMP should be monitored (<code>VIEW TEMPSIZE</code>, <code>VIEW TEMPMAX</code>) to ensure that sufficient space is allocated to accommodate the additional activity. </p>

===Dictionary/204 server size===
The minimum <var class="product">Dictionary/204</var> server size requirements are listed below.
The actual server size requirements might vary slightly because of table
settings in the local Online <var class="product">Model 204</var> regions, and because of slight
differences between <var>UTABLE</var> requirements in different versions of <var class="product">Model 204</var>.
<table class="thJustBold">
<tr class="head"><th>Subsystem name
</th><th>Minimum server
</th></tr>

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

Getting started with OOP for User Language programmers

2015-12-10T20:21:30Z

MCosta: /* Collections */

[[Category:Tutorial]]
==Background==
So, you're a <var class="product">[[User Language]]</var> programmer and you're thinking about learning object-oriented programming (OOP):
<ul>
<li>Rumor has it you can be a more effective programmer if you use object-oriented techniques.

<li>You're tired of feeling inferior to object-oriented programmers because they speak a language that you don't understand but which sure as heck sounds impressive.

<li>You use [[Sirius Software]] products and Sirius has announced that all new <var class="product">User Language</var> functionality will use object-oriented syntax.

<li>"Object-oriented" looks better on your resume than "User Language."

<li>You just want to learn something new.
</ul>

Unfortunately, most <var class="product">User Language</var> programmers' first experience with object-oriented programming is painful and bewildering. Often it comes in the form of a VB.Net or Java class where the terminology flows freely from day one. Even worse:

<ul>
<li>Classes often emphasize how one architects an object-oriented application. While this might be a logical way to build an application, it's a daunting way to learn a language — like trying to learn ballroom dancing before you know how to walk.

<li>Teachers (and books about object-oriented programming) are often enamored with the more sophisticated aspects of object-oriented programming languages, leaving in the dust novices still struggling to digest the simpler concepts.

<li>Many object-oriented concepts are interrelated, so it often requires plowing ahead without fully understanding the concepts one has already learned.

<li>There was no way to put the concepts learned in a Java or VB.Net class to use in <var class="product">User Language</var>. So one is forced to work on object-oriented programming in one's free time, or the concepts are quickly forgotten.
</ul>

Fortunately, there <strong>is</strong> a way you can learn object-oriented programming and apply the principles on-the-job from day one!

One requirement for this is to work at a site where <var class="product">[[SOUL]]</var> (thus <var class="product">Model 204</var> V7.5 or higher) is available (or where at least some of the other Janus products, such as <var class="product">Janus Web Server</var> or <var class="product">Janus Sockets</var>, are available).

Before going further, a word about terminology: In English-speaking (as opposed to American-speaking) countries, object-oriented is usually called "object-orientated." More commonly, object-oriented programming is just called "OO."

==Mixed case code==
So, let's get started. First, if you're going to do OO programming, you've got to write your code in mixed case. No, there is no technical reason OO code in <var class="product">User Language</var> must be in mixed case, but:
<ul>
<li>It is easy enough to do, and even if you don't use OO, it makes your code look more modern.

<li>The industry consensus is that descriptive, often compound, words are better for variable, function, and subroutine names than terse non-descriptive names. For example, %itemNumber is better than %ITMN. While the latter is easier to type, the former is much easier to read. Using %ITEMNUMBER, on the other hand, clearly blunts some of that readability benefit. %itemNumber is written in what's called [http://en.wikipedia.org/wiki/CamelCase CamelCase].

<li>OO SOUL depends on CamelCase to make function and subroutine names readable.
</ul>

Fortunately, it's easy to start using mixed case code. Simply start typing your code in mixed case. What can possibly go wrong? If your system manager has set everything up nicely for you, nothing. But, if not, you might have a few glitches that are easy enough to fix:
<ul>
<li>If you use the Model 204 editor and type in mixed case code, and it gets converted to upper case when you enter it, you have two options:
<ul>
<li>Set *LOWER at command level. But this has the drawback that Model 204 commands now require holding down the shift key, because mixed case Model 204 commands do not work.

<li>Set the SIREDIT user parameter to X'33' (only the X'01' bit is required, but you may as well set some others) before entering the editor. This causes Model 204 to essentially switch to *LOWER mode before entering the editor. Request that your system manager do this for everyone by setting SIREDIT X'33' in CCAIN.
</ul>

<li>If you get compilation errors when you type in mixed case <var class="product">SOUL</var>, it means that the compiler is not running in case-independent mode. To fix this, you have these options:
<ul>
<li>Have your system manager set the X'01' bit in the <var>[[COMPOPT parameter|COMPOPT]]</var> system parameter. This must be done in CCAIN, and it is probably the best option.

<li>Change the BEGIN or B statement at the start of the request you're working on to use mixed case: that is, <code>Begin</code>, <code>begin</code>, or <code>b</code>.

<li>If you can't change the start of the program, add the line <code>Sirius Case ToUpper</code> (the case of the words doesn't matter) to the start of the procedure you are working on.
</ul>
</ul>

The following is an example of a mixed case <var class="product">User Language</var> program that starts with a mixed case <var>Begin</var>:
<p class="code">begin
print 'Hello World!'
end </p>
The following is an example of an <var>Include</var>d procedure that contains a <code>Sirius Case ToUpper</code> directive:
<p class="code">sirius case toUpper
subroutine hello
print 'Hello World!'
end subroutine </p>

Note that mixed case <var class="product">User Language</var> support is case independent. You can write <var class="product">User Language</var> statements in any case, and you can specify Model 204 variables with any case. The following illustrates a little island of mixed case code in the middle of some uppercase code:
<p class="code">SUBROUTINE FOOBAR(%INPUT IS FLOAT)
%MSG IS STRING LEN 32
%TOTAL IS FLOAT
...
if %input gt %total then
%msg = 'Input value too big'
end if
...
PRINT %MSG
END SUBROUTINE
</p>

This code illustrates the fact that you don't have to convert an entire procedure (or request) to mixed case to take advantage of mixed case <var class="product">SOUL</var>. Obviously though, in the long-term, it is a good goal to aim for relatively consistent casing in all your code. In the short term however, some inconsistency will have to be tolerated to get to the point where most or all <var class="product">SOUL</var> code is in mixed case. Certainly, any new procedures should be written completely in mixed case.

This example also demonstrates that you don't have to learn anything new to enter <var class="product">User Language</var> in mixed case (<strong>all</strong> statements still work the same way), so there is no excuse not to start.

==Object-oriented syntax==
The most pernicious difference between OO languages and procedural languages such as <var class="product">User Language</var> (called "UL" from here on) is the syntax. And the biggest syntactic difference between OO and UL is how functions and subroutines are invoked. Let's start with functions. All UL programmers know how to invoke a function.

First, functions are called $functions (dollar-functions) or £functions (pound-functions) in the UK. $functions (except some of the Sirius $functions) <strong>always</strong> return a value so must either be on the right side of an assignment, input to a subroutine or other $function call, or inside some UL expression. The following example, has a $substr in all three contexts:
<p class="code">%x = $substr(%y, 3, 10)
call clever($substr(%y, %start, %len))
%z = $substr(%y, %len, 1) + 10
</p>
As the above example shows, and all UL programmers know, a $function can be followed by the $function arguments (inputs) in parentheses with multiple arguments separated by commas.

OO functions, on the other hand, use a syntax where a function invocation consists of the thing (object, if you will) that the function is operating on specified <strong>before</strong> the function name, followed by its arguments inside parentheses. Many $functions have OO equivalents and $substr is no exception: its OO equivalent is called <var>[[Substring (String function)|Substring]]</var>. The following illustrates the use of the OO <var>Substring</var> function by replacing "$substr" in the previous example with "substring":
<p class="code">%x = %y:substring(3, 10)
call clever(%y:substring(%start, %len))
%z = %y:substring(%len, 1) + 10
</p>

While this might look strange to a <var class="product">User Language</var> programmer, it uses the most common OO syntax so can honestly be called OO programming. So, if you find any "$substr" call in your system and change it to use <var>Substring</var> (moving the first argument before a <code>:substring</code>), you have now done some OO coding. It's that easy!

To further add to your bona fides as an object oriented programmer, don't call <var>Substring</var> a function, but call it a '''method'''. In addition, don't call <code>%y</code> just a string, call it a '''string object'''. Now you're ready for something more advanced. Say "I applied the <var>Substring</var> method to the <var>String</var> object". Repeat until it feels natural to say it. Congratulations, you're well on your way to becoming an OO programmer and, maybe even a guru. If you're curious about what you just said:
<ul>
<li>Method is just a fancy word that means function or subroutine or any other called code that does something.
<li>Object is just a fancy word for a "thingy."
</ul>
Now, of course, there are many functions available other than just <var>Substring</var>. The functions that operate on strings are called '''Intrinsic String methods'''. You can find a list of the methods at [[List of String methods]]. There are also functions that operate on numbers. The list of these can be found at [[List of Float methods]].

Now, while congratulating yourself on your new-found skills, you might have a gnawing feeling that you really haven't accomplished a lot, as much as you have learned. So what have you accomplished? Is OO syntax really better than what you're used to? At first blush, it would seem worse, as the traditional $function call is more like English, where verb (function name) precedes the object (first parameter), as opposed to the OO syntax, where the order is reversed. For example, one would say "get the substring of %y" not "%y get the substring," so
<code>%x = $substr(%y, 2, 3)</code> <strong>seems</strong> more natural than
<code>%x = %y:substring(2, 3)</code>.
While this might be true, it's easy enough to get used to the second form — in many languages the object comes before the verb.

In any case, the chief advantage of OO syntax is that because the input of a function is to the left of the function, one can invoke a function and then pass the result of that function to another function by placing the second function call after the first. Similarly, a third function can be placed to the right of second to process its output. To illustrate, consider the following:
<p class="code">%x = %y:substring(%start, %len):toUpper:unspace </p>

This reads rather nicely, left to right: take "%y", get a substring, convert to uppercase, and remove extra blanks. The traditional version doesn't read nearly as nicely:
<p class="code">%x = $unspace($upcase($substr(%y, %start, %len)))</p>

Since the processing happens in inside out order, presumably one should read this code inside out but, of course, this is very difficult. In addition, because only a colon is required as a separator character, and because no dollar-sign is required to distinguish a function from other entities, the OO version is shorter, in spite of the fact that the function names are somewhat longer, and so, more meaningful. Perhaps more important, the OO expression contains fewer "noise" characters. All of these lead to much better readability for the OO expression. And, just as spaces can be placed around parentheses in a $function invocation to improve readability, spaces can be placed around the colon used to separate the object and function name:
<p class="code">%x = %y : substring( %start, %len ): toUpper :unspace </p>

This example used inconsistent spacing just to illustrate what's allowed, not to suggest that inconsistent spacing is recommended — it's not.

So, to continue the process of becoming an object-oriented <var class="product">User Language</var> programmer, you should familiarize yourself with the list of intrinsic String and Float methods, and try to use them wherever possible and in lieu of the $function equivalents. There is no performance penalty for doing so — in some cases OO functions and $functions share the same underlying code.

===Named parameters===
The Sirius object-oriented <var class="product">User Language</var> implementation has support for named parameters, parameters that can be specified by name, rather than position. While, strictly speaking, this has nothing to do with OO programming (in fact, few OO languages support it — Java and VB.Net do not) named parameters are used in many Sirius methods, so it is important to understand them. To specify a value for a named parameter, simply specify the name, followed by an equals sign (<tt>=</tt>), followed by the value. For example, the <var>Right</var> and <var>Left</var> String functions have a <var>Pad</var> named parameter that indicates the pad character to be used if the input string is shorter than the requested length:
<p class="code">%x = %y:right(20, pad='0') </p>

In this case, the name simply makes the code clearer, since without the following name,
it's far less obvious what the second parameter means:
<p class="code">%x = %y:right(20, '0') </p>

In functions with large numbers of parameters, the named parameters can also be very useful for eliminating the need for placeholder commas, and for making the function invocations more readable. String and Float methods tend not to have a lot of parameters so named parameters are not heavily used for them, but they <strong>are</strong> used here and there, so it's important to understand them.

==Stringlists==
The object-oriented extensions to <var class="product">User Language</var> use [[$lists]]. Most sites that <i>can</i> use $lists, <i>do</i> use $lists, because many [[List of $functions|Sirius $functions]] require them as input or outputs, and because they are just generally useful.
$lists are essentially objects because an object is a container for information that is accessed via a reference variable, and multiple reference variables can refer to the same object ($list). For example:
<p class="code">%list is float
%list2 is float
...
%list = $listNew
%list2 = %list
$listAdd(%list, 'Now is the winter')
print $listInf(%list2, 1)
</p>
In this example, the <code>Print</code> statement would end up printing "Now is the winter" even though the <code>$listAdd</code> added the line to <code>%list</code>.
Both <code>%list</code> and <code>%list2</code> point to the same $list (object) and so, it is not surprising that what is added via <code>%list</code> can be seen via <code>%list2</code>. It is clear, too, that <code>%list</code> and <code>%list2</code> must be '''pointers''' to $list objects and cannot be the objects, themselves, since a <var>Float</var> value couldn't possibly hold the contents of a $list.
An experienced UL programmer might raise an eyebrow at the line that contains the <code>$listAdd</code> in the above example. <var>$listAdd</var> is a '''function''', so it returns a value. But the <code>$listAdd</code> is not on the right side of an assignment. What gives? Well, the result of many $functions is usually "uninteresting" to the UL code, so it seems silly to have to find a variable to which to assign it. So the Sirius Mods allows <strong>certain</strong> $functions to be invoked without assigning its result to anything. This causes the $function to behave more like a subroutine as subroutines are called without obtaining a return value from the subroutine. It is this blurring of the distinction between functions and subroutines that leads to the OO term '''method''', which is a convenient way of referring to either.

So when you were using $lists, you were using object-oriented programming capabilities, even though you might not have realized it. However, you were <strong>not</strong> using object-oriented syntax to access the $list objects, so the benefits of a pure object-oriented facility were not available to you. Now, you might just say "Hold on, didn't you say strings are also objects?" Indeed they are. However, they're objects that can't be changed once they're set (so-called '''immutable''' objects) — you can't really change a string that's been assigned to a variable, you can only assign a new string to that variable. Most objects are not immutable, though of course, strings and numbers are <i>heavily</i> used, so they have importance disproportionate to their number. Nevertheless, the thing that distinguishes OO languages from non-OO languages is the presence of changeable (non-immutable) objects, so $lists can be viewed as a step toward object-oriented programming.

The pure object-oriented equivalent of $lists are called '''Stringlists'''. And, using a <var>Stringlist</var> is very similar to using a $list. To illustrate, let's take the above example and convert it to using <var>Stringlists</var>:
<p class="code">%list is object stringlist
%list2 is object stringlist
...
%list = new
%list2 = %list
%list:add('Now is the winter')
print %list2:item(1) </p>

Your first reaction might be an understandable "So what?" Well, let's take a look at what we've accomplished. First, we've made it much clearer what's in <code>%list</code> and <code>%list2</code>: references to <var>Stringlists</var>. This prevents accidents such as someone accidentally incrementing the value of a %list — the following would <strong>not</strong> be allowed:
<p class="code">%list is object stringlist
...
%list = %list + 1 <span style="color:red;"><==Invalid</span> </p>
Nor, would the following:
<p class="code">%list is object stringlist
%list2 is float
...
%list = %list2 <span style="color:red;"><==Invalid</span> </p>

While this might not seem that useful, it can be much more useful in complex applications with lots of different kinds of objects — except for strings and numbers, only object variables of the same "class" can be assigned to each other. "Wait a minute, what's a class?" you say. A '''class''' is simply a name for objects with identical characteristics. In this case, all <var>Stringlists</var> have a similar structure and have a fixed set of things you can do with them (like $lists). The distinction between a class and individual objects is the same as in normal usage — my blue Subaru is an object in the class of cars.

In any case, beyond the protection of accidental assignment mismatches, what else has using an OO <var>Stringlist</var> instead of a traditional $list bought us? Well, compare:
<p class="code">$listAdd(%list, 'Now is the winter') </p>
with
<p class="code">%list:add('Now is the winter') </p>

In the former, when the UL compiler hits the <code>$listAdd</code>, it has no idea that it's working with a $list. So, to distinguish <code>$listAdd</code> from other functions that might be doing an add of something to something, the word "list" has to be used as a qualifier in the $function name — it would not do to have the $function called simply <code>$add</code>. But, with the OO syntax, the compiler first hits the <code>%list</code> so now "knows" that whatever follows must be something specific to a <var>Stringlist</var>. So it is sufficient to use the function name <code>Add</code> because it can only mean the <var>Add</var> that applies to <var>Stringlists</var>, not to other classes. This means the following:
<ul>
<li>The OO statements tend to be shorter, because the extra qualifiers on the function names are unnecessary. This is often true even when the OO statements use longer, more meaningful function names than the non-OO equivalents.

<li>The absence of the extra qualifiers eliminates a lot of the "noise" in OO statements. Since $lists names usually have the word "list" in them to keep them straight from other variables, and since all the $list functions start with "$list", code that manipulates $lists often turns into the actual functional code swimming in a sea of the word "list".
</ul>

Consider, for example, code that subsets, sorts, and then prints the contents of a $list:
<p class="code">$list_print($listSort($listSub(%list, 'foo'), '1,10,A'))) </p>

Now, consider the OO equivalent:
<p class="code">%list:subset('foo'):sortNew('1,10,A'):print </p>

Not only is the OO version considerably shorter, it is much easier to follow — again, it can be read left to right.
In the $function version, our eyes glaze over at the sea of <code>$list</code>s and nested parentheses. While, this is an extreme example, it can safely be said that code using OO syntax is almost always tidier and easier to read than the traditional non-OO syntax.

Unfortunately, unlike using the OO syntax for intrinsic (<var>String</var> and <var>Float</var>) data, there is no really good way to simply change lines of code here and there to gradually migrate from using the pseudo-object-orientation of $lists to the full-on "true" object-orientation of <var>Stringlists</var>. Fortunately, many uses of <var>Stringlists</var> are fairly localized, so in many cases, changing an application from using $lists to using <var>Stringlists</var> can be a matter of changing a few dozen lines of code or fewer. While this doesn't provide any game-changing improvements in functionality (there are few things one can do with <var>Stringlists</var> that one can't do with $lists), it will:

<ul>
<li>Make code tidier and easier to understand, especially should your organization hire younger programmers who are familiar with object-oriented programming.

<li>Familiarize you with object-oriented syntax and object behavior.
</ul>

On this latter point, it is worth mentioning that because <var>Stringlists</var> are true objects, they correct the flakiness that can occur with $lists when the same <var>$listNew</var> (or other $list-creating statement) is executed multiple times. Because the same <var>$listNew</var> statement always returns the same $list identifier (number), situations where a <var>$listNew</var> is excuted multiple times can be buggy or confusing. Executing the same <var>New</var> operation for <var>Stringlists</var> multiple times, on the other hand, returns distinct <var>Stringlist</var> references and so eliminates the bugginess or confusion inherent in the $list equivalent.

It is worth emphasizing that a <var>Stringlist</var> object variable does <strong>not</strong> contain the <var>Stringlist</var> object any more than a variable used to hold a $list identifier contains the $list itself. In both cases, the variable contains a '''reference''' to the underlying object. So assigning one <var>Stringlist</var> object variable to another does not create a copy of the object (it simply copies the reference to the underlying object), just as assigning a $list identifier from one variable to another does not copy the $list itself. Although there is a <var>Copy</var> function for <var>Stringlists</var>:
<p class="code">%list is object stringlist
%list2 is object stringlist
...
%list2 = %list:copy </p>

The assignment of the references is much more efficient, of course, and in many cases, just what one wants, anyway.

<p class="note"><b>Note:</b> <var>Stringlists</var> are no more or less efficient than $lists; in fact, they share most of the same underlying code. </p>

Also, all <var>Stringlist</var> methods are <b>longstring capable</b>. That is, they a accept and return <var>[[Longstrings|Longstring]]</var> values (strings longer than 255 bytes). For historic reasons, the $list API contains a mix of longstring-capable and non-longstring-capable functions. Many of the non-longstring-capable $functions have extra parameters to deal with the fact that, while $list items could be longer than 255 bytes, they could only be processed 255 bytes at a time. The <var>Stringlist</var> API, written well after longstrings became available, didn't need to deal with any of these issues. This means that the $list API is considerably more complicated than the <var>Stringlist</var> API, without providing <i>any</i> additional functionality. This is just another reason to use the <var>Stringlists</var> in lieu of $lists.

So, in keeping with the theme of this page the recommendations are:
<ul>
<li>Find some existing $list code that is relatively localized, and convert it to use <var>Stringlist</var> objects.
<li>Write any new code using <var>Stringlists</var> rather than $lists.
</ul>

==Collections==
So far, we have seen how Strings and numbers are simply objects, and can be manipulated using OO syntax without much effort. We've also seen that $lists were really objects, and that $list identifiers behaved very much like object variables, albeit [http://en.wikipedia.org/wiki/Kludge kludgily] because there was no formal object support in <var class="product">User Language</var>. As such, with a modicum of effort, an application that uses $lists could be modified to use <var>Stringlists</var>, tidying up the code without any loss of functionality. As our last exercise in learning object-oriented programming we now look at '''Collections'''.

Collections are essentially object-oriented replacements for traditional Model 204 arrays, but, as you'll see, with considerably more functionality.

Model 204 arrays, unlike $lists, are most certainly <strong>not</strong> objects in the OO sense, because <var>Array</var> variables are not references to array objects, they are the arrays themselves. There is no way to have two variables referencing the same array (except in the special case of arrays being passed as parameters), and arrays are created at compile-time, unlike objects (and $lists) which are created at run-time. In addition to making arrays non-OO, these restrictions can be problematic for applications:
<ul>
<li>Application coders must determine ahead of time what the largest number of array items will be and allocate space for them, at compile time. This is both:
<ul>
<li>Wasteful of server space, as often the maximum likely array size is likely to be much bigger than the commonly required one.
<li>Insufficient, as invariably any arbitrary limit can and will ultimately be exceeded.
</ul>

<li>The inability to have multiple references to the same array can make certain code clumsy and unintuitive.
</ul>

Collections provide a nice object-oriented alternative to arrays. Like arrays, collection variables are declared as being composed of variables of a specific type. For example, an array of numbers might be declared as:
<p class="code">%numbers is float array(20) </p>

A comparable collection declaration would be something like:
<p class="code">%numbers is collection arraylist of float </p>

The word <code>collection</code> here means exactly the same thing as "object," but it is used to distinguish collection objects, which have certain special characteristics (such as having an <var>Of</var> clause in the declaration) from other objects. Because collections are so common in OO applications, the keyword <code>collection</code> is actually optional, and the above declaration could be more simply written as:
<p class="code">%numbers is arraylist of float </p>

Probably, the first thing that jumps out at you is the fact that we don't have to declare (and, in fact, can't) the maximum number of items to be allowed in the <var>Arraylist</var>. This means that <var>Arraylists</var> will only use as much space as is needed for the data at hand, and they will not add a lot to server size requirements for the odd cases where an <var>Arraylist</var> happens to have a lot of items. In fact, collection items are stored in CCATEMP on an as-needed basis, with only the currently referenced item being stored in the server. So, collections have very small server footprints.

One appealing aspect of using an <var>Arraylist</var> is that, by and large, references to <var>Arraylist</var> items are <strong>identical</strong> to references to <var>Array</var> items. That is, to set <code>%x</code> to the third item in either an <var>Array</var> or <var>Arraylist</var>, one can simply do:

<p class="code">%x = %numbers(3) </p>

And to set the the <code>%i</code>'th item in either an <var>Array</var> or an <var>Arraylist</var>, one can do:
<p class="code">%numbers(%i) = %x </p>

So, all one has to do to switch from using an <var>Array</var> to an <var>Arraylist</var> is to simply change the variable declaration? Well, not quite. Suppose we had something like:
<p class="code">%cost is float array(20)
%ncost is float
...
o: for each occurrence of cost
%ncost = %ncost + 1
%cost(%ncost) = value in o
end for </p>

Now, we change the above to:
<p class="code">%cost is arraylist of float
%ncost is float
...
o: for each occurrence of cost
%ncost = %ncost + 1
%cost(%ncost) = value in o
end for </p>

The problem we hit immediately is that the <var>Array</var> version of code never explicitly created the array — the array is created at compile-time. <var>Arraylists</var>, on the other hand, being objects need to be created at run-time — the OO term for this being [http://en.wikipedia.org/wiki/Instantiation_%28computer_science%29 instantiation]. This is identical to the requirement that a $list be created with a <var>$listNew</var>. Not having created an instance of the <var>Arraylist</var>, we will get a [http://en.wikipedia.org/wiki/Null_pointer#Null_pointer null pointer] error in our first reference to the object. We can fix this problem one of two ways. One way is to simply create a new <var>Arraylist</var> instance before using it:
<p class="code">%cost is arraylist of float
%ncost is float
...
%cost = new
o: for each occurrence of cost
%ncost = %ncost + 1
%cost(%ncost) = value in o
end for </p>

But, it is also possible to tell the OO infrastructure to automatically create a new <var>Arraylist</var> the first time it is referenced:
<p class="code">%cost is arraylist of float auto new
%ncost is float
...
o: for each occurrence of cost
%ncost = %ncost + 1
%cost(%ncost) = value in o
end for </p>

While in many instances this is a bad idea (since it can become unclear in the code where an object will be first created or where it's first intended to be created), experience has shown that, at least for collections, the use of <code>Auto New</code> usually works out fairly well. This is especially the case for applications where an <var>Array</var> was changed to an <var>Arraylist</var>.

But we hit a second problem with the above code: an attempt to set item number <code>%ncost</code> in the <var>Arraylist</var> in the above example will almost cause request cancellation, because that item won't be there, yet. This is really no different from the <var>Array</var> code where, if you tried to add a 21'st item to the array, you would get a request cancellation because the array was declared to have 20 items. However, because the array is created at compile-time with 20 entries, one <strong>can</strong> simply set items 1 through 20. When switching the code to use an <var>Arraylist</var>, the code will have to be changed, somewhat:
<p class="code">%cost is arraylist of float auto new
%ncost is float
...
o: for each occurrence of cost
%ncost = %ncost + 1
%cost:add(value in o)
end for </p>

While this makes it a bit more trouble to trivially change from using an <var>Array</var> to an <var>Arraylist</var>, often the populating of the array is isolated to one place, so the change is fairly trivial. Even better, it can eliminate the need for a count variable like <code>%ncount</code> since the code could be simply written as:
<p class="code">%cost is arraylist of float auto new
...
o: for each occurrence of cost
%cost:add(value in o)
end for </p>

"Hold on" you might say. "I need <code>%ncost</code> later on":
<p class="code">for %i from 1 to %ncost
%x = %cost(%i)
...
end for </p>

But, this is unnecessary. One nice thing about collections is you <strong>always</strong> have a <var>Count</var> function that returns the number of items in the collection so the above code could simply be written as:
<p class="code">for %i from 1 to %cost:count
%x = %cost(%i)
...
end for </p>

In addition to eliminating the need for the <code>%ncost</code> variable, this eliminates the chance of a bug where <code>%ncost</code> doesn't accurately reflect the count of items on the <var>Arraylist</var>. Of course, if you have a <strong>lot</strong> of references to <code>%ncost</code>, you might prefer not to fix them all up, in spite of the benefits. In this case, you could simply leave the incrementing of <code>%ncost</code> in the loop that populates the <var>Arraylist</var> or, if you're compulsive about performance, set it after the loop:
<p class="code">o: for each occurrence of cost
%cost:add(value in o)
end for
%ncost = %cost:count </p>

So, hopefully, it's clear that with minimal effort, an application can be changed from using an <var>Array</var> to an <var>Arraylist</var>. This would have the immediate benefit of reducing the server size required by the application while, at the same time, reducing any limit on the number of items one might put into the <var>Arraylist</var>. Even better, a wide variety of <var>Arraylist</var> functions become available once you've made this change.
There are functions to make copies of <var>Arraylists</var>, to sort them, to search them, to insert or remove items, to find minima and maxima, and much more. In addition, you have the power of multiple references to the same <var>Arraylist</var>. You can even have <var>Arraylists</var> of <var>Arraylists</var>, if that's useful.

All that said, there might be cases where it's non-trivial to convert from using an <var>Array</var> to an <var>Arraylist</var>. Specifically, your application might depend on the fact that the <var>Array</var> is pre-populated with a specific number of items. For example, suppose in the above example, there was an array of 20 items that corresponded to 20 possible product numbers and total costs are calculated as:
<p class="code">o: for each occurence of product.no
%cost(product.no) = %cost(product.no) + cost(occurrence in o)
end for </p>

Such an application does not lend itself to using the <var>Arraylist</var> <var>Add</var> method, since the product numbers won't necessarily arrive in numeric order. One approach would be to pre-populate an <var>Arraylist</var> with zeros:
<p class="code">for %i from 1 to 20
%cost:add(0)
end for </p>

But this somehow seems a bit <i>ad hoc</i> and dissatisfying. Another approach for such an application is to use a different kind of collection, a '''FloatNamedArraylist'''. A <var>FloatNamedArraylist</var> uses a number to index the items, but:
<ul>
<li>The item numbers don't have to be added sequentially.

<li>Negative and fractional indexes are allowed.
</ul>

Generally, the most useful aspect of <var>FloatNamedArraylists</var> is the first of these items (as it is in our example), but the second can be useful on occasion, too. Using a <var>FloatNamedArraylist</var>, we can now repair the above example:
<p class="code">%cost is floatNamedArraylist of float auto new
...
o: for each occurence of product.no
%cost(product.no) = %cost(product.no) + cost(occurrence in o)
end for </p>

But, this still isn't quite right. While one can set a <var>FloatNamedArraylist</var> item whether or not it currently has an explicitly set value, by default you cannot retrieve a value of an item that was never set. Since the assignment statement above first retrieves this current value of the item being updated, a request canceling error is guaranteed the first time it's executed. Fortunately, with the addition of a simple method call, the problem can be fixed:
<p class="code">%cost is floatNamedArraylist of float auto new
...
%cost:useDefault = true
o: for each occurence of product.no
%cost(product.no) = %cost(product.no) + cost(occurrence in o)
end for </p>

This setting of <code>UseDefault</code> to <code>True</code> means that a reference to an unset item number will return a default value which, for a <var>FloatNamedArraylist</var> is, of course, zero (though it could be set to something else, if needed). In fact, a <var>FloatNamedArraylist</var> provides a lower impact way of converting an <var>Array</var> to a collection than does an <var>Arraylist</var>. A <var>FloatNamedArraylist</var> with <code>UseDefault</code> set to <code>True</code> acts exactly like an <var>Array</var> with essentially no limit on the number of items and no cost for unused item numbers. So, if you had a <var>FloatNamedArraylist</var> with used item numbers 1, 500, and 9999, the <var>FloatNamedArraylist</var> would use no more space than if the used item numbers were 1, 2, and 3. This is what's known as a [http://en.wikipedia.org/wiki/Sparse_array sparse array]. Still, even though a <var>FloatNamedArraylist</var> provides a simpler migration from an <var>Array</var>, it is recommended that in the common case where the array/collection items are sequentially added, an <var>Arraylist</var> be used, as this provides a more natural way of representing the data, even though it might be a <strong>little</strong> more work.

Hopefully, you'll have noticed something unusual in the above code: while <code>UseDefault</code> <strong>looks</strong> like a function or subroutine invocation, it's actually being set. This is something called a '''property''', though it can also be thought of as a variable, too (much as images have variables that can be set). In any case, objects can have properties or variables with values that can be set or retrieved. The syntactic magic that allows the above <code>True</code> might also catch your attention. A UL programmer would guess that it's a field reference, but it's not — it's simply a boolean value. Hopefully, it seems natural enough that, for now, you're willing to accept and understand its meaning it without fully understanding the syntax.

As a last note about <var>FloatNamedArraylists</var>, it is possible to loop through only the items that have actually be set in the request. For example, the following prints the index and value for all set <var>FloatNamedArraylist</var> items in <code>%cost</code>:
<p class="code">%cost is floatNamedArraylist of float
...
for %i from 1 to %cost:count
print %cost:nameByNumber(%i) with ': ' with %cost:itemByNumber(%i)
end for </p>

The "name" of a <var>FloatNamedArraylist</var> item is the index, so if you had updated items 1, 73, and 9999, <code>NameByNumber</code> would return those numbers for input parameters 1, 2, and 3, respectively and, of course, <code>ItemByNumber</code> would return the value to which these items had been set.

Hopefully, by this point, you see:
<ul>
<li>How easy it is to change from using arrays to collections.

<li>The power that such a change provides.
</ul>

Collections are a big topic and there are many very useful subtopics that haven't been covered here:

<ul>
<li>The ability to have collections of any datatype such as <var>Strings</var>, <var>Longstrings</var>, or even objects such as <var>Stringlists</var> or other collections.

<li><var>NamedArraylists</var> provide collections where the index is a string. They provide <var class="product">User Language</var> with [http://en.wikipedia.org/wiki/Associative_array associative array] capability.
</ul>

===The magic Item method===
In converting an <var>Array</var> to a collection, it's critical that a collection item can be referenced in a syntactically identical way to an <var>Array</var>, namely with <code>%array(<i>subscript</i>)</code>. Not only is this incredibly useful for such a conversion, but it seems very logical and natural; so much so, that one might not give it a second thought.

However, in the object-oriented paradigm, the contents of an an object are <strong>always</strong> accessed by a method or variable name — in <var class="product">SOUL</var> via <code><object>:<member></code> syntax. So, what gives? Well, for collection objects, because the most common operation for a collection and the whole reason for the collection's existance is the ability to extract individual items from the collection, there is a default method if one is not specified explicitly: the <var>Item</var> method. This means that if <code>%foo</code> is an <var>Arraylist</var>, <code>%foo(4)</code> is functionally identical to <code>%foo:item(4)</code>. Which one is used is largely a matter of taste though, again, the fact that <code>%foo(4)</code> seems so natural suggests that there is generally no particularly good reason to explicitly specify <code>Item</code>.

In addition to collections, certain "collection-like" objects such as <var>Stringlists</var> can also use the implied <var>Item</var> method. <var>Stringlists</var> are not, strictly speaking, collections, since they cannot be made up of arbitrary datatypes (they have no <var>Of</var> clause on their declarations). However, for most purposes, they behave very much like an <var>Arraylist</var> of strings, so they are collection-like. As such, if <code>%sl</code> is a <var>Stringlist</var> object, <code>%sl(%i)</code> is functionally identical to <code>%sl:item(%i)</code>.

==Conclusion==
After reading this page and following its suggestions, you should be much more comfortable with object-oriented programming syntax and have a sense of how objects and object variables are used. This is half the battle in becoming an object-oriented programmer. The other half is writing your own classes (types of objects). But, it is possible to use object-oriented technology without ever writing your own classes. In fact, it is likely that many and maybe even most programmers in other OO languages write few if any of their own classes.

SOUL provides a wide variety of built-in (System) classes to increase the power of <var class="product">User Language</var> programmers and to give them plenty of practice writing OO code. Even if you never write your own classes, it is well worth moving to using object-oriented syntax and facilities as much as possible. Ultimately, you will get comfortable enough with the concepts that you will recognize the situations where you want to write your own classes, and you will have a sense of how those classes should be structured. If and when that happens, you will be ready to take the next step. Until then, you can already consider yourself an object-oriented programmer (though not an expert or "guru").

==See also==
<ul>
<li>[[Classes and Objects]]
<li>[[Methods]]
<li>[[Object variables]]
<li>[[Object oriented programming in SOUL]]
</ul>

[[Category:SOUL object-oriented programming topics]]
[[Category:SOUL]]

Model 204 installation on IBM z/VSE

2015-07-24T22:02:30Z

MCosta: /* Running M204CATP */

==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [http://sirius.sirius-software.com/download/m204catp.txt M204CATP job stream] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream, which catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204V75_VSE.MAC file to the POWER RDR queue, CLASS=0, in binary format. This file contains the M204VSE job stream, which catalogs source and macros into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LINKMLOD</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The EVCP module is a subset of the RSQL module. The code in EVCP contains code to process complex pattern matching. The code in RSQL contains the modules in EVCP along with the modules to support the SQL engine.

To link an ONLINE with RSQL and not EVCP, uncomment the following line in the JCL:

<p class="code">* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern</p>

To link an ONLINE with EVCP instead of RSQL, uncomment the following line:

<p class="code">* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher</p>

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LINKMLOD JCL is used to link M204L.
<p class="code"><nowiki>
// JOB LINKMLOD
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKMLOD links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
ENTRY M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

Model 204 installation on IBM z/VSE

2015-07-23T18:52:02Z

MCosta: /* Link editing the Model 204 phases */

==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [[Model 204 M204CATP job stream for IBM z/VSE|M204CATP]] [[link|job stream]] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream, which catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204V75_VSE.MAC file to the POWER RDR queue, CLASS=0, in binary format. This file contains the M204VSE job stream, which catalogs source and macros into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LINKMLOD</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The EVCP module is a subset of the RSQL module. The code in EVCP contains code to process complex pattern matching. The code in RSQL contains the modules in EVCP along with the modules to support the SQL engine.

To link an ONLINE with RSQL and not EVCP, uncomment the following line in the JCL:

<p class="code">* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern</p>

To link an ONLINE with EVCP instead of RSQL, uncomment the following line:

<p class="code">* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher</p>

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LINKMLOD JCL is used to link M204L.
<p class="code"><nowiki>
// JOB LINKMLOD
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKMLOD links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
ENTRY M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

Model 204 installation on IBM z/VSE

2015-07-23T18:49:10Z

MCosta: /* Link editing the M204L phase */

==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [[Model 204 M204CATP job stream for IBM z/VSE|M204CATP]] [[link|job stream]] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream, which catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204V75_VSE.MAC file to the POWER RDR queue, CLASS=0, in binary format. This file contains the M204VSE job stream, which catalogs source and macros into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LNKM204L</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The EVCP module is a subset of the RSQL module. The code in EVCP contains code to process complex pattern matching. The code in RSQL contains the modules in EVCP along with the modules to support the SQL engine.

To link an ONLINE with RSQL and not EVCP, uncomment the following line in the JCL:

<p class="code">* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern</p>

To link an ONLINE with EVCP instead of RSQL, uncomment the following line:

<p class="code">* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher</p>

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LINKMLOD JCL is used to link M204L.
<p class="code"><nowiki>
// JOB LINKMLOD
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKMLOD links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
ENTRY M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

Model 204 installation on IBM z/VSE

2015-07-23T18:43:52Z

MCosta: /* Link editing the M204L phase */

==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [[Model 204 M204CATP job stream for IBM z/VSE|M204CATP]] [[link|job stream]] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream, which catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204V75_VSE.MAC file to the POWER RDR queue, CLASS=0, in binary format. This file contains the M204VSE job stream, which catalogs source and macros into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LNKM204L</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The EVCP module is a subset of the RSQL module. The code in EVCP contains code to process complex pattern matching. The code in RSQL contains the modules in EVCP along with the modules to support the SQL engine.

To link an ONLINE with RSQL and not EVCP, uncomment the following line in the JCL:

<p class="code">* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern</p>

To link an ONLINE with EVCP instead of RSQL, uncomment the following line:

<p class="code">* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher</p>

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LNKM204L JCL is used to link M204L.
<p class="code"><nowiki>
// JOB LINKMLOD
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKMLOD links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
ENTRY M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

Model 204 installation on IBM z/VSE

2015-06-04T15:04:13Z

MCosta: /* Populating the library */

<span style="color:#BA0000"><b>Note:</b> This page is currently under construction.</span>
==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

For an example, see [[need section to link to|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [[Model 204 M204CATP job stream for IBM z/VSE|M204CATP]] [[link|job stream]] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream that catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204V75_VSE.MAC file to the POWER RDR queue, CLASS=0, in binary format. This file contains the M204VSE job stream that catalogs source and macros into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LNKM204L</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LNKM204L JCL is used to link M204L.
<p class="code"><nowiki>// JOB LNKM204L
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LNKM204L links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

Model 204 installation on IBM z/VSE

2015-06-04T14:54:56Z

MCosta: /* Populating the library */

<span style="color:#BA0000"><b>Note:</b> This page is currently under construction.</span>
==Overview==
This topic describes the steps required to upgrade from Rocket Model 204 version 7.4 to version 7.5, on the IBM<sup>®</sup> z/VSE<sup>®</sup> operating system.

For information on the new features available in version 7.5, see the [[Release notes for Model 204 version 7.5|7.5 Release notes]].

<table>
<tr><td><p>In order to upgrade to Model 204 version 7.5, <b>you must have version 7.4</b> and [[#Before you begin|various]] Early Warnings installed on your system.</p> </td></tr>
</table>

To upgrade to version 7.5, simply download, upload, and link the 7.5 object modules available from the downloads page to install the 7.5 components. In addition, you must [[#Procedures that can be cataloged|catalog procedure files]] in the V750 sublibrary that include DLBL/EXTENT information for existing or new Model 204 files.

==Before you begin==
<ul>
<li>In order to upgrade to version 7.5, you must have version 7.4 and Early Warnings for Dictionary/204 through 740DI016 installed on your system. For information on Early Warnings, log in to the [http://www.rocketsoftware.com/support Rocket Customer Portal].</li>
<li>Model 204 version 7.5 does not include new Dictionary/204 files or new CCASTAT and CCASYS files. You will be using your existing 7.4 versions of these files.</li>
<li>For system requirements for version 7.5, see the [[Release notes for Model 204 version 7.5#Operating system requirements|7.5 Release notes]].</li>
<li>You must have either a [[Rocket M204 user ID]] or a Sirius user ID to download the installation files.</li>
<li>The sublibrary containing the object has the authorization zap (covering your licensed processors) preapplied, so you do not need to get a new authorization zap from the website. (The preapplied zap will authorize Model 204 itself and any separately purchased products such as SirScan.)</li>
<li>The object files also have the maintenance zaps (as of the time the stream was
prepared) preapplied, so you do not need to apply any maintenance as part of this installation. (You will only need to apply any [https://m204.rocketsoftware.com/maint/fixlist new maintenance] when it becomes available for this release.)</li>
</ul>
<div id="steps"></div>

==Overview of upgrading steps==

Review the following high-level summary of steps before you begin downloading the <var class="product">Model 204</var> version 7.5 files.

For an example, see [[need section to link to|Example workflow for 7.5: download through installation]].

<ol>
<li>[[#M204CATP|Allocate and initialize]] the Model 204 library.

<li>[[#downloading|Download]] the Model 204 object file and macro library. You will need your [[Rocket M204 user ID]].</li>

<li>[[#populating|Populate]] the Model 204 library from the downloaded streams in the previous step.

<li>If you have your own user $functions (FUNU), you must do the following steps:
<ol style="list-style-type:lower-alpha;">
<li>[[#FUNU_7.5|modify FUNU for 64-bit addressing]] considerations and store the modified source in your V750 sublibrary.</li>
<li>If you have any user-defined messages (MSGU), store them in your V750 sublibrary.</li>
<li>[[#FUNU_7.5_assemble|Assemble]] FUNU (and MSGU, if applicable).</li>
</ol>
</li>

<li>If you use customized modules, such as CDTB, modify them as needed and [[#FUNU_7.5_assemble|assemble]] them.</li>

<li>Link the following phases and utility programs:
<ol style="list-style-type:lower-alpha;">
<li>[[#Linking the ONLINE phase|ONLINE]] phase</li>
<li>[[#Linking the IFAM1 phase|IFAM1]] phase, if you use it</li>
<li>[[#Linking the BATCH204 phase|BATCH204]] phase, if you use it</li>
<li><var class="product">Model 204</var> [[#link_phases|phases and utility programs]], such as [[#Installing CRAM|CRAM]] phases</li>
</ol>

<li>If you use the [[CICS interface]], customize it, and then [[#cics|assemble and link]] the CICS modules.</li>

<li>If your z/VSE site runs under z/VM, copy and link the [[#bvp204|$$BVP204]] phase.</li>

<li>[[#Allocating CCATEMP|Allocate CCATEMP]], a required data set used by Model 204 as the system scratch file.

<li>If you use [[#softspy|SoftSpy]], upgrade it for 7.5.</li>

<li>[[#Verifying Model 204 7.5 on your system|Verify]] that your upgrade to Model 204 7.5 was successful.</li>
</ol>

==Space and partition requirements==
===Model 204 disk space requirements===
Use the minimum disk space requirements for the libraries when calculating EXTENT information for Model 204 files.

Rocket recommends a minimum library size of 1200 tracks for disk type 3390.

===Reserving a partition===
Rocket recommends a minimum partition size of eight megabytes (8M) when installing Model 204.

Some Model 204 installation JCL might assign system files/devices (such as SYSIPT and SYSPCH) to disk. z/VSE requires that this JCL be run in a static partition.
<div id="M204CATP"></div>

==Preparing the Model 204 environment==


To prepare the Model 204 environment: run the M204CATP job, allocate CCATEMP, and catalog frequently used procedures.
===Running M204CATP===
The M204CATP job performs the following tasks:
<ul>
<li>allocates VSAM managed space for the Model 204 library (M204LIB)</li>
<li>defines the sublibraries (V750 and J750)</li>
<li>catalogs two Model 204 procedures (M204V750 and M204JCL) that help facilitate access to the Model 204 sublibraries</li>
</ul>
To run the M204CATP job:
<ol>
<li>Access the [[Model 204 M204CATP job stream for IBM z/VSE|M204CATP]] [[link|job stream]] text file and save it on your workstation.</li>
<li>Upload the job stream to the mainframe in ASCII format.</li>
<li>Modify the M204CATP job as noted in the file.</li>
<li>Submit the M204CATP job.</li>
</ol>

===Allocating CCATEMP===
CCATEMP is a required data set used by Model 204 as the system scratch file.

Allocate CCATEMP before running jobs that execute an ONLINE, BATCH204, or IFAM1 program.

<ol>
<li>Calculate the size of CCATEMP:
<p>Allocate a minimum of 25 pages per user if your site uses file groups, otherwise
allocate 20 pages per user.</p></li>
<li>Allocate CCATEMP by modifying and submitting the ALOCTEMP job.</li>
<li>Modify the M204SYS procedure to point to the newly allocated CCATEMP.</li>
</ol>

===Cataloging additional procedures===

You can store some of the more frequently used JCL in the form of cataloged procedures. The jobs to catalog these procedures are distributed in the J750 sublibrary.

To catalog procedures, modify each procedure as follows:
<ul>
<li>Add POWER JCL</li>
<li>Add the appropriate DLBL, EXTENT, and ASSGN information</li>
</ul>

The jobs assume that the M204JCL procedure is in the system library (IJSYSRS.SYSLIB). All other Rocket-supplied procedures are cataloged into the V750 sublibrary. <br />Determine the new file, library volumes, and extents; then modify the procedures before cataloging them.
====Procedures that can be cataloged====
The following shows the procedures that can be cataloged and the job that must be modified for each procedure.
<ol>
<li>Determine the files, library volumes, and extents that you need for the procedures.</li>
<li>Modify the catalog jobs with this information.</li>
<li>Catalog the procedures.</li>
</ol>

<table>
<caption>Jobs for cataloging frequently used procedures</caption>
<tr class="head"><th>Procedure name</th> <th>Catalog job</th> <th>Description</th></tr>

<tr><td>M204WRK1</td> <td>CATWRK1</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204WRK2</td> <td>CATWRK2</td> <td>Work file for translation and assembly</td></tr>

<tr><td>M204SYS</td> <td>CATSYS</td> <td>System files (CCASTAT and CCATEMP)</td></tr>

<tr><td>M204DD</td> <td>CATDD</td> <td>Dictionary/204 files and CCASYS</td></tr>
</table>

====Work file procedures====
You must catalog work file procedures in the CATWRK1 and CATWRK2 jobs for the following jobs that perform translation or assembly:

<ul>
<li>CICS jobs</li>
<li>CDBTASMC, FUNUASMC, MSGUASMC jobs</li>
</ul>
The CCASTAT and CCASYS files from version 7.4 are compatible with version 7.5.

==Building the object and macro sublibrary==
To build the object and macro sublibrary, you must download the object file and macro library and upload each to the mainframe.

<div id="downloading"></div>
===Downloading===

<ol>
<li>Using your [[Rocket M204 user ID]] and password, log in to the [https://model204.rocketsoftware.com/maint/objlist Model 204 object file download page].</li>
<li>Click the <b>Download object file</b> link beside the object library that you want to download. It contains the CATV750 job stream and is saved on your workstation as M204V75.OBJ.</li>
<li>Go to the [https://model204.rocketsoftware.com/maint/maclist Model 204 macro library download page].</li>
<li>Click the <b>Download macro library</b> link beside the macro library that you want to download. It contains the M204VSE job stream and is saved on your workstation as M204V75_VSE.MAC.</li>
</ol>
For details on how to download, see [[Downloading and uploading Model 204 installation components]].

Once the object and macro files are downloaded to your workstation, upload them to the z/VSE system on the IBM mainframe.

<div id="uploading"></div>
====Upload format and size====

You can use any file transfer mechanism to upload the files, including FTP and IND$FILE.

Specify these characteristics for the upload files:

<table class="noBorder">
<tr><td><b>transfer format:</b></td> <td>binary</td></tr>
<tr><td><b>record format:</b></td> <td>FB</td></tr>
<tr><td><b>record size:</b></td> <td>80 for each downloaded file</td></tr>
<tr><td><b>block size:</b></td> <td>6400 for each downloaded file</td></tr>
<tr><td><b>storage size for both:</b></td> <td>primary: 10 CYL; secondary: 5 CYL</td></tr>
</table>

<div id="populating"></div>
===Populating the library===

<ol>
<li>Upload the M204V75.OBJ file to the POWER RDR queue, CLASS=0, in binary format. This file contains the CATV750 job stream that catalogs object and JCL into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the CATV750 job stream from the RDR queue (<code>r rdr,catv750</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
<li>Upload the M204VSE job stream to the POWER RDR queue, CLASS=0, in binary format. This job will catalog source and macro into the Model 204 sublibrary, V750.</li>
<li>From the VSE console, release the M204VSE job stream from the RDR queue (<code>r rdr,m204vse</code>). At the pause, enter the DLBL statements for your Model 204 library.</li>
</ol>
<div id="bldLibs"></div>

<div id="cics"></div>

==Preparing site-specific FUNU, MSGU, and CDTB modules==
<div id="FUNU_7.5"></div>

===FUNUASMC, MSGUASMC, and CDTBASMC jobs===

If you use translation tables or user-written functions, you must change the source code in the FUNU.A, MSGU.A, and CDTB.A sublibrary members to accommodate the requirements of your site, as shown in the following table.
<table>
<caption>Customizable user modules</caption>
<tr class="head"><th>If you use...</th> <th>Then do this...</th> <th>Using this job</th></tr>

<tr><td>Your own User Language functions</td>
<td>Add them to the FUNU.A member</td>
<td>FUNUASMC</td></tr>

<tr><td>Error messages with your own User Language functions</td>
<td>Modify the MSGU.A member</td>
<td>MSGUASMC</td></tr>

<tr><td>$CODE and $DECODE functions to encode and decode character strings</td>
<td>Edit your own translation tables into the CDTB.A member</td>
<td>CDTBASMC</td> </tr>
</table>

The FUNU.A member contains one user function, $SEP, which adds separators when a date is entered in the format mm/dd/yy. MSGU.A also contains one sample error message.

You can use FUNU.A and MSGU.A to [[Customizing_functions_and_translation_tables|write your own user functions]]. The steps for installing the modules, as well as assembly considerations, are provided here.

It is recommended that if you think your site will make use of the TCP/IP Sockets Interface for Model 204, link the FUNU.A member during the installation process, even if you have not yet developed your own functions. This ensures access to the $ASCII and $EBCDIC functions.

<div id="FUNU_7.5_assemble"></div>
===Assembling FUNU, MSGU, and CDTB===

The following table identifies the JCL to assemble FUNU, MSGU, and CDTB, and catalog the object decks into the Model 204 sublibrary.
<table>
<caption>JCL library member for user modules</caption>
<tr class="head"><th>Member</th> <th>Assembles and catalogs user modules</th></tr>
<tr><td>FUNUASMC</td> <td>FUNU (functions)</td></tr>
<tr><td>MSGUASMC</td> <td>MSGU (messages)</td></tr>
<tr><td>CDTBASMC</td> <td>CDTB (code table)</td></tr>
</table>

Once the modules are assembled and cataloged, link the Model 204 phases to contain user code tables and/or user functions, specifying the V750 sublibrary (which contains the FUNU, MSGU, and CDTB modules) in the search list.

===Assembly considerations for FUNU and MSGU===
Some of the Model 204 macros and copy code needed to assemble FUNU and
MSGU contain assembly language statements that are not supported by the
z/VSE assembler. An assembly error occurs in the following circumstances:

<ul>
<li>
EQU statement specifies a length attribute or type attribute. The following example from the VARDEFS copy book illustrates the error:

<p class="code">VISLVL EQU 0,1 FIELD SECURITY LEVEL</p>
The error generated for this statement is:

<p class="code">IPK122 INVALID DELIMITER, ',1'</p>
</li>
<li>
EQU statement specifies a value that is too long or too large by assembler
rules. The following example from the STARTS macro illustrates the error:

<p class="code">MAXFS EQU 16777216/(4096*8) .MAX NUMBER OF INTERNAL FILE SEGMENTS</p>
The error generated for this statement is:

<p class="code">IPK117 VALUE OF SELF-DEFINING TERM '16777216' TOO LARGE</p>

See the z/VSE assembler error message IPK117 for more information.
</li>
<li>
Symbol defined by an EQU statement of the type described above is
referenced in a subsequent assembler statement. The following example
from the STARTS macro illustrates the error:

<p class="code">IVBN EQU ((MAXFS+7)/8). MAX # OF BYTES IN SEGMENT BIT PATTERN</p>

Where the error occurs because MAXFS is undefined (see the example in
the second bullet, above), the error generated for this statement is:

<p class="code">IPK149 SYMBOL 'MAXFS' NOT PREVIOUSLY DEFINED</p>
</li>
<li>
In FUNU, some undefined symbols generate the following statement:

<p class="code">QW9 ***** UNDEFINED *****</p>
The error generated for this statement is:
<p class="code">IPK149 SYMBOL 'QW9' NOT PREVIOUSLY DEFINED</p>
</li>
</ul>

The text generated is executable and executes properly (barring logic errors)
unless code that references an undefined symbol is executed.

Assembling FUNU and MSGU generates the errors described. However, in
FUNU, no assembly errors occur within the FUNUTAB table entries or within
the code for a user function (between the $name ENTER statement that begins
the function and the LEAVENUM, LEAVESTR, or LEAVEF0 macro that
terminates it). In MSGU, no assembly errors occur after the MSGU$ CSECT
statement. CDTB receives no assembly errors.

===z/VSE assembler errors===
Rocket Software takes no responsibility for the errors generated by the z/VSE
assembler. It is your responsibility to ensure that you do not code user functions
referencing symbols that are undefined due to an assembler error.

<div id="link_phases"></div>

==Link editing the Model 204 phases==

You must link all required phases and any optional phases that you want to use,
including utilities and sort exits.

To link any of the Model 204 phases, run the job listed for that phase in the following table. This table also lists utilities you might need and the jobs used to link or relink them.

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5. Phases that you must relink for 7.5 are listed as Required in the following table.
<table>
<caption>Executable phases and jobs used for linking or relinking</caption>
<tr class="head"><th>Phase or utility</th>
<th>Required / Optional</th>
<th>Purpose / Notes</th>
<th>Job</th>
<th>For more details, see ...</th></tr>

<tr><td>$$BVP204</td> <td>Required (for z/VSE under z/VM)</td> <td>z/VM-directed output logical transient. Required on z/VSE
systems running under z/VM.</td> <td>LINK$BVP</td> <td>[[#Linking the $$BVP204 phase|Linking the $$BVP204 phase]]</td></tr>

<tr><td>ALLOCATE</td> <td>Required</td> <td>Initializes Model 204 database files
<p>Required for Installation JCL, SQL installation, and Dictionary/204</p></td> <td>LINKALOC</td> <td>[[ALLOCATE utility in z/VSE]]</td></tr>

<tr><td>AUDIT204</td> <td>Required</td> <td>Generates an audit trail for printing out later, and produces statistical
reports and analysis</td> <td>
LINKAUDT</td> <td>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204 utility|AUDIT204 utility]]</td></tr>

<tr><td>BATCH2</td> <td>Optional</td> <td><p>Establishes a User Language connection to a Model 204 ONLINE running in a separate region</p>
Optional; recommended for CRAM testing.</td> <td>
LINKBAT2</td> <td>[[BATCH2 (TCP/IP)]]</td></tr>

<tr><td>BATCH204</td> <td>Required</td> <td><p>Handles a single user in batch mode</p> <p>Required to complete installation</p>
Link or relink when:
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of CICS (M204 CICS Interface)</li>
</ul></td><td>LINKB204</td> <td>[[#Linking the BATCH204 phase|Linking the BATCH204 phase]]</tr>

<tr><td>
CRAMSWT</td> <td>Optional</td> <td>CRAM non-master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
CRAMZWT</td> <td>Optional</td> <td>CRAM master subtask</td> <td>LINKCRAM</td> <td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
DFHPSF</td> <td>Optional</td> <td>CICS/IFAM2 Interface</td> <td>PSFASM</td> <td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
HASH15</td> <td>Optional</td> <td>Sort exit for M204HASH</td> <td>LINKHA15</td> <td>[[Hash key files#Using M204HASH in the z/VSE environment|Using M204HASH in the z/VSE environment]]</td></tr>

<tr><td>
IFAM1</td> <td>Optional</td> <td>Host Language Interface single-thread configuration
<p>Link or relink when installing or upgrading to a new release of Model 204. (You can ignore UNRESOLVED ADCON
messages.)</p></td>
<td>LINKIFM1</td> <td>[[Using HLI and batch configurations#IFAM1|IFAM1]]</td></tr>

<tr><td>
IGCLM244</td> <td>Optional</td> <td>CRAM load module</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>
M204CRPS</td> <td>Optional</td> <td>CICS full-screen printer routine</td><td>CRPSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204L</td> <td>Optional</td> <td>Loads a Model 204 phase above the line</td><td>LNKM204L</td><td>[[#Link editing the M204L phase|Link editing the M204L phase]]</td></tr>

<tr><td>
M204PRNT</td> <td>Optional</td> <td>CICS 3270 print routine</td><td>PRNTASMC</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>
M204PSFS</td> <td>Optional</td> <td>CICS full-screen remote User Language interface routine</td><td>PSFSASM</td><td>[[#Updating the CICS System Definition (CSD)|Updating the CICS System Definition (CSD)]]</td></tr>

<tr><td>MERGEJ</td> <td>Required</td> <td>Media recovery journal merge utility</td><td>LINKMRGJ</td><td>[[System and media recovery#Using the MERGEJ utility|Using the MERGEJ utility]]</td></tr>

<tr><td>OI15</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI15</td><td>[[Deferred update feature]]</td></tr>

<tr><td>OI35</td> <td>Optional</td> <td>File Load utility sort exits</td><td>LINKOI35</td><td>[[Deferred update feature]]</td></tr>

<tr><td>ONLINE</td><td>Required</td> <td>Link online.
<p>Link or relink when:</p>
<ul>
<li>Installing user modules FUNU, MSGU, CDTB</li>
<li>Installing or upgrading to a new release of Model 204</li>
<li>Moving to a different release of
CICS (M204 CICS Interface)</li></ul></td>
<td>LINKONLN</td><td>[[#Linking the ONLINE phase|Linking the ONLINE phase]]</td></tr>

<tr><td>SNAPCRAM</td> <td>Optional</td> <td>CRAM control block SNAP dump
routine</td><td>LINKCRAM</td><td>[[#Installing CRAM|Installing CRAM]]</td></tr>

<tr><td>UTILC</td> <td>Required</td> <td>Prints the Model 204 checkpoint file</td><td>LINKUTLC</td><td>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|Obtaining checkpoint information (UTILC)]]</td></tr>

<tr><td>UTILJ</td> <td>Required</td> <td>Prints and copies Model 204 journal files</td><td>LINKUTLJ</td><td>[[System and media recovery#Using the UTILJ utility|Using the UTILJ utility]]</td></tr>

<tr><td>UTLA</td> <td>Optional</td> <td>Prints the Model 204 audit trail</td><td>LINKUTLA</td><td>[[Tracking_system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#z/VSE and the audit trail|z/VSE and the audit trail]]</td></tr>

<tr><td>ZBLDTAB</td> <td>Optional</td> <td>Initializes the Model 204 password table. Required to allocate and
initialize CCASTAT.</td><td>LINKZBTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>

<tr><td>ZCTLTAB</td> <td>Optional</td> <td>Convert CCASTAT for the Password Expiration feature. Required to convert an existing CCASTAT data set to allow data control of passwords.</td><td>LINKZCTB</td><td>[[Storing security information (CCASTAT)]]</td></tr>
</table>

===Linking the ONLINE phase===
[[Model 204 LINKONLN job stream for IBM z/VSE|LINKONLN]] is the JCL member for linking the ONLINE phase and contains INCLUDE statements for the Model 204 core and all features. Uncomment the features that you are going to use.

Because the features for CICS do not affect the ONLINE phase, there are no INCLUDE statements for CICS.

===Linking the IFAM1 phase===
LINKIFM1 is the JCL member for linking the IFAM1 phase and contains an INCLUDE statement for the Model 204 core.

The following sample LINKIFM1 JCL is used to link IFAM1.

<p class="syntax"><nowiki>LINKIFM1 JCL example
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE IFAM1,* REPLACE=YES
INCLUDE LKIFM1
ENTRY IFII1
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the BATCH204 phase===
LINKB204 is the JCL member for linking the BATCH204 phase and contains
an INCLUDE statement for the Model 204 core and all features. Uncomment the features that you are going to use.

The following sample LINKB204 JCL is used to link BATCH204.

====LINKB204 JCL example====
<p class="syntax"><nowiki>// JOB LINKB204
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LINKB204 links/catalogs the MODEL 204 BATCH204 phase
/*
/* Note: if using LE functions in MODEL 204,
/* - add INCLUDE statements for LE modules
/* - concatenate appropriate sublibrary to search.
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
PHASE BATCH204,* REPLACE=YES
* INCLUDE LKNOSONL /* Uncomment for Pattern Matcher
* INCLUDE LKSQLONL /* Uncomment for Remote SQL and Pattern Matcher
ENTRY MAINTASK
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Link editing the M204L phase===
To run above the line (in 31-bit addressing space), you need to link the M204L program, which acts as an intermediary to load Model 204 phases above the line.

In the PARM clause of the EXEC statement, indicate the Model 204 load module that M204L will load above the line.

In the following example, ONLINE will be loaded above the line and then invoked:

<code>// EXEC M204L,SIZE=AUTO,PARM='ONLINE'</code>

The following sample LNKM204L JCL is used to link M204L.
<p class="code"><nowiki>// JOB LNKM204L
* ********************************************************************
* Rocket Model 204
* 02/15
* ********************************************************************
* LNKM204L links/catalogs the MODEL 204 M204L phase
/*
/*
// EXEC PROC=M204JCL DLBL for JCL sublibrary
// LIBDEF PROC,SEARCH=M204LIB.V750
// EXEC PROC=M204V750 DLBL for V750 M204 library
// LIBDEF PHASE,CATALOG=M204LIB.V750
// LIBDEF OBJ,SEARCH=M204LIB.V750
// OPTION CATAL
ACTION ERRLMT(500)
PHASE M204L,* REPLACE=YES
INCLUDE M204L
/*
// EXEC LNKEDT
/*
/&
</nowiki></p>

===Linking the CRAM phases===
The Cross-Region Access Method (CRAM) lets two or more Model 204 users in two or more partitions communicate with each other.
CRAM is used by:
<ul>
<li>BATCH2</li>
<li>CICS Interface</li>
<li>IFAM2</li>
</ul>
See [[Defining the user environment (CCAIN)]] for more information about CRAM.

To link the CRAM phases (CRAMSWT, CRAMZWT, IGCLM244, and SNAPCRAM), use the [[Model 204 LINKCRAM job stream for IBM z/VSE|LINKCRAM]] job from the J750 sublibrary.

===Linking the Model 204 utility phases===

Most of the utility phases from Model 204 version 7.4 will continue to perform correctly when used with version 7.5.

However, you must use the 7.5 version of the following utilities, which are sensitive to the Model 204 journal and checkpoint format.
The link jobs are available in the J750 sublibrary.
<table>
<tr class="head"><th>Utility</th><th>Description</th><th>Link job</th></tr>
<tr><td><b>[[ALLOCATE utility in z/VSE|ALLOCATE]]</b></td> <td>Initialize Model 204 database files</td> <td>LINKALOC</td></tr>
<tr><td><b>[[Tracking system activity (CCAJRNL, CCAAUDIT, CCAJLOG)#AUDIT204_utility|AUDIT204]]</b></td> <td>Extract from journal, with report stats and analysis</td> <td>LINKAUDT</td></tr>
<tr><td><b>[[System and media recovery#Using the MERGEJ utility|MERGEJ]]</b></td> <td>Merge concurrent journal streams</td><td>LINKMRGJ</td></tr>
<tr><td><b>[[Checkpoints: Storing before-images of changed pages#Obtaining checkpoint information (UTILC)|UTILC]]</b></td> <td>Information from checkpoint stream</td><td>LINKUTLC</td></tr>
<tr><td><b>[[System and media recovery#Using the UTILJ utility|UTILJ]]</b></td> <td>Information from journal stream; add EOF markers</td><td>LINKUTLJ</td></tr>
</table>

===Link editing messages===
When link editing any Model 204 programs, the following messages appear one or more times in the output listing:
<p class="code">2139I DUPLICATE SECTION DEFINITION: COPR *** SECTION IGNORED ***

2158I NO CSECT LENGTH SUPPLIED</p>

These messages result from the linkage editor flagging any duplicate CSECT as an error in a new release of system software. If the message reads exactly as above, you can ignore it. However, if the error message displays anything
other than COPR, [[Contacting Rocket Software Technical Support|contact Technical Support]].

Also, you will typically see Unresolved External warnings for the following references, which you may ignore: FORTRAN modules such as DTRNH, DSQRT, and so on.

==CICS interface installation==

The Model 204 CICS interface allows CICS complete access to Model 204 facilities and supports CICS pseudo conversational programs.
<p class="note"><b>Note:</b> It is not necessary to install the CICS interface if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

===Requirements===
<ul>
<li>CICS Transaction Server support
<p>Rocket M204 supports the CICS Transaction Server versions 3.1, 3.2, 4.1, and 4.2.</p></li>
<li>Supporting TPROCESS COBOL applications
<p>If your CICS TPROCESS application was originally linked with AMODE=24, you must relink the CICS TPROCESS application specifying AMODE=31 because AMODE=24 is not supported.</p></li>
</ul>

===CICS interface overview===
For an overview of the CICS interface, including storage requirements and a listing of CICS interface components, see [[CICS interface]].

<div id="cics_install"></div>
===Installing the CICS interface===

<ol>
<li>Customize the interface by editing the CICFG copy member and replacing it in the distribution library as CICFG.A. Then proceed with the CICSASM and CICSLINK jobs.
<p>For information on customizations needed for using the CICS Standard Mapping Service, see [[CICS interface]].</p></li>
<li>Update the CICS System Definition (CSD) using one of the following methods:
<ul><li>Resource Definition Online (CEDA).</li>
<li>The IBM DFHSCDUP offline utility, to process the definitions in batch.</li>
<li>Processing the CICS Program Control Table (PCT) and Program Processing Table (PPT).</li>
</ul>
<li>Assemble, translate, and catalog the Model 204 CICS Interface modules, using the following jobs:
<ul>
<li>[[Model 204 CRPSASM job stream for IBM z/VSE|CRPSASM]]</li>
<li>[[Model 204 ENTPSASM job stream for IBM z/VSE|ENTPSASM]]</li>
<li>[[Model 204 OPLTASMC job stream for IBM z/VSE|OPLTASMC]]</li>
<li>[[Model 204 PPCIASM job stream for IBM z/VSE|PPCIASM]]</li>
<li>[[Model 204 PRNTASMC job stream for IBM z/VSE|PRNTASMC]]</li>
<li>[[Model 204 PSFASM job stream for IBM z/VSE|PSFASM]]</li>
<li>[[Model 204 PSFSASM job stream for IBM z/VSE|PSFSASM]]</li>
</ul>
</li>
<li>Relink the IFAM2 transactions requiring pseudo conversational support with IFENTPS.</li>
<li>Relink all user process-to-process partners with IFPPCI.</li>
</ol>

===Updating the CICS System Definition (CSD)===
You can update the CSD by using CEDA, by using the DFHCSDUP utility, or by processing the CICS Program Control Table (PCT). Use the values in the following table, where appropriate, for the method you choose. Information about
using CEDA follows the table.

<b>CICS System Definition values</b>
<table>
<tr class="head"><th>User program</th> <th>Program name</th> <th>Transaction ID</th> <th>Modifiable <br>CICFG symbol</th>
<th>TWA size</th></tr>

<tr><td>IFAM2 pseudo conversational</td> <td>DFHPSF</td> <td>DFHPSF is accessed by using a CICS LINK. <br />It is never
invoked with a transaction ID from a terminal.</td> <td>N/A</td> <td>N/A</td><tr>
<tr><td>Full-screen interface</td> <td>M204PSFS</td> <td>M204</td> <td>&TRN</td> <td>88</td></tr>
<tr><td>Screen copy transaction</td> <td>M204CRPS</td> <td>U204</td> <td>N/A</td> <td>N/A</td></tr>
<tr><td>Screen print transaction</td> <td>M204PRNT</td> <td>P204</td> <td>&COP</td> <td>88</td></tr>
</table>

CEDA (the Resource Definition Online transaction) or the DFHCSDUP utility defines the transactions and programs to the CSD file.

If you are not using tables, then define the transactions and programs by using CEDA
and the values in the previous table, as in the following example:
<p class="syntax">CEDA DEFine PROG(program_name)
GRoup(group_name)
LANGuage(ASSEMBLER)
RELoad(NO)
RESident(NO) (Except for DFHPSF, RESident(YES))
STatus(ENABLED)

CEDA DEFine TRANsaction(trans_ID)
GRoup(group_name)
PROgram(program_name)
TWASIZE(twa_size_value)
.
.
.
CEDA CHeck GRoup(group_name)
CEDA INstall GRoup(group_name)
</p>

You can use a transaction ID for a user program that is different from the value
shown in the previous table. However, if you do so, you must change the associated
CICFG symbol shown in the table.

As shown in the preceding example, group_name is any valid group name for the
user site.

<p class="note"> <b>Note:</b> Remember to add the groups to the GRPLIST for the particular CICS
region. If the groups are not added, they are not installed during each CICS initialization.</p>

===Processing the PCT and PPT===
The JCL sublibrary members PCTNTRY and PPTNTRY have the Program Control Table (PCT) and the Program Processing Table (PPT) default values shown in the following sections. You can update the CSD by adding to or modifying these default values and then assembling the tables.
====PCT: Program Control Table====
The Program Control Table (PCT) assigns user programs to their related CICS transaction identifiers (the transaction codes). Entries are required for both the 3270 full-screen interface and the screen print transaction.

The JCL sublibrary member, PCTNTRY, contains the PCT default values shown in the following code:
<p class="code">DFHPCT TYPE=ENTRY,PROGRAM=M204PSFS,TRANSID=M204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204PRNT,TRANSID=P204,TWASIZE=88
DFHPCT TYPE=ENTRY,PROGRAM=M204CRPS,TRANSID=U204</p>

The following entry in the PCT is required for all user IFAM2 transactions:

<p class="syntax">DFHPCT TYPE=ENTRY,PROGRAM=program_name,TRANSID=xxxx,TWASIZE=88</p>

Use the values in the previous table if you are updating the PCT. If you use a transaction ID for a user program that is different from the value shown in that table, you must change the associated CICFG symbol.

====PPT: Program Processing Table====
The Program Processing Table (PPT) stores program attributes. Entries are required for the 3270 full-screen interface, direct printer support, and the IFAM2 interface.

The JCL sublibrary member, [[PPTNTRY job stream for IBM z/VSE|PPTNTRY]], contains the PPT default values shown in the following code.

<p class="note"><b>Note:</b> In the first line of the PPT, be sure to set the RES parameter to YES; otherwise, the transaction does not complete successfully.</p>

<p class="code">DFHPPT TYPE=ENTRY,PROGRAM=DFHPSF,RES=YES,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204CRPS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PRNT,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=M204PSFS,PGMLANG=ASSEMBLER
DFHPPT TYPE=ENTRY,PROGRAM=OBPLTSD,PGMLANG=ASSEMBLER</p>

===Assembling the CICS Interface modules===
Assemble, in the sequence listed, the CICS Interface modules listed in the
assembly step in the [[#cics_install|CICS interface installation]] section.

Some assemblies display a warning message (DFHEIMSG 4) because the
CSA address is release-dependent. If the interface program is running in the
release under which it was assembled, ignore the warning.

After the modules are successfully built, relink as directed in the [[#cics_install|CICS interface installation]] section.

<div id="bvp204"></div>

==Linking the $$BVP204 phase==

<p class="note"><b>Notes:</b> Information about linking $$BVP204 applies only to z/VSE sites running under z/VM. <br />
It is not necessary to link the $$BVP204 phase if it has been installed for a previous version of Model 204. The phases from the older version are compatible with version 7.5 of Model 204.</p>

The $$BVP204 phase is a transient: it is required for the z/VM-directed output
feature, and it is invoked by Model 204 to issue diagnostic instructions in order
to pass CP commands to z/VM.

Linking $$BVP204 to the system library improves performance.

===LINK$BVP job===
To link $$BVP204, use the LINK$BVP job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

===COPYVMPR job===
To copy $$BVP204 to the System Residence Library, use the COPYVMPR job from the J750 sublibrary.

This is a required step in a Model 204 installation on z/VSE running under z/VM.

<div id="softspy"></div>

==Installing SoftSpy for 7.5==

See the [[SoftSpy installation guide]] for instructions on installing SoftSpy version 7.5.

==Verifying Model 204 7.5 on your system==
To perform an initial verification that your upgrade to 7.5 was successful, issue the following commands from the Model 204 command line.
<table>
<tr class="head"><th>Command</th> <th>You should see...</th></tr>
<tr><td>ROCKET</td> <td>A list of authorized Model 204 products (including 7.5) currently on your system.</td></tr>
<tr><td>DISPLAY ZAPS</td> <td>A list of Model 204 zaps (including 7.5 zaps) on your system.</td></tr>
<tr><td>DICTADMIN</td> <td>The Dictionary Administration subsystem, displaying <code>Release 7.5</code> on its menu screens.</td></tr>
<tr><td>SUBSYSMGMT</td> <td>The Application Subsystem facility, displaying <code>VER 7 REL 5</code> on its menu screens.</td></tr>
</table>

==See also==
<ul>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/OS]]</li>
<li>[[Upgrading to Model 204 version 7.5 on IBM z/VM CMS]]</li>
</ul>

==Additional information==
Refer to the <i>[http://docs.rocketsoftware.com/nxt/gateway.dll/RKBnew556%2Fmodel%20204%2Fprevious%20versions%2Fv7.4%2Fm204_installzvse_v74.pdf Rocket Model 204 Installation Guide for IBM z/VSE, version 7.4]</i>, for additional installation information.

[[Category:Installation]]

JsonCircularReference class

2015-05-01T20:04:45Z

MCosta:

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a [[Json class#Circular references|circular reference]].

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[#New constructor|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<p>The following example catches a circular reference exception and prints the string where the circular reference occurs.
</p>
<p class="code">b
%jsonCircRefError is object JsonCircularReference
%jsa is object json
%jsb is object json
%jsc is object json

%jsa = array('a')
%jsb = array('b')
%jsc = array('c')
%jsa:add(%jsb)
%jsb:add(%jsc)
%jsc:add(%jsa)

try
print %jsa:stringify
catch JsonCircularReference to %jsonCircRefError
print 'Caught Json Circular Reference Error'
print %jsa:tostring
end try
end
</p>

Running this example results in:
<p class="code">Caught Json Circular Reference Error
["a",["b",["c",[Circular]]]]
</p>
[[Category:System exception classes]]

Release notes for Model 204 version 7.6

2015-05-01T19:37:50Z

MCosta: /* Json class */

These release notes list the enhancements and other changes contained in Model 204 version 7.6.

==Overview==
These release notes contain installation and features information for the Rocket Model 204 version 7.6 release.
Before beginning your installation, please read through this information about product installation and changes.

==New in this release==
This section summarizes the new features and enhancements for Model 204 version 7.6.
<table>
<tr class="head"><th>Category</th>
<th>Feature</th>
<tr>
<td nowrap>SOUL (User Language)</td>
<td>
<ul>
<li>[[#New SOUL statements|Private]] keyword for class declarations; Friend declarations for Class blocks</li>
<li>[[#Json class|Json class]] for exchanging data with other platforms using the JSON format</li>
<li>[[#Web class|Web class]] as a container for Janus Web Server specific methods</li>
<li>[[#Utf8ToUnicode and Utf16ToUnicode string methods|Utf8ToUnicode and Utf16ToUnicode string methods]] can now handle values that cannot be translated into EBCDIC</li>
</ul>
</td>
</tr>

<tr>
<td>Performance</td>
<td>
<ul>
<li>[[#Massive zIIP offload|Improvements to the zIIP offload]] ensure that almost all Model 204 MP-capable code is offloaded to zIIP</li>
<li>Improved zIIP processing for [[#User-written $functions and zIIPs|user-written $functions]]</li>
<li>New [[#Journal and checkpoint processing enhancements|journal and checkpoint write PSTs]] (pseudo subtasks)</li>
<li>[[#64-bit addressing and Above The Bar (ATB) storage|STBL and VTBL]] can now be placed above the (2G) bar</li>
<li>[[#Support for OI CHUNK fields in field groups|CHUNK attribute]] for DEFINE FIELD can now be specified for fields in a field group</li>
</ul>
</td>
</tr>

<tr>
<td>former-Sirius product enhancements</td>
<td>
<ul>
<li>[[#SCREENTHROW setting for Janus Web Legacy|New SCREENTHROW setting]] for Janus Web ports to improve error handling for Janus Web Legacy applications</li>
</ul>
</td>
</tr>

<tr>
<td>
Debugging and testing</td>
<td>
<ul>
<li>[[#Unicode linefeed now causes line break on print|Unicode linefeed]] now causes a line break on print</li>
</ul>
</td>
</tr>
</table>

==Operating system and hardware requirements==
===Operating system requirements===
<p style="color:red">Requirements for Model 204 version 7.6 are still being determined.</p>

<ul>
<li><b>IBM z/OS</b>
<ul>
<li>Versions supported: z/OS version 1.07 through [[Model 204 technical specifications#z/OS 2.1 compatibility issues|2.1]].</li>
<p>Version 1.07 is sufficient for all functionality except for the following features:</p>
<ul>
<li>Large (1 MB) page support requires version 1.9.</li>
<li>Extended address volumes (EAV) requires version 1.12.</li>
</ul>
</li>
</ul>
On z/OS, Model 204 release 7.6 operates as an APF authorized load module, as required by many 7.6 features. <br />
To run Model 204 unauthorized, [[Contacting Rocket Software Technical Support|contact Technical Support]].

<li><b>IBM z/VM</b>
<ul>
<li>Versions supported: z/VM version 5.4 through 6.3.</li>
</ul>
</li>

<li><b>IBM z/VSE</b>
<ul>
<li>Versions supported: z/VSE version 5.1 and 5.2.</li>
</ul>
</li>
</ul>

=== Hardware requirements ===
<p style="color:red">Requirements for Model 204 version 7.6 are still being determined.</p>

Model 204 version 7.6 requires the IBM z/890 or above processor, except for the following feature:
<p>
The large (1 MB) page support feature requires the IBM z10 or above processor. </p>

===Model 204 compatibility with operating systems===
<p style="color:red">Content for version 7.6 is still being determined.</p>
For information on Model 204 certification with IBM operating systems, see:
http://www.rocketsoftware.com/products/rocket-model-204/technical-information

<div id="Connect* compatibility with Model 204"></div>
===Connect* compatibility with Model 204===
Connect<span class="superstar">★</span> version 7.6 is compatible with all versions of Model 204.
For more information on Connect<sup>★</sup> installation, see the <var class="book">[[Media:M204_ConnectStarInstallProgram_V75.pdf|Connect* Suite Installation and Programming Guide]]</var>.

See also [[#Connect* enhancements|Connect<span class="superstar">★</span> enhancements]].

==SOUL enhancements==

===New SOUL statements===
<ul>
<li>The [[Classes and Objects#Class block syntax|Private]] keyword has been added to class declarations and [[Classes and Objects#Friend declarations|Friend declarations]] have been added to Class blocks.</li>
</ul>

===Non-OO enhancements in SOUL===

===New and changed classes and methods===
The LabeledArrayList (or TaggedArrayList) class is to be added.

====Json class====
The [[Json class]] has been created to facilitate exchange of data with other platforms using the [http://en.wikipedia.org/wiki/JSON JSON format]. This class contains a large number of methods and also adds three new exception classes: [[InvalidJsonType class|InvalidJsonType]], [[JsonCircularReference class|JsonCircularReference]], and [[JsonParseError class|JsonParseError]], and one new enumeration: [[Json class#The JsonType enumeration|JsonType]]. In addition, the [[JsonParse (Unicode function)|JsonParse]] function was added to the Unicode intrinsic class.

====Web class====
The [[Web class]] has been created as a container for Janus Web Server specific methods. This class contains two new methods: [[ScreenInputCallback (Web property)|ScreenInputCallback]] and [[ScreenOutputCallback (Web property)|ScreenOutputCallback]]. There is also an associated new system type: [[WebScreenCallback type|WebScreenCallback]] and a new [[WebScreenException class|WebScreenException]] exception class.
====Utf8ToUnicode and Utf16ToUnicode string methods====
The [[Utf8ToUnicode (String function)|Utf8ToUnicode]] and [[Utf16ToUnicode (String function)|Utf16ToUnicode]] string methods can now handle values that cannot be translated into EBCDIC. The <var>AllowUntranslatable</var> argument, now available for general use and <var>True</var> by default, specifies that such values will be stored into the target Unicode string rather than producing an exception.

===New and changed $functions===

==Sirius products and product enhancements==
This section describes enhancements to [[Sirius Software product list|the former-Sirius products]].

===Changes to Janus Web Server===
IPV6 Support for Janus TCP/IP Base is to be added.

====SCREENTHROW setting for Janus Web Legacy====
The new [[SCREENTHROW and NOSCREENTHROW (JANUS DEFINE parameters)|SCREENTHROW]] setting for Janus Web ports allows janus Web Legacy applications to trap client errors rather than deferring to the default Janus Web Legacy support error handling behavior.

===Changes to Fast/Unload and Fast/Reload===
These products are to be equipped with 64-bit addressing and Above The Bar (ATB) storage.

===RockZap for VSE===
Support is being added for running RockZap under z/VSE.

==File-related enhancements==

===New field attributes===
<p>
This section lists the new field attributes. For more information on how related attributes work together, see the [[Field design]] topic.</p>
TBD

==System management enhancements==
TBD

==Performance enhancements==

===Massive zIIP offload===
The approach to zIIP (IBM System z Integrated Information Processor) support in Model 204 prior to version 7.6 is to offload to zIIP only [[Performance monitoring and tuning#Model 204 workload eligible for zIIP offload|certain eligible code]] safe for execution on the zIIP engine. The V7.6 improvements to the zIIP offload make most of the Model 204 code zIIP tolerant: almost all MP-capable code (Model 204 code that may run on an MP subtask) is offloaded to zIIP. Code that cannot be executed on zIIP uses the MP subtask or a maintask.
<p class="note"><b>Note:</b>
While a limited version of this capability is available to all customers, the fully improved zIIP support requires an additional license. For more information, [[Contacting Rocket Software Technical Support|contact Rocket Software]].</p>

<p>
This feature is for z/OS systems only. As previously, specifying a nonzero value for the <var>[[NMPSUBZ parameter|NMPSUBZ]]</var> parameter activates zIIP processing.</p>

====User-written $functions and zIIPs====
Instead of having to indicate what code should run on zIIP, it is only necessary now to indicate what Assembler code may not run on zIIP. Customers planning to use zIIP processing must do either of these:
<ul>
<li>Inspect any [[Customizing functions and translation tables#Converting user-written functions|user-written $functions]] for non-tolerant code (code that uses an SVC instruction or system services that may use SVC, like BSAM, VTAM, task-mode z/OS macros), which must be bracketed with <code>SRBMODE OFF</code> and <code>SRBMODE ON</code>. </li>

<li>Specify <code>MP=NO</code> (the default) or no <var>MP</var> setting at all [[Customizing functions and translation tables#Additional requirements for MP/204 (multiprocessing)|in the function table]] to cause $functions to run on a maintask. Any other value for <var>MP</var> enables $functions to run on zIIP subtasks. </li>
</ul>
<p>
It is not always obvious if code may or may not run on a zIIP subtask. Even if all explicit SVCs and non-task-mode system macros issued by Model 204 have been identified and bracketed, some may be issued implicitly by z/OS or other services, so user testing is important. </p>

====Parameter changes for zIIP usage====
The following are V7.6 changes to the [[Performance_monitoring_and_tuning#Model 204 parameters for zIIP support|documented recommendations]] for the parameters that initiate and control Model 204 zIIP processing:
<ul>
<li>Parameter <var>ZQMAX</var> is deprecated. If you have specified a value for <var>ZQMAX</var>, it is now ignored.</li>

<li>X'01' becomes the default value of the <var>[[SIRFUNC parameter|SIRFUNC]]</var> parameter.
<p>
The X'01' bit of <var>SIRFUNC</var> must be set (explicitly or as the default value) for zIIP processing or the run is cancelled.</p></li>

<li>The <var>[[XMEMOPT parameter|XMEMOPT]]</var> X'02' bit was not documented as necessary for zIIPs. It <i>is</i> necessary as of V7.6.</li>

<li>It is now <b><i>strongly recommended</i></b> that customers running MP/204 not set the X'40' bit of the <var>[[SCHDOPT parameter|SCHDOPT]]</var> parameter as MP subtasks will no longer steal work from zIIP SRBs unless they seem overloaded, in which case one would probably not want the <var>SCHDOPT</var> X'40' bit to prevent MP subtasks from helping out.</li>
</ul>

===Journal and checkpoint processing enhancements===
<p>
New journal and checkpoint write PSTs (pseudo subtasks) are invoked by the <var>SYSOPT2</var> parameter. </p>
<p>
A dual mode of operation (with and without write PSTs) is available: if the new PSTs are not created (for any reason), the journal and checkpoint processing continues as it does in version 7.5 of Model 204. </p>
<p>
The <var>NSUBTKS</var> parameter is also crucial: If <var>SYSOPT2</var> indicates new PSTs but <var>NSUBTKS</var> is too low, the Online will not come up.</p>



===64-bit addressing and Above The Bar (ATB) storage===
Storage above the (2G) bar increases scalability, performance, and growth potential. 64-bit addressing is the de facto standard for Model 204.

<ul>
<li>ATB support for FTBL was released with Model 204 version 7.4.</li>
<li>ATB support for GTBL, NTBL, and QTBL was released with Model 204 version 7.5.</li>
<li>ATB support for STBL and VTBL is added in Model 204 version 7.6.</li>
</ul>

When using non-swappable ATB server space, each user gets <var>[[SERVNSSZ parameter|SERVNSSZ]]</var> bytes of ATB space, even if the thread is logged out or running resident requests. For greater efficiency, Model 204 also provides swappable ATB server areas that can supplement or replace the non-swappable areas. These swappable ATB server areas are controlled by the <var>[[SERVGA parameter|SERVGA]]</var> and <var>[[SERVGSZ parameter|SERVGSZ]]</var> parameters.

As more features use ATB buffers, it is a good idea to reevaluate your ATB and BTB buffer usage.

====STBL and VTBL in above the bar storage====
STBL and VTBL can now be placed into swappable or non-swappable server storage area above the bar.
<p>In order to store a table in ATB storage:</p>
<p style="color:red">TBD: any changes to SERVNSSZ or SERVNSA for 7.6</p>
<ul>
<li>Increase the <var>[[SERVNSSZ parameter|SERVNSSZ]]</var> parameter by the corresponding table size.
<li>Set the proper bit in <var>[[SERVNSA parameter|SERVNSA]]</var>:
<ul>
<li>for STBL set the xxx byte to <code>X'xx'</code>, so the value of <var>SERVNSA</var> is <code>X'........'</code></li>
<li>for VTBL set the xxx byte to <code>X'xx'</code>, so the value of <var>SERVNSA</var> is <code>X'........'</code></li>
</ul>
</ul>
<p class="note">'''Note:'''
The settings for each server table above the bar are independent of each other.
So if FTBL, GTBL, NTBL, QTBL, STBL, and VTBL are all placed above the bar, then <var>SERVNSA</var> should be set to <code>X'........'</code>.</p>

===Support for OI CHUNK fields in field groups===
The CHUNK attribute for DEFINE FIELD was introduced in Model 204 version 7.5 to improve the efficiency of range finds using Ordered Index (OI) processing. The CHUNK attribute can now be specified for fields in a field group.

===64-bit addressing support for TBO buffers, the Procedure dictionary, and Longstrings===
This support will be new in version 7.6.

==Debugging and testing enhancements==
====Unicode linefeed now causes line break on print====
Printing or auditing a unicode string that contains a unicode linefeed character (u+000a) will now cause a new line to be started on the output device, rather than displaying <code>
</code>. This should make it much easier to look at unicode strings that contain formatting linefeeds. This feature works for any display-oriented statements such as Print, Audit, Trace, PrintText, AuditText, TraceText, Text, etc.

====SoftSpy====
As of version 7.5, the SoftSpy debugging, testing, and performance tuning product has been included as part of the Model 204 core product.

For more information about SoftSpy version 7.6, see the [http://m204stage.rocketsoftware.com/index.php/Release_notes_for_SoftSpy_V7.6 SoftSpy 7.6 release notes].

<div id="Connect* enhancements"></div>
==Connect<sup>★</sup> enhancements==
The 7.6 version of Connect<sup>★</sup> for JDBC, Connect<sup>★</sup> for .NET, and Connect<sup>★</sup> for ODBC is now available. <br />
For more information on Connect<sup>★</sup> installation, see the <var class="book">[[Media:M204_ConnectStarInstallProgram_V75.pdf|Connect* Suite Installation and Programming Guide]]</var>.

Each Connect<sup>★</sup> interface contains the latest fixes and enhancements and is compatible with Model 204 version 7.6.

==MQ/204 enhancements==

TBD

==Other features==
TBD

==Compatibility issues==
====Unicode linefeed now causes line break on print====
Printing or auditing a unicode string that contains a unicode linefeed character (u+000a) will now cause a new line to be started on the output device, rather than displaying <code>
</code>. This should make it much easier to look at unicode strings that contain formatting linefeeds. This feature works for any display-oriented statements such as Print, Audit, Trace, PrintText, AuditText, TraceText, Text, etc..

While this feature is likely to make it much easier to examine unicode strings, in theory it could cause a backward-compatbility problem for applications that parse the results of a Print of unicode data, expecting the <code>&x#000A;</code> values to be present.

==New and changed commands==

===SWITCH STREAM (new parameter: RESET)===
The <var>[[SWITCH STREAM command|SWITCH STREAM]]</var> command has added an optional RESET parameter that will cause any disabled parallel GDG members to be reopened during the switch. RESET is valid only for a CCAJLOG stream specified as a Parallel GDG.


==Reliability enhancements==
TBD

==New and changed parameters==

===New CFROPTS system parameter===
The new <var>[[CFROPTS parameter|CFROPTS]]</var> parameter makes it possible to request that Model 204 use strict fair share enqueuing for critical file resource lock conflicts.

===New X'20' bit for RCVOPT===
The X'20' bit of the <var>[[RCVOPT parameter|RCVOPT]]</var> parameter prevents the flushing of dirty pages for a file that does not do pre-imaging (<var>[[FRCVOPT parameter|FRCVOPT]]</var> X'20' set) during a subtransaction checkpoint.





==Documentation conversion to wiki format==
Rocket Model 204 documentation is being converted from individual manuals in PDF format to a set of cross-linked HTML articles in this integrated wiki, M204wiki.

As of Model 204 release 7.6, most manuals are now in wiki format. The rest remain in PDF format, available in the M204 folder of the [http://docs.rocketsoftware.com/nxt/gateway.dll?f=templates$fn=default.htm Rocket Software Documentation Library].

For details, see [[Model 204 documentation]].

==New and updated messages==

See [[New and updated messages in Model 204 version 7.6 -- DRAFT|New and updated messages in Model 204 version 7.6]] for details.

[[Category: Release notes]]

Template:List of classes and methods

2015-05-01T19:32:21Z

MCosta: /* Exceptions */

==System classes==
<table>
<tr><td style="border-right:0">CharacterMap class:</td><td style="border-left:0">[[CharacterMap class|Synopsis]] | [[List of CharacterMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">CharacterToUnicodeMap class:</td><td style="border-left:0">[[CharacterToUnicodeMap class|Synopsis]] | [[List of CharacterToUnicodeMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[Collections|Collection]] classes <ul class="nobul"><li>Arraylist class:<li>FloatNamedArraylist class:<li>NamedArraylist class:<li>UnicodeNamedArraylist class:</ul> </td>

<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Arraylist class|Synopsis]] | [[List of Arraylist methods|Methods]]<li>[[FloatNamedArraylist class|Synopsis]] | [[List of FloatNamedArraylist methods|Methods]]<li>[[NamedArraylist class|Synopsis]] | [[List of NamedArraylist methods|Methods]]<li>[[UnicodeNamedArraylist class|Synopsis]] | [[List of UnicodeNamedArraylist methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Daemon class:</td><td style="border-left:0">[[Daemon class|Synopsis]] | [[List of Daemon methods|Methods]]</td></tr>

<tr><td style="border-right:0">Dataset class:</td><td style="border-left:0">[[Dataset class|Synopsis]] | [[List of Dataset methods|Methods]]</td></tr>

<tr><td style="border-right:0">Email class:</td><td style="border-left:0">[[Email class|Synopsis]] | [[List of Email methods|Methods]]</td></tr>

<tr><td style="border-right:0">FastUnloadTask class:</td><td style="border-left:0">[[FastUnloadTask class|Synopsis]] | [[List of FastUnloadTask methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[File classes]] <ul class="nobul"><li>Recordset class:<li>Record class:<li>SortedRecordset class:<li>RecordsetCursor class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Recordset class|Synopsis]] | [[List of Recordset methods|Methods]]<li>[[Record class|Synopsis]] | [[List of Record methods|Methods]]<li>[[SortedRecordset class|Synopsis]] | [[List of SortedRecordset methods|Methods]]<li>[[RecordsetCursor class|Synopsis]] | [[List of RecordsetCursor methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[HTTP Helper|HTTP Helper]] classes: <ul class="nobul"><li>HttpRequest class:<li>HttpResponse class:</ul></td>
<td style="border-left:0">[[List of HTTP Helper methods|HTTP Helper methods]]<ul class="nobulnoindent"><li>[[HttpRequest class|Synopsis]] | [[List of HttpRequest methods|Methods]]<li>[[HttpResponse class|Synopsis]] | [[List of HttpResponse methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[Intrinsic classes|Intrinsic]] classes: <ul class="nobul"><li>Float class:<li>String class:<li>Unicode class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[List of Float methods|Methods]]<li>[[List of String methods|Methods]]<li>[[List of Unicode methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Journal class:</td><td style="border-left:0">[[Journal class|Synopsis]] | [[List of Journal methods|Methods]]</td></tr>

<tr><td style="border-right:0">Json class:</td><td style="border-left:0">[[Json class|Synopsis]] | [[List of Json methods|Methods]]</td></tr>

<tr><td style="border-right:0">LDAP class:</td><td style="border-left:0">[[LDAP class|Synopsis]] | [[List of LDAP methods|Methods]]</td></tr>

<tr><td style="border-right:0">Object class:</td><td style="border-left:0">[[Object class|Synopsis]] | [[List of Object methods|Methods]]</td></tr>

<tr><td style="border-right:0">PersistentObjectInfo class:</td><td style="border-left:0">[[PersistentObjectInfo class|Synopsis]] | [[List of PersistentObjectInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">ProcedureInfo class:</td><td style="border-left:0">[[ProcedureInfo class|Synopsis]] | [[List of ProcedureInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">RandomNumberGenerator class:</td><td style="border-left:0">[[RandomNumberGenerator class|Synopsis]] | [[List of RandomNumberGenerator methods|Methods]]</td></tr>

<tr><td style="border-right:0">Screen and ScreenField classes:</td>
<td style="border-left:0">[[Screen classes|Synopsis]] | [[List of Screen API methods|Methods]]</td></tr>

<tr><td style="border-right:0">SelectionCriterion class:</td><td style="border-left:0">[[SelectionCriterion class|Synopsis]] | [[List of SelectionCriterion methods|Methods]]</td></tr>

<tr><td style="border-right:0">Socket class:</td><td style="border-left:0">[[Socket class|Synopsis]] | [[List of Socket methods|Methods]]</td></tr>

<tr><td style="border-right:0">SortOrder class:</td><td style="border-left:0">[[SortOrder class|Synopsis]] | [[List of SortOrder methods|Methods]]</td></tr>

<tr><td style="border-right:0">Stringlist class:</td><td style="border-left:0">[[Stringlist class|Synopsis]] | [[List of Stringlist methods|Methods]]</td></tr>

<tr><td style="border-right:0">StringTokenizer class:</td><td style="border-left:0">[[StringTokenizer class|Synopsis]] | [[List of StringTokenizer methods|Methods]]</td></tr>

<tr><td style="border-right:0"><ul class="nobulnoindent"><li>System class:<li>Subsystem class:</ul></td>
<td style="border-left:0"><ul class="nobulnoindent"><li>[[System and Subsystem classes|Synopsis]] | [[List of System methods|Methods]]<li>[[System and Subsystem classes|Synopsis]] | [[List of Subsystem methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">UdpSocket class:</td><td style="border-left:0">[[UdpSocket class|Synopsis]] | [[List of UdpSocket methods|Methods]]</td></tr>

<tr><td style="border-right:0">UserStatistics class:</td><td style="border-left:0">[[UserStatistics class|Synopsis]] | [[List of UserStatistics methods|Methods]]</td></tr>

<tr><td style="border-right:0">Web class:</td><td style="border-left:0">[[Web class|Synopsis]] | [[List of Web methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[XmlDoc API]] classes <ul class="nobul"><li>XmlDoc class:<li>XmlNode class:<li>XmlNodelist class:</ul> </td>
<td style="border-left:0">[[List of XmlDoc API methods|XmlDoc API methods]]<ul class="nobulnoindent"><li>[[XmlDoc API#The XmlDoc class|Synopsis]] | [[List of XmlDoc methods|XmlDoc methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNode methods|XmlNode methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNodelist methods|XmlNodelist methods]]</ul></td></tr>

<tr>
<td style="border-right:0">[[XmlParser API]] classes <ul class="nobul"><li>XmlParser class:<li>XmlSelector class:<li>XmlAttributeList class:</ul>XmlParser API types <ul class="nobul"><li>[[XmlStartHandler type]]<li>[[XmlEndHandler type]]<li>[[XmlPIHandler type]]</ul> </td>
<td style="border-left:0">[[List of XmlParser API methods|XmlParser API methods]]<ul class="nobulnoindent"><li>[[XmlParser class|Synopsis]] | [[List of XmlParser methods|XmlParser methods]]<li>[[XmlSelector class|Synopsis]] | [[List of XmlSelector methods|XmlSelector methods]]<li>[[XmlAttributeListClass|Synopsis]] | [[List of XmlAttributeList methods|XmlAttributeList methods]]</ul></td></tr>
</table>

==Enumerations==
<table>
<tr><td colspan="2"><strong>[[Enumerations]]</strong>
<table class="noBorder"><tr><td style="border-right:0"><ul class="nobulnoindent">
<li>  [[ActionKey enumeration|ActionKey]]</li>
<li>  [[AddToRecordErrorReason enumeration|AddToRecordErrorReason]] </li>
<li>  [[Boolean enumeration|Boolean]]</li>
<li>  [[CursorState enumeration|CursorState]]</li>
<li>  [[DaemonState enumeration|DaemonState]]</li>
<li>  [[DatasetState enumeration|DatasetState]]</li>
<li>  [[FastUnloadTaskState enumeration|FastUnloadTaskState]]</li>
<li>  [[FieldColor enumeration|FieldColor]]</li>
<li>  [[Highlight enumeration|Highlight]]</li>
<li>  [[JsonType enumeration|JsonType]]</li>
<li>  [[LineEnd enumeration|LineEnd]]</li>
<li>  [[LockStrength enumeration|LockStrength]]</li>
</ul></td>
<td style="border-left:0"><ul class="nobul">
<li>   [[RecordFormat enumeration|RecordFormat]]</li>
<li>   [[RecordLockType enumeration|RecordLockType]]</li>
<li>   [[RegexSplitOutputOptions enumeration|RegexSplitOutputOptions]]</li>
<li>   [[TranslationExceptionReason enumeration|TranslationExceptionReason]]</li>
<li>   [[XmlAdjacentTextSetting enumeration|XmlAdjacentTextSetting]]</li>
<li>   [[XmlInvalidChar enumeration|XmlInvalidChar]]</li>
<li>   [[XmlNamespaceSetting enumeration|XmlNamespaceSetting]]</li>
<li>   [[XmlNodeType enumeration|XmlNodeType]]</li>
<li>   [[XmlParseErrorReason enumeration|XmlParseErrorReason]]</li>
<li>   [[XPathErrorReason enumeration|XPathErrorReason]]</li>
</ul></td></tr></table></td></tr>
</table>

==Exceptions==
<table>
<tr><td style="border-right:0"><div id="except"></div><strong>[[Exceptions|Exception]]</strong> classes<ul class="nobul">
<li>AddToRecordError: </li>
<li>BadJournal: </li>
<li>CharacterTranslationException: </li>
<li>DaemonLost: </li>
<li>IncorrectDaemonState: </li>
<li>InvalidBase64Data: </li>
<li>InvalidBitNumber: </li>
<li>InvalidDateString: </li>
<li>InvalidDeflateData: </li>
<li>InvalidGZipData: </li>
<li>InvalidHexData: </li>
<li>InvalidJsonType: </li>
<li>InvalidRegex: </li>
<li>InvalidSortSpecification: </li>
<li>InvalidValue: </li>
<li>ItemNotFound: </li>
<li>ItemNotPresent: </li>
<li>JsonCircularReference: </li>
<li>JsonParseError: </li>
<li>MaxDaemExceeded: </li>
<li>MismatchedQuote: </li>
<li>NoFreeDaemons: </li>
<li>NotJanusConnection: </li>
<li>OutOfBounds: </li>
<li>RecordLockingConflict: </li>
<li>ScreenReadError: </li>
<li>UnknownStatistic: </li>
<li>WebScreenException: </li>
<li>XmlParseError: </li>
<li>XPathError: </li></ul></td>

<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[AddToRecordError class|Synopsis]] | [[AddToRecordError class#The AddToRecordError methods|Methods]]
<li>[[BadJournal class|Synopsis]] | [[BadJournal class#The BadJournal methods|Methods]]
<li>[[CharacterTranslationException class|Synopsis]] | [[CharacterTranslationException class#The CharacterTranslationException methods|Methods]]
<li>[[DaemonLost class|Synopsis]] | [[DaemonLost class#The DaemonLost methods|Methods]]
<li>[[IncorrectDaemonState class|Synopsis]] | [[IncorrectDaemonState class#The IncorrectDaemonState methods|Methods]]
<li>[[InvalidBase64Data class|Synopsis]] | [[InvalidBase64Data class#The InvalidBase64Data methods|Methods]]
<li>[[InvalidBitNumber class|Synopsis]] | [[InvalidBitNumber class#The InvalidBitNumber methods|Methods]]
<li>[[InvalidDateString class|Synopsis]] | [[InvalidDateString class#The InvalidDateString methods|Methods]]
<li>[[InvalidDeflateData class|Synopsis]] | [[InvalidDeflateData class#The InvalidDeflateData methods|Methods]]
<li>[[InvalidGZipData class|Synopsis]] | [[InvalidGZipData class#The InvalidGZipData methods|Methods]]
<li>[[InvalidHexData class|Synopsis]] | [[InvalidHexData class#The InvalidHexData methods|Methods]]
<li>[[InvalidJsonType class|Synopsis]] | [[InvalidJsonType class#The InvalidJsonType methods|Methods]]
<li>[[InvalidRegex class|Synopsis]] | [[InvalidRegex class#The InvalidRegex methods|Methods]]
<li>[[InvalidSortSpecification class|Synopsis]] | [[InvalidSortSpecification class#The InvalidSortSpecification methods|Methods]]
<li>[[InvalidValue class|Synopsis]] | [[InvalidValue class#The InvalidValue methods|Methods]]
<li>[[ItemNotFound class|Synopsis]] | [[ItemNotFound class#The ItemNotFound methods|Methods]]
<li>[[ItemNotPresent class|Synopsis]] | [[ItemNotPresent class#The ItemNotPresent methods|Methods]]
<li>[[JsonCircularReference class|Synopsis]] | [[JsonCircularReference class#The JsonCircularReference methods|Methods]]
<li>[[JsonParseError class|Synopsis]] | [[ JsonParseError class#The JsonParseError methods|Methods]]
<li>[[MaxDaemExceeded class|Synopsis]] | [[MaxDaemExceeded class#The MaxDaemExceeded methods|Methods]]
<li>[[MismatchedQuote class|Synopsis]] | [[MismatchedQuote class#The MismatchedQuote methods|Methods]]
<li>[[NoFreeDaemons class|Synopsis]] | [[NoFreeDaemons class#The NoFreeDaemons methods|Methods]]
<li>[[NotJanusConnection class|Synopsis]] | [[NotJanusConnection class#The NotJanusConnection methods|Methods]]
<li>[[OutOfBounds class|Synopsis]] | [[OutOfBounds class#The OutOfBounds methods|Methods]]
<li>[[RecordLockingConflict class|Synopsis]] | [[RecordLockingConflict class#The RecordLockingConflict methods|Methods]]
<li>[[ScreenReadError class|Synopsis]] | [[ScreenReadError class#The ScreenReadError methods|Methods]]
<li>[[UnknownStatistic class|Synopsis]] | [[UnknownStatistic class#The UnknownStatistic methods|Methods]]
<li>[[WebScreenException class|Synopsis]] | [[WebScreenException class#The WebScreenException methods|Methods]]
<li>[[XmlParseError class|Synopsis]] | [[XmlParseError class#The XmlParseError methods|Methods]]
<li>[[XPathError class|Synopsis]] | [[XPathError class#The XPathError methods|Methods]]</ul></td></tr>
</table>

==System types==
<table>
<tr><td style="border-right:0"><div id="except"></div>System types<ul class="nobul">
<li>CertificateChecker</li>
<li>ProcedureInfoList</li>
<li>WebScreenCallback</li>
</ul></td>
<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[CertificateChecker type|Synopsis]]</li>
<li>[[ProcedureInfoList type|Synopsis]]</li>
<li>[[WebScreenCallback type|Synopsis]]</li>
</ul></td></tr>
</table>

Template:List of classes and methods

2015-05-01T19:28:04Z

MCosta: /* Exceptions */

==System classes==
<table>
<tr><td style="border-right:0">CharacterMap class:</td><td style="border-left:0">[[CharacterMap class|Synopsis]] | [[List of CharacterMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">CharacterToUnicodeMap class:</td><td style="border-left:0">[[CharacterToUnicodeMap class|Synopsis]] | [[List of CharacterToUnicodeMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[Collections|Collection]] classes <ul class="nobul"><li>Arraylist class:<li>FloatNamedArraylist class:<li>NamedArraylist class:<li>UnicodeNamedArraylist class:</ul> </td>

<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Arraylist class|Synopsis]] | [[List of Arraylist methods|Methods]]<li>[[FloatNamedArraylist class|Synopsis]] | [[List of FloatNamedArraylist methods|Methods]]<li>[[NamedArraylist class|Synopsis]] | [[List of NamedArraylist methods|Methods]]<li>[[UnicodeNamedArraylist class|Synopsis]] | [[List of UnicodeNamedArraylist methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Daemon class:</td><td style="border-left:0">[[Daemon class|Synopsis]] | [[List of Daemon methods|Methods]]</td></tr>

<tr><td style="border-right:0">Dataset class:</td><td style="border-left:0">[[Dataset class|Synopsis]] | [[List of Dataset methods|Methods]]</td></tr>

<tr><td style="border-right:0">Email class:</td><td style="border-left:0">[[Email class|Synopsis]] | [[List of Email methods|Methods]]</td></tr>

<tr><td style="border-right:0">FastUnloadTask class:</td><td style="border-left:0">[[FastUnloadTask class|Synopsis]] | [[List of FastUnloadTask methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[File classes]] <ul class="nobul"><li>Recordset class:<li>Record class:<li>SortedRecordset class:<li>RecordsetCursor class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Recordset class|Synopsis]] | [[List of Recordset methods|Methods]]<li>[[Record class|Synopsis]] | [[List of Record methods|Methods]]<li>[[SortedRecordset class|Synopsis]] | [[List of SortedRecordset methods|Methods]]<li>[[RecordsetCursor class|Synopsis]] | [[List of RecordsetCursor methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[HTTP Helper|HTTP Helper]] classes: <ul class="nobul"><li>HttpRequest class:<li>HttpResponse class:</ul></td>
<td style="border-left:0">[[List of HTTP Helper methods|HTTP Helper methods]]<ul class="nobulnoindent"><li>[[HttpRequest class|Synopsis]] | [[List of HttpRequest methods|Methods]]<li>[[HttpResponse class|Synopsis]] | [[List of HttpResponse methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[Intrinsic classes|Intrinsic]] classes: <ul class="nobul"><li>Float class:<li>String class:<li>Unicode class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[List of Float methods|Methods]]<li>[[List of String methods|Methods]]<li>[[List of Unicode methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Journal class:</td><td style="border-left:0">[[Journal class|Synopsis]] | [[List of Journal methods|Methods]]</td></tr>

<tr><td style="border-right:0">Json class:</td><td style="border-left:0">[[Json class|Synopsis]] | [[List of Json methods|Methods]]</td></tr>

<tr><td style="border-right:0">LDAP class:</td><td style="border-left:0">[[LDAP class|Synopsis]] | [[List of LDAP methods|Methods]]</td></tr>

<tr><td style="border-right:0">Object class:</td><td style="border-left:0">[[Object class|Synopsis]] | [[List of Object methods|Methods]]</td></tr>

<tr><td style="border-right:0">PersistentObjectInfo class:</td><td style="border-left:0">[[PersistentObjectInfo class|Synopsis]] | [[List of PersistentObjectInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">ProcedureInfo class:</td><td style="border-left:0">[[ProcedureInfo class|Synopsis]] | [[List of ProcedureInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">RandomNumberGenerator class:</td><td style="border-left:0">[[RandomNumberGenerator class|Synopsis]] | [[List of RandomNumberGenerator methods|Methods]]</td></tr>

<tr><td style="border-right:0">Screen and ScreenField classes:</td>
<td style="border-left:0">[[Screen classes|Synopsis]] | [[List of Screen API methods|Methods]]</td></tr>

<tr><td style="border-right:0">SelectionCriterion class:</td><td style="border-left:0">[[SelectionCriterion class|Synopsis]] | [[List of SelectionCriterion methods|Methods]]</td></tr>

<tr><td style="border-right:0">Socket class:</td><td style="border-left:0">[[Socket class|Synopsis]] | [[List of Socket methods|Methods]]</td></tr>

<tr><td style="border-right:0">SortOrder class:</td><td style="border-left:0">[[SortOrder class|Synopsis]] | [[List of SortOrder methods|Methods]]</td></tr>

<tr><td style="border-right:0">Stringlist class:</td><td style="border-left:0">[[Stringlist class|Synopsis]] | [[List of Stringlist methods|Methods]]</td></tr>

<tr><td style="border-right:0">StringTokenizer class:</td><td style="border-left:0">[[StringTokenizer class|Synopsis]] | [[List of StringTokenizer methods|Methods]]</td></tr>

<tr><td style="border-right:0"><ul class="nobulnoindent"><li>System class:<li>Subsystem class:</ul></td>
<td style="border-left:0"><ul class="nobulnoindent"><li>[[System and Subsystem classes|Synopsis]] | [[List of System methods|Methods]]<li>[[System and Subsystem classes|Synopsis]] | [[List of Subsystem methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">UdpSocket class:</td><td style="border-left:0">[[UdpSocket class|Synopsis]] | [[List of UdpSocket methods|Methods]]</td></tr>

<tr><td style="border-right:0">UserStatistics class:</td><td style="border-left:0">[[UserStatistics class|Synopsis]] | [[List of UserStatistics methods|Methods]]</td></tr>

<tr><td style="border-right:0">Web class:</td><td style="border-left:0">[[Web class|Synopsis]] | [[List of Web methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[XmlDoc API]] classes <ul class="nobul"><li>XmlDoc class:<li>XmlNode class:<li>XmlNodelist class:</ul> </td>
<td style="border-left:0">[[List of XmlDoc API methods|XmlDoc API methods]]<ul class="nobulnoindent"><li>[[XmlDoc API#The XmlDoc class|Synopsis]] | [[List of XmlDoc methods|XmlDoc methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNode methods|XmlNode methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNodelist methods|XmlNodelist methods]]</ul></td></tr>

<tr>
<td style="border-right:0">[[XmlParser API]] classes <ul class="nobul"><li>XmlParser class:<li>XmlSelector class:<li>XmlAttributeList class:</ul>XmlParser API types <ul class="nobul"><li>[[XmlStartHandler type]]<li>[[XmlEndHandler type]]<li>[[XmlPIHandler type]]</ul> </td>
<td style="border-left:0">[[List of XmlParser API methods|XmlParser API methods]]<ul class="nobulnoindent"><li>[[XmlParser class|Synopsis]] | [[List of XmlParser methods|XmlParser methods]]<li>[[XmlSelector class|Synopsis]] | [[List of XmlSelector methods|XmlSelector methods]]<li>[[XmlAttributeListClass|Synopsis]] | [[List of XmlAttributeList methods|XmlAttributeList methods]]</ul></td></tr>
</table>

==Enumerations==
<table>
<tr><td colspan="2"><strong>[[Enumerations]]</strong>
<table class="noBorder"><tr><td style="border-right:0"><ul class="nobulnoindent">
<li>  [[ActionKey enumeration|ActionKey]]</li>
<li>  [[AddToRecordErrorReason enumeration|AddToRecordErrorReason]] </li>
<li>  [[Boolean enumeration|Boolean]]</li>
<li>  [[CursorState enumeration|CursorState]]</li>
<li>  [[DaemonState enumeration|DaemonState]]</li>
<li>  [[DatasetState enumeration|DatasetState]]</li>
<li>  [[FastUnloadTaskState enumeration|FastUnloadTaskState]]</li>
<li>  [[FieldColor enumeration|FieldColor]]</li>
<li>  [[Highlight enumeration|Highlight]]</li>
<li>  [[JsonType enumeration|JsonType]]</li>
<li>  [[LineEnd enumeration|LineEnd]]</li>
<li>  [[LockStrength enumeration|LockStrength]]</li>
</ul></td>
<td style="border-left:0"><ul class="nobul">
<li>   [[RecordFormat enumeration|RecordFormat]]</li>
<li>   [[RecordLockType enumeration|RecordLockType]]</li>
<li>   [[RegexSplitOutputOptions enumeration|RegexSplitOutputOptions]]</li>
<li>   [[TranslationExceptionReason enumeration|TranslationExceptionReason]]</li>
<li>   [[XmlAdjacentTextSetting enumeration|XmlAdjacentTextSetting]]</li>
<li>   [[XmlInvalidChar enumeration|XmlInvalidChar]]</li>
<li>   [[XmlNamespaceSetting enumeration|XmlNamespaceSetting]]</li>
<li>   [[XmlNodeType enumeration|XmlNodeType]]</li>
<li>   [[XmlParseErrorReason enumeration|XmlParseErrorReason]]</li>
<li>   [[XPathErrorReason enumeration|XPathErrorReason]]</li>
</ul></td></tr></table></td></tr>
</table>

==Exceptions==
<table>
<tr><td style="border-right:0"><div id="except"></div><strong>[[Exceptions|Exception]]</strong> classes<ul class="nobul">
<li>AddToRecordError: </li>
<li>BadJournal: </li>
<li>CharacterTranslationException: </li>
<li>DaemonLost: </li>
<li>IncorrectDaemonState: </li>
<li>InvalidBase64Data: </li>
<li>InvalidBitNumber: </li>
<li>InvalidDateString: </li>
<li>InvalidDeflateData: </li>
<li>InvalidGZipData: </li>
<li>InvalidHexData: </li>
<li>InvalidJsonType: </li>
<li>InvalidRegex: </li>
<li>InvalidSortSpecification: </li>
<li>InvalidValue: </li>
<li>ItemNotFound: </li>
<li>ItemNotPresent: </li>
<li>JsonParseError: </li>
<li>MaxDaemExceeded: </li>
<li>MismatchedQuote: </li>
<li>NoFreeDaemons: </li>
<li>NotJanusConnection: </li>
<li>OutOfBounds: </li>
<li>RecordLockingConflict: </li>
<li>ScreenReadError: </li>
<li>UnknownStatistic: </li>
<li>WebScreenException: </li>
<li>XmlParseError: </li>
<li>XPathError: </li></ul></td>

<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[AddToRecordError class|Synopsis]] | [[AddToRecordError class#The AddToRecordError methods|Methods]]
<li>[[BadJournal class|Synopsis]] | [[BadJournal class#The BadJournal methods|Methods]]
<li>[[CharacterTranslationException class|Synopsis]] | [[CharacterTranslationException class#The CharacterTranslationException methods|Methods]]
<li>[[DaemonLost class|Synopsis]] | [[DaemonLost class#The DaemonLost methods|Methods]]
<li>[[IncorrectDaemonState class|Synopsis]] | [[IncorrectDaemonState class#The IncorrectDaemonState methods|Methods]]
<li>[[InvalidBase64Data class|Synopsis]] | [[InvalidBase64Data class#The InvalidBase64Data methods|Methods]]
<li>[[InvalidBitNumber class|Synopsis]] | [[InvalidBitNumber class#The InvalidBitNumber methods|Methods]]
<li>[[InvalidDateString class|Synopsis]] | [[InvalidDateString class#The InvalidDateString methods|Methods]]
<li>[[InvalidDeflateData class|Synopsis]] | [[InvalidDeflateData class#The InvalidDeflateData methods|Methods]]
<li>[[InvalidGZipData class|Synopsis]] | [[InvalidGZipData class#The InvalidGZipData methods|Methods]]
<li>[[InvalidHexData class|Synopsis]] | [[InvalidHexData class#The InvalidHexData methods|Methods]]
<li>[[InvalidJsonType class|Synopsis]] | [[InvalidJsonType class#The InvalidJsonType methods|Methods]]
<li>[[InvalidRegex class|Synopsis]] | [[InvalidRegex class#The InvalidRegex methods|Methods]]
<li>[[InvalidSortSpecification class|Synopsis]] | [[InvalidSortSpecification class#The InvalidSortSpecification methods|Methods]]
<li>[[InvalidValue class|Synopsis]] | [[InvalidValue class#The InvalidValue methods|Methods]]
<li>[[ItemNotFound class|Synopsis]] | [[ItemNotFound class#The ItemNotFound methods|Methods]]
<li>[[ItemNotPresent class|Synopsis]] | [[ItemNotPresent class#The ItemNotPresent methods|Methods]]
<li>[[JsonCircularReference class|Synopsis]] | [[JsonCircularReference class#The JsonCircularReference methods|Methods]]
<li>[[JsonParseError class|Synopsis]] | [[ JsonParseError class#The JsonParseError methods|Methods]]
<li>[[MaxDaemExceeded class|Synopsis]] | [[MaxDaemExceeded class#The MaxDaemExceeded methods|Methods]]
<li>[[MismatchedQuote class|Synopsis]] | [[MismatchedQuote class#The MismatchedQuote methods|Methods]]
<li>[[NoFreeDaemons class|Synopsis]] | [[NoFreeDaemons class#The NoFreeDaemons methods|Methods]]
<li>[[NotJanusConnection class|Synopsis]] | [[NotJanusConnection class#The NotJanusConnection methods|Methods]]
<li>[[OutOfBounds class|Synopsis]] | [[OutOfBounds class#The OutOfBounds methods|Methods]]
<li>[[RecordLockingConflict class|Synopsis]] | [[RecordLockingConflict class#The RecordLockingConflict methods|Methods]]
<li>[[ScreenReadError class|Synopsis]] | [[ScreenReadError class#The ScreenReadError methods|Methods]]
<li>[[UnknownStatistic class|Synopsis]] | [[UnknownStatistic class#The UnknownStatistic methods|Methods]]
<li>[[WebScreenException class|Synopsis]] | [[WebScreenException class#The WebScreenException methods|Methods]]
<li>[[XmlParseError class|Synopsis]] | [[XmlParseError class#The XmlParseError methods|Methods]]
<li>[[XPathError class|Synopsis]] | [[XPathError class#The XPathError methods|Methods]]</ul></td></tr>
</table>

==System types==
<table>
<tr><td style="border-right:0"><div id="except"></div>System types<ul class="nobul">
<li>CertificateChecker</li>
<li>ProcedureInfoList</li>
<li>WebScreenCallback</li>
</ul></td>
<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[CertificateChecker type|Synopsis]]</li>
<li>[[ProcedureInfoList type|Synopsis]]</li>
<li>[[WebScreenCallback type|Synopsis]]</li>
</ul></td></tr>
</table>

Template:List of classes and methods

2015-05-01T19:25:54Z

MCosta: /* Exceptions */

==System classes==
<table>
<tr><td style="border-right:0">CharacterMap class:</td><td style="border-left:0">[[CharacterMap class|Synopsis]] | [[List of CharacterMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">CharacterToUnicodeMap class:</td><td style="border-left:0">[[CharacterToUnicodeMap class|Synopsis]] | [[List of CharacterToUnicodeMap methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[Collections|Collection]] classes <ul class="nobul"><li>Arraylist class:<li>FloatNamedArraylist class:<li>NamedArraylist class:<li>UnicodeNamedArraylist class:</ul> </td>

<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Arraylist class|Synopsis]] | [[List of Arraylist methods|Methods]]<li>[[FloatNamedArraylist class|Synopsis]] | [[List of FloatNamedArraylist methods|Methods]]<li>[[NamedArraylist class|Synopsis]] | [[List of NamedArraylist methods|Methods]]<li>[[UnicodeNamedArraylist class|Synopsis]] | [[List of UnicodeNamedArraylist methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Daemon class:</td><td style="border-left:0">[[Daemon class|Synopsis]] | [[List of Daemon methods|Methods]]</td></tr>

<tr><td style="border-right:0">Dataset class:</td><td style="border-left:0">[[Dataset class|Synopsis]] | [[List of Dataset methods|Methods]]</td></tr>

<tr><td style="border-right:0">Email class:</td><td style="border-left:0">[[Email class|Synopsis]] | [[List of Email methods|Methods]]</td></tr>

<tr><td style="border-right:0">FastUnloadTask class:</td><td style="border-left:0">[[FastUnloadTask class|Synopsis]] | [[List of FastUnloadTask methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[File classes]] <ul class="nobul"><li>Recordset class:<li>Record class:<li>SortedRecordset class:<li>RecordsetCursor class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[Recordset class|Synopsis]] | [[List of Recordset methods|Methods]]<li>[[Record class|Synopsis]] | [[List of Record methods|Methods]]<li>[[SortedRecordset class|Synopsis]] | [[List of SortedRecordset methods|Methods]]<li>[[RecordsetCursor class|Synopsis]] | [[List of RecordsetCursor methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[HTTP Helper|HTTP Helper]] classes: <ul class="nobul"><li>HttpRequest class:<li>HttpResponse class:</ul></td>
<td style="border-left:0">[[List of HTTP Helper methods|HTTP Helper methods]]<ul class="nobulnoindent"><li>[[HttpRequest class|Synopsis]] | [[List of HttpRequest methods|Methods]]<li>[[HttpResponse class|Synopsis]] | [[List of HttpResponse methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">[[Intrinsic classes|Intrinsic]] classes: <ul class="nobul"><li>Float class:<li>String class:<li>Unicode class:</ul></td>
<td style="border-left:0"> <ul class="nobulnoindent"><li>[[List of Float methods|Methods]]<li>[[List of String methods|Methods]]<li>[[List of Unicode methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">Journal class:</td><td style="border-left:0">[[Journal class|Synopsis]] | [[List of Journal methods|Methods]]</td></tr>

<tr><td style="border-right:0">Json class:</td><td style="border-left:0">[[Json class|Synopsis]] | [[List of Json methods|Methods]]</td></tr>

<tr><td style="border-right:0">LDAP class:</td><td style="border-left:0">[[LDAP class|Synopsis]] | [[List of LDAP methods|Methods]]</td></tr>

<tr><td style="border-right:0">Object class:</td><td style="border-left:0">[[Object class|Synopsis]] | [[List of Object methods|Methods]]</td></tr>

<tr><td style="border-right:0">PersistentObjectInfo class:</td><td style="border-left:0">[[PersistentObjectInfo class|Synopsis]] | [[List of PersistentObjectInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">ProcedureInfo class:</td><td style="border-left:0">[[ProcedureInfo class|Synopsis]] | [[List of ProcedureInfo methods|Methods]]</td></tr>

<tr><td style="border-right:0">RandomNumberGenerator class:</td><td style="border-left:0">[[RandomNumberGenerator class|Synopsis]] | [[List of RandomNumberGenerator methods|Methods]]</td></tr>

<tr><td style="border-right:0">Screen and ScreenField classes:</td>
<td style="border-left:0">[[Screen classes|Synopsis]] | [[List of Screen API methods|Methods]]</td></tr>

<tr><td style="border-right:0">SelectionCriterion class:</td><td style="border-left:0">[[SelectionCriterion class|Synopsis]] | [[List of SelectionCriterion methods|Methods]]</td></tr>

<tr><td style="border-right:0">Socket class:</td><td style="border-left:0">[[Socket class|Synopsis]] | [[List of Socket methods|Methods]]</td></tr>

<tr><td style="border-right:0">SortOrder class:</td><td style="border-left:0">[[SortOrder class|Synopsis]] | [[List of SortOrder methods|Methods]]</td></tr>

<tr><td style="border-right:0">Stringlist class:</td><td style="border-left:0">[[Stringlist class|Synopsis]] | [[List of Stringlist methods|Methods]]</td></tr>

<tr><td style="border-right:0">StringTokenizer class:</td><td style="border-left:0">[[StringTokenizer class|Synopsis]] | [[List of StringTokenizer methods|Methods]]</td></tr>

<tr><td style="border-right:0"><ul class="nobulnoindent"><li>System class:<li>Subsystem class:</ul></td>
<td style="border-left:0"><ul class="nobulnoindent"><li>[[System and Subsystem classes|Synopsis]] | [[List of System methods|Methods]]<li>[[System and Subsystem classes|Synopsis]] | [[List of Subsystem methods|Methods]]</ul></td></tr>

<tr><td style="border-right:0">UdpSocket class:</td><td style="border-left:0">[[UdpSocket class|Synopsis]] | [[List of UdpSocket methods|Methods]]</td></tr>

<tr><td style="border-right:0">UserStatistics class:</td><td style="border-left:0">[[UserStatistics class|Synopsis]] | [[List of UserStatistics methods|Methods]]</td></tr>

<tr><td style="border-right:0">Web class:</td><td style="border-left:0">[[Web class|Synopsis]] | [[List of Web methods|Methods]]</td></tr>

<tr><td style="border-right:0">[[XmlDoc API]] classes <ul class="nobul"><li>XmlDoc class:<li>XmlNode class:<li>XmlNodelist class:</ul> </td>
<td style="border-left:0">[[List of XmlDoc API methods|XmlDoc API methods]]<ul class="nobulnoindent"><li>[[XmlDoc API#The XmlDoc class|Synopsis]] | [[List of XmlDoc methods|XmlDoc methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNode methods|XmlNode methods]]<li>[[XmlDoc API#The XmlNode and XmlNodelist classes, and XPath|Synopsis]] | [[List of XmlNodelist methods|XmlNodelist methods]]</ul></td></tr>

<tr>
<td style="border-right:0">[[XmlParser API]] classes <ul class="nobul"><li>XmlParser class:<li>XmlSelector class:<li>XmlAttributeList class:</ul>XmlParser API types <ul class="nobul"><li>[[XmlStartHandler type]]<li>[[XmlEndHandler type]]<li>[[XmlPIHandler type]]</ul> </td>
<td style="border-left:0">[[List of XmlParser API methods|XmlParser API methods]]<ul class="nobulnoindent"><li>[[XmlParser class|Synopsis]] | [[List of XmlParser methods|XmlParser methods]]<li>[[XmlSelector class|Synopsis]] | [[List of XmlSelector methods|XmlSelector methods]]<li>[[XmlAttributeListClass|Synopsis]] | [[List of XmlAttributeList methods|XmlAttributeList methods]]</ul></td></tr>
</table>

==Enumerations==
<table>
<tr><td colspan="2"><strong>[[Enumerations]]</strong>
<table class="noBorder"><tr><td style="border-right:0"><ul class="nobulnoindent">
<li>  [[ActionKey enumeration|ActionKey]]</li>
<li>  [[AddToRecordErrorReason enumeration|AddToRecordErrorReason]] </li>
<li>  [[Boolean enumeration|Boolean]]</li>
<li>  [[CursorState enumeration|CursorState]]</li>
<li>  [[DaemonState enumeration|DaemonState]]</li>
<li>  [[DatasetState enumeration|DatasetState]]</li>
<li>  [[FastUnloadTaskState enumeration|FastUnloadTaskState]]</li>
<li>  [[FieldColor enumeration|FieldColor]]</li>
<li>  [[Highlight enumeration|Highlight]]</li>
<li>  [[JsonType enumeration|JsonType]]</li>
<li>  [[LineEnd enumeration|LineEnd]]</li>
<li>  [[LockStrength enumeration|LockStrength]]</li>
</ul></td>
<td style="border-left:0"><ul class="nobul">
<li>   [[RecordFormat enumeration|RecordFormat]]</li>
<li>   [[RecordLockType enumeration|RecordLockType]]</li>
<li>   [[RegexSplitOutputOptions enumeration|RegexSplitOutputOptions]]</li>
<li>   [[TranslationExceptionReason enumeration|TranslationExceptionReason]]</li>
<li>   [[XmlAdjacentTextSetting enumeration|XmlAdjacentTextSetting]]</li>
<li>   [[XmlInvalidChar enumeration|XmlInvalidChar]]</li>
<li>   [[XmlNamespaceSetting enumeration|XmlNamespaceSetting]]</li>
<li>   [[XmlNodeType enumeration|XmlNodeType]]</li>
<li>   [[XmlParseErrorReason enumeration|XmlParseErrorReason]]</li>
<li>   [[XPathErrorReason enumeration|XPathErrorReason]]</li>
</ul></td></tr></table></td></tr>
</table>

==Exceptions==
<table>
<tr><td style="border-right:0"><div id="except"></div><strong>[[Exceptions|Exception]]</strong> classes<ul class="nobul">
<li>AddToRecordError: </li>
<li>BadJournal: </li>
<li>CharacterTranslationException: </li>
<li>DaemonLost: </li>
<li>IncorrectDaemonState: </li>
<li>InvalidBase64Data: </li>
<li>InvalidBitNumber: </li>
<li>InvalidDateString: </li>
<li>InvalidDeflateData: </li>
<li>InvalidGZipData: </li>
<li>InvalidHexData: </li>
<li>InvalidJsonType: </li>
<li>InvalidRegex: </li>
<li>InvalidSortSpecification: </li>
<li>InvalidValue: </li>
<li>ItemNotFound: </li>
<li>ItemNotPresent: </li>
<li>JsonParseError: </li>
<li>MaxDaemExceeded: </li>
<li>MismatchedQuote: </li>
<li>NoFreeDaemons: </li>
<li>NotJanusConnection: </li>
<li>OutOfBounds: </li>
<li>RecordLockingConflict: </li>
<li>ScreenReadError: </li>
<li>UnknownStatistic: </li>
<li>WebScreenException: </li>
<li>XmlParseError: </li>
<li>XPathError: </li></ul></td>

<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[AddToRecordError class|Synopsis]] | [[AddToRecordError class#The AddToRecordError methods|Methods]]
<li>[[BadJournal class|Synopsis]] | [[BadJournal class#The BadJournal methods|Methods]]
<li>[[CharacterTranslationException class|Synopsis]] | [[CharacterTranslationException class#The CharacterTranslationException methods|Methods]]
<li>[[DaemonLost class|Synopsis]] | [[DaemonLost class#The DaemonLost methods|Methods]]
<li>[[IncorrectDaemonState class|Synopsis]] | [[IncorrectDaemonState class#The IncorrectDaemonState methods|Methods]]
<li>[[InvalidBase64Data class|Synopsis]] | [[InvalidBase64Data class#The InvalidBase64Data methods|Methods]]
<li>[[InvalidBitNumber class|Synopsis]] | [[InvalidBitNumber class#The InvalidBitNumber methods|Methods]]
<li>[[InvalidDateString class|Synopsis]] | [[InvalidDateString class#The InvalidDateString methods|Methods]]
<li>[[InvalidDeflateData class|Synopsis]] | [[InvalidDeflateData class#The InvalidDeflateData methods|Methods]]
<li>[[InvalidGZipData class|Synopsis]] | [[InvalidGZipData class#The InvalidGZipData methods|Methods]]
<li>[[InvalidHexData class|Synopsis]] | [[InvalidHexData class#The InvalidHexData methods|Methods]]
<li>[[InvalidJsonType class|Synopsis]] | [[InvalidJsonType class#The InvalidJsonType methods|Methods]]
<li>[[InvalidRegex class|Synopsis]] | [[InvalidRegex class#The InvalidRegex methods|Methods]]
<li>[[InvalidSortSpecification class|Synopsis]] | [[InvalidSortSpecification class#The InvalidSortSpecification methods|Methods]]
<li>[[InvalidValue class|Synopsis]] | [[InvalidValue class#The InvalidValue methods|Methods]]
<li>[[ItemNotFound class|Synopsis]] | [[ItemNotFound class#The ItemNotFound methods|Methods]]
<li>[[ItemNotPresent class|Synopsis]] | [[ItemNotPresent class#The ItemNotPresent methods|Methods]]
<li>[[JsonCircularException|Synopsis]] | [[JsonCircularReference class#The JsonCircularReference methods|Methods]]
<li>[[JsonParseError class|Synopsis]] | [[ JsonParseErrorclass#The JsonParseError methods|Methods]]
<li>[[MaxDaemExceeded class|Synopsis]] | [[MaxDaemExceeded class#The MaxDaemExceeded methods|Methods]]
<li>[[MismatchedQuote class|Synopsis]] | [[MismatchedQuote class#The MismatchedQuote methods|Methods]]
<li>[[NoFreeDaemons class|Synopsis]] | [[NoFreeDaemons class#The NoFreeDaemons methods|Methods]]
<li>[[NotJanusConnection class|Synopsis]] | [[NotJanusConnection class#The NotJanusConnection methods|Methods]]
<li>[[OutOfBounds class|Synopsis]] | [[OutOfBounds class#The OutOfBounds methods|Methods]]
<li>[[RecordLockingConflict class|Synopsis]] | [[RecordLockingConflict class#The RecordLockingConflict methods|Methods]]
<li>[[ScreenReadError class|Synopsis]] | [[ScreenReadError class#The ScreenReadError methods|Methods]]
<li>[[UnknownStatistic class|Synopsis]] | [[UnknownStatistic class#The UnknownStatistic methods|Methods]]
<li>[[WebScreenException class|Synopsis]] | [[WebScreenException class#The WebScreenException methods|Methods]]
<li>[[XmlParseError class|Synopsis]] | [[XmlParseError class#The XmlParseError methods|Methods]]
<li>[[XPathError class|Synopsis]] | [[XPathError class#The XPathError methods|Methods]]</ul></td></tr>
</table>

==System types==
<table>
<tr><td style="border-right:0"><div id="except"></div>System types<ul class="nobul">
<li>CertificateChecker</li>
<li>ProcedureInfoList</li>
<li>WebScreenCallback</li>
</ul></td>
<td nowrap style="border-left:0"> <ul class="nobulnoindent">
<li>[[CertificateChecker type|Synopsis]]</li>
<li>[[ProcedureInfoList type|Synopsis]]</li>
<li>[[WebScreenCallback type|Synopsis]]</li>
</ul></td></tr>
</table>

Stringify (Json function)

2015-05-01T19:20:31Z

MCosta: /* Usage notes */

{{Template:Json:Stringify subtitle}}
This function serializes a Json object tree as a unicode JSON string.
==Syntax==
{{Template:Json:Stringify syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%unicode</th><td>A unicode string that contains the JSON format serialization of the Json object tree.</td></tr>
<tr><th>Json</th>
<td>Json object, which may be <var>Null</var> or any underlying Json object type (boolean, number, string, array, or object).</td></tr>
<tr><th><var>Indent</var></th>
<td>The number of space characters to add in front of each line for each nesting level (see below for moe details). The default value of <var>Indent</var> is 0 which means lines won't be indented.</td></tr>
</table>
==Usage notes==
<ul>
<li>The name <i>Stringify</i> derives from the equivalent JavaScript method: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify JSON.stringify].</li>
<li>The functionality of Stringify is practically identical to that of [[ToString (Json function)|ToString]]. The only difference is that Stringify throws a [[JsonCircularReference class|JsonCircularReference]] exception if the Json object leads to a [[Json class#Circular references|circular reference]]. Because the JSON specification does not allow for circular references, Stringify is probably the preferred function to use for generating JSON to send to another platform – it's better to catch the exception in Model 204 than to send bad JSON data to someone else.</li>
<li>If no indentation is used (<var>Indent</var> defaults or is set to 0) no whitespace is added between any of the JSON tokens and separator characters (curly and square braces, commas, and colons). This format is very compact but can be tough for humans to read.</li>
<li>If indentation is used, a [http://en.wikipedia.org/wiki/Newline unicode linefeed character] (u+000a) is added before each array item or object property and after the last array item or object property. If the unicode data is printed or audited, the unicode linefeed characters will cause a new line to be started on the screen or audit trail. This will make the serialized JSON data much nicer and easier to read.</li>
<li>The <var>Indent</var> value indicates the number of blank characters per indentation level to place before each new line of data. Every array and object increases the indentation level by one inside its boundaries. So if an array is inside an object which is inside another object that array's indentation level is 3. With an <var>Indent</var> value of 2 each array item in that array will have 6 space characters in front of it.</li>
<li>If a non-zero <var>Indent</var> value is used, a single space character is always placed after the colon in an object property name.</li>
<li>If the serialized JSON data is to be sent to another platform, the unicode JSON data generally needs to be UTF-8 or UTF-16 encoded which can be done by using the [[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]] or [[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]] Unicode functions. Even if the data is known to only contain data that is translatable to EBCDIC it is best to avoid converting it to EBCDIC, if possible.</li>
<li>A null Json object serializes as the unicode literal <code>null</code>.</li>
</ul>

==Examples==
The following example builds a Json object tree then serializes it using Stringify and prints the result:
<p class="code">b

%json is object json
%title is string len 64
%i is float

%json = object
%json("Lee") = "To Kill a Mockingbird"
%json("Faulkner") = array("As I Lay Dying", "Absalom, Absalom", "The Sound and the Fury")
%json("Hurston") = array("Jonah's Gourd Vine", "Their Eyes Were Watching God")
%json("Ellison") = "Invisible Man"

printText {~=%json:stringify(indent=2)}

end
</p>
This prints:
<p class="code">%json:stringify(indent=2)={
"Lee": "To Kill a Mockingbird",
"Faulkner": [
"As I Lay Dying",
"Absalom, Absalom",
"The Sound and the Fury"
],
"Hurston": [
"Jonah's Gourd Vine",
"Their Eyes Were Watching God"
],
"Ellison": "Invisible Man"
}
</p>
If the <code>indent=2</code> were removed from the above code, it would print (wrapping at column 80):
<p class="code">%json:stringify(indent=0)={"Lee":"To Kill a Mockingbird","Faulkner":["As I Lay -
Dying","Absalom, Absalom","The Sound and the Fury"],"Hurston":["Jonah's Gourd V-
ine","Their Eyes Were Watching God"],"Ellison":"Invisible Man"}
</p>
==See also==
{{Template:Json:Stringify footer}}

Stringify (Json function)

2015-05-01T19:17:35Z

MCosta: /* Usage notes */

{{Template:Json:Stringify subtitle}}
This function serializes a Json object tree as a unicode JSON string.
==Syntax==
{{Template:Json:Stringify syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%unicode</th><td>A unicode string that contains the JSON format serialization of the Json object tree.</td></tr>
<tr><th>Json</th>
<td>Json object, which may be <var>Null</var> or any underlying Json object type (boolean, number, string, array, or object).</td></tr>
<tr><th><var>Indent</var></th>
<td>The number of space characters to add in front of each line for each nesting level (see below for moe details). The default value of <var>Indent</var> is 0 which means lines won't be indented.</td></tr>
</table>
==Usage notes==
<ul>
<li>The name <i>Stringify</i> derives from the equivalent JavaScript method: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify JSON.stringify].</li>
<li>The functionality of Stringify is practically identical to that of [[ToString (Json function)|ToString]]. The only difference is that Stringify throws a [[JsonCircularReference class|JsonCircularReference]] exception if the Json object leads to a [[Json class#Circular references|circular reference]]. Because the JSON specification does not allow for circular references, Stringify is probably the preferred function to use for generating JSON to send to another platform – it's better to request cancel in 204 than to send bad JSON data to someone else.</li>
<li>If no indentation is used (<var>Indent</var> defaults or is set to 0) no whitespace is added between any of the JSON tokens and separator characters (curly and square braces, commas, and colons). This format is very compact but can be tough for humans to read.</li>
<li>If indentation is used, a [http://en.wikipedia.org/wiki/Newline unicode linefeed character] (u+000a) is added before each array item or object property and after the last array item or object property. If the unicode data is printed or audited, the unicode linefeed characters will cause a new line to be started on the screen or audit trail. This will make the serialized JSON data much nicer and easier to read.</li>
<li>The <var>Indent</var> value indicates the number of blank characters per indentation level to place before each new line of data. Every array and object increases the indentation level by one inside its boundaries. So if an array is inside an object which is inside another object that array's indentation level is 3. With an <var>Indent</var> value of 2 each array item in that array will have 6 space characters in front of it.</li>
<li>If a non-zero <var>Indent</var> value is used, a single space character is always placed after the colon in an object property name.</li>
<li>If the serialized JSON data is to be sent to another platform, the unicode JSON data generally needs to be UTF-8 or UTF-16 encoded which can be done by using the [[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]] or [[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]] Unicode functions. Even if the data is known to only contain data that is translatable to EBCDIC it is best to avoid converting it to EBCDIC, if possible.</li>
<li>A null Json object serializes as the unicode literal <code>null</code>.</li>
</ul>

==Examples==
The following example builds a Json object tree then serializes it using Stringify and prints the result:
<p class="code">b

%json is object json
%title is string len 64
%i is float

%json = object
%json("Lee") = "To Kill a Mockingbird"
%json("Faulkner") = array("As I Lay Dying", "Absalom, Absalom", "The Sound and the Fury")
%json("Hurston") = array("Jonah's Gourd Vine", "Their Eyes Were Watching God")
%json("Ellison") = "Invisible Man"

printText {~=%json:stringify(indent=2)}

end
</p>
This prints:
<p class="code">%json:stringify(indent=2)={
"Lee": "To Kill a Mockingbird",
"Faulkner": [
"As I Lay Dying",
"Absalom, Absalom",
"The Sound and the Fury"
],
"Hurston": [
"Jonah's Gourd Vine",
"Their Eyes Were Watching God"
],
"Ellison": "Invisible Man"
}
</p>
If the <code>indent=2</code> were removed from the above code, it would print (wrapping at column 80):
<p class="code">%json:stringify(indent=0)={"Lee":"To Kill a Mockingbird","Faulkner":["As I Lay -
Dying","Absalom, Absalom","The Sound and the Fury"],"Hurston":["Jonah's Gourd V-
ine","Their Eyes Were Watching God"],"Ellison":"Invisible Man"}
</p>
==See also==
{{Template:Json:Stringify footer}}

Stringify (Json function)

2015-05-01T19:17:08Z

MCosta: /* Usage notes */

{{Template:Json:Stringify subtitle}}
This function serializes a Json object tree as a unicode JSON string.
==Syntax==
{{Template:Json:Stringify syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%unicode</th><td>A unicode string that contains the JSON format serialization of the Json object tree.</td></tr>
<tr><th>Json</th>
<td>Json object, which may be <var>Null</var> or any underlying Json object type (boolean, number, string, array, or object).</td></tr>
<tr><th><var>Indent</var></th>
<td>The number of space characters to add in front of each line for each nesting level (see below for moe details). The default value of <var>Indent</var> is 0 which means lines won't be indented.</td></tr>
</table>
==Usage notes==
<ul>
<li>The name <i>Stringify</i> derives from the equivalent JavaScript method: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify JSON.stringify].</li>
<li>The functionality of Stringify is practically identical to that of [[ToString (Json function)|ToString]]. The only difference is that Stringify throws a [[JsonCircularReference class|JsonCircularReference]]Exception if the Json object leads to a [[Json class#Circular references|circular reference]]. Because the JSON specification does not allow for circular references, Stringify is probably the preferred function to use for generating JSON to send to another platform – it's better to request cancel in 204 than to send bad JSON data to someone else.</li>
<li>If no indentation is used (<var>Indent</var> defaults or is set to 0) no whitespace is added between any of the JSON tokens and separator characters (curly and square braces, commas, and colons). This format is very compact but can be tough for humans to read.</li>
<li>If indentation is used, a [http://en.wikipedia.org/wiki/Newline unicode linefeed character] (u+000a) is added before each array item or object property and after the last array item or object property. If the unicode data is printed or audited, the unicode linefeed characters will cause a new line to be started on the screen or audit trail. This will make the serialized JSON data much nicer and easier to read.</li>
<li>The <var>Indent</var> value indicates the number of blank characters per indentation level to place before each new line of data. Every array and object increases the indentation level by one inside its boundaries. So if an array is inside an object which is inside another object that array's indentation level is 3. With an <var>Indent</var> value of 2 each array item in that array will have 6 space characters in front of it.</li>
<li>If a non-zero <var>Indent</var> value is used, a single space character is always placed after the colon in an object property name.</li>
<li>If the serialized JSON data is to be sent to another platform, the unicode JSON data generally needs to be UTF-8 or UTF-16 encoded which can be done by using the [[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]] or [[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]] Unicode functions. Even if the data is known to only contain data that is translatable to EBCDIC it is best to avoid converting it to EBCDIC, if possible.</li>
<li>A null Json object serializes as the unicode literal <code>null</code>.</li>
</ul>

==Examples==
The following example builds a Json object tree then serializes it using Stringify and prints the result:
<p class="code">b

%json is object json
%title is string len 64
%i is float

%json = object
%json("Lee") = "To Kill a Mockingbird"
%json("Faulkner") = array("As I Lay Dying", "Absalom, Absalom", "The Sound and the Fury")
%json("Hurston") = array("Jonah's Gourd Vine", "Their Eyes Were Watching God")
%json("Ellison") = "Invisible Man"

printText {~=%json:stringify(indent=2)}

end
</p>
This prints:
<p class="code">%json:stringify(indent=2)={
"Lee": "To Kill a Mockingbird",
"Faulkner": [
"As I Lay Dying",
"Absalom, Absalom",
"The Sound and the Fury"
],
"Hurston": [
"Jonah's Gourd Vine",
"Their Eyes Were Watching God"
],
"Ellison": "Invisible Man"
}
</p>
If the <code>indent=2</code> were removed from the above code, it would print (wrapping at column 80):
<p class="code">%json:stringify(indent=0)={"Lee":"To Kill a Mockingbird","Faulkner":["As I Lay -
Dying","Absalom, Absalom","The Sound and the Fury"],"Hurston":["Jonah's Gourd V-
ine","Their Eyes Were Watching God"],"Ellison":"Invisible Man"}
</p>
==See also==
{{Template:Json:Stringify footer}}

JsonCircularReference class

2015-05-01T19:12:54Z

MCosta:

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a [[Json class#Circular references|circular reference]].

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<p>The following example catches a circular reference exception and prints the string where the circular reference occurs.
</p>
<p class="code">b
%jsonCircRefError is object JsonCircularReference
%jsa is object json
%jsb is object json
%jsc is object json

%jsa = array('a')
%jsb = array('b')
%jsc = array('c')
%jsa:add(%jsb)
%jsb:add(%jsc)
%jsc:add(%jsa)

try
print %jsa:stringify
catch JsonCircularReference to %jsonCircRefError
print 'Caught Json Circular Reference Error'
print %jsa:tostring
end try
end
</p>

Running this example results in:
<p class="code">Caught Json Circular Reference Error
["a",["b",["c",[Circular]]]]
</p>
[[Category:System exception classes]]

Stringify (Json function)

2015-05-01T19:11:15Z

MCosta: /* Usage notes */

{{Template:Json:Stringify subtitle}}
This function serializes a Json object tree as a unicode JSON string.
==Syntax==
{{Template:Json:Stringify syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%unicode</th><td>A unicode string that contains the JSON format serialization of the Json object tree.</td></tr>
<tr><th>Json</th>
<td>Json object, which may be <var>Null</var> or any underlying Json object type (boolean, number, string, array, or object).</td></tr>
<tr><th><var>Indent</var></th>
<td>The number of space characters to add in front of each line for each nesting level (see below for moe details). The default value of <var>Indent</var> is 0 which means lines won't be indented.</td></tr>
</table>
==Usage notes==
<ul>
<li>The name <i>Stringify</i> derives from the equivalent JavaScript method: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify JSON.stringify].</li>
<li>The functionality of Stringify is practically identical to that of [[ToString (Json function)|ToString]]. The only difference is that Stringify throws a JsonCircularReference Exception if the Json object leads to a [[Json class#Circular references|circular reference]]. Because the JSON specification does not allow for circular references, Stringify is probably the preferred function to use for generating JSON to send to another platform – it's better to request cancel in 204 than to send bad JSON data to someone else.</li>
<li>If no indentation is used (<var>Indent</var> defaults or is set to 0) no whitespace is added between any of the JSON tokens and separator characters (curly and square braces, commas, and colons). This format is very compact but can be tough for humans to read.</li>
<li>If indentation is used, a [http://en.wikipedia.org/wiki/Newline unicode linefeed character] (u+000a) is added before each array item or object property and after the last array item or object property. If the unicode data is printed or audited, the unicode linefeed characters will cause a new line to be started on the screen or audit trail. This will make the serialized JSON data much nicer and easier to read.</li>
<li>The <var>Indent</var> value indicates the number of blank characters per indentation level to place before each new line of data. Every array and object increases the indentation level by one inside its boundaries. So if an array is inside an object which is inside another object that array's indentation level is 3. With an <var>Indent</var> value of 2 each array item in that array will have 6 space characters in front of it.</li>
<li>If a non-zero <var>Indent</var> value is used, a single space character is always placed after the colon in an object property name.</li>
<li>If the serialized JSON data is to be sent to another platform, the unicode JSON data generally needs to be UTF-8 or UTF-16 encoded which can be done by using the [[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]] or [[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]] Unicode functions. Even if the data is known to only contain data that is translatable to EBCDIC it is best to avoid converting it to EBCDIC, if possible.</li>
<li>A null Json object serializes as the unicode literal <code>null</code>.</li>
</ul>

==Examples==
The following example builds a Json object tree then serializes it using Stringify and prints the result:
<p class="code">b

%json is object json
%title is string len 64
%i is float

%json = object
%json("Lee") = "To Kill a Mockingbird"
%json("Faulkner") = array("As I Lay Dying", "Absalom, Absalom", "The Sound and the Fury")
%json("Hurston") = array("Jonah's Gourd Vine", "Their Eyes Were Watching God")
%json("Ellison") = "Invisible Man"

printText {~=%json:stringify(indent=2)}

end
</p>
This prints:
<p class="code">%json:stringify(indent=2)={
"Lee": "To Kill a Mockingbird",
"Faulkner": [
"As I Lay Dying",
"Absalom, Absalom",
"The Sound and the Fury"
],
"Hurston": [
"Jonah's Gourd Vine",
"Their Eyes Were Watching God"
],
"Ellison": "Invisible Man"
}
</p>
If the <code>indent=2</code> were removed from the above code, it would print (wrapping at column 80):
<p class="code">%json:stringify(indent=0)={"Lee":"To Kill a Mockingbird","Faulkner":["As I Lay -
Dying","Absalom, Absalom","The Sound and the Fury"],"Hurston":["Jonah's Gourd V-
ine","Their Eyes Were Watching God"],"Ellison":"Invisible Man"}
</p>
==See also==
{{Template:Json:Stringify footer}}

JsonCircularReference class

2015-05-01T18:51:55Z

MCosta: /* Usage notes */

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<p>The following example catches a circular reference exception and prints the string where the circular reference occurs.
</p>
<p class="code">b
%jsonCircRefError is object JsonCircularReference
%jsa is object json
%jsb is object json
%jsc is object json

%jsa = array('a')
%jsb = array('b')
%jsc = array('c')
%jsa:add(%jsb)
%jsb:add(%jsc)
%jsc:add(%jsa)

try
print %jsa:stringify
catch JsonCircularReference to %jsonCircRefError
print 'Caught Json Circular Reference Error'
print %jsa:tostring
end try
end
</p>

Running this example results in:
<p class="code">Caught Json Circular Reference Error
["a",["b",["c",[Circular]]]]
</p>
[[Category:System exception classes]]

JsonCircularReference class

2015-05-01T18:49:14Z

MCosta: /* Usage notes */

JsonCircularReference class

2015-05-01T18:48:19Z

MCosta: /* Usage notes */

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<p>The following example illustrates a circular reference exception and prints the string where the circular reference occurs.
</p>
<p class="code">b
%jsonCircRefError is object JsonCircularReference
%jsa is object json
%jsb is object json
%jsc is object json

%jsa = array('a')
%jsb = array('b')
%jsc = array('c')
%jsa:add(%jsb)
%jsb:add(%jsc)
%jsc:add(%jsa)

try
print %jsa:stringify
catch JsonCircularReference to %jsonCircRefError
print 'Caught Json Circular Reference Error'
print %jsa:tostring
end try
end
</p>
[[Category:System exception classes]]

JsonCircularReference class

2015-05-01T18:39:28Z

MCosta: /* Usage notes */

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<p class="code">
b
%jsonCircRefError is object JsonCircularReference
%jsa is object json
%jsb is object json
%jsc is object json

%jsa = array('a')
%jsb = array('b')
%jsc = array('c')
%jsa:add(%jsb)
%jsb:add(%jsc)
%jsc:add(%jsa)

try
print %jsa:stringify
catch JsonCircularReference to %jsonCircRefError
print 'Caught Json Circular Reference Error'
print %jsa:tostring
end try
end
</p>
[[Category:System exception classes]]

Template:JsonCircularReference:New subtitle

2015-05-01T18:18:07Z

MCosta: Created page with "<span class="pageSubtitle">Create a new JsonCircularReference object (JsonCircularReference class)</span>"

<span class="pageSubtitle">Create a new JsonCircularReference object ([[JsonCircularReference class]])</span>

JsonCircularReference class

2015-05-01T16:07:37Z

MCosta: /* Usage notes */

JsonCircularReference class

2015-05-01T15:46:03Z

MCosta:

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonCircularReference</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<ul>
<li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:
<p class="code">%jcircref = new

%jcircref = %(JsonCircularReference):new

%jcircref = %jcircref:new
</p>
</ul>

[[Category:System exception classes]]

JsonCircularReference class

2015-05-01T15:44:48Z

MCosta:

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

Remember that you catch an exception with the <var>[[Exceptions#Try and Catch|Catch]]</var> statement; if an exception condition occurs outside a <var>Catch</var> for it, the request is canceled.

The <var>JsonParseError</var> class, like the Json class is available as of <var class="product">Model 204</var> 7.6.

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<ul>
<li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:
<p class="code">%jcircref = new

%jcircref = %(JsonCircularReference):new

%jcircref = %jcircref:new
</p>
</ul>

[[Category:System exception classes]]

JsonCircularReference class

2015-05-01T15:43:28Z

MCosta:

JsonCircularReference exceptions are thrown by the Stringify function in the Json class if the Json object leads to a circular reference.

To produce a <var>JsonCircularReference</var> exception for yourself, you typically use a <var class="product">SOUL</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with a <var>JsonCircularReference</var> <var>[[New_(JsonCircularReference_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws a <var>JsonCircularReference</var> exception:
<p class="code">throw %(JsonCircularReference):new
</p>

==The JsonCircularReference methods==
{{Template:List of JsonCircularReference methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li>
<li>[[JsonCircularReference methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==New constructor==
{{Template:JsonCircularReference:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>JsonCircularReference</var> exception. The <var>New</var> method format is as follows:

===Syntax===
{{Template:JsonCircularReference:New syntax}}

====Syntax terms====
<table class="syntaxTable">

<tr><th>%JsonCircularReference </th>
<td>A reference to an instance of a <var>JsonCircularReference</var> object.
</td></tr>

<tr><th><var>[%(JsonCircularReference):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking a <var>JsonCircularReference</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<ul>
<li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:
<p class="code">%jcircref = new

%jcircref = %(JsonCircularReference):new

%jcircref = %jcircref:new
</p>
</ul>

[[Category:System exception classes]]