List of System Properties

The following variables represent values that are consistent throughout the system. They can be used in any executable object.

Notes:

  • The Variable name is the technical name of the predefined variable. It will be replaced by the corresponding value at runtime.

  • The Security level is defined by using the setting VAR_SECURITY_LEVEL in the UC_SYSTEM_SETTINGS variable. This setting determines whether the variables of SQL statements are replaced by dynamic Variable objects and, if so, which ones. For more information, see VAR_SECURITY_LEVEL.

  • The security level is always 1 if the value of the predefined variable refers to a script function. Security level 1 should also be assigned if the value is derived from an attribute that the user cannot directly influence using the script element :PUT_ATT.

    Example

    Attribute: ACCOUNT, Variable: &$ACCOUNT#

    Variables for attributes that can be modified at runtime (and therefore pose a security risk) correspond to security level 2.

    Example

    Attribute: HOST, variable &$AGENT#

Properties

  • Name: Automation Engine system (language)
    Variable name: &$SYS_LANGUAGE#
    Description: Supplies the language in which the Server generates the log files
    Script element: SYS_USER_LANGUAGE
    Security level: 1

  • Name: Automation Engine system (name)
    Variable name: &$SYSTEM#
    Description: Retrieves the name of the Automation Engine system
    Script element: GET_UC_SYSTEM_NAME
    Security level: 1

  • Name: Client
    Variable name: &$CLIENT#
    Description: Returns the number of the current client
    Script element: SYS_ACT_CLIENT, SYS_USER_CLIENT
    Security level: 1

  • Name: Client title
    Variable name: &$CLIENT_DESC#
    Description: Returns the text of the current client
    Script element: SYS_ACT_CLIENT_TEXT
    Security level: 1

  • Name: Current date
    Variable name: &$PHYS_DATE_format#
    Description: Retrieves the current date
    Script element: SYS_DATE_PHYSICAL
    Security level: 1

  • Name: Current time
    Variable name: &$PHYS_TIME_format#
    Description: Determines the current time of day
    Important!
    The behavior of the variable &$PHYS_TIME_format# differs from the script function SYS_TIME_PHYSICAL. Calling this script function several times can result in different time values (depending on the time of the call). The value of the predefined variable is set during its generation and remains constant for the complete execution.
    Script element: SYS_TIME
    Security level: 1

  • Name: SNMP Connection
    Variable Name: &$SNMP_ACTIVE#
    Description: Checks if the SNMP connection of the AE is active
    Script element: SYS_SNMP_ACTIVE
    Security level: 1

  • Name: User (department)
    Variable Name: &$DEPARTMENT#
    Description: Supplies the department of the user who has started the task
    Script element: SYS_USER_DEP
    Security level: 1

  • Name: User (object activator)
    Variable Name:&$USER#
    Description: Supplies the name of the user who has started the task
    Note:
    The user who is currently logged on is used for the preview if this variable is used in the SQL statements of a Variable object. This behavior also applies to the variables &$DEPARTMENT# and &USER_FL#. Whether the predefined variables are triggered will depend, however, on the security settings.
    Script element: SYS_USER_NAME
    Security level: 1

  • Name: User (first and last name)
    Variable Name: &$USER_FL#
    Description: Supplies the first and last name of the user who has started the task
    Script element: SYS_USER_LNAME
    Security level: 1

  • Name: Task-specific cache path
    Variable Name: &$AGENT_RESOURCES_TASK#
    Description: Value represents the task-specific cache path
    Important!
    :ATTACH_RES is available on UNIX or Windows.
    Script element: :ATTACH_RES
    Security level: N/A

  • Name: Client-wide cache path
    Variable Name: &$AGENT_RESOURCES_CLIENT#
    Description: Value represents the client-specific cache path
    Important!
    :ATTACH_RES is available on UNIX or Windows.
    Script element: :ATTACH_RES
    Security level: N/A

See also: