The Control-M/Analyzer System variables are listed below in alphabetical order. Values of System variables marked with an asterisk (*) can be modified by the user using a DO SET statement.
Table 143 Summary of System Variables
Variable |
Description |
---|---|
BARGnn* |
Block arguments for passing parameters to a block. |
RARGnn* |
Rule arguments for passing parameters to a rule. |
SYSBARGNO |
Specifies the number of block arguments. |
SYSCATEG |
Current category name. |
SYSCENT |
First two digits in the current year (for example, 19 in the year 1998). SYSCENT returns 20 on 1 January 2000. |
SYSCURLINE |
Holds the current line to be compared by an ON COMPARE statement. This system variable is not limited in length, as opposed to regular variables, which are limited to 100 bytes. This variable is used only by an ON COMPARE statement (including its optional user blocks). |
SYSSRCHALL* |
Indicates whether to search each qualifying line for all occurrences or only the first occurrence of the string specified in a WHEN statement. If SYSSRCHALL=1, the line is searched until all occurrences are found. IF SYSSRCHALL=0 (the default value), searching in each line stops when the first occurrence of the string in that line is found. For example:
|
SYSCPROCn |
Nine user-defined System variables (n is a number from 1 through 9) that provide a mechanism for combining sequences of processes into a single BCPROCn combined process that can afterwards be used as a PROCESS in a DO EXTRACT statement. Any meaningful sequence of built-in or user-defined processes can be made into a combined process using a DO SET statement. For example:
Each process in the list must be separated by a blank. When a BCPROCn combined process is used in a DO EXTRACT statement, the processes it represents are implemented in the same order (left to right) they had in the DO SET statement. Each SYSCPROCn variable must be defined by a DO SET statement before it is used by the DO EXTRACT statement. The SYSCPROCn definition remains effective until the rule terminates unless redefined by a subsequent DO SET statement in the rule. For more information about DO EXTRACT and DO SET statements, see DO EXTRACT: Automated Balancing Statement and DO SET: Automated Balancing Statement. |
SYSDATE |
System date. SYSDATE returns 000101 on 1 January 2000. |
SYSDAY |
Day portion of system date (format dd). |
SYSDBVARCREATE*
|
Flag that indicates whether Control-M/Analyzer should automatically create a Database variable (according to defaults) if a rule refers to a variable (with a DB_ prefix) that has not been defined. For more information, seeAutomatic Database Variable Creation. Valid values are:
Note: The Database variable is only created automatically if both the SYSDBVARCREATE system variable and the VARCRET parameter in the CTBPARM member are set to Y. |
SYSDBVARGENS* |
Default maximum value of Database variable generations for Database variables created automatically by Control-M/Analyzer. For more information, see the SYSDBVARCREATE System variable above. The initial value of this default is the value specified by the VARGENS parameter in the CTBPARM member. |
SYSDBVARDESC* |
Default description for Database variables created automatically by Control-M/Analyzer. See System variable SYSDBVARCREATE above. The initial value of this description is blank. |
SYSDECCHAR* |
Specifies the decimal point character indicator. For information about how the value of SYSDECCHAR affects output formatting, see Dynamic Print Formatting Facility. If the value of SYSDECCHAR is DOT, the decimal point indicator is a period and the thousands separator is a comma. If the value of SYSDECCHAR is COMMA, the decimal point indicator is a comma and the thousands separator is a period. The default value of SYSDECCHAR is the value of the DEECHAR installation parameter in the CTBPARM member of the Control-M/Analyzer Parameters library. |
SYSEXTBLANK* |
Alternative value for blank values extracted during rule execution. If SYSEXTBLANK is initialized, blank values subsequently extracted by the DO EXTRACT statement are set to the value of SYSEXTBLANK. Otherwise, the extracted values remain blank. SYSEXTBLANK is initialized by the DO SET statement. For additional information on how the DO EXTRACT statement operates, see DO EXTRACT Processes. Example
Since SYSEXTBLANK was previously set to 0, if the value extracted is blank, TOTAL1 is set to 0 (meaning, the value specified for SYSEXTBLANK). |
SYSEXTUPROC* |
Expression that contains a reference to the SYSEXTVAL System variable (the value extracted by the DO EXTRACT statement). This expression specifies a user-defined process that is applied when a DO EXTRACT statement is run with the BUPROC process (described in DO EXTRACT: Automated Balancing Statement). For example, our original data contains information in inches, but we need information in centimeters to process the data. We could extract the information (in inches) and convert it each time to centimeters with an appropriate DO SET statement. Instead, we can specify the desired process one time by setting the SYSEXTUPROC System variable and then executing the DO EXTRACT statement as shown in the following example. Example
The value in inches extracted from the specified line and columns is evaluated according to the expression in SYSEXTUPROC and its value is stored in the CENTIM variable. |
SYSEXTVAL |
The value extracted by process BUPROC of the DO EXTRACT statement. (For additional information see DO EXTRACT: Automated Balancing Statement.) The extracted value is saved in this System variable. The SYSEXTUPROC System variable (described above) must be set to an expression that contains a reference to the SYSEXTVAL System variable. |
SYSGROUP |
Current group name. |
SYSJOBID |
Job ID of the current job. |
SYSJOBNAME |
Current job name. |
SYSLSTR1,... |
These are long string variables that are not limited in length (unlike regular variables that are limited to 100 bytes). These long string variables can be used by the following Control-M/Analyzer statements, functions and operators:
|
SYSMISSION |
Current mission name. |
SYSMONTH |
Month portion of system date (format mm). |
SYSNDATE |
Next scheduling date. Varies, depending on the method by which Control-M/Analyzer is invoked, as follows:
|
SYSNULL |
Null variable (created by setting the variable length of zero). SYSNULL is used in a DO SET statement to set a variable to "null." For example:
|
SYSOPT |
Control-M/Analyzer invocation method. Valid values are:
For additional information about invoking Control-M/Analyzer, see Introduction and Control-M/Analyzer Variables. |
SYSODATE |
Original scheduling date. Varies, depending on the method by which Control-M/Analyzer is invoked, as follows:
|
SYSOWNER |
Current owner. |
SYSPDATE |
Previous scheduling date. Varies, depending on the method by which Control-M/Analyzer is invoked, as follows:
|
SYSRARGNO |
Number of rule arguments. |
SYSRESOLVE* |
Flag to indicate whether symbols that begin with %% must be resolved. As a default, AutoEdit variables are resolved automatically. Setting SYSRESOLVE to NO overrides this default; this option is not currently available. See SYSRESOLVE Control Statement. |
SYSRC |
System return code. Can be used to check the results of several functions (HOWMANY, NEXTVAR, SUM). Valid values:
|
SYSRRC |
Return code of a rule called by a DO RULE statement. |
SYSRULE |
Name of the rule to be executed by Control-M/Analyzer. However, if the rule was called by another rule, the value is the name of the calling rule. |
SYSRUNID* |
Site-defined run identifier. Run identifiers can be specified as part of a Control-M/Analyzer Database variable name for identification purposes. The run identifier can only contain alphanumeric characters. |
SYSRUNMODE |
Implementation level mode for the current group:
|
SYSSUBRULE |
Name of the currently executing rule. Eight characters are returned (meaning, the name is padded with blanks on the right if necessary). |
SYSTIME |
System time. |
SYSURC |
Return code of a rule called by a DO CALLUSER statement. |
SYSVER |
Control-M/Analyzer version number. |
SYSYEAR |
Year portion of system date (format yy). |
Parent Topic |