Message Property Set

Characteristics of a message’s structure are described in the following table.

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.