UBL

Since Camel 4.23

The UBL data format is used for marshalling and unmarshalling UBL 2.1 (Universal Business Language) documents.

UBL 2.1 is an OASIS standard that defines XML business document types such as invoices, credit notes, orders, despatch advice, and more. It is the document format used by the Peppol e-invoicing network and is increasingly mandated across the EU (ViDA directive), and other countries.

The data format uses the ph-ubl library by Philip Helger as the underlying JAXB binding layer. It supports all 65 UBL 2.1 document types and auto-detects the document type from the Java class name (when marshalling) or from the XML root element (when unmarshalling).

UBL Options

The UBL dataformat supports the following options which are listed below.

Name Default Java Type Description

prettyPrint (common)

false

Boolean

Whether to enable pretty printing (formatted) output of the XML.

Supported Document Types

The data format supports all 65 UBL 2.1 document types, including:

  • Invoice, CreditNote, DebitNote

  • Order, OrderResponse, OrderCancellation, OrderChange

  • DespatchAdvice, ReceiptAdvice

  • Quotation, RequestForQuotation

  • Catalogue, CatalogueRequest

  • ApplicationResponse

  • Waybill, BillOfLading, FreightInvoice

  • Statement, RemittanceAdvice, Reminder

  • and many more

Usage

Marshalling (Java object to XML)

  • Java

  • XML

  • YAML

from("direct:marshal")
    .marshal().ubl()
    .to("file:output");
<route>
  <from uri="direct:marshal"/>
  <marshal>
    <ubl/>
  </marshal>
  <to uri="file:output"/>
</route>
- route:
    from:
      uri: direct:marshal
    steps:
      - marshal:
          ubl: {}
      - to:
          uri: file:output

Unmarshalling (XML to Java object)

  • Java

  • XML

  • YAML

from("file:invoices")
    .unmarshal().ubl()
    .process(exchange -> {
        InvoiceType invoice = exchange.getIn().getBody(InvoiceType.class);
        String id = invoice.getIDValue();
    });
<route>
  <from uri="file:invoices"/>
  <unmarshal>
    <ubl/>
  </unmarshal>
  <to uri="direct:process"/>
</route>
- route:
    from:
      uri: file:invoices
    steps:
      - unmarshal:
          ubl: {}
      - to:
          uri: direct:process

With pretty printing

  • Java

  • XML

  • YAML

UblDataFormat ubl = new UblDataFormat();
ubl.setPrettyPrint(true);

from("direct:marshal")
    .marshal(ubl)
    .to("file:output");
<route>
  <from uri="direct:marshal"/>
  <marshal>
    <ubl prettyPrint="true"/>
  </marshal>
  <to uri="file:output"/>
</route>
- route:
    from:
      uri: direct:marshal
    steps:
      - marshal:
          ubl:
            prettyPrint: true
      - to:
          uri: file:output

Dependencies

To use UBL in your Camel routes, you need to add the dependency on camel-ubl which implements this data format.

If you use Maven, you could add the following to your pom.xml, substituting the version number for the latest and greatest release.

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-ubl</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
Back to top