You can create two types of audit reports using Data Studio:
- sessions - who accessed the system and when.
- events - what actions were taken and when.
Audit reports can be useful for compliance and troubleshooting.
Audit reports are restricted to admins, installation managers or anyone with the ability to edit user details.
Audit sessions report
The sessions report contains a record of every time a user accesses the system in the selected time period:
- SessionId
- UserId
- UserName
- EnvironmentName
- Session StartDate (and time)
- Session EndDate (and time)
Audit events report
This report records all the actions (events) that either the system or user took in the selected time period. Each event includes the following detail:
- EnvironmentName
- SpaceName
- UserId
- UserName
- EventType
- Operation
- EventDate (and time)
- Message (contains full details of the event, i.e. what was changed)
- TargetObjectType
- TargetObjectName
- ParentEventType
- ParentEventOperation
- ParentEventDate
- ParentEventMessage
- SessionId
- EventId
- TargetObjectId
- TargetObjectUuid
For example, an event can be: a Workflow created, modified, executed or published; a JDBC query approved; a new user added or deleted; metadata exported and so on.
Download audit reports
To download the report as a .csv file:
- Click on the user icon in the top menu and choose Download audit report.
- Select the Report type.
- Choose all or a specific Environment.
- Enter the number of days you'd like to see the historic data for.
Time period
The default time period that audit data will be retained for is 90 days. To change this, go to the Manage Environments page and edit the selected Environment settings.
Audit report API
Audit data can also be accessed using the Data Studio API. In this case, an API key needs to be created with the Audit operations permissions. Find out more.
