CMT Change Logs |
The Change Log entity is used to track all changes in the system (when Change Control is enabled). For every change, the Change Log records:
• | Who made a change. |
• | When the change was started (Checked Out), and completed (Checked In). |
• | What SDI was changed. |
• | The actual changes made. |
• | Why a change was made |
When making controlled changes, a Change Log event is automatically generated upon SDI Check Out (before any changes are made to the SDI). These Change Log events continue to capture any changes made while the SDI is checked out.
When an SDI is checked out, the following occurs:
• | An SDI Snapshot of the SDIs data in its current state (at the time of Check Out) is taken and stored with the Change Log. |
• | If specified, the Change Log is associated with a Change Request (the Change Log becomes part of the Change Request's group of changes). |
• | The Change Log is included in the Change Log History for the SDI. |
As eligible Users make changes to the checked out SDI, those changes are tracked and associated with the Change Log until the SDI is checked back in. At Check In, a second SDI Snapshot is taken to capture the changes.
At any point during the change control process, you can use these Change Logs (SDI Snapshots) to visualize the original configuration (before any changes were made) and compare that to the current (while changes are in progress or changed) configuration.
Track Changes (Change Logs) |
|
|
To view the generated Change Logs, navigate to Lab Admin → Change Control → Change Logs. The Change Log List page displays.
|
The following information is shown on the Change Log List page:
Column | Description | |||||||||||||||||||||
Change Log ID | The automatically generated Change Log identifier. | |||||||||||||||||||||
Status | The status of the changes.
|
|||||||||||||||||||||
Primary Change Log | If this Change Log is the result of a change to an associated SDI (independently managed SDI), the primary Change Log (SDI on which the independently managed SDI is referenced) is listed here. | |||||||||||||||||||||
![]() |
View Check In icon. This is displayed only after an item has been checked back in. Clicking the icon opens the SDI Viewer showing the SDI Snapshot of the data at the time of Check In.
For information about visualizing SDI Snapshots see the Visualizing SDI Snapshots document.
|
|||||||||||||||||||||
![]() |
View Changes Icon.
This opens the SDI Snapshot comparison view.
Changes made since the original SDI Snapshot are highlighted. See Visualizing SDI Snapshots for more information. |
|||||||||||||||||||||
|
View Change History Icon. This opens the View Change History dialog. | |||||||||||||||||||||
Change Request | The Change Request with which this Change Log has been associated. | |||||||||||||||||||||
SDC | The SDC for which changes are being made (SDC of the SDI that was checked out). | |||||||||||||||||||||
Key | The concatenated key ids (including Property Trees) of the SDI that was checked out.
When checking out a Property Tree the Key indicates whether a specific node (such as Sapphire Custom) or the full Property Tree (from the list page) has been checked out. |
|||||||||||||||||||||
Checked In by | The User who checked in the SDI. | |||||||||||||||||||||
When | The date on which the SDI was checked back in. This is the date on which the final SDI Snapshot was taken.
Display dates in a relative date format such as "2 days ago". See Date Format Policy for information about defining Relative Date Formats. |
|||||||||||||||||||||
Checked Out To | The User or Department to whom the SDI was checked out. | |||||||||||||||||||||
When | The date on which the SDI was checked out. | |||||||||||||||||||||
Check In Comments | Comments associated with SDI Check In. | |||||||||||||||||||||
From Transfer |
If the Change Log was generated as the result of an Import, the from transfer icon is displayed in the "From Transfer" column.
Clicking the From Transfer icon opens the Edit Transferlog page where you can view details of the transfer. See CMT Transfer for more information about Importing a transfer package. |
Managing Change Logs |
|
|
The following sections detail the operations available from the Change Log List page.
View |
"View" opens the Change Log.
|
Field | Description |
Change Log ID | The automatically generated Change Log identifier. |
Change Request | The Change Request with which this Change Log is associated. |
Status | The status of the changes (Change Log status). |
Type | The type of Change Log.
A Primary Change Log is generated for an SDI that is checked out. An Associated Change Log is generated for any SDI referenced on the SDI, but not checked out directly. |
Reason | Text to describe the reason for the change. |
Link SDC
Link Keyid1 Link Keyid2 Link Keyid3 |
SDC and keyid to identify the SDI for which this Change Log was generated. |
Property Tree Node | The Property Tree node for which this Change Log was generated. |
Primary Change Log | When the Change Log Type is Associated, the Primary Change Log is listed here. |
Checked Out Date | The Date the SDI was checked out. |
Checked Out by User
Checked Out by Department |
The User or Department to whom the SDI was Checked Out. |
Checked In By
Checked In Date |
The User who checked the SDI back in.
The date the SDI was checked back in. |
Notes | Notes associated with the Change Log. |
Rolled Back By
Rolled Back Date |
The User who initiated an Undo Check Out (after some changes were made).
See Undo Check Out for more information.
The date Undo Check Out was performed. |
Check In |
Lets you Check In any Change Logs (you are checking in the associated SDIs) checked out to you. See Check Out/Check In for detailed information about checking in an SDI.
![]() |
Compare Changes |
Lets you compare the changes made between two Change Logs (change sessions). Only two Change Logs can be compared at a time, each must be for the same SDC.
When comparing Property Tree SDIs, both entries must be of the same mode. For example, you cannot compare a Change Log for a single node to a Change Log for the entire Property Tree.
Clicking "Compare Changes" opens the Snapshot Viewer. See Visualizing SDI Snapshots for detailed information about the Compare Changes SDI Snapshot.
![]() |
Edit Change Request |
Lets you easily manage the Change Logs (changes) associated with a given Change Request.
Choose to:
• | Change an already assigned Change Request to a different Change Request. |
• | Add a Change Request when not previously assigned. |
• | Remove a Change Request association (Change Log will have no assigned Change Request). |
Select one or more Change Logs and click "Edit Change Request". The Select Change Request dialog displays.
|
Using the lookup, choose the preferred Change Request and click "OK". The Change Log is now associated with the new Change Request. Leaving the Change Request empty removes the Change Log from the Change Request (the Change Log is no longer associated with a Change Request).
Transfer (Import/Export) Change Logs |
|
|
Using CMT Transfer, you can easily Export all changes made within a Check Out/Check In session (captured in the Change Log). Select one or more Change Log(s) and click "Export". This initiates the Export Wizard. See CMT Transfer → Export for more detailed information.