Installing the CMS Pipelines Runtime Library Distribution

The CMS Pipelines executables consist of two MODULE files, the main module and a bootstrap module. The name of the bootstrap module is the command name (usually PIPE). The bootstrap module in this distribution is named PIPE MODULE, so it is invoked the first time a PIPE command is issued. The bootstrap module NUCXLOADs the main module, so that subsequent invocations of the command go directly to the main module, whatever its name. In this distribution, the main module is named PIPELINE MODULE (and that is the name that PIPE MODULE NUCXLOADs). In VM/ESA, the main module is named DMSPIPE. In the CMS Pipelines field-test program, the main module is named NXPIPE.

Note that CMS has its own PIPE MODULE on the S disk to activate DMSPIPE. Be sure to have the one you want first in the search order. There is no bootstrap for NXPIPE; you must activate it explicitly.

When packaging this version of the CMS Pipelines runtime library with a product, you can use any module names and any command name you wish. For information about running multiple versions of CMS Pipelines under different names, see Appendix D in pipeline.pdf. (A plain text version of Appendix D is also available.) Also see PIPINIT EXEC and Steve Hayes' PICKPIPE command.

Installing the Executables

For this discussion, we will assume that the command name is to remain "PIPE". We do not recomment installing the runtime library over the CMS version because many components of CMS use CMS Pipelines under the bonnet.

If you use DIRMAINT, be sure to review the DIRMAINT considerations before replacing the VM/ESA version of CMS Pipelines with the runtime library version, as the response to "pipe query level" will change and the behavior of the "crc" stage may also change.

Thus, you will be running the VM/ESA and Runtime Versions of CMS Pipelines in Parallel. You would be well advised to install Steve Hayes' PICKPIPE facility, which will allow your users to switch readily between the two versions.

To avoid introducing incompatible behavior if your users are accustomed to using the VM/ESA version of Pipelines, you can force the runtime library version of Pipelines to assume the "style" of the VM/ESA version of Pipelines by issuing the following command in the CMS system profile (SYSPROF EXEC): 


'PIPE literal REPOSITORY - | literal STYLE DMS | configure | console'
This command sets the style to "DMS" (the VM/ESA style), with one override that specifies that no external message repository is to be used. (In such a case, the English-language message texts built into the runtime module are used. If you require messages in other languages, see the discussion of NLS considerations.)

Note: even if you set the style to "DMS", there will be some incompatabilities, the most notable being that Pipelines message numbers, message texts, and return codes will be different from those issued by CMS Releases 9-13.

If you use PICKPIPE, you will not need the PIPE MODULE from the runtime distribution. You will need to put PIPELINE MODULE on a suitable disk and decide whether to replace the PIPELINE HELPLIB on the HELP disk with the one from the runtime distribution. You can use VMSES/E to build a PIPES+ segment for the runtime distribution. PICKPIPE will then load the PIPES+ segment, rather than the PIPES segment, when invoked with the "uplevel" option.

If your system has multiple versions of CMS Pipelines available and your SYSPROF EXEC issues a PIPE command, you may wish to give users a choice of which version of Pipes is invoked for them during CMS initialization.

*UPDATED* Generating the HELP Files

The CMS Pipelines online documentation consists of the file PIPELINE HELPLIB, which is read when a "pipe help" or "pipe ahelp" command is issued. One can optionally generate individual HELP files that will be accessed by the CMS HELP command.

The HELP files are built from the HELPLIB, using these steps:

  1. If you have not already done so, download PIPELINE HELPLIB and reblock it to fixed-length, 80-byte records.

  2. Download HLIB2HIN REXX and run the following pipeline to build PIPELINE HELPIN: 
    
'PIPE hlib2hin | > pipeline helpin a fixed'
  3. Build the HELPPIPx, HELPMSG, HELPABBR, and HELPMENU files using PIPGHELP EXEC *UPDATED*, which requires PIPGHELP REXX *UPDATED* and PIPMENU REXX. The command is "pipghelp" to produce help files that use box characters or "pipghelp % notext" to produce help files in which the box characters are replaced with more generally available characters.

  4. Erase PIPELINE HELPIN, which is an intermediate file not needed after the HELP files are built. (PIPELINE HELPLIB, on the other hand, should be stored where it can be accessed by the "pipe help" command.)

Preparing the Runtime Distribution for use with SQL/DS

The SQL access module must be generated before you can access SQL/DS tables with the runtime library version of CMS Pipelines. PIPSQI ASMSQL is the input to the preparation process, which is described in Note 4 of the author's documentation for the "sql" pipeline stage (issue the command "pipe ahelp sql" or refer to PIPELINE BOOK or pipeline.pdf).

Melinda Varian / Office of Computing and Information Technology / Princeton University / melinda.varian@me.com
September 19, 1997

Revised 2010-03-01 jph.