Tracking Search Detail

From this screen you can read lots of details about an individual document. A very convenient and powerful option when you need to error-track a document is the ability to download the document the way it looked during all stages of the document flow. You can see how it looked when it came in from the sender, how it was transformed and how it was ultimately outputted to the destination location.

As an example for this guide, we have chosen a Purchase Invoice document.

The document details screen can be divided into several smaller sections, which will be described in detail below.

Show multiple documents

You can have multiple documents shown from your search result. This is be display with a box per document. 
To remove a document, click in the top-right corner of each document. When clicking this button, the document will be removed - and it will be reflected in the URL.

Action buttons

Depending a Link user's permissions, there will be some actions buttons available from the document detail page. Several of these are identical to the ones present on the document search result page and you can read about their possibilities in the Document action buttons section.

Files

Below the action buttons you can see each individual document as it appears in the document flow. For each document you have the option to either view it in the browser, or save a local copy. Some documents are also able to be viewed as a stylesheet, indicated by the 'Print' icon. 

The document flow runs from top to bottom, meaning 'Interchange In' contains the Ingoing document, while 'Interchange Out' contains the outgoing document. In the middle of the flow is the 'CDM'. The CDM document holds all the relevant data items for a certain type of document in a very structured manner. The good thing about using CDM documents in the middle of document conversion is that you are likely to be able to reuse your conversion logic.

Between the Interchanges and CDM are the messages. Depending on the format of the document being sent, these may be identical to the Interchange document. If a document has an envelope around it, this will have been removed in the 'Message In' file. 

The size shown to the right of each document refers to the size of the zipped document.

Clicking 'View' will open the document in a new tab in its raw format. 

Document

The document section contains information about the document. Depending on the document and its current status, some data may not be available. It also contains a shortcut to the distribution associated with the document. 

We will not go into too much detail about each specific piece of information here.

Document Type

The document type of the document is shown here, e.g. Purchase Invoice, Sales Order etc.

Created Date

Shows the date and time the document was created.

Document Number

A unique document number will be shown here. It may vary depending on the document type exactly which field it refers to.

Last Status

Shows the latest status of the document. 

Document Log

Document trace enabled from the Ingoing side. Is turned off by default.

Port Configuration

Click 'Show' to see data that have been configured on the receive pipeline. 

Context properties for Interchange

Metadata about the message, before being disassembled. Will only show if they have been saved by the system.

Context properties for Message

Metadata about the message, after being disassembled. Will only show if they have been saved by the system.

Originating System

System that communicates between the sender system and Link. 

Originating Id

The id of the transmission from the originating system.

Document Id

A unique id given to the document by Link.

Document Guid

A unique Id given to the document by Link.

Distribution Id

Displays the distribution id and contains a link to the distribution associated with the document.

Ingoing / Outgoing

The ingoing and outgoing sections contain information about the sender and receiver party. The data displayed here is dependent on the different partners involved in the document flow.

Partner

Shows the partner name. Click it to be redirected to the page for that partner.

Interchange Number

Will contain the interchange number, if message is in Edifact format. Otherwise it will be generated on the outgoing message.

Format/Variant/Version

Shows the format of the document. In the example above, the document is in a standard Edifact INVOIC D96A format. 

Address

Displays the address from where the document was sent, and where it was sent to.

Port Name

The name of the receive port if one exists. Otherwise a custom label.

Interchange Id

Generated interchange id. Mainly used for internal systems.

Transmission Id

Transmission Id is an ID which that is unique for an interchange.

Interchange Log File

Transport log file. Is only available on some protocols.

Message Number

Will contain the message number, if message is in Edifact format. Otherwise it will be generated on the outgoing message.

Message Number Out

It is present in the outgoing section as message number. The MessageNumberOut is a global auto generated sequence number that we are generating in the database. It is a value taken from the column Tracking.tDocuments.MessageNumberOut. It is an ID that is unique per document per transaction.  So, if a document is resent, it will have the same DocumentNumber as the original document, but it will have a new MessageNumberOut value. It is the value we use for UNH IDs in edifact documents. It is a sequential value, based on a cross data owner sequence. It can be used as part of document using 'Document value extactor Functoid' 

Tracking Fields

If any tracking fields have been configured for the document type, these can be shown here. Press 'Load tracking fields' to display them on the page. See the 'Tracking Fields' page in the user guide for more information on tracking fields.

Status Flow

At the bottom of the tracking search detail page is the status flow. This contains information about the various steps that have occurred in the document flow, such as messages being sent and received. This information is especially useful, if there are several servers involved in the document flow. Each step holds data about the current status of the document at that time, as well as a short description of what occurred. The status flow is displayed as a data grid, which means it supports standard sorting, filtering and grouping functionality.

By default only simple status types are displayed. If you need to have more technical status types displayed, you can tick the 'Include technical status types' [1] checkbox. The status flow will now show you all the steps involved in the document flow. 

It's recommended to read the Using data grids section to learn more about it's possibilities.

Additional Backup Files

The additional back files are used to save extra files, during the flow,  other than the default backup files (Interchange In, Message In, CDM, Message Out, and Interchange Out). The Additional files can be attached in 3 different levels: Interchange In, Document or Interchange Out depending on where in the flow the files are generated.  These files helps us in debug purpose or extra logging as well, so we may use it for further investigation in case if any document failed.

Existing Usage

At the moment it is used from AS4 for additional info, and from PGP component to save file in decrypted stage