Skip to main content

Transforming Documents in a Project

Creating an Atlas project, compiling mappings, transforming documents individually or in batches, and interpreting the results

The Atlas Transform page with the preview and batch transform areas, run statistics and a table of transformed files, one of which failed validation

An Atlas project converts documents from a source format to a target format. To set up an integration, select the formats and choose Direct mapping or Via canonical mapping through Docupath's canonical document format, the Docupath Internal Format (DIF). Review the proposed field mappings, compile them into a converter, and transform documents with that converter.


Prerequisites

  • Atlas enabled for your tenant, so that Atlas appears in Settings and in the user menu. Note that Atlas is available to tenants in the EU region only.

  • For each side of the conversion, a format already in Formats, or 1 to 10 sample files of up to 5 MB each with the same root element.


Steps

Create the project

  1. In the Docupath platform, open Settings → Atlas. Atlas opens in a new browser tab, on the Projects page.

  2. In the New project card, enter a Project name.

  3. Optional: pick Invoice or Purchase Order as the document type. If you leave it on Detect document type automatically, Atlas asks you to confirm the type during setup.

  4. Click Create. The project opens on Setup, the first of its stages, listed on the left: Setup, Mappings, Visual, Rules, XSLT and Transform.

Define the source and target

The Setup step of a new Atlas project, with a source and a target format chosen in the intake panels and the mapping mode choice, Direct or Via canonical, waiting to be made
  1. In the INTAKE card, under SOURCE, drop your samples on SOURCE XML OR JSON SAMPLES, or choose a format under …or pick a format. Each side accepts either samples or an existing format.

  2. Do the same under TARGET.

  3. Under MAPPING MODE, click Direct or Via canonical. There is no default, and nothing starts until you choose.

    • Via canonical chains the source format's inbound leg (format to canonical format) and the target format's outbound leg (canonical format to format). Field mappings combines the two legs into source-to-target rows, and approving or rejecting a row updates both legs.

    • Direct maps the source straight to the target in a single mapping, which you review on the same Field mappings page.

    A format's legs are shared by every Via canonical project and every document type in the Docupath platform that uses the format. A Direct project compiles its own mapping for that source and target pair and does not change the formats' legs. A JSON format needs Via canonical.

    As soon as you choose, Atlas imports each side's samples as a new draft format.

  4. If a Confirm document type card appears, click Use Invoice, or the other type it offers.

Atlas displays the generated mappings in the Building mappings panel and opens Mappings when generation finishes. A Direct project generates new mappings. A Via canonical project reuses existing legs for the selected formats and generates only the missing legs. If both legs are reused, Atlas does not open Mappings automatically; open it to review them.

The Setup step of an existing Atlas project, showing the source and target sample files and the document structure of both formats

Review the mappings

  1. On the Field mappings page, Approve, Edit or Reject each proposed row, or click Approve all, which also approves rows you rejected. The bar above the table shows how much of the source is mapped and how many target fields no mapping covers.

Visual and Rules are optional before you compile.

Compile the converter

The Atlas XSLT page showing the compiled stylesheet for a project, with Compile XSLT, version, Download and Download merged XSLT controls
  1. Open XSLT and click Compile XSLT. Atlas compiles every Approved and Modified row into the project's converter, an XSLT stylesheet (the file that performs the conversion). Proposed and Rejected rows are left out. Activating a mapping version on a format takes only Approved rows.

  2. Read the banner above the stylesheet, for example Target coverage: 90%. 5 target field(s) will be empty because they have no mapping. Map the empty fields the target needs, then compile again.

Run documents

  1. Open Transform.

  2. Optional: select Bypass validations to skip the XSD, Schematron and validation rule checks. Both cards share the box, and it stays selected until you clear it. Runs made with it are marked unvalidated.

  3. To preview one file, drop it on DROP A SINGLE FILE TO PREVIEW in the Preview card and click Run preview.

  4. To run several, drop them on XML FILES in the Batch transform card and click Transform all. Click Validate only instead to check the files against the source format's XSD and Schematron without converting them.

A preview shows a SUCCESS or ERROR chip, the coverage and schema results and the output, and a Via canonical project adds a CANONICAL FORMAT tab beside FINAL TARGET. It adds no row to the run table. Transform all adds a row per file. Validate only saves nothing, runs no validation rules, and lists each file's result in the Validation results dialog.


Expected Outcome

Each file from Transform all has a row in the run table:

Column

What it shows

Status

Success, Error or Pending, plus unvalidated when the checks were bypassed

Coverage

The field coverage badge

Rules

Validation rules passed out of those that ran, such as 3/4. Click it for details. bypassed means the checks were skipped, and - that no approved rules ran

Actions

After a success, XML, Report, Schema, Download (saves <file name>_transformed.xml) and Delete. After a failure, Schema, Retry (runs the same input again as a new row, with the checks on) and Delete, beside the error in red

Field coverage is the percentage of populated source fields whose mapped target fields contain a value in the output. Report shows the coverage details, and Schema opens the run's Schema validation report.

On the Projects page, each project card shows one status chip:

Chip

Meaning

Draft

Before Atlas builds any mappings

Analyzing

Atlas is building the mappings

Pending Review

Mappings proposed, waiting for review

Ready

The XSLT is compiled

Active

A file in the run table has converted (a preview does not count)


Common Issues

Issue

Cause

Resolution

Setup stops with a message starting Intake failed while

A setup step failed, and the message names it

Try again. Each attempt imports new draft formats, so Disable and then Remove the leftovers in Formats

The build panel reads Build failed. See technical details.

The mapping build stopped with an error

Read the log under Show technical details, then click Build mappings. Mappings reused from a format are kept

A global format, such as Peppol BIS Billing 3.0, is missing from …or pick a format

Projects use only your tenant's own formats

In Formats, open Global, click Fork to tenant and confirm with Fork. Then pick the copy, which has the same name

A run fails with Source document failed XSD or Schematron validation or Generated target document failed XSD or Schematron validation

The input or the output fails its format's XSD or Schematron

Click Schema for the findings, then correct the document, or correct the mappings and compile again

A run fails with Validation failed: and a list of ERROR rules

An approved ERROR rule on the target format failed

Click the Rules cell for the failing rules and the values found, then correct the data, the mapping or the rule


Notes

  • Compile XSLT, Run preview and Approve all on Field mappings also activate the latest draft version of the source and target formats.

  • Limits: 5 MB per file for a preview or a batch, 10 MB per document for Validate only, and XML nested at most 200 levels deep.

  • Runs stay in the project until you delete them or the project.

Did this answer your question?