Audit Log

Learn how to find changes made to components, references, and field types by specific users across workspaces, revert changes when needed.

Jacqueline S. avatar
Written by Jacqueline S.
Updated over a week ago

Swiftly identify changes to components, references, component types, reference types, and field types across all your workspaces and asses their impact as positive or negative. Additionally, track changes made to your workspace properties such as a name, description, and more. With Audit log, you can easily trace changes back to the responsible users to foster individual accountability, gain insights into the rationale behind changes, and revert changes back to their previous state when needed.

Table of contents:


What is Audit Log?

Audit log is a record of changes made to the model and metamodel. Currently, you can find changes made to your components, references, component types, reference types, and field types across all workspaces in your organization. Plus, changes made to the workspace properties: name, description, start view, default perspective, and default sort.

  • Model

    • components

    • references

    • workspace properties

  • Metamodel

    • component types

    • reference types

    • field types

How to Find Changes Made to Your Data

Access Audit log from the Preferences menu at the bottom left corner of the screen. Easily find changes made to your data by:

  • Applying filters to narrow down the information in the table

  • Expanding a row to see how your data changed

How to Filter the Audit Log Table

Click the “Filter” button at the top right corner of the screen to open the Filter sidebar. Next, use any of these filters to refine the information displayed in the table:

  • Change type: Choose the type of data to monitor for changes. For all types a dropdown will appear where you can specify a component, reference, component type, reference type, field, or workspace to narrow your search. If you don't select an item from the dropdown, the table will display all changes related to the chosen change type.

  • Workspaces: Choose the workspaces you want to see property changes for or that house the components, references, and field types for which you wish to review changes.

  • Actions: Select the type of change made to your components, references, field types, and workspaces you want to visualize: created, updated, or deleted.

  • Users: Type the name of a particular user(s) to see all changes made to your components, references, field types, and workspace properties by them.

  • Date range: Find changes made to your components, references, field types, and workspace properties within a specific date range by selecting a custom period of time.

How to See What Changed

Each row in the Audit log table represents a change made to your architecture. Currently, you can see who created, updated, and deleted components, references, component types, reference types, field types, and workspaces.

Expand a row in the Audit log table to see more details on what changed, including:

  • The fields components and references were created with

  • The properties field types were created with (API name, applies to all component types, applies to all reference types, component types, options/ default value, reference types, type)

  • The properties workspaces were created with (name, description, start view, default perspective, default sort)

  • The previous and current state for updated components, references, component types, reference types, field types, and workspace properties

  • The fields deleted components and references had

  • The workspace that houses the components, references, and field types

To expand a row, simply click on the arrow next to each row. Clicking on the arrow next to the “Time” column expands and collapses all rows.

How to Revert Changes

Reverting changes is only possible on components and references as long as they have not been deleted. To revert changes:

  1. Expand a component or reference row that has been updated.

  2. Check the “Changed from” column to see the value that you would be restoring.

  3. Click “Restore” to the right of the screen.

To revert component or reference changes to a specific version, look for that specific change in the table. You can use the "Date range" picker in the Filters sidebar to display changes for that specific time frame in which the change was made. Alternatively, navigate the table with the pagination arrows. Next, expand the desired row and select "Restore".

FAQ

  • How extensive is the historical data accessible through Audit Log?

    • It is currently possible to see changes for the last 30 days from the current date.

  • Who can access Audit log?

    • All user roles, except Contributors, can access Audit log. The logs that users can change in the table depend on their workspace permissions.

  • Why can't I see logs for deleted workspaces?

    • Only admin users can see logs for deleted workspaces. When a workspace is deleted, everyone with access loses permissions on that workspace.

  • Why does the “Change by” column show “Unknown” values?

    • Most likely this change was executed automatically by an integration.

  • Can I revert changes for component types, reference types, and workspace properties?

    • Yes. Currently, it is possible to revert changes for components and references as long as they have not been deleted.

  • Can I restore deleted components, references, component types, reference types, field types, and workspaces?

    • No. It is not possible to revert the deletion of any type of data.

  • What happens if another person modifies the component or reference I'm currently editing before I save my changes?

    • Audit log will capture and display both sets of changes. The modification that was saved first will initially appear in the log, but once the second change is saved, it will be placed above the first, effectively positioning the first change below the most recent one.

Did this answer your question?