共通ベース・イベント・モデルは、各種エンタープライズ・アプリケーション間の イベントの新しい規格です。この規格は、これらのイベントを構成するデータ・エレメントの 整合性を、エレメント自体とその形式の両方において提案します。
キーワードの "MUST"、"MUST NOT"、 "REQUIRED"、"SHALL"、"SHALL NOT"、 "SHOULD"、"SHOULD NOT"、"RECOMMENDED"、 "MAY"、および "OPTIONAL" は、 RFC-2119 の記述のように解釈されます (www.ietf.org/rfc/rfc2119.txt を参照)。
フォーマット済みデータは、常に人間が読める形式です。すべてのフォーマット済み データとストリング値は、UTF-8 ストリングとしてエンコードする必要があります。
- 共通ベース・イベントは、次の XML スキーマ・データ型のサブセット とこれらの型の配列の変動のみをサポートします。これらのデータ型の記述は、 XML スキーマ仕様にあります。 データ型は、 XML スキーマ署名のデータ型です。 関連参照を確認してください。
- byte
- short
- int
- long
- float
- double
- string
- dateTime
- duration
- hexBinary
- boolean
最大ストリング長は、1024 文字を超えることはできません。これよりも 長いストリングが必要な場合は、hexBinary 型を選択することができます。
既知のコンシューマーと、イベントのプロセスおよびストレージに対する
制約に関連した経験データを基に、フィールド長は、できるだけ広い受け入れ範囲と
精度を確保するために指定されています。 しかし、場合によっては、
送信側がこれらの長さ制限を超えてしまう可能性があります。
この場合、イベントを現状のまま受け入れるか、仕様に準拠するようメッセージを付けるか、
または無効として破棄するために、該当するアクションを取ることは、
イベントのコンシューマーの責任です。 しかし一般に、
データ (このイベント仕様に準拠していないデータでも) を保存することは、
イベントを完全に失うよりは望ましいといえます。
したがって、できるだけ多くのイベント・データを保存するよう努力することを推奨します。
この文書に指定されているすべての名前とストリングでは、大文字小文字の区別があります。
状態 3 タプルに対して収集されるデータを識別する、 以下のプロパティーが共通ベース・イベントを構成します。
localInstanceId はタイプ・ストリングであり、イベントのインスタンスをローカルに 識別するために使用されます。この値がグローバルに固有であることを 暗黙に保証するものはありません。ただし、一度設定されると、この値はイベントの存続期間中、 固定されます。localInstanceId の値の内容は、タイム・スタンプ、ロケーション、 オフセット、メッセージ ID など、複数パーツの値である場合があります。 または、ID の固有性を確実にするために、内容を提供するために 他のアプリケーションで定義済みのテクニックを使用する場合があります。 たとえば、ローカル・ホスト IP アドレスを提供するストリング、 access.log ファイルの絶対パスを提供するストリング、 ローカルの完全修飾ホスト名を提供するストリング、タイム・スタンプを提供するストリング、 および sequenceNumber を表すストリングの連結に ID を設定することがあります。 この結果ストリングは、次のようになります:
9.27.11.27 mycomputer.toronto.ibm.com 20021009012534.002000-240_0
このプロパティーはキーではありません。これは、変更不可のオプショナル・プロパティーです。 つまり一度設定されると、変更できません。これは、イベントを発行する コンポーネントによって提供されたり、またはイベントのコンシューマーによって 割り当てられる可能性があります。localInstanceId の最大ストリング長は、 128 文字を超えることはできません。
globalInstanceId は、イベントの基本 ID を表す、複素数データ型です。 このプロパティーは、イベントをグローバルで一意的に識別し、 イベントの基本キーとして使用される可能性があります。この値は、 Globally Unique Identifier (GUID) であり、長さは 128 ビット以上、 256 ビット以下でなければなりません。この値が固有なことを確認するのは、 GUID 生成アルゴリズムの責任となります。
これはオプショナル・プロパティーですが、指定されると、 変更することはできません。つまり一度設定されると、 イベントの存続中、変更できません。globalInstanceId は、イベントを発行する コンポーネントまたはイベントのコンシューマーによって提供される可能性があります。
globalInstanceId は、イベント間の関連を確立するために必要です。 globalInstanceId が指定されていないと、AssociatedEvent の記述のように、 関連を提供できません。
イベントの作成日時は、XML スキーマの dateTime データ型の定義通りに 指定される必要があります。creationTime の値は、生成するプラットフォームで 許可されている通り正確に、細分性を提供する必要があります。
これは必須プロパティーで、変更できず、イベントを報告する コンポーネントによって提供される必要があります。これが設定されている場合、 イベントの存続期間中、変更できません。
severity は、イベントを報告するアプリケーションに関して、 イベントが記述する状況の重大度レベルを示します。プロパティーに含まれる 値の意味は、共通値または修飾子の列挙型によって記述され、 イベントの重大度レベルを示す場合があります。たとえば、通知、警告、または 意図した重大度レベルにマップされる幾つかの整数は、すべて有効な値です。 この文書では、特定の実装を暗黙指定していませんが、 このフィールドのユーザーが実装の要求に従って、さらに値を 追加する可能性があることを理解した上で、代わりに以下の値を提案しています。 このフィールドは単に、検出された種類の状態の重大さを定義するのを助け、また 管理者が社内で現在発生している、より重大な問題に焦点を当てられるように支援するものです。
以下の事前定義重大度レベルは、重大度の増す順にリストされています。
値は、0 から 70 です。予約済みの値は、不明 の 0 から始まり、 10 ずつ増分して、致命的の 60 までです。その他の重大度を 追加できますが、70 を超えることはできません。値が指定されていない場合は、 このイベントは重大度がないものとして解釈されます。これは、"NONE" と同等です。
これはオプショナル・プロパティーで、一度設定されると変更できません。severity の デフォルト値はありません。
priority は、イベントの重要度とレコードを処理するための 相対順序を定義します。以下の優先順位が事前定義されています。
値は、0 から 100 です。「低」の予約済み値は 10、「中」の場合は 50、 「高」は 70 です。その他の優先順位を追加できますが、100 を超えることはできません。
値が指定されていない場合は、 このイベントは優先順位がないものとして解釈されます。これは、"NONE" と同等です。
priority プロパティーは重大度とは分離されており、異なっています。 priority はよりカスタマー・ドリブンのプロパティーになることを意図されていますが、 severity は影響を受けるコンポーネントによって認められる状態を指示するものです。 たとえば、「高」の優先順位と重大度「マイナー」のイベントは、 「低」の優先順位と重大度「重大」のイベントよりも先に処理されます。
これはオプショナル・プロパティーで、変更可能です。priority にはデフォルト値はありません。
reporterComponentId は、影響を受けたコンポーネントの代わりにイベント または状態を報告したコンポーネントの ID です。このプロパティーのデータ型は、 一意的にコンポーネントを識別するために必要なデータを提供する、 ComponentIdentification 型によって記述される複合タイプです。
報告しているコンポーネントがソース・コンポーネントと異なる場合、 これは必須プロパティーです。それ以外の場合は、このフィールドは 省略する必要があります。このプロパティーは変更不可です。 つまり一度設定すると、変更できません。
sourceComponentId は、イベントまたは状態による影響を受けた コンポーネントの識別番号です。このプロパティーのデータ型は、 一意的にコンポーネントを識別するために必要なデータを提供する、 ComponentIdentification 型によって記述される複合タイプです。
このプロパティーは必須であり、変更できません。イベントの製作者は、 sourceComponentId を提供する必要があります。報告しているコンポーネントと影響を受けた コンポーネントが同じ場合は、reporterComponentId を省略する必要があります。
situationType は、報告されているイベントの原因となった状態のタイプを指定します。 これは、拡張可能なストリング値です。
提案されている予約済みキーワードは、以下の通りです。
これはオプショナル・プロパティーであり、変更できません。 situationType の最大ストリング長は、512 バイトを超えることはできません。
contextDataElements は、このイベントが参照する型 ContextDataElement のコンテキストの配列です。 このプロパティーは、問題診断の作業単位の 実行パスに沿って生成されたメッセージまたはイベントの相関を支援するために使用される データを保持します。
これはオプショナル・プロパティーであり、変更可能です。 これは、 イベントを発行するコンポーネントによって提供されたり、またはイベントのコンシューマー によって割り当てられる可能性があります。
msg プロパティーは、イベントに伴うテキストです。通常これは、特定のロケール 用に翻訳された、人間が読める形式の、解決済みメッセージ・ストリングです。
msg プロパティーのロケールは、 MsgDataElement 型の msgLocale プロパティーによって指定されます。msg ロケールにはデフォルト値はありません。
このプロパティーはオプショナルですが、 MsgDataElement の msgCatalogId および msgCatalog プロパティーが値を指定しない場合、値を持つよう推奨されます。
msgDataElement は、MsgDataElement を参照するプロパティーです。このプロパティーは、このイベントが保持する メッセージと関連付けられた、すべての関連情報を指定するために使用されるデータを保持します。
これはオプショナル・プロパティーであり、変更できません。これは、イベントを発行する コンポーネントによって提供されます。
extensionName プロパティーには、このイベントが表す "イベント・クラス" の 名前が含まれます (たとえば、Trace、CommonBaseEvent)。イベント・クラス名は、 特定のイベント内に存在すると予期される、追加のプロパティーを示すものです。 次のセクションに記述されている ExtendedDataElement を使用するよう選択した場合は、 extensionName の値を指定することをお勧めします。
これはオプショナル・プロパティーで、変更できず、イベントを報告する コンポーネントによって提供される必要があります。指定された値がヌルの場合、 その値は "CommonBaseEvent" であると想定されます。
extendedDataElements と extendedProperties
extendedDataElements プロパティーは、型
ExtendedDataElement
の名前エレメントのシーケンスです。これは、CommonBaseEvent データ・モデルで説明されない
他のすべての属性を指定するロケーションを提供することにより、
拡張性に使用されます。ここに入れられる情報は、製品に特定のデータであると想定されます。
このプロパティーは、ユーザーが提供できるもので、名前付きエレメントは相関ルールによって フィルター操作、検索、および参照できます。
これはオプショナル・プロパティーで、変更可能です。つまり設定後、 変更することができます。このプロパティーの値は、イベントを発行するコンポーネント によって提供されたり、イベントのコンシューマーによって割り当てられる可能性があります。
associatedEvents プロパティーでは、イベントまたは親と子の関係の、 制限なしのグループ化が許可されます。 このプロパティーは、 関連したイベントと、関連の名前によって表される関連のタイプを記述する タイプ・フィールドを識別する、globalInstanceIds で構成される複合タイプです。
これはオプショナル・プロパティーで、変更可能です。つまり設定後、 変更することができます。このプロパティーの値は、イベントを発行するコンポーネント によって提供されたり、イベントのコンシューマーによって割り当てられる可能性があります。
repeatCount は、特定の時間間隔に対する、特定のイベントの発生回数です。 時間間隔は、以下に記述する elapsedTime プロパティーによって示されます。 イベントを以前に発行されたイベントの繰り返しにする定義は、 アプリケーション固有のため、この仕様では定義されません。
このプロパティーはオプショナルであり、変更可能です。repeatCount は、 イベントを発行するコンポーネント、またはイベントのコンシューマーによって 設定される可能性があります。デフォルト値はありません。0 または値なしは、 イベントの繰り返しがないことを示しています。
elapsedTime は、特定イベントの幾つかの発生回数に対する、時間間隔または 経過時間です。発生回数は、repeatCount の値によって指定されます。 この値は、繰り返されるイベントが観察される継続時間を示します。
このプロパティーの値は、マイクロ秒の細分度で表現する必要があります。
このプロパティーはオプショナルであり、変更可能です。ただし、 repeatCount が指定されている場合は、経過時間が必要です。 elapsedTime は、repeatCount を設定するコンポーネントと同じコンポーネントによって 設定されることがあります。elapsedTime のデフォルト値はありません。
sequenceNumber はソースで定義された番号で、これにより複数のメッセージが、 コンシューマーのロケーション (たとえば、イベント・サーバーまたは管理ツール) に 到着した順序とは異なる論理順序で送信および処理されます。シーケンス番号は、 コンシューマーによる到着メッセージのソートを支援します。これは、時間と、イベントの 特定のプロバイダーに関連します。
このプロパティーはオプショナルで、一度設定されると変更できません。デフォルト値はありません。
問題報告では、問題診断で考慮すべき、コンポーネントの 2 つの 一般カテゴリーがあります。これは状態を観察および報告するコンポーネント (reporter) と、 その状態を経験している実際のコンポーネント (affected) です。コンポーネントの識別番号は、 コンポーネントを一意的に識別するために必要な属性の集合を提供します。これと同じデータが、 イベントまたは状態を報告しているコンポーネントと、状態の影響を受けている、 またはその状態を経験しているコンポーネントの両方の識別に使用されます。 これらのコンポーネントは、同じである場合があります。
たとえば、標準的な情報技術環境では、普通、 その環境で実行されているアプリケーションのアクティビティーは、 管理エージェントまたはアダプターの手段により、 アプリケーションから受信または収集されたイベントを使用して モニターされることが少なくありません。
例 1: myWebApp と呼ばれる WebSphere アプリケーションが、リモート・システムに 置かれた DB2 サーバーの問題が原因でテーブル照会をタイムアウトになる ケースを考えてみます。この後、Web アプリケーションは障害を示す イベントを発行します。この場合、myWebApp は "影響を受けた (affected)"、 または "ソース (source)" コンポーネントです。
例 2: Windows サーバーでアプリケーション X が実行中のケースを考えてみます。 アプリケーションがエラーを検出し、Windows エラー・ログに項目を追加します。 そして、エラー・ログからのメッセージを読み取り、共通ベース・イベントを生成して、 実行依頼する、別のアプリケーション (アダプター) があります。 この場合、イベントの "影響を受ける (affected)" または "ソース (source)" コンポーネントはアプリケーション X であり、 報告しているコンポーネントは、イベントを生成して実行依頼したアダプターです。
ComponentIdentification 型の詳細記述は、以下の通りです。
location は、コンポーネントのロケーションに対応する、 物理アドレスを指定します。たとえば、ホスト名、IP アドレス、VTAM LU など。 location の値の形式は、locationType プロパティーによって指定されます。優先値は、 完全修飾ホスト名です。
このプロパティーは必須であり、変更できません。つまり一度設定すると、 変更できません。location の最大ストリング長は 256 文字を超えることはできません。
このプロパティーは、location プロパティーの値の形式と意味を指定します。 このプロパティーには、以下に示す既知の、予約済みキーワードがあります。
デフォルト値は、"Unknown" です。このプロパティーは 必須であり、変更できません。つまり一度設定すると、 変更できません。locationType の最大 ストリング長は、32 文字を超えることはできません。
application プロパティーは、アプリケーションのユーザー名を指定します (たとえば、myApp)。application のバージョン情報が、# 文字で区切られて、 コンポーネントの終わりに付加されることがあります。
これはオプショナル・プロパティーであり、変更できません。つまり一度設定すると、 変更できません。application 名の最大ストリング長は、 256 文字を超えることはできません。
executionEnvironment プロパティーは、アプリケーションが稼動している即時環境を 識別します。たとえば、WebSphere Application Server 名: cell:node:server。
executionEnvironment のバージョン情報が、# 文字で区切られて、 コンポーネントの終わりに付加されることがあります。executionEnvironment の最大 ストリング長は 256 文字を超えることはできません。
これはオプショナル・プロパティーであり、変更できません。つまり一度設定すると、 イベントの存続期間中、変更できません。
component は、コンポーネントの論理 ID を指定します。このプロパティーには、 特定のアプリケーション、製品、サブシステムの名前 (たとえば、IBM DB2 V7.1) が 含まれている必要があります。この値は、レポーター・ロケーションによって 指定された有効範囲内で固有でなければなりません。
このプロパティーは必須であり、変更できません。つまり一度設定すると、 イベントの存続期間中、変更できません。component 名の最大ストリング長は、 256 文字を超えることはできません。
subComponent は、イベントの論理コンポーネント・プロパティーのさらに詳しい 描写を指定します。
これには component プロパティーのサブコンポーネントの ID が含まれており、 イベントに指定された、最も細分化された定義でなければなりません。このプロパティーは、 アプリケーションまたはオペレーティング・システム・リソースのさまざまなパーツの 1 つ である場合があります。たとえば、モジュール名、クラス名、クラスおよびメソッド名など。
このプロパティーは必須であり、変更できません。つまり一度設定すると、 イベントの存続期間中、変更できません。subComponent 名の最大ストリング長は、 512 文字を超えることはできません。
componentIdType は、この componentIdentification によって識別される
コンポーネントの形式と意味を指定します。このプロパティーの、予約済みで、
非専用キーワードのリストは、次の通りです。
このプロパティーは必須であり、変更できません。componentIdType の最大 ストリング長は、32 文字を超えることはできません。
instanceId は、component プロパティーによって指定されるコンポーネントの インスタンスのハンドルまたは ID を指定します。これは、Grid Service Handle(GSH)、EJBHandle です。
このプロパティーはオプショナルであり、変更できません。つまり一度設定すると、 変更できません。instanceId の最大ストリング長は、128 文字を超えることはできません。
processId は、イベントを生成する "実行中の" コンポーネント、 またはサブコンポーネントのプロセス ID を識別するストリング型です。
これはオプショナル・プロパティーで、変更できません。つまり一度設定すると、 変更できません。processId の最大ストリング長は、64 文字を超えることはできません。
threadId プロパティーは、タイプ・ストリングであり、イベントを生成する プロセス ID によって示されるコンポーネントまたはサブコンポーネントのスレッド ID を 識別します。実行プロセスは、その関数と着信要求を実行するために、 1 つ以上のスレッドを作成します。したがって、スレッド ID は、それに応じて変更されます。
これはオプショナル・プロパティーで、変更できません。つまり一度設定すると、 変更できません。threadId の最大ストリング長は、64 文字を超えることはできません。
ExtendedDataElement では、拡張性の目的のために、name-type-value コレクションを 提供することができます。ここに、CommonBaseEvent データ・モデルで説明できない その他の属性を組み込むことができます。ここに指定されるコレクションは、 製品に特定のデータであると想定されます。
名前付きプロパティーは、相関ルールによりフィルター操作、検索、 または参照することができます。"名前" はユーザーによって定義されますが、 予約済みキーワードの非専用リストは以下の通りです。
RawData - このキーワードは、"現状のまま" のデータを示すもので、 通常、形式はそのようなデータの作成者専有のものである場合があります。このデータは、 バイナリーを含め、どのような形式の場合もあります。逐語的なデータの検索を許可し、 コンテキストの形式を理解するツールをサポートするよう意図されています。
RootHeader - このキーワードは、dataRefs によって定義される ExtendedDataElements の階層について、ルート ExtendedDataElement を識別するよう 意図されています。
ExtendedDataElement 型の詳細記述は、以下のとおりです。
name プロパティーは、ExtendedDataElement の名前を指定します。この名前は、 イベント内の他のすべてのプロパティー (たとえば、RawData、msgLocale、および EventStatus) に関して固有でなければなりません。
このプロパティーは必須であり、変更できません。
値のデータ型は、以下の values プロパティーに指定されています。
有効な型は以下の通りです。
上記のデータ型は、ExtendedDataElement 型によってサポートされる唯一有効な型です。 デフォルト値は、"string" です。
このプロパティーは必須であり、変更できません。
type プロパティーによって定義される型のこの拡張データ・エレメントの値の配列は、 上記の通りです。
このプロパティーはオプショナルであり、変更できません。これは、 "value" または "hexValue" プロパティーが指定されている場合は、 指定できません。
hexValues プロパティーは、上記に定義された、サポートされる型のリストにない その他のデータ型または complexType のデータを保持するバイトの配列です。
このプロパティーはオプショナルであり、変更できません。これは、 "values" または "value" プロパティーが指定されている場合は、 指定できません。
注: hexValue および values プロパティーは、
相互に排他的です。この 2 つプロパティーのうち 1 つしか定義できません。
children プロパティーは、他の ExtendedDataElement(s) を参照して、 ExtendedDataElement の構造リストを指定します。 このリストでは、 特定の CommonBaseEvents のグループに対応する、関連した ExtendedDataElement の 階層を作成することができます。 したがって、これはすべての ExtendedDataElement を検討して調査する必要なしに、関連した ExtendedDataElement のリストへの アクセスを取得するための、効率的で素早い方法です。
このプロパティーはオプショナルであり、変更できません。
ContextDataElement の記述
ContextDataElement 型は、このイベントが参照する 1 つ以上のコンテキストを 定義します。この複合タイプは、問題診断目的の作業単位の実行パスに沿って 生成されたメッセージまたはイベントの相関を支援するために使用されるデータ を保持します。
以下のテーブルは、共通ベース・イベントにおけるコンテキストを表す データ・プロパティーの要約を提供します。この ContextDataElement の詳細記述が、 要約テーブルの後にあります。
contextDataElement の詳細記述は、以下の通りです。
これは、コンテキストのデータ型です。この型では、イベントのコンシューマーが コンテキスト値の形式を認識することを許可します。type は、アプリケーション固有です (たとえば、PD_LogRecordCorrelator)。
このプロパティーは 必須であり、変更できません。
これは、このコンテキスト・データ・エレメント (たとえば、相関エンジン) を作成したアプリケーションの名前です。
このプロパティーは 必須であり、変更できません。
これは、コンテキストの実装に関するコンテキストの値です。
contextId が値を指定している場合、このプロパティーは必要なく、
またこのプロパティーは変更できません。
このプロパティーは、製品またはユーザーに固有のコンテキストを含む エレメントへの参照です。
このプロパティーは、contextValue が値を指定している場合、必要ありません。 またこのプロパティーは変更できません。contextValue プロパティーが指定されている場合、 このプロパティーは指定できません。
注: contextValue と contextId は相互に排他的で、この 2 つのプロパティーうち 1 つしか
定義できません。ただし、contextValue が値に設定されている場合、
contextId は無視されます。
AssociatedEvent の記述
AssociatedEvent 型では、イベントのグループ化が許可されます。 これにより、関連したイベントおよびその associationEngine を識別することができます。
AssociatedEvent 型の詳細記述は、以下の通りです。
これは、この AssociatedEvent を作成した AssocationEngine への参照です。
このプロパティーは必須であり、設定後は変更できません。
このイベントと関連付けられているイベントに対応する globalInstanceIds の配列。
これは必須プロパティーで、変更不可であり、name プロパティーによって指定される
関連エンジンにより提供されます。
AssociatedEvent の記述
AssociationEngine エレメントでは、関連イベントの識別を考慮しています。 また、この複合タイプは、関連の型を記述するプロパティーも提供します。 これは、XML スキーマのその独自のスタンドアロン・エンティティーによって表され、 AssociatedEvent エレメントはそれを参照しています。
AssociationEngine 型の詳細記述は、以下の通りです。
関連を作成するアプリケーションの名前 (たとえば、my correlation engine name) 。
このプロパティーは必須であり、設定後は変更できません。
このプロパティーには、この AssociationEngine によって作成される関連の型が含まれます。
正しく定義された関連には、以下のものがあります。
予約済みキーワード値には、以下のものがあります。
このプロパティーは必須であり、特定の "name" プロパティーに対して 設定されている場合、変更できません。
エレメントの基本 ID。このプロパティーは、グローバルに固有でなければなりません。 この推奨値は、128 ビットまたは 256 ビットの Globally Unique Id (16 進ストリングで表記) です。この値を設定した後は変更できません。
これは必須プロパティーであり、変更できません。
MsgDataElement の記述
この MsgDataElement は、このイベントが保持するメッセージと関連した すべての関連情報を指定するために使用されるデータを表します。
msgId プロパティーは、イベントのメッセージ ID を示します。この ID は通常、 英数字または数字の固有値ストリングです。これは、メッセージ・カタログの メッセージを識別する数字のストリングのように単純にしたり、または 英数字の複数パーツ・ストリングにすることができます (たとえば、DBT1234E)。 msgId の内容の形式は、次のセクションで説明する msgIdType プロパティー によって指定されます。
これはオプショナル・プロパティーであり、一度設定されると変更できず、 イベントを発行するコンポーネントによって提供されます。 msgId プロパティーの 最大ストリング長は、256 文字を超えることはできません。
msgIdType プロパティーは、msgId の意味と形式を指定します。 ID がスタンドアロンまたは既知の規則に準拠している場合、またはその規則を表す場合は、 このプロパティーによって命名されます。たとえば、IBM3.4.1 は、 コンポーネントを表す 3 文字の英字、続いて 4 文字の数字、接尾部の 1 文字の英字で 構成される、3 つのパーツの、8 文字のストリング ID のメッセージ ID を暗黙指定しています (たとえば、DBT2359I)。その他の類似する予約済みキーワードは、 IBM3.4、IBM4.4、IBM3.1.4、IBM3.4.1、IBM4.4.1、および IBM3.1.4.1 です。
予約済みキーワードの現行の非専用リストには、以下のものが含まれます。
これはオプショナル・プロパティーであり、一度設定された後は変更できません。 このプロパティーは、イベントを発行するコンポーネントによって提供されます。 これは、msgId プロパティーが指定されている場合、提供される必要があります。 msgIdType プロパティーの最大ストリング長は、32 文字を超えることはできません。
msgLocale プロパティーは、msg が翻訳されているロケールを指定します。 その値は、IETF RFC 1766 仕様に準拠したロケール・コードです。 たとえば、en-US は米国英語の値です。
このプロパティーはオプショナルで、一度設定されると変更できません。 msgLocale が指定されている場合、そのロケールの決定は イベントのコンシューマーの責任です。
msgLocale ごとの最大ストリング長は、5 文字以下でなければなりません。
msgCatalogTokens プロパティーは、NLS ベースのメッセージを解決し、 完全にフォーマットされたテキストにするために使用される置換データを 保持するためのストリング値の配列で構成されます。値の順序は、配列エレメントの 暗黙の順序によって暗黙指定されています。トークンのロケールは、msgLocale によって 定義されたメッセージ・テキストのロケールと同じでなければなりません。
このプロパティーはオプショナルで、一度設定されると変更できません。 置換値がない場合は、このプロパティーを指定する必要はありません。 msgCatalogTokens プロパティーの最大ストリング長は、 256 バイト以下でなければなりません。
msgCatalogId プロパティーは、メッセージ・カタログからのメッセージ・テキストを 解決するために使用されるメッセージの索引または ID です。
このプロパティーはオプショナルで、一度設定されると変更できません。
msgCatalog プロパティーは、msgCatalogId によって指定された翻訳メッセージを 含むメッセージ・カタログの修飾名です。
このプロパティーはオプショナルで、一度設定されると変更できません。 msgCatalog プロパティーの最大ストリング長は、128 文字以下でなければなりません。
msgCatalogType プロパティーは、msgCatalog の意味と形式を指定します。 予約済みキーワードの現行の非専用リストには、以下のものが含まれます。
このプロパティーはオプショナルであり、一度設定されると変更できません。
msgCatalog プロパティーが定義されている場合、提供されている必要があります。
msgCatalogType プロパティーの最大ストリング長は、32 文字を超えることはできません。
関連概念
共通ベース・イベント・モデル
関連参照
共通ベース・イベント XML スキーマ仕様
(C) Copyright IBM Corporation 2000, 2003. All Rights Reserved.