Templates: notifications add, edit, review and delete

Modified on Thu, 24 Jul at 12:36 PM

Through templates, it's possible to add, edit, review and delete SMS templates, email templates, push notifications, and in-app messages. This feature provides an overview of available notification templates, detailing each template's key (reference ID), template key (type of message), and a brief description of its purpose.

Add new template

By clicking on 'add', a new template can be introduced. Initially, selecting a language is 'optional'. This step can be skipped if, for instance, only one language is utilized within your study. Subsequently, you select the template type, enter the unique key, and describe the template's intended use. Depending on the chosen template type, you may or may not include a title, such as the subject line of an email. Then, using the editor, you can format the template with text, shortcuts, and links. 'Show in portal' allows the email to be reviewed once sent to a participant, and 'show in mobile application' applies only to push notifications and InMobile messages.

Adding Variables to Visit

Variables can be used in the templates. This means that information can be automatically read. The following variables are available:

General Variables:

Note that the variables are case-sensitive.

Variable	Explanation
`{{FirstName}}`	First name to whom the email is sent
`{{LastName}}`	Last name to whom the email is sent
`{{Email}}`	Email to whom the email is sent
`{{StudySite_Email}}`	Study site email linked to the site, see site overview
`{{StudySite_PhoneNumber}}`	Study site phone number linked to the site, see site overview
`{{StudySite_AddressLine1}}`	Study site address line 1 linked to the site, see site overview
`{{StudySite_AddressLine2}}`	Study site address line 2 linked to the site, see site overview
`{{StudySite_AddressLine3}}`	Study site address line 3 linked to the site, see site overview
`{{StudySite_PostalCode}}`	Study site postal code linked to the site, see site overview
`{{StudySite_City}}`	Study site city linked to the site, see site overview

If the information is not present in the system, it will not be added.

Linking Visit Template to Visit

To link a visit to a template, the key of template must end with the number of the visit. For example:

Type		Not be sent	Will be Sent
Mail	MailCreate{{VisitKey}}	MailCreateV	MailCreateV1
SMS	SMSCreate{{VisitKey }}	SMSCreateV	SMSCreateV1

Keys	Explanation
MailCreate	Sent when a visit is scheduled
MailUpdate	Sent when a visit is updated
MailCancel	Sent when a visit is canceled
MailRemind	Sent based on the notification schedule set for the study or your organization
SMSCreate	Sent when a visit is scheduled
SMSUpdate	Sent when a visit is updated
SMSCancel	Sent when a visit is canceled
SMSRemind	Sent based on the notification schedule set for the study or your organization

Variables can also be added to a visit template.

Adding Visit Variables in Template

Note that the variables are case-sensitive.

Variable	Explanation
`{{VisitDateTime}}`	Visit date and time
`{{VisitDate}}`	Visit date
`{{VisitTime}}`	Visit time
`{{VisitName}}`	Title of visit

Edit template

By clicking on the pencil icon in the template overview, it is possible to modify a template. Please note! If you have multiple languages, we recommend checking each template for accuracy.

Testing template

Once a template is completed with all the necessary information, it becomes possible to test it. A 'test' button will appear at the bottom left corner, and for email templates, a 'preview' button will be available as well. The test feature enables you to send a test message to yourself, provided your profile contains the requisite details (for example, a mobile number is needed for SMS testing). Additionally, you can view how the email will appear by clicking on the 'preview' button, which will display a sample on the left side.

Important to know is that the variables will not be filled.