Skip to main content
Skip table of contents

Documents

Documents overview

You can browse all documents that have been processed by Routty up to 365 days in the past. You can search and filter on all relevant data.

The following documents fields are displayed:

  • Received on: The timestamp when the document was first received by Routty or its connector. If a document is reprocessed, this timestamp remains unchanged.

  • Document reference: For example, an invoice number, purchase order number, etc.

  • Company: The name of the company associated with the document.

  • Business partner: The partner with whom the document was exchanged.

  • Status:The current status of the document. Possible statuses include:

    • Error: The document was not successfully processed.

    • Processing: The document is currently being processed by Routty.

    • Success: The document has been successfully processed.

    • Cancelled: The document was in an error state and was manually cancelled; no further processing is required or will occur.

    • Rejected: The document was delivered successfully but rejected by the customer.

    • Ready for Export: The document is waiting to be picked up by the output connector, which will send the document to the target channel.

    • Awaiting feedback: The document has been processed and is awaiting a response from the receiving channel.

    • Ready for upload: The document is awaiting file upload.

    • Reprocessing: The document is undergoing processing again.

  • Channel: channel over which the document has been received or will be sent, e.g. Peppol or SFTP.

  • Flow: either inbound or outbound.

  • Document type: the type of document that was processed.

  • Environment: indicating if this document is a test or live document.

  • Actions: an admin can ask to reprocess the document or can cancel a document.


Document Details

When clicking on a document in the Documents overview the detail page for the document will be opened. In this details page you can find the following information:

In the info view, you can view all relevant information on the document.

In the files view, you can download or view the document XML and its attachments at various stages of processing:

  • input: the XML file as it has been received by Routty.

  • transformed: the XML file after it has been transformed to the UBL format by Routty.

  • enriched: the XML file after it has been enriched by Routty. Enriched documents contain the UBL along with extra information about the identified Company and Business Partner.

  • output: the XML file after it has been transformed to the output format the output connector (ERP, CRM,…)requires .

The XML file that has been received by Routty may contain one or multiple attachments. Routty will extract these attachments and make them available for download.

The audit logs provide a detailed overview of all the processing (automatic and manual) steps for a particular document.


The Enriched XML document

One of the version of the document is the enriched XML, since this is the basis for the output mapping this section gives some further details on how this enriched document is structured.

Format

Field

Description

Attachments

List of attachments added in Routty.

This is a subset of all attachments, inside the result of the input mapping can be added any other attachments.

Metadata

Any additional metadata generated by Routty will be placed under this tag

Metadata.Channel

The Channel which was used to transfer this document between Company and BusinessPartner. For an inbound process this would be the receiving channel, for an outbound process this would be the sending channel.

Metadata.BusinessPartner

Either the customer or supplier, dependent on whether the documents is used in an inbound or an outbound flow.

This contains all data, which is known in the masterdata in Routty

Metadata.Company

The company of the Routty tenant, to which this document is linked.

This contains all data, which is known in the masterdata in Routty

Document

At this location the full result of the transformed XML is placed

Example

CODE
<RouttyDocument>
    <Attachments>
        <Attachment>
            <Type>Generated</Type>
            <Filename>generated.pdf</Filename>
            <MimeType>application/pdf</MimeType>
            <Data>JVBERi0x</Data>
        </Attachment>
    </Attachments>
    <Metadata>
        <Channel>
            <ChannelName>Peppol</ChannelName>
        </Channel>
        <BusinessPartner>
            <CrmNumber>1234567890</CrmNumber>
            <Name>Acme Corporation</Name>
            <CompanyGroupId>ACME-GRP</CompanyGroupId>
            <Street>Main Street</Street>
            <Number>100</Number>
            <PoBox>456</PoBox>
            <PostalCode>12345</PostalCode>
            <CountryCode>US</CountryCode>
            <Phone>+1-555-1234</Phone>
            <Email>contact@acme-corp.com</Email>
            <Identifiers>
                <Identifier>
                    <IdentifierType>VAT</IdentifierType>
                    <IdentifierValue>US123456789</IdentifierValue>
                </Identifier>
                <Identifier>
                    <IdentifierType>CBE</IdentifierType>
                    <IdentifierValue>123456789</IdentifierValue>
                </Identifier>
            </Identifiers>
            <IsMasterData>False</IsMasterData>
        </BusinessPartner>
        <Company>
            <CrmNumber>0987654321</CrmNumber>
            <Name>Globex Corporation</Name>
            <CompanyGroupId>GLOBEX</CompanyGroupId>
            <Street>Industrial Avenue</Street>
            <Number>200B</Number>
            <PoBox>789</PoBox>
            <PostalCode>67890</PostalCode>
            <CountryCode>US</CountryCode>
            <Phone>+1-555-5678</Phone>
            <Email>info@globex-corp.com</Email>
            <Identifiers>
                <Identifier>
                    <IdentifierType>CBE</IdentifierType>
                    <IdentifierValue>0987654321</IdentifierValue>
                </Identifier>
                <Identifier>
                    <IdentifierType>VAT</IdentifierType>
                    <IdentifierValue>US098765432</IdentifierValue>
                </Identifier>
            </Identifiers>
        </Company>
    </Metadata>
    <Document>
        <DocumentNumber>123</DocumentNumber>
    </Document>
</RouttyDocument>

In this example the transformed XML would look like

CODE
    <Document>
        <DocumentNumber>123</DocumentNumber>
    </Document>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.