Audit Log

Prev

The Audit Log records actions taken in Hyperscience, such as settings changes, downloads, model training, flow deployments, and user sessions, along with who performed each action and when. System Administrators use it to review a detailed history of activity in the system.

Required permissions

By default, only members of the System Admin Permission Group can open the Audit Log. If you need access, contact a system administrator. To learn more, see Managing Permission Groups.

Open the Audit Log

Click Administration, and then click the Audit Log tab.

You can also retrieve Audit Log data through the API. To learn more, see the API documentation.

The Audit Log table

The table lists one row per activity, newest first. Click the Created column header to reverse the sort order.

Column

Description

Activity ID

The ID number of the recorded action. Click an ID to see the full record. See Data recorded for each activity.

Created

The date and time the activity was recorded.

Activity Name

The type of action performed. See Activities recorded in the Audit Log.

Sub Activity Name

How the action was performed, when the activity can be performed in more than one way. For example, when Activity Name is Add New Layout, this column shows whether the layout was created new or uploaded. Empty for activities that have no subtype.

Username

The user who performed the activity. Empty when the operator was the machine.

The count above the table shows how many activities match the current filters.

Filter and search the Audit Log

By default, the table shows only activities created today. To see earlier activities, change or clear the date range at the top of the page.

Click Filters to filter by activity name, operator (human or machine), or username. You can combine these filters. The Username filter is not shown while Operator is set to Machine.

To find a specific activity, enter its activity ID in the search box.

The Audit Log table with the Filters panel open, showing the activity name, operator, and username filters.

Export Audit Log data

To download the Audit Log as a CSV file, click Download filtered activities on the right side of the page. The export contains only the rows that match the current filters, including the date range. If you clear the date range and all other filters, the button reads Download all activities and the export contains every record in the Audit Log.

The file is prepared in the background. When it is ready, a download link appears in the Notifications menu.

Each row in the CSV file contains the data described in Data recorded for each activity, with activity names and subtypes in their system (database) form. The filters used for the export are included in the file.

Downloading the Audit Log is itself recorded in the Audit Log, as a Download or Prep CSV Download activity with the subtype Audit Log Table.

Data recorded for each activity

Click an activity's ID in the Audit Log table to open the activity's full record. Fields that do not apply to the activity show --.

Field

Description

ID

The system-generated numeric ID for the recorded activity.

Activity Created

The date and time the activity was recorded.

Operator

Whether the activity was performed by the machine or by a human.

Username

When Operator is Human, the username of the user who performed the activity.

Activity Display Name

The human-readable activity name. This is the value listed in Activities recorded in the Audit Log.

Activity System Name

The name of the activity in the database. This often differs from the display name.

Activity Subtype Display Name

When an activity can be performed in more than one way, the human-readable name of how it was performed. For example, when Activity Display Name is Add New Layout, this field might be Upload Existing.

Activity Subtype System Name

The name of the activity subtype in the database, if applicable.

Extra

Additional details about the activity, if applicable. For example, when Activity Display Name is User Login, this field can contain details about the browser used to log in.

Success

Whether the activity succeeded (true) or failed (false).

Object ID

The ID of the object affected by the activity, if applicable.

Object Type

The type of the object affected by the activity, if applicable.

Object Name

The name of the object affected by the activity, if applicable.

Object Column Changes

For edits to an object, a table of the individual changes. See Change details.

When enhanced audit logging is enabled, the record also includes the request details described in Enhanced audit logging.

Change details

For changes to an object with more than one editable element, the Object Column Changes field contains a table of the individual edits.

Column

Description

Attribute

The element that was edited.

Old Value

The value before the edit.

New Value

The value after the edit.

Enhanced audit logging

Enhanced audit logging adds request-level detail to the Audit Log to support stricter requirements. It is disabled by default. To enable it, set HS_ENHANCED_AUDIT_LOGGING_ENABLED to true in the instance's configuration .env File.

Enhanced audit logging increases the volume of records written to the Audit Log and can affect performance. Enable it only if your compliance requirements call for it.

When enhanced audit logging is enabled:

  • Every activity record includes the request that caused it. The following fields are added to the activity's full record and to CSV exports.

  • Additional requests are recorded as HTTP Request activities, with the HTTP method (for example, GET request) as the subtype: successful GET and DELETE requests that are not already recorded as a specific activity, every request that fails (HTTP status 400 or higher), and every request that ends in an unhandled error. For failed requests, Success is false and Extra contains the status code or the error.

Field

Description

Request Path

The URL path of the request, including any query string.

Request Method

The HTTP method of the request, such as GET or POST.

Request IP Address

The IP address the request came from.

Request Headers

The Origin, User-Agent, Host, and Referer headers of the request. No other headers are recorded.

Two additional variables control where enhanced records are written. Both default to true.

Variable

Description

HS_ENHANCED_AUDIT_LOGGING_TO_DB

Writes enhanced records to the Audit Log in the database.

HS_ENHANCED_AUDIT_LOGGING_TO_STDOUT

Writes enhanced records to the application's standard output (container logs).

In v40, HS_DETAILED_AUDIT_LOGGING_ENABLED was renamed to HS_ENHANCED_AUDIT_LOGGING_ENABLED. If you enabled enhanced audit logging on an earlier version, replace the old variable in your configuration.

Audit Log retention

Hyperscience deletes Audit Log records on a schedule. The schedule is controlled by the Activity Log deletion settings in Administration > System Settings > General. To learn more, see Application Settings Overview.

Setting

Description

Default

Activity Log deletion

Turns scheduled deletion of Audit Log records on or off.

Enabled (v40 and later)

Activity Log deletion policy

How many days after an activity its record is deleted, and the time of day the deletion job starts. The retention period cannot exceed 180 days.

60 days after the activity, starting at 18:00 UTC (shown in your local time)

Activity Log deletion maximum runtime

The longest the deletion job runs in one day. Records that are not deleted within this time are deleted the next time the job runs.

6 hours

Only users with the Access Advanced Administration and Debug Tools permission can turn Activity Log deletion off or set a retention period longer than 180 days. Other System Administrators can shorten the retention period or change the schedule.

Activities recorded in the Audit Log

The following activities are recorded. Activity names in this table match the values in the Activity Name filter, so you can use them as search terms.

Activity Name

Description

Notes

Abandon Tasks

Leave a task without finishing it

Acknowledge License Notification

Acquire Case Token

Receive a token to complete any Supervision tasks related to a case

Acquire Document Token

Receive a token to complete any Supervision tasks related to a document

Acquire Submission Token

Receive a token to complete any Supervision tasks related to a submission

Activate M2M Accounts Within The Local Identity Provider

Activate local identity provider client

Add New Layout

Layout creation/layout import

Add Trainer Checkpoint Chunk

Analytics Flush Buffered Measurements to Main Storage

Analytics Rollup Measurements

Archive Flow

Archive a flow through the application or the API

Archive Identification Model

Archive Layout Group

Artifact Repository Dependency Injection

Assign Layout Release to Workflow

Assign Tags to Layout Group

Auto Model Activation

Bulk assign BlockStorageBinary records to a Workflow

Bulk Delete Authentication Groups

Delete multiple authentication groups

Bulk Delete BlockStorageBinary Records

Delete multiple BlockStorageBinary records

Bulk Delete Flow Runs

Cancel Find Potential Layouts Job

Cancel a Find Potential Layouts job

Cancel Layout Triage Job

Cancel Model Training

Cancel model training tasks

Cancel Submissions

Change Layout Restriction

Change the default Retry Policy

Clean Up Trainer Checkpoints

Complete Training Checkpoint Chunking

Copy Permission Groups

Duplicate a permission group

Count System-of-Record Documents(s)

Create a BlocksStorageBinary record

Create An Access Token Within The Local Identity Provider

Create An M2M Account Within The Local Identity Provider

Create a local identity provider client

Create Artifact Repository

Configure a connection to an S3 bucket or another Hyperscience instance to use it as an artifact repository

Create Candidate Group

Create Clear QA Tasks Job

Create a job that deletes all tasks from the QA Task Queue

Create Dictionary Field

Add a field to the field dictionary

Create Dictionary Field Group

Create a new field group in the field dictionary

Create External Job

Create Flow Engine Definitions

Create Flow Run

Start the execution of a flow

Create Ground Truth

Upload a document in Training Data Management and start the flow execution

Create Knowledge Store Item

Add an item to the Knowledge Store

Create Layout From Potential Layout

Create Layout Release

Create Layout Restriction

Create Metric Definition

Create New Authentication Group

Create an authentication group in the application or on import

Create New Data Type

Create a field data type

Create New Permission Group

Create New Task Restriction

Create a task restriction

Create Notification

Create Submission

Create submissions through the application or API

Create Task Request

Generate a Supervision task (e.g., Manual Transcription)

Create Trainer Failure Report

Create User

Deactivate M2M Accounts Within The Local Identity Provider

Deactivate local identity provider client

Delete An M2M account Within The Local Identity Provider

Delete Artifact Repository

Delete an artifact repository connection

Delete Authentication Group

Delete an authentication group

Delete Candidate Groups

Delete Case Tokens

Release case tokens assigned by users to complete Supervision tasks related to a case

Delete Cases

Delete cases

Delete Dictionary Field

Delete a field from the field dictionary

Delete Dictionary Field Group

Delete a field group from the field dictionary

Delete Document Tokens

Release knowledge worker tokens used by keyers to complete Supervision tasks related to a document

Delete Flow Engine Definitions

Delete Flow Run

Delete Ground Truth

Delete Ground Truth from Training Data Management

Delete Ground Truth Item Tags

Delete Knowledge Store Collection

Delete a collection from the Knowledge Store

Delete Knowledge Store Item

Delete an item from the Knowledge Store

Delete Layout

Delete Layout Release

Delete Layout Restriction

Delete Layout Version Being Used

Delete a layout version

Delete Non-Structured Layout Training Data

Delete Permission Group

Delete a permission group

Delete Permission Groups

Delete permission groups

Delete Potential Layout

Delete Shared Layout Fields

Delete Submission

Delete submissions through the application or API

Delete Submission Tokens

Release knowledge worker tokens used by keyers to complete Supervision tasks related to a submission

Delete System-of-Record Document(s)

Delete Task Restriction

Delete a task restriction

Delete User

Deploy Flow

Deploy a flow through the application or API

Deploy Identification Model

Activate trained candidate model

Deploy Table Identification Model

Download a Table ID model

Deploy Text Classification Model

Deregister Trainer(s)

Detach the trainer or trainers

Django Admin

Access to /admin. For more information, contact your Hyperscience representative.

Document Rejection

Handle document rejection

Download a BinaryKV

Download Artifacts

Export flows, releases, or models

Download Authentication Group

Export an authentication group

Download Auto Threshold Model

Download Block

Download File

Any async download. Async downloads can be accessed from the Notification Center

Async downloads are downloads that can be accessed from the Notification Center.

Download Flow

Export a flow through the application

Download Identification Model

Download a Field Identification model

Download Image

Download a page image

Download Non-Structured Layout Classification Model

Async download of a non-structured layout's Classification Model. Async downloads can be accessed from the Notification Center

Async downloads are downloads that can be accessed from the Notification Center.

Download Non-Structured Layout Classification Model With Training Data

Async download of a non-structured layout's Classification Model and its training data. Async downloads can be accessed from the Notification Center

Async downloads are downloads that can be accessed from the Notification Center.

Download Non-Structured Layout Training Data

Download of a non-Structured layout's training data

Download or Prep CSV Download

Download submission-level CSV, document-level CSV, system throughput CSV, all users performance CSV, or Audit Log CSV

Download or Prep JSON Download

Download or Prep Release Download

Export a release

Download or Prep ZIP Download

Download Permission Group

Export a permission group

Download System Settings

Export system settings

Download Text Classification Model

Download Training Data for Text Classification Model

Drop System-of-Record Collection

Duplicate Flow

Edit An M2M account Within The Local Identity Provider

Edit a local identity provider client

Edit Artifact Repository

Send a request to /api/v5/artifacts/repositories for flows, releases, or models

Edit Authentication Group

Update the authentication group in the application or on import

Edit Blank Candidate Group

Edit Candidate Groups

Edit Case

Edit a case

Edit Case Deletion Date

Edit the deletion date for a case

Edit Data Type

Edit a field data type

Edit Flow Engine Config

Edit Freeform Config

Edit Knowledge Store Items

Edit Layout

Edit Layout Flex Engine Type for Training

Edit Layout Group

Edit Layout Name

Edit layout name

Edit Layout Page

Edit layout page

Edit Layout Page Image

Edit layout page's image

Edit Layout Release

Edit a Release

Edit Layout Submission Processing Deadline

Edit SLA rule for a specific layout

Edit Layout Version

Edit layout version

Edit Permission Group

Update a permission group in the application

Edit Potential Layout

Edit Python Package

Install/uninstall Python packages and manage Command (python_packages.py) levels

Edit System Setting

Edit system settings on the System Settings page and in /admin

Edit Task Restriction

Update a task restriction in the application

Edit The Local Identity Provider Configuration

Local identity provider config edit

Edit User

Edit User Profile

Enable/Disable Transcription Model

Enter Task Queue

Begin working on tasks in the Task Queue

Execute diff for Ground Truth Layout Versions

Export Artifact Key

Export Block Definition

Export BlocksAssetChunk

Export BlocksStorageBinary record

Export Dictionary Field

Export the field dictionary

Export Extraction Jobs

Export Ground Truth Training Data

Export Ground Truth Training Data from TDM

Export Ground Truth Training Data CSV

Export Knowledge Store Collection

Export Layout Version

Export Python Package

Export Python Package Requirements

Export Submissions

Export Submissions Uploaded File

Export Trainer Checkpoint Chunk

Export Trainer Failure Report

Export Translation File

Fail Halted Job

Update a halted job's status to Failed

Field Customization Create

Field Customization Update

Field Identification Model

Flow Synchronisation

Generate Flow Diff

Generate Flow Overrides

Get Features Availability

get layout release stats

Get Reporting Data

Get Task Queue And Assign Tasks

Click a Perform Tasks link in the Task Queue

HTTP Request

A request to the application that was not recorded as a specific activity, or that failed. The subtype is the HTTP method. See Enhanced audit logging.

Recorded only when enhanced audit logging is enabled

Import Dictionary Field

Import a field dictionary

Import Knowledge Store Items

Import items to the Knowledge Store

Import Layout Release

Import Translation File

Insert a single System-of-Record Document

Insert License Key

Install Base Model

Install ORCA Base Model

License Limit Status Change

list layout release fields

Lock Layout Group

Lock Release

Create a release or update a release to have a Locked status

Magic Clone

Copy fields with similar shapes in the Layout Editor

Mark Submission Pages For Clustering

Submit pages for Find Potential Layout

Merge Candidate Groups

Model

Move Pages Between Candidate Groups

Non-Structured Layout Classification Model

Notify Workflow Owners

Open Specific Task

Start working on a specific submission and/or document

Parse CSV for Field Data Type

Upload a CSV to create a data type

Persistent Flow Filter Restriction

Predict Table Cells

Identify a Template row and click Commit and Review to use the copycat.

Prepare Settings Import

Process Trainer Task Result

The trainer sends data to the application

Prune Dashboard Data

Read All Ground Truth Item Tags

Read Clustering Config

Click the Find Layouts button on the Potential Layout Variations page

Read Clustering Jobs

Click Find Potential Layout on the No Layout Variation Found page

Read Ground Truth Item Tags

Read Model Information

Read Notification

Open the Notification panel

Read Submission Transformed Read

Register Trainer

Register the trainer by running bash run.sh trainer from the trainer machine

Reject Identification Model

Reject a candidate model

Remove Document From Case

Remove Out Of Support Python

Remove Page From Case

Remove Pages From Candidate Group

Reprioritize Submission

Update a submission's SLA goal when matched to a layout with an earlier SLA or when manually set in the Task Queue

Reset User Authorization Token

Reset a user-authentication token by user or permission group

Reset User Multi-factor Authentication

Reset User Password

Restore Flow

Restore Flow through the application or the public API

Restore Layout Group

Restore User

Resubmit Submission

Retry submission

Retrieve System-of-Record Document(s)

Retry Find Potential Layouts Job

Retry a Find potential layouts job

Retry Halted Jobs

Retry Halted Submissions In Case

Retry Layout Triage Job

Retry Workflow Job

Return Task And Assign To User

Run Find Potential Layouts Job

Run a Find potential layouts job

Run Layout Triage Job

Run Variation Suggestion Job

Schedule Identification Model Training

Trigger a model training by clicking the Run Training button

Schedule Non-Structured Layout Model Training

Schedule Classification model training

Schedule Submission Cancellation

Schedule Submission Deletion

Schedule Text Classification Model Training

Schedule Transcription Model Training

Send Usage and Settings Failure

Send Usage and Settings Initiated

Send Usage and Settings Success

Start Training Checkpoint Chunking

Submit Supervision Task

Submit a response for a Supervision task

Table Identification Model

Terminate Chat Flow Run

Terminate Flow Run

Test Block Connection

Test the connection of an Input Block or Output Block through the application

Trainer Set Error Seen

Trigger Analysis for Ground Truth

Run Training Data Analysis in Training Data Management

Trigger Chat Flow

Trigger Flow Version

Unarchive Layout Group

Undeploy Flow

Disable a flow through the application or API

Undeploy Flow Group

Undeploy Identification Model

Deactivate an active Identification model

Undeploy Text Classification Model

Uninstall Base Model

Uninstall ORCA Base Model

Update Blank Candidate Group

Update Dictionary Field

Update a field in the field dictionary

Update Dictionary Field Group

Update a field group in the field dictionary

Update Flow

Update a flow through the application or API

Update Ground Truth

Change the annotations of documents in Training Data Management

Update Ground Truth Item Tags

Update Ground Truth Model Type Identifier

Update Identification Model

Update Field ID model

Update Metric Dimensions

Update Notification

Update or Create a BinaryKV

Update Permission Group Restrictions

Update Redaction For Clustering

Update System-of-Record Document(s)

Upgrade Software Version

Run the init command

Upload Artifacts

Import flows, models, or releases

Upload Authentication Group

Import authentication group

Upload Auto Threshold Model

Upload Blank Image For Candidate Group

Upload Block

Upload a block's definition file

Upload Block Definition

Upload a block-definition file

Upload Flow

Import flow through the application or API

Upload Ground Truth Training Data

Import ground truth training data

Upload Ground Truth Training Data Document

Upload documents to Training Data Management

Upload Identification Model

Upload a model and set its candidate model

Upload Non-Structured Layout Classification Model

Upload a non-Structured layout's Classification model

Upload Non-Structured Layout Classification Model With Training Data

Upload non-Structured layout's Classification model and its training data

Upload Non-Structured Layout Training Data

Upload a non-Structured layout's training data

Upload Permission Group

Import permission group

Upload Submission

Create submissions through the application or API

Upload System Settings

Import system settings

Upload Text Classification Model

Upload Training Data for Text Classification Model

User Login

User logs in to the system

User Logout

Wipe PII from Submission

Workflow Import Wizard Step

Legacy activities

Some activities are no longer recorded but still appear in the Activity Name filter, so that existing Audit Log entries remain searchable. These are prefixed with [Legacy] in the filter — for example, [Legacy] Lock Layout Version.

A legacy activity produces no new entries. It matches only records created while the activity was still in use.

Activity Name

Description

Name in the database

Auto Model Activation - Activate Identification Model

Automated training - activate flex model

Auto Model Activation - Dismiss Identification Model

Automated training - dismiss flex model

Deploy Release

deploy release

Download Accuracy Data

download performance stats

Download Dictionary CSV

download dictionary csv

Download Layout Group Version

download layout group version

Download Locked Layout Version

download locked layout version

Download Potential Layout Results

download potential layout results

Download Release Fields

download release fields

Edit Submission Processing Deadline

edit goal time rule

Edit Training Data

edit training data

Enter Supervision Task Queue

Enter Supervision Task Queue

Get VM Affinity allocations

vm affinity allocations get

Lock Layout Version

lock layout version

Open Specific Task

Start working on a specific submission and/or document

go to specific supervision task

Retry Halted Job

retry halted job

Save VM Affinity Configurations

vm affinity config save

Upload Submission - API

upload submissions-API

Upload Submission - UI

upload submissions-UI

Changes by release

Release

Change

v36 and earlier

The Audit Log had no page in the application. Records were viewed in the activity_auditlog database table or at /admin/activity/auditlog/, and activity names were stored in their system form (for example, enter supervision task queue). The Audit Logs API was introduced in v36.

v37

The Audit Log tab was added to Administration, with human-readable activity names, filtering, and CSV export. The Extra field and the activity_name, operator, and username API filters were added.

v40

HS_DETAILED_AUDIT_LOGGING_ENABLED was renamed to HS_ENHANCED_AUDIT_LOGGING_ENABLED. Activity Log deletion is enabled by default, with a default retention period of 60 days and a maximum of 180 days.