Bookshelf v8.0: Components of Unified Messaging

The UMS business service relies on pluggable message display services that are responsible for displaying messages and accepting user responses. These message display services are the following:

Figure 36 shows the interaction between UMS and registered message display services.

Message display services subscribe to updates to the message cache in the UMS. A message display service subscribes when it is included in the user interface. A message display service unsubscribes when it is not included in the user interface. More than one message display service can be subscribed at the same time.

Update Messages Method

The UMS calls the Update Messages method on the message display service every time the message cache is updated.

Process Response Method

The message display service invokes the Process Response method on the UMS when the user selects a response in the UI.

Custom Message Display Services

If necessary, you can develop your own message display service for use with the UMS as long as it adheres to the protocol of method invocations described in Registered Message Display Services. Using a custom message display service, you may choose to provide a different UI layout or a filter to display only a subset of messages.

Payload Variables

A payload variable is a name/value pair associated with a message instance. It can be substituted into the final message text, saved to the database when a response is logged, used as the scope for duplicate message suppression, or used to process a response. For example:

The payload property set is passed with the message to message display services and automated response services. The payload structure is a set of name/value pairs.

Any payload variable can be substituted into the text by enclosing its name in []. Any payload variable can be logged to the response table as long as a Response Field mapping is specified.

You create payload variables by navigating to Administration - Application > Message Types > Payload.

Message Property Set

Table 36. Message Structure Attributes
Attribute	Type	Description
Message Id	String	A unique identifier for the message. This is used to make sure the same message does not display twice. Every time a message is displayed, it must be assigned the same message ID to enable suppression of repeated messages. This is also used to identify the message when an action is selected.
Message Type	String	The message type of the message. Refers to a row in the Message Types table.
Score	Number	An integer between 1 and 100 indicating the priority of the message. This is used to determine the order in which passive messages are displayed.
Display Mode	String	(Optional) Indicates how to display the message. Seed data values are "Active" and "Passive". You (the integrator) can extend this list. NOTE: This input is optional. If not specified for a particular message, then the Display Mode defaults from the message type.
[Payload]	Property Set	A list of name/value pairs that are used to specialize the display and processing of the message. Examples: Line Item Id = "12-ABC123" Upsell Product = "Canon 128 MB Memory Card" The payload attributes are defined in the Message Type administration view. They are stored as sibling properties of Message Id, Score, and so on.

Message List Property Set

The example that follows shows the structure of a sample message list called "Message List."

This sample message list consists of a set of messages. Each message has a child property set providing the payload properties.

Message Responses

A message type with an active display mode means that a dialog box is displayed to the user, and the user must provide a response. A message type response is an allowed response to a message. Defining message type responses is part of the process of creating a message type.

You create message type responses in the Administration - Application > Message Types > Responses view. For information on creating message type responses, see Creating Message Types.

Message Translations

The Unified Messaging framework allows for translations of message text and message response text. If you are implementing message translations, you enter the translations as part of the process of creating a message type. You create message type translations in the Administration - Application > Message Types > Translations view. For information on creating message translations, see Creating Message Types.