Variables

Variables are memory locations with a user- or system-defined name that can hold a value and be referenced in job and SMART folder definitions. A variable is resolved when its current value is retrieved from memory. Control-M resolves the variables used in a job definition when a job begins or completes execution, depending on the type of variable. The contents of the original job definition and variables remain unchanged.

You can use the following types of variables in SMART folder, sub-folder, and job attributes:

• User-Defined Variables: Variables that you create, name, and assign a value to.

• System Variables: Preexisting variables with static names and Control-M-assigned values.

• Variable Lists: A variable with a Control-M-defined name and user-assigned value, which references a pool of named pool variables A type of variable that you create in one job and can reference in subsequent jobs with the same Pool parameter. A Named Pool is a logical grouping of variables. .

You can manage variables with the following Monitoring utilities:

• ctmvar: Defines, deletes, modifies, and displays variables.

• ctmstvar: Displays the current value of a variable or function.

User-Defined Variables

User-defined variables are variables that you create by defining the variable name and assigning it a value in the job or SMART folder definitions. Before a job is submitted, Control-M resolves the variables and uses the value that is retrieved in the current job execution. For more information, see Adding Variables. For a description of the names and values that you can assign to user-defined variables, see Variable Names and Values.

Variable Scope

The scope of a variable is the extent of the area in Control-M where your variables can be referenced. You can set the scope of user-defined variables when you add variables to a job, as described in Adding Variables. The following list describes the different variable scope types:

• Local: Variables are referenced by the job they are defined in, such as messages, If-Action arguments, or a job script in succeeding executions.

• Named Pool: Variables are referenced by any job in the same pool, which is a group of shared variables that share the same pool name.

• SMART Folder: Variables are referenced by jobs and sub-folders in the SMART folder.

You can determine the scope of a variable by the prefix that is added to its name, as described in Variable Reference Syntax.

System Variables

System variables are preexisting variables with static names and Control-M-assigned values. You can reference system variables in the job definition The set of parameters that defines what the job does, when it runs, its prerequisites, and the post-processing actions Control-M performs after it ends (also called a job processing definition). attributes, as described in Variable Reference Attributes and in the values of User-Defined Variables. Before a job is submitted, Control-M resolves the variables and uses the retrieved values for the current job execution.

The following is a list of system variables that you can reference in the attributes of a job definition and as values within User-Defined Variables:

• Job General System Variables: Reflects attributes defined in a job definition.

• Job Scheduling System Variables: Reflects the scheduling of a job.

• Environment System Variables: Reflects your environment and are not specific to a job.

• Action System Variables: Returns statistics about your job after it has been executed.

Variable Lists

A variable list is a variable with a Control-M-assigned name, such as POOLSYM, and a user-defined value. Variable lists enable you to define multiple variables inanother job or a utility, and reference them locally, without the need to manually redefine them in each job, SMART folder, or sub-folder.

You can reference the following types of variable lists in SMART folders, sub-folders, and jobs:

• %%POOLSYM (Local): Contains a user-defined value that consists of a pool name where one or more named pool variables A type of variable that you create in one job and can reference in subsequent jobs with the same Pool parameter. A Named Pool is a logical grouping of variables. are defined.

  A job is defined with a %%POOLSYM local variable list that is assigned the value MyPool, which is an existing pool that contains the following variable definitions:

  • var1=100

  • var1=200

  • var3=300

Adding Variables

This procedure describes how to add user-defined variables or variable lists to a job, which enables you to share data between multiple jobs.

Begin

1. From the Variables area in the job or folder definitions, click .

2. From the Type drop-down list, select one of the following variable scope types:

   • Local: Defines a variable that can be referenced by the job or folder that they are defined in.

   • Named Pool: Defines a variable that can be referenced by referring to the pool name.

     In the Pool Name field that appears, type a logical pool name.

   • SMART Folder: Defines a variable that can be referenced by all jobs and sub-folders in the SMART folder.

3. In the Name field, do one of the following:

   • User-Defined Variable: Type a logical variable name.

   • Variable List: Do the following:

     • POOLSYM: Type POOLSYM.

4. In the Value field, do one of the following:

   • User-Defined Variable: Type the variable value.

   • Variable List: Do the following:

     • POOLSYM: Type the pool name.

   A variable is added to the job definition.

   To resolve and view the current values of your variables, see Variables.

Variable Simulation

Variable Simulation enables you to view the original and resolved values of variables in your SMART folder, sub-folder, or job, without the need to run any of them.

In an OS job, you can toggle back and forth between variable simulations in the Command field and Variables area of an OS job, all within the same Variable Simulation pane. This eliminates the need to close the Variable Simulation pane in one area of the job definitions and reopen it from another.

The following procedures describe how to simulate variables:

• Simulating Added Variables

• Simulating Variables in OS Jobs

Simulating Added Variables

This procedure describes how to view the original and resolved values of added variables in SMART folders, sub-folders, or jobs.

Begin

• From the top right corner of the Variables area, in the General tab, click .

  The Name, Original Value, and Resolved Value of each variable appear in the Variable Simulation pane.

  The error message CTMERR appears with the variable name in the Resolved Value when one of the following values have been assigned:

  • A nonexistent variable.

  • A user-defined variable that is assigned a value that includes a nonexistent variable.

Simulating Variables in OS Jobs

This procedure describes how to view the original and resolved values of variables in OS jobs.

Begin

• Do one of the following:

  • To simulate variables used in the Command field, click .

    The Original Command Line and Resolved Command Line appear in the Variable Simulation pane.

    The error message CTMERR appears with the variable name in the Resolved Command Line when one of the following values have been assigned:

    • A nonexistent variable.

    • A user-defined variable that is assigned a value that includes a nonexistent variable.

  • To simulate variables added in the Variables area, see Simulating Added Variables.

  You can toggle back and forth between variable simulations in the Command field and the Variables area by clicking Command Line and Variables in the Variable Simulation pane.

Shared Variables

Shared Variables enables you to view the names and current resolved values of all named pool variables in active jobs, SMART folders, or Workspaces. This tool enables you to track the changing values of variables during run time.

The following video describes Shared Variables:

Variable Reference Attributes

The following table describes the attributes where you can reference User-Defined Variables and in a job definition The set of parameters that defines what the job does, when it runs, its prerequisites, and the post-processing actions Control-M performs after it ends (also called a job processing definition)..

Attribute	Tab
Command	General Tab: OS job type
File Name
File Path
Alerts Window Message	Actions Tab: If-Actions> Action> Notify
Job Log Message
Mail Attributes
File Name	Actions Tab: If-Actions > Action> Handle Output
Name	Actions Tab: If-Actions > Action> Set Variable
Value
Alerts Window Message	Actions Tab: Creating Notifications
Job Log Message
Mail Attributes
File Name	Actions tab: Output Handling options> Action> Copy

Variable Reference Syntax

The following table describes the syntax for referencing a variable in the attribute of a SMART folder, sub-folder, or job definition.

Variable	Syntax
Local Variables	%%<VARIABLE NAME>
Named Pool Variables	%%\\<POOL NAME>\<VARIABLE NAME>
SMART Folder Variables	%%<VARIABLE NAME>
Variables that are not resolved	Windows: %#%

Job General System Variables

The following table describes the Job General System Variables.

Name	Resolution	Description
%%APPLIC	String	Resolves the application A job attribute that provides a logical name for sorting groups of jobs, which enables you to search for and update jobs. of the job.
%%APPLGROUP	String	Resolves the sub-application A job attribute that provides a logical name for sorting groups of jobs in an Application, which enables you to search and update jobs. of the job.
%%CYCLIC	Y or N	Resolves the cyclic A SMART folder or job that executes multiple times in one run, whether for specific intervals, sequences of intervals, or times. status of the job, as follows: Y: The job is cyclic. N: The job is not cyclic.
%%$FOLDER_ID	String	Resolves the run ID The identification code for a SMART folder, sub-folder, or job execution. of the job. This variable is valid for jobs in a SMART folder and is evaluated in base 36.
%%GROUP_ORDID	Numeric	Resolves the Run ID of the sub-application where the job belongs. This variable is valid only for jobs in an active SMART folder and is evaluated in base 10.
%%$GROUP_ORDID	Numeric	Resolves the Run ID of the sub-application where the job belongs. This variable is valid only for job in an active SMART folder and is evaluated in base 36.
%%JOBNAME	String	Resolves the name of the job.
%%ORDERID	String	Resolves the run ID of the job.
%%OWNER	String	Resolves the username with the authorization to execute the job and is defined in the Run as field.
%%RUNCOUNT	Numeric	Resolves the number of times the job run has ever executed (the first time the job executes, this variable returns a value of 1). %%RUNCOUNT counts each execution of a job and each execution of a cyclic job as individual executions.
%%SCHEDTAB	String	Resolves the name of the parent folder of the job.
%%SMART_ORDERID		Resolves the run ID of an existing SMART folder. This variable is valid for jobs in a SMART folder and is evaluated in base 10.
%%$SMART_ORDERID		Resolves the run ID of an existing SMART folder. This variable is valid for jobs in a SMART folder and is evaluated in base 36.
%%$TABLE_ID	Numeric	Resolves the run ID of the folder where the job belongs. This variable is valid for jobs in a SMART folder and is evaluated in base 36.

Application and Sub-application Variables

The following is a list of unique rules that apply when using variables in the Application and Sub-application fields:

• Jobs that are run at different times have different Application names in the job output.

  Application = APP_X_%%TIME

  FolderX runs at New Day time, 07:00, and again using the ctmudly utility at 14:00.

  Application name in the job output for jobs that ran at New Day time: APP_X_07:00.

  Application name in the job output for jobs that ran using the ctmudly utility: APP_X_14:00.

• The following variables are resolved when the job is ordered (run):

  • %%$DATE

  • %%$YEAR

  • %%MONTH

  • %%OWDAY

  • %%RMONTH

  • %%YEAR

  • %%$ODATE

  • %%CENT

  • %%ODATE

  • %%OYEAR

  • %%RWDAY

  • %%OMONNAM

  • %%$OYEAR

  • %%DATE

  • %%ODAY

  • %%RDATE

  • %%RYEAR

  • %%RMONNAM

  • %%$RDATE

  • %%DAY

  • %%OJULDAY

  • %%RDAY

  • %%TIME

  • %%MONNAM

  • %%$RYEAR

  • %%JULDAY

  • %%OMONTH

  • %%RJULDAY

  • %%WDAY

  Variables that are not listed above are resolved when the job executes.

  Application = %%TIME.%%VAR1

  %%TIME resolves to 140413 when the job is ordered, but %%VAR1 only resolves when the job executes.

  Application in the job output when the job is ordered: 140413%%VAR1.

• Multiple variables and fixed text are used in a single field.

  Application = Shipments_%%ODATE.%%TIME

  Application in the job output: Shipments_01012021.07:00.

• The following variables are resolved based on the ODAT received as a parameter to the run request or command:

  • %%ODATE

  • %%$ODATE

  • %%CENT

  • %%OYEAR,

  • %%$OYEAR

  • %%OMONTH

  • %%ODAY

  • %%OWDAY

  • %%OJULDAY

  • %%OMONNAM

• The following variables are resolved based on the Control-M/Server date, or based on the next New Day date for pre-run:

  • %%RDATE

  • %%$RDATE

  • %%RYEAR

  • %%$RYEAR

  • %%RMONTH,

  • %%RDAY

  • %%RWDAY

  • %%RJULDAY

  • %%RMONNAM

• The following variables are calculated based on the current date or on the next date for pre-run:

  • %%DATE

  • %%$DATE

  • %%YEAR

  • %%$YEAR

  • %%MONTH

  • %%DAY

  • %%WDAY

  • %%JULDAY

  • %%MONNAM

• The %%TIME variable is calculated based on the current time or on the New Day time for pre-run.

Job Scheduling System Variables

The following table describes the Job Scheduling System Variables that reflect the scheduling of a job in relation to the ODATE The date that a job joins the Run Queue. of the job.

Name	Resolution	Description
%%NEXT	YYMMDD	Resolves to the next scheduled date of the job.
%%$NEXT	YYYYMMDD	Resolves to the next scheduled date of the job (4-digit year).
%%ODATE	YYMMDD	Resolves to the date that the job joined the Run Queue The queue of jobs that are scheduled to execute on a specific day, in states of Waiting or Executing, depending on their running phase.).
%%$ODATE	YYYYMMDD	Resolves to the date that the job joined the Run Queue (4-digit year).
%%ODAY	1–31	Resolves to the day of the month that the job joined the Run Queue.
%%OJULDAY	1–365	Resolves to the day of the year that the job joined the Run Queue such as, 36 for February 5th.
%%OMONTH	1–12	Resolves to the month that the job joined the Run Queue (1=January).
%%OWDAY	0–6	Resolves to the day of the week that the job joined the Run Queue. Default: 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, and 0=Sunday.
%%OYEAR	YY	Resolves to the year that the job joined the Run Queue.
%%$OYEAR	YYYY	Resolves to the year that the job joined the Run Queue (4-digit year).
%%PREV	YYMMDD	Resolves to the previous run date of the job.
%%$PREV	YYMMDD	Resolves to the previous run date of the job (4-digit year).

Environment System Variables

The following table describes the Environment System Variables.

Name	Resolution	Description
%%CENT	YY	Resolves to the first two digits in the current year such as, 20 in the year 2021.
%%DATACENTER	String	Resolves to the name of the Server for the current Control-M installation.
%%DATE	YYMMDD	Resolves to the current date.
%%$DATE	YYYYMMDD	Resolves to the current date (4-digit year).
%%$RDATE	YYYYMMDD	Same as %%$DATE.
%%DAY	1–31	Resolves to the current day of the month.
%%JULDAY	1–365	Resolves to the current system Julian day of the year, such as 36 for February 5th.
%%RJULDAY	1–365	Same as %%JULDAY.
%%MONNAM	String	Resolves to the first 3 letters of the name of the current month.
%%RMONNAM		Same as %%MONNAM.
%%MONTH	MM	Resolves to the current month.
%%RMONTH	MM	Same as %%MONTH.
%%RDAY	1–31	Resolves to the current day of the month.
%%WDAY	0–6	Resolves to the current day of the week. Default: 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, and 0=Sunday.
%%RWDAY	0–6	Same as %%WDAY.
%%YEAR	YY	Resolves to the current year.
%%RYEAR	YY	Same as %%YEAR.
%%$RYEAR	YYYY	Resolves to the current year (4-digit year).
%%TIME	HHMMSS	Resolves to the current time of day.

Action System Variables

The following table describes the Action System Variables that reflect the value in the attribute defined after job execution.

Name	Resolution	Description
%%AVG_CPU	Numeric	Resolves (in seconds), to the average CPU time for previous runs of the job (not folder).
%%AVG_TIME	Numeric	Resolves (in seconds), to the average run time for previous runs of the job or folder.
%%COMPSTAT	Numeric	Resolves to the completion code assigned to the job by the operating system of the computer that executes the job. Initial Value: 0
%%JOBID	String	Resolves to the identification assigned to the job (not folder) by the operating system of the computer that executes the job.
%%NODEID	String	Resolves to the host ID of the Agent A Control-M component installed on a host (computer) that runs and monitors the jobs on the host. computer that submitted the job.
%%SD_CPU	Numeric	Resolves (in seconds), to the standard deviation of the CPU time of the execution of the job (not folder) from the average CPU time for previous executions of the job. Do not use this variable in a SMART folder definition.
%%SD_TIME	Numeric	Resolves (in seconds), to the standard deviation of the elapsed run time of the execution of the job or folder from the average elapsed run time for previous runs of the current job or folder.

SLA Management Variables

The following table lists the SLA Management variables, which you can only define in the SLA Service Actions of an SLA Management job.

Variable	Description
%%PROBLEMATIC_JOBS	Name of any job in a service that is not running on time, and, as a result, will impact the service. If more than one job is problematic, the names of all problematic jobs is returned.
%%SERVICE_DUE_TIME	Time by which the entire service should complete.
%%SERVICE_EXPECTED_END_TIME	Time BMC SLA Manager estimates the service will complete.
%%SERVICE_NAME	Name of the service.
%%SERVICE_PRIORITY	Priority level of the service.

Variable Names and Values

You can assign names to User-Defined Variables as follows:

• 1–38 alphanumeric characters.

• Names are case-sensitive.

• Names cannot begin with a number.

• No blank spaces or any of the following special characters: < > [ ] { } ( ) = ; ` ~ | : ? . + - * / & ^ # @ ! , " '.

You can set the values of User-Defined Variables with one or more of the following elements:

• 1–214 alphanumeric character strings.

• Variables set on the General tab, as described in Job General System Variables.

• Variables set when you manually run a job, as described in Running Jobs or a Workspace.

• Variables set in the If-Action A post-processing action that you define for Control-M to perform after a job executes, if a condition is met. of a previous job, as described in If-Action Action Attributes.

• System Variables

• Variable Reference Attributes

• Variable Concatenations

• Variable Functions

Variable Manipulations

You can use an operator in the value to manipulate a date variable or numeric variable using the following syntax:

<VALUE> <OPERATOR> <NUMBER>

Where:

• <VALUE>: A date or number.

• <OPERATOR>: %%PLUS or %%MINUS.

• <NUMBER>: Applied to the operator.

Variable Concatenations

You can concatenate variables to resolve into a single string using the "." operator. To include a period separator between two variables you must use "..".

Variable Functions

A variable function performs an action or process on the variable. Variable functions are used instead of another expression. The following functions are available:

• %%CALCDATE

• %%GETENV

• %%SUBSTR

• %%$WCALC

• %%BLANK

%%CALCDATE

%%CALCDATE and %%$CALCDATE: Adds or subtracts a specified number of days from a specified date with %%CALCDATE in the yymmdd format, and %%$CALCDATE in the yyyymmdd format, using the following syntax:

%%CALCDATE <DATE> <OPERATOR><NUMBER>

Where:

• <DATE>: A date in yymmdd or yyyymmdd format, such as 291115, or a variable that resolves to a date, such as %%DAY.

• <OPERATOR>: Either the + (plus) or - (minus) sign.

• <NUMBER>: The number you want to add to or subtract from the original date.

%%GETENV

GETENV: Retrieves the value of an environment variable, using the following syntax:

%%GETENV <ENVIRONMENT>

Where <ENVIRONMENT>: is the environment variable, such as HOME.

%%SUBSTR

%%SUBSTR: Extracts a substring from within the value of a string variable, using the following syntax:

%%SUBSTR <VARIABLE> <START POSITION> <LENGTH>

Where:

• <VARIABLE>: The string variable from where to extract the new substring.

• <START POSITION>: A number or numeric variable indicating the starting character of the substring in the <VARIABLE>.

  The number of the first character in the <VARIABLE> is 1.

• <LENGTH>: is equal to the number of characters in the substring.

If <START POSITION> is a variable, Control-M resolves this variable first before it resolves %%Number.

%%$WCALC

%%$WCALC: Adds or subtracts a specified number of days from a specified Regular Calendars in the yyyymmdd format, using the following syntax:

%%$WCALC <DATE> <INSTRUCTION> <CALENDAR>

Where:

• <DATE>: A date in yyyymmdd format, such as 20291115, or a variable that resolves to such a date, such as %%$DATE.

• <INSTRUCTION> Do one of the following:

  • +<NUMBER> or -<NUMBER>: Instructs Control-M to calculate the date that you specify the <NUMBER> of working days after or before the <DATE>.

  • > More than: Instructs Control-M to calculate after the <DATE> the next working day in the calendar that you specify.

  • > Less than: Instructs Control-M to calculate before the <DATE> the previous working day in the calendar that you specify.

• <CALENDAR>: The name of the Regular calendar where Control-M calculates the date.

%%BLANK

%%BLANK: Inserts spaces in the value where you define the number of spaces, using the following syntax:
%%BLANK<N>

Where <N> is the number of spaces you want to insert.