diff --git a/README.md b/README.md index 0c48aec8a..a087308af 100644 --- a/README.md +++ b/README.md @@ -330,8 +330,14 @@ The rules report tab displays the run status of each rule selected for validatio The possible rule run statuses are: -- `SUCCESS` - The rule ran and data was validated against the rule. May or may not produce results -- `SKIPPED` - The rule was unable to be run. Usually due to missing required data, but could also be cause by rule execution errors. +- `SUCCESS` - The rule ran, data was validated, and no issues were reported. +- `SKIPPED` - The rule was unable to be run for one of the following reasons: + - Column not found in data + - Domain not found + - Schema validation is off + - Outside scope +- `ISSUE REPORTED` - The rule ran, data was validated, and issues were reported +- `EXECUTION ERROR` - The validation failed for an unknown reason caused by rule evaluation or execution. Error details are found in the `Issue Details` tab. #### Setting DATASET_SIZE_THRESHOLD for Large Datasets diff --git a/cdisc_rules_engine/enums/execution_status.py b/cdisc_rules_engine/enums/execution_status.py index ab8c1740e..60f9d3a0d 100644 --- a/cdisc_rules_engine/enums/execution_status.py +++ b/cdisc_rules_engine/enums/execution_status.py @@ -4,9 +4,9 @@ class ExecutionStatus(BaseEnum): SUCCESS = "success" SKIPPED = "skipped" - EXECUTION_ERROR = "execution_error" - ISSUE_REPORTED = "issue_reported" - UNKNOWN_STATUS = "unknown_status" + EXECUTION_ERROR = "execution error" + ISSUE_REPORTED = "issue reported" + UNKNOWN_STATUS = "unknown status" class SkippedReason(BaseEnum): diff --git a/resources/templates/report-template.xlsx b/resources/templates/report-template.xlsx index 227cdd1e7..b27e0fabd 100644 Binary files a/resources/templates/report-template.xlsx and b/resources/templates/report-template.xlsx differ diff --git a/resources/templates/usdm-report-template.xlsx b/resources/templates/usdm-report-template.xlsx index 998b8f8bd..b253a7627 100644 Binary files a/resources/templates/usdm-report-template.xlsx and b/resources/templates/usdm-report-template.xlsx differ