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
At the top of the page several actions buttons are available. These allow you to perform actions on the currently viewed document.
Resend
By pressing the ‘Resend’ button, you will get the opportunity to resend the message.
Resending will force the original message to enter Link once more.
The is a number of options when you are resending.
| Info | ||
|---|---|---|
| ||
The step from Interchange In to Message In is called disassembling. The Interchange Infile is the file that arrived to Link. If the Interchange In file is a batch file, it will be de-batched in the disassemble step. |
If you don't mark any of the options, the Message In will be resend. (Look at the first screen dump to see where Message In is in the flow)
Resend by interchange
If you mark Resend by interchange, and resending the document(s) the flow will start at from the beginning with the disassembling step. If the incoming file is a batch of documents, the batch will be disassembled and all the document will go through Link again.
If the ingoing message is a EDIFACT, the same interchange number will be reused.
Resend bypass doublet check
If you mark Resend bypass doublet check, the duplicate check will not be executed on this message. That means that although there is a duplicate message to the resend message, you will not get a duplicate error.
Resend bypass test marking
If you mark Resend bypass test marking the document will be processed even though it is test marked. E.g. has Edifact a test mark property.
Resend by document log
The name should have been Resend with document log.
If you mark Resend by document log, an extended logging will be done. This log is called Document Log. This feature is mainly for the developer, who is debugging.
Resend generate new transmission Id
If you mark Resend generate new transmission Id, a new Transmission Id will be generated on the outgoing interchange, which might prevent the receiver from detecting duplicates.
Manually Handle
If you press this button, you will mark the document with the ‘Ignored’ status. Link will do nothing further.
Recreate
Sends a request to the sender system to send a new message. Requires a plugin to be implemented.
Delete
Clicking this will delete the document. A window asking whether you are sure about the deletion will appear. Press 'Ok' to delete the document. You will then be redirected back to the Tracking Search screen. Note that deleting a document is irreversible!
Show raw document details
This will display all technical details about the document. They will not be further explained here.
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 sizeTracking Search 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.
You can switch between the documents simply by clicking on them. To remove a document, click on the top-right corner of the corresponding box.
Overview
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 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 what you can do with them in the Document action buttons section.
Files
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. 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
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:
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.
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.
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. The number will be shown here. It may 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.
receiving partners.
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 labelthe transport 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.
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.
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.
To the right of the data grid you have several options available [2]. These are also described in detail on the 'Document search result' page in this guide.
Export
Clicking the export button will present you with a dropdown of two options:
- Export all data
- Export selected rows
These allow you to either export the entire data grid as it is presented, or a specific set of rows. To select a row, click the empty checkbox in the furthest left column. You can deselect a row by clicking it again.
The data grid will be downloaded as an .xslt file, which can then be opened in an Excel program.
Column Chooser
This option makes it possible to customize which columns should be displayed in the data grid. Some columns are selected by default. When selecting it, you will be presented with a small window that contains all the columns that are not currently in use.
You can scroll while hovering your mouse over window box to see additional columns. To insert a new column you must drag it from the window to to the data grid. A blue line will appear when dragging, which means the column will be placed between the two columns. You can drag any column back to the window in the same manner.
Search
When data grids become too large, you may need to search for a specific document. The search box will perform its search on the entire data grid and will exclude the rows that do not match the search dynamically. Note that it is not possible to search for specific dates and time intervals.
Reset
Clicking this will reset the state of the grid to the default state. This means that all current sorting, grouping, filtering etc. will be reset. If you have placed or removed any columns via the column chooser, these will be reset as well. Any currently selected rows will be deselected.
Data Grid
There are several functions available on the data grid itself. These will be explained in more detail below.
Sorting
To sort the data, simply click on the column you wish to sort by. The first sorting done when clicked will be in ascending order. Click the column again to sort in descending order.
Grouping
Organizing data in groups can help you get a quick overview of your data set. To group your data, drag the desired column into the small space above the data grid, where this text is displayed: "Drag a column header here to group by that column". See the animation below for further reference.
After you have dragged and released the column, a new window will appear, showing how many items match each group. Click the small arrow to the left to expand each group and see the individual items. You can sort the groups by clicking on the group header.
To add more groups, simply use the same drag and drop method as explained. Each group will then contain several subgroups depending on how many groups you selected.
To return to the standard data grid, you can either drag the groups back onto the data grid, or click the 'Reset' button next to the Search bar.
Filtering
In order to exclude certain rows from the data grid you can make use of filtering. The filtering option is located to the right of the column name. By clicking it a window will appear, which show you the different values for the selected column. Click the checkbox next to the value to filter by it. 'Select All' will filter by all the values. See the animation below for further reference.
You can go back and change your filtering options, by clicking the filter icon again. To filter by more than one column, simply select the filter icon for each column you wish to filter by.
To reset the filtering, you can open the filtering options for each column and remove the checkboxes. Alternatively you can reset the entire data grid using the 'Reset' button next to the Search bar.
Pagination
If you include the technical status types, your status flow may include many items, which means the data may need to be split up into several pages. At the bottom left of the data grid you have the option to choose the number of items that should be displayed on a single page. You can display from 15 up to 1000 items on a single page.
You can navigate between pages in the bottom right of the data grid.
Additional Backup Files
for further investigation in case if any document failed.
Existing Usage
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.
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.
| Panel | ||
|---|---|---|
| ||
Content on this page:
|