Il modello eventi di base comuni è il nuovo standard per gli eventi che si verificano in diversi tipi di applicazioni enterprise. Questo standard intende fornire uniformità dei dati e dei rispettivi formati per tutti gli eventi.
Le parole chiave "DEVE", "NON DEVE", "OBBLIGATORIO", "DOVREBBE", "NON DOVREBBE", "CONSIGLIATO", "PUÒ" e "FACOLTATIVO" devono essere interpretate come descritto nel documento RFC-2119 (vedere www.ietf.org/rfc/rfc2119.txt).
I dati formattati devono essere sempre leggibili. Tutti i dati formattati e lei valori delle stringhe devono essere in formato UTF-8.
- L'evento di base comune supporta solo la seguente sottoserie di tipi di dati di schema XML e la relativa variazione di matrice. La specifica dello schema XML contiene una descrizione di questi tipi di dati. I tipi di dati sono tipi di dati di schema XML . Vedere il riferimento corrispondente.
- byte
- short
- int
- long
- float
- double
- string
- dateTime
- duration
- hexBinary
- boolean
La lunghezza massima delle stringhe non deve mai superare i 1024 caratteri. Se si desidera utilizzare una stringa più lunga, utilizzare il tipo hexBinary.
Le lunghezze dei vari campi sono state specificate per assicurare la maggior fedeltà agli eventi
originali, e sono state ricavate da dati empirici basati sullo studio di utenti e limitazioni note rispetto
all'elaborazione e all'archiviazione degli eventi. Tuttavia, è possibile che tali
limitazioni non vengano rispettate dal mittente. In questo caso, il ricevente dell'evento dovrà accettare l'evento così com'è,
renderlo conforme alla specifica o rifiutarlo come invalido. In generale,
è preferibile conservare i dati che non rispettano l'evento standard piuttosto che
perdere completamente traccia dell'evento, quindi, in questa situazione, si consiglia di conservare
quanti più dati di evento sia possibile.
Tutti i nomi e le stringhe specificati in questo documento rilevano la differenza tra maiuscolo e minuscolo.
L'evento di base comune è costituito dalle seguenti proprietà che identificano i dati raccolti in una situazione di tupla a 3:
localInstanceId è di tipo stringa e viene utilizzata per identificare localmente le istanze di un evento. Questo valore potrebbe non essere unico. Tuttavia, una volta impostato, rimane costante per tutta la durata dell'evento. Il valore di localInstanceId può essere un valore composto da più parti, ad esempio data/ora, percorso, offset, ID del messaggio, oppure, per fornire contenuti che garantiscano l'unicità dell'ID, può utilizzare tecniche definite dall'applicazione. Ad esempio, è possibile impostare l'identificatore sulla concatenazione di una stringa che fornisce l'IP dell'host locale, di una stringa che fornisce il percorso assoluto del file access.log file, di una stringa che indichi la data e l'ora e di una stringa che rappresenta la sequenceNumber. Il risultato è simile al seguente:
9.27.11.27 mycomputer.toronto.ibm.com 20021009012534.002000-240_0
Questa proprietà non è una chiave. Si tratta di una proprietà FACOLTATIVA invariabile, e una volta impostata non può essere modificata. Può essere indicata dal componente che produce l'evento o assegnata dal ricevente dell'evento. La lunghezza massima della stringa per localInstanceId non deve superare i 128 caratteri.
globalInstanceId è un tipo di dati complesso che rappresenta l'identificatore primario dell'evento. La proprietà identifica unicamente l'evento e può essere usata come chiave primaria dell'evento. Il valore deve essere un GUID (Globally Unique Identifier) di almeno 128 bit di lunghezza ma non superiore a 256 bit. Per assicurare l'unicità di questo valore, ci si basa sull'algoritmo di generazione GUID.
Si tratta di una proprietà FACOLTATIVA, ma se specificata non sarà variabile, quindi una volta impostata non può essere modificata. globalInstanceId può essere indicata dal componente che produce l'evento o dal ricevente dell'evento.
La proprietà globalInstanceId è richiesta per stabilire le associazioni tra gli eventi. Se globalInstanceId non viene specificata, non sarà possibile fornire l'associazione descritta da AssociatedEvent.
La data e l'ora dell'evento creato, devono essere specificate in base al tipo di dati dateTime dello schema XML. Il valore di creationTime deve essere quanto più preciso possibile.
Si tratta di una proprietà OBBLIGATORIA, invariabile e deve essere fornita dal componente che riporta l'evento. Una volta impostata non potrà essere modificata per tutta la durata dell'evento.
La gravità indica il livello dello stato a cui l'evento si riferisce, rispetto all'applicazione che riporta l'evento. I significati dei valori contenuti dalla proprietà possono essere descritti da una numerazione di valori o qualificatori comuni che indicano il livello di gravità dell'evento. Ad esempio, le informazioni, gli avvisi o numeri interi che si associano ai livelli di gravità specificati, sono tutti considerati valori validi. Questo documento non implica alcuna implementazione specifica, ma suggerisce una serie di valori ai quali gli utenti possono aggiungere i valori desiderati. Questo campo aiuta semplicemente a definire la gravità delle eventuali situazioni riscontrate e indica agli amministratori i problemi più gravi a cui dare priorità.
I livelli di severità riportati di seguito, sono elencati in ordine crescente di severità:
I valori variano da 0 a 70. I valori riservati cominciano da 0 per Sconosciuto e aumentano per incrementi di 10, fino a 60 per Grave. È possibile aggiungere altri livelli di gravità, ma non bisognerà superare il valore 70. Se non viene specificato alcun valore, l'evento verrà considerato di nessuna gravità, che corrisponde al livello "NONE".
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata. I livelli di gravità non hanno valore predefinito.
La priorità definisce l'importanza dell'evento e l'ordine relativo in cui elaborare i record. Le priorità riportate di seguito sono predefinite:
I valori variano da 0 a 100. Il valore riservato per la priorità Bassa è 10, per Media è 50, e per Alta 70. È possibile aggiungere altri livelli di priorità ma non bisognerà superare il valore 100.
Se non viene specificato alcun valore, l'evento verrà considerato di nessuna priorità, che corrisponde al livello "NONE".
La proprietà di priorità è diversa e a parte rispetto alla gravità, in quanto la priorità è definita dall'utente mentre la gravità indica lo stato della situazione di un componente colpito. Ad esempio un evento con priorità Alta e livello di gravità Minore, dovrebbe essere processato dopo un evento con priorità Bassa e livello di severità Critico.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. I livelli di priorità non hanno valore predefinito.
La proprietà reporterComponentId costituisce l'identificazione del componente che ha riportato l'evento o la situazione per conto del componente colpito. Il tipo di dati di questa proprietà è di tipo complesso, come descritto dal tipo ComponentIdentification che fornisce i dati richiesti unicamente per identificare i componenti.
Si tratta di una proprietà OBBLIGATORIA se il componente che riporta l'evento è diverso dal componente di origine. In caso contrario, questo campo deve essere omesso. La proprietà non è variabile e una volta impostata non può essere modificata.
La proprietà sourceComponentId identifica il componente colpito dall'evento o dalla situazione. Il tipo di dati di questa proprietà è di tipo complesso, come descritto dal tipo ComponentIdentification che fornisce i dati richiesti unicamente per identificare i componenti.
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. Il fornitore dell'evento deve specificare la proprietà sourceComponentId. Se il componente che riporta l'evento e il componente colpito sono lo stesso, la proprietà reporterComponentId deve essere omessa.
La proprietà situationType indica il tipo di situazione che ha causato l'evento da riportare. Si tratta di una stringa estendibile.
Le parole chiave riservate proposte sono:
Si tratta di una proprietà FACOLTATIVA, invariabile. La lunghezza massima della stringa di situationType non deve superare i 512 byte.
contextDataElements è una matrice di contesti di tipo ContextDataElement a cui l'evento si riferisce. La proprietà contiene dati che vengono utilizzati insieme ai messaggi di correlazione e agli eventi generati lungo il percorso di esecuzione di un'unità di lavoro, per la diagnostica dei problemi.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. Può essere indicata dal componente che produce l'evento o assegnata dal ricevente dell'evento.
La proprietà msg è costituita dal testo che accompagna l'evento. Si tratta della stringa di messaggio leggibile dall'utente nella lingua indicata dalle impostazioni internazionali specificate.
Le impostazioni internazionali della proprietà msg sono specificate dalla proprietà msgLocale del tipo MsgDataElement. La locale di msg non ha valore predefinito.
Questa proprietà è FACOLTATIVA ma è preferibile impostarla se le proprietà msgCatalogId e msgCatalog dell'elemento MsgDataElement non indicano alcun valore.
msgDataElement è una proprietà che fa riferimento a MsgDataElement. Questa proprietà contiene i dati che vengono utilizzati per specificare tutte le informazioni correlate associate al messaggio dell'evento.
Si tratta di una proprietà FACOLTATIVA e non può essere modificata. Viene indicata dal componente che produce l'evento.
La proprietà extensionName contiene il nome della "classe evento" rappresentata dall'evento (ad esempio, Trace, CommonBaseEvent). Il nome della classe indica se l'evento specifico verrà accompagnato da altre proprietà aggiuntive. Se si sceglie di utilizzare la proprietà ExtendedDataElement, descritta nel paragrafo successivo, si consiglia di specificare un valore per extensionName.
Si tratta di una proprietà FACOLTATIVA, invariabile e deve essere fornita dal componente che riporta l'evento. Se il valore specificato è nullo, verrà utilizzato il valore "CommonBaseEvent".
extendedDataElements e extendedProperties
La proprietà extendedDataElements è una sequenza di nomi di tipo
ExtendedDataElement. Viene anche utilizzata per
indicare un percorso per eventuali altri attributi non previsti dal modello dati
CommonBaseEvent. Le informazioni specificate con questa proprietà saranno dati specifici del prodotto.
La proprietà può essere specificata dall'utente e gli elementi potranno essere filtrati, indicati come riferimento dalle regole di correlazione e sarà possibile effettuare ricerche di elementi specifici.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. Ovvero, dopo averla impostata, potrà essere modificata. Il valore della proprietà può essere indicato dal componente che produce l'evento o assegnato dal ricevente dell'evento.
La proprietà associatedEvents consente di raggruppare senza limitazioni, eventi o relazioni principale-secondarie. Questa proprietà è di tipo complesso ed è costituita da globalInstanceIds che identificano gli eventi associati e da un campo che descrive il tipo di associazione rappresentato dal nome stesso dell'associazione.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. Ovvero, dopo averla impostata, potrà essere modificata. Il valore della proprietà può essere indicato dal componente che produce l'evento o assegnato dal ricevente dell'evento.
repeatCount è il numero di ricorrenze di un evento specifico in un determinato intervallo di tempo. L'intervallo di tempo viene indicato dalla proprietà elapsedTime descritta di seguito. La definizione di cosa rende un evento una ripetizione di un evento già verificatosi, è specifica dell'applicazione e non viene definita da questa proprietà.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. repeatCount può essere indicata dal componente che produce l'evento o dal ricevente dell'evento. Non esiste valore predefinito. Il valore 0 o nessun valore, indicherà che non c'è ripetizione dell'evento.
La proprietà elapsedTime indica l'intervallo di tempo o il tempo trascorso per un determinato numero di ricorrenze dell'evento specificato. Il numero di ricorrenze viene specificato dal valore di repeatCount. Questo valore indica la durata di tempo trascorso tra il ripetersi degli eventi.
Il valore di questa proprietà deve essere espresso in microsecondi.
Si tratta di una proprietà FACOLTATIVA e può essere modificata. Tuttavia, se viene specificata la proprietà repeatCount, bisognerà indicare il tempo trascorso. La proprietà elapsedTime può essere impostata dallo stesso elemento che imposta repeatCount. elapsedTime non dispone di valore predefinito.
sequenceNumber è un numero definito dall'origine che consente di inviare ed elaborare più messaggi in un ordine logico diverso dall'ordine in cui vengono arrivano al ricevente (ad esempio, un server di eventi o strumenti di gestione). Il numero di sequenza è utile nell'ordinamento dei messaggi ricevuti. L'ordine viene stabilito in base al tempo e al fornitore dell'evento.
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata. Non esiste valore predefinito.
Descrizione di ComponentIdentification
Nell'individuazione dei problemi, esistono due categorie di componenti da considerare per la diagnosi degli errori: il componente che osserva e riporta la situazione (emittente) e il componente realmente colpito dalla situazione. Il processo di identificazione fornisce una raccolta di attributi che consente di identificare i componenti univocamente. Gli stessi dati vengono utilizzati per identificare sia il componente che riporta un evento o una situazione che il componente colpito. In alcuni casi, i due componenti saranno lo stesso.
Ad esempio, in un ambiente IT tipico, generalmente le attività delle applicazioni in esecuzione vengono controllate mediante eventi provenienti dalle applicazioni e ricevuti attraverso agenti di gestione o adattatori.
Esempio 1: si consideri il caso in cui un'applicazione WebSphere, chiamata myWebApp, vada in timeout durante la query di una tabella, a causa di un problema sul server DB2 ubicato su un sistema remoto. L'applicazione Web produce un evento che riporta l'errore. In questo caso myWebApp è il componente "colpito" o il componente "origine".
Esempio 2: si consideri il caso in cui un'applicazione X è in esecuzione su un server Windows. L'applicazione rileva un errore ed aggiunge una voce al log degli errori di Windows. Un'applicazione diversa (un adattatore) legge i messaggi dal log degli errori, genera un evento di base comune e lo inoltra. In questo caso, il componente "colpito" o "origine" dell'evento è l'applicazione X e il componente che riporta l'evento è l'adattatore che ha generato e inoltrato l'evento.
Di seguito è riportata una descrizione dettagliata del tipo ComponentIdentification.
La proprietà location indica l'indirizzo fisico che corrisponde all'ubicazione di un componente. Ad esempio, un nome host, un indirizzo IP, una LU VTAM. Il formato del valore di location è specificato dalla proprietà locationType. Il valore preferito è un nome host completo.
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa di location non deve superare i 256 byte.
Questa proprietà specifica il formato e il significato del valore della proprietà location. Questa proprietà utilizza le seguenti parole chiave note, riservate:
Il valore predefinito è "Unknown". Si tratta di una proprietà OBBLIGATORIA e invariabile. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa di locationType non deve superare i 32 byte.
La proprietà application indica il nome utente dell'applicazione (ad esempio, myApp). Le informazioni sulla versione dell'applicazione possono essere aggiunte alla fine del componente, separate dal carattere #.
Si tratta di una proprietà FACOLTATIVA, invariabile. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa per il nome dell'applicazione non deve superare i 256 caratteri.
La proprietà executionEnvironment identifica l'ambiente immediato in cui è in esecuzione l'applicazione. Ad esempio, il nome di un server WebSphere Application Server: cell:node:server.
Le informazioni sulla versione dell'ambiente di esecuzione possono essere aggiunte alla fine del componente, separate dal carattere #. La lunghezza massima della stringa di executionEnvironment non deve superare i 256 byte.
Si tratta di una proprietà FACOLTATIVA, invariabile. Ovvero, una volta impostata non potrà essere modificata per tutta la durata dell'evento.
La proprietà component indica l'identità logica di un componente. Questa proprietà deve contenere il nome di una determinata applicazione, prodotto o sottosistema (ad esempio, IBM DB2 V7.1). Questo valore dovrebbe essere univoco nell'ambito specificato dall'ubicazione del componente emittente.
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. Ovvero, una volta impostata non potrà essere modificata per tutta la durata dell'evento. La lunghezza massima della stringa componente non deve superare i 256 caratteri.
La proprietà subComponent fornisce un'ulteriore delineazione del componente logico dell'evento.
Deve contenere l'identità del componente secondario della proprietà component e rappresenta la definizione più dettagliata specificata nell'evento. Questa proprietà può essere una delle diverse parti di un'applicazione o di un sistema operativo, ad esempio un nome di modulo, un nome di classe, una classe e un nome di metodo.
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. Ovvero, una volta impostata non potrà essere modificata per tutta la durata dell'evento. La lunghezza massima della stringa per il componente secondario non deve superare i 512 caratteri.
La proprietà componentIdType indica il formato e il significato del componente identificato
da componentIdentification. Le parole chiave riservate e non esclusive di questa proprietà sono:
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. La lunghezza massima della stringa di componentIdType non deve superare i 32 byte.
instanceId indica un gestore o un identificatore per l'istanza del componente specificato dalla proprietà component. Ad esempio, GSH (Grid Service Handle), EJBHandle.
Si tratta di una proprietà FACOLTATIVA e invariabile. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa per instanceId non deve superare i 128 caratteri.
processId è un tipo di stringa che identifica l'ID del processo del componente o componente secondario in "esecuzione" che ha generato l'evento.
Si tratta di una proprietà FACOLTATIVA, invariabile. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa di processId non deve superare i 64 byte.
La proprietà threadId identifica l'ID thread del componente o del componente secondario indicato dall'ID del processo che genera l'evento. Un processo in esecuzione può utilizzare uno o più thread per svolgere le sue funzioni e rispondere alle richieste in entrata. Di conseguenza, l'ID thread verrà modificato continuamente.
Si tratta di una proprietà FACOLTATIVA, invariabile. Ovvero, dopo averla impostata, non potrà essere modificata. La lunghezza massima della stringa di threadId non deve superare i 64 byte.
Descrizione di ExtendedDataElement
ExtendedDataElement consente di fornire raccolte di nomi-tipi-valore da specificare per ottenere maggiore estendibilità. In questa proprietà è possibile includere tutti gli attributi non previsti dal modello dati CommonBaseEvent. I dati specificati con questa proprietà saranno dati specifici del prodotto.
Le proprietà indicate potranno essere filtrate, indicate come riferimento dalle regole di correlazione o sottoposte a ricerca. Il "nome" viene definito dall'utente, tuttavia, esiste un elenco di parole chiave riservate non esclusive, riportato di seguito:
RawData - questa parola chiave indica dati "as is", generalmente nel formato scelto dal produttore dei dati. Possono essere di qualsiasi tipo, incluso binario. Consente di richiamare i dati in modalità verbatim e supporta strumenti che comprendono il formato dei contesti.
RootHeader - questa parola chiave consente di identificare l'elemento principale ExtendedDataElement di una gerarchia di ExtendedDataElements definiti dai dataRefs.
Di seguito è riportata una descrizione dettagliata di ExtendedDataElement:
La proprietà name indica il nome dell'ExtendedDataElement. Tale nome deve essere univoco rispetto alle altre proprietà dell'evento (ad esempio, RawData, msgLocale e EventStatus).
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata.
Il tipo di dati dei valori specificati dalla proprietà values riportati di seguito.
I tipi validi sono:
Questi tipi di dati sono i soli tipi validi supportati dal tipo ExtendedDataElement. Il valore predefinito è "string".
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata.
Matrice di valori per questo elemento di dati del tipo definito dalla proprietà type descritta in precedenza.
Si tratta di una proprietà OBBLIGATORIA e può essere modificata. Non deve essere specificata se è stata indicata la proprietà "value" o "hexValue".
La proprietà hexValues è costituita da una matrice di byte che contiene i dati di qualsiasi altri tipo o complexType non supportato nell'elenco dei tipi specificati in precedenza.
Si tratta di una proprietà OBBLIGATORIA e non può essere modificata. Non deve essere specificata se è stata indicata la proprietà "values" o "value".
Nota: le proprietà hexValue e values si escludono reciprocamente.
È possibile definire solo una di queste due proprietà.
La proprietà children si riferisce a altri ExtendedDataElement per specificare un elenco strutturato di ExtendedDataElement. Questo elenco consente di creare una gerarchia di ExtendedDataElement correlati che corrispondono a un gruppo specifico di CommonBaseEvents. Si tratta di un metodo rapido ed efficiente per accedere all'elenco di ExtendedDataElement senza dover esaminare tutti gli ExtendedDataElement.
Si tratta di una proprietà OBBLIGATORIA e può essere modificata.
Descrizione di ContextDataElement
Il tipo ContextDataElement definisce uno o più contesti a cui si riferisce l'evento. Questo tipo complesso contiene dati che vengono utilizzati insieme ai messaggi di correlazione e agli eventi generati lungo il percorso di esecuzione di un'unità di lavoro, per la diagnostica dei problemi.
La seguente tabella contiene un riepilogo delle proprietà dei dati che rappresentano un contesto nell'evento di base comune. Successivamente alla tabella di riepilogo, viene riportata una descrizione dettagliata di ContextDataElement.
Descrizione dettagliata di contextDataElement:
Il tipo di dati del contesto. Questo tipo consente all'utente dell'evento di riconoscere il formato del valore del contesto. Il tipo è specifico dell'applicazione (ad esempio, PD_LogRecordCorrelator).
Si tratta di una proprietà OBBLIGATORIA e invariabile.
Il nome dell'applicazione che ha creato l'elemento dati di contesto (ad esempio, il motore di correlazione).
Si tratta di una proprietà OBBLIGATORIA e invariabile.
Il valore del contesto rispetto all'implementazione del contesto.
Questa proprietà non è richiesta se contextId indica un valore e non è variabile.
Questa proprietà rappresenta il riferimento dell'elemento che contiene un contesto specifico del prodotto o dell'utente.
Questa proprietà non è richiesta se contextValue indica un valore e non è variabile. Non deve essere specificata se è stata indicata la proprietà contextValue.
Nota: contextValue e contextId si escludono reciprocamente; è possibile definire solo una delle due
proprietà. Se contextValue è impostato, contextId viene ignorato.
Descrizione di AssociatedEvent
Il tipo AssociatedEvent consente di raggruppare eventi e di identificare gli eventi associati e il rispettivo associationEngine.
Di seguito è riportata una descrizione dettagliata di AssociatedEvent:
Riferimento all'AssocationEngine che ha creato questo AssociatedEvent.
Si tratta di una proprietà OBBLIGATORIA e una volta impostata non potrà essere modificata.
Una matrice di globalInstanceIds che corrisponde agli eventi associati a questo evento.
Si tratta di una proprietà OBBLIGATORIA, variabile e viene fornita dal motore di associazione
specificato dalla proprietà name.
Descrizione di AssociatedEngine
L'elemento AssociationEngine consente di identificare eventi associati e il tipo di associazione. È rappresentato dalla propria entità autonoma nello schema XML e gli elementi AssociatedEvent fanno riferimento ad esso.
Di seguito è riportata una descrizione dettagliata di AssociationEngine:
Nome dell'applicazione che creerà l'associazione (ad esempio, my correlation engine name).
Si tratta di una proprietà OBBLIGATORIA e una volta impostata non potrà essere modificata.
Questa proprietà contiene il tipo di associazione creata dall'AssociationEngine.
di seguito sono riportate alcune associazioni definite:
I valori delle parole chiave riservate includono:
Si tratta di una proprietà OBBLIGATORIA e non potrà essere modificata se impostata per una specifica proprietà "name".
L'identificatore primario di un elemento. Questa proprietà deve essere univoca. Il valore consigliato è un Globally Unique Id di 128 bit o 256 bit (rappresentato come stringa esadecimale). Una volta impostato, questo valore non dovrà essere modificato.
Si tratta di una proprietà OBBLIGATORIA, invariabile.
Descrizione di MsgDataElement
MsgDataElement rappresenta i dati utilizzati per specificare le informazioni correlate associate al messaggio dell'evento.
La proprietà msgId specifica l'identificatore del messaggio dell'evento. Tale identificatore è generalmente una stringa di valore univoco composta da caratteri numerici o alfanumerici. Può essere una stringa semplice che identifica un messaggio di un catalogo, oppure una stringa costituita da più parti di caratteri alfanumerici (ad esempio, DBT1234E). Il formato del contenuto di msgId è specificato dalla proprietà msgIdType descritta al paragrafo successivo.
Si tratta di una proprietà FACOLTATIVA, invariabile una volta impostata, e deve essere fornita dal componente che produce l'evento. La lunghezza massima della stringa per la proprietà msgId non deve superare i 256 caratteri.
La proprietà msgIdType indica il significato e il formato di msgId. Se l'ID è conforme o rappresenta una convenzione nota, il nome gli verrà assegnato da questa proprietà. Ad esempio, IBM3.4.1 implica un ID di messaggio composto da un identificatore di stringa di 3 parti e 8 caratteri, che consiste di 3 caratteri alfabetici che rappresentano un componente, seguiti da 4 caratteri numerici e avente come suffisso un carattere alfabetico (ad esempio,DBT2359I). Altre parole chiave simili riservate sono IBM3.4, IBM4.4, IBM3.1.4, IBM3.4.1, IBM4.4.1 e IBM3.1.4.1.
L'elenco attuale di parole chiave riservate non esclusive, comprende:
Si tratta di una proprietà FACOLTATIVA, invariabile una volta impostata, e deve essere fornita dal componente che produce l'evento. Deve essere indicata se viene specificata la proprietà msgId. La lunghezza massima della stringa per la proprietà msgIdType non deve superare i 32 caratteri.
La proprietà msgLocale indica le impostazioni internazionali che verranno applicate al messaggio. Il valore sarà un codice di locale conforme alle specifiche IETF RFC 1766. Ad esempio, en-US è il valore per Stati Uniti Inglese.
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata. Se msgLocale viene specificato, sarà l'utente dell'evento a specificare la locale.
La lunghezza massima della stringa per msgLocale non deve superare i 5 caratteri.
La proprietà msgCatalogTokens è costituita da una matrice di valori di stringa che contiene i dati di sostituzione utilizzati per risolvere i messaggi in lingua nazionale i testo formattato. L'ordine dei valori si basa sull'ordine degli elementi della matrice. La locale dei token deve corrispondere alla locale del testo del messaggio definita da msgLocale.
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata. Se non esiste alcun valore di sostituzione, non è necessario specificare questa proprietà. La lunghezza massima della stringa per la proprietà msgCatalogTokens non deve superare i 256 byte.
La proprietà msgCatalogId rappresenta l'indice o l'identificatore di un messaggio utilizzato per risolvere il testo dei messaggi da un catalogo di messaggi.
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata.
La proprietà msgCatalog rappresenta il nome completo del catalogo di messaggi che contiene il messaggio tradotto specificato da msgCatalogId.
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata. La lunghezza massima della stringa per msgCatalog non deve superare i 128 caratteri.
La proprietà msgCatalogType indica il significato e il formato di msgCatalog. L'elenco attuale di parole chiave riservate non esclusive, comprende:
Si tratta di una proprietà FACOLTATIVA e una volta impostata non potrà essere modificata e deve
essere specificata se viene definita la proprietà msgCatalog. La lunghezza massima della stringa per la proprietà
msgCatalogType non deve superare i 32 caratteri.
Argomenti correlati
Modello eventi di base comuni
Riferimenti correlati
Specifiche dello schema XML dell'evento di base comune
(C) Copyright IBM Corporation 2000, 2003. Tutti i diritti riservati.