==== Batch inputs ====

=== Purpose ===
This monitor is dedicated to the monitoring of batch inputs. It will look for batch input sessions with error status occurred within a period of time.
 
Notifies with an alarm when a batch input session is in error
=== Configuration hints ===

You can customize the monitoring for a specific client, creator and session. Use the surveillance table to adjust the monitoring settings: 
- Client 
- Creator 
- Session 
- Thresholds 
-Severity

Make sure that the analyze period is at least greater than the schedule time.
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Period (min)|Period: Defines how far in the past the monitor will look for batch input sessions at each check|
^Client|A filter to match only a subset of clients.|
^Creator|A filter to match only a given creator or subset of creators.|
^Batch input session|A filter to match only a given session name.|
^Max errors|The maximum number of failed sessions matching the filters.|
^Aggregate|If checked, the threshold will be compared to the total number of sessions matching the filter. If not checked, one alarm per failed session will be sent.|
^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 used for showing threshold and severity in the daily report|
=== Examples ===
 
^Active^Period (min)^Client^Creator^Batch input session^Max errors^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|60|*|*|*|1|false|MAJOR|true| |true|false|false|

**Effect** : Report with a MAJOR alarm any failed batch input session that occured in the last 60 minutes.
=== Examples ===
 
^Active^Period (min)^Client^Creator^Batch input session^Max errors^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|60|800|jdoe|*|10|true|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm if 10 or more failed sessions occured for user jdoe on client 800.
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|FAILED_BATCHINPUTS_NUMBER|Errors|[CLIENT][CREATOR][SESSION]|Send the number of batch input sessions with error matching the filter.|