====== ABAP Number ranges ======
===== Purpose =====
  Number ranges of objects are used to define a range of possible serial numbers for SAP documents.
  To run short on numbers will cause problems in document generation and must be monitored.
===== Configuration hints =====
  * Define the objects to monitor in the surveillance table. 
  * Each object set in the table will be collected and checked. 
  * If the remaining slots of any of its range are too low, an alarm will be sent.
  * A filter can be set on the sub object to target a specific object or exclude some others.
  * Each range of a target object will be checked and might be triggering an alarm.
  * Use the threshold field to set maximum usage, you can use [[..:commonsettings#multi_thresholds_syntax|multi threshold syntax]]

==== Fetch all objects ====
  * If enabled, the monitor will collect all available objects. This can be used if you want to monitor a wide range of objects and use regular expressions to match them.
  * Note that this will collect thousands of objects and **it is better if that can be avoided**

**Important note:**
This monitor might have problems to compute available space for complex ranges composed by prefixes, alpha numeric and special characters. Make sure to test the monitoring of such object carefully.
===== Configuration =====
^ Fetch all objects | If enabled, fetches all available objects |
==== Surveillance table ====
^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Client|A filter to match only a subset of clients.|
^Object|The object to monitor. Use the exact object name or a regex if "Fetch all objects" is enabled |
^Sub Object|A filter on the sub object name. Use plain text or regex|
^Range| A filter on the range|
^Max used space (%)|The maximum used ratio of the range in percent. You can use multi-threshold (G2W:90 W2M:95) or absolute value |
^Severity|The severity of the generated alarm |
^Auto clear|If checked, the alarm will be cleared as soon as the alarm conditions are not fulfilled 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 QOS generation.|
^Report|If checked, this line of surveillance will used for showing threshold and severity in the daily report|

===== Examples =====
 
^Active^Client^Object^Sub object^Range^Max used space^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|800|RV_BELEG|*|*|G2W:90 W2M:95|MAJOR|true| |true|false|true|

**Effect** : Collects number ranges for object RV_BELEG and sends a WARNING alarm if over 90% or a MAJOR alarm if over 95%. Sends also a metric for every single range.
===== Generated metrics =====
 
^metricId^metricUnit^metricTarget^metricDescription^
|ABAP_NUMBER_RANGE_PERCENTAGE_USED|%|[CLIENT][OBJECT][RANGE]|The used range in percent for a given object