Overview
The Audit Log in the database records key user actions taken in the Hyperscience application, such as settings changes and certain file downloads, along with which user took the action and when. This information allows an administrator to view a record of key actions taken in the system.
To view the audit log, go to the admin page by attaching "/admin/activity/auditlog/" to the end of the application URL (e.g., "example.production.hyperscience.com/admin/activity/auditlog/").
To query the activity tracking logs, navigate to the database table activity_auditlog.
Audit Log columns
The following information defines the column names in the Audit Log:
Column Name | Description |
|---|---|
id | System-generated numeric ID for the recorded activity |
activity_created | Date & time at which the activity was recorded |
operator | Whether the activity was performed by the machine or manually - 1 corresponds to machine, 0 to manual |
username | The username which performed the step, if manual |
activity_subtype_name | Activity details (if applicable) - full list below |
activity_name | Human-readable activity name - full list below |
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 database table activity_objectcolumnchange contains additional change details:
Column Name | Description |
|---|---|
id | System-generated numeric ID for the recorded edit activity |
column_name | Element undergoing edits |
old_value | Value prior to the edit |
new_value | Value after the edit |
audit_log_id | Numeric ID of the parent activity as recorded in activity_auditlog |
Activities logged
The following table defines what actions are tracked in the audit log. The Subtype, Object ID, and Object Name values vary depending on the type (i.e. name) of the activity.
Activity Name | Subtype (where applicable) | Object ID | Object Name | Notes |
|---|---|---|---|---|
login | Successful logins only | |||
application upgrade | Additional details on the change are stored in object_column_changes | |||
deploy release | release UUID | release name | ||
retry halted job | job ID | job type | ||
delete submissions | Deleted submission ID | |||
resubmit submissions | ID of original submission | |||
upload submissions - API | The following text will be shown if submission-level settings are applied: - "layout selected" - if Flex layout is specified at time of submission - "machine transcription only" - if Machine Extract Only toggle is enabled on submission If multiple values are present for a given record, they will be separated with a comma. | new submission ID | ||
upload submissions - UI | The following text will be shown if submission-level settings are applied: - "layout selected" - if Flex layout is specified at time of submission - "machine transcription only" - if machine extraction only option is enabled on submission If multiple settings were used for a given submission, the values will be separated with a comma. | new submission ID | ||
edit system setting | Text describing the System Setting changed - examples: - transcription_qa_sample_rate - text_transcription_threshold - field_id_quality_assurance | Text indicates the setting or threshold area - for example: - beta_config for beta feature settings - qa_config for QA settings | Old & new values are recorded in the changes column. | |
enter supervision task queue | String which includes information about: - task purpose - i.e., transcription, page sorting - task source - i.e., quality assurance | |||
submit supervision task response | task ID | |||
create data type | data type UUID | data type name | Additional details on the change are stored in activity_objectcolumnchange | |
edit data type | data type UUID | data type name (if edits are made to the data type name, the name recorded is the original name prior to any edits) | Additional details on the change are stored in activity_objectcolumnchange | |
edit layout name | layout UUID | new layout name | Old & new values are recorded in the changes column. | |
download locked layout version | json | layout version UUID | layout version name | |
download locked layout version | csv | layout version UUID | layout version name | |
add layout | upload existing | job ID | job type | |
add layout | create new - Form | Layout UUID | layout name | |
add layout | create new - Flex | Layout UUID | layout name | |
edit layout priority | layout UUID | layout name | Old & new values are recorded in the changes column. | |
fail halted job | job ID | job type | ||
go to specific supervision task | String which includes info on: - submission ID, document ID, or page ID on which task resides - task purpose - i.e., transcription, page sorting - task source - i.e., quality assurance
| |||
edit layout page | layout page UUID | layout version name and page number | ||
lock layout version | layout version UUID | layout version name | ||
lock release | release UUID | release name | ||
download release | release UUID | release name | ||
download csv | submissions table - [level - submission, page, or field] | |||
download csv | reports - data quality - output field accuracy | |||
download csv | reports - data quality - transcription accuracy | |||
run find potential layouts job | job ID | for Find Potential Layouts job | ||
cancel find potential layouts job | job ID | |||
download potential layout results | download full job data | job ID | for Find Potential Layouts job | |
download potential layout results | download single potential layout data | cluster UUID | for Find Potential Layouts job | |
settings export | The exported settings are recorded in the changes column. | |||
settings import | The imported settings are recorded in the changes column. | |||
deploy flex model | Flex model ID | |||
dismiss flex model | Flex model ID | |||
download flex model | Flex model ID |
Sample Activity Logging Records
Here is an example of the activity logging records of a user who logged in, entered the Supervision Queue, and submitted a Supervision task response:
Column Name | Values - Login | Values - Enter Task Queue | Values - Submit Task Response |
|---|---|---|---|
id | 26928 | 26929 | 26930 |
activity_created | 2019-04-02 08:17:33.126235+00:00 | 2019-04-02 08:18:25.372863+00:00 | 2019-04-02 08:18:53.546372+00:00 |
operator | 0 | 0 | 0 |
username | example_user_1 | example_user_1 | example_user_1 |
activity_subtype_name | forms:task_purpose:transcribe_page, forms:task_source:qa | ||
activity_name | login | enter supervision task queue | submit supervision task response |
object_id | 305267 | ||
object_type | |||
object_name | |||
changes |