- Created by Karsten Markmann, last modified by Nicolai Krog on Jan 12, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
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.
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:
TODO: INSERT SCREENSHOT ETC. WITH HUMAN READABLE EXAMPLE
Additional Files
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.
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.
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 varies depending on the document type exactly which field it refers to.
Last Status
Shows the status of the document.
Init Configuration
This field is intended only for advanced users / developers and contains the document configuration when it entered Link.
Context properties for Interchange
This 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
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.
Document Id
A unique id given to the document by Link.
Document Guid
A unique 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 partners.
Partner
Shows the partner name. Click it to be redirected to the page for that partner.
Interchange 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.
Format/Variant/Version
Shows the format, variant and version of the document.
Address
Displays the address from where the document was received / sent. The format will vary upon the protocol used.
Port Name
Displays the name of the transport location that was used when receiving / sending the document.
Interchange Id
Auto-generated interchange id. Mainly used for internal systems.
Transmission Id
Id of the transmission. Only supported by some transport types.
Interchange Log File
Transport log file. Is only available on some protocols - in the example above, an SFTP-log file is available for the sending of the document.
Message Number
If the incoming message format supports message 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. It's recommended to read the Using data grids section if you are unfamiliar with this.
By default the list is only showing simple logging. If you need to have more technical logging info displayed, you can tick the 'Include technical status types' checkbox.
Status events
Status events is an advanced topic that aren't relevant in all Link setups. If you are not familiar with this concept you can read more in the Status events article.
It there are any associated status events with the document, they can be loaded by clicking the "Load status events" symbol.
This will give you a grid showing the associated status events as well as a few action buttons.
Here we will refer to the Status event result section where both grid content and buttons are explained in detail.
Content on this page:
- No labels