|
Objective
The aim of the Dynamic Object Builder is to monitor objects whose return output is dynamic by applying a set of user-defined rules this return output data.
The monitoring features supporting Dynamic Object Builders are:
Method (Summary)
What the PATROL administrator does:
| • | Creates a set of rules to apply to output data |
| • | Creates String Search/Numeric Value Extraction templates to apply to dynamic items |
What the Dynamic Object Builder does:
| • | Applies the user-defined set of rules to the output data |
| • | Extracts each matching line and creates a dynamic object for each of them in the PATROL console according to the user-defined naming |
| • | Groups all dynamic objects under a dynamic container to facilitate the management of all the dynamic objects |
What analyzing and/or processing commands may be applied to the data:
You can analyze the dynamic objects with String Search and Numeric Value Extraction. If you have selected the Trigger an alarm when objects are missing option, a parameter named Status is automatically added to the PATROL Console for Dynamic Items. It informs you of the Dynamic Item presence or absence upon each collect.
Create or edit a dynamic object
To create a Dynamic Object Builder, right-click one of the monitoring features supporting Dynamic Object Builders and select KM Commands > New > Dynamic Object Builder...
To edit a Dynamic Object Builder, right-click the Dynamic Object Builder icon in the PATROL Console and select KM Commands > Edit.
Dynamic Object Builder Wizard — Welcome Page
1. Defining the rules to apply to the output data
Dynamic Object Builder Wizard — Rules Definition Page
| • | View Parameter Output: Displays the output data to which the Dynamic Object Builder rules will be applied. |
| • | Keep only lines matching the regular expression below: Specify the regular expression you wish the Dynamic Object Builder to search for in the output data. Each matching lines is displayed in a separated Dynamic Item automatically added in the PATROL Console under the Dynamic Container icon. |
| • | Exclude lines matching the regular expression below: Specify the regular expression you wish the Dynamic Object Builder to search for in the output data. Each matching lines will be ignored. |
| • | Trigger an alarm when objects are missing: This option allows you to define if and how Monitoring Studio must trigger an alert when the Dynamic Item, containing the extracted line, is missing from one collect to another: |
| ▪ | Do not trigger any alert: Select this option if you do not wish Monitoring Studio to trigger any alert when objects are missing |
| ▪ | Trigger an INFORMATION: Select this option if you wish Monitoring Studio to trigger an Information alert when objects are missing |
| ▪ | Trigger a WARNING: Select this option if you wish Monitoring Studio to trigger a Warning alert when objects are missing |
| ▪ | Trigger an ALARM: Select this option if you wish Monitoring Studio to trigger an Alarm alert when objects are missing |
I you have chosen to trigger an alert, a Status parameter will automatically be activated and displayed under the Dynamic Item in the PATROL Console to indicate that the Dynamic Item is missing. Click the Status parameter to open a graph pane displaying the status history of the Dynamic Item.
| • | Delete missing objects: Set this option according to how you want Monitoring Studio to display missing objects in the console. The available options are: |
| ▪ | Never: Monitoring Studio never deletes missing objects in the console. They will always be present. |
| ▪ | As soon as they are missing: Monitoring Studio deletes missing objects from the console as soon as their absence is discovered. If an alarm is configured, Monitoring Studio will trigger the alarm before deleting the object. |
| ▪ | When they are missing .... in a row: Monitoring Studio deletes missing objects after they have been missing a specific number of times in a row |
| • | Column separators: Define the way the Dynamic Object Builder detects columns of output data. Column contents are used to generate the Dynamic Items display name and ID in the PATROL Console. |
Dynamic Object Builder Wizard — Column separator definition
2. Define Dynamic Objects, Instance Names and Internal identifier
Dynamic Object Builder Wizard — Dynamic Object Names and ID definition Page
| • | Object Display Name: Name of the Dynamic Object Builder as it will appear in the PATROL Console |
| • | Object Internal Identifier (ID): Name used by the PATROL Console to internally identify the Dynamic Object Builder |
| • | Object Display Name: Name of the Dynamic item that contains the data retrieved from the output data. This name will be used as a label to identify the Dynamic item in the PATROL Console |
| • | Object Internal Identifier (ID): Name used by the PATROL Console to internally identify the Dynamic item |
| • | More Information: Provides information on the objects creation and labeling |
Click Finish to apply the Dynamic Object Builder rules to the KM command output file.
Dynamic Objects are instances of the SW_DYNAMIC class.
Using String Search and Numeric Value Extraction Templates
Features such as String Search and Numeric Value Extraction can help you analyze the Dynamic Items output. In order to apply these features to all the Dynamic Items in a single operation, the Dynamic Object Builder creates Templates instances of these features. While standard String Search and Numeric Value Extraction features apply to a single return output, Templates apply to all the Dynamic Items' output within the Dynamic Container (see step  in the example below).
When you modify a Template, the changes will apply to all the Dynamic Items upon the next data collection.
Example
How a Dynamic Object Builder elements are managed and displayed in the PATROL Console
|
See Also
Numeric Value Extraction
String Search
SW_DYNAMIC
SW_DYNAMIC_CONTAINER
SW_DYNAMIC_DISCOVERY
SW_DYNAMIC_NUMBERS
SW_DYNAMIC_STRINGS
| 
