內容說明是由 Common Base Event 規格所定義。
內容說明主要在說明事件可以包含的內容。
這可以是 Common Base Event 規格定義成簡式類型的任何內容。內容說明無法說明複式內容(如:msgDataElement),
但其可以說明複式內容子項的簡式內容。事件定義可以包含任何數目(包括零在內)的內容說明。
內容說明含有下列欄位:
- name
- 內容的名稱。這必須是 CommonBaseEvent 元素的屬性名稱,或是 CommonBaseEvent 複式子元素的屬性名稱。例如 severity、priority 和 globalInstanceId。
- path
- 如果內容不是 CommonBaseEvent 的屬性,這是指定內容路徑的 XPath 位置路徑。這個路徑會指出所說明之內容的母項內容。下面就是幾個範例:
- 如果要說明 CommonBaseEvent 的內容(如:severity),請勿指定路徑。空值路徑會指定最上層的內容。
- 如果要說明 msgDataElement 的內容(這是 CommonBaseEvent 的複式內容),
您可以指定 msgDataElement 路徑。
- 如果要說明 msgHelp的內容(其本身是 msgDataElement 的複式內容),請指定 msgDataElement/msgHelp 路徑。
該路徑也可以說明重複內容的特定實例。比方說,如果事件定義說明多個 contextDataElements 內容,您可能會指定一個名稱為 businessContext 的內容,並使用 contextDataElements[@name='businessContext'] 路徑。
- defaultValue
- 內容的預設值。
預設值代表在完成事件的內容時,如果遺漏必要的內容,所應該使用的值。(因此,需要內容說明以及定義預設值。)這個欄位是選用性欄位。
- required
- 這個 Boolean 值會指定內容是必要或選用。
如果這個欄位為 true,就表示內容是必要值。
這個欄位是選用的;如果未指定,則假設內容是選用的。
- permittedValue
- 可以作為內容的值。如果事件定義只接受某些內容值,每一個值都會由內容說明中的 permittedValue 欄位來表示。內容說明可以包含任何數目的容許值。
這個欄位是選用的;如果指定 minValue 或 maxValue 欄位,則不可指定這個欄位。
- minValue
- maxValue
- 可以作為內容的最小值和最大值。如果事件定義接受一個範圍的內容值,這些欄位會定義該範圍的上下限。如果您只指定 minValue,
則允許的範圍沒有上限;同樣地,如果您只指定 maxValue,
則允許的範圍沒有下限。這些欄位是選用的;如果指定 permittedValue 欄位,則不可指定這些欄位。