UN-like layout formatting specification for UBL Order Cancellation instances

$Date: 2003/11/18 15:40:47 $(UTC)


Table of Contents

1. Order cancellation 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. Party information
3.1. Seller
3.2. Cancellation number
3.3. Date
3.4. Seller's reference
3.5. Buyer's reference
3.6. Purchase order date
3.7. Consignee
3.8. Buyer
3.9. Cancellation reason
3.10. Response
4. Summary information
4.1. Invoice clauses
4.2. Name of signatory
4.3. Place and date of issue
4.4. Signature

1.  Order cancellation formatting specification

This formatting specification describes a rendering of the UBL Order Cancellation document model according to a mimic of the United Nations Layout Key for Trade Documents guidelines given the absence of such a 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:

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 formatting specifications.

1.4.  Namespaces

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

  • xmlns:xo="urn:oasis:names:tc:ubl:OrderCancellation:1:0-beta"

  • xmlns:cat="urn:oasis:names:tc:ubl:CommonAggregateTypes:1:0-beta"

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
/​xo:OrderCancellation/​cat:ID
/​xo:OrderCancellation/​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. Party information

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

3.1. Seller

Table 2. XPath information

XPath addresses
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:PartyName/​cat:Name
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:Address/​cat:StreetName
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:Address/​cat:CityName
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:Address/​cat:CountrySubentity
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:Address/​cat:PostalZone
/​xo:OrderCancellation/​cat:SellerParty/​cat:Party/​cat:Address/​cat:Country/​cat:Name

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

3.2. Cancellation number

Table 3. XPath information

XPath address
/​xo:OrderCancellation/​cat:ID

This number is a unique number assigned to the order cancellation by the buyer.

3.3. Date

Table 4. XPath information

XPath address
/​xo:OrderCancellation/​xo:IssueDateTime

This field states the date of the order cancellation.

3.4. Seller's reference

Table 5. XPath information

XPath address
/​xo:OrderCancellation/​cat:OrderReference/​cat:SellersID

This field provides a seller assigned reference to the order corresponding to this order cancellation.

3.5. Buyer's reference

Table 6. XPath information

XPath address
/​xo:OrderCancellation/​cat:OrderReference/​cat:BuyersID

This field provides the buyer's reference to the original order.

3.6. Purchase order date

Table 7. XPath information

XPath address
/​xo:OrderCancellation/​cat:OrderReference/​cat:IssueDate

This fields provides the issue date of the original order

3.7. Consignee

Currently the contents of this field is the same as the Section 3.8, “Buyer” field.

3.8. Buyer

Table 8. XPath information

XPath addresses
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:PartyName/​cat:Name
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:StreetName
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CityName
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CountrySubentity
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:PostalZone
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:Country/​cat:Name

These fields are used to provide the name and address of the buyer of the goods involved in the transaction.

3.9. Cancellation reason

Table 9. XPath information

XPath address
/​xo:OrderCancellation/​xo:CancellationNote

This fields provides free text information relating to the cancellation of the order.

3.10. Response

Table 10. XPath information

XPath address
/​xo:OrderCancellation/​xo:ResponseRequiredIndicator

This field indicates if the sender of the cancellation requires a response to this message, if the indicator returns true then 'Response Required' would be printed in this form field, if the indicator returns false then 'No Response Required' would be printed.

4. Summary information

Summary information is associated to the entire order cancellation.

4.1. Invoice clauses

Table 11. XPath information

XPath address
/​xo:OrderCancellation/​cat:Note

This notes field is used for any free text information that relates to the order cancellation.

4.2. Name of signatory

Table 12. XPath information

XPath addresses
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Contact/​cat:Name
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Contact/​cat:Telephone

These fields provides the contact name and telephone number for this order cancellation.

4.3. Place and date of issue

Table 13. XPath information

XPath addresses
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CityName
/​xo:OrderCancellation/​cat:BuyerParty/​cat:Party/​cat:Address/​cat:CountrySubentity
/​xo:OrderCancellation/​cat:IssueDate

The above fields provide information relating to the date and place of issue of the order cancellation.

4.4. Signature

This field is not currently being filled automatically as it is a manual entry.