Versions Compared

Key

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

...

  1. Participant age at the time of registration should be more than 18 years

  2. Only male participant registrations are allowed

  3. Frozen event timestamp should be later than the specimen creation time.

What is Data Validation or Edit Check?

  1. Data Validation is a series of constraints designed to check the validity of the input data.

  2. Data Validation constraints can be made of variables of a single record or multiple records.

  3. Data Validation is like database check constraints designed to ensure high-quality specimen data is collected.

How to define data validation?

Data validations can be defined using JSON.

Expand
titleClick here to view details for the configuration..
  1. The code has three parts - records, forms and rules

    1. records - Whenever any of these specified records are modified; the constraint rules should be evaluated/enforced. This refers to the data entry level at which the fields are present for which the edit check is to be applied. The value for records can be cpr, specimen, visit or a combination of these.

    2. forms - Optional field. If present, specifies the list of forms whose data is used to enforce the constraints.

    3. rules - List of integrity rules that should be satisfied by the records and forms.

  2. A ‘rule’ is made up of three attributes when, expr, and description.

    1. when: The attribute 'when' is optional and specifies when the rule is applicable. For example, the rule is applicable only for primary specimens

    2. expr: The attribute 'expr' specifies the check constraint that should be satisfied.

    3. description: The attribute 'description' describes the constraint in user-friendly language. This is also used in error messages when the rule is broken or not satisfied.

  3. Aliases for rules are - “cpr, visit, primarySpecimen, specimen”, which are self-explanator.

  4. Aliases for accessing the form records are cprForms, visitForms, primarySpecimenForms, specimenForms. These are maps that can be indexed by the form name to access the relevant form data. For example, specimenForms['SpecimenFrozenEvent'] can be used to access the latest frozen event. Similarly, specimenForms['SpecimenFrozenEvent$Array'] can be used to access the list of all the frozen events for the specimen in question.

Where to define the data validation rules?

The ‘editChecks’ section of the code needs to be inserted after the ‘dictionary’ section in the workflows JSON.

...