Start a conversation

Select an action for your automation

The action describes the result of the event triggering.

1. Open the action dialog

After you navigate to the Automation Engine and select an eventclick on the "Action" button (1).


2. Select an action

A pop-up will show up in which you can select an action:


  1. Search for an action: As more actions are supported by our system, you will be able to search for your desired resulting action using the search box at the top left side of the popup dialog.
  2. Actions: A list of all actions appears on the left side of the popup dialog. Note that only Actions that are supported with your previously chosen event will appear. Therefore, if you choose a different event you may see a different list of Actions. One action must be selected before continuing with your automation. 
  3. Description: A description of the action appears at the top right side of the popup dialog. 
  4. Next/Cancel: Once you select your action, click the "Next" button at the bottom right of the dialog. If you want to quit without saving the action, click "Cancel".
  5. Upon clicking "Next", you will be taken to a new screen to specify the details of your action. This screen changes depending on the action you select; Show/hide phase, Add query, Create and send survey package, or Show/hide step.

2a. Show/hide phase

The Show/hide phase action will hide a phase when the condition is true, and show a phase when the condition is not true. Currently only the Field Value Updated event can trigger this action. First, select the phase you would like to hide by click on the Select Phase button. This will open a "Select a phase" popup which contains all of the phases within your study. Select the phase and click "Save". Press "Back" to select a different action type or "Cancel" to go back to the main Automation Engine screen without saving changes.

2b. Add query

The Add query action will add a specified query to the selected field with the selected status. Currently only the Field Value Updated event can trigger this action. Therefore, once the field is updated to meet the conditions, a query will be added to a field.


  1. Select Field: Select a field to add a query. This will open a "Select a field" popup which contains all valid fields in your study for selection. Fields that do not support queries (i.e. Report buttons, hidden calculation fields, etc.) will not appear in this list.
  2. Status of query: Specify the status of the query, either as "Open" or "Unconfirmed". When the query is created it will have this status.
  3. Comment: Enter text that will be the body of the query in the input box. 
  4. Back/Save/Cancel: Click "Save" to save your action, "Cancel" to go back to the main Automation Engine screen, or "Back" to select a different action type.

New queries that are created by the automation engine indicate within the comment of the query that it is an automatically generated query. The following text is added: “This query was automatically generated by automation 'Automation Name'.”

2c. Create and send a survey package invitation

This action will create and send a survey package invitation when an email address is added to a record and  the specified conditions are met. Currently only the "Email address added to record" event can trigger this action.


  1. Survey package: Select the survey package you want to send when an email address is added to a record. Please note that if you do not have a survey package created in your study, you must go back to your study structure and create a survey package. Once created, please refresh the Automation Engine so that it reloads your study data.
  2. Belongs to: Select if the survey package will belong to a phase in your study.
  3. Email Subject: Specify the email subject that the patient receiving the survey will see in their inbox.
  4. Email text: Specify the email text in the Email text box. This field must contain the {url} tag, which will automatically generate a link to the patient's individual survey.
  5. Lock survey if finished: Select if you want the survey to be locked upon completion.
  6. Send/Start date: Select if you want the survey to be sent relative to when the event (email added to record) is triggered or if you would like to decide later.
  7. Start date: Select the number of days after the trigger day you would like the sending pattern to begin. If the sending pattern does not exist, the system will send your survey package on the start date you specify.
  8. Scheduling: Specify the scheduling of the survey. Note that you need a schedule already created for it to appear in the dropdown. If you have not yet created a schedule, you must go back to your study Structure > Survey Packages > Configure Schedules to create one. Once created, please refresh the Automation Engine so that it reloads your study data.
  9. Back/Save/Cancel: Click Save to save your action, Cancel to go back to the main Automation Engine screen, or Back to select a different action type.

2d. Show/Hide Step

The Show/Hide Step action will hide a step when the condition is true, and show a step when the condition is not true. First, select the step you would like to hide by clicking on the Select Step button. This will open a "Select a step" popup which contains all of the steps within your study. Currently we do not support the hiding of report steps. Please note that if the step you select is the only step in a phase, the phase will disappear as well.

3. Save your Automation

If you have selected your event, condition(s), and action, it is now time to save your automation! In the main Automation Engine interface, click "Save" located at the bottom right of the screen. If the automation is saved successfully, the appropriate message should appear. You now have the option to close the tab.


Congratulations! You have successfully created an automation! Now let's get to testing it. Made a mistake when creating your automation? No worries! You can simply edit it.

Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Tonya

  2. Posted
  3. Updated