4.3.4.15. UBL

OASIS Universal Business Language (UBL) is the product of an international effort to define a royalty-free library of standard electronic XML business documents such as purchase orders and invoices.

File sample

Below is a sample of UBL file:

<?xml version="1.0" encoding="UTF-8"?>
<Catalogue xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:Catalogue-2" xsi:schemaLocation="urn:oasis:names:specification:ubl:schema:xsd:Catalogue-2 ../UBL%202.1%20schema/maindoc/UBL-Catalogue-2.1.xsd">
	<cbc:UBLVersionID>2.1</cbc:UBLVersionID>
	<cbc:CustomizationID>urn:www.cenbii.eu:transaction:biicoretrdm019:ver2.0:extended:urn:www.peppol.eu:bis:peppol1a:ver2.0</cbc:CustomizationID>
	<cbc:ProfileID>urn:www.cenbii.eu:profile:bii01:ver2.0</cbc:ProfileID>
	<cbc:ID>1234</cbc:ID>
	<cbc:ActionCode listID="ACTIONCODE:PEPPOL">Add</cbc:ActionCode>
	<cbc:Name>Peppol Catalogue</cbc:Name>
	<cbc:IssueDate>2013-08-01</cbc:IssueDate>
	<cbc:VersionID>1</cbc:VersionID>
	<cac:ValidityPeriod>
		<cbc:StartDate>2013-09-01</cbc:StartDate>
		<cbc:EndDate>2014-12-31</cbc:EndDate>
	</cac:ValidityPeriod>
	<cac:ReferencedContract>
		<cbc:ID>3299-8RA</cbc:ID>
		<cbc:ContractType>Framework</cbc:ContractType>
	</cac:ReferencedContract>
	<cac:ProviderParty>
		<cac:PartyIdentification>
			<cbc:ID schemeID="GLN">579000123002</cbc:ID>
		</cac:PartyIdentification>
		<cac:PartyName>
			<cbc:Name>Office AS</cbc:Name>
		</cac:PartyName>
	</cac:ProviderParty>
	<cac:ReceiverParty>
		<cbc:EndpointID schemeID="NO:ORGNR">99156827</cbc:EndpointID>
		<cac:PartyIdentification>
			<cbc:ID schemeID="NO:ORGNR">99572527</cbc:ID>
		</cac:PartyIdentification>
		<cac:PartyName>
			<cbc:Name>DIFI</cbc:Name>
		</cac:PartyName>
	</cac:ReceiverParty>
	<cac:CatalogueLine>
		<cbc:ID>1</cbc:ID>
		<cbc:ActionCode listID="ACTIONCODE:BII2">Add</cbc:ActionCode>
		<cbc:OrderableIndicator>true</cbc:OrderableIndicator>
		<cbc:OrderableUnit>BX</cbc:OrderableUnit>
		<cbc:OrderQuantityIncrementNumeric>1</cbc:OrderQuantityIncrementNumeric>
		<cbc:MinimumOrderQuantity>1</cbc:MinimumOrderQuantity>
		<cac:RequiredItemLocationQuantity>
			<cac:Price>
				<cbc:PriceAmount currencyID="NOK">20.00</cbc:PriceAmount>
			</cac:Price>
		</cac:RequiredItemLocationQuantity>
		<cac:Item>
			<cbc:Description>Ballpoint pen comes in different colours and tip sizes</cbc:Description>
			...

The following properties are available:

Document type	Type and version of the UBL document. Automatically detected from the provided sample
Profile and customization	UBL Profile and UBL customization reference used to validate the UBL document. Automatically detected from the provided sample
UBL Validation Mode	None: No validation will be done on the UBL (nor XSD, nor schematrons) Based on detected types: The validations (both XSD and schematrons) will be done based on the information found in the UBL message itself and the properties "Document type" and "Profile and customization" are left empty. If the properties "document type" or "Profile and Customization" are filled, Babelway will do an additional check to see if the message validated matches these values. If not, the message will fail and moved to Error. Based on explicit types: XSD validation will be done based on the value in the document type property and the schematron validation will be executed based on the Profile And Customization property. If one of these value is empty, we will skip the corresponding validation.

By using UBL message definition, you will get benefit of UBL XSD validation and schematron validation for some of the UBL Profile and Customization (OpenPEPPOL, ePrior...)

Note:You can get a suggestion while updating the message tree of UBL, CEFACT and XML with the fields or attributes to be added under the segment or the field as seen below: