notify features overview presentation

© 2013 EngagePoint, Inc. All rights reserved.

ENGAGEPOINT NOTIFY

Features Overview

11/18/2013

EngagePoint.com 2

Agenda

Confidential Presentation © 2013 EngagePoint, Inc. All rights reserved.

• What is EngagePoint Notify?• Where do Messages Come From?• Configuring System Properties• Delivery Channels• Template Groups• Templates• Include Templates Feature• Static and Dynamic Attachments• Creating Global Placeholders• Exporting/importing Template Data• Template Data Package• SMS Subscription Setup• Service Keywords• Service Message Templates• Monitoring SMS Subscriptions

EngagePoint.com 3 Confidential Presentation © 2013 EngagePoint, Inc. All rights reserved.

What is EngagePoint Notify?

• EngagePoint Notify is a ready-to-use module for message generation that provides delivery services in a large-scale SOA environments.

• Based on a message template, EngagePoint Notify generates and reliably delivers personalized messages for individual recipients via their preferred communication channels.


Where do Messages Come From?

• Messages are generated based on notification templates.

You can: • Create your own templates directly in EngagePoint Notify• Upload templates configured in Eclipse BIRT1 using the

Import functionality

1 BIRT is an open-source Eclipse-based reporting system that integrates with your Java/Java EE application to produce compelling reports.

http://www.eclipse.org/birt/phoenix/


Configuring System Properties• System Administrator can configure the system

properties from the user interface • Navigate to Settings > Configuration Options


Delivery Channels

• Notification templates are configured for each delivery channel

• The following delivery channels are supported: Email SMS Print Mail Internal Mail


Template GroupsTemplates are organized into template groups that you can:• Add• Edit• Delete


Creating Template Groups

• You can search for a template group by specifying the template group name and category as the search criteria.


Types of Templates

The following types of templates are available:(Email) - templates for email

notifications(SMS) - templates for SMS notifications(Print Mail) - templates for printed mail

notifications(Attachment) - templates for dynamic

attachments


Creating Notification Templates

Templates within a template group have a unique combination of:• Language• MIME Type • Template TypeTo create a template:1. Navigate to Templates

> Template Management.

2. Click the Add Template button in the required template group.


Notification Templates ProcessingTemplates are processed by different rendering engines depending on the template type. The rendering engines support different MIME Types and generate notifications in various formats:• FreeMarker generates HTML and plain text

notifications• Eclipse BIRT generates the PDF notificationsTemplate Type MIME Type Rendering Engine

Email text/html, text/plain FreeMarker

SMS text/plain FreeMarker

Print Mail application/pdf BIRT

Attachment text/html, text/plain, application/pdf

BIRT, FreeMarker


Editing Templates

• Template body can be edited in the text editor on the Template Details page.• The following editors are available depending on the

MIME type of template:Rich text editor –

for text/html

Plain text editor –for text/plain, application/pdf

Include Templates Feature• You can include one template into another, thereby reusing the existing

content. Included templates should have the same rendering engine and MIME type as the base template.

1. Select the base template.2. In the body of template, enter the link to the template that you need to

include (for text/plain and application.pdf MIME types):

where the following values are available for• templateMimeType: text/plain, text/html, application/pdf• templateLanguage: en, es• templateType: email, sms, attachment, mail (for Print Mail templates)

For the application/pdf MIME type, place the include link into the comment tag: 

<#include"cmis://[templateGroupName]:[templateMimeType]:[templateLanguage]:[templateType]">


Including Templates

For text/html MIME type:1. Select the base template and go to its Template

Details page.2. On the rich text editor toolbar, click the Include

Template button .3. In Templates pop-up, select

the required template.4. Click the Insert button.


Static and Dynamic Attachments

Attachments can be added to the Email and Print Mail templates.• Static attachments are static files that are added to the

notification templates. These files are then included unchanged in all notifications based on a template with attachments.

Only the PDF files can be attached to Print Mail templates as static attachments. • Dynamic attachments are the PDF, HTML and .txt files

that can be filled with notification-specific data at the time of notification generation.

Only templates with the application/pdf MIME type can be attached to the Print Mail templates as dynamic attachments.


Adding Static Attachments

You can add up to 128 attachments with maximum size of 10 MB and total size of up to 100 MB.

1. Click the Edit template icon on Templates Overview.

2. Navigate to Template Details page > Static Attachments section > click Add Attachment.


Adding Dynamic Attachments

To add dynamic attachments to a template, you need to first create them in the system as Attachment templates.To add a dynamic attachment:1. Click the Edit template icon on Templates Overview.


Adding Dynamic Attachments

2. Navigate to Template Details page > Dynamic Attachments section.3. Click the Add Attachment button.

4. In the Dynamic Attachment pop-up window, select one or more templates that you want to attach. Use the Search functionality.5. Click OK.


Creating Global Placeholders• Global placeholders are specific types of information

containing the text fragments that can be used in all kinds of templates.

• Added to a template, a global placeholder's value is automatically inserted by default to all documents based on this template.

The default value of a global placeholder can be customized for a particular notification in a corresponding web service.


Creating Global Placeholders

1. Navigate Templates > Global Placeholders.2. Click Add Placeholder button.

3. Specify the placeholder details:• Key – a unique identifier of a

global placeholder. • Value –text fragment that will

be included to each document based on a template where placeholder is used.

• Language – language specified for a global placeholder has to be the same with the language of a template where this placeholder will be included.


Exporting/Importing Template Data

To import/export template data:1. Navigate to Settings > Import / Export.2. Click Import or Export.


Template Data Package

• Template data is exported as a ZIP archive. After unpacking, the data package has the following structure:


Global Placeholders Folder

• The GlobalPlaceholders folder contains XML files, each corresponding to a particular global placeholder. The XML files are named as "[key]-[language abbreviation]".xml.

• The XML file includes the following information:key - name of the placeholder language - language of the placeholdervalue - value to use for replacing the placeholder key

Combination of Key + Language should be unique in the system.

<globalPlaceholder> <key>Test Key</key> <language>en</language> <description>Test description</description> <value>Test value that will replace the key</value></globalPlaceholder>


Templates Group Folder• The Templates folder contains template group

folders, each corresponding to a separate template group. The folders are named as "TemplateGroup[template group name]“.

• Information about a template group is stored in the XML file that is named as "TemplateGroup.xml“. The XML file contains the following information about a template group:name categorydescription

<templateGroup> <name>Test group</name> <category>Test category</category> <description>Test description</description></templateGroup>


Templates Folder

• Any template that belongs to the template group is included as a subfolder to the template group folder. • The template subfolders are named as

"Template[Template type_language abbreviation_ Mime Type]“, where

Template type: email, sms, attachment, mail (for Print Mail templates)

Language abbreviation: en, esMimeType: text/plain, text/html, application/pdf


Templates Folder

• Every template folder includes:Template.xml - meta data of the template, its

properties.Template.content - body of the template, the

actual text.attachments subfolder - folder with static

attachments. This data is present for Email templates (files in any format) and Print Mail templates (PDF files only).


SMS Subscription Setup• EngagePoint Notify provides functionality for the SMS

subscription (campaign launch) using the mBlox messaging platform.

To use the SMS channel, each state has to go through the Cellular Telecommunications and Internet Association (CTIA) certification process that takes 8-12 weeks.


Service Keywords

• For the SMS subscription, there are specific (service) keywords that are processed by the system and return the messages with standard texting based on the appropriate predefined templates. • A user starts the subscription process by sending

the opt-in request - an SMS message - with the declared keyword CONNECTED to the SMS campaign short code.• The subscribed users can request HELP information

with the HELP keyword.• Users can unsubscribe from the SMS campaign by

sending the SMS message with the STOP keyword.


Service Message Templates

The complete list of the service message templates includes:• SMS Opt-in subscribed • SMS Opt-in not subscribed • SMS Opt-out subscribed • SMS Opt-out not subscribed • SMS Help subscribed • SMS Help not subscribed • SMS Unrecognized • SMS Reminder • SMS Subscription pin


Monitoring SMS Subscriptions• You can get the information about a SMS

subscription at any time• Navigate to Settings > Subscription History


Thank you for attention!

• • • • • •

For more information:

notify features overview presentation

Documents