Audit Trail

The agreement audit trail provides a history of the lifecycle changes made to an agreement. For each recorded event you can see when it happened, what kind of change it was, where it came from, who performed it, and, for edits, a plain-language summary of exactly which settings changed.

The audit trail is read-only. It is recorded automatically in the background, so no setup or manual logging is required. You cannot edit or delete entries from the user interface.

The audit trail is kept per agreement. You view the history of one agreement at a time from that agreement's own page.

Typical uses:
  • Confirming who last changed an agreement, and what they changed
  • Understanding why an agreement is no longer active
  • Tracing whether a change came from a user in the interface or from an automated process such as Mapper tool
  • Reviewing the change history during troubleshooting or an internal audit

View the audit trail of an agreement

  1. Open the Enterprise Collaborator Agreements page.
  2. Select the agreement to review to open its detail page.
  3. Click the Audit Trail tab.

    The list shows the most recent event first.

Note: The Audit Trail tab is displayed when the audit trail is enabled for your environment.

See the Enable and disable the audit trail section.

Information displayed for each event

This table shows the information displayed for each event:
Column Description
Date & Time When the event was recorded, displayed in your local date and time format.
Action The type of event: CREATE, UPDATE, ACTIVATE, or DEACTIVATE.
Change Details For an update, a summary of what changed. One line per change. This is blank for create, activate, and deactivate events because the action itself already describes what happened.
Source Where the change originated.

See the Sources section.
Performed By The name of the user who performed the action. Shows System when the action was performed automatically by IEC rather than by a signed-in user.

Recorded actions

This table shows the actions that are recorded:
Action Recorded when
CREATE A new agreement is created.
UPDATE An existing agreement is saved with at least one actual change. Saving an agreement without changing anything does not create an entry.
ACTIVATE An agreement is activated.
DEACTIVATE An agreement is deactivated, either manually or automatically by IEC.

Sources

The Source column identifies which part of IEC the change came from.

This table shows the values that are displayed in this column:
Source Description
AgreementUI The change was made in Partner Admin by a user.
ECAdminUI The agreement was enabled or disabled from the Enterprise Collaborator Administration page in the Grid Management Pages.
ACM The agreement was created by ACM through import.
Mapper The agreement was created or updated automatically when a custom BOD mapping was published.

Change details

For UPDATE events, the Change Details column describes each change in plain language. When several things change in one save, each change is listed on its own line. Point to the cell to see the full text if it is longer than the column.

Change Details covers changes such as:
  • The agreement name and version
  • Process steps added, removed, or reordered in the standard and error processes
  • Settings changed within a process step
  • Detection targets and detection target groups added, removed, or changed
  • Agreement properties and control properties added, changed, cleared, or removed
Example: 
Agreement name changed from "New_Agreement_1" to "New_Agreement_2"
Version changed from "1.1" to "1.2"
Added Standard process step: Apply Envelope

Multiple changes in one update:
-Standard process step order changed from [Reorder, XML Transform, Apply Envelope] to [Reorder, Apply Envelope, XML Transform]
-Detection target value changed (Target ID: env:URI) from "test" to "test2"
-Control property Inactive value changed from "true" to "false"

Internal identifiers are deliberately left out of the summaries so that the list stays readable.

Working with the list

The list features:
  • Sorting: Select a column heading to sort by that column. You can sort all columns.
  • Filtering: Specify a value in the filter row under a column heading to narrow the list. For example, filter Action on UPDATE to see only edits, or filter Performed By on a user name.
  • Paging: The list shows 20 events per page. Use the paging controls at the bottom to move between pages.
  • Column width: You can adjust column widths by dragging the column borders.
  • Refresh: The list refreshes automatically after you save the agreement, and whenever you open the audit trail of a different agreement.
This table shows the messages that you may see:
Message Description
Loading audit trail... The history is being retrieved.
No audit trail entries found. No events have been recorded for this agreement yet. This is expected for agreements that existed before the audit trail was enabled, and for agreements that have not been changed since.
Failed to load audit trail. The history could not be retrieved. Retry, and contact your administrator if the message persists.

Enable and disable the audit trail

The audit trail is controlled by a single IEC application property that a Tenant Administrator can change in the Grid Management Pages.

The property audit.trail.enabled enables or disables the audit trail for agreement lifecycle events. By default, this property is enabled.

Behavior when the property is disabled:
  • The Audit Trail tab is not displayed on the agreement page.
  • No new events are recorded from any source.
  • Events that were already recorded are kept. They become visible again as soon as the property is enabled.

Because recording starts only when the audit trail is enabled, the history begins from the point of enablement. Changes made before that are not displayed.