Script Elements for Handling Tasks

You can write scripts to activate or deactivate tasks, retrieve information about tasks and manage other aspects of tasks.

Execute or Deactivate a Task

The following script elements execute or deactivate objects.

• ACTIVATE_UC_OBJECT
  
  Executes an object

• CANCEL_UC_OBJECT
  
  Terminates an active task

• RESTART_UC_OBJECT
  Executes an object again
  See also: Script Elements for Restarting Tasks

• DEACTIVATE_UC_OBJECT
  
  Deactivates a completed task

• SET_SYNC
  
  Executes an action defined in a Sync object

Information about an Activated Task

• SYS_ACT_JP
  
  Determines if a task was activated in a workflow
  
  Predefined variable: &$IN_PROCESSFLOW#

• GET_PUBLISHED_VALUE
  
  Returns the value or PromptSet variable of a task

• GET_UC_OBJECT_NR
  
  Returns the RunID of an activated object

• GET_UC_OBJECT_STATUS
  
  Returns the status of an activated object

• SYS_ACT_HOST
  
  Returns the name of the host

• GET_STATISTIC_DETAIL
  Returns the execution data of an executable object

Information about the Current Task

The following functions retrieve details of the task that the script is written in.

• SYS_ACT_ME_LNR
  Returns the sequence number of the current task

• SYS_ACT_ME_NAME
  Returns the name of the current task

• SYS_ACT_ME_NR
  Returns the RunID of the current task
  Predefined variable: &$RUNID#

• SYS_ACT_ME_TYPE
  Returns the object type of the current task
  Predefined variable: &$OBJECT_TYPE#

• SYS_ACT_PTTYP
  Returns the partner type of the user that a Job is run by
  Predefined variable: &$PARTNER_TYPE#

• SYS_ACT_USERID
  Returns the User ID that a Job is run by from the Login object

Check Object Status

• SYS_ACTIVE_COUNT
  Returns the number of all activated objects

• SYS_STATE_ACTIVE
  Checks if an object has already been activated

• SYS_STATE_JOB_ACTIVE
  Checks if a Job has already been activated

• SYS_STATE_JOBS_IN_GROUP
  Returns the number of Jobs that are registered in a Group

• SYS_STATE_JP_ACTIVE
  Checks if a Workflow has already been activated

• TOGGLE_OBJECT_STATUS
  Stops or starts the automatic processing of several object types

Modify a Task

The following script elements manage workflows and tasks in workflows.

• :ATTACH_SYNC
  
  Assigns a Sync object to a task

• :MODIFY_STATE
  
  Modifies the return code or status text of a job when the job has finished

• MODIFY_TASK
  
  Modifies a task in an active workflow, letting you change a wide variety of task properties

Set or Retrieve Task Start Times

• GET_CONDITION
  
  Returns the earliest start times in a workflow

• :SET_CONDITION
  
  Sets the earliest start time for tasks in a workflow

Task Forecasts

The following script functions create or manage forecasts for tasks.

• FORECAST_TASK
  
  Generates a forecast for a particular active task

• FORECAST_OBJECT
  
  Generates a forecast for a particular object

• DELETE_FORECAST
  
  Removes one or more specific forecasts stored in the Automation Engine database

• AUTOFORECAST
  Calculates forecast data for future activities

Rollback

The following script elements let you roll back tasks or handle tasks after a rollback.

• ROLLBACK_UC_OBJECT
  
  Runs the rollback of a particular task

• RERUN_UC_OBJECT
  Continue a workflow by restarting all child tasks after a rollback

See also:

• Script Elements for Workflows and Tasks in Workflows