process studio - workflows - save/publish, versioning and history management

  • Updated

Overview

Workflows templates include a versioning system that allows technical admins to track changes, prevent data loss, and revert configurations safely. This system relies on autosaves, manual checkpoints, and published versions to maintain template stability and operational continuity.

 

Technical Considerations and Limitations

  • Execution Lifecycle: Every execution runs the version it was created from for its entire life. Publishing a new version does not migrate or affect executions that are already running.
  • Starting Rule Activation: The starting rule does not listen for events until the template is published. A draft template does not trigger any executions regardless of system events.
  • Template Deletion: Templates cannot be deleted to ensure execution history remains intact. Unpublishing is the only method to retire a template.
  • Node-Level Validation: Individual nodes carry a Draft badge if configuration is missing. A template cannot be published if any node retains a Draft badge.

 

Key Components

Autosave

The system automatically saves the template during configuration.

  • Autosave triggers when adding or deleting nodes and when creating or removing connections.
  • Autosave maintains only the latest working draft and creates no checkpoints or versions.

 

Checkpoints

Checkpoints are manual snapshots capturing nodes, connections, configurations, timestamps, and creator information.

  • Checkpoints act as restore points for stable states.
  • Checkpoints are not published workflows.

 

Published Versions

Published versions are validated and fully configured templates that are active in the system.

  • The last published version remains live and continues producing executions while a new draft is being configured.

 

Required Permissions

  • Administrator permissions to access Control Center > Process Studio > Workflows.

 

Configuration Steps

To do the configurations, navigate to Control Center and select Process Studio -> Workflows.

Create a Checkpoint

Create checkpoints to save stable template states before significant configuration changes. Follow these steps to create one:

  1. Open the workflow in the editor.
  2. Click the chevron icon next to the PUBLISH button in the upper-right corner.
  3. Select Save as Checkpoint.

 

Publish a Workflow Template

Publishing activates the template and its starting rule. Follow these steps to publish it:

  1. Click the chevron icon next to the PUBLISH button in the upper-right corner.
  2. Select Publish Template.


 

Unpublish a Workflow Template

Unpublishing stops new executions from generating without affecting current executions. Follow these steps to unpublish it:

  1. Navigate to the templates list view.
  2. Identify the workflow template and check the box right side next to its name.
  3. In the top grid menu select DEACTIVATE.


 

 

View History and Preview Versions

The Version History panel provides chronological access to checkpoints and published versions.

  1. Click the chevron icon next to the PUBLISH button.
  2. Select See Version History.
  3. Locate the desired checkpoint or published version.
  4. Click PREVIEW to view the read-only configuration.
  5. Click EXIT to close the preview.


 

Restore a Previous Version

Restoring reverts the draft to a previously saved state without publishing, creating executions, activating listeners, or removing other versions.

  1. Open See Version History.
  2. Locate the version to restore.
  3. Click the restore icon, or click PREVIEW and then click RESTORE.
  4. Click YES, RESTORE to confirm.


 

 

Validation

  • When a checkpoint is created, the system displays The Checkpoint was created successfully message.   
  • When a template is published, the Version History displays the version number and a Published status.

 

Troubleshooting

  • Problem: The template fails to publish. 
  • Symptoms: An error badge appears next to the PUBLISH button, and affected elements are outlined in red. 
  • Possible Causes: One or more nodes are incomplete and carry a Draft badge. 
  • Resolution Steps: Complete the missing configurations on all highlighted nodes before attempting to publish again.