This article provides an overview of the workflow versioning system in GelatoConnect, detailing how it allows users to modify workflows without impacting live orders. It covers the process of accessing, editing, and publishing workflows, as well as the benefits of using this feature.
Understanding Workflow Versioning
Workflow versioning is a feature that automatically generates a new draft version of a workflow whenever you begin editing it. This ensures that any modifications you make do not immediately affect live orders that are currently being processed by the published version of the workflow. You can work on the draft confidently and publish it only when you are ready.
Accessing and Editing Workflows
You can access and edit a workflow in two ways:
From the Manage Orders Page: If a specific order has gone through a workflow, you can find the workflow name in the order details. Clicking on the workflow name will direct you to the workflow editor, where you can view its execution history.
From the Workflows Page: Navigate directly to the "Workflows" page and select the workflow you wish to edit.
Making Changes and Managing Drafts
When you open a published workflow for editing, the system automatically creates a new draft version.
Draft Status: A "Draft" status will appear at the top of the workflow editor, indicating that any changes made will not affect the published version.
Workflow Versions: At the top right of the editor, you will find a "Workflow Versions" button. Clicking this will display a list of all versions of your workflow, including the published one and any active drafts.
Saving Changes: You can save changes to your draft at any time, and these changes will be stored in the draft version.
Publishing a New Version
Once you have finalized your changes and are ready to apply them to new orders, you can publish the new draft.
Publish Button: Click the "Publish" button at the top right of the editor.
Confirmation: The system will confirm that the new version has been published.
Live Orders: All new orders that meet the workflow's criteria will now utilize this newly published version.
Reprocessing Failed Executions
If you have failed orders that you wish to reprocess with your new workflow version, the system will prompt you with a message: "Review failed executions below to reprocess with a new version." This feature allows you to rerun those failed orders using the corrected workflow.
Conflict in Attributes When Publishing
If you try to publish a workflow and see a message that there is a conflict in the attributes, it means that another workflow is already configured for the same product model with the same attribute settings.
For example, if Workflow 1 is configured for white mugs and 11oz mugs, you cannot create Workflow 2 with the same configuration (white mugs and 11oz mugs) and publish it. This conflict prevents multiple workflows from defining the same product model in the system.
Restoring to a Previous Version
If you make changes that you no longer wish to keep, or if you need to revert to a previous working version, you can restore an earlier version of the workflow.
View All Versions: Click the "Workflow Versions" button at the top right.
Select a Previous Version: Choose the version you want to restore from the list.
View-Only Mode: The system will indicate that you are viewing an old version and that editing is disabled.
Restore: Click the "Restore this version" button. The system will create a new draft based on this old version.
Publish: You can then review the new draft and publish it to make it the active version.
Benefits of Workflow Versioning
Safety: You can make and test changes to your workflows without the risk of impacting live orders in the system.
Flexibility: You can work on multiple changes or test different ideas in a draft without committing to them.
Rollback: You can easily revert to a previous, stable version of your workflow if a new version does not perform as expected.
Workflow versioning provides the assurance to continuously improve and optimize your production processes without the fear of unintended consequences.