プロパティーの記述は、コモン・ベース・イベントの仕様で定義されています。
プロパティーの記述は、イベントに含まれる可能性のあるプロパティーについて説明します。
単純型としてコモン・ベース・イベントの仕様で定義されているすべてのプロパティーが対象となります。
プロパティーの記述では msgDataElement のような複合プロパティーは説明できませんが、複合プロパティーの子である単純プロパティーは説明することができます。
イベント定義には、任意の数 (0 も可) のプロパティーの記述を含めることができます。
プロパティーの記述には、以下のフィールドがあります。
- name
- プロパティーの名前。
これは、CommonBaseEvent エレメントの属性か、CommonBaseEvent の複合サブエレメントの属性の名前にする必要があります。
例としては、severity、priority、および globalInstanceId などがあります。
- path
- プロパティーが CommonBaseEvent の属性ではない場合に、プロパティーへのパスを指定する XPath ロケーション・パス。
このパスは、説明されているプロパティーの親プロパティーを示します。
例は以下のとおりです。
- severity などの CommonBaseEvent のプロパティーを記述するには、パスは指定しない。
ヌル・パスはトップレベルのプロパティーを指定します。
- CommonBaseEvent の複合プロパティーである msgDataElement のプロパティーを記述するには、パス msgDataElement を指定する。
- msgDataElement の複合プロパティーである msgHelp のプロパティーを記述するには、パス msgDataElement/msgHelp を指定する。
パスで、反復プロパティーの特定のインスタンスを記述することもできます。
例えば、イベント定義で複数の contextDataElements プロパティーを記述する場合、パス contextDataElements[@name='businessContext'] を使用して、businessContext を指定することができます。
- defaultValue
- プロパティーのデフォルト値。デフォルト値は、必要なプロパティーが欠落しているイベントの内容を埋めるのに使用する値です。(したがって、プロパティーの記述を必須とし、デフォルト値を定義するのは重要なことです。)このフィールドはオプションです。
- required
- プロパティーが必須かオプションかを指定するブール値。
このフィールドが true と等しい場合、プロパティーは必須となります。
このフィールドはオプションです。指定しない場合、プロパティーはオプションと想定されます。
- permittedValue
- プロパティーに許可されている値。
イベント定義でプロパティーに対して特定の値しか許可しない場合には、それぞれの値がプロパティーの記述の permittedValue フィールドに表示されます。
プロパティーの記述には、許可されている値の任意の数値が入ります。
このフィールドはオプションです。minValue フィールドまたは maxValue フィールドが指定されている場合は指定しないでください。
- minValue
- maxValue
- プロパティーに対して許可されている最小値および最大値。
イベント定義でプロパティーの値を範囲で許可している場合に、これらのフィールドは、その範囲の下限と上限を定義します。minValue のみを指定すると、許可される範囲に上限はなくなります。
maxValue のみを指定すると許可される範囲に下限はなくなります。
これらのフィールドはオプションです。permittedValue フィールドが指定されている場合は指定しないでください。