Description du modèle Common Base Event

Le modèle Common Base Event est la nouvelle norme des événements parmi les différents types d'applications d'entreprise. Cette norme propose la cohérences des éléments de données qui constituent ces événements, à la fois dans les éléments proprement dits et dans leur format.

Conventions utilisées dans le modèle Common Base Event

Description du modèle Common Base Event

Les propriétés suivantes qui identifient les données collectées pour la situation 3-tuple constituent le modèle Common Base Event :

localInstanceId

La propriété localInstanceId est de type chaîne et est utilisée pour identifier en local les instances d'un événement. Il n'y a aucune garantie implicite selon laquelle cette valeur est globalement unique. Cependant, une fois qu'elle est définie, elle demeure constante pour la durée de vie de l'événement. La valeur de la propriété localInstanceId correspond PEUT-ETRE à une valeur comportant plusieurs parties (par exemple, un horodatage, un emplacement, une position ou un ID message) ou utilise PEUT-ETRE d'autres techniques définies par l'application pour fournir le contenu garantissant le caractère unique de l'ID. Par exemple, vous pouvez paramétrer l'identificateur sur la concaténation des chaînes suivantes : adresse IP de l'hôte local, chemin absolu du fichier access.log, nom complet de l'hôte local, horodatage et numéro de séquence (sequenceNumber). La chaîne résultante apparaît sous la forme suivante :

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

Cette propriété ne correspond pas à une clé. Il s'agit d'une propriété FACULTATIVE non modifiable. Elle PEUT être fournie par le composant qui émet l'événement ou attribuée par l'utilisateur de l'événement. La longueur de chaîne maximale de la propriété localInstanceId NE DOIT PAS excéder 128 caractères.

globalInstanceId

La propriété globalInstanceId correspond à un type de données complexe représentant l'identificateur principal de l'événement. La propriété permet l'identification globale et unique de l'événement et PEUT servir de clé principale pour l'événement. La valeur DOIT correspondre à un identificateur global unique (GUID) comportant au moins 128 bits et au maximum 256 bits. Il appartient à l'algorithme de génération de GUID d'assurer le caractère unique de cette valeur.

Il s'agit d'une propriété FACULTATIVE ; cependant, lorsqu'elle est spécifiée, elle n'est pas modifiable, c'est-à-dire, une fois définie, elle ne peut pas être modifiée pendant la durée de vie de l'événement. La propriété globalInstanceId peut être fournie par le composant qui émet l'événement ou par l'utilisateur de l'événement.

La propriété globalInstanceId doit établir des associations entre les événements. Si la propriété globalInstanceId n'est pas spécifiée, l'association, telle qu'elle est décrite par AssociatedEvent, ne peut pas être fournie.

creationTime

La date et l'heure de création de l'événement DOIVENT être spécifiées, telles qu'elles sont définies par le type de données dateTime du schéma XML. La valeur de la propriété creationTime DOIT fournir une granularité aussi précise que celle autorisée par la plateforme de génération.

Il s'agit d'une propriété OBLIGATOIRE non modifiable qui DOIT être fournie par le composant qui signale l'événement. Une fois définie, elle ne peut pas être modifiée pendant la durée de vie de l'événement.

severity

La propriété severity indique le niveau de gravité de l'état décrit par l'événement, par rapport à l'application qui signale l'événement. La signification des valeurs éventuellement contenues dans la propriété peut être décrite à l'aide d'une énumération de valeurs ou qualificatifs courants indiquant le niveau de gravité de l'événement. Par exemple, information, avertissement ou certains entiers correspondants aux niveaux de gravité prévus sont des valeurs valides. Ce document ne suggère aucune implémentation spécifique. En revanche, il propose les valeurs ci-dessous à condition que les utilisateurs de cette zone puissent ajouter d'autres valeurs en fonction des exigences de leurs implémentations. Cette zone aide simplement à définir la gravité de la situation rencontrée et à permettre aux administrateurs de se concentrer sur les incidents les plus graves qui se produisent dans l'entreprise.

Les niveaux de gravité prédéfinis suivants sont répertoriés dans l'ordre croissant :

Les valeurs sont comprises entre 0 et 70. Les valeurs réservées commencent par 0 pour le niveau UNKNOWN et augmentent par incréments de 10, jusqu'à 60 pour le niveau FATAL. D'autres niveaux de gravité PEUVENT être ajoutés mais sans dépasser la valeur 70. Si aucune valeur n'est spécifiée, cet événement est considéré comme n'ayant aucune gravité, ce qui correspond à la valeur "NONE".

Il s'agit d'une propriété FACULTATIVE qui n'est pas modifiable une fois qu'elle est définie. Il n'y a pas de valeur par défaut pour la gravité.

priority

Cette propriété définit l'importance de l'événement et l'ordre relatif dans lequel les enregistrements doivent être traités. Les priorités suivantes sont prédéfinies :

Les valeurs sont comprises entre 0 et 100. La valeur réservée pour Faible est 10, pour Moyenne 50 et pour Elevée 70. D'autres priorités PEUVENT être ajoutées mais sans dépasser la valeur 100.

Si aucune valeur n'est spécifiée, cet événement est considéré comme n'ayant aucune priorité, ce qui correspond à la valeur "NONE".

La propriété priority est distincte de la propriété severity, dans la mesure où la première est prévue comme étant une propriété contrôlée par l'utilisateur, alors que la propriété severity impose l'état de la situation, telle qu'elle est perçue par le composant affecté. Par exemple, un événement dont la priorité est HIGH et la gravité MINOR doit être traité avant un événement de priorité LOW et de gravité CRITICAL.

Il s'agit d'une propriété FACULTATIVE modifiable. Il n'y a pas de valeur par défaut pour la priorité.

reporterComponentId

La propriété reporterComponentId correspond à l'identification du composant qui a signalé l'événement ou la situation pour le compte du composant affecté. Le type de données de cette propriété est un type complexe, tel qu'il est décrit par le type ComponentIdentification qui fournit les données requises pour l'identification unique d'un composant.

Il s'agit d'une propriété OBLIGATOIRE si le composant de signalisation est différent du composant source. Dans le cas contraire, cette zone DOIT être omise. Cette propriété n'est pas modifiable une fois qu'elle est définie.

sourceComponentId

La propriété sourceComponentId correspond à l'identification du composant qui a été affecté par l'événement ou la situation. Le type de données de cette propriété est un type complexe, tel qu'il est décrit par le type  ComponentIdentification qui fournit les données requises pour l'identification unique d'un composant.

Cette propriété est OBLIGATOIRE et non modifiable. Le générateur de l'événement DOIT fournir la propriété sourceComponentId. Si le rapporteur et les composants affectés sont identiques, la propriété reporterComponentId DOIT être omise.

situationType

La propriété situationType indique le type de la situation qui a été à l'origine de l'événement à signaler. Il s'agit d'une valeur de chaîne extensible.

Les mots clés réservés proposés sont les suivants :

Cette propriété est FACULTATIVE et non modifiable. La longueur de chaîne maximale de situationType NE DOIT PAS excéder 512 octets.

contextDataElements

La propriété contextDataElements correspond à un tableau de contextes de type ContextDataElement  utilisé par cet événement. Cette propriété contient des données qui aident à corréler les messages ou les événements générés le long du chemin d'exécution d'une unité d'oeuvre à des fins de diagnostic d'incident.

Il s'agit d'une propriété FACULTATIVE modifiable.Elle peut être fournie par le composant qui émet l'événement ou attribuée par l'utilisateur de l'événement.

msg

La propriété msg correspond au texte qui accompagne l'événement. Il s'agit généralement de la chaîne de messages résolue dans un format lisible par l'utilisateur pour un environnement local spécifique.

L'environnement local de la propriété msg est spécifié par la propriété msgLocale du type MsgDataElement. Il n'y a pas de valeur par défaut pour l'environnement local msg.

Cette propriété est FACULTATIVE mais il est RECOMMANDE de lui affecter une valeur si les propriétés msgCatalogId et msgCatalog de MsgDataElement  ne spécifient pas de valeur.

msgDataElement

msgDataElement est une propriété qui fait référence à un type MsgDataElement. Cette propriété contient des données servant à spécifier toutes les informations connexes associées au message contenu dans cet événement.

Il s'agit d'une propriété FACULTATIVE non modifiable. Elle est fournie par le composant qui émet l'événement.

extensionName

La propriété extensionName contient le nom d'une "classe d'événements" représentée par cet événement (par exemple, Trace, CommonBaseEvent). Le nom de classe d'événements indique toutes les propriétés supplémentaires devant être présentes dans l'événement spécifique. Si vous choisissez d'utiliser la propriété ExtendedDataElement, qui est décrite dans la section qui suit, il est conseillé de spécifier une valeur pour la propriété extensionName.

Il s'agit d'une propriété FACULTATIVE non modifiable qui DOIT être fournie par le composant qui signale l'événement. Si la valeur spécifiée est NULL, la valeur utilisée par défaut est "CommonBaseEvent".

extendedDataElements et extendedProperties

La propriété extendedDataElements est une série d'éléments de nom de type ExtendedDataElement. Elle doit être utilisée à des fins d'extension. Pour ce faire,
indiquez un emplacement dans lequel spécifier tous les autres attributs non représentés dans le modèle de données CommonBaseEvent. Les informations placées dans cet emplacement sont considérées comme étant des données propres au produit.

Il s'agit d'une propriété que vous pouvez fournir et les éléments nommés peuvent être filtrés, utilisés pour les recherches ou référencés par les règles de corrélation.

Cette propriété est FACULTATIVE et modifiable. En d'autres termes, une fois définie, elle peut être modifiée. La valeur de cette propriété peut être fournie par le composant qui émet l'événement ou attribuée par l'utilisateur de l'événement.

associatedEvents

La propriété associatedEvents permet le regroupement non restreint des événements ou des relations parent-enfant. Il s'agit d'un type complexe qui est composé de propriétés globalInstanceId identifiant les événements associés, ainsi qu'une zone de type décrivant le type de l'association qui est représentée par le nom de l'association.

Cette propriété est FACULTATIVE et modifiable. En d'autres termes, une fois définie, elle peut être modifiée. La valeur de cette propriété peut être fournie par le composant qui émet l'événement ou attribuée par l'utilisateur de l'événement.

repeatCount

La propriété repeatCount correspond au nombre d'occurrences d'un événement donné pour un intervalle de temps spécifique. L'intervalle de temps est indiqué par la propriété elapsedTime décrite ci-dessous. La définition de ce qui fait d'un événement une répétition d'un événement précédemment émis est propre à l'application et, par conséquent, n'est pas définie par cette spécification.

Cette propriété est FACULTATIVE et modifiable. Elle peut être définie par le composant qui émet l'événement ou par l'utilisateur de l'événement. Il n'y a pas de valeur par défaut. Une valeur de 0 ou l'absence de valeur indique que l'événement n'est pas répété.

elapsedTime

La propriété elapsedTime correspond à l'intervalle de temps ou au temps écoulé d'un certain nombre d'occurrences d'un événement spécifique. Le nombre d'occurrences est indiqué par la valeur de la propriété repeatCount.Cette valeur indique la durée de la période pendant laquelle les événements répétés ont été observés.

La valeur de cette propriété DOIT être exprimée en microsecondes de granularité.

Cette propriété est FACULTATIVE et modifiable. Cependant si elle est spécifiée, un temps écoulé doit être indiqué. La propriété elapsedTime peut être définie par le même composant qui définit la propriété repeatCount. Il n'y a pas de valeur par défaut pour elapsedTime.

sequenceNumber

La propriété sequenceNumber est un nombre défini à la source qui permet à plusieurs messages d'être envoyés et traités dans un ordre logique différent de l'ordre dans lequel ils sont arrivés chez l'utilisateur (par exemple, un serveur d'événements ou des outils de gestion). Le numéro de séquence aide les utilisateurs à trier les messages arrivés, en fonction de l'heure et du fournisseur particulier de l'événement.

Cette propriété est FACULTATIVE et non modifiable une fois définie. Il n'y a pas de valeur par défaut.

Description du type ComponentIdentification

Lors de la génération de rapports d'incidents, il existe deux catégories générales de composants qui doivent être prises en considération pour le diagnostic des incidents : le composant qui observe et signale la situation (rapporteur) et le composant réel qui est confronté à la situation (affecté). L'identification de composants fournit un ensemble d'attributs requis pour l'identification unique d'un composant. Les mêmes données servent à identifier le composant qui signale un événement ou une situation et le composant qui est affecté par la situation ou confronté à cette dernière. Dans certains cas, ces composants sont identiques.

Par exemple, dans un environnement informatique standard, les activités des applications qui s'exécutent dans cet environnement sont généralement contrôlées à l'aide des événements reçus ou colletés des applications au moyen d'agents de gestion ou d'adaptateurs.

Exemple 1 : Prenez en considération le cas où une application WebSphere appelée myWebApp arrive à expiration lors d'une requête de table, en raison d'un incident de serveur DB2 qui se situe sur un système éloigné. L'application Web émet alors un événement indiquant la situation d'échec. Dans ce cas, myWebApp est le composant "affecté" ou le composant "source".

Exemple 2 : Prenez en considération le cas où une application X est en cours d'exécution sur un serveur Windows. Cette application rencontre une erreur et ajoute une entrée dans le journal des erreurs Windows. Puis, une application distincte (un adaptateur) lit les messages du journal des erreurs et génère un événement de base commun qu'il soumet ensuite. Dans ce cas, le composant "affecté" ou "source" de l'événement est l'application X et le composant de signalisation est l'adaptateur qui a généré et soumis l'événement.

Une description détaillée du type ComponentIdentification est présentée ci-dessous.

location

La propriété location indique l'adresse physique qui correspond à l'emplacement d'un composant (par exemple, nom d'hôte, adresse IP, unité logique VTAM). Le format de la valeur de la propriété location est spécifié par la propriété locationType. La valeur préférée correspond à un nom d'hôte qualifié complet.

Cette propriété est OBLIGATOIRE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de location NE DOIT PAS excéder 256 caractères.

locationType

Cette propriété spécifie le format et la signification de la valeur de la propriété location. Elle comporte les mots clés réservés identifiés suivants :

La valeur par défaut est "Unknown". Cette propriété est OBLIGATOIRE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de locationType NE DOIT PAS excéder 32 caractères.

application

La propriété application spécifie le nom d'utilisateur de l'application (par exemple, myApp). Vous pouvez ajouter les informations relatives à la version de l'application à la fin du composant en les séparant à l'aide d'un caractère #.

Il s'agit d'une propriété FACULTATIVE non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de la propriété application NE DOIT PAS excéder 256 caractères.

executionEnvironment

La propriété executionEnvironment identifie l'environnement immédiat dans lequel une application est en cours d'exécution. Par exemple, un nom WebSphere Application Server : cellule:noeud:serveur.

Vous pouvez ajouter les informations relatives à la version de l'environnement d'exécution à la fin du composant en les séparant à l'aide d'un caractère #. La longueur de chaîne maximale de la propriété executionEnvironment NE DOIT PAS excéder 256 caractères.

Il s'agit d'une propriété FACULTATIVE non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée pendant la durée de vie de l'événement.

component

La propriété component spécifie l'identité logique d'un composant. Cette propriété DOIT contenir le nom d'une application, d'un produit ou d'un sous-système particulier (par exemple, IBM DB2 V7.1). Cette valeur DOIT être unique dans l'environnement spécifié par l'emplacement du rapporteur.

Cette propriété est OBLIGATOIRE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée pendant la durée de vie de l'événement. La longueur de chaîne maximale de la propriété component NE DOIT PAS excéder 256 caractères.

subComponent

La propriété subComponent spécifie une description détaillée de la propriété de composant logique de l'événement.

Elle DOIT contenir l'identité du sous-composant de la propriété component et correspondre à la définition la plus granulaire spécifiée dans l'événement. Cette propriété peut être une des nombreuses parties d'une application ou d'une ressource de système d'exploitation, par exemple, un nom de module, un nom de classe, une classe et un nom de méthode.

Cette propriété est OBLIGATOIRE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée pendant la durée de vie de l'événement. La longueur de chaîne maximale de la propriété subComponent NE DOIT PAS excéder 512 caractères.

componentIdType

La propriété componentIdType spécifie le format et la signification du composant qui est identifié par ce componentIdentification. Voici la liste non exclusive des mots clés réservés de cette propriété :
 

Cette propriété est OBLIGATOIRE et non modifiable. La longueur de chaîne maximale de componentIdType NE DOIT PAS excéder 32 caractères.

instanceId

La propriété instanceId spécifie un descripteur ou un identificateur pour l'instance du composant qui est indiqué par la propriété component. C'est-à-dire, Grid Service Handle(GSH), EJBHandle.

Cette propriété est FACULTATIVE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de la propriété instanceId NE DOIT PAS excéder 128 caractères.

processId

La propriété processId est de type chaîne identifiant l'ID processus du composant ou sous-composant "actif" qui a généré l'événement.

Cette propriété est FACULTATIVE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de processId NE DOIT PAS excéder 64 caractères.

threadId

La propriété threadId est de type chaîne et identifie l'ID d'unité d'exécution du composant ou sous-composant indiqué par l'ID processus qui a généré l'événement. Il se peut qu'un processus en cours d'exécution engendre une ou plusieurs unités d'exécution de sorte qu'elles exécutent sa fonction et les requêtes entrantes. L'ID d'unité d'exécution change donc en conséquence.

Cette propriété est FACULTATIVE et non modifiable. En d'autres termes, une fois définie, elle ne peut pas être modifiée. La longueur de chaîne maximale de threadId NE DOIT PAS excéder 64 caractères.

Description du type ExtendedDataElement

Le type ExtendedDataElement permet de fournir des collections nom-type-valeur à spécifier à des fins d'extension. Vous pouvez y inclure tous les autres attributs qui ne sont pas représentés dans le modèle de données CommonBaseEvent. Les collections spécifiées dans cet emplacement sont considérées comme étant des données propres au produit.

Les propriétés nommées peuvent être filtrées, utilisées pour les recherches ou référencées par les règles de corrélation. Le "nom" est défini pour vous ; cependant, la liste non exclusive des mots clés réservés est la suivante :

RawData : Ce mot clé indique les données "en l'état" dont l'état est généralement propre au générateur de ces données. Il peut se présenter sous n'importe quelle forme, y compris binaire. Il permet l'extraction des données textuellement et la prise en charge des outils qui comprennent le format du contexte.

RootHeader : Ce mot clé sert à identifier la propriété racine ExtendedDataElement pour une hiérarchie des types ExtendedDataElement qui sont définis par les dataRefs.

Voici la description détaillée du type ExtendedDataElement :

name

La propriété name spécifie le nom du type ExtendedDataElement. Ce nom DOIT être unique en ce qui concerne toutes les autres propriétés de l'événement (par exemple, RawData, msgLocale et EventStatus).

Cette propriété est OBLIGATOIRE et non modifiable.
 

type

Type de données des valeurs spécifiées dans la propriété values ci-dessous.

Les types valides sont les suivants :
 

Les types de données ci-dessus sont les seuls types valides pris en charge par le type ExtendedDataElement. La valeur par défaut est "string".

Cette propriété est OBLIGATOIRE et non modifiable.

values

Tableau des valeurs de cet élément de données étendu dont le type est défini par la propriété type décrite ci-dessus.

Cette propriété est FACULTATIVE et modifiable. Elle NE DOIT PAS être spécifiée si la propriété "value" ou "hexValue" est indiquée.

hexValue

La propriété hexValues correspond à un tableau d'octets contenant les données relatives à tout autre type de données ou complexType qui ne figure pas dans la liste des types pris en charge définis ci-dessus.

Cette propriété est FACULTATIVE et non modifiable. Elle NE DOIT PAS être spécifiée si la propriété "values" ou "value" est indiquée.

Remarque : Les propriétés hexValue et values s'excluent mutuellement. Vous ne pouvez définir qu'une seule de ces deux propriétés.
 

children

La propriété children fait référence à un ou plusieurs autres types ExtendedDataElement pour spécifier une liste structurée d'éléments de données étendus.Cette liste permet la création d'une hiérarchie d'éléments de données étendus associés correspondant à un groupe spécifique de CommonBaseEvents.En conséquence, il s'agit d'un moyen efficace et rapide pour accéder à la liste des types ExtendedDataElement associés sans avoir à consulter tous les ExtendedDataElement.

Cette propriété est FACULTATIVE et modifiable.
 

Description du type ContextDataElement

Le type ContextDataElement définit un ou plusieurs contextes référencés par cet événement. Ce type complexe contient des données qui aident à corréler les messages ou les événements générés le long du chemin d'exécution d'une unité d'oeuvre à des fins de diagnostic d'incident.

Le tableau ci-dessous contient un récapitulatif des propriétés de données représentant un contexte dans l'événement de base commun. Ce tableau est suivi d'une description détaillée de ContextDataElement.

Voici une description détaillée de contextDataElement :
 

type

Il s'agit du type de données du contexte. Ce type doit permettre à l'utilisateur de l'événement de reconnaître le format de la valeur de contexte. Le type est propre à l'application (par exemple, PD_LogRecordCorrelator).

Cette propriété est OBLIGATOIRE et non modifiable.

name

Il s'agit du nom de l'application qui a créé cet élément de données de contexte (par exemple, moteur de corrélation).

Cette propriété est OBLIGATOIRE et non modifiable.

contextValue

Il s'agit de la valeur du contexte en rapport avec l'implémentation du contexte.

Cette propriété n'est pas obligatoire si contextId spécifie une valeur. Elle n'est pas modifiable.
 

contextId

Cette propriété constitue la référence à l'élément qui contient un contexte propre au produit ou à l'utilisateur.

Cette propriété n'est pas obligatoire si contextValue spécifie une valeur. Elle n'est pas modifiable. Elle NE DOIT PAS être spécifiée si la propriété contextValue est indiquée.

Remarque : Les propriétés contextValue et contextId s'excluent mutuellement ; vous ne pouvez définir qu'une seule de ces deux propriétés. Cependant, si la propriété contextValue est paramétrée sur une valeur, la propriété contextId est ignorée.
 

Description du type AssociatedEvent

Le type AssociatedEvent sert à regrouper des événements. Il permet d'identifier des événements associés et leur associationEngine.

Voici la description détaillée du type AssociatedEvent :

associationEngine

Il s'agit d'une référence à l'élément AssociationEngine qui a créé ce type AssociatedEvent.

Cette propriété est OBLIGATOIRE et non modifiable une fois définie.

resolvedEvents

Tableau de propriétés globalInstanceIds correspondant aux événements qui sont associés à cet événement.

Il s'agit d'une propriété OBLIGATOIRE modifiable qui est fournie par le moteur d'association spécifié par la propriété nom.
 

Description du type AssociatedEvent

L'élément AssociationEngine permet l'identification des événements associés ; ce type complexe fournit également des propriétés décrivant le type de l'association.Il est représenté par sa propre entité autonome dans le schéma XML et les éléments AssociatedEvent lui font référence.

Voici la description détaillée du type AssociationEngine :

name

Nom de l'application qui va créer l'association (par exemple, nom du moteur de corrélation).

Cette propriété est OBLIGATOIRE et non modifiable une fois définie.

type

Cette propriété doit contenir le type de l'association créée par cet élément AssociationEngine.

Voici quelques associations bien définies&nbps;:

Valeurs des mots clés réservés :

 Cette propriété est OBLIGATOIRE et non modifiable une fois qu'elle est définie pour une propriété "name" spécifique.

id

Identificateur principal de l'élément. Cette propriété DOIT être globalement unique. La valeur recommandée pour cette propriété est un ID global unique de 128 bits ou de 256 bits (représenté sous forme de chaîne hexadécimale). Une fois définie, cette valeur NE DOIT jamais être modifiée.

Cette propriété est OBLIGATOIRE et non modifiable.

Description du type MsgDataElement

Le type MsgDataElement contient les données servant à spécifier toutes les informations connexes associées au message contenu dans cet événement.

msgId

La propriété msgId spécifie l'identificateur de message de l'événement. Cet identificateur est généralement une chaîne de valeur unique comportant des caractères alphanumériques ou numériques. Il peut simplement s'agir d'une chaîne multiple de caractères numériques identifiant un message dans un catalogue de messages ou d'une chaîne de caractères alphanumériques (par exemple, DBT1234E). Le format du contenu de la propriété msgId est spécifié par la propriété msgIdType, comme décrit dans la section qui suit.

Cette propriété est FACULTATIVE et non modifiable une fois définie, et doit être fournie par le composant qui émet l'événement.La longueur de chaîne maximale de la propriété msgId NE DOIT PAS excéder 256 caractères.

msgIdType

La propriété msgIdType spécifie la signification et le format de la propriété msgId. Si l'ID respecte ou représente une norme ou une convention identifiée, il est nommé par cette propriété. Par exemple, IBM3.4.1 désigne un ID message d'un identificateur de chaîne comportant 3 parties et 8 caractères, constitué de 3 caractères alphabétiques représentant un composant, suivi de 4 caractères numériques et dont le suffixe est représenté par un caractère alphabétique (par exemple, DBT2359I). IBM3.4, IBM4.4, IBM3.1.4, IBM3.4.1, IBM4.4.1 et IBM3.1.4.1 sont d'autres mots clés réservés similaires.

La liste non exclusive en cours des mots clés réservés est la suivante :

Cette propriété est FACULTATIVE et non modifiable une fois définie, et doit être fournie par le composant qui émet l'événement.Elle doit être fournie si la propriété msgId est spécifiée.La longueur de chaîne maximale de la propriété msgIdType NE DOIT PAS excéder 32 caractères.

msgLocale

La propriété msgLocale spécifie l'environnement local de msg. Sa valeur correspond à un code d'environnement local conforme aux spécifications IETF RFC 1766. Par exemple, fr-FR est la valeur pour le français.

Cette propriété est FACULTATIVE et non modifiable une fois définie.Si la propriété msgLocale est spécifiée, il appartient à l'utilisateur de l'événement de déterminer l'environnement local.

La longueur de chaîne maximale de msgLocale NE DOIT PAS excéder 5 caractères.

msgCatalogTokens

La propriété msgCatalogTokens comprend un tableau de valeurs de chaîne permettant le stockage de données de substitution pour la résolution d'un message NLS vers un texte entièrement mis en forme. L'ordre des valeurs est fourni par l'ordre implicite des éléments de tableau. L'environnement local des jetons doit être identique à celui du texte de message, tel qu'il est défini par msgLocale.

Cette propriété est FACULTATIVE et non modifiable une fois définie. S'il n'y a aucune valeur de substitution, il n'est pas nécessaire de spécifier cette propriété. La longueur de chaîne maximale de la propriété msgCatalogTokens NE DOIT PAS excéder 256 octets.

msgCatalogId

La propriété msgCatalogId correspond à l'index ou à l'identificateur d'un message, qui est utilisé pour la résolution du texte de message à partir d'un catalogue de messages.

Cette propriété est FACULTATIVE et non modifiable une fois définie.

msgCatalog

La propriété msgCatalog correspond au nom qualifié du catalogue de messages qui contient le message traduit spécifié par la propriété msgCatalogId.

Cette propriété est FACULTATIVE et non modifiable une fois définie. La longueur de chaîne maximale de la propriété msgCatalog NE DOIT PAS excéder 128 caractères.

msgCatalogType

La propriété msgCatalogType spécifie la signification et le format de la propriété msgCatalog.La liste non exclusive en cours des mots clés réservés est la suivante :

Cette propriété est FACULTATIVE et non modifiable une fois qu'elle est définie. Elle DOIT être fournie si la propriété msgCatalog est définie.La longueur de chaîne maximale de la propriété msgCatalogType NE DOIT PAS excéder 32 caractères.
 

Concepts connexes
Modèle Common Base Event

Référence associée
Spécification de schéma XML pour Common Base Event


(C) Copyright IBM Corporation 2000, 2003. All Rights Reserved.