Message templates

This portlet allows administrators to view the templates set to be used when sending emails to Hosts, Guests, as well as other notifications (kiosk offline, low paper) from tdsvisitor. It is also possible to add new message templates, edit, clone and delete.

To open Message Templates portlet, go to Menu > Setting > Message Templates.

All existent message templates are presented on grid. The template name (Message Template column) indicates its use - e.g. 'email_invite_visitor' is the template used in the email sent to guests after a visit registration.

Add a message template

1. On Message Templates portlet, click the Add button.

2. Add Message Template form is shown. Fill out the required fields:

  • Type: Email or SMS; for SMS Type, the fields From, Reply To, Email CC and Subject are not presented.
  • Category: for tdsvisitor, all emails are automated;
  • Message Template: an identifier (name) for the message template;
  • From: address sending the emails; usually already filled by default/configured on tdsvisitor install;
  • Subject: subject of the email to be sent;
  • Body: email body.

3. Optionally, you may inform:

  • Area Type: leave it blank to apply to all system Locations, or select 'Site' to apply to a specific one (which you can select on Area field);
  • Reply To: if a receiver clicks 'Reply', the address informed here will be shown;
  • Email CC: address to receive a copy of any emails sent using this template;
  • Data: include data on emails by selecting the mapping tag from the list and clicking Add to Subject or Add to Body;
  • ICS Summary: text to be showed in the ICS file attached to emails sent by tdsvisitor system.

4. Click Save to commit the inclusion.

Edit message template

1. Click the Edit this message template icon in the Action column;

2. The same form used for the add operation will be presented with the message template data retrieved; all fields can be edited.

3. After changing the information, click Save to update.

For the default/standard message templates, it is not possible to edit the Message Template (name) field.

Clone message template

1. Click the Clone this message template icon in the Action column;

2. Clone Message Template form will be presented, with all field settings copied. Just fill out a name on Message Template and click Save.

Delete message template

1. To delete a message template, click the Bin icon Delete this message template in the Action column.

2. A confirmation dialog will appear. Click Yes to confirm the operation, or No to abort it.