Embed Size (px)
Citation preview
Transactional MessagingTechnical Documentation
Adobe Campaign v6.1
© 2017, Adobe System Incorporated
All rights reserved.
Published by Adobe Systems Inc.
Terms of use | Privacy Center
A trademark symbol (®, ™, etc.) denotes an Adobe trademark.
All third-party trademarks are the property of their respective owners. Updated Information/Additional Third Party Code Information available athttp://www.adobe.com/go/thirdparty
Neolane, an Adobe Company18 rue Roger Simon Barboux, 94110 Arcueil - France+33 1 41 98 35 35www.adobe.com
Adobe Campaign v6.1 - Transactional Messaging
Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About transactional messaging . . . . . . . . . . . . . . . . . . . . . . . . . 5Transactional messaging architecture . . . . . . . . . . . . . . . . . . . . . . 6
About execution and control instances . . . . . . . . . . . . . . . . . . . . . 6Supporting several control instances . . . . . . . . . . . . . . . . . . . . . . 7Installing instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Adding a delivery channel . . . . . . . . . . . . . . . . . . . . . . . . . 8Transactional messages and inbound Interaction . . . . . . . . . . . . . . . . . 9Transactional messaging and push notifications . . . . . . . . . . . . . . . . . . 9
Event description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10About transactional messaging datamodel . . . . . . . . . . . . . . . . . . . 10SOAP methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Information returned by the SOAP call . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2. Instance configuration . . . . . . . . . . . . . . . . . . . . . . . 15
Creating a shared connection . . . . . . . . . . . . . . . . . . . . . . . . . 15Control instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Execution instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Using several control instances . . . . . . . . . . . . . . . . . . . . . . . 20
Identifying execution instances . . . . . . . . . . . . . . . . . . . . . . . . 23Monitoring thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Purging events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Technical workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Control instance workflows . . . . . . . . . . . . . . . . . . . . . . . . . 25Execution instance workflows . . . . . . . . . . . . . . . . . . . . . . . . 27
Creating event types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Configuring multibranding . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Typical process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Chapter 3. Message templates . . . . . . . . . . . . . . . . . . . . . . . . 29
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Creating the message template . . . . . . . . . . . . . . . . . . . . . . . . 29Creating message content . . . . . . . . . . . . . . . . . . . . . . . . . . 32Managing seed addresses . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Adobe Campaign v6.1 - Transactional Messaging | 3
Table of Contents
Creating a seed address . . . . . . . . . . . . . . . . . . . . . . . . . . 34Creating several seed addresses . . . . . . . . . . . . . . . . . . . . . . . 36
Personalization data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Transactional message preview . . . . . . . . . . . . . . . . . . . . . . . . 38Sending a proof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Chapter 4. Template publication . . . . . . . . . . . . . . . . . . . . . . . 43
Chapter 5. Event processing . . . . . . . . . . . . . . . . . . . . . . . . . 47
About event processing . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Event collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Routing towards a template . . . . . . . . . . . . . . . . . . . . . . . . . 48Delivery execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Event recycling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 6. Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
About transactional messaging reports . . . . . . . . . . . . . . . . . . . . . 53History of Message Center events . . . . . . . . . . . . . . . . . . . . . . . 54Message Center service level . . . . . . . . . . . . . . . . . . . . . . . . . 55Message Center processing time . . . . . . . . . . . . . . . . . . . . . . . . 56
4
Table of ContentsAbout transactional messaging . . . . . . . . . . . . . . . . . . . . . . . . . . 5Transactional messaging architecture . . . . . . . . . . . . . . . . . . . . . . . . 6
About execution and control instances . . . . . . . . . . . . . . . . . . . . . . 6Supporting several control instances . . . . . . . . . . . . . . . . . . . . . . . 7Installing instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Adding a delivery channel . . . . . . . . . . . . . . . . . . . . . . . . . . 8Transactional messages and inbound Interaction . . . . . . . . . . . . . . . . . . . 9Transactional messaging and push notifications . . . . . . . . . . . . . . . . . . . . 9
Event description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10About transactional messaging datamodel . . . . . . . . . . . . . . . . . . . . . 10SOAP methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Information returned by the SOAP call . . . . . . . . . . . . . . . . . . . . . . 12
About transactional messaging
Transactional messaging (Message Center) is a Campaign module designed for managing trigger messages. Thesemessages are generated from events triggered from information systems, and can be: invoice, order confirmation,shipping confirmation, password change, product unavailability notification, account statement or website accountcreation for instance.
Adobe Campaign Message Center module is integrated into an information system which returns events to bechanged into personalized transactional messages. These messages can be sent individually or in batches via email,SMS or push notifications.
In this specific architecture, execution cell is separated from the control instance, which ensures higher availabilityand better load management.
Note:
To create new users for Message Center execution instances hosted on Adobe Cloud, you need to contact AdobeCustomer Care. Message Center users are specific operators that require dedicated permissions to access 'Real timeevents' (nmsRtEvent) folders.
Adobe Campaign v6.1 - Transactional Messaging | 5
CHAPTER 1
Introduction
Transactional messaging architecture
About execution and control instancesIn Adobe Campaign, transactional messaging capabilities (also known as Message Center) were designed to supportscalability and provide a 24/7 service. It is made up of several instances:
n a control instance, which the message templates are created in,
n one or more execution instances which receive events and deliver messages.
To use these capabilities, Adobe Campaign users log on to the control instance to create transactional messagetemplates, generate the message preview using a seed list, display reports and monitor execution instances.
Execution instances receive events, link them to transactional message templates, and send a personalized messageto each recipient.
Depending on the amount of data to be processed, the architecture is either:
n broken down: the control instance is installed on a machine and the various execution instances on separateservers.
To find out how to get the various instances to communicate with each other via external accounts, refer toCreating a shared connection [page 15]
n minimal: the control and execution instances are installed on the same machine. With this type of installation,there is no need to configure external accounts.
6
Supporting several control instancesIt is possible to share an execution cluster among several control instances. For example, if you manage severalspecialized stores, you can configure one control instance per brand and link them all to the same execution cluster.
Note:
For more on the necessary configuration, refer to Using several control instances [page 20].
Installing instancesThere are several precautions to take when installing the Transactional message packages. Adobe recommends youto work in a test environment before putting into production. You also need to have a compatible Adobe Campaignlicense. For more information, please contact your Adobe account executive.
If you need to use several channels, you must install and configure related packages before installing Transactionalmessage packages. Refer to Adding a delivery channel [page 8].
n To install the control instance on your machine, select the Transactional message control module.
Adobe Campaign v6.1 - Transactional Messaging | 7
Introduction
n To install the execution instance on your machine, select the Transactional message execution module.
Adding a delivery channelAdding a delivery channel (mobile channel, Mobile App channel, etc.) must be performed before installing theTransactional message package. If you have started a transactional messaging project on the email channel, thendecide during the project to add a new channel, you must follow these steps:
1 Install the channel you need, for example the Mobile channel, using the package import wizard (Tools >Advanced > Import package... > Adobe Campaign Package).
2 Perform a file import (Tools > Advanced > Import package... > File), and select the \datakit\nms\[Yourlanguage]\package\messageCenter.xml file.
3 In the XML content of the data to import, keep only the delivery template that corresponds to the addedchannel. For example, if you have added the Mobile channel, keep only the entities element that correspondsto the Mobile transactional message (smsTriggerMessage). If you have added the Mobile App Channel, keeponly the iOS transactional message (iosTriggerMessage) and the Android transactional message(androidTriggerMessage).
8
Transactional messages and inbound InteractionWhen combined with the Inbound Interaction module, transactional messaging enables you to insert a marketingoffer dedicated to the recipient into the message.
Note:
The Interaction module is detailed in Interaction.
To use transactional messaging with Interaction, you need to apply the following configurations:
n Install the Interaction package onto the control instance and configure your offer catalog.
Warning:
Do not replicate the offers onto the execution instances.
n The event must include an identifier linked to the recipients, for personalizing offers. The @externalId attributemust contain the value of this identifier. Interaction is configured by default to identify the recipient of the primarykey:
<rtEvent type="order_confirmation" email="[email protected]" externalId="1242">
You can configure Interaction so that identification takes place in the field of your choice, for example on theemail address:
<rtEvent type="order_confirmation" email="[email protected]" externalId="[email protected]">
Create your delivery templates the way you would for an email campaign:
n Add the offer to your transactional message template.
n Check the preview, send a proof and publish the template.
You also have to enable the unitary mode on your offer spaces. For more on this, refer to the Interaction guide.
Transactional messaging and push notificationsWhen combined with Mobile App channel module, transactional messaging enables you to push transactionalmessages through notifications on mobile devices.
Note:
The Mobile App channel is detailed in the Delivery guide.
To use transactional message modules with Mobile App Channel, you need to apply the following configurations:
1 Install the Mobile App Channel package onto the control and execution instances.
2 Replicate the Mobile application type Adobe Campaign service as well as the mobile applications that it containson the execution instances.
The event must contain the following elements:
n The mobile device ID (registrationId for Android and deviceToken for iOS). This ID represents the "address"that the notification will be sent to.
n The link to the mobile application or integration key (uuid) which lets you recover connection informationspecific to the application.
n The channel to which the notification will be sent (wishedChannel): 41 for iOS and 42 for Android
n All data useful for personalization
Here is an example of an event that contains this information:
<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <urn:PushEvent>
Adobe Campaign v6.1 - Transactional Messaging | 9
Introduction
<urn:sessiontoken>mc/</urn:sessiontoken> <urn:domEvent>
<rtEvent wishedChannel="41" type="DELIVERY" registrationToken="2cefnefzef758398493srefzefkzq483974"> <mobileApp _operation=”none” uuid="com.adobe.NeoMiles"/> <ctx> <deliveryTime>1:30 PM</deliveryTime> <url>http://www.adobe.com</url> </ctx> </rtEvent>
</urn:domEvent> </urn:PushEvent> </SOAP-ENV:Body></SOAP-ENV:Envelope>
Note:
The creation of message templates remains the same.
Event description
About transactional messaging datamodelTransactional messaging relies on Campaign datamodel, and uses two additional separate tables. These tables,NmsRtEvent and NmsBatchEvent, contain the same fields and let you manage real time events on the one handand batch events on the other.
SOAP methodsThis section details the SOAP methods associated with the transactional messages module schemas.
Two PushEvent or PushEvents SOAP methods are linked to the two nms:rtEvent and nms:BatchEvent dataschemas.It is the information system that determines whether an event is a "batch" or "real time" type.
n PushEvent lets you insert a single event into the message,
n PushEvents lets you insert a series of events into the message.
The WSDL path for accessing both methods is:
n http://hostname/nl/jsp/schemawsdl.jsp?schema=nms:rtEvent to access the real-time type schema.
n http://hostname/nl/jsp/schemawsdl.jsp?schema=nms:batchEvent to access the batch type schema.
Both methods contain an <urn:sessiontoken> element for logging on to the transactional messaging module.We recommend using an identification method via trusted IP addresses. The value of the field matches the login ofthe operator: <urn:sessiontoken>mc/</urn:sessiontoken> (the mc/ value is the out-of-the-box valueprovided by Adobe Campaign).
The PushEvent method is made up of a <urn:domEvent> parameter which contains the event.
The PushEvents method is made up of a <urn:domEventCollection> parameter which contains events.
Example using PushEvent:
<urn:PushEvent>
<urn:sessiontoken>mc/</urn:sessiontoken>
<urn:domEvent>
<rtEvent>
...
</rtEvent>
</urn:domEvent>
10
</urn:PushEvent>
Note:
In case of a call to the PushEvents method, we need to add a parent XML element to comply with standard XML.This XML element will frame the various <rtEvent> elements contained in the event.
Example using PushEvents:
<urn:PushEvents>
<urn:sessiontoken>mc/</urn:sessiontoken>
<urn:domEventCollection>
<Events>
<rtEvent>... </rtEvent>
<rtEvent>... </rtEvent>
...
</Events>
</urn:domEventCollection>
</urn:PushEvents>
The <rtEvent> and <batchEvent> elements have a set of attributes as well as a mandatory child element:<ctx> for integrating message data.
Note:
The <batchEvent> element lets you add the event to the "batch" queue. The <rtEvent> adds the event to the"real time" queue.
The mandatory attributes of the <rtEvent> and <batchEvent> elements are @type and @email. The value of@type must be the same as the itemized list value defined when configuring the execution instance. This value letsyou define the template to be linked to the content of the event during the delivery.
<rtEvent> configuration example:
<rtEvent type="order_confirmation" email="[email protected]" origin="eCommerce" wishedChannel="0" externalId="1242" mobilePhone="+33620202020">
In this example, two channels are provided: the email address and the mobile phone number. The wishedChannellets you select the channel you wish to use when transforming the event into a message. The "0" value correspondsto the email channel, the "1" value to the mobile channel, etc.
If you wish to postpone an event delivery, add the scheduled field followed by the preferred date. The event will betransformed into a message on this date.
We recommend filling in the @wishedChannel and @emailFormat attributes with numeric values. The function tablewhich links numeric values and labels is found in the data schema description.
Note:
A detailed description of all authorized attributes as well as their values is available in the description of thenms:rtEvent and nms:BatchEvent dataschema.
The <ctx> element contains the message data. Its XML content is open, which means it can be configured dependingon the content to be delivered.
Adobe Campaign v6.1 - Transactional Messaging | 11
Introduction
Note:
It is important to optimize the number and size of XML nodes contained in the message to avoid overloading theservers during delivery.
Data example:
<ctx> <client> <firstname>John</firstname> <lastname>Doe</lastname> </client> <action> <type>Order confirmation</type> <number>CN23453</number> </action> <orderdetails> <article num="1"> <name>Generic USB key</name> <price>20</price> </article> </orderdetails> </ctx>
Information returned by the SOAP callWhen it receives an event, Adobe Campaign generates a unique return ID. This is the ID of the archived version ofthe event.
Warning:
When receiving SOAP calls, Adobe Campaign verifies the email address format. If an email address is incorrectlyformatted, an error is returned.
n Example of an identifier returned by the method when event processing is successful:
<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns="http://xml.apache.org/xml-soap" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <urn:PushEventResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:nms:rtEvent"> <plId xsi:type="xsd:long">72057594037935966</plId> </urn:PushEventResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>
If the value of the return identifier is strictly greater than zero, this means the event has been successfully archivedin Adobe Campaign.
However, if the event fails to be processed, the method returns an error message or a value equal to zero.
n Processing example of an event that failed when the query does not contain a login or the specified operatordoesn't have the required rights:
<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xsi:type="xsd:string">Error while reading parameters of method 'PushEvent' of service 'nms:rtEvent'.</faultstring> <detail xsi:type="xsd:string">Invalid login or password. Connection denied.</detail>
12
</SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>
n Example of an event that failed due to an error in the query (the XML classification isn't complied with):
<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body><SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Client</faultcode><faultstring xsi:type="xsd:string">The XML SOAP message is invalid (service
'PushEvent', method 'nms:rtEvent').</faultstring><detail xsi:type="xsd:string"><![CDATA[(16:8) : Expected end of tag 'rtevent'
Error while parsing XML string '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:nms:rtEvent">
<soapenv:Header/><soapenv:Body>
<urn:PushEvent><urn:sessiontoken>mc/</urn:sessiontoken><urn:domEvent>
<rtevent type="create_account" email="[email protected]" origin="eCommerce" wishedChannel="email"
externalId="1596" language="english" country="EN" emailFormat="2"mobilePhone="+447700123123">
<ctx><website name="eCommerce" url="http://www.eCo']]></detail>
</SOAP-ENV:Fault></SOAP-ENV:Body>
</SOAP-ENV:Envelope>
n Example of an event that failed and returned a zero identifier (wrong method name):
<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns="http://xml.apache.org/xml-soap" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <urn:PushEventResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:urn="urn:nms:rtEvent"> <plId xsi:type="xsd:long">0</plId> </urn:PushEventResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>
Adobe Campaign v6.1 - Transactional Messaging | 13
Introduction
14
Table of ContentsCreating a shared connection . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Control instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Execution instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Using several control instances . . . . . . . . . . . . . . . . . . . . . . . . 20
Identifying execution instances . . . . . . . . . . . . . . . . . . . . . . . . . 23Monitoring thresholds . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Purging events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Technical workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Control instance workflows . . . . . . . . . . . . . . . . . . . . . . . . . . 25Execution instance workflows . . . . . . . . . . . . . . . . . . . . . . . . . 27
Creating event types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Configuring multibranding . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Typical process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Creating a shared connection
Warning:
Schema extensions made on the schemas used by Message Center technical workflows on either control or executioninstances need to be duplicated on the other instances used by Adobe Campaign transactional messaging module.
Control instanceIf you have a broken down architecture, you need to specify the execution instances linked to the control instanceand connect them. Transactional message templates are deployed to the execution instances. The connectionbetween the control instance and the execution instances is created by configuring the Execution instance typeexternal accounts. You need to create as many external accounts as there are execution instances.
Note:
When execution instances are used by several control instances, data can be divided by folder and by operator. Formore on this, refer to Using several control instances [page 20].
Adobe Campaign v6.1 - Transactional Messaging | 15
CHAPTER 2
Instance configuration
To create an execution instance type external account, apply the following steps:
1 Go to the Administration > Platform > External accounts folder.
2 Select one of the execution instance type external accounts provided out-of-the-box with Adobe Campaign,right-click and choose Duplicate.
3 Change the label according to your needs.
4 Select the Enabled option to make the external account operational.
5 Specify the address of the server on which the execution instance is installed.
16
6 The account must match the Message Center Agent as defined in the operator folder. By default, the out-of-the-boxaccount provided by Adobe Campaign is mc.
7 Enter the password of the account as defined in the operator folder.
Note:
To avoid entering a password each time you log on to the instance, you can specify the IP address of the controlinstance in the execution instance. For more on this, refer to Execution instance [page 19].
8 Specify the recovery method to be used by the execution instance.
The data to recover is forwarded to the control instance by the execution instance, to add to transactionalmessage and event archives.
Data collection occurs either via a Web service which uses HTTP/HTTPS access, or via the Federated Data Access(FDA) module.
Adobe Campaign v6.1 - Transactional Messaging | 17
Instance configuration
The second method is recommended if the control instance has direct access to the database of the executioninstances. If not, choose the Web service access. The FDA account to specify coincides with the connection tothe databases of the various execution instances created on the control instance.
For more information on Federated Data Access (FDA), refer to Accessing an external database.
9 Click Test the connection to make sure the control instance and the execution instance are linked up.
10 Each execution instance must be associated with an identifier. This identifier can be attributed on each executioninstance either manually, by using the deployment wizard (refer to Identifying execution instances [page 23]),or automatically, by clicking the Initialize connection button from the control instance.
18
Execution instanceIn order for the control instance to be able to connect to the execution instance without having to giving a password,simply enter the IP address of the control instance in the Message Center access rights section. However, emptypasswords are forbidden by default. To use an empty password, go to the execution instances and define a securityzone limited to the IP address of the information system that delivers the events. This security zone must allow emptypasswords and accept <identifier>/<password> type connections. For more on this, refer to the Installation guide.
Note:
When execution instances are used by several control instances, data can be divided by folder and by operator. Formore on this, refer to Using several control instances [page 20].
1 Go to the operator folder in the execution instance (Administration > Access management > Operators).
2 Select the Message Center agent.
3 Select the Edit tab, click Access rights, and then click the Edit the access parameters... link.
Adobe Campaign v6.1 - Transactional Messaging | 19
Instance configuration
4 In the Access settings window, click the Add a trusted IP mask link and add the IP address of the control instance.
Using several control instancesYou can share an execution cluster with various control instances. This type of architecture requires the followingconfiguration.
For example if your company manages two brands, each with its own control instance: Control 1 and Control 2.Two execution instances are also used. You need to enter a different Message Center operator for each controlinstance: an mc1 operator for the Control 1 instance and an mc2 operator for the Control 2 instance. In the tree ofall the execution instances, create one folder per operator (Folder 1 and Folder 2), and restrict each operator's dataaccess to their folder.
Configuring control instances
1 In the Control 1 control instance, create one external account per execution instance, and enter the mc1 operatorin each external account. The mc1 operator will thereafter be created on all the execution instances (refer toConfiguring execution instances [page 21]).
20
2 In the Control 2 control instance, create one external account per execution instance, and enter the mc2 operatorin each external account. The mc2 operator will thereafter be created on all the execution instances (refer toConfiguring execution instances [page 21]).
Note:
For more on configuring a control instance, refer to Control instance [page 15].
Configuring execution instances
In order to use several control instances, this configuration has to be performed on ALL execution instances.
1 Create one folder per operator in the Administration > Production > Message Center node: Folder 1 and Folder2. For more on creating folders and views, refer to Platform.
Adobe Campaign v6.1 - Transactional Messaging | 21
Instance configuration
2 Create the mc1 and mc2 operators by duplicating the Message Center operator provided by default (mc). Formore on creating operators, refer to the Platform guide.
Note:
mc1 and mc2 operators must have Message Center execution rights and they cannot have access to the AdobeCampaign client console. An operator must always be linked with a security zone. For more on this, refer toInstallation Guide.
3 For each operator, check the Restrict to information found in sub-folders of box, and select the relevant folder(Folder 1 for the mc1 operator and Folder 2 for the mc2 operator).
22
4 Give each operator read and write permissions for their folder. To do this, right-click the folder and selectProperties. Then select the Security tab and add the relevant operator (mc1 for Folder 1 and mc2 for Folder2). Make sure that the Read/Write data boxes are checked.
Identifying execution instances
A unique identifier must be assigned to each instance to differentiate the history of each execution instance whenyou view them in the control instance. This step is mandatory even if your control and execution instances areinstalled on the same machine. This identifier can be manually attributed on each execution instance, via thedeployment wizard, or automatically by clicking the Initialize connection button from the control instance (seeControl instance [page 15]).
To manually attribute an identifier, open the deployment wizard on each execution instance, go to the MessageCenter window and assign your chosen identifier to the instance.
Adobe Campaign v6.1 - Transactional Messaging | 23
Instance configuration
Monitoring thresholds
You can configure the warning thresholds (orange) and alert thresholds (red) of the indicators that appear in theMessage Center service level and Message Center processing time reports (refer to Reports [page 53]). To do this,open the deployment wizard of the execution instance, go to the Message Center page and use the arrows to changethe thresholds.
Note:
The number of events pending in queue is displayed in the System indicators section of the Adobe Campaign processmonitoring page. For more information on the deployment wizard, refer to the Installation guide.
Purging events
You can use the deployment wizard to configure how long the data is to be stored in the database.
Event purging is carried out automatically by the Database cleansing workflow. This workflow purges the eventsreceived and stored on the execution instances and events archived on a control instance.
Use the arrows as appropriate to change the purge settings.
24
Event purge settings on a control instance:
Event purge settings on an execution instance:
For more on the database cleansing workflow, refer to Description of the database cleansing workflow.
Technical workflows
You must ensure that the technical workflows on the control instance and the different execution instances haveindeed been created and started before deploying any transactional message templates.
The various technical workflows related to transactional messaging (Message Center) are broken down betweenthe control instance and the execution instance(s).
Control instance workflowsOn the control instance, you must create one archiving workflow per execution instance. The archiving workflowscan then be accessed from the Administration > Production > Message Center folder. Once created, the archivingworkflows are automatically started.
Distributed architecture
Adobe Campaign v6.1 - Transactional Messaging | 25
Instance configuration
If you have one or several execution instances, on the control instance, you must create one archiving workflow foreach Message Center execution instance external account. Click the Create the archiving workflow button tocreate and start the workflow.
Minimal architecture
Once the control and execution modules are installed on the same instance, you must create the archiving workflowusing the deployment wizard. Click the Create the archiving workflow button to create and start the workflow.
26
Execution instance workflowsOn the execution instance(s), the technical workflows for transactional messaging can be accessed from theAdministration > Production > Message Center folder. You just have to start them. The workflows in the list are:
n Processing batch events (internal name: batchEventsProcessing): this workflow lets you break down batchevents in a queue before they are linked to a message template.
n Processing real time events (internal name: rtEventsProcessing): this workflow lets you break down real timeevents in a queue before they are linked to a message template.
n Update event status (internal name: updateEventStatus): this workflow lets you attribute a status to the event.
The following event statuses are available:
n Pending: the event is in the queue. No message template has been assigned to it yet.
n Pending delivery: the event is in the queue, a message template has been assigned to it and it is beingprocessed by the delivery.
n Sent: this status is copied from the delivery logs. It means that the delivery has been sent.
n Ignored by the delivery: this status is copied from the delivery logs. It means that the delivery was ignored.
n Delivery failed: this status is copied from the delivery logs. It means that the delivery failed.
n Event not taken into account: the event could not be linked to a message template. The event will not beprocessed.
Creating event types
Event types destined to be processed by Adobe Campaign must be created in the control instance. This can be donevia the Administration > Platform > Enumerations folder of the tree. Each event type matches a value in theeventType enumeration. This can be an order confirmation, password or order delivery change, etc.
For more on itemized lists, refer to Enumeration management.
Once the itemized list values have been created, log off and back on to your instance for the creation to be effective.
Configuring multibranding
This section describes one solution to configure tracking and mirror page URLs per brand, for transactional messagesin Adobe Campaign.
Adobe Campaign v6.1 - Transactional Messaging | 27
Instance configuration
Prerequisites
n All of the hosts must be added to the configuration file of the instance (config-<instance>.xml).
n Each brand must be assigned a sub-domain.
n You must have an HTTPS certificate for all brands if the web tracking is done on HTTPS pages.
Typical processTo configure multibranding, you need to configure both execution instances and control instance. In the executioninstances, follow the steps below:
1 Create one external account per brand.
Note:
Creating an execution instance type external account is presented in the Control instance [page 15] section.
2 Extend the nms:extAccount schema to add the tracking URL:
<attribute advanced="true" desc="URL of the tracking servers" label="Tracking server URL"length="100" name="trackingURL" type="string"/>
Note:
Extending an existing schema is presented in the Extending a schema section.
3 Modify the nms:extAccount form:
<container label="Message domain branding" type="frame"> <static type="help"> These parameters are used to override the DNS alias and addresses used during message delivery. When not populated, the values of the 'NmsServer_MirrorPageUrl' and 'NmsEmail_DefaultErrorAddr' options are used.</static> <input xpath="@mirrorURL"/> <input xpath="@trackingURL"/> <input img="nms:sendemail.png" menuId="deliveryMenuBuilder" type="scriptEdit"> xpath="errorAddress"/> </container>
4 Modify the NmsTracking_OpenFormula and NmsTracking_ClickFormula options to use the external accountinstead of a global option.
To do this, replace:
<%@ include option='NmsTracking_ServerUrl' %>
with:
<%@ value object="provider" xpath="@trackingURL" %>
Warning:
These changes could lead to conflicts when upgrading. You may need to manually merge these formulas withtheir new version.
On the control instance, you need to link delivery templates and external accounts. To do this, you need to:
1 Create one external account per brand with the same internal name as defined in step 1.
2 Create one default delivery template per brand.
3 In the delivery template's Properties, set the routing to the external account of the brand.
28
Table of ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Creating the message template . . . . . . . . . . . . . . . . . . . . . . . . . 29Creating message content . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Managing seed addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Creating a seed address . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Creating several seed addresses . . . . . . . . . . . . . . . . . . . . . . . . 36
Personalization data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Transactional message preview . . . . . . . . . . . . . . . . . . . . . . . . . 38Sending a proof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Introduction
To make sure each event can be changed into a personalized message, you need to create a message template tomatch each event type. Templates contain the necessary information for personalizing the transactional message.You can also use templates to test the message preview and send proofs using seed addresses before delivering tothe final target.
Using seed addresses, you can also display the rendering of the message for various internet access providers (inboxrendering) if you install the Deliverability module (for more on this, refer to the Delivery guide).
Creating the message template
1 Go to the Message Center>Transactional message templates folder in the Adobe Campaign tree.
Adobe Campaign v6.1 - Transactional Messaging | 29
CHAPTER 3
Message templates
2 In the list of transactional message templates, right-click and select New in the drop-down menu or click theNew button above the list of transactional message templates.
3 In the delivery window, select the delivery template suitable for the channel you want to use.
4 Change its label if necessary.
30
5 Select the type of event that matches the message you want to send.
Event types need to be created beforehand in the console. For more on this, refer to Creating event types[page 27].
6 Enter a nature and a description, then click Continue to create the message body (refer to Creating messagecontent [page 32]).
Adobe Campaign v6.1 - Transactional Messaging | 31
Message templates
Creating message content
The definition of the transactional message content is the same as for regular deliveries in Adobe Campaign. Forinstance, for an email delivery, you can create content in HTML or text format, add attachments or personalize thedelivery object. For more on this, refer to the chapter on Email delivery.
Warning:
Images included in the message must be publicly accessible. Adobe Campaign does not provide any image uploadmecanism for transactional messages.
Unlike in JSSP or webApp, `<%=` doesn’t have any default escaping. So you have to escape each data coming fromthe event properly. This escaping depends on how this field is used. For example, within a URL, please useencodeURIComponent. To be displayed in the HTML, you can use escapeXMLString.
Once you have defined your message content, you can integrate event information into the message body andpersonalize it. Event information is inserted into the body of the text thanks to personalization tags.
To insert personalization tags into the body of an email message, apply the following steps:
1 In the message template, click the tab that matches the email format (HTML or text).
2 Enter the body of the message.
32
3 In the body of the text, insert the tag using the Real time events>Event XML menus.
4 Fill in the tag using the following syntax: element name.@attribute name as shown below.
Adobe Campaign v6.1 - Transactional Messaging | 33
Message templates
Managing seed addresses
A seed address lets you display a preview of your message, send a proof, and test message personalization beforeemail or SMS delivery. Seed addresses are linked to the delivery and cannot be used for other deliveries.
Creating a seed address
1 In the transactional message template, click the Seed addresses tab.
2 Assign a label to it for easy selection later.
3 Enter the seed address (email or mobile phone depending on the communication channel).
34
4 Enter the external identifier: this optional field allows you to enter a business key (unique ID, name + email, etc.)that is common to all applications on your website, used to identify your profiles. If this field is also present inthe Adobe Campaign marketing database, you can then reconcile an event with a profile in the database.
5 Insert test data (refer to Personalization data [page 37]).
Adobe Campaign v6.1 - Transactional Messaging | 35
Message templates
Creating several seed addresses
1 Click the Add other seed addresses link, then click the Add button.
2 Follow the configuration steps for a seed address detailed in the Creating a seed address [page 34] section.
3 Repeat the process to create as many addresses as you need.
36
Once the addresses are created, you can display their preview and personalization. Refer to Transactional messagepreview [page 38].
Personalization data
It is possible to use data in the message template to test transactional message personalization. This functionality isused to generate a preview or send a proof. If you install the Deliverability module, this data allows you to displaya rendering of the messages for various internet access providers (Inbox rendering: for more on this, refer to theDelivery guide).
The purpose of this data is to test your messages before their final delivery. These messages do not coincide withactual data to be processed by Message Center. However, the XML structure must be identical to that of the eventstored in the execution instance, as shown below.
This information enables you to personalize message content using personalization tags (for more on this, refer toCreating message content [page 32]).
1 In the message template, click the Seed addresses tab.
Adobe Campaign v6.1 - Transactional Messaging | 37
Message templates
2 In the event content, enter the test information in XML format.
Transactional message preview
Once you have created one or more seed addresses and the message body, you can preview the message and checkits personalization.
1 In the message template, click the Preview tab.
38
2 Select A seed address in the drop-down list.
Adobe Campaign v6.1 - Transactional Messaging | 39
Message templates
3 Select the seed address created previously to display the personalized message.
40
Sending a proof
You can test message delivery by sending a proof to a previously created seed address.
Sending a proof involves the same process as for a regular delivery (for more on this, refer to the Delivery guide).However, to send a proof within Message Center you need to carry out the following operations beforehand:
n create one or more seed addresses (refer to Managing seed addresses [page 34]) with test data (refer toPersonalization data [page 37]),
n create the message content (refer to Creating message content [page 32]).
To send the proof:
1 Click the Send a proof button in the delivery window.
2 Analyze the delivery,
3 Correct any errors and confirm the delivery,
Adobe Campaign v6.1 - Transactional Messaging | 41
Message templates
4 Check that the message was delivered to the seed address and that its content complies with your configuration.
Proofs can be accessed in each template via the Audit tab.
42
Once the message template created on the control instance is complete, you can publish it on all execution instances.Publication lets you automatically create two message templates on the execution instance which will allow you tosend messages linked to real time and batch events.
Warning:
Remember to publish the template whenever you make any changes to it in order for these changes to be effectiveduring transactional message delivery.
Note:
When publishing transactional message templates, typology rules are automatically published on the executioninstances.
1 In the control instance, go to the Message Center > Transactional message templates folder of the tree.
2 Select the template you want to publish on your execution instances.
Adobe Campaign v6.1 - Transactional Messaging | 43
CHAPTER 4
Template publication
3 Click Publication.
44
Once publication is complete, both message templates to be applied to batch and real time type events are createdin the tree of the production instance in the Administration > Production > Message Center > Default > Transactionalmessage templates folder.
Adobe Campaign v6.1 - Transactional Messaging | 45
Template publication
46
Table of ContentsAbout event processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Event collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Routing towards a template . . . . . . . . . . . . . . . . . . . . . . . . . . 48Delivery execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Event recycling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
About event processing
In the context of transactional messaging, an event is generated by an information system and is sent to AdobeCampaign via the PushEvent and PushEvents methods (refer to Event description [page 10]). It contains data linkedto the event, such as its type (order confirmation or account creation on a website for instance), email address ormobile number, as well as other information that lets you enrich and personalize the transactional message beforedelivery. This can be customer contact information, the language of the message or the email format.
Example of event data:
To process transactional messaging events, the following steps must be applied:
1 Event collection,
2 Event enrichment prior to being transferred to a message template (if you acquired the enrichment optionavailable for Campaign transactional messaging module),
Adobe Campaign v6.1 - Transactional Messaging | 47
CHAPTER 5
Event processing
3 Event transfer to a message template,
4 Event enrichment with personalization data,
5 Delivery execution,
6 Recycling of events whose linked delivery failed (this step can be carried out via an Adobe Campaign workflow).
The Event history, under Message Center > Event history, groups all the processed events into one single view.They can be categorized by event type or by status. These statuses are:
n Pending: which means the event may be:
n an event which has just been collected and which has not yet been processed. The Number of errors columnshows the value 0. The email template has not yet been linked.
n an event processed but whose confirmation is erroneous. Tthe Number of errors column shows a value thatis not 0. To know when this event will be processed again, consult the Process requested on column.
n Pending delivery: the event was processed and the delivery template is linked. The email is pending deliveryand the classic delivery process is applied. For more information, you can open the delivery. Refer to Delivery.
n Sent, Ignored and Delivery error: these delivery statuses are recovered via the updateEventsStatus workflow.For more information, you can open the relevant delivery.
n Event not covered: the Message Center routing phase failed. For example, Adobe Campaign did not find theemail which acts as a template for the event.
n Event expired: the maximum number of send tries was reached. The event is considered null.
Event collection
Events generated by the information system can be collected using two modes:
n calls to SOAP methods let you push events in Adobe Campaign: the PushEvent method lets you send one eventat a time, the PushEvents method lets you send several at once. Refer to Event description [page 10].
n creating a workflow lets you recover events by importing files or via an SQL gateway (with the Federated DataAccess option).
Once they are collected, events are broken down - by technical workflows - between real time and batch queues ofthe execution instances, while waiting to be linked to a message template.
Routing towards a template
Once the message template is published on the execution instance(s), two templates to be linked to a real time ora batch event are automatically generated. The routing step consists of linking an event to the appropriate messagetemplate. Linking is based on the event type specified in the properties of the event itself and those of the template.
48
Definition of the event type in the event properties:
Definition of the event type in the message template properties:
By default, routing is based on the following information:
n the event type,
n the channel to be used (by default: email),
n the most recent delivery template, based on the publication date.
Delivery execution
Note:
The MTA prioritizes processing the transactional messages over any other delivery.
Adobe Campaign v6.1 - Transactional Messaging | 49
Event processing
On the execution instance, once the enrichment stages are complete and a delivery template has been linked to theevent, the delivery is sent. All deliveries are grouped in the Administration > Production > Message Center > Default> Deliveries folder.
By default, they are sorted into sub-folders by delivery month.
50
This sort can be changed in the message template properties as shown below.
Event recycling
If the delivery of a message on a specific channel fails, Adobe Campaign can resend the message using a differentchannel. For instance, if a delivery on the SMS channel fails, the message is resent using the email channel.
To do this, you need to configure a workflow which recreates all events with the Delivery error status, and assignsa different channel to them.
Adobe Campaign v6.1 - Transactional Messaging | 51
Event processing
Warning:
This step can only be carried out using a workflow and is therefore reserved for expert users. For more information,please contact Adobe account executive.
52
Table of ContentsAbout transactional messaging reports . . . . . . . . . . . . . . . . . . . . . . . 53History of Message Center events . . . . . . . . . . . . . . . . . . . . . . . . . 54Message Center service level . . . . . . . . . . . . . . . . . . . . . . . . . . 55Message Center processing time . . . . . . . . . . . . . . . . . . . . . . . . . 56
About transactional messaging reports
Adobe Campaign offers several reports that allow you to control the activity and smooth running of the executioninstances. These Message Center reports can be accessed from the Reports universe of the control instance.
Adobe Campaign v6.1 - Transactional Messaging | 53
CHAPTER 6
Reports
History of Message Center events
The History of Message Center events report provides you with an overview of the Message Center activity, i.e. thenumber of events processed and delivered as transactional messages.
When the report is opened, the information displayed by default coincides with the rate of successfully senttransactional messages. To view more levels, you can open the various nodes and place your cursor on the appropriatelevel to select it.
You can view the data specific to each event type, per time period. The Events column corresponds to the numberof events received per control instance. The number of events transformed into personalized transactional messagesis detailed in the Sent column.
The History of Message Center events report is a pivot table type report. For more on this, refer to the Analyzingpopulations section.
54
Message Center service level
This report displays the delivery statistics related to transactional messages as well as the error breakdown. You canclick on an error type to display its details. This report, aimed at technical administrators, can also be accessed viathe Monitoring universe in the control instance.
In this report, you can choose to display the overall statistics or those relative to a particular execution instance. Youcan also filter the data by channel and over a specific period. The indicators displayed in the Indicators over theperiod section are calculated over the period selected:
n Incoming (throughput event/h): average hourly number of events entered in the Message Center queue.
n Incoming (event vol): number of events entered in the Message Center queue.
n Outgoing (throughput msg/h): average hourly number of successful outgoing Message Center events (sent bya delivery).
n Outgoing (msg vol): number of successful outgoing Message Center events (sent by a delivery).
n Average sending time (seconds): average time spent in Message Center for successfully processed events. Thecalculation takes the processing time and the mta sending time into account.
n Error rate: number of events with errors compared to the number of events that have entered the MessageCenter queue. The following errors are taken into account: routing error, expired event (event that has been inthe queue too long), delivery error, ignored by the delivery (quarantine, etc.).
Note:
The warning (orange) and alert (red) indicator thresholds can be configured in the deployment wizard. Refer toMonitoring thresholds [page 24].
Adobe Campaign v6.1 - Transactional Messaging | 55
Reports
Message Center processing time
This report displays the main indicators related to the real time queue. This report, aimed at technical administrators,can also be accessed via the Monitoring universe in the control instance.
Just like for the Message Center service level report, you can choose to display the overall statistics or those relativeto a particular execution instance. You can also filter the data by channel and over a specific period. The indicatorsdisplayed in the Indicators over the period section are calculated over the period selected:
n Average queuing time: the average time that successfully processed events spent in Message Center. Only theprocessing time is taken into account.
n Average message sending time (s): the average time that successfully processed events spent in MessageCenter. Only the mta delivery time is taken into account.
n Average processing time (s): the average time that successfully processed events spent in Message Center. Thecalculation takes the processing time and the mta sending time into account.
n Maximum number of queued events: maximum number of events present in the Message Center queue atany given moment.
n Minimum number of queued events: minimum number of events present in the Message Center queue at anygiven moment.
n Average number of queued events: average number of events present in the Message Center queue at anygiven moment.
Note:
The warning (orange) and alert (red) indicator thresholds can be configured in Adobe Campaign deployment wizard.Refer to Monitoring thresholds [page 24].
56
