Contact Us   |   About eCircle   |   News   |   Newsletter   |   Imprint   
eCircle_logo

 
XMLNotifications
Your trail:
Header

XML Notifications are generated by eC-Messenger on various events. They consist of a well-defined XML and are sent to configured addresses. If you are not familiar with eC-messenger, you should read EcmessengerIn5Minutes first.

XML Specification#

The XML for the generated messages is defined in a W3C Schema. Among other elements, this schema specifically defines the elements described as follows.

Most these xml elements extend a standard schema type userType which is illustrated here. For group-level notifications, a grouptype is usually used to tell about the recipient group (the list) which the user and the notification belongs to.

Profile Change Notifications#

These system level notifications may be configured by ecircle personnel only. There are the following notifications:

  • change-profile: Send upon a successful (self-initiated) profile change of the user. There are several use cases like immediate change in response to a web form or a change following a subsequent confirmation only. In all cases, this notification goes out only after a successful end of that use case.
  • change-email: Similiar, sent out after a email change was completed.
  • change-mobile: Similiar, sent out after a mobile number change was completed.

This type of notification contains the information before and after the change:

.

There is a fallback mechanism in place, in case the configured target addres does not respond. In this case, the System-Administrator of the customer system is contacted, usually somebody from eCircle.

This notification may be send from within a group or a system context. Only in group context, it will carry a group-id attribute and it will reveal the member attributes in the profile node. The context is usually determined by the configuration of the respective trigger

Blacklisted Notification#

Very similiar to the Profile Change Notifications mentioned above, only that the XML element is named blacklist and the new-branch is not existing. This notification is issued if a user has been blacklisted.

This notification is issued upon successful blacklisting only; due to the thourough cleanup from the system, that might be much later than when the blacklisting was started.

This notification is enabled/disabled together with the profile change setting.

Subscription Change Notifications#

These group-level notifications can be configured by a user of eC-messenger, that has the right permissions assigned[1]. These notifications may be configured to send a minimal or maximal data set[3]. Graphically, such a notification looks as follows:

.

  • subscribe: Send upon a successful (self-initiated) subscription. There are several subscription use cases, depending of the desired opt-in process. In all cases, this notification goes out only after a successful end of such a process[2].
  • unsubscribe: Similiar, sent out after a completed (self initiated) unsubscription.
  • bounce: A bounce notification is sent whenever a recipient is marked as bounce. This happens under consideration of the bounce settings that are set up for the given group (N bounces within X hours). A bounce classification was done on this address then already (see Handbook of eC-messenger). The bounce-reason contains the email text, that lead to bounce detection.

Import Report Notification#

A Import report can sent once a recipient import finished[4]. There is a human readable confirmation email too, which is not discussed here. That this notification is issued, must to be specified in the Configuration of the Import-Task.

Here(info) is a sample report.

Sendout Finished Notification#

This notification is sent after a group sendout (not a single message or a re-send group message) finished. It can be set up using group settings or the async API's control message.

Addressing options#

When specifying the target address of a notification, all supported eC-messenger address types are available. In all cases, the XML described above is the payload of the message send to these addresses.

You get a good impression about the XML Notification, if you let the system mail the notification to you, using a mailto:-Address first.
[#1] Set up using dom_customer_domain.external_service
[#2] There are also configuration option per group, that allow to forward the complete opt-in process to a external service.
[#3] Set up on system level, using dom_customer_domain.f_full_xml_report
[#4] To be configured by giving an address to the import configuration.
  Page Info Edit
This page (revision-10) last changed on 14:21 25-Jun-2010 by bschulze.