Map set header

The map set header provides the set of maps in the file with identifying information and indicates whether the map set is enabled for use. A single map set header must precede all maps in the map set.

The following table describes the required and optional map set header parameters that precede the maps in the set.

Parameter	Description	Inclusion
`MapSetName`	Describes the name of the map set. Note: The MapSetName can be seen in the trace file. Use this functionality to debug problems with a specific map set.	Required
`Version`	Indicates the version of the map set. This must be specified by the developer or integration end-user manually.	Optional
`FormatVersion`	Indicates the required version of the BMC II C APIs to translate the file. Depending on its contents, a map file created in version 2.1 or later of the BMC II Developer’s Kit might not be backward compatible with an earlier version of the toolkit.	Required
`ChangeDate`	Indicates the date when the file was last changed. This must be specified by the developer or integration end-user manually.	Optional
`Description`	Provides a free-text description of the map set.	Optional
`Enable`	Specifies whether the map set (and all maps in it) are enabled for use. Valid values: `TRUE` — enabled `FALSE` — disabled Note: If you specify a disabled map set in a `bmcii_translate` function call, the BMC II C APIs do not translate the message and the `BMCII_MAP_DISABLED` return code is sent to the integration. This return code does not necessarily describe an error, since disabling an entire map set is supported. If you disabled the map set intentionally, no response is necessary. If the map set was disabled unintentionally, reload the map set file and rerun the `bmcii_translate` function.	Required

Sample Map Set Header

MapSetName=Testing
Version=9
FormatVersion=2
ChangeDate=August 14, 2005
Description=This file contains the event map examples
Enable=true

Page tree

Map set header