Configuring XMP PDF properties

To support e-invoicing standards such as ZUGFeRD and Factur-X, Document Output Management (DOM) provides functionality to define and manage PDF XMP (Extensible Metadata Platform) schemas and properties. You can specify structured XMP metadata and assign it to report rules for PDF output. When a report rule has XMP data and the output is rendered as PDF, the XMP metadata is embedded in the generated PDF.

Only the XMP properties that are defined for the report rule are included. The generated PDF uses the related schema, namespace, and property definitions. Property values are taken from the XMP data for the report rule. If a value contains a variable reference, the resolved variable value is used. XMP properties can be structured hierarchically: a property can contain child properties, depending on how the selected schema is defined.

Use case:

  • Create a document type and report rule for the Invoice report, for example cisli12001000, or use an existing document type.
  • Define a ZUGFeRD 2.0 XMP schema and assign its properties to the invoice report rule, so that every invoice that is rendered as PDF carries compliant e-invoicing metadata.

Setup:

  1. In the session, define an XMP schema, for example ZUGFeRD_2.0.
  2. On the Namespaces tab, which refers to the session, define the namespace prefixes and URIs that are used by the schema.
  3. On the Properties tab, which refers to the session, define the property hierarchy. A property can contain child properties, depending on how the schema is defined.
  4. Save the schema.
  5. Start the Report Rules (ttrpi2520m000) session.
  6. Select the report rule for the Invoice report (for example, cisli12001000), which is linked to the Invoice document type, or add a new report rule with these properties:
    • Report: cisli12001000
    • Is Default: Yes
    • Document Type: Invoice
    • Render Format: PDF
  7. Open the details for this report rule. The Report Rule (ttrpi2520m100) session is displayed.
  8. On the PDF XMP Data tab, which refers to the session, click Select Schema and select the schema that you defined, for example ZUGFeRD_2.0. The property records are generated from the schema.
  9. Specify values for the Simple -type properties. Optionally, use #variable# references so that report values, such as the invoice number, are inserted at render time.
  10. Save this record, and click Validate and Compile to validate the report rule.
  11. Print a draft invoice to the Document Output Management device and view the results.
Note: 

Only the XMP properties that are defined for the report rule are embedded in the PDF. Values that contain a variable reference are replaced by the resolved variable value when the document is rendered.