History
This tab allows users to track changes of the process definition. This includes detailed information about who made each change, when it was made, and the specific modifications.
Availability
- This functionality is accessible within the settings for both Workflows and CMS entities
- Only Admin users have access to use this feature.
The feature tracks changes in the following areas:
- Process Entity Settings:
- "Basic Info"
- "Properties"
- "Tasks"
- "Highlighted Properties"
- "Quickstart Settings"
- CMS Entity Settings:
- "Basic Info"
- "Properties"
- "Highlighted Properties"
- "Highlighted Referrals"
Example: How it works
You are editing a workflow with an email-sending node and want to update the fields "From Name" and "From Email"
.
After making and saving the changes:
- Navigate to the "History" tab to review the modifications.
- The following details will be displayed:
- Time and Author of the "Actual" version (1).
- The "Actual" version (latest, uneditable version used for comparison) highlighted with a red background (2).
- The modified version with changes highlighted in green, indicating additions or resolved settings (3).
- A "Show More" button to expand the viewer if additional changes are present (4).
- A scrollable viewer for faster navigation to changed areas (5).
Comparing Versions
You can compare the current version with any previous changes on the timeline:
- The left dropdown displays the "Actual version" (latest version). This dropdown is disabled to ensure it cannot be modified.
- The right dropdown allows selection of any prior modified versions for comparison.
To view a comparison:
- Select a modified version from the right dropdown and choose one of them
After we choose we can see the green area on the right JSON and scroll it
The changes will be displayed in the viewer, with areas added or modified shown in green (2).
Here we can see what the new "Entity" property was added with the name "Contact" with read/write groups permissions for the "Hyper Users" and "Hyper Admins"
This feature provides a way to track and display version-specific information for process definitions. It allows Admins to add, and manage release notes associated with process versions, helping ensure clarity about changes and their availability in the versions for the end users.
Release notes with rich text formatting
- Users can add release notes when saving a new version of a process definition.
- The release notes support rich text formatting and multilingual content.
Optional or Required Notes
A toggle in the process settings allows administrators to make release notes mandatory for every process version release.
If the "Require Release Notes" setting is enabled, making changes to tasks and then clicking the "Save" button will trigger a popup prompting you to add a release note. This ensures that every process version is accompanied by a detailed note describing the changes made.
Version Information on Process Detail Page
A release note icon is displayed in the title bar of the process detail page
Clicking the icon opens a side drawer showing release notes: This side drawer shows all the most recent process release notes, and those from the future releases past the current.
