Skip to main content

Veritran Docs

Audit

Audit is a platform service that allows you to obtain a history of updates made to entities in other platform components. It audits business entities (such as users, organizations, business rules or points of interest) depending on the audited component's functionalities. This platform service helps you to keep track of how these entities were modified and who modified them, and to understand how that change impacted on the platform or business.

Some of the platform components that can be audited are Middleware, BRM, IDM, http-to-sql and Workspace. The audited components integrate with Audit's API to store the data that is then displayed in Audit's user interface.

Note

New integrations of Veritran platform components with the Audit API may become available in future releases.

Pre-requisites

You must have login credentials to access Audit. If you don’t have credentials, contact your admin.

Language

Audit’s user interface supports both English and Spanish. The language of the UI depends strictly on your browser's language and cannot be modified from the console itself.

Access Audit

Log in to the SSO page to access Audit. This platform service consists of the Audit Management page, where you can view records of the creation of entities and the changes made to them, obtained from other platform components. See below to learn more.

Audit.gif

When you access Audit, you need to select a start and end date to filter entries. Additionally, you can filter by application, entity type, entity id, source, author, operation type, start day and end day. Click Clear all to delete the filters applied and display every record on the list.

Once you filter entries, the operations are displayed in a list. The list includes one entry for each modification or creation of entities in the platform component, and columns that display the following fields:

audit_open_icon.PNG

Open. Click this icon on any entity record to display a board with details about the entity and the request. Read Entity Details to learn more.

Date Time

Day and time when the operation took place. It displays the local time of the user’s operating system.

Application

Platform component where the operation took place.

Entity Type

Type of entity or profile that was managed, created or modified. This field depends on the different consoles' functionalities.

Entity ID

Identification or name of the entity that was managed, created or modified.

Source

Source (API or web) of the entity's new configuration. API configurations are executed programmatically, whereas web configurations are created through one of the linked consoles’ interfaces or front-end.

Author

User that managed, created or modified the entity.

Operation Type

Type of operation that was executed in the corresponding platform component.

Entity Details

Click Open (drop-down arrow icon) on any entity record to display a board with details about the entity and the request. In this board, you can see two tabs with information: Entity field and Request payload.

  • Entity field: Displays stored information about the entity involved in the request.

  • Request payload: Shows basic information about the request. These fields are fixed and do not vary, regardless of the type of entity that is being audited, except for the body field. This tab shows information like the URL, the client IP, server IP, the HTTP method, a body with specific data about the request you are viewing, and a caller that requested the petition.

There is a quick copy shortcut for each value in this board. Hover the cursor over the field you want to copy, and click Copy to clipboard, as shown in the image below.

copy-clipboard.png

Note

Audit can only be used for reference purposes. Entities cannot be modified from this interface and records cannot be deleted.