Creating a Criteria Check Rule Template

Prerequisites

Ensure that you have a criteria check event created. See the Creating a New Event section on the Managing Events page for more information.
Ensure that all survey names, schedule names, event names, group type names, and group name fields are named correctly.
Ensure that the survey and schedule are already created.

Create Criteria Check Rule

Note: The system will prevent you from creating a new criteria check rule if no check events are available. Each check event can only be used in one criteria check rule.

Complete the following steps to create a criteria check rule:

In eCOA Studio, open the Rules tab.
Select Create Rule.
Select Criteria Check and select Select Template.
Enter a Name for the rule. For example: Rule_1
Enter a Description. For example, Rule_1. The description helps other Studio users identify what the rule is when they see it in the Rules tab.
1. Example: This rule enables sites to check the average value of select survey answers and see the submission datetime of the surveys associated with the answers.
Select the event name of the check event you want to use to trigger the check. For example, hads_check.
Optionally, enter the Preconditions using references or variables to define the conditions you want to be evaluated as TRUE before the criteria check can be run. See Creating a Reference and Creating a Variable on the Understanding Rules page for more information.
1. Example: You can use STAT1 and STAT2 variables to require that two successful submissions of the HADS survey have been received from a participant before a site user can run the check. The following expression would return TRUE if the HADS survey has had two submissions with compliant statuses.
2. Variable definitions:
  1. STAT1: $survey.hads.[*].[*].[-1].Status
  2. STAT2: $survey.hads.[*].[*].[-2].Status
3. Expression: (STAT1 = "COMPLIANT") && (STAT2 = "COMPLIANT")
If you want the system to display a message to users when the preconditions are not met, enter the message in the Missing Preconditions field. For example: This participant must submit at least two HADS survey responses.
Add the Criteria Name, Display Label, and Expression for the criteria. You can add multiple citeria to a criteria check rule. After a site user runs the Criteria Check, the label and results of the expression for each criteria are displayed. See the following criteria examples:
1. Criteria Name: Criteria_1
  Display Label: The average answer for Question one across two instances was:
  Expression: Average(Value(ANS1INST1), Value(ANS1INST2))
2. Criteria Name: Criteria_2
  Display Label: Average answer is above the threshold:
  Expression: If(Average(Value(ANS1INST1), Value(ANS1INST2))>50,true,false)
3. Criteria Name: Criteria_3
  Display Label: The datetime for the submission of the most recent instance of the HADS was:
  Expression: $survey.hads.[*].[*].[-1].datetime
4. Criteria Name: Criteria_4
  Display Label: The datetime for the submission of the second most recent instance of the HADS was:
  Expression: $survey.hads.[*].[*].[-2].datetime

Note: When building a study that includes non-English-speaking site users, using Template Tokens within expressions displays results in the site user’s language. To copy and paste the text for the token, in the Rule Tools, select the Template Tokens tab, and select the Copy Variable Name button () next to the token you want to use. The text is copied to your clipboard. You can position your pointer where you want that value to be in the expression and press CTRL+V to paste it there.

Select Save.

Saving a Rule

Draft template changes are automatically saved as you make updates. If you sign out and back in, when you access the templates, you can continue working on your draft. If you choose to create a new draft before manually saving an in-progress draft, your changes will be lost.

You can save a rule by selecting the Save button.

Editing a Rule

You can edit a rule when the collection is in a Draft state.

Complete the following steps to edit a rule:

Open the collection, select the Rules tab, and select the Edit Rule icon () next to the rules you want to edit.
Make any changes you want to see, and select Save. Your changes are saved.

Deleting a Rule

You can only delete rules that have not been included in an approved collection. Once a rule is deleted, it cannot be recovered.

Complete the following steps to delete a rule:

Open the collection, select the Rules tab, and select the Delete Rule icon () next to the rule you want to delete. A confirmation box opens.
Select Delete. The rule is deleted.