Welcome to Zuora Product Documentation

Explore our rich library of product information

Workflow versioning overview

An introduction of the versions of a workflow definition.

You can view the versions of a workflow definition on the Versions tab. Click a workflow to open it, and then click the Versions tab. The information for each version is displayed in a table.

Workflow versions are either in the active or inactive status, which is indicated in the Version Status field.

  • Active - The active version is loaded by default on the Workflow tab when you open this workflow. The active version cannot be edited. It can be run manually, with event triggers, or on schedule. It is indicated with an Active label in the workflow definition name. Only one version can be set as the active version for a workflow definition.

  • Inactive - The inactive version can only be accessed on the Versions tab for a workflow. The inactive version can be edited and run manually as a development version for test. The Workflow Name and Workflow Triggers fields on the Settings tab for the inactive version are not editable. Except for the active version, all other versions of a workflow definition are inactive versions. It is indicated with an Inactive label in the workflow version name.

Note:
  • The first version created with the workflow definition is always inactive.

  • The Last Run Date for a workflow is determined by its versions. If the active workflow version has a recorded last run, its UTC time is used. If the active version has no recorded run, the UTC time from the inactive version's last run is used instead. If neither version has a recorded run, the Last Run Date will be blank.

Workflow version page

The following actions are available for each version. Click the menu icon to access these actions.

  • Run - Manually run the selected workflow version.

  • Edit - Open and edit the selected version for the workflow definition. The active version is not editable.

  • Export - Export the logic and configurations of a selected version of workflow as a JSON file. See Export a specific version of a workflow for details.

  • Metrics - Display the task and workflow usage metrics for the selected version.

  • Set Active - Set the selected version as the active version. See Set a workflow version as the active version for details.

  • Delete Previous Versions - Delete the previous versions prior to the selected version. See Delete workflow versions for details.

  • Delete - Delete the selected workflow version. The active version cannot be deleted. See Delete workflow versions for details.