This topic is a reference for the elements, the complex types and the groups defined in the Common Base Event Schema v1.0.1.
The AssociatedEvent type allows for associated events to be grouped. It allows for identifying associated events and its associationEngine. The associationEngine MAY be the reference to the application that created the association.
This attribute specifies an array of globalInstanceIds that correspond to those events that are associated with this event.
The AssociationEngine identifies the application that establishes association among related or associated events. In addition, it provides properties to describe the type of the association. The AssociationEngine is a standalone entity in the XML schema and the AssociatedEvents created by the application that is identified by the AssociationEngine refer to it. This will eliminate the need to repeat the same data in every associated event.
The primary identifier for the element. This property MUST be globally unique. The recommend value for this is either a 128 bit or 256 bit Globally Unique Id (represented as hex string). Once this value is set it MUST never be changed. This is a REQUIRED property.
This property should contain the type of association created by this AssociationEngine. Some well defined associations are: - Contains - Cleared - CausedBy - MultiPart - Correlated This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
Name of the application that creates the association (e.g,. my correlation engine name). This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The AvailableSituation deals with the situations reported from the component, regarding its operational state and availability. This situation provides a context for operations that can be performed on the component by distinguishing if a product is installed, operational and ready to process functional requests, or operational and ready/not ready to process management requests. Existing message include words like those that now ready to take requests, online, and offline, for example: ADMC0013I: SOAP connector available at port 8880 ADMC0026I: RMI Connector available at port 2809
This property specifies the operation state of the component reported by the situation. The operationalDisposition is a string with the following set of values: - STARTABLE - NONSTARTABLE This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the availability disposition of an entity or component that caused the situation to be reported. The availabilityDisposition is a string with the following set of values: - AVAILABLE - NOT AVAILABLE This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the processing disposition of a component opertation that caused the situation to be reported. The processingDisposition is a string with the following set of values: - FUNCTION_PROCESS - FUNCTION_BLOCK - MGMTTASK_PROCESS - MGMTTASK_BLOCKED This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This element defines the context(s) that this event references. This complex type holds data that is used to assist with problem diagnostics by correlating messages or events generated during execution of a unit of work.
This element allows for application-supplied name-type-value collections to be specified for extensibility purposes. This is the mechanism by which other attributes not specified in the CommonBaseEvent data model can be added. Collections specified here are assumed to be product specific data.
This element allows events that are associated with each other to be grouped together and coupled with a corresponding association engine.
Identification of the component that is the "reporter" of the event or the situation. It is a REQUIRED property if the reporting component is different than the source component. Otherwise this field MUST NOT be present.
Identification of the component that is "affected" or was "impacted" by the event or the situation. This is a REQUIRED property for the component that is affected by the situation.
The msgDataElement is a property that is refers to a MsgDataElement. This property holds data that is used to specify all the related information associated with the message that this event holds. This is an OPTIONAL property and non-mutable. It is provided by the component issuing the event.
The situation is the data that describes the situation or event reported by the event. The situation information includes a required set of properties or attributes that are common across products groups and platforms, yet architected and flexible to allow for adoption to product-specific requirements. The situation is an element of type Situation which specifies the type of the situation that caused the event to be reported. This is an REQUIRED property, which it is not mutable; that is, once it is set it MUST NOT be changed.
Any additional data.
A string identifying the version of this event. This field is OPTIONAL in that if it isn't specified, the version of the Common Base Event is said to be 1.0. Otherwise this field MUST be filled in and MUST be consistent with the version specified in the schema header.The string length for version MUST NOT exceed 16 characters. When an application is creating an event following this version of the specification this field should be set to 1.0.1
The primary identifier for the event. This property MUST be globally unique and MAY be used as the primary key for the event. This is an OPTIONAL property. However, once this value is set it MUST never be changed. The recommended value is either a 128 bit or 256 bit Globally Unique Id and MUST start with an alphabetic character (i.e., a-z and A-Z).
The name of an event class (or element in XML) that this event represents (e.g., CommonBaseEvent). The name indicates any additional elements that are expected to be present within the event. This is an OPTIONAL property. If the value specified is null, then the value is assumed to be CommonBaseEvent. The string length for extensionName MUST NOT exceed 64 characters.
A source supplied event identifier. There is no guarantee that this value is globally unique. This is an OPTIONAL property. The string length for localInstanceId MUST NOT exceed 128 characters.
This attribute specifies the time at which this Common Base Event was created. It uses a type called dateType as specified in the XML schema. Example: December 31, 2004, 12:00pm will be "2004-12-31T12:00:00".
The perceived severity of the status the event is describing with respect to the application that reports the event. The predefined severity levels, in order of increasing severity, are as follows: * 0 Unknown * 10 Information MUST be used for cases when the event contains only general information and is not reporting an error. * 20 Harmless MUST be used for cases in which the error event has no effect on the normal operation of the resource. * 30 Warning MUST be used when it is appropriate to let the user decide if an action is needed in response to the event. * 40 Minor MUST be used to indicate that action is needed, but the situation is not serious at this time. * 50 Critical MUST be used to indicate that an immediate action is needed and the scope is broad (perhaps an imminent outage to a critical resource will result). * 60 Fatal MUST be used to indicate that an error occurred, but it is too late to take remedial action. The associated values are 0 to 70. The reserved values start at 0 for Unknown and increase by increments of 10 to 60 for Fatal. Other severities MAY be added but MUST NOT exceed 70. This is an OPTIONAL property.
The text accompanying the event. This is typically the resolved message string in human readable format rendered for a specific locale. This is and OPTIONAL property. The string length for msg MUST NOT exceed 1024 characters.
Defines the importance of the event. The predefined priorities are: * 10 Low * 50 Medium * 70 High The values are 0 to 100. The reserved value for Low is 10, for Medium is 50, and for High is 70. Other priorities MAY be added but MUST NOT exceed 100. This is an OPTIONAL property.
A source-defined number that allows for multiple messages to be sent and processed in a logical order that is different than the order in which they arrived at the consumer location (e.g., an event server or management tools). The sequence number helps consumers to sort arrived messages that may arrive out-of-order. This is with respect to the creation time and to the particular reporter of the messages. This is an OPTIONAL property with no default value.
The repeatCount specifies the number of occurrences of identical events within a specified time interval. The time interval is specified by the elapsedTime property. The definition of "identical events" is application-specific and therefore is not defined by this specification. This property is OPTIONAL and mutable. The repeatCount MAY be set by the component that issues the event or the event consumer. There is no default value. A value of 0 or no value indicates no repeated occurrences of the event.
This is the time interval or the elapsed time during which the number of identical events occurred (as specified by the repeatCount property). This property is expressed in microseconds. If no value (or zero) is specified for repeatCount, then this is an OPTIONAL property with no default value. However, if repeatCount is specified (it has a non-zero value), then elapsedTime is REQUIRED.
This element provides the detailed information about the components that are identified by the sourceComponentId and the reporterComponentId elements.
This property specifies the logical identify of a component. It must contain the name of a particular application, product or subsystem. The value should be unique within the scope specified by the reporter location property. The type of info specified is described in the componentIdType property. Note: The component, subcomponent and componentIdType properties form a logical group. The interrelationships among these properties should be taken into account by producers and consumers of Common Base Events.
This property specifies a further distinction for the logical component property of an event. It should contain the identity of the subcomponent of the component property and it should be the most granular definition speciied in the event, for example ApplicationServer:mycompany.myapp.AdminConsole. Note: This property may be one of the various parts of an application or operating system such as a module name, class name, class and method name.
This property specifies the format and the meaning of the component property that is identified in the componentIdentificationType element. The Common Base Event version 1.0.1 specification defines these component types: * ProductName: Indicates that component represents a specific product. * DeviceName: Indicates that component represents a device. * SystemName: Indicates that component represents a system. * ServiceName: Indicates that component represents a service. * Process: Indicates that the component represents a process. * Application: Indicates the component represents a collection of one or more components, in which component is specified in the form module.component and subcomponet is specified in the form class.method. * Unknown: Indicates that component is not one of the above types.
This property specifies a handle or identifier for the instance of the component that is specified in the component property. This is useful when more than one occurrence of a component is running on a system. Note: This property should uniquely identify a specific instance of a component. Some environments might provide appropriate constructs for the value of the instanceId property.
This property specifies the human-readable 'common' name of an application. The application version info may be optionally appened to the end of the name, separated by a '#' sign. for example "My application#3.2" specifies the application as 'My application' and version 3.2.
This property specifies the hosting environment of the application that is specified in the application property. It identifies the immediate environment within which the applicaiton is operating. for example, "My application" may be hosted on "BaseAppServer\myNode\server1". The version information for the executionEnvironment may be specified at the end of the property value and separated by a '#' character. for example, "BaseAppServer\myNode\server1#5.1".
This property specifies the physical address that corresponds to the location of a component. This address could be one of many different types, for example IP Address, host name, or MAC address, so the locationType element should be specified as well. Note: The recommended value for a location address is a fully qualified hostname.
This property specifies the format and meaning of the value in the location property. The following types are defined: * IPV4: Internet Protocol version 4 * IPV6: Internet Protocol version 6 * NWA: See note*. * ISDN: See note*. * ICD: See note*. * OID-OSI: See note*. * Dial: See note*. * HWA: See note*. * HID: See note*. * X25: See note*. * DCC: See note*. * SNA: See note*. * IPX: See note*. * E.164: See note*. * Hostname: Name of the hosting system * FQHostname: Fully qualified name of the hosting system * Devicename: Name of a device *Note: See the definition in the Common Informatoin Model (CIM) of the Distributed Management Task Force(DMTF) http://www.dmtf.org/standards/cim
This property is a string that specifies the process identifier of the running component or subcomponent that generated the event. The value is platform-specific. The threadId property can be used in conjunction with processId to futhre delineate the component or subcomponent.
This property is a string that specifies the thread identifier of the component or subcomponent that is specified by the proessId property. A running process may spawn one or more threads to execute its functions. The threadId will change accordingly. Note: if processId and threadId are used, they are typically obtained from the hosting environment or platform.
This property characterizes all instances of a given kind of component. componentType is a string that contains a namespace-qualified name (like an XML QName) that consists of an optional prefix and a local part, optionally separated by a colon. Tip: This property is not intended to be used for unique identification of the components, rather it identifies the type of component (or resource) that can be used as an additional qualifier to identify and establish a scope for the instance name of the component.
The ConfigureSituation deals with the components identifying their configuration. Any changes that a component makes to its configuration should be logged using this category. Additionally, messages that describe current configuration state fall into this category. Existing message include words like port number is, address is, and process id, for example: ADFS0134I: File transfer is configured with host="9.27.11.13", port="9090", securityEnabled="false".
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The ConnectSituation deals with the situations that identify aspects about a connection to another component. Messages that say a connection failed, that a connection was created, or that a connection was ended all fall into this category. Existing messages include words like connection reset, connection failed, and failed to get a connection, for example: DBMN0015W: Failure while creating connection {0} DBMN0033W: connection close failure {0} DBMN0023W: Failed to close a connection {0}
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the situation disposition that is representation of the parameters necessary to describe the situation. The situationDisposition is a string with the following set of values: - INUSE - FREED - CLOSED - AVAILABLE This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
Name of the application that created this context data element. This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The data type of the contextValue property. This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The CreateSituation deals with the situations documenting when a component creates an entity. Messages telling that a document was created, or a file was created, or an EJB was created all fall into this category. Existing message include words like was created, about to create, and now exists, for example: ADMR0009I: Document cells/flatfootNetwork/applications/Dynamic Cache Monitor.ear/Dynamic Cache Monitor.ear was created
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The DependencySituation deals with the situations that components produce to say that they cannot find some component or feature that they need. This category includes messages about not finding the 'version' of the component that was expected. Messages that say a resource was not found, or that an application or subsystem that was unavailable, also fall into this category. Existing messages include words like could not find, and no such component, for example: WSVR0017E: Error encountered binding the J2EE resource, Pet Store JMS Queue Connection Factory, as jms/queue/QueueConnectionFactory from resources.xml no resource binder found
This property specifies the dependency disposition of a feature of a component that caused the situation to be reported. The featureDisposition is a string with the following set of values: - MET - NOT MET This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The DestroySituation deals with the situations documenting when an entity or component was removed or destroyed. Messages telling that a document was destroyed or a file was deleted all fall into this category. Existing message include words like was created, about to create, and now exists, for example: CONM6007I: The connection pool was destroyed for data source (UDDI.Datasource.techs8.server1).
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The array of values for this extended data element represented as a string of the specified type, excluding hexBinary. hexBinary values MUST be defined using the hexValue property. The hexValue and the values properties are mutually exclusive. Only one of these properties SHALL be defined. This is an OPTIONAL property. The string length for this property MUST NOT exceed 1024 characters.
The hexValue is an array of characters that holds the data for any other data type or complexType not in the supported types described above. The hexValue and the values properties are mutually exclusive. Only one of these properties SHALL be defined. This is an OPTIONAL property.
The children property refers to other ExtendedDataElement(s) to specify a structured list of ExtendedDataElement's. This list allows for the creation of a hierarchy of related ExtendedDataElement's corresponding to a specific group of CommonBaseEvents. Accordingly, this is an efficient and quick way to get access to the list of related ExtendedDataElement's without having to look through and examine all the ExtendedDataElement's. This property is OPTIONAL and it is mutable.
The name of the extended data element. This name MUST be unique with respect to all other fields at the same level of extendedDataElement hierarchy, however, there may exist a child with the same name at different level or hierarchy. This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The data type of the values specified in the values property. Valid types are listed below. These are the only valid data types for the ExtendedDataElement type. The default value is "string". This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The FeatureSituation deals with the situations that announce that a feature of a component is now ready (or not ready) for service requests. Situations that indicate things like services being available and services or features being unavailable fall into this category. Existing situations include words like now available, currently available, and transport is listening on port 123, for example: SRVE0171I: Transport HTTPS is listening on port 9443 MSGS0601I: WebSphere Embedded Messaging has not been installed
This property specifies the availability disposition of a feature of a component that caused the situation to be reported. The featureDisposition is a string with the following set of values: - AVAILABLE - NOT AVAILABLE This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This element represents the data that is used to specify all of the related information that is associated with the message that this event holds.
This attribute represents an array of strings used as substitution values for resolving an internationalized message into formatted text. The order of the substitution values is implied by the implicit order of the array elements. If there are no substitution values, then msgCatalogTokens does not need to be specified. This is an OPTIONAL property. The string length for the msgCatalogTokens property MUST NOT exceed 256 characters per token.
The locale for which this msg property is rendered. Its value is a locale code that conforms to IETF RFC 1766. This is an OPTIONAL property.
The OtherSituation category is to provide support for the situation that is product specific requirement other than the predefined categories.
The ReportSituation deals with the situations reported from the component, such as heartbeat or performance information. Data such as current CPU utilization, current memory heap size, etc. would fall into this category. Existing messages include words like utilization value is, buffer size is, and number of threads is, for example: IEE890I WTO Buffers in console backup storage = 1024
This property specifies the category of the reported situation. The reportCategory is a string with the following set of values: - PERFORMANCE - SECURITY - HEARTBEAT - STATUS - TRACE - DEBUG - LOG This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The RequestSituation deals with the situations that a component uses to identify the completion status of a request. Typically, these requests are complex management tasks or transactions that a component undertakes on behalf of a requestor and not the mainline simple requests or transactions. Existing messages include words like configuration synchronization started, and backup procedure complete, for example: ADMS0003I: Configuration synchronization completed.
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the request qualifiers that are representation of the parameters necessary to describe the situation. The situationQualifier is a string with the following set of values: - REQUEST INITIATED - REQUEST COMPLETED This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The situation specifies the type of the situation that caused the event to be reported. This is an REQUIRED property.
The situationType specifies the type of the situation that caused the event to be reported. See SituationType definition for details. This is an REQUIRED property.
The categoryName specifies the type of the situation that caused the event to be reported. The categoryName is a string and has the following set of values:
This property specifies the scope of the impact of the situation reported. The initial set of values is described following this table. This is a REQUIRED property. The string length for this property MUST NOT exceed 64 characters.
The StartSituation deals with the start up process for a component. Messages that indicate that a component has begun the startup process, that it has finished the startup process, or that it has aborted the startup process all fall into this category.
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: * SUCCESSFUL * UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the situation qualifiers that are representation of the parameters necessary to describe the situation. The situationQualifier is a string with the following set of values: * START INITIATED * RESTART INITIATED * START COMPLETED This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
The StopSituation deals with the shutdown process for a component. Message that indicate that a component has begun to stop, that it has stopped, or that the stopping process has failed all fall into this category. Existing messages include words like stop, stopping, stopped, completed, and exiting, for example: WSVR0220I: Application stopped: {0} WSVR0102E: An error occurred stopping, {0} MSGS0657I: Stopping the MQJD JMS Provider
This property specifies the success disposition of an operation of a situation that caused the situation to be reported. The successDisposition is a string with the following set of values: - SUCCESSFUL - UNSUCESSFUL This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the situation qualifiers that are representation of the parameters necessary to describe the situation. The situationQualifier is a string with the following set of values: - STOP INITIATED - ABORT INITIATED - PAUSE INITIATED - STOP COMPLETED This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property MUST NOT exceed 64 characters.
This property specifies the situation qualifiers that are representation of the parameters necessary to describe the situation. The situationQualifier is a string with the following set of values: - STOP INITIATED - ABORT INITIATED - PAUSE INITIATED - STOP COMPLETED This is a REQUIRED property and once it is set it MUST NOT change. The string length for this property UST NOT exceed 64 characters.
The index or the identifier for a message that is used for resolving the message text from a message catalog. This is an OPTIONAL property. The string length for this property MUST NOT exceed 64 characters.
The msgCatalogType property specifies the meaning and format of the msgCatalog. The current nonexclusive list of reserved keywords includes: - Java - XPG This property is OPTIONAL and it is not mutable once it is set . The string length for the msgCatalogType property MUST NOT exceed 32 characters.
The qualified name of the message catalog that contains the translated message specified by the msgCatalogId. This is an OPTIONAL property. The string length of the msgCatalog MUST NOT exceed 128 characters.
Specifies the message identifier of the event. This identifier SHOULD be a unique value string of alphanumeric or numeric characters. It can be as simple as a string of numeric characters that identify a message in a message catalog or a multi-part string of alphanumeric characters (e.g., DBT1234E). This is an OPTIONAL property. The string length for msgId MUST NOT exceed 256 characters.
Specifies the meaning and format of the msgId. If the msgId conforms to or represents a standard or a well-known convention, it is named by this property. Examples are: IBM3.4, IBM4.4, IBM3.1.4, IBM3.4.1, IBM4.4.1, and IBM3.1.4.1. The nonexclusive reserved keywords include: - IBM* (* is as described above) - JMX - DottedName - Unknown This is an OPTIONAL property. The string length for msgIdType MUST NOT exceed 32 characters.