Descripción del modelo de evento base común (CBE)

El modelo de evento base común es el nuevo estándar para los eventos que se producen en los distintos tipos de aplicaciones de empresa. Este estándar propone la coherencia de los elementos de datos que conforman estos eventos, tanto en los propios elementos como en su formato.

Convenios utilizados en el modelo de evento base común

Descripción del evento base común (CBE)

Con objeto de identificar los datos recogidos para la 3-tupla de una situación que constituye el evento base común (CBE), se utilizan las siguientes propiedades:

localInstanceId

La propiedad localInstanceId es de tipo serie y sirve para identificar localmente las instancias de un evento. No existe ninguna garantía implícita de que este valor sea globalmente exclusivo. Sin embargo, una vez establecido, permanece constante mientras dure el evento. El contenido del valor de la propiedad localInstanceId PUEDE constar de varias partes, que especifiquen, por ejemplo, la indicación de la hora, la ubicación, el desplazamiento y el ID del mensaje; o bien PUEDE utilizar otras técnicas definidas por la aplicación para proporcionar el contenido con el fin de garantizar la unicidad del ID. Por ejemplo, puede establecer el identificador para que sea la concatenación de una serie, dando la dirección IP del sistema principal local, una serie que proporcione la vía de acceso absoluta del archivo access.log, una serie que dé el nombre totalmente calificado del sistema principal local, una serie que dé la indicación de la hora y una serie que represente el número de secuencia (sequenceNumber). La serie resultante sería como esta:

9.27.11.27 misistema.toronto.ibm.com 20021009012534.002000-240_0

Esta propiedad no es una clave. Es una propiedad OPCIONAL inmutable; es decir, una vez establecida, no se puede cambiar. La puede proporcionar el componente que emite el evento o la puede asignar el consumidor del evento. La longitud máxima de la serie localInstanceId NO DEBE superar los 128 caracteres.

globalInstanceId

La propiedad globalInstanceId es un tipo de datos complejo que representa el identificador primario del evento. La propiedad identifica global e inequívocamente el evento y PUEDE utilizarse a modo de clave primaria del evento. El valor DEBE ser un identificador globalmente exclusivo (GUID) cuya longitud esté comprendida entre 128 bits y 256 bits. El algoritmo de generación de GUID es el responsable de asegurar la unicidad de este valor.

Esta es una propiedad OPCIONAL, pero si se especifica, es inmutable; es decir, una vez establecida, no se puede cambiar mientras dure el evento. La propiedad globalInstanceId la puede proporcionar el componente que emite el evento o el consumidor del evento.

La propiedad globalInstanceId es necesaria para establecer asociaciones entre los eventos. Si no se especifica el ID de instancia global, no se podrá proporcionar la asociación tal como se describe en AssociatedEvent.

creationTime

Esta propiedad indica la fecha y la hora de creación del evento, que DEBEN especificarse tal como se definen en el tipo de datos dateTime del esquema XML. El valor de creationTime DEBE proporcionar una granularidad tan precisa como lo permita la plataforma que genera el evento.

Esta es una propiedad OBLIGATORIA e inmutable, y la DEBE proporcionar el componente que informa del evento. Una vez establecida, no se puede cambiar mientras dure el evento.

severity

Esta propiedad indica el nivel de gravedad del estado que el evento está describiendo, con respecto a la aplicación que informa del evento. El significado de los valores que haya en la propiedad se puede describir mediante una enumeración de valores o calificadores comunes que indiquen el nivel de gravedad del evento. Por ejemplo, serían válidos valores como informativo, aviso o determinados números enteros que se correspondan con los niveles de gravedad deseados. En este documento no se impone una implementación específica, sino que se sugieren algunos valores para animar a los usuarios de este campo a añadir valores adicionales en función de su implementación. Este campo tan solo ayuda a definir la gravedad del tipo de situación que se ha puesto de manifiesto y permite a los administradores centrarse en los problemas más graves que se produzcan en la empresa.

A continuación figura una lista ordenada de los niveles de gravedad predefinidos, empezando por los de menor gravedad:

Los valores oscilan entre el 0 y el 70. Los valores reservados empiezan por el 0 , que corresponde a Desconocido, y aumentan en incrementos de 10 hasta el 60, que corresponde a Muy grave. PUEDEN añadirse otros niveles de gravedad, pero NO DEBEN sobrepasar el 70. Si no se especifica ningún valor, se interpreta que este evento no tiene gravedad alguna, lo que equivale al valor "NONE".

Esta es una propiedad OPCIONAL, pero es inmutable una vez establecida. No hay ningún valor por omisión para la gravedad.

priority

La propiedad priority define la prioridad o importancia del evento y el orden relativo en que se deben procesar los registros. Los valores de prioridad predefinidos son los siguientes:

Los valores oscilan entre el 0 y el 100. El valor reservado para la prioridad baja es el 10, para la mediana es el 50 y para la alta, el 70. PUEDEN añadirse otros grados de prioridad, pero NO DEBEN sobrepasar el 100.

Si no se especifica ningún valor, se interpreta que este evento no tiene prioridad alguna, lo que equivale al valor "NONE".

La prioridad es una propiedad distinta e independiente de la gravedad, ya que la prioridad indica más el punto de vista de un consumidor, mientras que la gravedad corresponde al estado de la situación tal como la percibe el componente afectado. Por ejemplo, un evento que tenga una prioridad ALTA y una gravedad LEVE se debe procesar antes que un evento que tenga una prioridad BAJA y una gravedad GRAVE.

Esta es una propiedad OPCIONAL y mudable. No hay ningún valor por omisión para la prioridad.

reporterComponentId

La propiedad reporterComponentId es la identificación del componente que ha informado del evento o de la situación en nombre del componente afectado. El tipo de datos de esta propiedad es un tipo complejo tal como se describe en el tipo ComponentIdentification que proporciona los datos necesarios para identificar inequívocamente un componente.

Es una propiedad OBLIGATORIA si el componente que informa es distinto del componente origen. En caso contrario, DEBE omitirse este campo. Esta propiedad es inmutable; es decir, una vez establecida, no se puede cambiar.

sourceComponentId

La propiedad sourceComponentId es la identificación del componente afectado por el evento o la situación. El tipo de datos de esta propiedad es un tipo complejo tal como se describe en el tipo ComponentIdentification que proporciona los datos necesarios para identificar inequívocamente un componente. 

Esta propiedad es OBLIGATORIA e inmutable. El productor del evento DEBE proporcionar el ID del componente origen (propiedad sourceComponentId). Si el componente informador coincide con el componente afectado, DEBE omitirse la propiedad reporterComponentId.

situationType

La propiedad situationType especifica el tipo de situación que ha provocado que se informe del evento. El valor de esta propiedad es de tipo serie extensible.

Las palabras clave reservadas propuestas son las siguientes:

Esta propiedad es OPCIONAL e inmutable. La longitud máxima de la serie situationType NO DEBE superar los 512 bytes.

contextDataElements

La propiedad contextDataElements es una matriz de contextos del tipo ContextDataElement a los que hace referencia este evento. En esta propiedad están los datos que ayudarán a correlacionar los mensajes o los eventos generados a lo largo del proceso de ejecución de una unidad de trabajo con vistas al diagnóstico de problemas.

Esta propiedad es OPCIONAL y mudable. La puede proporcionar el componente que emite el evento o la puede asignar el consumidor del evento. 

msg

La propiedad msg representa el texto que acompaña al evento. Por lo general, es la serie resuelta del mensaje en formato legible para las personas y representada para un entorno local concreto.

El entorno local de la propiedad msg se especifica mediante la propiedad msgLocale del tipo MsgDataElement. No hay ningún valor por omisión para el entorno local de la propiedad msg.

Esta propiedad es OPCIONAL, pero le RECOMENDAMOS que le dé un valor si las propiedades msgCatalogId y msgCatalog de MsgDataElement no especifican un valor. 

msgDataElement

La propiedad msgDataElement hace referencia a un elemento de datos de mensaje, MsgDataElement. En esta propiedad están los datos que permiten especificar toda la información relacionada que se asocia al mensaje contenido en este evento.

Es una propiedad OPCIONAL e inmutable. La proporciona el componente que emite el evento.

extensionName

La propiedad extensionName contiene el nombre de una "clase de evento" representada por este evento (por ejemplo, la clase Trace o la clase CommonBaseEvent). El nombre de la clase de evento indica las propiedades adicionales que deberían estar presentes en el evento en cuestión. Si opta por utilizar extendedDataElement, propiedad descrita en el próximo apartado, le recomendamos que especifique un valor para la propiedad extensionName.

Esta es una propiedad OPCIONAL e inmutable, y la DEBE proporcionar el componente que informa del evento. Si el valor especificado es nulo, se toma el valor "CommonBaseEvent".

extendedDataElements y extendedProperties

La propiedad extendedDataElements es una secuencia de elementos nombre del tipo ExtendedDataElement. Su finalidad es proporcionar capacidad de ampliación, ya que suministra una ubicación en la que especificar otros atributos no previstos en el modelo de datos del evento base común (CBE).
La información incluida aquí se supone que son datos específicos del producto.

Esta propiedad la puede suministrar usted mismo, y los elementos nombrados permiten realizar operaciones como filtrar y hacer búsquedas o referencias mediante reglas de correlación.

Esta es una propiedad OPCIONAL y mudable. Es decir, una vez establecida, se puede cambiar. El valor de esta propiedad lo puede proporcionar el componente que emite el evento o lo puede asignar el consumidor del evento.

associatedEvents

La propiedad associatedEvents prevé la posibilidad de hacer grupos no restringidos de eventos o relaciones entre padres e hijos. Es una propiedad de tipo complejo formada por identificadores de instancia global (propiedad globalInstanceId) que identifica los eventos asociados junto con un campo de tipo que describe el tipo de asociación representada por el nombre de la asociación.

Esta es una propiedad OPCIONAL y mudable. Es decir, una vez establecida, se puede cambiar. El valor de esta propiedad lo puede proporcionar el componente que emite el evento o lo puede asignar el consumidor del evento.

repeatCount

La propiedad repeatCount representa el número de apariciones de un evento dado durante un intervalo de tiempo concreto. El intervalo se indica mediante la propiedad elapsedTime, descrita a continuación. La definición de lo que hace que un evento sea la repetición de un evento emitido anteriormente es una característica específica de la aplicación y, por lo tanto, no está incluida en esta especificación.

Esta propiedad es OPCIONAL y mudable. La propiedad repeatCount la puede establecer el componente que emite el evento o el consumidor del evento. No hay ningún valor por omisión. Cuando el valor es 0 o cuando no hay ningún valor, el evento no se repite.

elapsedTime

La propiedad elapsedTime indica el intervalo de tiempo o el tiempo transcurrido mientras se producían apariciones de un evento concreto. El número de apariciones viene especificado por el valor de la propiedad repeatCount. Este valor indica durante cuánto tiempo se han observado los eventos repetidos. 

El valor de esta propiedad se DEBE expresar con una granularidad de microsegundos.

Esta propiedad es OPCIONAL y mudable. Pero si se especifica la propiedad repeatCount, también es preciso indicar el tiempo transcurrido (elapsedTime). La propiedad elapsedTime la puede establecer el mismo componente que establece la propiedad repeatCount. No hay ningún valor por omisión para el tiempo transcurrido.

sequenceNumber

La propiedad sequenceNumber representa el número de secuencia y es un número definido por el origen que permite enviar múltiples mensajes y procesarlos según un orden lógico distinto del orden de llegada a la ubicación del consumidor (por ejemplo, un servidor de eventos o las herramientas de gestión). El número de secuencia ayuda a los consumidores a ordenar los mensajes que llegan. Lo hacen con respecto a la hora y al proveedor concreto del evento.

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar. No hay ningún valor por omisión.

Descripción del tipo ComponentIdentification (identificación de componentes)

En la elaboración de informes sobre problemas, existen dos categorías generales de componentes en relación con el diagnóstico: el componente que observa la situación e informa de ella (informador) y el componente real que experimenta la situación (afectado). La identificación de componentes proporciona un conjunto de atributos que permite identificar inequívocamente cada uno de los componentes. Los mismos datos sirven para identificar el componente que informa de un evento o una situación y el componente afectado o que experimenta la situación. En algunos casos, estos componentes coincidirán.

Por ejemplo, en un entorno típico de tecnología de la información, normalmente las actividades de las aplicaciones que se ejecutan en ese entorno se suelen supervisar mediante eventos que se reciben o recogen a partir de las aplicaciones por medio de agentes de gestión o adaptadores.

Ejemplo 1: supongamos el caso de una aplicación de WebSphere, llamada miAplWeb, que excede el tiempo de espera en la consulta de una tabla debido a un problema producido en un servidor de DB2 ubicado en un sistema remoto. Entonces la aplicación Web emite un evento que indica la situación de la anomalía. En este caso, miAplWeb es el componente "origen" o "afectado".

Ejemplo 2: supongamos el caso de una aplicación X que se esté ejecutando en un servidor Windows. La aplicación encuentra un error y añade una entrada al archivo de anotaciones de error de Windows. Luego, una aplicación aparte (un adaptador) lee los mensajes del archivo de anotaciones de error, genera un evento base común (CBE) y lo envía. En este caso, el componente "afectado" o componente "origen" del evento es la aplicación X y el componente informador es el adaptador que generó el evento y lo envió.

A continuación figura una descripción detallada del tipo ComponentIdentification.

location

La propiedad location especifica la dirección física que corresponde a la ubicación de un componente. Por ejemplo, un nombre de sistema principal, una dirección IP, VTAM LU. El formato del valor de la ubicación se especifica mediante la propiedad locationType. El valor preferido es un nombre de sistema principal totalmente calificado.

Esta propiedad es OBLIGATORIA e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie location NO DEBE superar los 256 caracteres.

locationType

Esta propiedad especifica el formato y el significado del valor de la propiedad location. Esta propiedad tiene las siguientes palabras clave reservadas por todos conocidas:

El valor por omisión es "Unknown" (desconocido). Esta propiedad es OBLIGATORIA e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie locationType NO DEBE superar los 32 caracteres.

application

La propiedad application especifica el nombre de usuario de la aplicación (por ejemplo, miApl). Se puede añadir información sobre la versión de la aplicación al final del componente, separándola mediante un carácter #.

Esta es una propiedad OPCIONAL e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie application NO DEBE superar los 256 caracteres.

executionEnvironment

La propiedad executionEnvironment identifica el entorno de ejecución inmediato en el que se está ejecutando la aplicación. Por ejemplo, el nombre de un WebSphere Application Server: celda:nodo:servidor.

Se puede añadir información sobre la versión del entorno de ejecución al final del componente, separándola mediante un carácter #. La longitud máxima de la serie executionEnvironment NO DEBE superar los 256 caracteres.

Esta es una propiedad OPCIONAL e inmutable. Es decir, una vez establecida, no se puede cambiar mientras dure el evento.

component

La propiedad component especifica la identidad lógica de un componente. Esta propiedad DEBE contener el nombre de una aplicación, producto o subsistema concreto (por ejemplo, IBM DB2 V7.1). Este valor DEBERÍA ser exclusivo en el ámbito especificado por la ubicación del informador.

Esta propiedad es OBLIGATORIA e inmutable. Es decir, una vez establecida, no se puede cambiar mientras dure el evento. La longitud máxima de la serie component NO DEBE superar los 256 caracteres.

subComponent

La propiedad subComponent especifica una delineación adicional de la propiedad lógica component del evento.

DEBERÍA contener la identidad del subcomponente de la propiedad component y ser la definición más granular especificada en el evento. Esta propiedad puede ser una de las diversas partes de que consta un recurso de aplicación o sistema operativo; por ejemplo, un nombre de módulo, un nombre de clase, un nombre de clase y método.

Esta propiedad es OBLIGATORIA e inmutable. Es decir, una vez establecida, no se puede cambiar mientras dure el evento. La longitud máxima de la serie subComponent NO DEBE superar los 512 caracteres.

componentIdType

La propiedad componentIdType especifica el formato y el significado del componente identificado mediante esta componentIdentification. A continuación figura una lista no exclusiva de palabras clave reservadas para esta propiedad:
 

Esta propiedad es OBLIGATORIA e inmutable. La longitud máxima de la serie componentIdType NO DEBE superar los 32 caracteres.

instanceId

La propiedad instanceId especifica un handle o un identificador de la instancia del componente especificado por la propiedad component. Por ejemplo, Grid Service Handle(GSH), EJBHandle.

Esta propiedad es OPCIONAL e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie instanceId NO DEBE superar los 128 caracteres.

processId

La propiedad processId es de tipo serie e identifica el ID de proceso del componente o subcomponente "en ejecución" que generó el evento.

Esta es una propiedad OPCIONAL e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie processId NO DEBE superar los 64 caracteres.

threadId

La propiedad threadId es de tipo serie e identifica el ID de hebra del componente o subcomponente indicado por el ID del proceso que generó el evento. Un proceso en ejecución puede engendrar una o más hebras para transportar su función y las peticiones entrantes. Por lo tanto, el ID de la hebra cambiará de acuerdo con ello.

Esta es una propiedad OPCIONAL e inmutable. Es decir, una vez establecida, no se puede cambiar. La longitud máxima de la serie threadId NO DEBE superar los 64 caracteres.

Descripción del tipo ExtendedDataElement (elemento de datos ampliado)

El tipo ExtendedDataElement le permite suministrar conjuntos de nombre-tipo-valor que deban especificarse a efectos de ampliabilidad. Aquí es donde puede incluir los atributos que no se hayan previsto en el modelo de datos del evento base común (CommonBaseEvent). Los conjuntos especificados aquí se supone que son datos específicos del producto.

Las propiedades nombradas permiten realizar operaciones como filtrar y hacer búsquedas o referencias mediante reglas de correlación. El nombre (propiedad "name") lo define usted mismo, aunque teniendo en cuenta la siguiente lista no exclusiva de palabras clave reservadas:

RawData: palabra clave que indica los datos "tal cual", que normalmente tienen un formato que puede ser propiedad del productor de los datos. El formato puede ser cualquiera, incluido el binario. La finalidad de esta palabra clave es permitir que los datos se recuperen literalmente y dar soporte a las herramientas que saben interpretar el formato del contexto.

RootHeader: palabra clave cuya finalidad es identificar el ExtendedDataElement raíz de una jerarquía de tipos ExtendedDataElement definidos por las referencias de datos (dataRefs).

La descripción detallada del tipo ExtendedDataElement es la siguiente:

name

La propiedad name especifica el nombre del elemento de datos ampliado. Este nombre DEBE ser exclusivo con respecto a todas las demás propiedades indicadas en el evento (por ejemplo, RawData, msgLocale y EventStatus).

Esta propiedad es OBLIGATORIA e inmutable.
 

type

La propiedad type representa el tipo de datos de los valores especificados en la propiedad values, que se describe más abajo.

Los valores válidos de la propiedad type son:
 

Los tipos de datos anteriores son los únicos tipos válidos soportados por el tipo ExtendedDataElement. El valor por omisión es "string".

Esta propiedad es OBLIGATORIA e inmutable.

values

La propiedad values representa una matriz de los valores de este elemento de datos ampliado, valores cuyo tipo es el definido por la propiedad type descrita más arriba.

Esta propiedad es OPCIONAL y mudable. NO DEBE especificarse si se especifica la propiedad "value" o "hexValues".

hexValues

La propiedad hexValues es una matriz de bytes que contiene los datos de cualquier otro tipo de datos (o de complexType) que no figuren en la lista de tipos soportados definida más arriba.

Esta propiedad es OPCIONAL e inmutable. NO DEBE especificarse si se especifica la propiedad "values" o "value".

Nota: las propiedades hexValues y values se excluyen mutuamente. Solo se puede definir una de las dos.
 

children

La propiedad children (hijos) se refiere a los otros elementos de datos ampliados para especificar una lista estructurada de tales elementos. Esta lista permite crear una jerarquía de elementos de datos ampliados relacionados en correspondencia con un determinado grupo de eventos base comunes (CBE). De acuerdo con ello, esta es una manera rápida y eficaz de obtener acceso a la lista de elementos de datos ampliados relacionados sin tener que buscarlos y examinarlos todos. 

Esta propiedad es OPCIONAL y mudable.
 

Descripción del tipo ContextDataElement (elemento de datos de contexto)

El tipo ContextDataElement define uno o más contextos a los que hace referencia este evento. En este tipo complejo están los datos que ayudarán a correlacionar los mensajes o los eventos generados a lo largo del proceso de ejecución de una unidad de trabajo con vistas al diagnóstico de problemas.

En la siguiente tabla se proporciona un resumen de las propiedades de datos que representan un contexto en el evento base común (CBE). Después de la tabla resumida se da una explicación detallada del tipo ContextDataElement.

A continuación figura una descripción detallada de contextDataElement:
 

type

La propiedad type representa el tipo de datos del contexto. Este tipo debe permitir que el consumidor del evento reconozca el formato del valor de contexto. El tipo es específico de la aplicación (por ejemplo, PD_LogRecordCorrelator).

Esta propiedad es OBLIGATORIA e inmutable.

name

La propiedad name representa el nombre de la aplicación que ha creado este elemento de datos de contexto (por ejemplo, Motor de correlación).

Esta propiedad es OBLIGATORIA e inmutable.

contextValue

Esta propiedad representa el valor del contexto con respecto a su implementación.

Esta propiedad no es obligatoria si la propiedad contextId especifica un valor; además es inmutable.
 

contextId

Esta propiedad es la referencia al elemento que contiene un contexto específico de un producto o un usuario.

Esta propiedad no es obligatoria si la propiedad contextValue especifica un valor; además, es inmutable. NO DEBE especificarse si se especifica la propiedad contextValue.

Nota: las propiedades contextValue y contextId se excluyen mutuamente; solo se puede definir una de las dos. Sin embargo, si la propiedad contextValue se establece en un valor, se desprecia el valor que tenga la propiedad contextId.
 

Descripción del tipo AssociatedEvent (evento asociado)

El tipo AssociatedEvent permite agrupar los eventos. Sirve para identificar los eventos asociados y el correspondiente motor de asociación (propiedad associationEngine).

La descripción detallada del tipo AssociatedEvent es la siguiente:

associationEngine

Esta propiedad representa una referencia al motor de asociación (AssocationEngine) que creó este evento asociado.

Esta propiedad es OBLIGATORIA e inmutable una vez establecida.

resolvedEvents

Esta propiedad representa una matriz de globalInstanceIds que se corresponden con los eventos asociados a este.

Es una propiedad OBLIGATORIA mudable, proporcionada por el motor de asociación especificado por la propiedad name.
 

Descripción del tipo AssociationEngine

El elemento AssociationEngine permite identificar los eventos asociados; es un tipo complejo que también proporciona propiedades para describir el tipo de asociación. Viene representado por una entidad autónoma propia en el esquema XML y en los elementos AssociatedEvent que hacen referencia a él. 

La descripción detallada del tipo AssociationEngine es la siguiente:

name

Nombre de la aplicación que creará la asociación (por ejemplo, nombre de mi motor de correlación).

Esta propiedad es OBLIGATORIA e inmutable una vez establecida.

type

Esta propiedad debe contener el tipo de asociación creada por este motor (AssociationEngine).

Algunas de las asociaciones bien definidas son:

Los valores de las palabras clave reservadas son los siguientes:

Esta propiedad es OBLIGATORIA e inmutable una vez establecida para una propiedad "name" específica. 

id

Esta propiedad representa el identificador primario del elemento. DEBE ser una propiedad globalmente exclusiva. El valor recomendado es un ID globalmente exclusivo de 128 bits o 256 bits (representado por una serie hexadecimal). Una vez establecido, no se DEBE cambiar nunca este valor.

Es una propiedad OBLIGATORIA e inmutable.

Descripción del tipo MsgDataElement (elemento de datos de mensaje)

El tipo MsgDataElement representa los datos que permiten especificar toda la información relacionada que se asocia al mensaje contenido en este evento.

msgId

La propiedad msgId especifica el identificador de mensaje del evento. Este identificador es normalmente un valor exclusivo de tipo serie de caracteres alfanuméricos o numéricos. Puede ser tan simple como una serie de caracteres numéricos que identifica un mensaje en un catálogo de mensajes o tan complejo como una serie múltiple de caracteres alfanuméricos (por ejemplo, DBT1234E). El formato del contenido de la propiedad msgId se especifica mediante la propiedad msgIdType, que se describe en el siguiente apartado.

Es una propiedad OPCIONAL, pero inmutable una vez establecida, y la debe proporcionar el componente que emite el evento. La longitud máxima de la serie msgId NO DEBE superar los 256 caracteres. 

msgIdType

La propiedad msgIdType especifica el significado y el formato de la propiedad msgId. Si el ID está en conformidad con (o representa) un convenio estándar o por todos conocido, ello se indica en esta propiedad. Por ejemplo, el tipo de identificador IBM3.4.1 implica un ID de mensaje de 3 partes, un identificador de tipo serie de 8 caracteres, con 3 caracteres alfabéticos que representan un componente, seguido de 4 caracteres numéricos y con un sufijo formado por un carácter alfabético (por ejemplo, DBT2359I). Otras palabras clave reservadas similares son IBM3.4, IBM4.4, IBM3.1.4, IBM3.4.1, IBM4.4.1 e IBM3.1.4.1.

La lista actual no exclusiva de palabras clave reservadas es:

Es una propiedad OPCIONAL, pero inmutable una vez establecida, y la debe proporcionar el componente que emite el evento. Hay que suministrarla si se especifica la propiedad msgId. La longitud máxima de la serie msgIdType NO DEBE superar los 32 caracteres. 

msgLocale

La propiedad msgLocale especifica el entorno local en el que viene representado el mensaje. Su valor es el código de un entorno local que esté en conformidad con las especificaciones del documento RFC 1766 de IETF. Por ejemplo, en-US es el valor que corresponde al inglés de Estados Unidos.

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar. Si se especifica la propiedad msgLocale, el consumidor del evento es el que debe decidir el entorno local. 

La longitud máxima de cada serie msgLocale NO DEBE superar los 5 caracteres.

msgCatalogTokens

La propiedad msgCatalogTokens consta de una matriz de valores de tipo serie destinada a los datos de sustitución que servirán para resolver un mensaje basado en NLS en un texto plenamente formateado. El orden de los valores viene establecido por el orden implícito de los elementos de la matriz. El entorno local de los símbolos debe coincidir con el entorno local del texto del mensaje, definido en la propiedad msgLocale.

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar. Si no hay ningún valor de sustitución, no hace falta especificar esta propiedad. La longitud máxima de la serie msgCatalogTokens NO DEBE superar los 256 bytes.

msgCatalogId

La propiedad msgCatalogId representa el índice o el identificador de un mensaje que sirve para resolver el texto del mensaje a partir de un catálogo de mensajes.

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar.

msgCatalog

La propiedad msgCatalog representa el nombre calificado del catálogo de mensajes que contiene el mensaje traducido especificado por la propiedad msgCatalogId.

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar. La longitud máxima de la serie msgCatalog NO DEBE superar los 128 caracteres.

msgCatalogType

La propiedad msgCatalogType especifica el significado y el formato de la propiedad msgCatalog. La lista actual no exclusiva de palabras clave reservadas es: 

Esta propiedad es OPCIONAL, pero una vez establecida, no se puede cambiar; DEBE proporcionarse si se define la propiedad msgCatalog. La longitud máxima de la serie msgCatalogType NO DEBE superar los 32 caracteres. 
 

Conceptos relacionados
Modelo de evento base común

Consulta relacionada
Especificación de esquema XML de un evento base común


(C) Copyright IBM Corporation 2000, 2003. Reservados todos los derechos.