Le descrizioni proprietà sono definite dalla specifica Common Base Event.
Una descrizione proprietà descrive una proprietà contenuta in un evento.
È possibile che si tratti di una qualsiasi proprietà definita dalla specifica
Common Base Event come tipo semplice. Una descrizione proprietà non può descrivere una
proprietà complessa, come un msgDataElement, ma può descrivere una proprietà semplice che
risulta un child di una proprietà complessa. Non ci sono limiti al numero di descrizioni
di proprietà che possono essere contenute in una definizione di evento (compreso nessuna).
Una descrizione proprietà comprende i campi seguenti:
- name
- Il nome della proprietà. Tale nome deve essere il nome di un attributo dell'elemento
CommonBaseEvent o di un attributo di un elemento secondario complesso di
CommonBaseEvent. Alcuni esempi sono severity, priority e globalInstanceId.
- path
- Un percorso ubicazione XPath che specifica il percorso alla proprietà, se la
proprietà non è un attributo di CommonBaseEvent. Il percorso identifica la
proprietà parent della proprietà descritta. Di seguito vengono presentati alcuni
esempi:
- Per descrivere una proprietà di CommonBaseEvent come severity, non specificare un percorso. Un percorso nullo specifica una proprietà di livello
superiore.
- Per descrivere una proprietà di msgDataElement, che è una proprietà complessa di CommonBaseEvent, specificare il percorso msgDataElement.
- Per descrivere una proprietà di msgHelp, che è essa stessa una proprietà complessa di msgDataElement, specificare il percorso msgDataElement/msgHelp.
Il percorso può anche descrivere un'istanza specifica di una proprietà ripetuta. Ad esempio, se una definizione di evento descrive varie proprietà contextDataElements, è possibile specificarne una denominata businessContext utilizzando il percorso contextDataElements[@name='businessContext'].
- defaultValue
- Il valore predefinito della proprietà. Tale valore rappresenta il valore che deve essere utilizzato
durante il completamento dei contenuti per un evento che non presenta una proprietà
obbligatoria. (Ha pertanto senso che sia richiesta una descrizione della proprietà e definire un valore predefinito). Questo campo è facoltativo.
- required
- Un valore booleano che specifica se la proprietà è obbligatoria o facoltativa.
Se il valore di
questo campo è impostato su true, la proprietà è obbligatoria. Questo campo è facoltativo: se non viene specificata, si presume che la proprietà sia facoltativa.
- permittedValue
- Un valore consentito della proprietà. Se una definizione evento consente solo
determinati valori per una proprietà, ciascun valore è rappresentato da un campo
permittedValue nella descrizione della proprietà. Una descrizione può
includere qualsiasi numero di valori consentiti. Questo campo è facoltativo e non deve essere specifcato se vengono specificati i campi minValue o maxValue.
- minValue
- maxValue
- I valori minimi e massimi consentiti per la proprietà. Se una definizione di evento
consente un intervallo di valori per una proprietà, questi campi definiscono il limite
inferiore e superiore di tale intervallo. Se si specifica solo minValue,
l'intervallo consentito non ha un limite massimo; in modo analogo, se si specifica solo maxValue,
l'intervallo consentito non ha un limite minimo. Questi campi sono facoltativi e non devono essere specificati se vengono specificati i campi permittedValue.