XSUTGLOB (global variable definition) automation control point
Use the XSUTGLOB automation control point for the following tasks:
To initialize user-defined global variables
User-defined global variables are visible across automation control points. (Local variables are limited to the automation control point to which they are defined.)
To dynamically set +parameters for BMC AMI Utilities
Using this automation control point allows utilities to set certain +parameters at run time based on such criteria as time of day.
The product invokes this automation control point after issuing message NGTU091. This occurs near the beginning of the processing of a set of BMC AMI Utilities.
Variables
The following table describes the general variables used in the XSUTGLOB automation control point:
Variable name | Contents | Possible values | Notes |
|---|---|---|---|
jobname | Name of the current job | Not applicable |
|
plan | Db2 plan used to connect to Db2 | Not applicable |
|
rc | Return code for this automation control point | SeeReturn codes |
|
restart_parm | Value of the third parameter on the utility EXEC statement |
|
|
ssid | Db2 subsystem ID | Not applicable |
|
stepname | Name of the current job step | Not applicable |
|
uid | Utility ID for the current job step | Not applicable |
The following table displays the general variables that set BMC AMI Utilities +parameters at run time:
Variable name | BMC AMI Utilities +parameter |
|---|---|
CONTROLPREFIX | +CONTROLPREFIX |
DEADLINE | +DEADLINE |
INITWINDOW | +INITWINDOW |
MAXCONNECT | +MAXCONNECT |
MAXMEMORY | +MAXMEMORY |
MAXTASKS | +MAXTASKS |
MAXWAIT | +MAXWAIT |
SVRDISK | +SVRDISK |
SVRTAPE | +SVRTAPE |
WORKPREFIX | +WORKPREFIX |
WORKUNIT | +WORKUNIT |
Return codes
The XSUTGLOB automation control point returns the following return codes:
Return code | Description |
|---|---|
0 | (default value) Signifies normal completion No action is required. |
Any other value | Abnormal termination Set the return code to any non-zero value to cancel the entire job. |
Usage considerations
Review the following information before using this automation control point:
- The value of the uid variable is the utility ID for the master (when XSUTGLOB is called from the master) or the utility ID of the server (when XSUTGLOB is called from the server). This value might be different for the master than for the server. To reduce confusion, BMC suggests that you use the _cdbvar ('UID') function instead of reading the uid variable. For more information about the _cdbvar function, see _cdbvar-function.
- You cannot set the values of global-global variables from the XSUTGLOB automation control point.