Tracking Search Details

Note that through the Document search result screen, you might have selected to view several documents together. In this case, the individual documents are visible as separate boxes in the top of the screen:

You can switch between the documents simply by clicking on them. To remove a document, click in the top-right corner of the corresponding box. 

Overview

The document detail page. There is quite a lot of information here, and there are also many different actions and functionalities available.

If a document has the "Failed status", there will be even more information available - this is described in the Failed documents section. If you would like to read more about our proposed way of troubleshooting failed documents, we recommend that you read the How to handle errors article.

Some users might be confused by the vast amount of information presented here - lots of it is even rather technical. But one of Link's key strengths are exactly that it provides very detailed information in presented in one place, and we are in this article going to go through all the sections, files, fields and logs shown on the screen from top to bottom.

Action buttons

Depending a Link user's permissions, there will be action 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

This section of the screen gives you the ability to download and view the document in the different ways it looked during all stages of the document flow. If you are not familiar with these concepts, we recommend that you read the Document stages article.

You can download the state of the document for each stage by clicking "Save" - if you'd like to just quickly view it, you can click "View. It is also possible to inspect the document in a more human readable format by clicking "Print". The "Print" option however, is only available if this has been correctly set up. Developers can read about how to set this up in the TODO: INSERT LINK section under "Developer". The "Size" field shown to the right of each document refers to the size of the zipped document.

Image Added

In this example, a sales order was received in EDIFACT format and sent in a custom XML format. We can compare them by clicking "View" on the "Interchange In" and "Interchange Out" rows:

It is also possible to inspect the document in a more human readable format by clicking ???? TODO

Developers can read about how to set this up in the TODO: INSERT LINK section under "Developer".

TODO: INSERT SCREENSHOT ETC. WITH HUMAN READABLE EXAMPLE

Additional Files

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. 

Image Removed

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 This section is intended only for advanced users / developers. 

Each row in the list gives additional logging information for each step which is useful for developers troubleshooting advanced integration scenarios.

Image Added

Document

The Document section contains detailed 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.

Image RemovedImage Added

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 varies 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

Init Configuration

This field is intended only for advanced users / developers and contains the document configuration when it entered Link.

Context properties for Interchange

Metadata about the messageThis field is intended only for advanced users / developers and contains metadata for the interchange, before being disassembled. Will only show if they have been saved by the system.

Context properties for Message

Metadata This field is intended only for advanced users / developers and contains 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 GUID 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.

Image RemovedImage Added

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 If the incoming message format supports interchange number (e.g. EDIFACT and X12) it will be shown here. In other cases, it will be auto-generated on the outgoing message.

Format/Variant/Version

Shows the format, variant and version 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 toreceived / sent. The format will vary upon the protocol used.

Port Name

The Displays the name of the receive port if one exists. Otherwise a custom labelthe transport location that was used when receiving / sending the document.

Interchange Id

Generated Auto-generated interchange id. Mainly used for internal systems.

Transmission Id

Transmission Id is an ID which that is unique for an interchangeId of the transmission. Only supported by some transport types.

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' - in the example above, an SFTP-log file is available for the sending of the document.

Image Added

Message Number

If the incoming message format supports interchange number (e.g. EDIFACT and X12) it will be shown here. In other cases, it will be auto-generated on the outgoing message.

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.Image Removed It's recommended to read the Using data grids section if you are unfamiliar with this.

Image Added

By default the list is only showing simple status types are displayedlogging. If you need to have more technical status types logging info 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 

Status events