logo
logo

Raw audit log

The Raw audit log is available under Manage.

The raw audit log provides an audit trail.

This can be downloaded in JSON format, with a timestamp to and from filter.

Once completed, click on Download. There is a message informing that the download job is queued and to view this job in Downloads.

The Downloads can be accessed from the Profile and Settings menu.

To download the raw audit log file, click the Download .

The JSON download uses name-value pairs, with the keys being as follows:

  • EventType

  • MessageId

  • UserName

  • AuditType

  • EventType

  • Severity

  • TargetDefinition

  • TargetId

  • TargetIdentifier

  • Timestamp

  • UserId

  • Modified

This structure is replicated in the JSON file:

Audit trail

The product's audit trail captures all events that occur on entities. This data is stored in a specific Elasticsearch index.

The audit trail will register the following main event types:

  • Entity Created
  • Entity Updated
  • Entity Deleted

Since all objects within the platform are stored as Entities, actions, such as: assets being uploaded, updated, deleted; individual files that have been downloaded by a user; download order handling; user management; annotations being added; status changes, and so on, are captured.

The following columns exist in the audit trail table:

  • Message ID: ID of the entry action (primary key).
  • Target ID: Entity ID involved in the operation.

  • EventType: Keyword of action performed (EntityCreated, EntityUpdated, EntityDeleted).

  • UserId: Entity ID of the user triggering the action.

  • UserName: Name of the user triggering the action.
  • Data: JSON structure containing detailed information on the action performed.
  • TimeStamp: Date/time when the action was executed (UTC time).

Example Data values for the creation of an entity (EntityCreated):

The action is logged after the creation is successful. There may, however, be processing that is done post logging. The following is a JSON piece that one can find in the audit log when creating an entity. Note that it includes the definition of the entity that was created, the properties that were modified, and the relations that were modified.

{
  "culture": "",
  "name": null,
  "definition": "User",
  "property_changes": [
    {
      "property": "Description",
      "data_type": "System.String",
      "value": {
        "en-US": {
          "original": "<p>before</p>",
          "new": "<p>after</p>"
        }
      }
    },
    {
      "property": "FileName",
      "data_type": "System.String",
      "value": {
        "original": "old",
        "new": "new"
      }
    }
  ],
  "relation_changes": [
    {
      "relation": "UserGroupToUser",
      "role": "Child",
      "definition": "UserGroup",
      "added_values": [
        {
          "id": 2,
          "name": null
        },
        {
          "id": 5714,
          "name": null
        }
      ],
      "removed_values": []
    }
  ]
}

Multi-culture support

For multi-culture properties, the property changes' value is a dictionary with the culture name as keys and the changed content as values. The following is an example of a multi-culture property:

{
  "property_changes": [
    {
      "property": "Description",
      "data_type": "System.String",
      "value": {
        "en-US": {
          "original": "<p>before</p>",
          "new": "<p>after</p>"
        }
      }
    }
  ]
}

Can we improve this article ? Provide feedback