Rules report

This report gives you a complete view of all the rules that were created in a study and includes all the changes that were performed for each rule. This report includes custom rules as well as predefined validation and notification rules added in form design.

The Rules report offers details about each rule, including rule expression, rule status, the mode in which the rule is contained, as well as information about changes that were made to that rule and the validity of that rule.

Custom rules and predefined designer notification rules are included in the first section Custom Rules, along with their details. Predefined validation rules are included in the second section Designer Validation Rules. For more information see Predefined rules versus custom rules.

This report is available in XLSX, PDF, and HTML formats.

Note:

If you generate the report in XLSX format, the Designer Validation Rules section is included as a separate sheet.

Tip:

If you need to work with this report in a CSV format, an XLSX file might be useful to you. Open the report generated in an XLSX format using a spreadsheet editor, then save individual sheets as CSV files.

Modes

This report is available in all 3 modes.

Permission required to run the report

Any user who's assigned the Run the Study Rules Report permission can generate this report.

Filters

Filter	Description
Study Version	Select a study version to display the rules associated with a specific form or question or leave it blank to display all rules in the study.
Rule State	Select Draft, UAT, Approved or Published to display only rules with a specific state or leave it blank to view all rules in all states. Note: This filter is only applicable for custom rules. All predefined validation rules will be included.
Form Title	Select a form title to see all rules that are associated with that form or leave it blank to view all the rules included in all the forms in that study version.
Question Label	Select a question label to see rules that are associated with that question or leave it blank to view all rules that are associated with all questions included in the form you previously selected.
Include Audit Trail	Select Yes to see details about every historical change that was made to each rule. Note: Audit trail data is only available for custom rules. Validation rules only display current status. Select No to view only the latest version for each rule.
File	Choose the output type for the report: XLSX PDF HTML

Field descriptions

Initial fields	Description
Customer Name	A customer's name used to purchase the cloud subscription.
Study Name	A study's ID as entered by the study manager when they created the study.
Mode	The mode in which you ran the report.
Study Version	Number of the study version for which the report is generated.
Report Generated By	User name of the user who generated the report.
Created Date	UTC time and date of when this report was run.
Include Audit Trail	Setting that indicates if you included audit trails in your report or not.
Do Not Block Users	Setting that will filter out the names of the users in the Action Target field.

Custom rules	Description
Visit Name	The name of the visit for which the rule is set.
Visit RefName	The Reference name of the visit for which the rule is set.
Form Name	The name of the form that contains the rule.
Form RefName	The reference name of the form that contains the rule.
Target Question	The name of the question that contains the rule. This is the question for which the calculated value or query will appear.
Question RefName	The reference name of the question that contains the rule. This is the question for which the calculated value or query will appear.
Rule Version Number	The number of the rule version included in report.
Rule Reference ID	The unique ID that was generated for the rule.
Rule name	The name of the rule as entered by the rule designer.
Rule Copied	Reserved for future use Indicates if a rule is copied or not.
Rule Copied From	Reserved for future use The name of the rule from which the rule was copied from, if applicable.
Rule Description	The description of the rule as entered by the rule designer.
Unblock Form	Indicates whether the Unblock Form setting is active or not. If ON users are allowed to edit the form while the rule is running.
Variables	The variables that were defined for the rule.
Expression	The Javascript expression that was defined for the rule.
Rule Valid/Invalid	The validity of the rule. This field specifies whether the rule contains any errors.
Action Type	The type of action that is set for the rule: Create query or Calculate value.
Action Target	The roles or names of the targets that will be notified when the action is triggered.
Action Properties	The text of the query message as defined in the Answer type field.
Rule State	Status of the rule: Draft, UAT, Approved, Published. If audit format is selected all state changes will appear. Otherwise, only the most recent status will be provided for all rules in the study.
On Publish	Indicates if when a rule gets publish will run on All Data or Future Data, according to the configuration on the Rule Management page. Note: If the rule gets published using the state slider in Testing mode, this setting can be configured differently when user gets prompted with these two options.
Mode	The mode where the rule is contained.
Type of change	Indicates how the rule was modified. If audit format is selected all changes will appear. Otherwise, only the most recent change will be provided for all rules in the study.
Last modified by	User name of the user who last modified the rule.
Last modified Date/Time	Date and time (DD-MM-YYYY HH:MM:SS) of when the rule was last modified.

Designer Validation Rules	Description
Visit Name	Default to All Visits.
Visit RefName	Default to All Visits.
Form Name	The name of the form that contains the rule.
Form RefName	The reference name of the form that contains the rule.
Target Question	The name of the question that contains the rule.
Question RefName	The reference name of the question that contains the rule.
Study Version Number	Indicates the study version number in which the rule was updated (created, modified or deleted).
Rule ID	Rule's GUID from designer.
Rule Description	The type of rule and the value or values as specified by the designer. For example: 'On or after Jan-2010' or 'Exactly 1'.
Action Type	Indicates the action type defined for the validation rule: Validation Query (Designer) Validation and Query
Action Properties	Displays the Error/query message.
Mode	The mode where the rule is contained: Test or Active.

Parent topic: Report descriptions