Version Control & Rollback
Last updated
Last updated
Nected's Version Control feature is a powerful tool that helps users manage and track changes to their rules and workflows. This feature ensures that users can maintain control over their projects, collaborate effectively, and revert to previous versions when necessary. This document provides a detailed guide on accessing and utilizing the Version Control feature in both the rule editor and the workflow editor, along with best practices for maximizing its benefits.
The primary purpose of the Version Control feature is to allow users to manage different versions of their rules and workflows efficiently. It allows users to:
Track changes: Keep a record of modifications across different versions.
Rollback: Revert to previous versions if the current changes are not satisfactory.
Collaborate: Work together with team members through review and commenting functionalities.
Maintain quality: Ensure that only reviewed and approved changes are implemented.
Now, here is how you can control your rule and workflow versions:
To start using the Version Control feature in the rule editor, follow these steps:
Navigate to the Rule Page: Begin by navigating to the rule page where all your created rules are listed.
Select a Rule: Click on any rule you wish to manage. This will open the rule editor.
Access Version Control: In the rule editor, locate the gear icon on the right side, which indicates the settings. Click on the ⏲ button to open the Version Control section next to the settings. This section will provide you with various options to manage your rule versions.
The version would only be available once the rule/workflow is published. Once the rule/workflow is published, you can access the version from the Published tab in the version control section. To roll back a version, the version must not be currently live.
Inside the version control section, there are four tabs: Draft, In Review, Publish, and Archive. Let's see what you can do in these tabs:
The Published tab lists all versions of the rule or workflow that have been published. This tab helps you keep track of all final versions that are currently in use. You can access all published versions, each marked with a version number, Title, description, comments, and timestamp.
In the Published tab, you'll get some options for a specific published version, like these:
Preview: You can just click the preview button to preview the content of any published version. After clicking the "Preview" button, you'll be redirected to a new page where you can preview the published version of the rule.
Rollback: If needed, you can roll back to a previous version. This action will replace the current draft with the content from the selected version. If you click on the rollback button, a popup will appear on the screen, like this:
If you've done the steps mentioned in this popup, then you can simply ignore this popup message, and can click on "Proceed Further". The current version will be reverted to the last Published Version.
Let's say you've 2 Published versions and while working on the 3rd version i.e. editing the 2nd version, if you get anything wrong and you want to revert to the previous version, then you need to roll back your rule to the previous version. You can see all the past published versions from the Published tab of the Version Control section. If you need to revert to a previous version after making some edits:
Navigate to Version Control: Go to the Version Control section in the rule editor.
Select Published Tab: Click on the Published tab to view all published versions.
Preview Previous Version: Identify the previous version (e.g., Version 1) and click the Preview button to review its contents.
Rollback Action: Click the Rollback button. This action replaces the current draft with the content from Version 1, making it the new draft version ready for further edits or publishing.
The Draft tab displays all draft versions of the rule or workflow. This allows you to manage and review ongoing changes before they are finalized.
If you're in the draft tab, you can Publish, Request for Review, and Archive the rule.
The In Review tab shows rules or workflows submitted for review. This is an essential part of the approval process, ensuring that changes are thoroughly vetted before being published.
If the approval flow is disabled, by default the “In Review” tab looks like this:
This message is just to remind you that the approval flow is currently disabled.
Now if you've submitted the rule or workflow in review (irrespective of whether the approval flow is enabled or disabled), then you can see the in-review version in this tab:
Inside the "In review" tab you can perform the different tasks, that you can read from here.
The Archived tab contains versions of the rule or workflow that have been archived. This helps you manage outdated or deprecated versions without losing historical data.
View Archived Versions: See all archived versions, each marked with a version number and timestamp.
Options:
Preview: Preview the content of any archived version.
View Comments: Access comments associated with the archived versions.
By using the Version Control section, users can effectively manage the lifecycle of their rules and workflows, ensuring high-quality outputs and maintaining a clear history of changes. This detailed tracking and review process helps in maintaining robust and reliable workflows and rules within the Nected platform.
