Das Common Base Event-Modell ist der neue Standard für Ereignisse in den verschiedenen Unternehmensanwendungstypen. Dieser Standard schafft Konsistenz in den Datenelementen, aus denen sich Ereignisse zusammensetzen. Diese Konsistenz bezieht sich auf die Elemente selbst und auf deren Format.
Die Schlüsselwörter "MUSS" (MUST), "DARF NICHT" (MUST NOT), "ERFORDERLICH" (REQUIRED), "SOLL" (SHALL), "SOLL NICHT" (SHALL NOT), "SOLLTE" (SHOULD), "SOLLTE NICHT" (SHOULD NOT), "EMPFOHLEN" (RECOMMENDED), "KANN" (MAY) und "OPTIONAL" (OPTIONAL) sind gemäß der Beschreibung in RFC-2119 (www.ietf.org/rfc/rfc2119.txt) zu interpretieren.
Formatierte Daten liegen immer in visuell lesbarer Form vor. Alle formatierten Daten und Zeichenfolgewerte MÜSSEN als UTF-8-Zeichenfolge codiert werden.
- Common Base Event unterstützt nur die folgende Untergruppe der XML-Schemadatentypen und die Array-Variationen dieser Typen. Die Beschreibung dieser Datentypen finden Sie in der XML-Schemaspezifikation. Bei den Datentypen handelt es sich um XML-Schemadatentypen mit Vorzeichen. Weitere Informationen finden Sie im zugehörigen Verweis.
- byte
- short
- int
- long
- float
- double
- string
- dateTime
- duration
- hexBinary
- boolean
Die maximale Zeichenfolgenlänge DARF NICHT größer als 1024 Zeichen sein. Wenn Sie eine längere Zeichenfolge benötigen, KÖNNEN Sie den Typ hexBinary wählen.
Auf Basis empirischer Daten von bekannten Konsumenten und aufgrund bestehender Einschränkungen in
der Verarbeitung und Speicherung von Ereignissen wurden Feldlängen spezifiziert, die eine
möglichst breite Akzeptanz und Genauigkeit gewährleisten sollen.
Es kann jedoch vorkommen, dass ein Absender diese Längenbeschränkungen überschreitet.
In diesem Fall obliegt es dem Konsumenten eines Ereignisses, das Ereignis entweder
in der vorliegenden Form zu akzeptieren, es so anzupassen, dass es der Spezifikation entspricht,
oder es als ungültig anzusehen und zu verwerfen. Im Allgemeinen ist jedoch die
Erhaltung der Daten, auch wenn diese nicht in Übereinstimmung mit der Ereignisspezifikation vorliegen,
einem totalen Verlust des Ereignisses vorzuziehen.
Daher empfehlen wir, alle möglichen Schritte zur Erhaltung der Ereignisdaten zu unternehmen.
Bei allen in diesem Dokument angegebenen Namen und Zeichenfolgen wird zwischen Groß-/Kleinschreibung unterschieden.
Ein Common Base Event setzt sich aus folgenden Merkmalen zusammen, welche die Daten enthalten, die für das Situationsdreitupel erfasst werden:
Die localInstanceId hat den Typ string und wird zur lokalen Identifikation der Instanzen eines Ereignisses verwendet. Es besteht keine implizite Garantie, dass dieser Wert global eindeutig ist. Wenn der Wert jedoch einmal gesetzt wird, besteht er während der gesamten Lebensdauer eines Ereignisses. Der Wertinhalt der localInstanceId KANN ein mehrteiliger Wert sein, wie z. B. eine Zeitmarke, eine Adresse, ein Offset oder eine Nachrichten-ID; er KANN auch andere anwendungsdefinierte Verfahren zur Bereitstellung des Inhalts verwenden, mit denen die Eindeutigkeit der ID sichergestellt wird. Beispielsweise können Sie die ID auf die Verkettung einer Zeichenfolge einstellen und in dieser Verkettung die lokale Host-IP-Adresse, eine Zeichenfolge mit dem absoluten Pfad der Datei access.log, eine Zeichenfolge mit dem lokalen, vollständig qualifizierten Hostnamen, eine Zeichenfolge mit der Zeitmarke und eine Zeichenfolge mit der sequenceNumber einbringen. Daraus ergäbe sich eine Zeichenfolge wie diese:
9.27.11.27 mycomputer.toronto.ibm.com 20021009012534.002000-240_0
Dieses Merkmal ist kein Schlüssel. Das Merkmal ist OPTIONAL und nicht mutabel, das bedeutet, es kann nur einmal festgelegt und danach nicht mehr geändert werden. Es KANN von einer Komponente zur Verfügung gestellt werden, die ein Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden. Die maximale Länge der Zeichenfolge für die localInstanceId DARF 128 Zeichen NICHT überschreiten.
Die globalInstanceId ist ein komplexer Datentyp, der die primäre Ereignis-ID darstellt. Das Merkmal identifiziert das Ereignis global und eindeutig und KANN als Primärschlüssel für das Ereignis verwendet werden. Der Wert MUSS eine global eindeutige ID (GUID, Globally Unique Identifier) mit einer Länge von mindestens 128 Bit und höchstens 256 Bit sein. Es obliegt dem Generierungsalgorithmus der GUID, die Eindeutigkeit dieses Werts sicherzustellen.
Das Merkmal ist OPTIONAL, wenn es jedoch angegeben wird, ist es nicht mutabel. Das bedeutet, dass es nur einmal festgelegt und danach nicht mehr geändert werden kann. Die globalInstanceId kann von einer Komponente zur Verfügung gestellt werden, die ein Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden.
Die globalInstanceId ist erforderlich, um Beziehungen zwischen Ereignissen aufzubauen. Wenn die globalInstanceId nicht wie in AssociatedEvent beschrieben angegeben wird, kann keine Beziehung hergestellt werden.
Das Datum und die Zeit der Erstellung des Ereignisses MÜSSEN gemäß der Definition des Datentyps dateTime des XML-Schemas angegeben werden. Der Wert von creationTime MUSS so präzise unterteilt sein, wie es die generierende Plattform zulässt.
Es handelt sich hierbei um ein ERFORDERLICHES Merkmal, das nicht mutabel ist und von der Komponente zur Verfügung gestellt werden MUSS, die das Ereignis berichtet. Wenn das Merkmal festgelegt ist, kann es nicht mehr geändert werden, solange das Ereignis existiert.
Mit severity wird die Prioritätsstufe des Zustands angegeben, den ein Ereignis beschreibt. Dabei wird die Anwendung berücksichtigt, die das Ereignis berichtet. Die Bedeutungen der Merkmalwerte können durch eine Aufzählung von allgemeinen Werten oder Qualifikationsmerkmalen beschrieben werden, aus denen sich die Prioritätsstufe eines Ereignisses ersehen lässt. Beispielsweise sind Information, Warning oder Integerzuordnungen zu den gewünschten Prioritätsstufen gültige Werte. Dieses Dokument enthält keine spezifische Implementierung, sondern empfiehlt die folgenden Werte unter Berücksichtigung der Tatsache, dass Benutzer in ihren eigenen Implementierungen zusätzliche Werte hinzufügen können. Dieses Feld soll dazu dienen, die Ernsthaftigkeit einer eingetretenen Situation zu definieren und Administratoren die Möglichkeit zu geben, sich zunächst auf die ernsten Probleme im Unternehmen konzentrieren zu können.
Nachfolgend sind die vordefinierten Prioritätsstufen mit zunehmender Priorität aufgeführt:
Die Werte liegen zwischen 0 und 70. Die reservierten Werte beginnen mit 0 für Unknown und nehmen in Zehnerschritten bis 60 für Fatal zu. Andere Fehlerkategorien KÖNNEN hinzugefügt werden, DÜRFEN aber NICHT höher als 70 sein. Wird kein Wert angegeben, wird davon ausgegangen, dass das Ereignis keine Fehlerkategorie besitzt. Dies entspricht "NONE".
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde. Es gibt für severity keine Standardeinstellung.
Die Priorität (priority) definiert die Wichtigkeit eines Ereignisses und die relative Reihenfolge, in der die Sätze bearbeitet werden sollten. Die folgenden Prioritäten sind vordefiniert:
Die Werte liegen zwischen 0 und 100. Die reservierten Werte sind 10 für Low, 50 für Medium und 70 für High. Andere Prioritäten KÖNNEN hinzugefügt werden, DÜRFEN aber NICHT höher als 100 sein.
Wird kein Wert angegeben, wird davon ausgegangen, dass das Ereignis keine Prioritätsstufe besitzt. Dies entspricht "NONE".
Das Merkmal priority unterscheidet sich von severity darin, dass priority mehr als verbrauchergesteuertes Merkmal gedacht ist, während severity den Zustand der Situation anhand der betroffenen Komponente beschreiben soll. Ein Ereignis mit priority=HIGH und severity=MINOR sollte beispielsweise vor einem Ereignis mit priority=LOW und severity=CRITICAL bearbeitet werden.
Es handelt sich um ein OPTIONALES Merkmal und es kann verändert werden. Es gibt für die Prioritätsstufe (priority) keine Standardeinstellung.
reporterComponentId ist die ID der Komponente, die ein Ereignis oder eine Situation im Namen der betroffenen Komponente berichtet hat. Der Datentyp dieses Merkmals ist ein komplexer Typ, der im Typ ComponentIdentification beschrieben wird. Dieser Typ stellt die zur eindeutigen Identifikation einer Komponente notwendigen Daten zur Verfügung.
Es handelt sich um ein ERFORDERLICHES Merkmal, wenn die Quellkomponente und die Berichtskomponente unterschiedlich sind. Ansonsten MUSS dieses Feld ausgelassen werden. Das Merkmal ist nicht mutabel, das bedeutet, es kann nur einmal festgelegt und danach nicht mehr geändert werden.
sourceComponentId ist die ID der Komponente, die von einem Ereignis oder einer Situation betroffen oder beeinträchtigt wurde. Der Datentyp dieses Merkmals ist ein komplexer Typ, der im Typ ComponentIdentification beschrieben wird. Dieser Typ stellt die zur eindeutigen Identifikation einer Komponente notwendigen Daten zur Verfügung.
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden. Der Erzeuger des Ereignisses MUSS die sourceComponentId zur Verfügung stellen. Wenn es sich bei der Berichtskomponente und der betroffenen Komponente um dieselbe Komponente handelt, MUSS die reporterComponentId ausgelassen werden.
situationType gibt den Typ der Situation an, wegen der das Ereignis berichtet wurde. Dies ist ein erweiterbarer Zeichenfolgewert.
Die vorgeschlagenen reservierten Schlüsselwörter sind:
Es handelt sich um ein OPTIONALES Merkmal, das nicht verändert werden kann. Die maximale Zeichenfolgenlänge für situationType DARF NICHT größer als 512 Bytes sein.
contextDataElements ist ein Array, bestehend aus Kontextelementen des Typs ContextDataElement, auf die dieses Ereignis verweist. Dieses Merkmal enthält Daten, die zur Korrelation von Nachrichten und Ereignissen verwendet werden, welche auf dem Bearbeitungspfad im Rahmen einer Arbeitseinheit zur Problemdiagnose generiert wurden.
Es handelt sich um ein OPTIONALES Merkmal und es kann verändert werden. Es kann von einer Komponente zur Verfügung gestellt werden, die ein Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden.
Das Merkmal msg enthält den Text, der sich dem Ereignis anschließt. Es handelt sich in der Regel um die aufgelöste Nachrichtenzeichenfolge in visuell lesbarem Format, die in einem bestimmten Locale wiedergegeben wird.
Das Locale, also die Ländereinstellung der Nachricht, wird mit dem Merkmal msgLocale des Typs MsgDataElement angegeben. Es gibt keine Standardeinstellung für das Locale von msg.
Dieses Merkmal ist OPTIONAL, es wird aber EMPFOHLEN, einen Wert festzulegen wenn die Merkmale msgCatalogId und msgCatalog von MsgDataElement keinen Wert festlegen.
msgDataElement ist ein Merkmal, das auf ein MsgDataElement verweist. Dieses Merkmal enthält die Daten, die zum Angeben aller mit der Nachricht zu diesem Ereignis verwandten Informationen verwendet werden.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden. Es wird von der Komponente zur Verfügung gestellt, die ein Ereignis ausgibt.
Das Merkmal extensionName enthält den Namen einer "Ereignisklasse", die dieses Ereignis repräsentiert (z. B. Trace, CommonBaseEvent). Der Name der Ereignisklasse deutet auf das Vorhandensein jeglicher zusätzlicher Merkmale in dem jeweiligen Ereignis hin. Wenn Sie ExtendedDataElement verwenden möchten, das im nächsten Abschnitt beschrieben wird, sollten Sie einen Wert für extensionName angeben.
Es handelt sich hierbei um ein OPTIONALES Merkmal, das nicht mutabel ist und von der Komponente zur Verfügung gestellt werden MUSS, die das Ereignis berichtet. Wenn der angegebene Wert null ist, wird für den Wert "CommonBaseEvent" angenommen.
extendedDataElements und extendedProperties
Das Merkmal extendedDataElements ist eine Folge von Namenselementen des Typs
ExtendedDataElement. Es wird zu Zwecken der Ausbaufähigkeit verwendet,
indem es eine Position für die Attribute zur Verfügung stellt, die im Common Base Event-Datenmodell nicht berücksichtigt werden.
Es wird davon ausgegangen, dass es sich bei den hier platzierten Informationen um produktspezifische Daten handelt.
Sie können dieses Merkmal angeben und dann die benannten Elemente filtern, durchsuchen und über Korrelationsregeln referenzieren.
Es handelt sich um ein OPTIONALES Merkmal und es ist mutabel. Das bedeutet, dass es geändert werden kann, nachdem es festgelegt wurde. Der Wert für dieses Merkmal kann von einer Komponente zur Verfügung gestellt werden, die ein Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden.
Das Merkmal associatedEvents ermöglicht Ihnen die uneingeschränkte Gruppierung von Ereignissen oder Elter-Kind-Beziehungen. Dieses Merkmal ist ein komplexer Typ, der sich aus den globalInstanceIds der zugeordneten Ereignisse und einem Typfeld zusammensetzt, in dem der Typ der durch den Namen der Beziehung dargestellten Beziehung beschrieben wird.
Es handelt sich um ein OPTIONALES Merkmal und es ist mutabel. Das bedeutet, dass es geändert werden kann, nachdem es festgelegt wurde. Der Wert für dieses Merkmal kann von einer Komponente zur Verfügung gestellt werden, die ein Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden.
repeatCount ist die Häufigkeit, mit der ein Ereignis in einem bestimmten Zeitintervall aufgetreten ist. Das Zeitintervall ergibt sich aus dem unten beschriebenen Merkmal elapsedTime. Die Definition, wann ein Ereignis als Wiederholung eines zuvor ausgegebenen Ereignisses betrachtet wird, ist anwendungsspezifisch und wird daher nicht in dieser Spezifikation definiert.
Das Merkmal ist OPTIONAL und es kann verändert werden. repeatCount kann von der Komponente festgelegt werden, die das Ereignis ausgibt, oder vom Konsumenten des Ereignisses zugewiesen werden. Es gibt keine Standardeinstellung. Der Wert 0 deutet darauf hin, dass sich das Ereignis nicht wiederholt hat.
elapsedTime ist das Zeitintervall oder die abgelaufene Zeit für die Häufigkeit, mit der ein bestimmtes Ereignis aufgetreten ist. Die Häufigkeit wird mit dem Wert von repeatCount angegeben. Dieser Wert gibt die Zeitdauer an, in der sich wiederholende Ereignisse beobachtet wurden.
Dieser Wert MUSS in Mikrosekunden angegeben werden.
Das Merkmal ist OPTIONAL und es kann verändert werden. Wenn jedoch ein repeatCount angegeben wird, muss eine abgelaufene Zeit vorhanden sein. elapsedTime kann von derselben Komponente festgelegt werden, die auch repeatCount festlegt. Es gibt für elapsedTime keine Standardeinstellung.
Die sequenceNumber ist eine von der Quelle definierte Folgenummer, mit der mehrere Nachrichten in einer logischen Reihenfolge gesendet und verarbeitet werden können, wobei sich diese Reihenfolge von der Reihenfolge unterscheidet, in der die Nachrichten am Standort des Konsumenten eingegangen sind (beispielsweise ein Ereignisserver oder Management-Tools). Diese Folgenummer hilft den Konsumenten beim Sortieren eingehender Nachrichten. Dies geschieht unter Berücksichtigung der Zeitmarke und des jeweiligen Ereignisproviders.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde. Es gibt keine Standardeinstellung.
Beschreibung zu ComponentIdentification
Bei Problemberichten gibt es zwei allgemeine Komponentenkategorien, die für die Problemdiagnose eine Rolle spielen: die Komponente, die die Situation beobachtet und berichtet (der Berichterstatter) und die Komponente, die tatsächlich die Situation erfährt (der Betroffene). Zur Komponentenidentifikation steht eine Attributsammlung zur Verfügung, die zur eindeutigen Identifikation einer Komponente erforderlich sind. Dabei werden die gleichen Daten zur Identifizierung der Komponente verwendet, die ein Ereignis oder eine Situation berichtet, die auch bei der Identifizierung der von der Situation betroffenen Komponente Anwendung finden. In einigen Fällen handelt es sich um ein und dieselbe Komponente.
Beispielsweise werden in einer typischen IT-Umgebung die Aktivitäten der in der Umgebung aktiven Anwendungen häufig durch Ereignisse überwacht, die von den Anwendungen durch Management-Agenten oder Adapter empfangen und erfasst werden.
Beispiel 1: In einer WebSphere-Anwendung namens myWebApp kommt es zu einer Zeitlimitüberschreitung bei einer Tabellenabfrage, die auf ein Problem auf dem DB2-Server auf einem fernen System zurückzuführen ist. Die Webanwendung gibt dann ein Ereignis zu dieser Fehlersituation aus. In diesem Fall ist myWebApp die "betroffene" Komponente, oder "Quell"komponente.
Beispiel 2: Anwendung X läuft auf einem Windows-Server. Es kommt zu einem Fehler in der Anwendung, und die Anwendung schreibt einen Eintrag in das Windows-Fehlerprotokoll. Eine weitere Anwendung (ein Adapter) liest dann die Nachrichten aus dem Fehlerprotokoll, generiert ein Common Base Event und übergibt dieses. In diesem Fall ist der "Betroffene", oder die "Quelle" des Ereignisses die Anwendung X, und die berichtende Komponente ist der Adapter, der das Ereignis generiert und übergeben hat.
Eine genaue Beschreibung des Typs ComponentIdentification folgt.
location gibt die physische Adresse an, die der Adresse einer Komponente entspricht. Beispielsweise kann es sich dabei um einen Hostnamen, eine IP-Adresse oder ein VTAM LU handeln. Das Format des Adresswerts wird in dem Merkmal locationType festgelegt. Der bevorzugte Wert ist der vollständig qualifizierte Hostname.
Dieses Merkmal ist ERFORDERLICH und nicht mutabel. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Zeichenfolgenlänge für location DARF NICHT größer als 256 Zeichen sein.
Dieses Merkmal legt das Format und die Bedeutung des Werts im Merkmal location fest. Dieses Merkmal hat die folgenden bekannten reservierten Schlüsselwörter:
Der Standardwert ist "Unknown" (Unbekannt). Dieses Merkmal ist ERFORDERLICH und ist nicht mutabel. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Zeichenfolgenlänge für locationType DARF NICHT größer als 32 Zeichen sein.
Das Merkmal application gibt den Anwendungsnamen an (z. B. myApp). Die Anwendungsversionsnummer kann durch ein #-Zeichen getrennt an das Ende der Komponente angehängt werden.
Es handelt sich um ein OPTIONALES Merkmal, das nicht mutabel ist. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Zeichenfolgenlänge des Anwendungsnamens DARF 256 Zeichen NICHT überschreiten.
Das Merkmal executionEnvironment identifiziert die unmittelbare Umgebung, in der eine Anwendung ausgeführt wird. Beispielsweise der Name eines WebSphere Application Servers: Zelle:Knoten:Server.
Die Versionsnummer der Ausführungsumgebung kann durch ein #-Zeichen getrennt an das Ende der Komponente angehängt werden. Die maximale Zeichenfolgenlänge für executionEnvironment DARF NICHT größer als 256 Zeichen sein.
Es handelt sich um ein OPTIONALES Merkmal, das nicht mutabel ist. Das bedeutet, dieser Wert besteht während der gesamten Lebensdauer eines Ereignisses fort, wenn er einmal festgelegt wird.
Mit component wird die logische Identität einer Komponente angegeben. Dieses Merkmal MUSS den Namen einer bestimmten Anwendung, eines Produkts oder Subsystems enthalten (z. B. IBM DB2 V7.1). Dieser Wert SOLLTE im Geltungsbereich der durch den Berichterstatter angegebenen Adresse eindeutig sein.
Dieses Merkmal ist ERFORDERLICH und ist nicht mutabel. Das bedeutet, dieser Wert besteht während der gesamten Lebensdauer eines Ereignisses fort, wenn er einmal festgelegt wird. Die maximale Zeichenfolgenlänge des Komponentennamens DARF 256 Zeichen NICHT überschreiten.
Mit subComponent kann eine weitere Beschreibung des logischen Komponentenmerkmals eines Ereignisses vorgenommen werden.
Es SOLLTE die Identität der Subkomponente des Merkmals component enthalten und die am weitesten differenzierte Definition im Ereignis darstellen. In diesem Merkmal kann ein beliebiger Teil einer Anwendungs- oder Betriebssystemressource angegeben werden, beispielsweise der Name eines Moduls, einer Klasse oder Methode.
Dieses Merkmal ist ERFORDERLICH und nicht mutabel. Das bedeutet, dieser Wert besteht während der gesamten Lebensdauer eines Ereignisses fort, wenn er einmal festgelegt wird. Die maximale Zeichenfolgenlänge von subComponent DARF 512 Zeichen NICHT überschreiten.
componentIdType gibt das Format und die Bedeutung der Komponente an, die mit dieser
componentIdentification identifiziert wird. Die reservierte, nicht ausschließliche Liste der
Schlüsselwörter für dieses Merkmal lautet:
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden. Die maximale Zeichenfolgenlänge für componentIdType DARF NICHT größer als 32 Zeichen sein.
instanceId gibt ein Handle oder eine ID für die Instanz der Komponente an, die in dem Merkmal component festgelegt wurde. Also Grid Service Handle(GSH), EJBHandle.
Dieses Merkmal ist OPTIONAL und ist nicht mutabel. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Länge der Zeichenfolge für instanceId DARF 128 Zeichen NICHT überschreiten.
processId ist ein Zeichenfolgentyp, der die Prozess-ID der "aktiven" Komponente oder Subkomponente angibt, die das Ereignis generiert hat.
Es handelt sich um ein OPTIONALES Merkmal und es ist nicht mutabel. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Zeichenfolgenlänge für processId DARF NICHT größer als 64 Zeichen sein.
Das Merkmal threadId ist ein Zeichenfolgentyp, der die Thread-ID der Komponente oder Subkomponente mit der Prozess-ID angibt, die das Ereignis generiert hat. Ein aktiver Prozess kann mehrere Threads erzeugen, um seine Funktionen zu tragen und eingehende Anfragen zu verarbeiten. Daher ändert sich die Thread-ID entsprechend.
Es handelt sich um ein OPTIONALES Merkmal und es ist nicht mutabel. Das bedeutet, dass es nicht mehr geändert werden kann, nachdem es einmal festgelegt wurde. Die maximale Zeichenfolgenlänge für threadId DARF NICHT größer als 64 Zeichen sein.
Beschreibung zu ExtendedDataElement
Ein ExtendedDataElement ermöglicht Ihnen die Angabe von Datensammlungen der Form Name-Typ-Wert zu Zwecken der Ausbaufähigkeit. An dieser Stelle können Sie Attribute einschließen, die im Common Base Event-Datenmodell nicht berücksichtigt werden. Es wird davon ausgegangen, dass es sich bei den hier angegebenen Datensammlungen um produktspezifische Daten handelt.
Sie können die benannten Elemente filtern, durchsuchen und über Korrelationsregeln referenzieren. Das Merkmal "name", also der Name, wird von Ihnen definiert. Die nicht ausschließliche Liste der Schlüsselwörter lautet wiefolgt:
RawData - Dieses Schlüsselwort gibt Daten im "Istzustand" an, die normalerweise in einem proprietären Format des Herstellers dieser Daten vorliegen. Das Format ist beliebig, auch Binärdaten sind zulässig. Es soll ermöglicht werden, Daten wortwörtlich zu empfangen und Tools zu unterstützen, die das Format des Kontexts verstehen.
RootHeader - Mit diesem Schlüsselwort soll das Stammelement des Typs ExtendedDataElement für eine Hierarchie von ExtendedDataElements identifiziert werden, welche von den dataRefs definiert werden.
Es folgt eine genaue Beschreibung des Typs ExtendedDataElement:
Das Merkmal name gibt den Namen für das ExtendedDataElement an. Dieser Name MUSS unter Berücksichtigung aller anderen Merkmale des Ereignisses (z. B. RawData, msgLocale und EventStatus) eindeutig sein.
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden.
Der Datentyp der Werte, die im Merkmal values weiter unten angegeben werden.
Die gültigen Typen sind:
Diese Datentypen sind die einzigen gültigen Datentypen, die der Typ ExtendedDataElement unterstützt. Der Standardwert ist "string".
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden.
Ein Wertearray für dieses erweiterte Datenelement vom Typ, der in dem oben beschriebenen Merkmal type definiert wird.
Dieses Merkmal ist OPTIONAL und kann verändert werden. Es DARF NICHT angegeben werden, wenn das Merkmal "value" oder das Merkmal "hexValue" angegeben wurde.
Das Merkmal hexValues ist ein Bytearray, das die Daten für einen Datentyp oder einen komplexen Typ (complexType) enthält, der nicht in der oben aufgeführten Liste der unterstützten Typen enthalten ist.
Dieses Merkmal ist OPTIONAL und kann nicht verändert werden. Es DARF NICHT angegeben werden, wenn das Merkmal "values" oder das Merkmal "value" angegeben wurde.
Hinweis: Die Merkmale hexValue und values schließen sich gegenseitig aus.
Es kann nur jeweils eins der beiden Merkmale definiert werden.
Das Merkmal children bezieht sich auf andere Elemente vom Typ ExtendedDataElement, um eine strukturierte Liste dieser Elemente angeben zu können. Mit dieser Liste ist es möglich, eine Hierarchie verwandter Elemente vom Typ ExtendedDataElement zu erstellen, die mit einer bestimmten Gruppe von Common Base Events korrespondieren. Daher bietet sich hier ein effizienter und schneller Weg, um auf die Liste verwandter Elemente vom Typ ExtendedDataElement zuzugreifen, ohne alle diese Elemente durchsuchen und untersuchen zu müssen.
Dieses Merkmal ist OPTIONAL und kann verändert werden.
Beschreibung zu ContextDataElement
Der Typ ContextDataElement definiert einen oder mehrere Kontexte, die von diesem Ereignis referenziert werden. Dieser komplexe Typ enthält Daten, die zur Korrelation von Nachrichten und Ereignissen verwendet werden, welche auf dem Bearbeitungspfad im Rahmen einer Arbeitseinheit zur Problemdiagnose generiert wurden.
Die folgende Tabelle enthält eine Zusammenfassung den Datenmerkmale, die einen Kontext im Common Base Event repräsentieren. Der Tabelle folgt eine genaue Beschreibung zu ContextDataElement.
Ein contextDataElement wird wiefolgt beschrieben:
Der Datentyp des Kontexts. Anhand dieses Typs kann der Konsument des Ereignisses das Format des Kontextwerts feststellen. Der Typ ist anwendungsspezifisch (z. B. PD_LogRecordCorrelator).
Dieses Merkmal ist ERFORDERLICH und ist nicht veränderbar.
Dies ist der Name der Anwendung, die dieses Kontextdatenelement erstellt hat (z. B. Korrelationsengine)
Dieses Merkmal ist ERFORDERLICH und ist nicht veränderbar.
Hierbei handelt es sich um den Wert des Kontexts, unter Berücksichtigung der Kontextimplementierung.
Dieses Merkmal ist nicht erforderlich, wenn in contextId ein Wert angegeben wurde. Es ist zudem nicht
veränderbar.
Dieses Merkmal stellt einen Verweis auf das Element da, das ein Produkt enthält- oder einen benutzerspezifischen Kontext.
Dieses Merkmal ist nicht erforderlich, wenn in contextValue ein Wert angegeben wurde. Es ist zudem nicht veränderbar. Es DARF NICHT angegeben werden, wenn das Merkmal contextValue angegeben wurde.
Hinweis: Die Merkmale contextValue und contextId schließen sich gegenseitig aus, es darf nur jeweils eins der beiden Merkmale
definiert werden. Wenn aber für contextValue einen Wert festgelegt wird, wird die contextId ignoriert.
Beschreibung zu AssociatedEvent
Der Typ AssociatedEvent ermöglicht die Gruppierung von Ereignissen. Dadurch können zugehörige Ereignisse und ihre Zuordnungsengine (associationEngine) identifiziert werden.
Es folgt eine genaue Beschreibung des Typs AssociatedEvent:
Hierbei handelt es sich um einen Verweis auf die AssocationEngine, die dieses AssociatedEvent erstellt hat.
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden, wenn es einmal festgelegt wurde.
Ein Array aus globalInstanceIds, welche dem Ereignis zugeordneten Ereignissen entsprechen.
Es handelt sich um ein ERFORDERLICHES Merkmal, das verändert werden kann und von der Zuordnungsengine
zur Verfügung gestellt wird, die von dem Merkmal name festgelegt wird.
Beschreibung zu AssociatedEvent
Während Sie mit dem Element AssociationEngine die zugeordneten Ereignisse erkennen können, ermöglicht Ihnen dieser komplexe Typ zusätzlich eine Beschreibung des Zuordnungstyps . Es wird von seiner eigenständigen Entität im XML-Schema repräsentiert, und die Elemente vom Typ AssociatedEvent beziehen sich darauf.
Es folgt eine genaue Beschreibung des Typs AssociationEngine:
Name der Anwendung, die eine Beziehung erstellen wird (z. B. der Name einer Korrelationsengine).
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden, wenn es einmal festgelegt wurde.
Dieses Merkmal sollte den Typ der Beziehung enthalten die von dieser AssociationEngine erstellt wird.
Einige wohldefinierte Zuordnungen sind:
Die Werte für reservierte Schlüsselwörter beinhalten:
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden, wenn es für ein bestimmtes "name"-Merkmal festgelegt wurde.
Die primäre ID für das Element. Dieses Merkmal MUSS global eindeutig sein. Es wird empfohlen, für diesen Wert die GUID mit der Länge 128 oder 256 Bit zu verwenden (als Hex-Zeichenfolge). Wenn dieser Wert festgelegt wurde, DARF er NICHT mehr geändert werden.
Dieses Merkmal ist ERFORDERLICH und kann nicht verändert werden.
Beschreibung zu MsgDataElement
MsgDataElement repräsentiert die Daten, die zum Angeben aller mit der Nachricht zu diesem Ereignis verwandten Informationen verwendet werden.
Das Merkmal msgId enthält die Nachrichten-ID für das Ereignis. Bei dieser ID handelt sich normalerweise um einen eindeutigen Wert aus alphanumerischen oder numerischen Zeichen. Es kann eine einfache Zeichenfolge aus numerischen Zeichen sein, mit denen eine Nachricht in einem Nachrichtenkatalog identifiziert wird, oder eine mehrteilige Zeichenfolge aus alphanumerischen Zeichen (z. B. DBT1234E). Das Inhaltsformat von msgId wird in dem Merkmal msgIdType angegeben, das im nächsten Abschnitt beschrieben wird.
Es handelt sich hierbei um ein OPTIONALES Merkmal, das nicht verändert werden kann und von der Komponente zur Verfügung gestellt werden sollte, die das Ereignis ausgibt. Die maximale Zeichenfolgenlänge für das Merkmal msgId DARF 256 Zeichen NICHT überschreiten.
Das Merkmal msgIdType gibt die Bedeutung und das Format der msgId an. Sollte die ID konform zu einem Standard sein oder einen Standard bzw. eine bekannte Konvention darstellen, wird dieser Standard mit diesem Merkmal angegeben. Beispielsweise stellt IBM3.4.1 eine dreiteilige Zeichenfolgen-ID mit acht Zeichen dar, bei der die drei alphabetischen Zeichen für eine Komponente stehen, gefolgt von vier numerischen Zeichen und einem Suffix von einem alphabetischen Zeichen (z. B. DBT2359I). Weitere reservierte Schlüsselwörter sind IBM3.4, IBM4.4, IBM3.1.4, IBM3.4.1, IBM4.4.1 und IBM3.1.4.1.
Die aktuelle, nicht ausschließliche Liste der reservierten Schlüsselwörter enthält:
Es handelt sich hierbei um ein OPTIONALES Merkmal, das nicht verändert werden kann und von der Komponente zur Verfügung gestellt werden sollte, die das Ereignis ausgibt. Es muss angegeben werden, wenn das Merkmal msgId angegeben wurde. Die maximale Zeichenfolgenlänge für das Merkmal msgId DARF 32 Zeichen NICHT überschreiten.
Das Merkmal msgLocale gibt das Locale, also die Ländereinstellung an, in der die Nachricht (msg) wiedergegeben wird. Bei ihrem Wert handelt es sich um einen Locale-Code, der mit den Spezifikationen in IETF RFC 1766 konform geht. Beispielsweise ist en-US der Wert für amerikanisches Englisch.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde. Wenn kein msgLocale angegeben wird, obliegt es dem Konsumenten des Ereignisses, über das Locale zu entscheiden.
Die maximale Zeichenfolgenlänge pro msgLocale DARF 5 Zeichen NICHT überschreiten.
Das Merkmal msgCatalogTokens besteht aus einem Array aus Zeichenfolgenwerten, die Substitutionsdaten enthalten, die für das Auflösen von Nachrichten zur Landessprachenunterstützung in vollständig formatierten Text verwendet werden. Die Reihenfolge der Werte wird durch die implizite Reihenfolge der Array-Elemente festgelegt. Das Locale sollte mit dem im msgLocale definierten Locale des Nachrichtentextes übereinstimmen.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde. Wenn keine Substitutionswerte vorhanden sind, braucht dieses Merkmal nicht angegeben zu werden. Die maximale Zeichenfolgenlänge für das Merkmal msgCatalogTokens DARF 256 Zeichen NICHT überschreiten.
Das Merkmal msgCatalogId stellt den Index oder die ID der Nachricht dar, der zum Auflösen eines Nachrichtentextes in einem Nachrichtenkatalog verwendet wird.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde.
Beim Merkmal msgCatalog handelt es sich um den qualifizierten Namen des Nachrichtenkatalogs, der die in msgCatalogId angegebene, übersetzte Nachricht enthält.
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt wurde. Die maximale Länge der Zeichenfolge für msgCatalog DARF 128 Zeichen NICHT überschreiten.
Das Merkmal msgCatalogType gibt die Bedeutung und das Format des Elements msgCatalog an. Die aktuelle, nicht ausschließliche Liste der reservierten Schlüsselwörter enthält:
Es handelt sich um ein OPTIONALES Merkmal und es kann nicht verändert werden, wenn es einmal festgelegt
wurde. Es MUSS angegeben werden, wenn das Merkmal msgCatalog definiert wurde. Die maximale Zeichenfolgenlänge für das Merkmal
msgCatalogType DARF 32 Zeichen NICHT überschreiten.
Verwandte Konzepte
Common Base Event-Modell
Verwandte Verweise
Spezifikation des Common Base Event-XML-Schemas
(C) Copyright IBM Corporation 2000, 2003. Alle Rechte vorbehalten.