Office-oriented formatting specification for UBL Order instances

Author: G. Ken Holman
Date: $Date: 2003/02/10 21:27:44 $(UTC)

Copyright © 2003 OASIS

Table of contents

1 Purchase order formatting specification
1.1 Status
1.2 Example renderings and implementations
1.3 Layout order and information
1.4 Namespaces
2 Miscellaneous information
2.1 Document header information
3 Header information
3.1 Order No.
3.2 Issue Date
3.3 Seller
3.4 Buyer
3.5 Contact
3.6 Order Contact
3.7 Delivery address
3.8 Requested Delivery Date
4 Line item information
4.1 Line no.
4.2 Part number
4.3 Description
4.4 Quantity U/M
4.5 Unit price
4.6 Amount
5 Summary information
5.1 Total amount

1: Purchase order formatting specification

This formatting specification describes a rendering of an instance of the UBL Order document model according to a conceptual office-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 renderings and implementations

Example renderings:

Note the above examples are produced using Crane's XSLT and XSL-FO stylesheets. The HTML and XSL-FO are created by running the Saxon XSLT processor http://saxon.sourceforge.net/. The PDF is created by running the Antenna House XSL Formatter Version 2.3 http://www.AntennaHouse.com (with their gracious permission) to produce PostScript from XSL-FO and GhostScript AFPL http://www.GhostScript.com to distill PDF from the PostScript.

Example implementations:

These implementations must not be considered as reference implementations of UBL formatting specifications or as normative components of the UBL delivery; they are merely examples from what will probably be many available UBL stylesheet libraries.

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:

2: Miscellaneous information

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

2.1: Document header information

Path
/​po:Order/​cat:ID
/​po:Order/​cat: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: Order No.

Path
/​po:Order/​cat:ID

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

3.2: Issue Date

Path
/​po:Order/​cat:IssueDate

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

3.3: Seller

Path
/​po:Order/​cat:SellerParty/​cat:PartyName/​cat:Name
/​po:Order/​cat:SellerParty/​cat:Address/​cat:Street
/​po:Order/​cat:SellerParty/​cat:Address/​cat:CityName
/​po:Order/​cat:SellerParty/​cat:Address/​cat:CountrySub-EntityCode
/​po:Order/​cat:SellerParty/​cat:Address/​cat:Country/​cat:Code
/​po:Order/​cat:SellerParty/​cat:Address/​cat:PostalZone

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.4: Buyer

Path
/​po:Order/​cat:BuyerParty/​cat:PartyName/​cat:Name
/​po:Order/​cat:BuyerParty/​cat:Address/​cat:Street
/​po:Order/​cat:BuyerParty/​cat:Address/​cat:CityName
/​po:Order/​cat:BuyerParty/​cat:Address/​cat:CountrySub-EntityCode
/​po:Order/​cat:BuyerParty/​cat:Address/​cat:Country/​cat:Code
/​po:Order/​cat:BuyerParty/​cat:Address/​cat:PostalZone

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

3.5: Contact

Path
/​po:Order/​cat:BuyerParty/​cat:BuyerContact/​cat:Name

The buyer's contact for the order

3.6: Order Contact

This field is not filled in at this time

3.7: Delivery address

Path
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverToAddress/​cat:Street
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverToAddress/​cat:CityName
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverToAddress/​cat:CountrySub-Entity
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverToAddress/​cat:Country/​cat:Code
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverToAddress/​cat:PostalZone

The address where the order is being delivered.

3.8: Requested Delivery Date

Path
/​po:Order/​cat:OrderLine/​cat:DeliveryRequirement/​cat:DeliverySchedule/​cat:RequestedDeliveryDate

4: Line item information

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

4.1: Line no.

Path
/​po:Order/​cat:OrderLine/​cat:BuyersID

This is the reference to the Order line.

4.2: Part number

Path
/​po:Order/​cat:OrderLine/​cat:Item/​cat:SellersItemIdentification/​cat:ID

4.3: Description

Path
/​po:Order/​cat:OrderLine/​cat:Item/​cat:Description

One of these exists for each Line item.

4.4: Quantity U/M

Path
/​po:Order/​cat:OrderLine/​cat:Quantity

One of these exists for each line item.

4.5: Unit price

Path
/​po:Order/​cat:OrderLine/​cat:Item/​cat:BasePrice/​cat:PriceAmount/​@currencyID
/​po:Order/​cat:OrderLine/​cat:Item/​cat:BasePrice/​cat:PriceAmount

One of these exists for each line item.

4.6: Amount

Path
/​po:Order/​cat:OrderLine/​cat:LineExtensionAmount/​@currencyID
/​po:Order/​cat:OrderLine/​cat:LineExtensionAmount

This is not calculated - it is transmitted

5: Summary information

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

5.1: Total amount

Path
/​po:Order/​cat:LineExtensionTotalAmount/​@currencyID
/​po:Order/​cat:LineExtensionTotalAmount

Two data fields populate this one form field: the currency and the total amount.


Office-oriented formatting specification for UBL Order instances
G. Ken Holman
Copyright © 2003 OASIS
$Date: 2003/02/10 21:27:44 $(UTC)