Simple Types

The following table lists the custom simple types that the ImpactManager.wsdl exposes and their corresponding built-in data types.


Simple Types

Simple type

Built-in data type

IMMessageType

string

IMBufferType

string

DataType

string

QueryMode

string

IMMessageType

The < wsdl:types > section contains the data definition for IMMessageType simple type.

<xsd:simpleType name="IMMessageType">
	<xsd:restriction base="xsd:string">
		<xsd:enumeration value="MSG_TYPE_NONE"/>
		<xsd:enumeration value="MSG_TYPE_NEW_EVENT"/>
		<xsd:enumeration value="MSG_TYPE_MOD_EVENT"/>
		<xsd:enumeration value="MSG_TYPE_NEW_DATA"/>
		<xsd:enumeration value="MSG_TYPE_OVERWRITE_DATA"/>
		<xsd:enumeration value="MSG_TYPE_MOD_DATA"/>
	</xsd:restriction>
</xsd:simpleType>

The IMMessageType value specifies an enumeration of the types of messages that the web service client can exchange with the web service and the BMC Impact Manager instance. The messages contain the event or data object.

The simple type IMMessageType has a restriction declaration that specifies that the built-in data type string must be used to specify its custom values, which are described in the following table.

Value

Description

MSG_TYPE_NONE

Empty message

MSG_TYPE_NEW_EVENT

Message contains a new event object

MSG_TYPE_MOD_EVENT

Message contains information for modifying an existing event object

MSG_TYPE_NEW_DATA

Message contains a new data object

MSG_TYPE_OVERWRITE_DATA

Message contains information for modifying an existing data object. If the data object does not already exist, then this operation creates it.

MSG_TYPE_MOD_DATA

Message contains information for modifying an existing data object. The message type requires that the data_handle ID of the BMC Impact Manager instance is set to enable modification. It does not use the mc_udid identifier. If the data object does not already exist, then this operation fails.

IMBufferType

The < wsdl:types > section contains the data definition for the simple type IMBufferType.

<xsd:simpleType name="IMBufferType">
	<xsd:restriction base="xsd:string">
		<xsd:enumeration value="BMCII_BUFFER_MODE_DEFAULT"/>
		<xsd:enumeration value="BMCII_BUFFER_MODE_NONE"/>
		<xsd:enumeration value="BMCII_BUFFER_MODE_LOW"/>
		<xsd:enumeration value="BMCII_BUFFER_MODE_HIGH"/>
	</xsd:restriction>
</xsd:simpleType>

The IMBufferType value specifies an enumeration of the types of persistent buffering routines that are available for sending event to the BMC Impact Manager instance.

The simple type IMBufferType has a restriction declaration that specifies that the built-in data type string must be used to specify its custom values, which are described in the following table.

Value

Description

BMCII_BUFFER_MODE_ DEFAULT

If the web services API cannot send the message to the BMC Impact Manager instance, the message is buffered in memory, but not saved to disk. The message is lost if the connection to the BMC Impact Manager instance is closed or if the BMC Impact Integration Web Services server shuts down or terminates.

This default value refers to the value that is defined in the startup configuration file of the BMC Impact Integration Web Services server. If no value is defined in the configuration file, then BMCII_BUFFER_MODE_NONE is used.

BMCII_BUFFER_MODE_ NONE

No persistent buffering routine is available. The message is buffered in memory, but not saved to disk. Any events and data are lost if the BMC Impact Manager instance is unavailable.

BMCII_BUFFER_MODE_ LOW

The message in the buffer is saved to a separate file on disk only if the web services API (SendEvent) cannot send the message. The message is saved on the disk until the web services API can complete its operation. If the web services API fails to complete its operation, the message is lost.

BMCII_BUFFER_MODE_ HIGH

The message in the buffer is saved immediately to a separate file, ensuring message delivery. This buffer mode selection can be resource-intensive because a copy of every message is saved to disk even if the message is sent.

DataType

The schema declaration file Basic Types.xsd contains the data definition of the simple type DataType.

<xsd:simpleType name="DataType">
	<xsd:restriction base="xsd:string">
		<xsd:enumeration value="BYTE"/>
		<xsd:enumeration value="SHORT"/>
		<xsd:enumeration value="INT"/>
		<xsd:enumeration value="LONG"/>
		<xsd:enumeration value="FLOAT"/>
		<xsd:enumeration value="DOUBLE"/>
		<xsd:enumeration value="STRING"/>
		<xsd:enumeration value="BYTE_ARRAY"/>
		<xsd:enumeration value="SHORT_ARRAY"/>
		<xsd:enumeration value="INT_ARRAY"/>
		<xsd:enumeration value="LONG_ARRAY"/>
		<xsd:enumeration value="FLOAT_ARRAY"/>
		<xsd:enumeration value="DOUBLE_ARRAY"/>
		<xsd:enumeration value="STRING_ARRAY"/>
	</xsd:restriction>
</xsd:simpleType>

The simple type DataType has a restriction declaration that specifies that the built-in data type string must be used to specify its values. These values consist of built-in data types ("BYTE," "SHORT," "INT," and so forth) and elements derived from complex types ("BYTE_ARRAY," "SHORT_ARRAY," "INT_ARRAY," and so forth).

Refer to value for a description of the element value_element, defined from the complex type value, to see how the enumerated DataType values are implemented.

QueryMode

The < wsdl:types > section contains the data definition for the simple type QueryMode.

<xsd:simpleType name="QueryMode">
	<xsd:restriction base="xsd:string">
		<xsd:enumeration value="BMCII_EVENT_CLASSES"/>
		<xsd:enumeration value="BMCII_DATA_CLASSES"/>
	</xsd:restriction>
</xsd:simpleType>

QueryMode defines which set of class definitions and respective subclasses are being queried: BMCII_EVENT_CLASSES or BMCII_DATA_CLASSES.

Was this page helpful? Yes No Submitting... Thank you

Comments