Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Tracking Search
DetailFrom 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.Details
Please note that through the Document search result screen, you may have selected to view several documents together. In this case, the individual documents are visible as separate boxes in the top of the screen, as shown in the figure below.
Image Added
You can switch between the documents simply by clicking on them. To remove a document, click in on the top-right corner of each document. When clicking this button, the document will be removed - and it will be reflected in the URL.Image Removedthe corresponding box.
Overview
Image Added
There is a a lot of information on the document detail page as well as many different possible actions and available features.
If a document has a "Failed status", there will be more information available for that document. Read more in the Failed documents section. If you would like to read more about how to troubleshoot failed documents, please read the Self-service support for the business article.
Some users might be confused by the amount of information presented here - lots of it is pretty technical. But one of Link's key strengths is that it provides very detailed information - all presented in one place. Here we´ll 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 some actions 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 what you can do with them in the Document action buttons section.
Image Added
Files
Below the action buttons you can see each individual document as it appears in Image Added
This section of the screen gives you the ability to download and view the document in all the different ways it looked during each stage of 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 If you are not familiar with these concepts, please read the Document stages article.
You can download the state of the document for each stage by clicking "Save". If you just want to view it, click "View. You can also view the document in a more reader friendly format by clicking "Print". The "Print" option however, is only available if it has been correctly set up. Developers can read about how to set this the "Print" option in the Link technical guide. The "Size" field 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
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:
Image AddedImage Added
Additional Files
This section is intended only for advanced users/developers.
Each row on the list shows 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 This option show the document type of the document is shown here, e.g. Purchase Invoice, Sales Order etc.
Created Date
Shows This options shows the time and date and time the document was created.
Document Number
A This option shows the unique document number will be shown here. It may vary . The number will vary, depending on the document type and exactly which field it refers to.
Last Status
Shows the latest This option shows the last recorded 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.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 message, This field is intended only for advanced users/developers and contains metadata for the interchange before being disassembled. Will This information will only show if they have it has 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 This information will only show if they have it has 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
IdA unique id givenID
This option will display a unique ID assigned to the document by Link.
Document
GuidA unique Id givenGUID
This option shows the unique GUID assigned to the document by Link.
Distribution
IdID
Displays This option 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 Removedreceiving partners.
Image Added
Partner
Shows This section shows the partner name. Click it to be redirected to the page for assigned to that partner.
Interchange Number
Will contain the interchange number, if message is in Edifact format. Otherwise it will be generated on 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 for the outgoing message.
Format/Variant/Version
Shows This section 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 This section displays the address from where the document was sent, and where it was sent to.received/sent. The format will vary upon the used protocol.
Port Name
The This section displays the name of the receive port if one exists. Otherwise a custom labeltransport location that was used when receiving/sending the document.
Interchange Id
Generated interchange id. Mainly This section displayed the auto-generated interchange ID and is mainly used for internal systems.
Transmission Id
Transmission Id is an ID which that is unique for an interchangeThis section displays the ID of the transmission and is only supported by some transport types.
Interchange Log File
Transport This section displays the transport log file . Is and is only available on for 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 message number (e.g. EDIFACT and X12) it will be shown here. In other cases, it will be auto-generated for the outgoing message.
Tracking Fields
If any tracking fields have been configured for the document type, these can be shown here. Press Click 'Load tracking fields' to display them on the page. See the 'Tracking Fields' page Read 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 contains 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. Please read the Data grids section if you are unfamiliar with this.
Image RemovedImage Added
By default, this list only shows simple status types are displayedlogging. If you need to have more technical status types logging info to be displayed, you can tick check 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 stagecheckbox.
Status events
Status events is an advanced topic that is not 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.
Image Added
This will give you a grid showing the associated status events as well as a few action buttons.
Image Added
Here we will refer to the Status event result section where both grid content and buttons are explained in detail.
Panel | ||
---|---|---|
| ||
Content on this page:
|