Submission Tracking Logs
Submission Tracking Logs
Updated on Dec 11, 2024
Published on Sep 17, 2024
1 minute(s) read
Overview
The submissions tracking functionality in the database and API records each stage that a page moves through as it is processed in Hyperscience. This information can help with debugging and stuck or incomplete submissions. To query the submission tracking logs, navigate to the database table reports_submissionlog.
Submission Tracking Log columns
The following information defines the column names in the Submissions Tracking Log, which correspond to the stages of the processing graph:
| Submission Activity Name | Submission Activity Subtype Name |
|---|---|
| Initial | W_SUBMISSION_START |
| Submission Deletion | W_SUBMISSIONS_DELETE |
| Resubmission | W_SUBMISSION_RETRY |
| Segmentation | SEGMENTATION |
| Page Classification | VPC |
| Layout Alignment | REGISTRATION |
| Form Aggregation | W_DISTRIBUTE_TO_FORMS |
| W_DISTRIBUTE_TO_FORMS_COMPLETE | |
| Field Identification | FIELD_LOCATOR |
| Transcription | OICR_FIELD |
| OICR_PAGE | |
| OICR_FLEX_PAGE | |
| Transcription completion | W_FORM_OICR_READY |
| Supervision - [Task Type] | CS_REQUEST |
| CS_RESPONSE | |
| Completion - [Page Status] | W_FORM_COMPLETE |
| W_SUBMISSION_COMPLETE | |
| Document State Changed | Complete |
| Submission State Changed | |
| Record QA | W_QA_READY |
| Notification | "NOTIFY" |
Submissions logged
The following information is recorded for every submitted page at each processing step:
| Column Name | Description |
|---|---|
| id | System-generated numeric ID for the processing step |
| activity_start | Date & time at which the processing step began |
| activity_end | Date & time at which the processing step completed |
| submission_metadata | Metadata provided at the time of submission, if any |
| submission_external_id | External ID provided at the time of submission, if any |
| submission_id | System-generated numeric ID for the submission of which the page is part |
| submission_page_id | System-generated numeric ID for the page |
| form_id | System-generated numeric ID for the document of which the page is part, if any |
| template_uuid | System-generated unique identifier of the layout to which the page has been matched |
| template_name | Name of the layout to which the page has been matched |
| operator | Whether the step was performed by the machine or manually - 1 corresponds to machine, 0 to manual |
| username | The username which performed the step, if manual |
| activity_name | Human-readable activity name - the full list above |
| activity_subtype_name | Processing graph step name - the full list above |
| activity_created | Date & time at which the processing step was created |
| transcribed_fields_count | Fields transcribed during the processing step, if any |
| details | Any additional information relevant to specific processing steps. For example - when resubmitting a submission, the submission ID of the new submission is recorded here. |
Sample Submission Tracking Record
Here’s an example submission tracking record for a page undergoing manual transcription:
| Column Name | Value - Manual Transcription Step |
|---|---|
| id | 123456789 |
| activity_start | 2019-01-02 12:19:07.278863+00:00 |
| activity_end | 2019-01-02 15:38:27.192354+00:00 |
| submission_metadata | “{"source_id": 98765}” |
| submission_external_id | file_id-4778742 |
| submission_id | 108355 |
| submission_page_id | 553688 |
| form_id | 131926 |
| template_uuid | e9fa28b8-736a-163e-8e38-e3ba7c69b8bc |
| template_name | New Account Opening - November 2017 |
| operator | 0 |
| username | example_user_1 |
| activity_name | Supervision - Transcribe Page |
| activity_subtype_name | CS_REQUEST |
| activity_created | 2019-01-02 12:18:53.278863+00:00 |
| transcribed_fields_count | 9 |
| details |
Accessing submission tracking logs via the API
Submission tracking logs may also be accessed via the API. Either of the following URLs will return rows corresponding to machine transcription actions – sorted by descending activity end date:
HTTP
[instance URL]/api/reporting/tracking/submissions?activity_name=Transcription&sort=-activity_end
HTTP
[instance URL]/api/activity/submission_logs?activity_name=Transcription&sort=-activity_end
Additional filtering and sorting options are available. Adding /csv at the end of the API call will download the results as a CSV file.