Advanced configuration
Help pages
In order to help users understand what they need to input, help files can be added.
When available this help will be shown in ProactivePack as in the example below.
If a html file is available, then the question mark can be clicked to show the help content.
Files are located in data/<ModuleName>/Help/ and must be named as follow:
1. <slotname>.html by default (all languages)
2. <slotname>-2 digit lang code>.html for a specific language
If file <ProactivePack Installation path>/data/BlackoutMgt/Help/mc_host.html exists then when user click on question mark content will be displayed such as:
In order to get such a result, file content should be:
<h2> Help on hostname choice</h2>
<hr/>
<p> You need to declare host you under maintenance using hostname or regular expression</p>
<div class="alert alert-success" role="alert">
<p> Example: hostname must be defined as in event management. Short name only. Do not use FQDN.</p>
</div>
<div class="alert alert-info" role="alert">
<p> Example: hostname must be defined as in event management. Short name only. Do not use FQDN.</p>
</div>
<div class="alert alert-warning" role="alert">
<p> Example: hostname must be defined as in event management. Short name only. Do not use FQDN.</p>
</div>
<div class="alert alert-danger" role="alert">
<p> Example: hostname must be defined as in event management. Short name only. Do not use FQDN.</p>
</div>Cell options
The module behavior can be changed using following options in Maintenance_KB_OPTIONS record :
|
Parameter |
Description |
Default/typical value |
|
CreatePeriodeSuccessSeverity |
Create period Event severity when success. |
INFO |
|
CreatePeriodeSuccessStatus |
Create period Event status when success. |
OPEN |
|
CreatePeriodeFailureSeverity |
Create Event severity when fails. |
MAJOR |
|
CreatePeriodeFailureStatus |
Create Event status when fails. |
OPEN |
|
KeepProfilsConscitency |
Keep profiles conscitency: destroy each object while removing profile. |
YES |
|
AddObj2ProfilSuccessSeverity |
Event severity when adding an object in profile if successfull. |
INFO |
|
AddObj2ProfilSuccessStatus |
Event status when adding an object in profile if successful. |
OPEN |
|
AddObj2ProfilFailureSeverity |
Event severity when adding an object in profile if fails. |
MAJOR |
|
AddObj2ProfilFailureStatus |
Event status when adding an object in profile if fails. |
OPEN |
|
DestroyObjProfilSuccessSeverity |
Event severity when removing an object in profile if successful. |
INFO |
|
DestroyObjProfilSuccessStatus |
Event status when removing an object in profile if successful. |
OPEN |
|
DestroyObjProfilFailureSeverity |
Event severity when removing an object in profile if fails. |
MAJOR |
|
DestroyObjProfilFailureStatus |
Event status when removing an object in profile if fails. |
OPEN |
|
DestroyPeriodeSeverity |
Destroy period Event severity when success. |
INFO |
|
DestroyPeriodeStatus |
Destroy period Event status when success. |
CLOSED |
|
DestroyEndedPeriods |
Enabling automatic destruction periods of type date to the end thereof. |
YES |
|
AutoCreateRef |
Auto repository creation based on incoming events. i In large environments we recommend to set the value to ‘NO’ as it could impact the performance |
YES |
|
EndPeriodExtraTime |
Default time (in seconds) added to each period in order to manage periods handover |
5 |
|
DurationToRemove |
Time (in seconds) between period end and removal if automated removal active |
600 |
|
MaxNumberOfNotes |
Max Number of event notes. When number of notes threshold is over, only latest note is conserved |
50 |
|
NotifyObjectBlackoutCalendar
|
Send notification events when calendar-based object blackouts start and stop |
NO |
|
NotifyProfileBlackoutCalendar
|
Send notification events when calendar-based profile blackouts start and stop |
NO |
|
NotifyCustomBlackoutCalendar
|
Send notification events when calendar-based custom blackouts start and stop |
NO |
|
NotifyObjectBlackoutDates
|
Send notification events when dates-based object blackouts start and stop |
NO |
|
NotifyProfileBlackoutDates
|
Send notification events when dates-based profile blackouts start and stop |
NO |
|
NotifyCustomBlackoutDates
|
Send notification events when dates-based custom blackouts start and stop |
NO |
|
NotifyEventSeverity
|
Default severity of start/stop notification events |
INFO |
|
NotifyObjectBlackoutStartFormat
|
Format (in MRL printf notation) of the object blackout start notification i Setting the value incorrectly may cause cell runtime errors and crashes |
See records/Maintenance_options.baroc |
|
NotifyObjectBlackoutStopFormat
|
Format (in MRL printf notation) of the object blackout stop notification. See warning above. |
|
|
NotifyProfileBlackoutStartFormat
|
Format (in MRL printf notation) of the profile blackout start notification. See warning above |
|
|
NotifyProfileBlackoutStopFormat
|
Format (in MRL printf notation) of the profile blackout stop notification. See warning above. |
|
|
NotifyCustomBlackoutStartFormat
|
Format (in MRL printf notation) of the custom blackout start notification. See warning above. |
|
|
NotifyCustomBlackoutStopFormat |
Format (in MRL printf notation) of the object profile stop notification. See warning above. |
|
|
ActiveStartStopEventsCorrelation |
Activate or not maintenance Stop/Start events corrzlation |
YES |
Those records can be modified using Command Line interface using the following syntax :
msetrec –n <cellname> -r Maintenance_KB_OPTIONS –S <parameter> -V <new value>
E.G.
msetrec –n <cellname> -r Maintenance_KB_OPTIONS –S AutoCreateRef –V NO
Repository
To assist users in creating object blackouts, a repository can be used to provide the list of allowed values for object class, object, and parameter.
Default Mechanism – cell based
The solution can be configured to use incoming events to fill a specific DDA table, in order to make object selection easier by presenting known values for object class, object and parameter.
By default, this mechanism is activated within the Blackout Management module but can be overwrite using any External source.
At the cell level, to check if the DDA is autopopulated with event input, run:
mgetrec -n <CellName> -q -r Maintenance_KB_OPTIONS.AutoCreateRef
The current value can changed using:
1) To enable
msetrec -n <CellName> -q -r Maintenance_KB_OPTIONS -S AutoCreateRef -V YES
2) To disable (default)
msetrec -n <CellName> -q -r Maintenance_KB_OPTIONS -S AutoCreateRef -V NOAlternative Mechanism – external source
In huge implementations using the cell to populate the list of object classes, object and parameter can be resource consuming and may impact performance.
In such situations it is possible to configure the module to use a specific file to contain the list of known values for object class, object and parameter.
A specific configuration key can be set in custom/BlackoutMgt.conf with path to an xml file. Such as
OverwriteRef ="/Data/Ref.xml";
Giving the absolute path to the valid xml file defined as below.
The file contents must match following criteria.
1. Header must be:
<?xml version="1.0" encoding="UTF-8"?>
<BMC_Impact_Manager version="1.0">
<IMPACT_DATA>2. Xml format by item must be
<ReferentielObjets>
<TypeObject>TypeObject1</TypeObject>
<Object>Object1</Object>
<Parametre>Parametre1</Parametre>
</ReferentielObjets> </IMPACT_DATA>
</BMC_Impact_Manager>
Sample file:
This xml file can be generated using mquery command with ‘-f xml’ options.
Linked Menus
In Object type Blackout, another source can be used in order to present values to users. The standard mechanism is build on a self learning and filled DDA ‘ReferentielObjets’.
On any kind of mechanism (default, external source), menus can be ‘linked’ to each other using a ‘key one’. Once user set the key other menus contents will be reduce to the compatibles values.
A configuration can be setup to use another source such as another DDA. In this example the referential source is the same as the standard one but can be changed.
Configuration:
You need to specify an ExternalSource for ‘mc_object_class,mc_object,mc_parameter’. The configuration shown on previous figure will setup an internal mechanism to query a DDA and slots. For details on options and format for the ExternalSource, see section Sources definitions in the Data Editor module.
In this example, a query to cell ‘EM’ cell and to DDA table ReferentielsObjets will be run and
mc_object_class,mc_object,mc_parameter will be filled with TypeObject,Object,Parametre slots from the DDA table.
The ‘,’ will be used as a field separator.
Notifications
Informational events can be generated when blackout windows start and stop. This option is disabled by default as it can lead to a high number of events being generated.
To configure, see all the Notify* parameters in the Cell options section.
Notification events are of class MAINTENANCE_START_NOTIFICATION and MAINTENANCE_STOP_NOTIFICATION.
Please note that:
- No correlation/deduplication is performed for those events. If needed, such logic can be implemented e.g. using recurrence or closureeve
- if a dates-based blackout is created with a past start time, no “maintenance start” event will be sent.