|
|
| (5 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | == System Events - Templates == | + | =This Content Has Moved House= |
| | | | |
| − | === Introduction ===
| + | This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base. |
| | | | |
| − | 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.
| + | We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home. |
| | | | |
| − | 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.
| + | [https://resources.emersion.com/display/EKB/Event+Templates Take me to the Emersion Knowledge Base article] |
| | | | |
| − | | + | [[file:new_home_sm.jpg|900px]] |
| − | ----
| |
| − | | |
| − | ===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 [[SystemEvents/Templates#Field Definitions|''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.
| |
| − | | |
| − | | |
| − | === Field Definitions ===
| |
| − | | |
| − | * '''Name''' is simply a name reference for the user.
| |
| − | * '''Event Type''' is the event type that this message is applied to.
| |
| − | * '''Sender''' is what will be used as the sender of the email.
| |
| − | * ''Recipients'' is a complex field allowing the user to select where the message will be sent. Choices can be;
| |
| − | ** '''Default Account Recipient''' which uses some business logic to work out the recipient from the users account. (''Effectively looks for the existence of an email address by first checking the Billing Contact, then Primary Contact'')
| |
| − | ** '''Primary Contact''' will use the Primary Contact's Email Address
| |
| − | ** '''Secondary Contact''' will use the Secondary Contact's Email Address
| |
| − | ** '''Billing Contact''' will use the Billing Contact's Email Address.
| |
| − | ** '''Custom ...''' which allows the user to enter a semi-colon delimited list of email addresses.
| |
| − | * '''CC''' is the carbon copy field.
| |
| − | * '''BCC''' is the blind carbon copy field.
| |
| − | * '''Subject''' is the subject field. This field accepts variables, a list of variables will appear next to the field when in focus to assist the user as to what is available.
| |
| − | * '''Priority''' is the message priority.
| |
| − | * '''Attachment''' will only appear for invoice based event types and can be only None or Invoice.
| |
| − | * '''Content''' is a HTML editor which also allows template variables.
| |
| − | | |
| − | | |
| − | ----
| |
| − | | |
| − | === See also ===
| |
| − | * [[SystemEvents/EventTypes|Event types]]
| |
| − | * [[SystemEvents/Actions|Event actions]]
| |
| − | * [[SystemEvents/Triggers|Triggers]]
| |
| − | | |
| − | <br style="clear:both" />
| |
| − | | |
| − | [[Category:SystemEvents]]
| |
This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home.
