List of Predefined Read Buffer Variables

UC_CAUSE* variables are predefined read buffer variables that retrieve the details of a task. Read buffer variables are stored in the read buffer for future use by other tasks.

The following read buffer variables are predefined by the Automation Engine:

  • UC_CAUSE_NAME

    Retrieves the name of the task

  • UC_CAUSE_NR

    Retrieves the RunID of the task

  • UC_CAUSE_STATE

    Retrieves the status of the task

  • UC_CAUSE_RETCODE

    Retrieves the return code of the task

Notes:

  • Use :READ script statements to retrieve the values of UC_CAUSE* variables.
  • Notification objects (ALARM type) that are set up as a follow-up action include UC_CAUSE* scripts by default to retrieve details of the task that activated the Notification.

Tip: You can also use write script variables to the read buffer, to pass the values to tasks that are activated by a script. For more information, see :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.

See also: