====== SAPconnect (SCOT/SOST) ======
  SAPConnect handles message sending from SAP via different media like FAX,
  EMAIL and PAGING. Message sending can be very important for some processes 
  and must be monitored accordingly. This monitor will watch for 
  messages with ERROR or WAITING status and notify when problems are found.
===== Configuration hints =====
  * Start by creating a new rule in the table and set the available filters: 
    * Client 
    * Message type 
    * Node 
    * Receiver 
    * Subject 
You can use regular expressions.

==== Period ====
  * Defines the max period of time to look for error or waiting messages.
  * Concerning waiting states: messages waiting for more time than the configured period will not be detected
  * If 0 is set as period, the monitoring will look for messages generated since the last check.
==== Status ==== 
  * **ERROR** will look for error messages generated in the period
  * **WAITING** will look for WAITING message generated in the period
===== Surveillance table =====
^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Status|Defines if the monitor will look for ERROR or WAITING states.|
^Client|A filter to match only a subset of clients.|
^Message type|INT for email, PAGE for paging messages and FAX for facsimile.|
^Node|A filter to match only a given node or subset of nodes.|
^Receiver|A filter to match only a given receiver or subset of receivers.|
^Subject|A filter to match only a given message subject.|
^Msg Nb|A filter to match only a given message number.|
^Period (min)|Defines how far in the past we look for messages. If set to 15, it will look for the messages generated in the last 15 minutes.|
^Threshold|The maximum number of messages matching the status and filters.|
^Aggregate|If checked, the results will be aggregated by medium type and then compared to threshold. If not checked, the threshold will be compared to the messages matching the filter.|
^Severity|The level of severity of the alarm generated by this line of surveillance.|
^Auto clear|If checked, the alarm will be cleared as soon as the alarm condition is not met anymore.|
^Alarm tag|This field allows to add custom text within the alarm message. %MSG% variable will contain the actual generated message and can be used such as: "my_prefix %MSG% my_suffix". By default, tag will be used as prefix.|
^Alarm|If checked, this line of surveillance will be used for alarm generation.|
^Metric|If checked, this line of surveillance will be used for metric generation.|
^Report|If checked, this line of surveillance will be used for report generation.|
===== Examples =====
^Active^Status^Client^Message type^Node^Receiver^Subject^Period (min)^Msg No.^Threshold^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|ERROR STATES|*|*|*|*|*|15|*|1|false|MAJOR|true| |true|false|

**Effect** : Sends one MAJOR alarm per type of message having 1 or more error status in the last 15 minutes
===== Examples =====
^Active^Status^Client^Message type^Node^Receiver^Subject^Period (min)^Msg No.^Threshold^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|WAITING STATES|800|INT|*|jdoe|*|15|672|10|false|WARNING|true| |true|false|

**Effect** : Sends a WARNING alarm if 10 or more emails addressed to jdoe are in waiting state on client 800 for messager number 672, since the last 15 minutes.

===== Generated metrics =====
^metricId^metricUnit^metricTarget^metricDescription^
|MESSAGE_TRANSFER_ERROR|Error messages|[CLIENT][TYPE][NODE][RECEIVER][SUBJECT]|Sends the number of messages with error state|
|MESSAGE_TRANSFER_ERROR|Error messages|[CLIENT][TYPE][NODE][RECEIVER][SUBJECT]|Sends the number of messages with waiting state|