Previous Topic: Resettable System KeywordsNext Topic: System Keywords Availability


Non-Resettable System Keywords

The system keywords described below cannot be assigned a value by Keyword Assignment Statements. These non-resettable system keywords provide values for your use in generating model output records. Note that not all of the keywords are available for every phase nor in every modeling facility. Any non-resettable system keyword that is unavailable has a value of blanks. See the table under System Keywords Availability later in this chapter.

Values for the non-resettable system keywords are taken from CA‑PanAPT Inventory, Library Code, and Move Request data, or are provided by the modeling facility.

Keywords beginning with $ALT provide data from an alternate Library Code. The Library Code that these keywords reflect is specified using the $ALTLIBCFORM keyword. Until you set this keyword, all of the $ALT keywords have null values.

Keywords beginning with $ASSIGNED or with $DIBS provide data from the Inventory Record for the member being modeled. If inventory is not active for a Library Code, then these keywords have a value of blanks when members of the Library Code are being modeled. When inventory is active, some inventory keywords might still have a value of blanks. You can use the value of the $ASSIGNED keyword to determine whether inventory keywords contain useful values for a member.

Keywords beginning with $DEST are given by the modeling facility and provide single keywords that apply to the primary and secondary targets of a move. These keywords can be used without the conditional logic that might otherwise be necessary. The primary target is the final destination for members of a move. The keywords with names that begin with $DEST1 identify the primary target. Keywords that start with $DEST2 identify the secondary target. A secondary target is the backup for the primary target when applicable (for example, Backup or Back Out libraries). During Verification Modeling, the $DEST keywords contain the tentative values that they will have during the next move.

Keywords with names that begin with $LVL contain information that varies by level. The level that the current contents of these keywords reflects is controlled by the $LEVEL keyword. Until you set this keyword, all of the $LVL keywords have null values.

Furthermore, keywords beginning with $LVLALTLIBC contain information that varies by level for the alternate Library Code. These keywords have null values until you set both the $ALTLIBCFORM and the $LEVEL keywords.

Keywords with names that begin with $CFG contain CA‑Pan/LCM Configuration Manager data from the Control file. If you did not add Configuration Manager information to your Control file, these keywords have null values.

Keywords with names that begin with $ORIG refer to the source or sending library for a move, or to the library where members are currently stored when no movement is implied (for example, On-Demand modeling). During Verification Modeling, the $ORIG keywords contain the tentative values they will have during the next move.

$ALT

Keywords beginning with $ALT provide data from an alternate Library Code. The Library Code that these keywords reflect is specified using the $ALTLIBCFORM keyword. Until you set this keyword, all of the $ALT keywords have null values.

$ALTLIBC

The four-character Library Code.

$ALTLIBCDESC

The 1 to 55-character Description field value from the Library Code.

$ALTLIBCODE

The 1 to 7-character Library Code and Subcode combined with all blanks and slashes removed (xxxxyyy).

$ALTLIBSUBC

The three-character Library Subcode.

$ALTMODELBASE

The 1 to 4-character Model Base.

$ALTRELCOMPINC

Zero to 4 sets of formatted Library Codes and Subcodes used for the CA‑Panvalet ++INCLUDE or CA‑Librarian ‑INC members for compiles. CA‑PanAPT formats each set with a slash (xxxx/yyy). The first set occupies positions 1 through 8 of this keyword, the second occupies positions 10 through 17, the third occupies positions 19 through 26, and the fourth occupies positions 28 through 35. One or more spaces is padded to the end of each set to ensure the next set starts at the correct position. For example:

1 10 19 28
| | | |
xxxx/yyy xxxx xx/yy xxxx/yyy

$ALTRELCOMPSYSLIB

Zero to 4 sets of formatted Library Codes and Subcodes used for the compile syslibs (for expanding COPY/INCLUDE statements and macros). See $ALTRELCOMPINC for an explanation of how this is formatted.

$ALTRELLKEDINC

Zero to 4 sets of formatted Library Codes and Subcodes used for the CA‑Panvalet ++INCLUDE or CA‑Librarian ‑INC members for Link Edits. See $ALTRELCOMPINC for an explanation of how this is formatted.

$ALTRELLKEDSYSLIB

Zero to 4 sets of formatted Library Codes and Subcodes used for the Link Edit syslibs (for including object and load modules). See $ALTRELCOMPINC for an explanation of how this is formatted.

$ALTRELLKEDSYSLIN

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for Link Edit control statement members.

$ALTRELOUTEXEC

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for holding executable output, typically load modules.

$ALTRELOUTLISTING

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for holding output listings.

$ALTRELOUTOBJECT

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for holding object members produced from compiles.

$ALTRELOUTOTHER

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for holding other types of output, such as DB2 DBRMs.

$ALTRELOUTSOURCE

An optional Library Code and Subcode formatted with a slash (xxxx/yyy) used for holding generated source output, such as what is produced when a CICS BMS map is compiled or what is produced from a DB2 DCLGEN.

$ALTRELPRECOMPSYSLIB

Zero to 4 sets of formatted Library Codes and Subcodes used for the pre‑compile syslibs. For instance, this would be used for expanding DB2 SQL FETCH statements. See $ALTRELCOMPINC for an explanation of how this is formatted.

$ASSIGNED

A one-character value that indicates if the current member's Inventory Record is assigned Y, unassigned N, or not available (blank). When the value is blank, then there is no Inventory Record for the member and the other inventory keywords are also blank.

$ASSIGNEDMR

The six-digit number of the Move Request to which the Inventory Record is assigned. The value can be different from the value of $MR.

$ASSIGNEDTO

The 1 to 8-character user ID of the CA‑PanAPT to whom this Inventory Record is assigned. The value is blank when the Inventory Record is not assigned or is unavailable.

$CFG

Keywords with names that begin with $CFG contain CA‑Pan/LCM Configuration Manager data from the Control file. If you did not add Configuration Manager information to your Control file, these keywords have null values.

$CFGAMKLISTARGS

The 0 to 50-character AMKLIST argument string.

$CFGDEPMBR

The 1 to 8-character member name for the Dependency file member.

$CFGOPTMBR

The 1 to 8-character member name for the Global Options member, or null if there is no Global Options member.

$CFGPROFDSN

The 1 to 44-character name of the CA‑Pan/LCM PROFILE data set.

$CFGPROJDSN

The 1 to 44-character name of the CA‑Pan/LCM Project data set.

$CFGSUPPERRS

A one-character value indicating whether AMKLIST errors are to be suppressed while running Verification Procedures. The values can be Y, indicating errors are to be suppressed, or N.

$CFGWARNLVL

The one‑character warning level value to be provided to AMKLIST while running Verification Procedures. The value can be 0, 1, 2, or 3.

$CHKREP

The one-character REPLACE value for the member as specified on the Retrieve Options panel (APIP710). The value indicates that a member with the same name on the destination library is to be replaced Y or is not to be replaced N.

$DBDSN

The 1 to 44-character data set name of the CA‑PanAPT database. This is the name associated with the APTDB DD in effect while Modeling is running.

$DB2TYPE

The 0 to 8-character DB2 Entity type for the Library Code. If you do not have the CA‑PanAPT DB2 option, this keyword is null. The value of this keyword is derived from the Library Code type as follows:

Library Code Type DB2 Type

DB2SRC SOURCE
DB2SDB SRCEDBRM
DB2DBRM DBRM
DB2PACK PACKAGE
DB2PLAN PLAN
all others null

$DESTn

Keyword names beginning with $DEST1 provide a single keyword that applies to the target of the move and can be used without conditional logic. Keyword names beginning with $DEST2 apply to a secondary target (for example, the Backup or Back Out Library).

$DEST1AM

The 1 to 2-character Access Method code for the primary destination data set.

$DEST1DDN

The 1 to 8-character ddname for the primary destination data set.

$DEST1DSN

The 1 to 44-character dsname for the primary destination data set.

$DEST1SEC

The 1 to 10-character security data for the primary destination data set.

$DEST1SHORTNAME

The 1 to 4-character short name associated with the destination level.

For Moves and Back outs, the $DEST1 fields pertain to the move level. For a Production Move/Back out, the Production level is the one these fields pertain to.

For Retrieve modeling, the $DEST1 fields pertain to the starting Test level.

When no members are being moved, as with On‑demand and Verification modeling, these keywords all have values of blanks.

$DEST2AM

The 1 to 2-character Access Method code for the secondary destination data set.

$DEST2DDN

The 1 to 8-character ddname for the secondary destination data set.

$DEST2DSN

The 1 to 44-character dsname for the secondary destination data set.

$DEST2SEC

The 1 to 10-character security data for the secondary destination data set.

For Moves, the $DEST2 fields pertain to the Back up data set for the move level.

For Back Outs, the $DEST2 fields pertain to the Back Out data set for the move level.

When no members are being moved, as with On‑demand and Verification modeling, or when no secondary destination is applicable, as with Retrieve modeling or moves without Back Up data sets, these keywords are all set to null values.

$DIBSAPPL

The 1 to 8-character Application field value from the Inventory Record.

$DIBSAPPROVED

A one-character value indicating whether the Inventory Record is approved Y, not approved N, or unavailable (blank).

$DIBSCICSOPT

The 1 to 60-character CICS precompiler option field from the Inventory Record.

$DIBSCOM

The 1 to 55-character Comment field value from the Inventory Record.

$DIBSCOMPOPT

The 1 to 60-character Compiler Options field value from the Inventory Record.

$DIBSDBOPT

The 1 to 60-character Data Base precompiler option field from the Inventory Record.

$DIBSDESC

The 1 to 55-character Description field value from the Inventory Record.

$DIBSENV

The 1 to 8-character Environment field value from the Inventory Record.

$DIBSLANG

The 1 to 8-character Language field value from the Inventory Record.

$DIBSLINKOPT

The 1 to 60-character Link Edit field value from the Inventory Record.

$DIBSLINKSTR

The 1 to 10-character Link Edit Stream member name from the Inventory Record.

$DIBSOWNER

The 1 to 8-character user ID of the Permanent owner of the Inventory Record.

$DIBSQUAL

The 1 to 8-character Inventory Qualifier of the Inventory Record.

$DIBSSAVEOBJECT

The one-character value from the Inventory Record that indicates whether to save an object module. The value can be one of the following:

blank Default to the Library Code setting.
Y Save object.
N Do not save object.

Also see keyword $SAVEOBJECT, which has a definitive Y/N value.

$DIBSSAVELIST

The one-character value from the Inventory Record that indicates whether to save a listing. The value can be one of the following:

blank Default to the Library Code setting.
Y Save listing.
N Do not save listing.

Also see keyword $SAVELIST, which has a definitive Y/N value.

$DIBSSAVELOAD

The one-character value from the Inventory Record that indicates whether to create a load module. The value can be one of the following:

blank Default to the Library Code setting.
Y Create load module.
N Do not create load module.

Also see keyword $SAVELOAD, which has a definitive Y/N value.

$DIBSUSER01-through-$DIBSUSER20

The user data field values from the Inventory Record. $DIBSUSER01 through $DIBSUSER05 are 1 to 8-character values. $DIBSUSER06 through $DIBSUSER10 are 1 to 16-character values, and $DIBSUSER11 through $DIBSUSER20 are 1 to 50-character values.

$ESSHORTNAME

If there is an Early Stop level specified for a Move Request, this keyword contains the 1 to 4-character short name of that level. Otherwise, this field is null.

$FIRSTLVL

The 1 to 4-character short name for the first level defined to your CA‑PanAPT system, commonly referred to as the Test level.

$FIRSTRUNDATE

The First Run date for the Move Request in the format YYYYMMDD.

$FROMDATA

The 1 to 8-character From User-data field for the member on the $ORIGDSN library.

For moves from the starting Test level, the value is the From Starting Level User‑data field specified on the Member Moves panel (APIP140). For moves from subsequent levels, and for Back Outs, the value is the To Destination Lvls User‑data field.

For Retrieve, the value is the From User-data field on the Retrieve Processing Options panel (APIP710).

$FROMNAME

The 1 to 10-character name for the member on the $ORIGDSN library.

For moves from the starting Test level, the value is the From Starting Level Member field specified on the Member Moves panel (APIP140). For moves from subsequent levels, and for Back Outs, the value is the To Destination Lvls Member field.

For Retrieve, the value is the From Member name on the Retrieve Processing Options panel (APIP710).

$LASTLVL

The 1 to 4-character short name of the last move level defined to your CA‑PanAPT system. Typically this is your PROD level, but it doesn't have to be.

$LEVELS

A three-digit number that describes the number of levels defined to your CA‑PanAPT system. For example, in a system with Test, Quality Assurance, and Production defined, the value is 003.

$LIBC

The four-character Library Code.

$LIBCDESC

The 1 to 55-character Description field value from the Library Code.

$LIBCFORM

The seven-character Library Code and Subcode formatted with a slash (xxxx/yyy).

$LIBCODE

The 1 to 7-character Library Code and Subcode concatenated with all blanks and slashes removed (xxxxyyy).

$LIBSUBC

The three-character Library Subcode.

$LIBCODETYPE

The 0 to 8-character Type field from the Library Code.

$LIBCODEMEMBERCOUNT

A seven-digit count of the number of members processed because the INIT phase in the range 0000000 through 9999999. The value is set to 0000000 in the INIT phase and incremented by one for each member processed.

$LVL

Keywords with names that begin with $LVL contain information that varies by level. The level that the current contents of these keywords reflects is controlled by the $LEVEL keyword. Until you set this keyword, all of the $LVL keywords have null values. If you specify a non‑existent level name for the $LEVEL keyword, all $LVL keywords have a null value, and the $LEVEL keyword is reset to a null value.

Keywords with names that begin with $LVLLIBC contain information defined to the current Library Code for the specified level. If the level controlled by the $LEVEL keyword is not defined to the Library Code, all of the $LVLLIBC keywords contain null values.

Keywords with names that begin with $LVLALTLIBC contain information defined to the alternate Library Code for the specified level. Like the $LVLLIBC keywords, if the level controlled by the $LEVEL keyword is not defined to the alternate Library Code, all of the $LVLALTLIBC keywords contain null values.

$LVLABBREVNAME

The 1 to 2-character abbreviated name of the level.

$LVLALTLIBCACTIVE

A one‑character value that contains the letter A if the level is active for the alternate Library Code or that contains the letter I if the level is inactive.

$LVLALTLIBCBKOTAM

The 0 to 2-character Access Method code for the alternate Library Code's Back Out data set for the level.

$LVLALTLIBCBKOTDDN

The 1 to 8-character ddname of the alternate Library Code's Back Out data set for the level. If the level does not use Back Out, this keyword is null.

$LVLALTLIBCBKOTDSN

The 1 to 44-character data set name of the alternate Library Code's Back Out data set for the level. If the level does not use Back Out, this keyword is null.

$LVLALTLIBCBKOTSEC

The 0 to 10-character security data for the alternate Library Code's Back Out data set for the level.

$LVLALTLIBCBKUPAM

The 0 to 2-character Access Method code for the alternate Library Code's Back Up data set for the level.

$LVLALTLIBCBKUPDDN

The 1 to 8-character ddname of the alternate Library Code's Back Up data set for the level. If the level does not use Back Up, this keyword is null.

$LVLALTLIBCBKUPDSN

The 1 to 44-character data set name of the alternate Library Code's Back Up data set for the level. If the level does not use Back Up, this keyword is null.

$LVLALTLIBCBKUPSEC

The 0 to 10-character security data for the alternate Library Code's Back Up data set for the level.

$LVLALTLIBCDESTAM

The 0 to 2-character Access Method code for the alternate Library Code for the level.

$LVLALTLIBCDESTDDN

The 1 to 8-character ddname of the alternate Library Code for the level.

$LVLALTLIBCDESTDSN

The 1 to 44-character data set name of the alternate Library Code for the level.

$LVLALTLIBCDESTSEC

The 0 to 10-character security data for the alternate Library Code for the level.

$LVLALTLIBCMOVECTL

The one-character Move Control value for the alternate Library Code for the level. See $LVLLIBCMOVECONTROL for a description of the values.

$LVLALTLIBCNEXT

The 1 to 4-character short name of the next highest level defined to the alternate Library Code or null if the current level is the last level for the Library Code.

$LVLALTLIBCNUMA

A three‑digit number that describes the number of levels in the alternate Library Code that follow the current level.

$LVLALTLIBCNUMB

A three‑digit number that describes the number of levels in the alternate Library Code that precede the current level.

$LVLALTLIBCOPTBKOT

A one‑character value that contains the Backout Enabled value for the alternate Library Code for the level. When the level is the starting Test level, this keyword is null.

$LVLALTLIBCOPTBKUP

A one‑character value that contains the Backup Enabled value for the alternate Library Code for the level. When the level is the starting Test level, this keyword is null.

$LVLALTLIBCPREV

The 1 to 4-character short name of the next lowest level defined to the alternate Library Code or null if the current level is the starting test level.

$LVLLIBCACTIVE

A one‑character value that contains A if the level is active for the Library Code, or contains I if the level is inactive for the Library Code, and doesn't pertain to any moves.

$LVLLIBCBKOTAM

The 0 to 2-character Access Method code for the Library Code Back Out data set for the level.

$LVLLIBCBKOTDDN

The 1 to 8-character ddname of the Library Code Back Out data set for the level. If the level does not use Back Out, this keyword is null.

$LVLLIBCBKOTDSN

The 1 to 44-character data set name of the Library Code Back Out data set for the level. If the level does not use Back Out, this keyword is null.

$LVLLIBCBKOTSEC

The 0 to 10-character security data for the Library Code Back Out data set for the level.

$LVLLIBCBKUPAM

The 0 to 2-character Access Method code for the Library Code Back Up data set for the level.

$LVLLIBCBKUPDDN

The 1 to 8-character ddname of the Library Code Back Up data set for the level. If the level does not use Back Up, this keyword is null.

$LVLLIBCBKUPDSN

The 1 to 44-character data set name of the Library Code Back Up data set for the level. If the level does not use Back Up, this keyword is null.

$LVLLIBCBKUPSEC

The 0 to 10-character security data for the Library Code Back Up data set for the level.

$LVLLIBCDESTAM

The 0 to 2-character Access Method code for the primary Library Code data set for the level.

$LVLLIBCDESTDDN

The 1 to 8-character ddname of the primary Library Code data set for the level.

$LVLLIBCDESTDSN

The 1 to 44-character data set name of the primary Library Code data set for the level.

$LVLLIBCDESTSEC

The 0 to 10-character security data for the primary Library Code data set for the level.

$LVLLIBCMOVECONTROL

The one-character Move Control value for the Library Code for the level. The value can be one of the following:

blank

The level is the starting test level, where movement does not apply.

C

Members are copied into this level. They are not deleted from the origin level.

M

Members are moved into this level. They are deleted from the origin level after they are copied.

D

Members are deleted from the origin level without being copied to this level.

I

The level is inactive, and doesn't participate in moves.

$LVLLIBCNEXT

The 1 to 4-character short name of the next highest level defined to the Library Code. If the current level is the last level for the Library Code, this keyword is null.

$LVLLIBCNUMA

A three-digit number that describes the number of levels in this Library Code that follow the current level. For example, in a system with Test, Quality Assurance, and Production defined, with the current level being Test, the value is 002. When the current level is the last level, the value is 000.

$LVLLIBCNUMB

A three-digit number that describes the number of levels in this Library Code that precede the current level. For example, in a system with Test, Quality Assurance, and Production defined, with the current level being Quality Assurance, the value is 001. When the current level is the starting Test level, the value is 000.

$LVLLIBCOPTBKOT

A one‑character value that contains the Backout Control value for this Library Code for the level. When the level is the starting Test level, this keyword is null.

$LVLLIBCOPTBKUP

A one‑character value that contains the Backup Enabled value for this Library Code for the level. When the level is the starting Test level, this keyword is null.

$LVLLIBCPREV

The 1 to 4-character short name of the next lowest level defined to the Library Code. If the current level is the starting Test level, this keyword is null.

$LVLLONGNAME

The 1 to 20-character long name of the level.

$LVLNEXT

The 1 to 4-character short name of the next highest level defined to the CA‑PanAPT system. If the current level is the last level, this keyword is null.

$LVLNUMA

A three-digit number that describes the number of levels in this CA‑PanAPT system that follow the current level. For example, in a system with Test, Quality Assurance, and Production defined, with the current level being Test, the value is 002. When the current level is the last level, the value is 000.

$LVLNUMB

A three-digit number that describes the number of levels in this CA‑PanAPT system that precede the current level. For example, in a system with Test, Quality Assurance, and Production defined, with the current level being Quality Assurance, the value is 001. When the current level is the starting Test level, the value is 000.

$LVLPREV

The 1 to 4-character short name of the next lowest level defined to the CA‑PanAPT system. If the current level is the starting Test level, this keyword is null.

$LVLSHORTNAME

The 1 to 4-character short name of the level. This keyword's value is always the same as the $LEVEL keyword value.

$MDLODSN

The 1 to 44-character data set name of the APTMDLO modeling output PDS.

$MEMBERCOUNT

A seven-digit count of the number of members processed in the range 0000000 through 9999999. The value is incremented by one for each member processed.

$MEMBEREXIST

A one-character value that indicates whether the member has passed Y or failed N the Member Existence Exit check. A value of blank indicates that a Member Existence Exit is not specified in the Library Code for the current move, so no exit was invoked to perform the check.

$MMPCPFX

The MMPCPFX node value of data sets created during the Move Processing Cycle. The value is taken from PARM specifications for the Move and On-demand Modeling Facilities. A value of blanks indicates that it was not specified. When properly specified, the value is a 1 to 8-character standard IBM data set qualifier node.

$MODELBASE

The 1 to 4-character Model Base for the Library Code.

$MODELTIME

A one‑character code that indicates what modeling facility is being used, as follows:

M

Move Modeling for normal movement

B

Move Modeling for Back Out movement

C

Retrieve Modeling

V

Verification Procedure Modeling

O

On‑Demand Modeling

$MODEL01-through-$MODEL12

The 1 to 75-character Model Specification Statements (up to 12 lines) currently being processed.

$MOVEDATE

The next scheduled move date for the Move Request in the format YYYYMMDD. For moves to a level before the final level, this comes from the next scheduled move date, which can be blank. For the final level, this contains the final move date.

$MOVETYPE

The one-character Move Type field value from the Move Request. The Move Type can be used to control the Move Processing Cycle. Use of Move Processing Cycles is dependent upon your site's requirements.

$MR

The six-digit Move Request number of the Move Request being processed, or of the Move Request the member being modeled is assigned.

When this keyword has a value of blanks, then the other Move Request related keywords, such as $MOVEDATE, $MOVETYPE, $MRDESC, and $SR also hold blanks.

$MRCFGINOPTMBR

The 1 to 8-character member name of the CA‑Pan/LCM Configuration Manager Option member for specifying additional impacting members for the Impact Analysis Member Selection List (MSL) and Verification Procedure. If this name was not specified when obtaining an Impact Analysis MSL or if you did not obtain an Impact Analysis MSL for this Move Request then this keyword is null.

$MRCFGOUTOPTMBR

The 1 to 8-character member name of the CA‑Pan/LCM Configuration Manager Option member for restricting the impacted members for the Impact Analysis Member Selection List (MSL) and Verification Procedure. If this name was not specified when obtaining an Impact Analysis MSL or if you did not obtain an Impact Analysis MSL for this Move Request, this keyword is null.

$MRDESC

The 1 to 55-character Description field value from the Move Request identified by $MR.

$MREXDESC1-through-$MREXDESC12

The 1 to 70-character Expanded Description field values from the Move Request identified by $MR (up to 12 lines).

$OPT

Keyword names that begin with $OPT provide data from the Library Code definition. Some $OPT keywords provide data derived from the Library Code definition and the move time. These keywords let you simplify models because CA‑PanAPT modeling has already done the tests associated with move time. The other $OPT keywords provide data directly from the Library Code definition.

$OPTD1TOD2

A one-character value indicating whether primary to secondary destination moves are supported, Y, or are not supported, N, for this move.

For normal moves in which the Library Code has Backup enabled, this keyword has a value of Y, because the Backup Library is the secondary destination (the $DEST2 data set).

For Back Out moves in which the Library Code has Backout Control specified as B (Backout and restore), this keyword also has a value of Y, because the Backout Library is the secondary destination.

In all other cases, this keyword has a value of N.

$OPTORIGDEL

A one-character value indicating whether to delete, Y, or not to delete, N, the member in the $ORIGDSN data set after this move is complete.

$OPTORIGTOD1

A one-character value that indicates whether a primary move is to be performed, Y, or is not to be performed, N.

For normal moves, this keyword has a value of Y when the Library Code's Move Control has a value of C (Copy) or M (Move), and a value of N when the Move Control value is D (Delete).

For Back Out moves in which the Library Code has Backout Control specified as B (Backout and restore) or R (Restore without backout), this keyword has a value of Y. When Backout Control is P (Prohibited) or blank, this keyword has a value of N.

Note that it is possible for $OPTORIGDEL to have a value of Y while this keyword is set to a value of N.

$ORIG

Keyword names that begin with $ORIG refer to the source or sending library for a move, or to the Library where members are currently stored when no movement is implied (for example, On-Demand modeling).

For normal moves, the $ORIG keywords pertain to the primary data set for the level the members are being moved from.

For Backout moves, the values pertain to the Back up data set for the current move level.

For Retrieve, the values depend upon which level you are retrieving from and whether it is from the primary data set or the Back up or Back out data set.

When no members are being moved, as with On‑demand and Verification modeling, the values correspond to what they would be if the members were being moved at that time, based upon the current status of the Move Request. If the Move Request is in a Move Complete, Back Out Complete, or Deleted status, the keyword values are null.

$ORIGAM

The 1 to 2-character Access Method code for the origin data set.

$ORIGDDN

The 1 to 8-character ddname for the origin data set.

$ORIGDSN

The 1 to 44-character dsname for the origin data set.

$ORIGSEC

The 1 to 10-character security data for the origin data set.

$ORIGSHORTNAME

The 1 to 4-character short name of the origin move level.

$OTHRPFX

The 1 to 8-character OTHRPFX data set name prefix specified during the execution of the APJP5320 proc. This allows your models to construct the same OTHER data set names that APJP5320 used.

$OWNER

The 1 to 8-character user ID of the Owner field value from the Move Request identified by $MR.

$PHASE

A four-character code indicating which Model Processing Phase is currently active. This keyword is always available with a value of START, INIT, MOVE, TERM, or END. See Model Processing earlier in this chapter.

$REL

Keyword names that begin with $REL contain the names of Library Codes that are related to the current Library Code. They fall into two formats. One is where a single Library Code name is specified, and the other is where a list of Library Code names is specified. Each library code, whether its the value for a single Library Code or one of the Library Codes in a list, is formatted such that the $ALTLIBCFORM keyword can be set to it. In the listed values, each Library Code except the last is padded with spaces on the end so its total length is nine characters, making it easy to pick the next Library Code out of the list.

$RELCOMPINC

A list of up to four sets of formatted Library Codes used for the CA‑Panvalet ++INCLUDE or CA‑Librarian ‑INC members used for compiles.

$RELCOMPSYSLIB

A list of up to four sets of formatted Library Codes used for the compile syslibs (for expanding COPY/INCLUDE statements and macros.

$RELLKEDINC

A list of up to four sets of formatted Library Codes used for the CA‑Panvalet ++INCLUDE or CA‑Librarian ‑INC members used for Link Edits.

$RELLKEDSYSLIB

A list of up to four sets of formatted Library Codes used for the Link Edit syslibs (for including object and load modules).

$RELLKEDSYSLIN

An optional formatted Library Code used for Link Edit control statement members.

$RELOUTEXEC

An optional formatted Library Code used for holding executable output, typically load modules.

$RELOUTLISTING

An optional formatted Library Code used for holding output listings.

$RELOUTOBJECT

An optional formatted Library Code used for holding object members produced from compiles.

$RELOUTOTHER

An optional formatted Library Code used for holding other types of output, such as DB2 DBRMs.

$RELOUTSOURCE

An optional formatted Library Code used for holding generated source output, such as what is produced when a CICS BMS map is compiled or what is produced from a DB2 DCLGEN.

$RELPRECOMPSYSLIB

A list of up to four sets of formatted Library Codes used for the pre‑compile syslibs. For instance, this would be used for expanding DB2 SQL FETCH statements.

$SAVEOBJECT

A one‑character value that indicates whether to save the object from a compile. This has a value of Y or N. If the member has inventory, and its inventory states to save the object or not, then the value of this field is determined from the inventory. Otherwise, the value is Y if the Library Code has a related object module Library Code, or it is N if there is no related object module Library Code.

$SAVELIST

A one‑character value that indicates whether to save listings. This has a value of Y or N. If the member has inventory, and its inventory states to save listings or not, then the value of this field is determined from the inventory. Otherwise, the value is Y if the Library Code has a related listing Library Code, or it is N if there is no related listing Library Code.

$SAVELOAD

A one‑character value that indicates whether to create load modules. This has a value of Y or N. If the member has inventory, and its inventory states to create load modules or not, then the value of this field is determined from the inventory. Otherwise, the value is Y if the Library Code has a related load module Library Code, or it is N if there is no related load module Library Code.

$SR

The 1 to 16-character Service Request field value from the Move Request identified by $MR.

$TESTDATA

The 1 to 8-character From Starting Level User‑data field for the member as specified on the Member Moves panel (APIP140). The starting level is commonly referred to as the TEST level.

$TESTNAME

The 1 to 10-character From Starting Level Member name field for the member as specified on the Member Moves panel (APIP140). The starting level is commonly referred to as the TEST level.

$TODATA

The 1 to 8-character To Data-user field value for the member.

For Retrieve, the value is the To Data-user field on the Retrieve Processing Options panel (APIP710). Otherwise, the value is the To Destination Lvls User-data field specified on the Member Moves panel (APIP140).

$TODAY

Today's system date in the format YYYYMMDD.

$TONAME

The 1 to 10-character To Destination Lvls Member or To Member name field value for the member.

For Retrieve, the value is the To Member name on the Retrieve Processing Options panel (APIP710). Otherwise, the value is the To Destination Lvls Member name specified on the Member Moves panel (APIP140).

$USERID

The 1 to 8-character user ID user performing the modeling. Online modeling facilities, such as Retrieve and Verification, set this keyword to the value of the TSO userid performing the Retrieve or Verification.

$UT

Keyword names that begin with $UT are used during Compare and Merge utility model processing.

During Compare processing, the $UTLIST keywords describe the output location for the report, the $UT1 keywords describe the NEW member, and the $UT2 keywords describe the OLD member.

During Merge processing, the $UTLIST keywords describe the output location for the report. The $UT1 and $UT2 keywords describe the members being merged. The $UT3 keywords describe the parent member for the merge. The $UTWORK1, $UTWORK3, and $UTWORK3 keywords describe work data sets to stage the $UT1, $UT2, and $UT3 members to when CA‑Pan/Merge cannot read them directly. The $UTOUT keywords describe where to create the merged result.

$UTLISTDSN
$UTOUTDSN
$UTWORK1DSN
$UTWORK2DSN
$UTWORK3DSN
$UT1DSN
$UT2DSN
$UT3DSN

The 1 to 44-character dsname for the utility data set.

$UTLISTNAME
$UTOUTNAME
$UT1NAME
$UT2NAME
$UT3NAME

The 1 to 10-character member name.

$UTLISTAM
$UTOUTAM
$UTWORK1AM
$UTWORK2AM
$UTWORK3AM
$UT1AM
$UT2AM
$UT3AM

The 0 to 2-character Access Method code.

$UTLISTSEC
$UTOUTSEC
$UT1SEC
$UT2SEC
$UT3SEC

The 0 to 10-character security data.

$VERCAT

The two-character Verification Category for the Verification being modeled.

$VERDESC

The 1 to 25-character description of the Verification Category for the Verification being modeled.

$VERREQUIRED

A one-character value indicating whether the Verification category being modeled is required by the current Library Code. This can be used to bypass members that do not pertain to the Verification Procedure if appropriate.

$VERSHORTNAME

The 1 to 4-character short name of the level at which the Verification is being run.

$VSAMPFX

The prefix for your CA‑PanAPT VSAM files. Normally this should be the same as the VSAMPFX specification in the APJP5320 or APJP5920 procs; however, it is not derived from there. The current data set name of the APTDB file (the CA‑PanAPT database) is stripped of the .APTDB suffix, giving this keyword value. If the data set name of your database does not end with an APTDB qualifier, the value of this keyword is null.

This keyword is useful for constructing JCL that uses the procs provided with CA‑PanAPT, most of which require a VSAMPFX parameter.

$X00

A string of 80 binary zeros. When using products such as CA‑Panexec to invoke compilers, it is often necessary to provide ddname overrides to compilers. Usually the parm string passed to the compiler required binary zeros as a place holder for any ddnames that are not altered. This keyword can be used to generate the binary zero place holders.