HP Operations Manager for Windows

OV_ConfigItem-Properties


Id

Signature
string Id
Description
Identifier, PRIMARY KEY. Unique Id, which should contain the component name (for example, "ovow.MsgActSrv.HBChecker.DisableHealthCheck").

NamespaceId

Signature
string NamespaceId
Description
Namespace to which this OV_ConfigItem belongs.

Caption

Signature
string Caption
Description
Caption to display in the Generic Config GUI. This string is localized into all languages supported by HPOM for Windows.

Description

Signature
string Description
Description
Description to display in the Generic Config GUI. This string is localized into all languages supported by HPOM for Windows.

RequiresServiceRestart

Signature
boolean RequiresServiceRestart
Description
The idea of the OvOWConfigProvider is that configuration changes in Registry or XPLConfig become immediately active. There may still be exceptions where a configuration change needs a restart of some HPOM components. For these cases this property must be set to TRUE to make the user aware of the necessary restart actions. Also the Description property must end wi th a "Note:" specifying exactly which services have to be restarted in order to make changes to this ConfigItem become effective. For ReadOnly ConfigItems this property should not be set because it may confuse the user when he gets instruction which services to restart when the ConfigItem was changed for a ConfigItem that he cannot change. The default for this property is FALSE.

InverseLogic

Signature
boolean InverseLogic
Description
In the Config UI we have some boolean ConfigItems that use negative logic, for example "ovow.Auditing.TurnOffAuditingInGeneral". From the usability aspect this is not so easy to use (You need to set the ConfigItem to FALSE to enable auditing which is rather confusing). To work around this usability problem, the property "InverseLogic" was introduced. Setting this property to "TRUE" tells the Config UI to show the opposite of the actual value given by OV_ConfigValue, , i.e. if the registry key for "ovow.Auditing.TurnOffAuditingInGeneral" is set to "FALSE", then the Config UI would show "TRUE" be cause it is an InverseLogic ConfigItem. To make this workaround work, the Caption and the Description also need to be adapted, for example the saption for "ovow.Auditing.TurnOffAuditingInGeneral" was changed from "Turn off in general" to "Turn on in general". The default for this property is "FALSE", i.e. this is not an InverseLogic ConfigItem. NOTE: Setting this property to "TRUE" does not change the behaviour of the ConfigProvider, and it does not change the value that you get from the ConfigProvider via C API or via WMI (OV_ConfigItem); it only advises the Config UI to negate the value it shows. So be careful if you use such a ConfigItem programmatically, because the Caption and the Description actually tells the opposite of what the ConfigItem means. NOTE: This property only makes sense for ConfigItems of the type "Boolean" and "NumericBoolean". For all other ConfigItems it is just ignored.

ValueType

Signature
string ValueType
Description
What the value represents (String, Integer, Boolean, NumericBoolean, or Enumeration). If the value does not match this type, then the provider resets it to DefaultValue.
Values
ValueMap
String
Integer
Boolean
NumericBoolean
Enumeration

DefaultValue

Signature
string DefaultValue
Description
Value to use when the configuration item does not exist in Registry or XPLConfig, or if it contains an invalid value.

ValueRange

Signature
string ValueRange
Description
Defines the acceptable value range for this configuration item. For Boolean values, this attribute is disregarded: Boolean values must always be either "FALSE" or "TRUE". For NumericBoolean values, this attribute is disregarded: NumericBoolean values must always be either "0" or "1". For Integer values, this attribute defines the minimum and maximum value of the Integer value. It must be in the form ".." (for example, "-10..10"). If the Integer value is beyond that range, the provider corrects it to the nearest boundary (min or max). For String values, the provider uses this attribute as an OvXplMatch::Pattern_t, and performs a pattern match of m_currentValue against m_valueRange. If the pattern match fails, then the value is set to m_defaultValue. For Enumeration values, this attribute defines all acceptable Strings as a comma-separated list (for example, "Karl,Gustav,Erwin,*"). If an asterisk (*) is part of this list, the provider also accepts free text input. If the value is not one of the Strings in the list, and if the list does not contain an asterisk (*) item, the provider sets the value to m_defaultValue.

LocationStoreType

Signature
string LocationStoreType[]
Description
LocationStoreType, LocationPath, LocationName, and LocationValueType are String arrays that are strongly interconnected. LocationStoreType[x], LocationPath[x], LocationName[x], and LocationValueType[x] are a quadruple that describes the physical location of this configuration item. The first quadruple (x=0) describes the current physical location of this configuration item. The following quadruples (x>0) describe legacy locations of this configuration item. If a value is set at a legacy location, the provider deletes the legacy location value, and stores the value in the current location. LocationStoreType[x] determines whether this configuration item is stored in a Registry key or in a XPLConfig namespace.
Values
ValueMap
XPLConfig
Registry

LocationPath

Signature
string LocationPath[]
Description
-- see general comments on LocationStoreType, LocationPath, LocationName and LocationValueType under LocationStoreType attribute. If the LocationStoreType is "XPLConfig", the provider treats the LocationPath attribute as an XPLConfig namespace name. If the LocationStoreType is "Registry", the provider treats the LocationPath attribute as a Registry key name. For Registry keys, the path can start with a key handle to specify the registry hive to use. Key handles may be one of the following: HKLM (for HKEY_LOCAL_MACHINE) HKCR (for HKEY_CLASSES_ROOT) HKCU (for HKEY_CURRENT_USER) HKUS (for HKEY_USERS) HKCC (for HKEY_CURRENT_CONFIG) HKDD (for HKEY_DYN_DATA) HKPD (for HKEY_PERFORMANCE_DATA) HKPT (for HKEY_PERFORMANCE_TEXT) HKPN (for HKEY_PERFORMANCE_NLSTEXT) If you do not specify a key handle, the provider assumes HKLM. Example for a LocationPath: "HKLM\\Software\\Hewlett-Packard\\OVEnterprise\\Management Server\\MsgActSrv"

LocationName

Signature
string LocationName[]
Description
-- see general comments on LocationStoreType, LocationPath, LocationName and LocationValueType under LocationStoreType attribute. LocationName[x] contains the value name within the OV_ConfigNamespace (Registry key or XPLConfig namespace) where this configuration item is stored.

LocationValueType

Signature
string LocationValueType[]
Description
-- see general comments on LocationStoreType, LocationPath, LocationName and LocationValueType under LocationStoreType attribute. For Registry values, LocationValueType[x] determines whether this configuration item is physically stored as an Integer or as a String.
Values
ValueMap
REG_SZ_Value
REG_DWORD_Value

ReadOnly

Signature
boolean ReadOnly
Description
If "TRUE", this configuration item is read-only. That is, it does not allow writing. NOTE: Read-only ConfigItems cannot be migrated. If "ReadOnly" is "TRUE", "Migrate" must be "FALSE".

GUIMode

Signature
string GUIMode
Description
Determines how this configuration item is displayed in the Generic Config GUI. It can be hidden (for product-internal values), visible only in Expert Mode, or always visible.
Values
ValueMap
StandardMode
ExpertMode
Hide

OrderNumber

Signature
sint32 OrderNumber
Description
Number that defines in which sequence the OV_ConfigItem instances are sorted in the Generic Config GUI. Sorting is done in ascending order, which means that an OV_ConfigItem with an OrderNumber of 1 is shown before one with an OrderNumber of 2. Two OV_ConfigItem instances with the same OrderNumber are sorted by their Caption in ascending order. The default for the OrderNumber (if not set) is 0.

Dependency

Signature
string Dependency
Description
Allows defining a dependency to another OV_ConfigItem (or a list of other OV_ConfigItem instance). It means that this OV_ConfigItem (THIS) is dependant on another OV_ConfigItem (DEP). The OV_ConfigItem DEP that this one is dependant on must be of "Boolean" or "NumericBoolean" type. If the OV_ConfigItem DEP is shown as "FALSE" in the Generic Config GUI (this includes the consideration of the "InverseLogic" property) then the OV_ConfigItem THIS is grayed out in the Generic Config GUI and cannot be modified. If there are multiple OV_ConfigItems DEP1, DEP2, ... defined, then OV_ConfigItem THIS is only modifiable if all OV_ConfigItems DEP1, DEP2, ... are shown as "TRUE". A use case for this is for example that OV_ConfigItem THIS is about the logging detail level and OV_ConfigItem DEP is about turning logging on or off; if logging is turned off, then it makes no sense configuring the detail level. This property contains a list of OV_ConfigItem "Id"s of the OV_ConfigItem DEP; this list is separated by comma or semicolon.

Migrate

Signature
boolean Migrate
Description
If "TRUE", the system exports this configuration item during HPOM for Windows migration. NOTE: To be migrated, ConfigItems may not be read-only. If "Migrate" is "TRUE", "ReadOnly" must be "FALSE".

OnlineHelp

Signature
string OnlineHelp
Description
Links to the online help topic that gives more detailed information about this configuration item.