La especificación Common Base Event define las descripciones de propiedades.
Una descripción de propiedad describe una propiedad que un suceso puede
contener. Puede ser cualquier propiedad que esté definida por la
especificación Common Base Event como un tipo sencillo. Una descripción de
propiedad no puede describir una propiedad compleja como por ejemplo
msgDataElement, pero puede describir una propiedad sencilla que sea hija
de una propiedad compleja. Una definición de suceso puede contener un número
cualquiera de descripciones de propiedades (incluido ninguno).
Una descripción de propiedad incluye los siguientes campos:
- name
- Nombre de la propiedad.
Debe ser el nombre de un atributo del elemento CommonBaseEvent o un
atributo de un subelemento complejo de CommonBaseEvent. Algunos
ejemplos son severity, priority y globalInstanceId.
- path
- Ubicación XPath que especifica la vía de acceso a la propiedad,
si la propiedad no es un atributo de CommonBaseEvent. La vía de
acceso identifica la propiedad padre de la propiedad que se describe. A
continuación aparecen algunos ejemplos:
- Para describir una propiedad de CommonBaseEvent, como por
ejemplo severity, no especifique una vía de acceso. Una vía de acceso
nula especifica una propiedad de nivel superior.
- Para describir una propiedad de msgDataElement, que es una
propiedad compleja de CommonBaseEvent, especifique la vía de
acceso msgDataElement.
- Para describir una propiedad de msgHelp, que es una
propiedad compleja de msgDataElement, especifique la vía de
acceso msgDataElement/msgHelp.
La vía de acceso también puede describir una instancia específica
de una propiedad repetida. Por ejemplo, si una definición de suceso
describe varias propiedades contextDataElements, podría especificar una
propiedad llamada businessContext y utilizar la vía de acceso
contextDataElements[@name='contextoEmpresa'].
- defaultValue
- El valor por omisión de la propiedad. El valor por omisión representa
el valor que se utiliza durante la cumplimentación del contenido de un
suceso al que le falte una propiedad necesaria. (Por lo tanto, tiene
sentido que una propiedad sea necesaria y que se defina un valor por
omisión). Este campo es opcional.
- required
- Valor booleano que especifica si la propiedad es necesaria u opcional.
Si este
campo es igual a true, la propiedad es necesaria. Este campo es opcional; si no se especifica, se asume que la propiedad es opcional.
- permittedValue
- Valor permitido para la propiedad. Si una definición de suceso sólo
permite ciertos valores para una propiedad, cada una se representa
mediante un campo permittedValue de la descripción de propiedad. Una
descripción de propiedad puede incluir cualquier número de valores
permitidos. Este valor es opcional y no debe ser especificado si
se especifican los campos minValue o maxValue.
- minValue
- maxValue
- Valores mínimos y máximos permitidos para la propiedad. Si una
definición de suceso permite un rango de valores para una propiedad,
estos campos definen los límites superiores e inferiores de dicho rango. Si sólo especifica minValue,
el rango permitido no tiene límite superior; de forma similar, si sólo especifica maxValue,
el rango permitido no tiene límite inferior. Estos campos son opcionales y no deben especificarse si
se especifican campos permittedValue.