How do I remove a scheduled invite?
- Theresa Baker (Unlicensed)
- Terry Nguyen
- Madison Lethebe
There are two methods to remove a scheduled invite.
- Manually remove the invite
- Build stop logic into your Automated Survey Invitations
- This setting is optional for Automated Survey Invitations. When enabled, REDCap will re-evaluate the logic against the record's data values whenever the record values are changed AFTER the invitation has been scheduled but BEFORE it has been sent to the respondent. And if the logic is no longer true (i.e., if the data values have changed during the time after the survey invitation was scheduled), it will not send the invitation to the respondent but will instead delete it (as if it had never been scheduled). Additionally, if the invitations get deleted due to this setting, then the invitations *may* get scheduled again later if data values are changed such that the logic evaluates as true again. Enabling this setting provides you with greater control over when and how invitations get sent when using conditional logic for Automated Survey Invitations.
Manually removed a scheduled invite
- Go to Survey Distribution Tools
- Select the Survey Invitation Log
- View Future Invitations
- Filter for the correct record, event, or survey
- Select the record checkbox
- Delete all the selected items
Build stop logic into your Automated Survey Invitations
This setting is optional for Automated Survey Invitations. When enabled, REDCap will re-evaluate the logic against the record's data values whenever the record values are changed AFTER the invitation has been scheduled but BEFORE it has been sent to the respondent. And if the logic is no longer true (i.e., if the data values have changed during the time after the survey invitation was scheduled), it will not send the invitation to the respondent but will instead delete it (as if it had never been scheduled). Additionally, if the invitations get deleted due to this setting, then the invitations *may* get scheduled again later if data values are changed such that the logic evaluates as true again. Enabling this setting provides you with greater control over when and how invitations get sent when using conditional logic for Automated Survey Invitations.
- Start in the online designer
- Automatic Survey Invitation
- Build stop logic into your automated invitation
- If you have Automated Survey Invitations (ASIs) that will not be sent immediately but instead are scheduled to be sent later, it might be a good idea to consider using 'stop logic' (otherwise known as a 'kill switch') in your conditional logic in order to manually stop these scheduled invitations when needed. This might be used if somehow an invitation was scheduled by accident and you need to quickly delete it. NOTE: You must have checked the 'ensure logic is still true' checkbox in order for the 'stop logic' to work. By having the checkbox checked, it means that every time a given record is saved or has data modified, REDCap will see if there is an invitation scheduled for this record/survey, and if so, it will then double-check to see if this condition/logic is still true. If the condition is no longer true, it will delete the invitation so that it never gets sent. And if the record is modified again later, in which the condition then becomes true again, then the invitation will get re-scheduled. Without the 'ensure logic is still true' checkbox being a checkbox, REDCap will leave the scheduled invitation as-is and never delete it.
The 'stop logic' could be a complex set of conditional logic, or it could be as simple as a single field in the project (i.e., the kill switch). For example, if you are wanting a survey invitation to be scheduled when a participant is at least 18 years old, your logic might be '[age] >= 18'. And if you want to add the 'stop logic' to be able to manually delete a scheduled invitation, you could have '[age] >= 18 and [remove_alert] <> 1', in which the field 'remove alert' is a Yes/No field. So in this instance, if you wanted to have the scheduled invitation deleted, you could simply go to the data entry form where the 'remove alert' field is located, and set it to 'Yes'. This can be done in a variety of different ways. This is merely a simple example to introduce this concept. Remember, the key to using 'stop logic' is that the 'ensure logic is still true' checkbox MUST be checked.
- If you have Automated Survey Invitations (ASIs) that will not be sent immediately but instead are scheduled to be sent later, it might be a good idea to consider using 'stop logic' (otherwise known as a 'kill switch') in your conditional logic in order to manually stop these scheduled invitations when needed. This might be used if somehow an invitation was scheduled by accident and you need to quickly delete it. NOTE: You must have checked the 'ensure logic is still true' checkbox in order for the 'stop logic' to work. By having the checkbox checked, it means that every time a given record is saved or has data modified, REDCap will see if there is an invitation scheduled for this record/survey, and if so, it will then double-check to see if this condition/logic is still true. If the condition is no longer true, it will delete the invitation so that it never gets sent. And if the record is modified again later, in which the condition then becomes true again, then the invitation will get re-scheduled. Without the 'ensure logic is still true' checkbox being a checkbox, REDCap will leave the scheduled invitation as-is and never delete it.