1.4.7 <SupplierSpecificProperty>

A <SupplierSpecificProperty> is a top level element that sits outside an <Event> and which is used to provide further documentation about a supplierSpecific or Private Property Type ().

If a Consumer wishes to then they may present the information contained within the <SupplierSpecificProperty> as additional information on all of the elements that contain a <Property> element that refers to it. Alternatively the Supplier may render the information in <SupplierSpecificProperty> as a standalone entity and then link to it from each of the referring elements.

If a Consumer receives an <IvesMessage> that contains supplierSpecific <Property> elements that do not have corresponding <SupplierSpecificProperty> elements, then the Supplier may utilise the most recently received <SupplierSpecificProperty> element from an earlier message from the same Supplier.

If the <SupplierSpecificProperty> is defined in the <IvesMessage> then this version should be utilised in preference over a previously received version.

Attributes

value

compulsory attribute that defines the value that this <SupplierSpecificProperty> must match in any supplierSpecific <Property> for them to be associated. This attribute must be unique within the scope of the document, ie you cannot have two <SupplierSpecificProperty> definitions with the same value.

Contained Within

<IvesMessage>

, optional and repeatable

May Contain

<Title>

, compulsory. Human readable version of the value that should be used in any situation where the <SupplierSpecificProperty> is being referred to for consumption by human users.

<Description>

, optional and repeatable

<Link>

, optional and repeatable

<Property>

, optional and repeatable