List of Agent Variables

Agent variables store agent information and settings. They are either available as VARA objects in Client 0 or they are directly stored in the database. If they are stored in the database, they are referred to as virtual agent variables. For information about agent variables and their syntax, see Virtual Agent VARA Objects.

This page includes the following:

Agent Variables in Client 0

Virtual Agent Variables

Virtual agent variables are usually defined in the [VARIABLES] section of the agent INI file. The values of some agent variables are automatically retrieved by the agent. In this case, there is no need to define them in the INI file (see the table below).
When the agent starts, all virtual variables will be passed on to the Automation Engine.

Important! It is not possible to define variables other than that are listed below. Although you can create user-defined variables, they cannot be read.

The following agent variables are available:

  • UC_EX_DAYLIGHT

    • Description:Checks whether the current time is Daylight Savings Time. The agent retrieves this information from the system time and passes it on to the Automation Engine.

    • Allowed values: Y and N, where

      • Y = Daylight Savings Time
      • N = Standard Time
    • Definition in INI file: The value of this variable is set automatically and cannot be defined in the INI file.

  • UC_EX_HOSTCHAR

    • Description: Description of the agent name, you can use the * wildcard for every agent that is not defined by name, see UC_EX_HOSTCHAR - Assigning Agents to Host Characteristics

    • Allowed values: Name or part of the variable that contains host characteristics. It allows a maximum of 188 characters.

    • Definition in INI file: Yes

  • UC_EX_HOST_ROLE

    • Description: Role of the agent, which is name that can be used as a filter in agent groups, see Agent Groups (HOSTG). If you enter several role names, separate them with a ";" character. Lowercase is converted to uppercase automatically.

      This definition does not affect the agent itself.

    • Allowed values: Up to 256 characters.

    • Definition in INI file: Yes

  • UC_EX_IP_ADDR

    • Description: IP address or name of the agent.

      When the agent starts, it retrieves the IP address of the computer on which it is running automatically. It passes this information on to the Automation Engine, where it is stored in this variable.

      The Automation Engine uses IP address and port number (variable UC_EX_IP_PORT) of the agent in the Header and Trailer Includes and passes this information on to the Job Messenger. The Job Messenger uses this data to connect to the agent.

      If the agent runs in a cluster, you can enter this cluster virtual IP address here. For more information, see Automation Engine and Clusters.

      (z/OS Agent) The agent uses these values only for the Sysplex configurations of a z/OS mainframe system.

    • Definition in INI file: No

  • UC_EX_IP_PORT

    • Description: Port of the agent.
    • Definition in INI file: No

  • UC_EX_JOB_MD

    • Description: Path and file name of the Job Messenger. When the agent starts, it checks this value and terminates if the path is not valid.

      This value is used in the Header and Trailer objects that include the messenger calls for the job start and job end.

    • Allowed values:

    • Definition in INI file: Mandatory

  • UC_EX_MIB_INFO

    • Description: Additional information about the agent for the MIB (7.1.1.16).
    • Definition in INI file: No

  • UC_EX_MIB_MONITORING

    • Description: Indicates whether the availability of the agent is monitored.

    • Allowed values: 0 and 1, where

      • 0 = the availability of the agent is not monitored.
      • 1 = the availability of the agent is monitored.
    • Definition in INI file: No

  • UC_EX_PATH_BACKUP

    Windows and UNIX Agents only.

    • Description: Directory in which the backup files of the file rollback of Jobs and File Transfers are stored. For more information, see Rollback Page.

      If the directory does not yet exist, it is created when the agent starts.

      Within the backup folder, the files are stored with the following structure /<Client>/<Date>/<RunID>/.

      The backup directory for the filebased rollback is automatically created when you start the agent. This directory is available for Jobs and File Transfers. You can define the path for the backup directory in the agent variable UC_EX_PATH_BACKUP.

      Note: For using the filebased rollback, you need the OS user under which the related Jobs and File Transfers are started, and write access to the backup directory.

    • Default value:

      • (Windows) ..\BACKUP"
      • (UNIX) ../backup
    • Definition in INI file: Yes

  • Agent Variable: UC_EX_PATH_BIN

    • Description: Directory in which the agent is installed. When the agent starts, it checks the value in this variables and terminates if the path is not valid.

    • Allowed values: The path to the working directory can be defined either as a relative or an absolute path. If all agent variables have been defined, you can use one of the two path definition variants.

    • Definition in INI file: Mandatory

  • Agent Variable: UC_EX_PATH_CACHE

    • Description: Directory is used to store client-wide resources.

      In the client-wide resource directory you should clean up unused files yourself.
      The job specific cache will be cleaned up by the Automation Engine system, since its resources will be used by the respective job only.

    • Definition in INI file: Yes

  • Agent Variable: UC_EX_PATH_JOBREPORT

    • Description: Directory in which the agent stores job reports. When the agent starts, it checks this value and terminates if the path is not valid.

      Note: The SAP Agent stores the restart file also in this directory.

    • Definition in INI file: Mandatory

  • Agent Variable: UC_EX_PATH_TEMP

    • Description: Directory in which the agent stores generated jobs on a temporary basis. When the agent starts, it checks this value and terminates if the path is not valid
    • Definition in INI file: Mandatory

  • Agent Variable: UC_EX_PATH_TEMP_IFS

    OS/400 Agents only if IFS is set in the store_key parameter in the INI file. For more information, see Agent OS/400 .

    • Description: IFS directory in which the StatusStore files of File Transfers should be stored.

    • Definition in INI file: Yes

  • Agent Variable: UC_EX_VERSION

    • Description: Version of the agent. The agent retrieves this value automatically.
    • Definition in INI file: No

  • Agent Variable: UC_HOST_CODE

    • Description: Name of the code table of Client 0. The character version that is defined here is used for transporting Jobs to the agent and for the automatic file transfer of the Job report.

    • Default value: UC_CODE

    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_CONN_ABAP

    • Description: Connection object for the ABAP basis that should be used in the Agent object.
    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_CONN_JAVA

    • Description: Connection object for the Java basis that should be used in the Agent object.
    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_CONN_PI

    • Description: Connection object for the Process Integration that should be used in the Agent object.
    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_CONN_SLD

    • Description: Connection object for the Landscape Directory which should be used in the Agent object.
    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_HW

    • Description: Hardware information of the computer. For example, the system type, the number of processors or the processor type. The agent retrieves this value automatically
    • Definition in INI file: No

  • Agent Variable: UC_HOST_JCL_VAR

    • Description: Reference to Includes that are used when the Job is generated. These are generally the following Includes: HEADER.*, TRAILER.* and RESTART.* of Client 0. User-defined Includes can also be used.
    • Definition in INI file: Yes

  • Agent Variable: UC_HOST_SW

    • Description: Operating system of the computer. The agent retrieves this value automatically.
    • Definition in INI file: No

  • Agent Variable: UC_HOST_SW_VERS

    • Description: Version of the operating system. The agent retrieves this value automatically.
    • Definition in INI file: No

  • Agent Variable: UC_SIEBEL_LOGPATH

    • Description: Directory in which the Siebel log files are stored.
    • Definition in INI file: Yes

  • Agent Variable: UC_SIEBEL_SRVRMGR

    • Description: Directory in which the Siebel Server Manager (srvrmgr.exe) is stored.
    • Definition in INI file: Yes

See also: