Introduction
- Notifications are managed from the Configuration -> Notification sub-view.
- The configuration format of notifications is XML. The JOC Cockpit offers a schema-aware XML Editor for configuration purposes.
Notification View
The Notification View allows to manage the configuration:
Explanation:
- If this view shows an empty configuration then the "New" button can be used to created a configuration.
- Alternatively a configuration can be added with the "Upload" button. A configuration sample is available from the
jetty_base/resources/xsd/notifications/notification.xml-example
file.
Structure of the Configuration
The configuration make use of the following base elements that are available from the Configurations root element.
- Fragments
- Fragments define re-usable configuration blocks for Messages, Monitors and monitored Objects.
- MessageFragments
- Message
- Defines the content that is sent e.g. by mail to a user or that is used to parameterize a command line utility, e.g. for forwarding to a System Monitor.
- Messages for use with E-Mail represent the mail body either for use with plain text e-mails or for use with HTML e-mails.
- Messages for use with the Command Line represent a string that can be used with the Notifications/Notification/NotificationMonitors/CommandFragmentRef element, see below.
- Message elements can include Monitor Variables that are placeholders for values, e.g. for the Workflow Path, Order ID etc.
- Any number of Message elements can be added.
- Defines the content that is sent e.g. by mail to a user or that is used to parameterize a command line utility, e.g. for forwarding to a System Monitor.
- Message
- MonitorFragments
- Such fragments come in two flavors:
- MailFragment
- The following elements are required to send mail:
- MessageRef: Specifies a reference to a Message element that provides the mail body.
- Subject: Specifies the mail subject that can include Monitor Variables.
- To: Specifies the e-mail address of the recipient. Multiple recipients can be separated comma.
- The following elements are optional to send mail:
- CC: The recipient of carbon copies. Multiple recipients can be separated by comma.
- BCC: The recipient of blind carbon copies. Multiple recipients can be separated by comma.
- From: The e-mail address of the account that is used to send mail. Consider that it depends on your mail server configuration if a specific account has to be used or if an arbitrary account can be used.
- The following elements are required to send mail:
- CommandFragment
- x
- MailFragment
- Such fragments come in two flavors:
- ObjectFragments
- x
- MessageFragments
- Fragments define re-usable configuration blocks for Messages, Monitors and monitored Objects.
- Notifications
- x
Variables
Notifications for use with E-Mail
Notifications for use with the Command Line
Overview
Content Tools