Formatting specifications for UBL Order instances

Author: G. Ken Holman
Date: $Date: 2003/01/26 22:22:16 $(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 Party information
2.1 Seller
2.2 Purchase order number
2.3 Date
2.4 Seller's reference
2.5 Buyer's reference
2.6 Other reference
2.7 Consignee
2.8 Buyer
2.9 Buyer's bank
2.10 Country of origin
2.11 Country of destination
3 Delivery and transport
3.1 Mode of transport
3.2 Date of despatch
3.3 Means of transport
3.4 Place of despatch
3.5 Place of loading
3.6 Place of discharge
3.7 Place of delivery
3.8 Terms of delivery
3.9 Location
3.10 Time of delivery
3.11 Transport Charges
3.12 Terms of payment
3.13 Currency of payment
4 Line item information
4.1 Shipping marks
4.2 Container Nr.
4.3 Number and kind of packages; description of goods
4.4 Total gross weight (Kg)
4.5 Cube m3
4.6 Item
4.7 Description
4.8 Quantity U/M
4.9 Unit price
4.10 Amount
5 Summary information
5.1 Invoice clauses
5.2 Total amount
5.3 Name of signatory
5.4 Place of issue
5.5 Signature

1: Purchase order formatting specification

This formatting specification describes a rendering of the UBL Order document model according to the United Nations Layout Key for Trade Documents guidelines for application for the 220 Order form:

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 and 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.

An up-to-date list of pointers to the source of these materials, and other published libraries of formatting specifications when they become available, will be found in a supplementary package linked from the UBL Library Content Subcommittee portal at http://oasis-open.org/committees/ubl/lcsc.

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.

Certain descriptions are verbatim quotes from the United Nations guidelines document.

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: Party information

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

2.1: 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

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.

2.2: Purchase order number

Path
/​po:Order/​cat:OrderID

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

2.3: Date

Path
/​po:Order/​cat:OrderIssueDate

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

2.4: Seller's reference

At this time this field is not being filled in.

2.5: Buyer's reference

At this time this field is not being filled in.

2.6: Other reference

At this time this field is not being filled in.

2.7: Consignee

The field for the name and address of the consignee has been located in conformity with international postal specifications so as to allow the use of window envelopes.

The contents of this field is the same as the 2.8 Buyer field.

2.8: 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

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

2.9: Buyer's bank

At this time this field is not being filled in.

2.10: Country of origin

At this time this field is not being filled in.

2.11: Country of destination

Path
/​po:Order/​cat:DestinationCountry/​cat:Code

At this time this field is not being filled in.

3: Delivery and transport

Transportation fields that are header-like and applicable to the entire order.

3.1: Mode of transport

At this time this field is not being filled in.

3.2: Date of despatch

At this time this field is not being filled in.

3.3: Means of transport

At this time this field is not being filled in.

3.4: Place of despatch

At this time this field is not being filled in.

3.5: Place of loading

At this time this field is not being filled in.

3.6: Place of discharge

At this time this field is not being filled in.

3.7: Place of delivery

At this time this field is not being filled in.

3.8: Terms of delivery

At this time this field is not being filled in.

3.9: Location

At this time this field is not being filled in.

3.10: Time of delivery

At this time this field is not being filled in.

3.11: Transport Charges

At this time this field is not being filled in.

3.12: Terms of payment

At this time this field is not being filled in.

3.13: Currency of payment

At this time this field is not being filled in.

4: Line item information

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

4.1: Shipping marks

At this time this field is not being filled in.

4.2: Container Nr.

At this time this field is not being filled in.

4.3: Number and kind of packages; description of goods

At this time this field is not being filled in.

4.4: Total gross weight (Kg)

Path
/​po:Order/​cat:OrderGrossWeightMeasure

The gross weight of the shipment.

4.5: Cube m3

Path
/​po:Order/​cat:OrderGrossVolumeMeasure

The gross volume of the shipment.

4.6: Item

Path
/​po:Order/​cat:OrderLine

This is the enumeration of the order line elements being processed.

4.7: Description

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

One of these exists for each Line item.

4.8: Quantity U/M

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

One of these exists for each line item.

4.9: Unit price

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

One of these exists for each line item.

4.10: Amount

This is the product of the 4.8 Quantity U/M field and the 4.9 Unit price field.

5: Summary information

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

5.1: Invoice clauses

At this time this field is not being filled in.

5.2: Total amount

Path
/​po:Order/​po:TransactionCurrencyCode

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

The total amount is the sum of all of the 4.10 Amount fields.

5.3: Name of signatory

At this time this field is not being filled in.

5.4: Place of issue

At this time this field is not being filled in.

5.5: Signature

This is not being filled in by the stylesheet and is left for a human to sign.


Formatting specifications for UBL Order instances
G. Ken Holman
Copyright © 2003 OASIS
$Date: 2003/01/26 22:22:16 $(UTC)