==== Process Chains monitoring ====

=== Purpose ===
This monitor is dedicated to surveillance of SAP process chains BI. It will watch for execution error status, duration, delay and job occurrence.
You can set general rule to watch any process chain and be notified as soon as any fails.
You can also configure specific rule for a given job to monitor its real schedule or duration.
=== Configuration hints ===

Use the surveillance table to adjust the monitoring settings: 
- Use "Load process chains" button to discover jobs available in the system. 
- Select a line and click "Wizard" to open the monitoring configurator.  
- You can set specific threshold and severity for job status, duration, delay and schedule metrics.  
- You can also define the execution calendar of the job in order to stop its monitoring when it is not running  
 **Note:** Job occurrence monitoring can only be configured via the wizard. You will have to define the expected schedule window, by defining its recurrence and duration.
=== Atomic fields ===
^Exclusion List|The exclusion list can be used when you activated to SAP jobs collection in the daily report monitor job. You can specify a list of jobs that you want to ignore, so they do not appear in the report. Note: This has no effect on the real time surveillance!|

=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Chaine name|A filter to define the process chain that you want to monitor. Use * for all.|
^Schedule info|Defines the schedule defined for the process chain. This field can only be modified via the wizard.|
^Max errors|The threshold for the maximum number of aborted process chains within a period.|
^Error alarm severity|Defines the severity of the alarm to send if a process chain is aborted.|
^Aggregate|If checked, an alarm will be sent if the total number of aborted process chains is over the threshold. If not check, then one alarm will be sent per process chain having a number of abort status equal or greater than the threshold.|
^Max duration|The threshold for the maximum duration|
^Duration alarm severity|The severity for the duration alarm.|
^Max delay|The threshold for the maximum execution delay.|
^Delay alarm severity|The severity for the delay alarm.|
^Occurence alarm severity|The severity used for schedule alarm.|
^Calendar|The execution calendar of the Process chain. The check won't be performed on calendar's closed days.|
^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.|
=== Examples ===
 
^Active^Chaine name^Schedule info^Max errors^Error alarm severity^Aggregate^Max duration^Duration alarm severity^Max delay^Delay alarm severity^Occurence alarm severity^Calendar^Alarm tag^Alarm^Metric^
|true|*|From last 15 min|1|CRITICAL|false|0|DISABLED|0|DISABLED|DISABLED|None| |true|false|

**Effect** : A CRITICAL alarm will be sent for each aborted process chain occured in the last 15 minutes
=== Examples ===
 
^Active^Chaine name^Schedule info^Max errors^Error alarm severity^Aggregate^Max duration^Duration alarm severity^Max delay^Delay alarm severity^Occurence alarm severity^Calendar^Alarm tag^Alarm^Metric^
|true|MY_CHAIN|Every 15 MINUTES Starting 2015/01/01 10:00|1|CRITICAL|false|15|WARNING|0|DISABLED|MAJOR|None| |true|false|

**Effect** : Sends a CRITICAL alarm if process chain MY_CHAIN is aborted. Sends a WARNING alarm if it runs for more than 15 minutes. Sends a MAJOR alarm if the the process chain does not run and terminate every 15 minutes (one alarm per missed slot).
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|PROCESSCHAINS_DURATION|Seconds|Process Chain Name|Sends the duration of the process chain|
|ABORTED_PROCESSCHAINS|Process chains|Process chain filter|Sends the number of aborted process chains matching the filter.|