Creating a Send Survey Data Rule Template

This template allows you to transfer survey answers to an external system via API. This rule is triggered when a survey status updates to Compliant or Missed. This automation helps ensure your external systems stay in sync with eCOA data.

Prerequisites

You must add Outbound API credentials in the Exports tab before configuring the rule. See the Adding Credentials section on the Working with Outbound APIs page for more information.
The survey you want to use as a data source must already exist in the collection. See Configuring Surveys for more information.

Create Send Survey Data Rule

Complete the following steps to create a send survey data rule:

In eCOA Studio, open the Rules tab.
Select Create Rule.
Select Send Survey Data and then select Select Template.
Enter a unique Name for the rule. For example: Rule_1
Enter a Description of what the rule is for. This description helps other Studio users identify what the rule is when they see it in the Rules tab.
Select the Trigger survey from the list. The rule evaluation occurs when a survey status changes to COMPLIANT or MISSED.
Enter the Expression that must evaluate to True for the API call to occur.
In the Action section, select Call API Template.
Enter a unique Call Name.
Enable or disable the Send Missed Surveys setting. If you select Enabled, the system sends null values to the external system when a survey is missed.
Configure the Field Mapping JSON to link eCOA blocks to external fields. See Configuring Outbound API Field Mapping for more information.
Add the required Call Mapping items.

Note: These values must match the equivalent EDC name values.

Select Save.

Note:

Rule-derived values are treated as tokens that automatically populate the equivalent mapped field in the Request JSON when a call is initiated.
If a site user transcribes a survey, the system uses the date and time of the transcription as the completion value.

Working With Rules

Saving a Rule

You can save a rule by selecting the Save button.

Note: You can save a rule that has errors. Ensure that you fix all errors before using the rule.

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

Once a rule is deleted, it cannot be recovered.

Complete the following steps to delete a rule: