ESIError
The ESIError schema provides the interface into theWindchill ESI error-handling shared service. It must be populated with the required information when the error-handling service is invoked. The following is a description of the ESIError schema.
Element | Description | ||
|---|---|---|---|
ProcessData | Top level node for all process data that is passed in with the error. Contains the following elements: ObjectHeader The ObjectHeader of the object currently being processed when the error occurred. WCID Unique identifier for the object that was being processed when the error occurred; internal to Windchill PDMLink ObjectNumber The object number of the object being processed at time of error. This is a generic field for any object. For example, for parts, PartNumber would be mapped; for BOMs, AssemblyPartNumber; for documents, DocumentNumber; for CNs, ChangeNumber. ControlData The control data for the Common Business Object which was being processed during an error. | ||
ErrorDetails | Contains information specific to the error. Contains the following elements: MessageCode A five-digit code that corresponds with the message that is being logged for this error. This value is cross-referenced in the ESIMessageLookups.properties file to log the error message text. Also, for the error handling process, this is used to lookup the handling code of the error in the ESIErrorHandlingCodes.properties file. Refer to the Message Logging, Error Handling, and Return Messaging section for details.
Type A one-character code that describes the type of the error. See Type section for details on the possible codes. Application A one-character code that describes the application that caused the error. See Application section for details on codes for specific applications. Root Cause The five-digit message code that corresponds to a root cause message. This will give users additional hints or tips on the error or where to find additional information. EAIAdditionalInformation The actual error string. Typically, if an error occurs, TIBCO BusinessWorks forms a schema called _error. This contains the Error Message, the Stack Trace of the Error, and the Data of the process that errored. For EAI software components, the StackTrace is mapped to this field to provide the most information possible. ExtraInformation This is for customization use. |
Element | Description | ||
|---|---|---|---|
ProcessData | Top level node for all process data that is passed in with the error. Contains the following elements: ObjectHeader The ObjectHeader of the object currently being processed when the error occurred. WCID Unique identifier for the object that was being processed when the error occurred; internal to Windchill PDMLink ObjectNumber The object number of the object being processed at time of error. This is a generic field for any object. Example, for parts, PartNumber would be mapped; for BOMs, AssemblyPartNumber; for documents, DocumentNumber; for CNs, ChangeNumber. ControlData The control data for the Common Business Object which was being processed during an error. | ||
ErrorDetails | Contains information specific to the error. Contains the following elements: MessageCode A five-digit code that corresponds to the message that is being logged for this error. This value is cross-referenced in the ESIORAMessageLookups.properties file to log the error message text. Also, for the error handling process, this is used to lookup the handling code of the error in the ESIErrorHandlingCodes.properties file. Refer to the Message Logging, Error Handling, and Return Messaging section for details.
Type A one-character code that describes the type of the error. See Type section for details on the possible codes. Application A one-character code that describes the application that caused the error. See Application section for details on codes for specific applications. |
Element | Description |
|---|---|
ErrorDetails | EAIPrimary The five-digit message code corresponding to the primary message to be sent to Windchill in the PostResult message. For more information, see Message Logging, Error Handling, and Return Messaging. EAISecondary The five-digit message code corresponding to a functional decision or functional warning message to be sent to Windchill. For more information, see Message Logging, Error Handling, and Return Messaging. ERPPrimary Primary return information from the ERP system. ERPSecondary Secondary return information from the ERP system. Root Cause The five-digit message code that corresponds to a root cause message. This will give users additional hints or tips on the error or where to find additional information. EAIAdditionalInformation The actual error string. Typically, if an error occurs, TIBCO BusinessWorks forms a schema called _error. This contains the Error Message, the Stack Trace of the Error, and the Data of the process that errored. For EAI software components, the StackTrace is mapped to this field to provide the most information possible. ExtraInformation This is for customization use. |