Audit Trails

In this section:

Account Admin - My Control Panel - Audit Trail for admin users page

You can use the Audit Trails page to view system actions by users and resources.

This includes Controlant Platform (SCM)'s automatic actions, e.g., automatically closed shipments.

Note

Access to audit trails depends on your access permissions:

Normal/ Elevated users can view their own actions in the Controlant Platform (SCM)
Admin users can trace system actions by users and resources, including automatic actions, e.g., automatically closed shipments.

Audit trails for admin users

A record of all actions that have been performed by any user in the Controlant Platform (SCM).

For more details about an audit record, in the Audit record table, click the Audit record. In the Information sidebar, the audit record opens.

Note

Access to audit trails depends on your access permissions:

Normal/ Elevated users can view their own actions in the Controlant Platform (SCM)
Admin users can trace system actions by users and resources, including automatic actions, e.g., automatically closed shipments.

Audit trails for admin users page description

You can use filters to control what data appears in the Audit trails table.

Table 3. Audit trails filters description

Item	Description
Username	Username of user. You can filter for actions performed by this user.
Date	Date range. You can filter for actions performed in this date range: Today Yesterday Last 7 days Last 30 days This month Last month Custom - you can select a date range using the date picker Default is Last 7 days.
Category	Category of action. You can filter for actions in this category. Login - user logged in Role - role was created, modified or deleted User - user was modified, e.g. user rights updated or role assigned Multiple - more than one of the above
ID / Reference	ID or reference of user or resource. Note You need to select the category before typing the ID / Reference.
Clear filters	Click to clear all filters. Tip To update the audit trails table, you may need to set a date filter and click Search.
	You can use the selector to manage the columns in the table below; show or hide individual columns, or change their order. Username Date Action Category Resource ID Description Note Changes you make will be preserved next time you log in. Tip To hide a column, click to clear the text box next to the column name. To show a column, click to select the text box next to the column name. To reorder columns, click next to the column name and drag up or down.
	Click to apply the filter with the supplied criteria.

The Audit trails table shows all records in the Audit trail, filtered via the criteria defined in the filters above.

Table 4. Audit trails table description

Item	Description
Username	Username of user that performed the action.
Date	Date action was performed, in `YYYY-MM-DD, hh:MM a` format.
Action	Action that was performed: Success - login was successful `[correct? something else can be successful?]` Created - item was created Updated - item was updated Deleted - item was deleted Multiple - more than one of the above applies
Category	Category of action. Example categories: Login - user logged in Role - role was created, modified or deleted User - user was modified, e.g. user rights updated or role assigned Multiple - more than one of the above applies
Resource ID	ID of resource.
Description	Description of action. Examples: Successful login User setting updated Role created

Audit trails for non-admin users

Account Admin - My Control Panel - Audit Trail for non-admin users page

A record of all actions that have been performed by you in the Controlant Platform (SCM).

For more details about an audit record, in the Audit record table, click the Audit record. In the Information sidebar, the audit record opens.

Note

Access to audit trails depends on your access permissions:

Normal/ Elevated users can view their own actions in the Controlant Platform (SCM)
Admin users can trace system actions by users and resources, including automatic actions, e.g., automatically closed shipments.

Audit trails for non-admin users page description

You can use filters to control what data appears in the Audit trails table.

Table 5. Audit trails filters description

Item	Description
Username	Username of user. You can filter for actions performed by this user.
Date	Date range. You can filter for actions performed in this date range: Today Yesterday Last 7 days Last 30 days This month Last month Custom - you can select a date range using the date picker Default is Last 7 days.
Category	Category of action. You can filter for actions in this category. Login - user logged in Role - role was created, modified or deleted User - user was modified, e.g. user rights updated or role assigned Multiple - more than one of the above applies
ID / Reference	ID or reference of user or resource. Note You need to select the category before typing the ID / Reference.
Clear filters	Click to clear all filters. Tip To update the audit trails table, you may need to set a date filter and click Search.
	You can use the selector to manage the columns in the table below; show or hide individual columns, or change their order. Username Date Action Category Resource ID Description Note Changes you make will be preserved next time you log in. Tip To hide a column, click to clear the text box next to the column name. To show a column, click to select the text box next to the column name. To reorder columns, click next to the column name and drag up or down.
	Click to apply the filter with the supplied criteria.

The Audit trails table shows all records in the Audit trail, filtered via the criteria defined in the filters above.

Table 6. Audit trails table description

Item	Description
Username	Username of user that performed the action. Note Hidden for non-admin users, as all the records in this page will be performed by you. You can use the Column selector to show the Username column.
Date	Date action was performed, in `YYYY-MM-DD, hh:MM a` format.
Action	Action that was performed: Success - login was successful `[correct? something else can be successful?]` Created - item was created Updated - item was updated Deleted - item was deleted Multiple - more than one of the above applies
Category	Category of action. Example categories: Login - user logged in Role - role was created, modified or deleted User - user was modified, e.g. user rights updated or role assigned Multiple - more than one of the above applies
Resource ID	ID of resource.
Description	Description of action. Examples: Successful login User setting updated Role created

Information sidebar

You can use the Information sidebar to view details about individual audit trail records.

Note

If you want to view full details of an audit trail record, at the bottom of the Information sidebar, click View Details. The Record details appears.

To view details about a record in the Information sidebar, do the following:

In the Audit trail page, click a record.
In the Information sidebar, the record details appear.

Information sidebar description

Table 7. Information sidebar description

Item	Description
General
ID	Unique identifier of the record.
Source	Source of the action.
Description	Description of action.
Performer	Username of user that performed the action.
Performer's E-mail	Email address of user that performed the action.
Reason for change	Reason for the operation, as given by the user when signing the action electronically. Note Blank unless electronic signature was required for this type of action in Controlant Platform (SCM).
Timestamp	Date action was performed, in `YYYY-MM-DD, hh:MM a` format.
Electronic Signature	Unique identifier of electronic signature. Note Blank unless electronic signature was required for this type of action in Controlant Platform (SCM).

Changes
Changes	Lists all changes included in this action. For each item that was changed: Name of item that was changed Id of item that was changed Value of item after the change

Relates to	Note In the action includes multiple steps, you will see all of the following for each step.
Category	Category of action. Example categories: Login - user logged in Role - role was created, modified or deleted User - user was modified, e.g. user rights updated or role assigned Multiple - more than one of the above applies
Action	Action that was performed: Success - login was successful `[correct? something else can be successful?]` Created - item was created Updated - item was updated Deleted - item was deleted Multiple - more than one of the above applies
Reference	Reference of user or entity that performed the action, e.g. username of user.
ID	Unique identifier of of user or entity that performed the action.

View Details	Click to open the Record Details page with full details for this record. For more information, see Record details.

Record details

Records Details page showing details about the selected audit trail record - Account Admin - Audit trail

You can use the Record details page to view details about individual audit trail records.

To view details about a record in the Record details page, do the following:

In the Audit trail page, click a record.
In the Information sidebar, the record details appear.
In the Information sidebar, click View Details.
The Record details page appears.

Record details area

Table 8. Record details area description

Item	Description
Back	Click to return to the Audit trails page.

Record details
ID	Unique identifier of the record.
Source	Source of the action.
Description	Description of action.
Timestamp	Date action was performed, in `YYYY-MM-DD, hh:MM a` format.
Reason for change	Reason for the operation, as given by the user when signing the action electronically. Note Blank unless electronic signature was required for this type of action in Controlant Platform (SCM).
Electronic Signature	Unique identifier of electronic signature. Note Blank unless electronic signature was required for this type of action in Controlant Platform (SCM).

Performer
Name	Name of user that performed the action.
Username	Username of user that performed the action.
User pool	User pool user is in.
E-mail	Email address of user that performed the action.
ID	Unique identifier of the user.
On behalf of	Username of user that action was performed on behalf of.

Metadata	Details about
HTTP Url	HTTP url of the endpoint used to perform the action.
HTTP method	HTTP method the endpoint used.
Trace ID	Trace ID of the action - unique identifier assigned to the transaction.
Correlation ID	Correlation ID of the action - unique identifier assigned to the request.
IP Address	IP address of user who performed the action.

Data Snapshot area

You can use the Data Snapshot to view the request that created the audit record, in JSON format. You can also download the JSON file.

Table 9. Data Snapshot area description

Item	Description
	Click to download the request that created the audit record, in JSON format.
JSON	Request that created the audit record, in JSON format. Tip Right-pointing arrows `🢒` indicate a section has been collapsed. Click the arrow to expand the section.

Changes table

You can use the Changes table to view all items that were changed in this audit record.

Table 10. Changes table description

Item	Description
Changed value	Item that was changed.
From	Value of item before the change.
To	Value of item after the change.

Audit Trails

Note

Audit trails for admin users

Note

Audit trails for admin users page description

Note

Tip

Note

Tip

Audit trails for non-admin users

Note

Audit trails for non-admin users page description

Note

Tip

Note

Tip

Note

Information sidebar

Note

Information sidebar description

Note

Note

Note

Record details

Record details area

Note

Note

Data Snapshot area

Tip

Changes table

Search results