Runs sanity checks on legacy ingest projects, namely for a given input retrospective form:
If any errors are found, it emails the targets specified in target_emails
The gear takes two input files as input:
| Input File | Description |
|---|---|
input_file |
The input retrospective form to run the sanity checks against. The subject to evaluate will be pulled from this file and run against all modules. |
form_configs_file |
JSON file with the forms module configurations. Should be the same as the one used by the ingest project, e.g. form-ingest-configs.json |
and the following configuration values:
| Configuration Value | Default | Description |
|---|---|---|
ingest_project_label |
ingest-form |
The corresponding ingest project for this retrospective project; assumes there is one, throws an error if no corresponding ingest project is found |
sender_email |
no-reply@naccdata.org |
Email to send error reports from |
target_emails |
nacchelp@uw.edu |
Comma-deliminated list of target emails to send error reports to |
apikey_path_prefix |
/prod/flywheel/gearbot |
The parameter store API-key path prefix for the gearbot |
After processing, the gear updates the input file. See the QC Conventions reference for details on the data models and conventions used across gears.
File Tag: The gear name (e.g., "legacy-sanity-check") is added as a simple tag to the input file on success, indicating the file has been processed and passed sanity checks.
Note: The tag is also added in early-exit cases (e.g., when the center is inactive). If sanity checks fail, the gear raises an error and sends an email notification to the configured target emails instead of tagging the file.