...

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.
    • MonitorFragments. Such fragments come in two flavors:
      • MailFragment
        • The following elements are required to send mail:
          • MessageRef: Specifies a the 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 by 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.
      • CommandFragment
        • x
    • ObjectFragments
      • x
• Notifications
  • x
• • • • • MessageRef: Specifies the reference to a Message element that provides the content that should be forwarded with the Command element. The message content is available from the ${MESSAGE} Monitor Variable for use with later elements.
        • Command: Specifies the shell command for Linux/Windows that is used to forward notifications, e.g. a System Monitor Agent utility.
          • The above notification view example makes use of a shell command like this:
            • echo "${MESSAGE}" >> /tmp/notification.log
          • The echo shell command appends the content of the ${MESSAGE} Monitor Variable to a file in the /tmp directory.
    • ObjectsFragments
      • Workflows: Any umber of workflow configurations can be added and are distinguished by a unique name that is added to this element.
        • Workflow: A specific workflow can be specified, e.g. by its name. The path attribute allows a regular expression to specify a part of the workflow path.
          • WorkflowJob: This element can be used to limit notifications to specific jobs in a workflow.
            • This includes to optionally specify the job name and/or its label.
            • When using this element then it is required to specify the criticality that can be one of ALL, NORMAL, CRITICAL.
            • Optionally the return_code_from and return_code_to attributes can be used to further limit notifications to jobs that complete with the given return code. For shell jobs the return code corresponds to the OS exit code.
• Notifications: xx
  • Notification
    • NotificationMonitors
      • CommandFragmentRef
        • MessageRef
      • MailFragmentRef
    • NotificationObjects
      • WorkflowRef

Monitor Variables

Notifications for use with E-Mail

...