Symbolic fields - syncsort_scc_monitor

Use of symbolic fields

Expressions, operator commands, messages, rule assignments and SMF records can use symbolic fields. Symbolic fields usually start with the ampersand (&) character, the only exception being an expression.

When symbolic fields are used in the rules language, the entire symbolic name need not be entered -- only enough of the name to ensure that the field is unique. For example, a symbolic name of &JOBN can be used to specify &JOBNAME.

Since only symbolic fields can be used on the left side of an expression, the ampersand character is optional. For example, both of the following expressions will compare the user’s account number to the literal “SY-0286-DJT”.

IF &ACCT = SY-0286-DJT
IF ACCT = SY-0286-DJT

When evaluating an expression, symbolic substitution will be performed before evaluating the expression. This facility allows symbolic fields to be placed on both sides of the relational operator. In the following example, the expression will compare the OWNERID for a VSAM file with the current job name.

IF &OWNER NE &JOBNAME

The DEFCMD, DEFMSG, DEFREC and DEFSMF statements can use symbolic fields to build operator commands, messages, rule records and SMF records. For example, the following message will perform symbolic substitution for the current job name.

DEFMSG WRNMSG01 “** WARNING ** &JOBNAME INVALID”

When just part of a symbolic field is required, the displacement and length of the substring can be specified with the symbolic name. The displacement and length should be enclosed in parentheses, and be separated by a comma or blank. The parenthetical field must be concatenated with the symbolic field name, and cannot be separated with blanks. For example, the following symbolic name will be evaluated for the first three characters of the job name.

&JOBNAME(1,3)

Note: For detailed information about symbolic variables, refer to the chapter Rules Customization in the Dynamic Install Facility (DIF) User’s Guide.

Symbolic field tables

Since SCC-DLimit has a large number of symbolic field names, the symbolic fields have been divided into several tables. These tables should help you in locating a particular symbolic field name.

The order of the tables listed in this section is very important. When a symbolic field is accessed, the tables are searched in sequence. The first table that contains an entry for the symbolic field will be used by the product. When the rules language attempts to modify the data associated with the symbolic field, the first table entry that can be updated will be used for the update.

Note: When a symbolic name is specified in more than one table, the product will often provide a unique name for each table. For example, the volume name in the UCB can be accessed via VOLSER or UVOLSER.

SCC-DLimit rules language variables

The following charts show the variable names that may be specified in the SCC-DLimit rules. In addition to the variables in these charts, many of the symbolic variables found in Chapter 8 of the Dynamic Install Facility (DIF) User’s Guide and Chapter 7 of the ACC/SRS User’s Guide may also be used. Because SCC-DLimit gets control during IGGPRE00 processing, all of the variables available during the ACC/SRSDADSM environment may be used, as well as many of the variables in the ACC/SRSDD and IDCAMS environments.

In the tables below, the following definition is used:

Account-name An alphanumeric string of 1 to 30 characters, representing an account in the SCC-DLimit database.

System wide variables

The symbolic variables that will most commonly be set by SCC-DLimit are the DACCT and MODEL variables. Setting these variables assigns the space request to an account in the database and allows the space to be tracked. The variables prefixed by SYS_ refer to values in the $CONTROL record, and allow access to the values that were set by the DLSYS command.

Table 9-1. Symbolic names for system-wide variables

SYMBOLIC NAME	TYPE	DESCRIPTION
`DACCT`	`CHAR(30)`	Specifies the name of the account assigned to the dataset. The SCC-DLimit rules may assign a dataset to up to 10 different accounts. (`DACCT1` is an alternate variable name for `DACCT`).
`DACCTn`	`CHAR(30)`	Specifies the name of the account assigned to the dataset. If specified, “n” must be a numeric value from 1 to 10. The SCC-DLimit rules may assign a dataset to up to 10 different accounts.
`ENV¹`	`CHAR(20)`	Environment name, i.e., the type of processing which is being performed by SCC-DLimit. Valid values: `ALLOCATE` `EXTEND` `SCRATCH` `RELEASE` `RENAME` `PARTREL` `VSAMEXT`
`ENVS¹`	`CHAR(20)`	Sub-environment name. A further breakdown of the type of processing which is being performed by SCC-DLimit. Valid values: `DADSM-PRE` `DADSM-POST`
`FAIL`	`CHAR(3)`	Specifies whether or not the job is to terminate with a JCL error. (`FAIL` is an alternate variable for `JCLFAIL`). Valid values: `YES` `NO`
`HSM_DEVICE¹`	`CHAR(4)`	The type of device on which the migrated dataset currently being processed by the `DLMAINT`HSM function resides. Valid values: `DISK` `TAPE`
`HSM_LEVEL¹`	`CHAR(6)`	The migration level on which the migrated dataset being processed by the `DLMAINT`HSM function currently resides. Valid values: `LEVEL1` `LEVEL2`
`MODEL`	`CHAR(30)`	Contains the name of a model account in the SCC-DLimit database. The characteristics of the model account are used when new accounts are created and a model account is assigned.
`NEWDSN`	`CHAR(44)`	NEW DSNAME ON `DADSM` RENAME REQUEST.
`NEWDSN_HLQ`	`CHAR(8)`	HLQ FOR THE NEW DSNAME ON `DADSM` RENAME REQUEST.
`NEWDSN_QUALL¹`	`CHAR(8)`	LAST QUALIFIER FOR THE NEW DSNAME ON RENAME REQUEST.
`NEWDSN_QUAL{n}¹`	`CHAR(8)`	nTH QUALIFIER FOR THE NEW DSNAME ON RENAME REQUEST.
`REQ_SIZE-GB`	`NUM`	DATA SET REQUESTED SPACE IN GIGABYTES.
`REQ_SIZE-KB`	`NUM`	DATA SET REQUESTED SPACE IN KILOBYTES.
`REQ_SIZE-MB`	`NUM`	DATA SET REQUESTED SPACE IN MEGABYTES.
`REQ_SIZE-T`	`NUM`	DATA SET REQUESTED SPACE IN TRACKS.
`SYS_AUTO`	`CHAR(3)`	Indicates whether new accounts may be automatically created in the SCC-DLimit database when a `SET` statement assigns an account name that does not currently exist in the database. Valid values: `YES` `NO`
`SYS_FMODE`	`CHAR(3)`	Specifies that the system-wide setting for the action that SCC-DLimit is to take when a request for space causes an account to exceed its limit is to override the settings specified for an account (`ACCT_MODE`). I.e., `DLSYS MODE(value) FORCE` was specified. Valid values: `YES` `NO`
`SYS_MODE`	`CHAR(10)`	Indicates the system-wide setting for the action that SCC-DLimit is to take when a request for space causes an account to exceed its limit. The system-wide setting (`SYS_MODE`) may be overridden by the mode specified for an account (`ACCT_MODE`). Valid values: `ACTIVE` `WARN` `TRACK` `INACTIVE`
Note: 1 This field is read only. `SET` processing will not allow the field to be modified.

Account variables

The account variables describe the contents of a record in the SCC-DLimit database. During allocation processing, these variables can be examined to determine the characteristics of the account assigned to the dataset. (In this case, the rules must first assign the account to a dataset via a SET DACCT= statement.)

These variables may also be set when a new account is created. This occurs when SET DACCT= refers to a non-existent account and the $CONTROL record indicates that AUTOCREATE(YES) was specified on the DLSYS command. Setting the ACCT_ variable when a new account is being created overrides the value of the variable that may otherwise have been obtained from a MODEL account if specified.

It may also be useful to set the ACCT_ variables during DLMAINT SCAN processing in order to change the values for a large number of accounts. The values for an individual account can also be changed via the DLALTERTSO command or the ISPF interface.

Table 9-2. Symbolic names for account variables

SYMBOLIC NAME	TYPE	DESCRIPTION
`ACCT_AUTO`	`CHAR(3)`	Indicates whether the account was created automatically by SCC-DLimit when space was requested for a dataset. Valid values: `YES` `NO`
`ACCT_CREDATE`	`CHAR(8)`	The date on which the SCC-DLimit account associated with the dataset was created. Valid values: `mm/dd/yy`.
`ACCT_CRETIME`	`CHAR(8)`	The time at which the SCC-DLimit account associated with the dataset was created. Valid values: `hh:mm:ss`.
`ACCT_DESC`	`CHAR(20)`	Specifies a description for the account.
`ACCT_LOG`	`CHAR(8)`	The DD name of a log file allocated to the DIF started task. Warning and error messages issued when space usage in an account exceeds the allowed limit are written to the specified dataset.
`ACCT_MODE`	`CHAR(10)`	Specifies the setting for the action that SCC-DLimit is to take when a request for space causes the account to exceed its allowable limit. If `NONE` is specified, the system-wide mode (`SYS_MODE`) is used unless a value other than `NONE` is specified for the account. Valid values: `ACTIVE` `WARN` `TRACK` `INACTIVE` `NONE`
`ACCT_NAME`	`CHAR(30)`	Specifies the name of the account assigned to the dataset.
`ACCT_NEW`	`CHAR(3)`	Indicates that the account is a new account which has not yet been recorded in the SCC-DLimit database. Valid values: `YES` `NO`
`ACCT_NOTIFY_WARN`	`CHAR(3)`	Indicates whether warning messages should be issued when the total space usage in the account exceeds the allowable limit. Valid values: `YES` `NO`
`ACCT_USEDATE`	`CHAR(8)`	The date on which the SCC-DLimit account was last accessed (i.e., the date on which space was last added to or subtracted from the account). Valid values: `mm/dd/yy`.
`ACCT_USETIME`	`CHAR(8)`	The time at which the SCC-DLimit account was last accessed (i.e., the time at which space was last added to or subtracted from the account). Valid values: `hh:mm:ss`.
`ACCT_USERID`	`CHAR(8)`	The TSO userid to be notified when space usage in the account exceeds the allowed limit.
`ACCT_WARN`	`NUM`	Percentage of the maximum allowable disk space limit for the account at which warning messages will be issued by SCC-DLimit. Valid values: 0-100.
Note: 1 This field is read only. `SET` processing will not allow the field to be modified.

Account space variables

These variables may also be set when a new account is created. This occurs when SET DACCT= refers to a non-existent account and the $CONTROL record indicates that AUTOCREATE(YES) was specified on the DLSYS command. Setting the ACCT_ variables when a new account is being created overrides the value of the variables that would otherwise have been obtained from a MODEL account if one was assigned.