The Audit Log records user actions taken in the Hyperscience application, such as settings changes and specific file downloads, along with which user took each action and when. This information allows System Admins to view a detailed record of key tasks completed in the system.
Accessing the Audit Log
By default, access to the Audit Log is given to members of the System Admin permission group. If you need access to the Audit Log, contact a system administrator.
- For more information on how to manage permission groups, see Managing Permission Groups.
To access the Audit Log in the application, click Administration, and then click the Audit Log tab.
You can also retrieve Audit Log data through our API. To learn more, see our API documentation.
Searching the Audit Log
For each activity, the table shows the following details:
- Activity ID
- Clicking an activity’s ID shows additional information about the activity. For more details, see the Data recorded for each activity.
- When the activity is completed
- Activity name
- See Activities recorded in the Audit Log for a full list of activity names.
- Username of the user who performed the activity (if the operator was not the machine)
Click Filters to select the activity name, operator (machine/human), or username you want to search by. You can use any combination of these filters.
You can also search by activity ID number, specific date created, or date range.
Exporting Audit Log data
If you need an export of the Audit Log, you can download a CSV file by clicking Download all activities (if you haven’t applied a filter) or Download filtered activities (if you’ve used a filter) on the right side of the page.
Activities recorded in the Audit Log
The Activities table contains information about each of the following activities performed in the system.
| Activity Name | Description | Notes |
|---|---|---|
| Add New Layout | Layout creation/layout import | |
| Archive Flow | Archive a flow through the UI or the API | |
| Cancel Find Potential Layouts Job | Cancel a “Find potential layouts” job | |
| Cancel Model Training | Cancel model training tasks | |
| Create New Authentication Group | Create an authentication group in the UI or on import | |
| Create New Data Type | Create a field data type | |
| Create New Task Restriction | Create a task restriction | |
| Delete Authentication Group | Delete an authentication group | |
| Delete Case Tokens<></> | Release case token assigned by users to complete Supervision tasks related to a case | |
| Delete Document Tokens | Release knowledge worker tokens used by users to complete Supervision tasks related to a document | |
| Delete Layout Version Being Used | Delete a layout version | |
| Delete Permission Group | Delete a permission group | |
| Delete Submissions | Delete submissions through the UI or API | |
| Delete Submission Tokens | Release knowledge worker tokens used by users to complete Supervision tasks related to a submission | |
| Delete Task Restriction | Delete a task restriction | |
| Document Rejection | Handle document rejection | |
| Download Authentication Group | Export an authentication group | |
| Download CSV | Download submission-level CSV, document-level CSV, system throughput CSV, all users performance CSV, or Audit Log CSV | |
| Download File | Any async download | Async downloads are downloads that can be accessed from the Notification Center. |
| Download Flow | Export flow through the UI | |
| Download Identification Model | Download a live/candidate model | |
| Download Image | Download image | |
| Download Non-Structured Layout Classification Model | Async download of a non-Structured layout’s Classification model | 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 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 Permission Group | Export a permission group | |
| Download Release | Export a release | |
| Download System Settings | Export system settings | |
| Deploy Flow | Deploy flow through the UI or API | |
| Deploy Identification Model | Activate trained candidate model | |
| Edit Authentication Group | Update authentication group in the UI or on import | |
| Edit Data Type | Edit field data type | |
| Edit Layout Submission Processing Deadline | Edit SLA rule for a specific layout | |
| Edit Layout Name | Edit layout name | |
| Edit Layout Page | Edit layout page | |
| Edit Layout Page Image | Edit layout page’s image | |
| Edit Layout Version | Edit layout version | |
| Edit Permission Group | Update a permission group in the UI | |
| 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 UI | |
| Enter Task Queue | User started working on tasks | |
| Fail Halted Job | Update halted jobs status to Failed | |
| Lock Release | Create a release or update a release to Locked | |
| Open Specific Task | Start working on specific task | Specific Submission and/or Document |
| Reject Identification Model | Reject a candidate model | |
| 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 user-authentication token by user or permission group | |
| Restore Flow | Restore Flow through the UI or the public API | |
| Resubmit Submission | Retry submission | |
| Retry Find Potential Layouts Job | Retry a “Find potential layouts” job | |
| Run Find Potential Layouts Job | Run a “Find potential layouts” job | |
| Schedule Identification Model Training | Schedule model training | |
| Submit Supervision Task | Submit Supervision task response | |
| Test Block Connection | Test the connection of an Input Block or Output Block through the UI | |
| Train Non-Structured Layout Model | Schedule Classification model training | |
| Undeploy Flow | Disable a flow through the UI or API | |
| Undeploy Identification Model | Deactivate an active Identification model | |
| Update Flow | Update flow through the UI or API | |
| Upgrade Software Version | Run the init command | |
| Upload Block | Upload a block’s definition file | |
| Upload Identification Model | Upload model and set its candidate model | |
| Upload Authentication Group | Import authentication group | |
| Upload Permission Group | Import permission group | |
| Upload Ground Truth Training Data | Import ground truth training data | |
| 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 System Settings | Import system settings | |
| Upload Submission | Create submissions through the UI or API | |
| Upload Flow | Import flow through the UI or API | |
| User Login | User logs in to system |
Data recorded for each activity
Clicking an activity’s ID in the Activities table reveals the following data about the activity.
| Field | Description |
|---|---|
| ID | System-generated numeric ID for the recorded activity |
| Activity Created | Date and time the activity was recorded |
| Operator | Indicates whether the activity was performed by the machine or by a human |
| Username | Operator is Human, the username of the user who performed the activity |
| Activity Display Name | Human-readable activity name |
| Activity System Name | The name of the activity in the database |
| Activity Subtype Display Name | If the activity type can be completed in multiple ways, this field contains the human-readable name of how the activity was completed (e.g., if Activity Display Name is Add New Layout, Activity Subtype Display Name could 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) (e.g., if the Activity Display Name is User Login, Extra could contain details about the browser used to log in) |
| Object ID | ID of object impacted by the activity (if applicable) |
| Object Type | Type of object impacted by the activity (if applicable) |
| Object Name | Name of the object impacted by the activity (if applicable) |
| Changes | Details regarding changes made (if applicable) |
For changes on objects with multiple editable elements, the Object Column Changes field contains a table with additional change details:
| Column Name | Description |
|---|---|
| Attribute | Element undergoing edits |
| Old Value | Value prior to the edit |
| New Value | Value after the edit |