System Administration
Message Types H
Use this page to Add a Message Type.
To access this page, select Admin > Configuration > Setup > Message Types.
|
Description |
|
|
Test |
Click to view a sample of the selected message as it displays in the Stewardship Tier. |
|
Copy |
Click to copy the message to use as the basis for a new message. |
|
MESSAGE TYPE NAME |
Displays the name of the message type. NOTE: Use this name when referring to the message type in any custom code. NOTE: Name the message so that developers and users can ascertain the scope of the message type and the application it runs in (for example, Cransoft.Event.Error). |
|
TITLE |
Displays the name that displays on the message. |
|
IMAGE ID |
Displays the name of the image file used in the message. Images are added on the Images page. Refer to Add an Image to the Stewardship Tier for more information. |
|
COLOR ID |
Displays the ID for the background color of the message. |
|
DESCRIPTION |
Displays a description of the message. NOTE: This can be used to classify the message type as a Notification, Error, or other type. |
|
IMAGE |
Displays the image that is included in the message. |
|
COLOR |
Displays the background color of the message. |
Message Types V
|
Field |
Description |
|
Message Type Name |
Displays the name of the message type. NOTE: Use this name when referring to the message type in any custom code. NOTE: Name the message so that developers and users can ascertain the scope of the message type and the application it runs in (for example, Cransoft.Event.Error). |
|
Storage |
|
|
Retention Days |
Displays the number of days the message is stored in the database. |
|
Notification Behavior |
|
|
Message Expansion Threshold |
Displays the maximum number of characters that can display in the message window. If the threshold is exceeded, when the message displays to the user, the message content is replaced with a predefined message, and a link is provided to view the message content in a separate pane within the Stewardship Tier. |
|
Require Action |
If checked, the user must click the message to close it. In unchecked, the message fades after displaying for a few seconds. |
|
Archive |
If checked, error messages are archived in the database, and can be viewed in the Messages tab accessed from the Quick Panel. |
|
Online Alert Only |
If checked, if the message is sent when a user is not logged in, it will not display in the Stewardship Tier when the user logs in. The user must click the Messages tab in the Quick Panel to view the message. If unchecked, the message displays as soon as the user is logged in. |
|
Read On Alert |
If checked, when the message displays to the user, it does not increment the unread message counter displayed on the Messages tab on the Quick Panel. If unchecked, the unread message counter is always incremented when a message with this message type displays. |
|
Workflow Properties |
|
|
Workflow Send Message |
Displays how a workflow message displays in the Stewardship Tier if this message type is used with a workflow business rule. Values are:
NOTE: If the user is online, the message isn't sent. It doesn't display in the Stewardship Tier, and does not display on the Messages tab in the Quick Panel.
Refer to Workflow Views for more information. |
|
Workflow Send Email |
Displays how a workflow email is sent to the user if this message type is used with a workflow business rule. Values are:
NOTE: If the user is online, the email isn't sent.
Refer to Workflow Views for more information. |
