Error Messages
When configuring asynchronous messages, various errors may be encountered. These errors point to issues with message file validation, data configuration, duplicate files, adapter issues, authorization failures, or database look-up failures (such as look-ups for missing product master data attributes triggered by a look-up code in the file).
Where are errors found in the UI?
Errors are found in the TraceLink UI in the Info Exchange app. Filter errors by error type under the Processing Status drop-down option. To display the actual error, select the hyperlinked error type associated with the designated message (see the image below for an example).
| Date - Time | Processing Code Review Status |
Output File Name | Output File Format | Actions | |
|---|---|---|---|---|---|
|
28 Dec 2015 - 03:49 PM | Map in Failed
-- |
-- | -- | -- |
|
|
22 Dec 2015 - 02:10 PM | Processing Failed
-- |
-- | -- | -- |
|
08 Sep 2016 - 05:00 PM | Needs Investigation
-- |
-- | -- | -- |
|
30 Apr 2014 - 08:04 PM |
Map Out Failed -- |
-- | -- | -- |
|
|
24 Mar 2024 - 12:47 PM | Delivery Failed
-- |
PickShipASN1490359607588.73875FIfH.738750bw4.73875nxTz |
X12 | -- |
What do the errors look like and how are they interpreted?
The example below reflects a "Map In" error type with errors identified in both the "Input" and "Output" (see Scope).
The following information is useful for interpreting errors:
- The Scope (indicated in red below) identifies whether the error is in the input or output.
- The error message is defined by the Description (indicated in yellow below). This provides some context as to why the error occurred. The Detail fields may also prove useful when troubleshooting errors in submitted data.
- Depending on the type of error, the InputAddress, OutputAddress, InterfacePath, and/or Value information identifies the full path to the field and instance of that field that triggered the error to assist with troubleshooting.
The following error examples illustrate what an error may look like in the TraceLink application:
MapInput:
ERRORS
ID: Input_Presentation_Mismatch
Severity: Error
Category: Input_Data_Error
Description: Cannot parse input data according to the presentation.
Scope: Input
Detail[Input Path]: SNXDispositionAssignedMessage | MessageBody | choice_1[0] | CommissionEvent | CommissionEventDetail[0] | EventDateTime
Detail[Input Data]: 2015-04621T08:18:00.140Z
Detail[Type]: DateTime - General Characters & XML Schema
Detail[Presentation]: YYYY-MM-DDThh:mm:ss[.sss][-hh:mm] - 2003-06-15T13:20:00.000-05:00
Detail[Error Name]: Presentation_Mismatch
InputAddress
InterfacePath: SNXDispositionAssignedMessage | MessageBody | choice_1[0] | CommissionEvent | CommissionEventDetail[0] | EventDateTime
XPath:
ParentElement: false
Value: /SNXDispositionAssignedMessage/MessageBody[1]/snx:CommissionEvent[1]/snx:CommissionEventDetail[1]/cmn:EventDateTime[1]/EventDateTime
OutputAddress
XPath:
ParentElement: false
Value: /can:CanonicalSNXDispositionAssignedEventType/can:MessageBody[1]/can:CommissionEvent[1]/can:CommissionEventDetail[1]/cmn:EventDateTime[1]
ID: Empty_Tag_Creation_For_Output_Field
Severity: Error
Category: Output_Data_Error
Description: An empty tag was created for a target field, but an empty tag is not valid data for the field.
Scope: Output
Detail[Output Path]: CanonicalSNXDispositionAssignedEventType | MessageBody | choice_1[*] | CommissionEvent | CommissionEventDetail[*] | EventDateTime
Detail[Minimum Target Iteration Count]: 1
Detail[Actual Iteration Count]: 0
OutputAddress
InterfacePath: 1
XPath:
ParentElement: false
Value: /can:CanonicalSNXDispositionAssignedEventType/can:MessageBody[1]/can:CommissionEvent[1]/can:CommissionEventDetail[1]/cmn:EventDateTime[1]
What are the different error types?
The following provides a brief description of each TraceLink error type:
Map In Failed - Class 1 Errors
This is the first step in the validation process as a file is received by TraceLink. This error is most often caused when required data is either missing or incorrect. This failure indicates that the file was poorly structured (e.g. data elements are in an incorrect order) or contained other errors that prevented TraceLink from integrating and processing the file. These instances trigger schema validation errors. In short, this error indicates that an inbound message has failed data translation. Map In Failed and Map Out Failed may also point to system errors in the map call.
An inbound message is designed to convert an external party’s data format to Tracelink's format. The external party sends data to Tracelink for data transformation, therefore Tracelink is the recipient of the data.
Processing Failed - Class 2 Errors
This is considered the second step in the validation process and generally where all of the business logic is found. This error indicates a failure at any point in a transformation document life cycle (e.g. transmission failure or back end code failure).
Map Out Failed
This step is when TraceLink maps the outbound data, converting it into the receiving party's preferred format. Sometimes the rules can vary based on the file format. This error indicates an outbound message has failed at some point in this data conversion process. Map In Failed and Map Out Failed can also point to system errors in the map call.
Blocked
A blocked error indicates a system blockage or processing failure.
Needs Investigation
This error indicates a processing error or message data translation failure. This error type requires investigation to determine the root of failure. Often, this error occurs when the system believes it is receiving a duplicate file.
TraceLink does have the ability to push these errors through manually.
What are the different error classes?
There are three classes of errors that are pertinent to asynchronous integration:
Class 1 Errors
Class 1 errors are mapping validation errors. These errors fall under the "Map In" error type. This is where the data structure of the message is validated (e.g. where data type information or an element's required or optional requirement is validated. Map In errors are returned if there is an issue with this first validation step. For example, if a required field is omitted, a class 1 error results.
Class 2 Errors
Class 2 errors are data translation errors which can be found in the "Processing Failed" category of errors. A Processing Failed error type indicates that the map failed to translate to TraceLink's internal format and therefore cannot hit the back end API. Think of this second step as an "integrity check" against the submitted data. For example, if a serial number is submitted but is assigned to an incorrect product code, an error results. Another example is if a certain event (such as Commission) is submitted, but the serial number included in that event is unrecognized, an error results. The following are some class 2 error examples:
| System Validation | Error |
|---|---|
| Serial Number does not exist. | Serial number [Serial Number] does not exist. |
| Serial Number is associated to a company or location that differs from the company or location shown in Show Data from. | Location [Location Name] was not valid for serial number [Serial Number]. |
| Serial Number has a parent. | Operation could not be performed because serial number (child serial number) and serial number (container serial number) are currently in different states or the operation would result in them having different states. Parent and child serial numbers are not permitted to be in different states. |
| Serial Number cannot be updated from its current state to the new state. | Cannot perform operation on serial number [serial number] with item state/serial number state [item state/serial number state]. This operation can only be performed when: [List of item states separated by "or"]. |
Class 3 Errors
Class 3 errors occur when data translation to a third party (Trade Partner) fails due to an internal server error. Class 3 errors are rare, though they may still occur due to missing or incorrect information in the Master Data. The troubleshooting recommendation for Class 3 errors is to first check Master Data, make appropriate edits, and then resubmit the designated file. If Master Data is correctly configured, contact Support for further assistance.
Where is error information found in this Guide?
Error Information is provided in each message's Errors section, as errors are message-specific:
The Errors table displays all potential errors that may be encountered for a message. In the "Description" column, the term "source" is used to refer to the specific element in question. For example, in the description for the cmn:PartnerId element below, "source" refers to cmn:ParterId itself. No value has been provided for this element, therefore triggering the error message.
See Error Messages before interpreting/troubleshooting a message.
| Data Element | Error Message | Description |
|---|---|---|
| Class 1 | ||
| cmn:DeliveryLocation | @type | DeliveryLocation type attribute is required when source delivery location is populated !!! | The error occurs if cmn:DeliveryLocation is populated, but the source is empty or null. |
| Valid delivery location type is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. | |
| cmn:PartnerId | @type | Party type attribute is required when source partner Id is populated !!! | The error occurs if cmn:PartnerId is populated, but the source is empty or null. |
| Valid partner identifier type is required !!! | The error occurs if the source is present, but there is no matching entry in the lookup file. | |
| cmn:DeliveryDirection | Delivery direction of Sent or Received is required !!! | The error occurs if the source is empty or null. |
| cmn:PartnerId | Partner identifier is required for delivery direction Received !!! | The error occurs if DeliveryDirection = Received, but the source is empty or null. |
| Class 2 | ||
| cmn:DeliveryNumber | Delivery [Delivery Number]: Shipment transaction for specified delivery number must be a sales shipment. Transfer shipment may not be voided. | The error occurs if the source refers to a transfer shipment instead of a sales shipment. |
| Delivery [Delivery Number]: Shipment transaction for specified delivery number has not been submitted. | The error occurs if the source does not refer to a shipment in a submitted state. | |
| Delivery [Delivery Number]: The serial numbers for the specified deliver must be in a Commissioned - Shipped state. | The error occurs if serial numbers are not in a Commissioned - Shipped state. | |
| Class 3 | ||
| The following is thrown for all Class 3 errors: “INTERNALERROR=Internal error from server [server details].” Please contact Support if this error is encountered. | ||
