Dictionary/204 installation guide

Overview

Dictionary/204 Is a set of application subsystems (known as APSYs) running inside a Model 204 Online that provide full-screen and web-based tools to help programmers, DBAs, and system managers handle the complexities of User Language and file and system management.

Installing Dictionary/204 requires downloading the M204PROC file and restoring it to your environment, setting up some subsidiary Model 204 files, and verifying that the environment has the appropriate parameter settings.

Note: As of Model 204 version 7.7, the M204PROC file is the container for the RKTools version 7.7 product, and Dictionary/204 is accessible from the RKTools interfaces (TN3270 and web), as well as from the usual Dictionary main menu.

Upgrades to Dictionary/204 can almost always be handled by restoring a fresh copy of the M204PROC file.

A summary of the Dictionary/204 installation steps

The following checklist specifies in brief the steps to follow installing Dictionary/204, 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/OS, and Installing Dictionary/204 on IBM z/VSE describe these steps in greater detail for each operating system.

1. Allocate the space required for the M204PROC data set, and RESTORE it from the DUMP files found on the website.

   In addition, there might be any number of other data sets required for the Dictionary/204 components you are installing. These are listed in Installation checklist (z/VM CMS), Installation checklist (z/OS), and Installation checklist (z/VSE).

2. If this is an upgrade, create backups of all Dictionary/204 files.
3. If Dictionary/204 has never been installed, use JCL provided in the DDINST job in RKOBJLIB.
4. If this is an upgrade, run DICN.DDRINST using the JCL provided in the DDRINST job in RKOBJLIB.
5. Verify the success of the installation by compiling each Dictionary/204 subsystem.
6. Use the subsystem named DICTADMIN to customize the Dictionary/204 environment.

Preparing for Dictionary/204 installation

The Dictionary/204 products are implemented as Model 204 subsystems. The code for all the component subsystems resides in the file named M204PROC which is typically downloaded from the Support section of the Rocket Software website.

Obtaining product installation files

The files necessary for the installation are available from the Rocket Software website:

1. On the Rocket M204 Customer Care page, click the Download SOUL files link.
2. After providing your registered customer login information, download the latest version of the Dictionary/204 file, M204PROC. The M204PROC file to download for versions higher than 7.5 of Model 204 is the file in the RKTools V7.7 product row. As described in Dictionary/204 logon and commands, Dictionary/204 is packaged with RKTools as of RKTools V7.7.

   A "Click here" link in the text at the beginning of this page provides Help on downloading format, some information about different browser behaviors, file sizing information, and more.

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

• Dictionary/204 operates in a Model 204 Online region.

  In the rest of this document, "Online" refers to a region of Model 204 running an ONLINE load module containing version 7.5 or higher.

User privileges

The installing user must have:

• Update access to the JCL or EXECs that bring up the host Online.
• System Manager privileges, as well as access to all of the Dictionary/204 subsystems and the JCL or EXEC that runs the Online Model 204 region.

New installation or reinstallation

• Sites that have never installed Dictionary/204 must use the new installation, as there are a number of files to allocate and Model 204 parameters to update.
• Sites that are re-installing the latest version of Dictionary/204 can reinstall Dictionary/204 (using DDRINST) or perform a new installation (using DDINST) to create a new set of Dictionary/204 files.

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

New installation

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

You can verify the Dictionary/204 version in the title of any Dictionary/204 screen. The installation steps are as follows:

1. In the Rocket M204 Customer Care page of the Rocket website, click the Download SOUL files link.
2. Download the appropriate version of the M204PROC file for your version of Model 204 (for version 7.7, M204PROC is the container for, and Dictionary/204 is a member of, RKTools).
3. Verify that the Online in which you are installing contains a version of Model 204 equal to or greater than the Dictionary/204 version.
4. Restore the M204PROC file into a file on your mainframe. (This file must be 6000 pages for 7.6 or earlier, or 9800 pages for 7.7 or later.) The DDNAME for this file in your Model 204 regions is also M204PROC.

5. Using the JCL from RKOBJLIB DDINST, run the procedure DICN.DDINST to install the downloaded release.

The Dictionary/204 APSYs can be set to AUTOSTART if you prefer.

Reinstallation for existing Dictionary/204 sites

You can verify the Dictionary/204 version in the title of any Dictionary/204 screen. The reinstallation steps are as follows:

1. In the Rocket M204 Customer Care page of the Rocket website, click the Download SOUL files link.
2. Download the latest version of the M204PROC file (which is followed by a version number). This is a dump of M204PROC.
3. Restore that dump data set into an M204PROC file on your mainframe. (This file must be 6000 pages for 7.6 or earlier, or 9800 pages for 7.7 or later.)

   If you are upgrading from a previous release, simply overlay your old M204PROC file.

4. Submit the Dictionary/204 re-installation job, member DDRINST in RKOBJLIB. This is a single-user, Model 204 job with the SYSOPT X'01' bit turned off, because the upgrade process requires the redefinition of two fields, APSUNM and APSCLSS to ORDERED CHARACTER, in CCASYS.

   Note: Running the installation job (DDRINST) creates backups of the upgraded Dictionary files.

Installing Dictionary/204 on IBM z/VM CMS

This section gives instructions for installing Dictionary/204 on z/VM CMS, including z/VM CMS system and software requirements.

Review Preparing for Dictionary/204 installation for details about general Dictionary/204 system requirements.

The M204PROC Model 204 file, which contains the SOUL code that runs Dictionary/204, can be obtained from the Rocket website.

The following files are required to complete an installation of Dictionary/204:

• METADATA
• DATALINK
• M204TEMP
• D204RPT
• D204SYS
• M204DCTL

Allocate space for the Dictionary/204 files, and restore them from the dump files downloaded from the Rocket website, as described in the following steps.

Installation checklist (z/VM CMS)

1. Define and format a minidisk to hold the Dictionary/204 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.
2. Allocate space for the required Dictionary/204 data sets. A skeleton exec, D204FDEF, is provided for this purpose. Modify this exec to perform the allocations on the appropriate minidisks.

   Allocate space for the following data sets:

   M204PROC	6000 pages (7.6 or earlier), 9800 pages (7.7 or later); must always be allocated.
   METADATA	400 pages; must always be allocated.
   DATALINK	400 pages; must always be allocated.
   M204TEMP	400 pages; must always be allocated.
   D204RPT	400 pages; must always be allocated.
   D204SYS	400 pages; must always be allocated.
   M204DCTL	400 pages; must always be allocated.

   Attention: If you are upgrading from a previous release, modify the D204FDEF EXEC to use the old Dictionary/204 files for the upgrade.

   The installation process uses these files to install a new version of Dictionary/204.

3. Modify the RESPROC EXEC to specify the M204PROC dump file and M204PROC file to be loaded.
4. Restore the M204PROC file with the D204 RESPROC exec.

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

5. To run the D204 exec for a new install, make sure the Online execs and load modules are on an accessed disk, then enter this command:

   EXEC D204 INSTALL

6. To run the D204 exec for a REINSTALL, make sure the Online execs and load modules are on an accessed disk, then enter this command:

   EXEC D204 REINSTALL

7. Complete steps 3 through the end in the Installing Dictionary/204 on IBM z/OS section.

Installing Dictionary/204 on IBM z/OS

This section gives instructions for installing Dictionary/204 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.

Installation checklist (z/OS)

1. Allocate the space required for the M204PROC file:

   M204PROC	6000 pages (7.6 or earlier), 9800 pages (7.7 or later)

   If you are creating a new M204PROC file from scratch, this will not be a problem. But if you are restoring into your existing M204PROC file, you will have to CREATE the file first (to wipe out existing content) before you execute the RESTORE.

   An example command sequence follows:

   CREATE FILE M204PROC END CREATE OPEN FILE M204PROC IN M024PROC RESTORE 192 FROM whatever

   Attention: If you are upgrading from a previous release, keep your old copies of Dictionary/204 files (see list of files in a following step). The installation process uses these files to determine whether to perform upgrade actions or new-installation actions.

2. Restore M204PROC, noting the following:
   • Rename database DSNs to conform to local standards.
3. Update the Online JCL or EXEC:

   Add DD cards for the Dictionary/204 files that the installation job allocates and creates. The following list identifies the files for which DD cards might be needed:

   M204PROC

   METADATA

   DATALINK

   M204TEMP

   M204DCTL

   D204SYS

   D204RPT

4. Verify that the Online environment allows the use of file groups and APSY subsystems.
   • To use permanent file groups, the Online must have a CCAGRP file defined to the run, and the SYSOPT parameter must contain the 2 bit.
   • To use APSYs, an Online must have a CCASYS file defined to the run, and the SYSOPT parameter must contain the 1 bit.

     For more information about APSYs and file groups, see File groups and System requirements for Application Subsystems.

5. Modify the User 0 stream.

   Adjust these parameters:

   NFILES	Increase by the number of Dictionary/204 files.
   NDCBS	Increase by the number of Dictionary/204 files.
   NDIR	Increase by the number of Dictionary/204 files.
   NORQS	Verify setting is at least 10.

6. To install Dictionary/204 for the first time, use the JCL provided in DDINST, which is stored in the RKOBJLIB.
7. To upgrade your existing Dictionary/204, run DICN.DDRINST using the JCL provided in the DDRINST job in RKOBJLIB.

   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.

   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.

8. Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 subsystems.

   The installing user is automatically added to the administration SCLASS in all Dictionary/204 subsystems.

9. Verify the installation of the subsystem(s) by compiling all of the subsystems.

   Enter ...	To test the ...
   START SUBSYS DICTIONARY	Dictionary main menu
   START SUBSYS DICTADMIN	Dictionary Administration
   START SUBSYS DOCUMENT	Documentation environment
   START SUBSYS FILEMGMT	File building tool
   START SUBSYS SUBSYSMGMT	Defining APSY subsystems
   START SUBSYS DICTREPORT	Dictionary report subsystem
   START SUBSYS XREF	Cross reference reporting subsystem

   If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under TEST DEBUG mode. For example, to determine why DICTIONARY failed to compile, enter:

   TEST DEBUG DICTIONARY

10. This step is optional. Modify the online input stream so User 0 initializes (compiles) the Dictionary/204 subsystems. Do this by placing one or more of the following in User 0's input stream:

    START SUBSYS DICTIONARY START SUBSYS DOCUMENT START SUBSYS DICTADMIN START SUBSYS FILEMGMT START SUBSYS SUBSYSMGMT START SUBSYS DICTREPORT START SUBSYS XREF

    This ensures that the subsystems are started for non-administrative users, and it shifts the overhead of compilation to a non-peak computing period.

11. Review the Dictionary/204 server size section, below, for specific requirements of individual APSY components of Dictionary/204.

Note: CCATEMP usage may increase with Dictionary/204. CCATEMP should be monitored (VIEW TEMPSIZE, VIEW TEMPMAX) to ensure that sufficient space is allocated to accommodate the additional activity.

Installing Dictionary/204 on IBM z/VSE

This section gives instructions for installing Dictionary/204 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.

Installation checklist (z/VSE)

1. Allocate the space required for the Dictionary/204 files:

   M204PROC	6000 pages (7.6 or earlier), 9800 pages (7.7 or later)
   METADATA	400 pages
   DATALINK	400 pages
   M204TEMP	400 pages
   D204RPT	400 pages
   D204SYS	400 pages
   M204DCTL	400 pages

   If you are creating a new M204PROC file from scratch, this will not be a problem. But if you are restoring into your existing M204PROC file, you will have to CREATE the file first (to wipe out existing content) before you execute the RESTORE.

   A sample command sequence follows:

   CREATE FILE M204PROC END CREATE OPEN FILE M204PROC IN M024PROC RESTORE 192 FROM whatever

   Attention: If you are upgrading from a previous release, keep your old copies of Dictionary/204 files (see list of files in a following step). The installation process uses these files to determine whether to perform upgrade actions or new-installation actions.

2. Restore M204PROC, noting the following:
   • Rename database DSNs to conform to local standards.
   • Provide a valid logon ID and password for the CCAIN stream for this job. If, for example, you are using the M204PROC file for the first time, make sure it is created, opened, and initialized before the RESTORE.
3. Update the Online JCL or EXEC:

   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:

   M204PROC

   METADATA

   DATALINK

   M204TEMP

   M204DCTL

   D204SYS

   D204RPT

4. Verify that the Online environment allows the use of file groups and application subsystems.
   • To use permanent file groups, the Online must have a CCAGRP file defined to the run, and the UPSI parameter must contain the 00000010 bit.
   • To use application subsystems, an Online must have a CCASYS file defined to the run, and the UPSI parameter must contain the 00000001 bit.

     For more information about application subsystems and file groups, see File groups and System requirements for Application Subsystems.

5. Modify the User 0 stream.

   Adjust these parameters:

   NFILES	Increase by the number of Dictionary/204 files.
   NDCBS	Increase by the number of Dictionary/204 files.
   NDIR	Increase by the number of Dictionary/204 files.
   NORQS	Verify that the setting is at least 5.

6. Start the Model 204 Online region, verifying that it points to a load module containing the Model204 Online.
7. Issue OPEN FILE M204PROC (no password is required), and execute the following command:

   INCLUDE DICN.DDRINST

   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.

   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.

8. Add users to the appropriate SCLASSes for any private or semi-public Dictionary/204 APSYs.

   The installing user is automatically added to the administration SCLASS in all Dictionary/204 APSYs.

9. Verify the installation of the subsystem(s) by compiling all of the subsystems.

   Enter ...	To test the ...
   START SUBSYS DICTIONARY	Dictionary main menu
   START SUBSYS DICTADMIN	Dictionary Administration
   START SUBSYS DOCUMENT	Documentation environment
   START SUBSYS FILEMGMT	File building tool
   START SUBSYS SUBSYSMGMT	Defining APSY subsystems
   START SUBSYS DICTREPORT	Dictionary report subsystem
   START SUBSYS XREF	Cross reference reporting subsystem

   If any of these subsystems fails to compile, ensure that the subsystem is STOPped, and run it under TEST DEBUG mode. For example, to determine why DICTIONARY failed to compile, enter:

   TEST DEBUG DICTIONARY

10. This step is optional. Modify the online input stream so User 0 initializes (compiles) the Dictionary/204 subsystems. Do this by placing one or more of the following in User 0's input stream:

    START SUBSYS DICTIONARY START SUBSYS DOCUMENT START SUBSYS DICTADMIN START SUBSYS FILEMGMT START SUBSYS SUBSYSMGMT START SUBSYS DICTREPORT START SUBSYS XREF

    This ensures that the subsystems are started for non-administrative users, and it shifts the overhead of compilation to a non-peak computing period.

11. Review Dictionary/204 server size for specific requirements of individual APSY components of Dictionary/204.

Note: CCATEMP usage might increase with Dictionary/204. CCATEMP should be monitored (VIEW TEMPSIZE, VIEW TEMPMAX) to ensure that sufficient space is allocated to accommodate the additional activity.

Dictionary/204 server size

The minimum Dictionary/204 server size requirements are listed below. The actual server size requirements might vary slightly because of table settings in the local Online Model 204 regions, and because of slight differences between UTABLE requirements in different versions of Model 204.

Subsystem name	Minimum server
DICTIONARY	455K
DOCUMENT	455K
DICTADMIN	455K
FILEMGMT	455K
SUBSYSMGMT	455K
DICTREPORT	455K
XREF	455K

For more information about Dictionary/204

After completing the installation, see the Dictionary/204 topics for instructions on how to:

• Start, stop, and test Dictionary/204 subsystems
• Set Dictionary/204 facility parameters
• Define Dictionary/204 users
• Customize the Dictionary/204 structure
• Use the Dictionary/204 facilities