==== PI/XI channels ====

=== Purpose ===
PI/XI communication channels must be monitored to detect transmission errors. This monitor will watch for channels with error status.
=== Configuration hints ===

This monitor has to be assigned to a Web portal connector to the target SAP system, with user credentials having access to the PI/XI channels view.

With this monitor, you will have the possibility to detect and to be notified when a Channel has not an appropriate status. With the surveillance table, you can customize how the channels will be monitored and how you will be notified. Channels can be monitored based on their service, channel name and party or a particular log text. You can actually monitor two states: activation state and channel state.  A disabled severity will filter out the channels matching the filters, for all subsequent lines.
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration. |
^Service|A filter on the channel service |
^Channel|A filter on the channel name. |
^Party|A filter on the channel party. |
^Activation state|The activation state to monitor.|
^Channel state|The channel state to monitor.|
^Logs|A filter on the channel log.|
^Max. messages|In aggregate mode, the threshold for the maximum number of channels matching the filter.|
^Aggregates|If not set, one alarm per channel matching the filters will be sent. If set, an alarm will be sent only if the cumulated number of channels matching the filter is not below the threshold.|
^Severity|The default severity to apply when the simple threshold syntax is used.|
^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 used for showing threshold and severity in the daily report |
=== Examples ===
 
^Active^Service^Channel^Party^Activation state^Channel state^Logs^Max. messages^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|*|*|*|ANY|ERROR|*|1|false|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm per channel in ERROR state.
=== Examples ===
 
^Active^Service^Channel^Party^Activation state^Channel state^Logs^Max. messages^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|Consumer|*|*|ANY|INACTIVE|*|3|true|WARNING|true| |true|false|false|

**Effect** : Sends a WARNING alarm if 3 or more channels from service consummer are in INACTIVE state.
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|PIXI_CHANNEL_STATUS|Channel status|[STATE][CHANNEL][SERVICE][PARTY][LOG]|Sends TRUE if the rule generated an alarm, FALSE instead|
|PIXI_CHANNEL_STATUS_COUNT|Channel errors|[STATE][CHANNEL][SERVICE][PARTY][LOG]|Sends the number of channels matching the filter|