Difference between revisions of "SystemEvents/Templates"
From Emersion
| Line 8: | Line 8: | ||
| + | ---- | ||
===To Display Templates=== | ===To Display Templates=== | ||
| Line 16: | Line 17: | ||
| + | ---- | ||
===To Create a Template=== | ===To Create a Template=== | ||
| Line 40: | Line 42: | ||
# Enter a ''BCC'' recipient if required. | # Enter a ''BCC'' recipient if required. | ||
# Enter the ''Subject'' text to show in the email subject line. | # Enter the ''Subject'' text to show in the email subject line. | ||
| − | |||
| − | |||
| − | |||
# Select event variables to include in the subject line from the list of ''Variables'' that appear beside the Subject field, which are specific to the Event Type selected. | # Select event variables to include in the subject line from the list of ''Variables'' that appear beside the Subject field, which are specific to the Event Type selected. | ||
| − | + | ::Click the variable name in the list. The variable ''code'' (e.g. ''‘%%package_subscription_name%%''’, ''‘{account->id}''’, ''‘%%FNN%%''’, etc.) will be added to the subject field. Position it within the text as required. | |
| − | Click the variable name in the list. The variable ''code'' (e.g. ''‘%%package_subscription_name%%''’, ''‘{account->id}''’, ''‘%%FNN%%''’, etc.) will be added to the subject field. Position it within the text as required. | ||
| − | |||
# Select the email Priority from the drop list (i.e. Low, Default, High). | # Select the email Priority from the drop list (i.e. Low, Default, High). | ||
# Use the ''Invoice'' check box under ''Attachments'' to indicate whether to attach the invoice to the email or not. Attaching the invoice is only valid against the ‘Invoice Delivery’, ‘Invoice Due’, ‘Invoice Overdue’ and ‘Invoice Post’ event types. | # Use the ''Invoice'' check box under ''Attachments'' to indicate whether to attach the invoice to the email or not. Attaching the invoice is only valid against the ‘Invoice Delivery’, ‘Invoice Due’, ‘Invoice Overdue’ and ‘Invoice Post’ event types. | ||
# Select the ''Invoice Template'' to attach in the drop list. | # Select the ''Invoice Template'' to attach in the drop list. | ||
# Enter the message text in the ''Content'' box. | # Enter the message text in the ''Content'' box. | ||
| − | + | ::The ''Content'' box is a basic HTML editor (i.e. tinyMCE). Some standard text formatting options are available. | |
| − | The ''Content'' box is a basic HTML editor (i.e. tinyMCE). Some standard text formatting options are available. | + | ::To add graphics to the message, such as an image or logo, the image file needs to be hosted externally. This is the preferred way of handling images in a message, rather than as attachments. This is done by editing the HTML directly, using the '''''Edit HTML Source'' function, and including the image in the HTML code directly.''' |
| − | |||
| − | To add graphics to the message, such as an image or logo, the image file needs to be hosted externally. This is the preferred way of handling images in a message, rather than as attachments. This is done by editing the HTML directly, using the '''''Edit HTML Source'' function, and including the image in the HTML code directly.''' | ||
| − | |||
# Insert the required event ''Variables'' into the message. Different event types will have different event variables available. These are shown beside the ''Content'' box. | # Insert the required event ''Variables'' into the message. Different event types will have different event variables available. These are shown beside the ''Content'' box. | ||
# Insert event variables to include in the message from the list of ''Variables'' that appear beside the Content box, which are specific to the Event Type. | # Insert event variables to include in the message from the list of ''Variables'' that appear beside the Content box, which are specific to the Event Type. | ||
| − | + | ::Click the variable name in the list. The variable ''code'' will be added to the subject field. Position it within the text as required. | |
| − | Click the variable name in the list. The variable ''code'' will be added to the subject field. Position it within the text as required. | ||
| − | |||
# Use the ''Preview'' function to see how the message will appear to the customer. | # Use the ''Preview'' function to see how the message will appear to the customer. | ||
# Click the '''Save''' button. The Template details will display. | # Click the '''Save''' button. The Template details will display. | ||
| Line 66: | Line 58: | ||
| + | ---- | ||
===To Edit a Template=== | ===To Edit a Template=== | ||
| Line 77: | Line 70: | ||
| + | ---- | ||
===To Delete a Template=== | ===To Delete a Template=== | ||
Revision as of 14:05, 30 September 2011
Contents
System Events - Templates
Introduction
Templates define the output of event actions. Some actions require a linked template without which the complete event cannot be successfully triggered. Other actions do not require templates.
Each template is further associated with a set of event variables that the system passes through from the triggered event. Each event type has a different set of variables available that can be configured in the template as required. In addition, pre-defined template types are used for each event action type. For example, the Account Password Changed event has separate templates for the Log action, the Notification action, and the Message action. A number of variables are available for use in each of these templates, such as customer number, customer name, password, customer primary email, and address.
To Display Templates
- Select Events > Templates > from the Menu. A list of existing templates will be shown.
- Click the template ID or Name in the list. The selected template will be displayed.
- Click the Return to list button to exit.
To Create a Template
- Select Events > Templates > from the Menu. A list of existing templates will be shown.
- Click the Create New Template button. The Create a Template page will appear.
- Enter the Name or description to give the template.
- Select an Event Type from the drop list.
- Select the Event Mapping required.
The list will only show the event mappings that Emersion has mapped for you. If the required mapping is not shown, please contact the Emersion support team.
- Enter the Sender name / email address. This name will appear in the message From field.
- Select the required Recipient using the option buttons, as follows:
- Default Account Recipient
- Primary Contact
- Billing Contact
- Secondary Contact
- Custom - enter the email address(es) to send the email, separate by a comma
The system uses the email address recorded against the account, or the email address entered, to send the event message.
- Enter a CC recipient if required.
- Enter a BCC recipient if required.
- Enter the Subject text to show in the email subject line.
- Select event variables to include in the subject line from the list of Variables that appear beside the Subject field, which are specific to the Event Type selected.
- Click the variable name in the list. The variable code (e.g. ‘%%package_subscription_name%%’, ‘{account->id}’, ‘%%FNN%%’, etc.) will be added to the subject field. Position it within the text as required.
- Select the email Priority from the drop list (i.e. Low, Default, High).
- Use the Invoice check box under Attachments to indicate whether to attach the invoice to the email or not. Attaching the invoice is only valid against the ‘Invoice Delivery’, ‘Invoice Due’, ‘Invoice Overdue’ and ‘Invoice Post’ event types.
- Select the Invoice Template to attach in the drop list.
- Enter the message text in the Content box.
- The Content box is a basic HTML editor (i.e. tinyMCE). Some standard text formatting options are available.
- To add graphics to the message, such as an image or logo, the image file needs to be hosted externally. This is the preferred way of handling images in a message, rather than as attachments. This is done by editing the HTML directly, using the Edit HTML Source function, and including the image in the HTML code directly.
- Insert the required event Variables into the message. Different event types will have different event variables available. These are shown beside the Content box.
- Insert event variables to include in the message from the list of Variables that appear beside the Content box, which are specific to the Event Type.
- Click the variable name in the list. The variable code will be added to the subject field. Position it within the text as required.
- Use the Preview function to see how the message will appear to the customer.
- Click the Save button. The Template details will display.
- Click the Return to list button to exit.
To Edit a Template
- Select Events > Templates > from the Menu. A list of existing templates will be shown.
- Click the template ID or Name in the list. The selected template will be displayed.
- Click the Edit button.
- Enter or modify information in the appropriate fields.
- Click the Save button. The updated template details will display, with an information box showing the template has been saved successfully. You can close the information box by clicking the blue cross.
- Click the Return to list button to exit.
To Delete a Template
- Select Events > Templates > from the Menu. A list of existing templates will be shown.
- Click Delete Template beside the required template in the Delete Mapping column. An information box will display showing that the template has been deleted.
See also
