Skip to main content

UDE v2 Data Messages SALES005

Version: Process description SALES005 v2.0

1 The process​

The trading process starts with the exchange of master data. In the DICO standard, we know the product and article message of the SALES005. Within DICO, a product is defined as something that possesses use properties and an article as something that possesses trade properties. So in this context, the item knows the properties that indicate whether something is refurbished or reused and the product describes the properties that are generic and thus also apply to a "new" item such as dimensions. In addition, the condition message and the item relationship message also belong to DICO Data Messages.

Published extensions within DataUDE:

  • XML structure DataUDE in the Item message.
  • XML structure DataUDE in the Product message

Here it is important to note that the extension should always be called by using the following tag:

<UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">

This way, the XSD of the extension is loaded making the extension validatable and is also the only correct way to officially use the extension.

In the relevant subchapters the location of the extension(s) in the relevant messages is indicated.

1.1 Overview of structures in the DataUDE

The following sturctures are currently present in the data extension:

  • TradeItemIndicators
  • Indicators
  • ValueDetail
  • ModelClassificationCharacteristics
  • VariableOrderConditions

2 UDE Structures​

2.1 TradeItemIndicators​

The extension contains indicators applicable to the item message.

Technology

The extension below is included in the item message at the line level. Only at this location in the message will the TradeItemIndicators extension be placed.

  • The location of the extension within the Article Message is on the line, xpath is: PriceCatalogue/Grouping/TradeItemLine/UserDefinedExtension

The following parts of the extension may be used within the Article message at this location:

<TradeItemLine>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:DataUDE>
      <data:TradeItemIndicators>
       <data:Refurbished>true</data:Refurbished>
       <data:Reused>true</data:Reused>
      </data:TradeItemIndicators>
    </data:DataUDE>
  </UserDefinedExtension>
</TradeItemLine>

Note: to exchange master data of items, follow the standard rules of current XML messages.

2.2 Indicators​

With this structure it is possible to create flexible indicators. An indicator that is not yet fixed in the article and/or product message. This structure responds to the many distinctions concerning indicators.

<data:Indicator>
  <data:Type>OTH</data:Type>
  <data:TypeOther>CO2 Surcharge</data:TypeOther>
  <data:Value>false</data:Value>
</data:Indicator>

Note that TypeOther is a fictional example in this case

On the field Type there is a code list IndicatorsType, at the code OTH it becomes possible to indicate a TypeOther. The content of the Value field is free if TypeOther is used. If TypeOther is not used and a specific code is called in the field Type then the content of the field Value can be prescribed in the definition of the corresponding code.

Technology

This extension can appear in 2 messages, namely the article message or the product message.

  • The location of this extension within the item message is on the line, xpath is: PriceCatalogue/Grouping/TradeItemLine/UserDefinedExtension

  • The location of this extension within the product message is on the line, xpath is: ProductData/ProductLine/UserDefinedExtension

The following parts of the extension may be used within the message at this location (example article message):

<TradeItemLine>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:DataUDE>
      <data:Indicator>
        <data:Type> </data:Type>
        <data:TypeOther> </data:TypeOther>
        <data:Value> </data:Value>
        <data:CertificateReference> </data:CertificateReference>
        <data:AttachmentReference> </data:AttachmentReference>
      </data:Indicator>
    </data:DataUDE>
  </UserDefinedExtension>
</TradeItemLine>

2.3 ValueDetail​

The ValueDetail structure allows additional values to be given for a product. Per property one extra value (value) can be given. So if via the product message and the ETM structure in that message a "color" (ETIM code: EF000007) can be given with the value "white" (ETIM code EV000202), an additional value can be added with extension, for example "cloud white". Only one valuedetail can be specified per language.

Example of applying ValueDetail:

<ProductClassificationCharacteristic>
  <InternationalCharacteristicCode>EF000007</InternationalCharacteristicCode>
  <InternationalCharacteristicCodeValue>EV000022</InternationalCharacteristicCodeValue>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:DataUDE>
      <data:ValueDetail>
       <data:DetailValue>Wolkenwit</data:DetailValue>
       <data:LanguageCode>NL</data:LanguageCode>
      </data:ValueDetail>
      <data:ValueDetail>
       <data:DetailValue>Cloud white</data:DetailValue>
       <data:LanguageCode>EN</data:LanguageCode>
      </data:ValueDetail>
    </data:DataUDE>
  </UserDefinedExtension>
</ProductClassificationCharacteristic>

Technology This extension is placed within the product message.

*The location of the extension within the product message is at the ProductClassificationCharacteristic level, xpath is: ProductData/ProductLine/ProductclassificationETIM/ProductClassificationCharacteristic/UserDefinedExtension

The following extension components may be used within the message at this location:

<ProductClassificationCharacteristic>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:DataUDE>
      <data:ValueDetail>
        <data:DetailValue> </data:DetailValue>
        <data:LanguageCode> </data:LanguageCode>
      </data:ValueDetail>
    </data:DataUDE>
  </UserDefinedExtension>
</ProductClassificationCharacteristic>

2.4 ModelClassificationCharacteristics.​

With the emergence of Connection Types (CT), it is necessary to separate the current ETIM MC structure from the ETIM EC structure in the product message. To exchange ETIM data with CT correctly, an extension is available. This extension is based on the structure established by ETIM International.

The operation of the extension is similar to that of the structure in the product message.

Technology

This extension is placed in the product message.

  • The location of the extension within the product message is at the ProductLine level, xpath is:ProductData/ProductLine/UserDefinedExtension
<ProductLine>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:DataUDE>
      <data:ModelClassificationCharacteristics>
        <data:ProductClass>
          <data:ClassCode> </data:ClassCode>
          <data:ClassVersion> </data:ClassVersion>
        </data:ProductClass>
        <data:ModellingClass>
          <data:ClassCode> </data:ClassCode>
          <data:ClassVersion> </data:ClassVersion>
        </data:ModellingClass>
        <data:BIMStatus> </data:BIMStatus>
        <data:Port>
          <data:PortCode> </data:PortCode>
          <data:ConnectionTypeCode> </data:ConnectionTypeCode>
          <data:ConnectionTypeVersion> </data:ConnectionTypeVersion>
          <data:ModellingClassFeature>
            <data:FeatureCode> </data:FeatureCode>
            <data:FeatureValue> </data:FeatureValue>
            <data:XCoordinate> </data:XCoordinate>
            <data:YCoordinate> </data:YCoordinate>
            <data:ZCoordinate> </data:ZCoordinate>
            <data:MatrixValues>
              <data:MatrixValue>
                <data:MatrixSourceValue> </data:MatrixSourceValue>
                <data:MatrixResultValue> </data:MatrixResultValue>
              </data:MatrixValue>
            </data:MatrixValues>
          </data:ModellingClassFeature>
        </data:Port>
      </data:ModelClassificationCharacteristics>
    </data:DataUDE>
  </UserDefinedExtension> 
</ProductLine>

2.5 VariableOrderConditions​

The structure allows you to specify custom products and items. Consider the width and length of a table top.

Examples:

  • A table top can be ordered with a length of 1000 mm - 2000 mm, in increments of 100 mm;
<data:VariableOrderConditions>
    <data:VariableCode>EF001438</data:VariableCode>
    <data:VariableDescription>Lengte</data:VariableDescription>
    <data:ValueType>N</data:ValueType>
    <data:NumericValueUoM>MMT</data:NumericValueUoM>
    <data:ValueRange>        
        <data:LowerNumericValue>1000</data:LowerNumericValue>
        <data:UpperNumericValue>2000</data:UpperNumericValue>
        <data:NumericValueStepSize>100</data:NumericValueStepSize>       
    </data:ValueRange>
</data:VariableOrderConditions>
  • A square air duct can be ordered from 400 mm to 1000 mm wide in 50 mm increments.
<data:VariableOrderConditions>
    <data:VariableCode>EF000008</data:VariableCode>
    <data:VariableDescription>Breedte</data:VariableDescription>
    <data:ValueType>N</data:ValueType>
    <data:NumericValueUoM>MMT</data:NumericValueUoM>
    <data:ValueRange>
        <data:LowerNumericValue>400</data:LowerNumericValue>
        <data:UpperNumericValue>1000</data:UpperNumericValue>
        <data:NumericValueStepSize>50</data:NumericValueStepSize>        
    </data:ValueRange>
</data:VariableOrderConditions>
  • A heater can be ordered in 4 different colors (white, red, blue and black).
<data:VariableOrderConditions>
    <data:VariableCode>EF000007</data:VariableCode>
    <data:VariableDescription>Kleur</data:VariableDescription>
    <data:ValueType>A</data:ValueType>
    <data:ValueRange>
        <data:AlphanumericValue>RAL9010</data:AlphanumericValue>
        <data:AlphanumericValue>RAL9005</data:AlphanumericValue>
        <data:AlphanumericValue>RAL5015</data:AlphanumericValue>
        <data:AlphanumericValue>RAL3020</data:AlphanumericValue>
    </data:ValueRange>
</data:VariableOrderConditions>

Technology This extension can appear in 2 messages, namely the article message or the product message.

  • The location of this extension within the item message is on the line, xpath is: PriceCatalogue/Grouping/TradeItemLine/UserDefinedExtension

  • The location of this extension within the product message is on the line, xpath is: ProductData/ProductLine/UserDefinedExtension

The extension is used within the message at this location (example article message):

  
<TradeItemLine>
  <UserDefinedExtension xmlns:data="http://www.ketenstandaard.nl/UDE/SALES/Data/v2" xsi:schemaLocation="http://www.ketenstandaard.nl/UDE/SALES/Data/v2 DataUDEv2.xsd">
    <data:VariableOrderConditions>
        <data:VariableCode> </data:VariableCode>
        <data:VariableDescription> </data:VariableDescription>
        <data:ValueType> </data:ValueType>
        <data:NumericValueUoM> </data:NumericValueUoM>
        <data:ValueRange>
            <data:AlphanumericValue> </data:AlphanumericValue>
            <data:LowerNumericValue> </data:LowerNumericValue>
            <data:UpperNumericValue> </data:UpperNumericValue>
            <data:NumericValueStepSize> </data:NumericValueStepSize>
        </data:ValueRange>
    </data:VariableOrderConditions>
  </UserDefinedExtension>
</TradeItemLine>