Technical description scope-document

ATLAS XML via Scope Document interface

We offer sending the original XML messages exchanged with German Customs (“ATLAS”) to the customer. The purpose is for the customer to be able to integrate other systems tightly with the data exchanged with ATLAS.

There are two versions of this interface:

The original XML, without any envelope, gets forwarded to the customer directly. This feature is available for ATLAS message exchange via FTAM, i.e. it is available for all types of ATLAS procedures except WKS.
The original XML is sent out via the Scope Document interface, i.e. it is wrapped in Scope-Document XML and that is sent out to the customer.

This document describes the second option, i.e. sending the original ATLAS XML via Scope Document interface.

Configuration

This feature is implemented in Scope and uses the Scope-Document clearing center. Please contact the Riege service team to get this feature activated for your branch.

Testing the interface

The Atlas Declarant role offers an action to send a test message. This will generate a fake E_ERR_NCK message and send it out via the Scope Document interface. The fake message will contain references that are newly generated every time, like the LRN, MRN, and message ids. Also, timestamps will be current. The sender and receiver and the user id will be taken from the current session.

XML Format

The Scope Document XML will be filled in the way described in the following by an XML example and comments before each element:

<!--
  ~ Copyright (c) 2026 Riege Software International. All rights reserved.
  ~ Use is subject to license terms.
  -->
<documentMessage xmlns="http://dtd.riege.com/scope/document" schemaVersion="2.3"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xsi:schemaLocation="http://dtd.riege.com/scope/document https://dtd.riege.com/scope/document/scope_document-2.3.xsd">
    <!-- current timestamp at creation time -->
    <messageHeader messageCreation="2026-07-24T17:18:19+02:00">
        <!-- organization code -->
        <sender>RSI</sender>
        <!-- organization code.legal entity code -->
        <recipient>RSI.DE</recipient>
        <!-- generated UUID for this message -->
        <messageId>449e20cb-1a5d-4806-a5b4-2afb9bd76386</messageId>
    </messageHeader>
    <!-- documentId: message id of the message contained in this document -->
    <!-- version: fix 1 -->
    <!-- mimeType: fix text/xml -->
    <document documentId="936a9c95-9339-4196-8849-b371dc765a4a" version="1" mimeType="text/xml">
        <!-- time the message was sent or received in Scope -->
        <time>2026-07-20T11:25:36+02:00</time>
        <refs>
            <!-- message id of the message contained in this document. For WKS, this is always a UUID -->
            <entityId idType="customsOriginalMessageID">936a9c95-9339-4196-8849-b371dc765a4a</entityId>
            <!-- MRN, if available. (For initial messages in a procedure, the MRN may not be available) -->
            <ref qual="customsRegistrationNumber">26DE587600123285C2</ref>
            <!-- LRN (uniquely generated by Scope per procedure) -->
            <ref qual="uniqueProcedureReference">GTL-X0APLVQ7IOG8U2654K</ref>
            <!-- bezugsnummer (if entered by user)  -->
            <ref qual="procedureReferenceNumber">abc202607151447</ref>
            <!-- shipment reference from customs order if available -->
            <ref qual="shipmentReference">FRAAE2600176</ref>
        </refs>
        <!-- message id of the message contained in this document with suffix ".xml" -->
        <fileName>936a9c95-9339-4196-8849-b371dc765a4a.xml</fileName>
        <!-- The content of the document, base64 encoded. This example is truncated, for brevity -->
        <content>PD94bWwgdm...EVYU0RGPgo=</content>
        <!-- customsDeOutgoingMessage or customsDeIncomingMessage -->
        <documentType>customsDeOutgoingMessage</documentType>
        <!-- message type -->
        <subType>E_EXS_DAT</subType>
        <!-- German description of the message type -->
        <subTypeDescription language="DE">EExsDat - Ausgangs-SumA</subTypeDescription>
        <additionalInformation>
            <!-- branch code from Scope that sent or received the message -->
            <branch>FRA</branch>
            <!-- Scope user responsible for the procedure in Scope -->
            <userID>max.mustermann@riege.com</userID>
            <customs>
                <!-- Scope user responsible for the procedure in Scope -->
                <customsClerkID>max.mustermann@riege.com</customsClerkID>
            </customs>
        </additionalInformation>
    </document>
</documentMessage>

Examples

incoming EExsAck - Empfangsbestätigung der Ausgangs-SumA
outgoing EExsDat - Ausgangs-SumA

Disclaimer: This technical description is not part of any contractual agreements.
This description is published by Riege Software under UPL license. Imprint. Privacy.
View project on GitHub