Workflows

When an approval request is created, revoked, rejected, or approved, CDA triggers the configured workflow in the Automation Engine in addition to the standard action. If the workflow is not found, an error is logged in the log file.

The workflows are started with the following parameters:

• @global/*

  The global variables, such as the CDA callback URL.

• @approval_request/*

  The system properties of the Approval Request.

• @approval_request/system/approval_token

  A token which is valid for only one request and can be used to approve the approval request without the user having to log in.

• @approval_request/system/reject_token

  A token which is valid for only one request and can be used to reject the approval request without the user having to log in.

• @approval_request/system/revoke_token

  A token which is valid for only one request and can be used to revoke the approval request without the user having to sign in.

• @approval_request/system/approval_url

  The URL to which the POST request for approval/rejection/revocation should be sent.

• @execution/*

  Available execution system properties when an external approval workflow is triggered:

  • /system/id
  • /system/maintype
  • /system/status
  • /system/install_mode
  • /system/start_mode
  • /system/needs_manual_start
  • /system/manual_confirmer
  • /system/process_run_id
  • /system/planned_from
  • /system/actual_from
  • /system/actual_to
  • /system/workflow
  • /system/application
  • /system/deployment_package
  • /system/environment
  • /system/deployment_profile
  • /system/queue
  • /system/queue_run_position
  • "/system/owner
  • "/system/folder

  Example: @execution/system/application

  If the approval request relates to an execution, it contains all properties of the execution. References which point to entities with unique names (for example, application, users, groups, environments, profile, ...) contain the name instead of the id.

Important! The approval/reject/revoke tokens are only available if the request is not approved/rejected/revoked yet. They cannot be imported/exported via the API and work only for one request. The tokens are only generated and sent on new requests. If a request got revoked, rejected, or approved, no further action is possible with the approval request; therefore no tokens are generated.

Note: To access the parameters in the workflows, define a PromptSet with the fields that are needed by your external approval system, and use EXT: expressions to resolve the parameters.

Example:

EXT:@approval_request/system/approval_token