Described Object Changes in Diagrams (Header/Footer Cycle Data)
This is documentation applies to version 19.11.0 and later
Purpose: Discover your options for displaying metadata of your described objects in the context of your diagram
You decide between Always show live data (default setting) or check-in and cycle controlled release of the information (changes toggle) of described objects via your repository policies for modeling.
Always show live data of described objects
The “Always show live” policy is enabled by default. Users viewing the diagram or the Describes Panel will see all changes to described objects that have occurred after the check-in and approval of the diagram.
Review, review date, approval, approval date, endorsement, and endorsement date data in the diagram header and/or footer will reflect their latest cycle.
Changes Toggle
Purpose
Highly regulated companies want to control any changes within their processes via our cycle management. This ensure that viewer users only see content that was approved via an approval cycle in the context of the diagram.
How to enable the changes toggle
Go to repository → policies → modeling, unchecked “Always show live described object data for latest visible versions of Diagrams.”
Behavior
When viewing the latest version of the diagram,
Users with See unapproved permission can toggle between Approved or Checked-in version and Changes version of the metadata of the described object via the changes toggle
Users without See unapproved permission or with Viewer license assignment will always see the data at the time of the last check-in and successful approval run.
If the toggle is set to the orange CHANGES, it shows the live data of the described objects. However, it will not show the latest cycle information in the header and/or footer because this version was not yet checked-in and approved. You will see No or N/A.
Example: Changes toggle is set to show the approved version (green) → If cycle information is available, it will be displayed. Here, the diagram did not go through an endorsement cycle, so the header shows the dates for Review and Approval but not for the Endorsement cycle.
Changes toggles is set to CHANGES → Cycle information is not shown, instead we show “No” for cycle state and “N/A” for the cycle completion date.
Find more information what events trigger the changes toggle:
https://doc.igrafx.com/doc/what-makes-the-diagram-changes-toggle-appear
Next steps to promote the changes to the diagram and production
Check out the diagram (no additional changes necessary to the diagram are needed) and check-in the diagram - this saves the changes in the diagram. Now all users with See unapproved content will see the diagram without a changes toggle.
When you are ready to promote the changes to production, you would run another approval cycle after the check-in and complete it. This makes the diagram and the changes visible to all users without See unapproved permission.