Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Error Report

A report of all the data validation errors can be downloaded from the collection protocol overview page > ‘More’ > ‘Export Errors’

...

Clicking on ‘Export Errors’ redirects to a page as shown below:

...

Report Interval: You can define the date range for which the report is to be downloaded.

User: This is used to define the user for which the report is to be downloaded.

The report is downloaded when clicked on ‘Export’. In case no value is entered for these fields, an entire report is downloaded, including all errors shown for all users.

The downloaded zip has a CSV file with the below columns:

Column

Description

Identifier

System-generated unique number

User#First Name

First name of the user who was logged in while performing data entry

User#Last Name

Last name of the user who was logged in while performing data entry

User#Email Address

Email address of the user who was logged in while performing data entry

Collection Protocol#Short Title

Collection protocol on which the data validation showed an error

Record Type

The data entry level on which the error occurred. It can have the values:

  • Registration

  • Visit

  • Specimen

  • Form name of a custom form

PPID

The participant protocol ID for which data entry gave an error

Visit Name

Visit for which the error was thrown. This column will have values only when the error is thrown at the ‘Visit’ level of a custom form attached at visit level

Error Time

The timestamp of the error thrown

Error Message

The display message for the error thrown. This is the same message that is displayed on the screen when an edit check fails. It is defined in JSON.

Error: ‘Cannot index into a null value’

While adding multiple edit checks on non-mandatory fields/forms, it is necessary to have a null check on all the fields involved in the edit check before accessing it. This can be done by checking whether the form/field is not equal to ‘null’ in the when part of the edit check.

Refer to ‘How to solve ‘Cannot index into a null value’ error’ for more details.

Setup error report scheduled job

The following configuration requires ‘os-data-qc’ JAR present in the $OS_PLUGINS directory.

...

  1. The os-data-qc plugin will create a new job (“Edit checks error report”) upon bootstrapping.

  2. By default, the ‘Fixed Parameters’ are null. These should be comma-separated collection protocol IDs (Ex: 1,8,21). The output error-report would be generated for these collection protocols.

  3. The generated report would be sent to the users under the 'Notify Users' list.

Info

Only newer errors, which happened since the job’s last run-time, are sent.

Screenshots

Expand
titleScreenshot: Sample Configured Job

...