Joinery-oriented formatting specification for UBL Order Response example instance

$Date: 2004/09/05 15:14:03 $(UTC)


Table of Contents

1. Simple order response formatting specification
1.1. Status
1.2. Example rendering
1.3. Layout order and information
1.4. Namespaces
2. Miscellaneous information
2.1. Document header information
3. Header information
3.1. Your Order No.
3.2. Issue Date
3.3. Our Reference
3.4. Confirmed
3.5. Buyer
3.6. Contact
3.7. Seller
3.8. Contact
3.9. Order Contact
3.10. Delivery address
3.11. Requested Delivery Date
3.12. Discount
3.13. Delivery Charge
4. Line item information
4.1. Line
4.2. Item
4.3. [Source of column headings]
4.4. [Values of columns with headings as above]
4.5. Qty
4.6. Measure
4.7. Measured
4.8. Price each

1.  Simple order response formatting specification

This formatting specification describes a rendering of an instance of the UBL Order Response document model according to a conceptual joinery-oriented layout.

For a list of all formatting specifications and an overview of the documentation conventions, please visit the formatting specification home page.

1.1.  Status

This specification has no formal status at this time. It should not be considered a reference interpretation of UBL documents. Feedback is sought from users of stylesheets that implement this formatting specification regarding suggestions for change for consideration by the OASIS UBL committees for incorporation into these formatting specifications.

Presentational semantics may never be formalized or normative in the UBL project due to differing international requirements and conventions for the presentation of information found in business documents. This document contains only examples from a few of what will probably be many available UBL stylesheet libraries.

1.2.  Example rendering

The following is an example rendering that illustrates the position and decoration of the information items found in an instance of the document type:

1.3.  Layout order and information

Items in this formatting specification are ordered roughly from the laid out fields on the form in the order left-to-right, top to bottom.

Important: the rendering of a number of fields is very simplified, reflecting a Western European interpretation of a subset of fields (as in names and addresses). User requirements need to be better understood for the level of granularity in these stylesheets.

1.4.  Namespaces

The following namespaces are mapped to the prefixes in the expressions below:

  • cac = "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-1.0"

    cbc = "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-1.0"

    ro = "urn:oasis:names:specification:ubl:schema:xsd:OrderResponse-1.0"

2.  Miscellaneous information

The following information is unrelated to the visible fields of the form.

2.1.  Document header information

Table 1. XPath information

XPath addresses
/​ro:OrderResponse/​ro:SellersID
/​ro:OrderResponse/​cac:OrderReference/​cbc:IssueDate

This information shows up in the window-title bar of the HTML browser, and in the document title supported by some XSL-FO processors.

3. Header information

Header information is associated with the form as a whole, not to the individual items of goods.

3.1. Your Order No.

Table 2. XPath information

XPath address
/​ro:OrderResponse/​cac:OrderReference/​cac:BuyersID

The reference number is a number or designation preferably common throughout each set of documents.

3.2. Issue Date

Table 3. XPath information

XPath address
/​ro:OrderResponse/​cac:OrderReference/​cbc:IssueDate

If not otherwise specified, "date" means the date of issue of the document in which it appears.

3.3. Our Reference

Table 4. XPath information

XPath address
/​ro:OrderResponse/​ro:SellersID

The reference number is a number or designation preferably common throughout each set of documents.

3.4. Confirmed

Table 5. XPath information

XPath address
/​ro:OrderResponse/​cbc:IssueDate

3.5. Buyer

Table 6. XPath information

XPath addresses
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:StreetName
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CityName
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity

The field for the name and address to which documents are sent (buyer).

3.6. Contact

Table 7. XPath information

XPath address
/​ro:OrderResponse/​cac:BuyerParty/​cac:Party/​cac:Contact/​cbc:Name

The buyer's contact for the order

3.7. Seller

Table 8. XPath information

XPath addresses
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:PartyName/​cbc:Name
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:BuildingName
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CityName
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:PostalZone
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Address/​cbc:CountrySubentity

This field is intended to show the name and address of the sender of goods or the originator of the documents, as the case may be.

3.8. Contact

Table 9. XPath information

XPath address
/​ro:OrderResponse/​cac:SellerParty/​cac:Party/​cac:Contact/​cbc:Name

The seller's contact for the order

3.9. Order Contact

This field is not filled in at this time

3.10.  Delivery address

Table 10. XPath information

XPath addresses
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:StreetName
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:BuildingName
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:CityName
/​ro:OrderResponse/​cac:Delivery/​cac:DeliveryAddress/​cbc:CountrySubentity

The address where the order is being delivered.

3.11.  Requested Delivery Date

Table 11. XPath information

XPath address
/​ro:OrderResponse/​cac:Delivery/​cbc:RequestedDeliveryDateTime

3.12. Discount

Table 12. XPath information

XPath addresses
/​ro:OrderResponse/​cac:AllowanceCharge/​cbc:MultiplierFactorNumeric
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListAgencyID
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListID
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListSchemeURI
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListAgencyName
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListName
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListURI
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@codeListVersionID
/​ro:OrderResponse/​cac:AllowanceCharge/​cac:ReasonCode/​@name
/​ro:OrderResponse/​cac:AllowanceCharge/​cbc:ChargeIndicator

3.13.  Delivery Charge

Table 13. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem[cac:Item/​cac:SellersItemIdentification/​cac:ID='Delivery']/​cac:Item/​cac:BasePrice/​cbc:PriceAmount/​@amountCurrencyID

4. Line item information

Line item information is associated with the individual items of the goods in the order.

4.1. Line

Table 14. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:BuyersID

This is the reference to the Order line.

4.2.  Item

Table 15. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:ID

4.3. [Source of column headings]

Table 16. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:PhysicalAttribute/​cac:AttributeID

4.4. [Values of columns with headings as above]

Table 17. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:PhysicalAttribute/​cac:DescriptionCode

4.5. Qty

Table 18. XPath information

XPath addresses
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cbc:Quantity
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cbc:Quantity/​@quantityUnitCode

One of these exists for each line item.

4.6. Measure

Table 19. XPath information

XPath addresses
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:MeasurementDimension/​cbc:Measure
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:MeasurementDimension/​cbc:Measure/​@measureUnitCode

4.7. Measured

Table 20. XPath information

XPath address
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:SellersItemIdentification/​cac:MeasurementDimension/​cac:AttributeID

4.8. Price each

Table 21. XPath information

XPath addresses
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount/​@amountCurrencyID
/​ro:OrderResponse/​ro:RespondedOrderLine/​cac:LineItem/​cac:Item/​cac:BasePrice/​cbc:PriceAmount