Configuring Your Product › Install LIB/TSO › The $LIBTSO Macro

The $LIBTSO Macro

The $LIBTSO macro tailors LIB/TSO to your site's requirements. The $LIBTSO macro generates the LIBTSOGN load module. CALJJCL member LUTSOIN2 contains USERMOD MLJ4407 to let you alter the $LIBTSO macro parameters.

ATYPn=(type,lan,comment-start,comment-symbol)

This optional parameter adds to or changes any of the CA-supplied entries on the TSO type table. See the section titled LIB/TSO Type Table later in this chapter for complete information on the ATYPn parameters. See also the TYPE= parameter.

CHECK=[NO|YES|ALL]

Specifies whether additional TSO/SPF member checking is performed.

• NO—No checking is performed.
• YES—LIBGET and LIBDLM checks the TLICD to verify that the member is not outstanding to another user through LIBGET.
• ALL—Checking is performed by LIBGET, LIBDLM, and LIBEXP.

CONTROL=[RESERVE|ENQ]

Specifies that the integrity of the TLICD file directory is maintained by either the RESERVE or ENQ facility. (See the section on the TLICD.)

DESC=[YES|NO]

Specifies whether a member description is required when a new member is added to master file through the LIBADD command.

EXITxx=(exit-routine-name,exit-processing-symbols)

Specify an EXITxx keyword for each LIB/TSO command that you want exit processing performed for, where xx is:

• LA for LIBADD
• LC for LIBCTL
• LD for LIBDLM
• LG for LIBGET
• LI for LIBINDEX
• LL for LIBLIST
• LS for LIBSAVE
• LU for LIBUTI
• LX for LIBXP

The exit-routine-name identifies the program where control is passed during exit processing. You can specify only one program per command but can use the same program for more than one command. The exit-routine-name can be 1 to 8 alphanumeric characters long. The first character is alphabetic or a national character.

The exit-processing-symbols identify the type of exit processing to perform for the command. The symbols are:

• CB—Command buffer exit
• FA—File allocation exit
• OP—TSO output exit (LIBGET only)
• TE—Command termination exit

You must specify at least one exit-processing-symbol, and can specify two or more by separating them with commas. For example:

EXITA=(EXITPGM,CB)
EXITLG=(EXITPGM,CB,FA,OP)

Note: See the MASTX= parameter for information on the master file allocation exit.

If you do not specify any EXITxx parameter, exit processing is not performed.

See the Systems Services Guide for information on LIB/TSO exit processing.

HIST=[YES|NO]

Specifies whether a history record is required when updating an CA Librarian member through the LIBSAVE or LIBEXP commands.

INC=[NO|RESEQ|NORESEQ|ASIS]

Specifies -INC statement expansion

• NO—(Default) Does not expand the -INC statements in an CA Librarian member when the member is copied into a TSO data set through the LIBGET command. Instead, they are converted into comment records.
• RESEQ—Expands all -INC statements of an CA Librarian member and resequences the records from an included member according to the sequence numbering attributes of the main member.
• NORESEQ—Expands all -INC statements of an CA Librarian member, but the records of the included member are not resequenced. The data set can be out of sequence as a result of using NORESEQ.
• ASIS—Copies the member into the data set unchanged, without -INC statement expansion or comment statements.

See the Batch Command Reference Guide for further information on -INC statement processing and sample comment statements.

KANA=[YES|NO]

Specifies whether KATAKANA characters are accepted on the HIST and DESC of the LIBADD, LIBSAVE, and LIBEXP commands.

LIBMSG=[TEMP|PERM|TERM]

Specifies where the CA Librarian Update Report is placed during LIBADD, LIBSAVE, LIBDLM, LIBEXP, and LIBINDEX command processing.

• TEMP—(Default) Writes the report to a temporary data set and deletes it at the end of command processing.
• PERM—Writes the report to a permanent data set.
• TERM—Displays the report on the terminal. It is not written to any file.

LIBPARM=['parameter-string'|'NRJS,NJTA']

Specifies execution parameters to use for CA Librarian when it is executed in response to the LIBADD, LIBSAVE, LIBDLM, LIBEXP, or LIBINDEX commands. The parameter string can be no more than 50 characters long and must be enclosed in single quotation marks.

Note: An IEX or OEX parameter included in the parameter-string is ignored during execution if the master file being accessed already has an input exit name or an output exit name permanently assigned to it. In such cases, the permanently assigned exit name is used. If the master file does not have a permanently assigned input or output exit name, the exit name specified on this parameter is used. See the Systems Services Guide for z/OS and OS/390 for information on permanently assigning an input or output exit name to a master file.

LIBRPGM=[batch-program-name|AFOLIBR]

Specifies the nonreentrant program name of CA Librarian used on the PGM field on the Job Control Language EXEC statement. The program must either be link edited into a library in the system LINK list or in a library referenced by the STEPLIB DD statement in the LOGON procedure.

Note: The name specified here must be the same name specified for CA Librarian in Step 12 of the installation procedure.

LIST=[YES|NO]

Specifies whether a member listing is written to a data set when a new member is added to the master file through the LIBADD command or when an existing member is updated through the LIBSAVE and LIBUPD commands.

MASTER=[master-file-name|LIBR.MASTER]

Specifies the default CA Librarian master file used if one is not identified through the SOURCE or DSSOURCE option. The master file name must be a fully qualified data set name from 1 to 44 characters long.

MASTEXT=user-dair-exit-name

Identifies the master file allocation exit program. See the Systems Services Guide for z/OS and OS/390. The exit program name must be from 1 to 8 characters long. The user exit program must exist as a load module in a library in the system link list or in a library referenced by the STEPLIB DD in the LOGON procedure.

MASTHI=[high-order-mast-name|LIBR]

Specifies the high-order (leftmost) portion of master file name for the SOURCE option. The high-order portion can consist of one field or several fields separated by periods. Each field can consist of 1 to 8 alphanumeric characters with an initial non-numeric character. The entire high-order portion can be no more than 42 characters long including periods.

MAXMOD=[nn|5]

Specifies the maximum number of outstanding members per user allowed by the LIBGET command. An outstanding member is one that a LIBGET command retrieved but did not yet return to the master file through a LIBSAVE command. Members retrieved by a LIBGET with the READONLY option specified are not considered outstanding members. The LIB/TSO Control Directory (TLICD) keeps track of outstanding members. You can permit from 1 to 99 outstanding members per user; the number should be the same as in the TLICD.

PDSDIR=[nnnnn|25]

Specifies the number of directory blocks allocated to a new TSO partitioned data set created by the LIBGET command.

PDSPRI=[nnnnn|50]

Specifies the primary number of blocks allocated to a new partitioned data set created by the LIBGET command. The size of the block is specified by the TSOBLK parameter.

PDSSEC=[nnnnn|50]

Specifies the secondary number of blocks allocated to a new TSO partitioned data set created by the LIBGET command. The size of the block is specified by the TSOBLK parameter.

PGMR=[NO|ADD|ADDSAVE]

Specifies whether a programmer name must be specified on the LIBADD, LIBSAVE, and LIBEXP commands.

• NO—Programmer name is not required.
• ADD—(Default) Programmer name is required on the LIBADD command only.
• ADDSAVE—Programmer name is required on the LIBSADD, LIBSAVE, and LIBEXP commands.

PREFIX=[YES|NO]

This parameter determines the prefix to use as the leftmost field of:

• The TSO data set name generated by the LIBADD, LIBGET, LIBSAVE, and LIBEXP commands.
• The TSO data set name if it is specified without quote marks on the TSODSN parameter.
• Master file name if it is specified without quote marks on the DSSOURCE parameter.
• The MSGS, LIST, and INDEX file names generated by LIBADD, LIBDLM, LIBINDEX, LIBSAVE, and LIBEXP.

Under z/OS and OS/390, if PREFIX=YES is specified and a prefix is specified in the profile, the prefix is attached to the data set or master file name. If PREFIX=YES is specified and a prefix is not specified in the profile, the user ID is prefixed to the data set or master file name. If PREFIX=NO is specified, the user ID is used as the prefix. PREFIX=NO must be specified for SVS.

PRTBLK=[nnnnn|3990]

Specifies the block size of the listing (LIST) and message (PERMMSG, TEMPMSG, and LONGT) files used by the batch CA Librarian. The block size must be specified in multiples of 133 and must be less than the maximum track size of the device or 32718, whichever is less.

PSWD=[D|DG|DGSX|DGSXL|NO]

Specifies whether the member password is required when accessing a member through the LIBDLM, LIBGET, LIBSAVE, LIBEXP, and LIBLIST commands. The password is required when the following variables are specified:

• D—Required only on LIBDLM command.
• DG—Required on LIBDLM and LIBGET commands.
• DGSX—Required on LIBDLM, LIBGET, LIBSAVE, and LIBEXP commands.
• DGSXL—Required on LIBDLM, LIBGET, LIBSAVE, LIBEXP, and LIBLIST commands.
• NO—(Default) Specifies that the password is not required to access an CA Librarian member through LIB/TSO.

Note the following:

• If the master file was initialized with NOBYPP specified, this parameter is ignored and the password is required for all commands.
• CA Librarian passwords are not intended for use as a security mechanism as they appear in various batch CA Librarian listings and in many online displays. However, you can use them as a check to verify that a member name has been keyed correctly.

SPFQN=[major-qname|SPFDSN|SPFEDIT]

Specifies the 1- to 8-character major-qname used by the SPF or ISPF/PDF editor. The default name is SPFEDIT. The qname enforces data set integrity during LIB/ISPF-TSO command processing against SPF or ISPF/PDF editor and utility processing. Since the qname can vary from release to release of SPF and ISPF/PDF, you must be sure to obtain the correct qname. See the ISPF Installation and Customization Guide.

TLICD=[data-set-name|LIBR.TLICD]

Specifies the data-set-name of the CA Librarian ISPF-TSO Control Directory (TLICD). The specified data set name must be fully qualified and can be 1 to 44 characters long. The name specified here must be the same as the data set name specified on the FILEOUT DD statement on the LIBTLICD utility execution that creates TLICD. See the Systems Services Guide for more information on TLICD.

Note: If you are upgrading from LIB/TSO Release 3.0 or later, the name specified for TLICD must be the same as the currently existing TLICD.

TSOBLK=[nnnnn|3120]

Specifies the block size of a new TSO data set created by the LIBGET command. The data set can be sequential or partitioned. The block size must be specified in multiples of 80 and must be less than the maximum track size of the device or 32720, whichever is less.

TYPE=[type|COBOL]

Specifies the default mode or TSO data set language type if not specified on the LIBADD, LIBGET, and LIBEXP commands.

The type specified here should be the one most commonly used at the site. CA provides 16 assigned types plus 10 unassigned types. You can override the 16 CA-supplied types and reassign all 26 entries.

The following lists the valid types and their meanings.

• ASM—Assembly statements
• BASIC—BASIC statements
• CLIST—TSO commands
• CNTL—JCL and SYSIN for SUBMIT command
• COBOL—ANS COBOL statements
• DATA—Uppercase data
• FORT—FORTRAN statements
• FORTGI—FORTRAN GI statements
• FORTH—FORTRAN H statements
• GIS—Generalized Information System (GIS) routines
• GOFORT—FORTRAN code and Go statements
• PLI—PL/I checkout or PL/I optimizing compiler statements
• PLIF—PL/I(F) Compiler statements
• RPG—Report program generator statements
• TEXT—Upper and lower case text
• VSBASIC—VSBASIC statements

UPDBLK=[nnnn|4080]

Specifies the block size of the update file used by the batch CA Librarian for the LIBADD, LIBSAVE, LIBEXP, LIBDLM, and LIBINDEX commands. The block size must be specified in multiples of 80 and must be less than the maximum device track size or 32720, whichever is less.