Company Administration Processing Response Guidelines
See How To Use this Guide before interpreting the guidelines below.
Message Type: IE_PROCESSING_RESPONSE
Info Exchange Display Name: Processing Response
These fields are sent by TraceLink back to the sender of the initiating message.
When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value. The Company Administration message supported by Processing Response is CreateServiceLink.| Data Element | Occurs | Format | Length | Enum | Req | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ie:IEProcessingAckMessage | 1...1 | - | - | - | M | Root element of message. | |||||||||
| ie:ControlFileHeader | 1...1 | - | - | - | M | XML file control header record. | |||||||||
| cmn:FileSenderNumber | 1...1 | String | 1/20 | - | M | File sender's company identifier.1 | |||||||||
| cmn:FileReceiverNumber | 1...1 | String | 1/20 | - | M | File recipient's company identifier.2 | |||||||||
| cmn:FileControlNumber | 1...1 | String | 1/* | - | M | Unique file control ID number.3 | |||||||||
| cmn:FileDate | 1...1 | Date | 10/10 | - | M | Date file generated in XML YYYY-MM-DD format.4 | |||||||||
| cmn:FileTime | 1...1 | Time | 9/9 | - | M | Time file generated in XML HH:MM:SSZ format (must be GMT).5 | |||||||||
| ie:MessageBody | 1...1 | - | - | - | M | Main body of message. | |||||||||
| ie:ProcessingResultsHeader | 1...1 | - | - | - | M | Provides identification of the processed message with information from the original message header, including message type, original message identifier, message sender and receiver identifiers, and original message date and time. | |||||||||
| ie:InputFileTransactionType | 1...1 | String | 1/* | TransactionType | M | Transaction type of the processed
message. Valid value:6
|
|||||||||
| ie:InputFileSenderNumber | 1...1 | String | 1/20 | - | M | FileSenderNumber that was provided in the processed message.7 | |||||||||
| ie:InputFileReceiverNumber | 1...1 | String | 1/20 | - | M | FileReceiverNumber that was provided in the processed message.8 | |||||||||
| ie:InputFileControlNumber | 1...1 | String | 1/* | - | M | FileControlNumber that was provided in the processed message.9 | |||||||||
| ie:InputFileDate | 1...1 | Date | 10/10 | - | M | FileDate that was provided in the processed message in XML YYYY-MM-DD format.10 | |||||||||
| ie:InputFileTime | 1...1 | Time | 9/9 | - | M | FileTime that was provided in the processed message in XML HH:MM:SSZ format.11 | |||||||||
| ie:ProcessingResults | 1...1 | - | - | - | M | Provides the processing results of
the message with a summary of:
For each of these categories, the system returns an "item spec" with identifying information about each item processed, the processing code, and the processing message. |
|||||||||
| ie:ProcessingSummary | 1...1 | - | - | - | M | Provides the processing results of
the message with a summary of:
|
|||||||||
| ie:TotalUpdated | 1...1 | Integer | - | - | M | The total number of items from the originating message that were updated by the system. | |||||||||
| ie:TotalProcessedNoWarning | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were updated without warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedNoWarning element will be populated with the item spec containing identifying information about each item processed including the processing code. | |||||||||
| ie:TotalProcessedWithWarning | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were updated with warning. This is a subset of TotalUpdated. If this value is greater than zero, the ProcessedWithWarning element will be populated with the item spec containing identifying information about each item that had a warning, including the processing code and processing message. | |||||||||
| ie:TotalFailed | 1...1 | Integer | - | - | M | The total number of updated items from the originating message that were not updated as a result of errors. If this value is greater than zero, the FailedItem element will be populated with the item spec containing identifying information about each item that failed, including the processing code and processing message. | |||||||||
| ie:ProcessedNoWarning | 0...1 | - | - | - | C | This element contains one item spec with the processing code for each item updated without warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of ie:TotalProcessedNoWarning. If ie:TotalProcessedNoWarning = 0, ie:ProcessedNoWarning will not be populated. | |||||||||
| ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with the processing code for each item updated without warning. | |||||||||
| ie:ADM_CreateServiceLinkSpec | 0...1 | - | - | - | O | Use for the Administration Create Service Link message. Contains information required to create a ServiceLink for a trade partner to become a subscriber to a specific Service published by the company.
To create multiple ServiceLinks to one or more Services, repeat the CreateServiceLink element, one for each trade partner / Service combination. |
|||||||||
| cmn:ServiceId | 1...1 | String | 1/* | - | M | The Service Identifier for the Service to which a ServiceLink subscriber is added, exactly as it appears in the Published Service Settings.12 | |||||||||
| cmn:PartnerId | 1...1 | String | 1/* | - | M | Identifier of the trade partner that is a ServiceLink subscriber to the Service. cmn:PartnerId and @type must match an identifier configured in Service Partners (e.g. the Manage Partners Admin screen).13 | |||||||||
| @type | 1...1 | String | 1/* | Location | O |
Attribute identifying the trade partner identifier type. Valid values:14
|
|||||||||
| cmn:Email | 1...1 | String | 1/* | - | M | The business email address of the person designated as the ServiceLink Admin for the trade partner company. This person is permitted to add additional users at the trade partner company to access the ServiceLink.
If the email address does not have a matching user account in the trade partner company, the Company Administrator receives the notification regarding the creation of the ServiceLink. If the trade partner does not yet have a Company Adminstrator, an email is sent to the provided email address with instructions for how to contact TraceLink support to activate a user account.15 |
|||||||||
| ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning.16 | |||||||||
| ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. | |||||||||
| ie:ProcessedWithWarning | 0...1 | - | - | - | O | This element contains one item spec with processing code and processing message for each item updated with warning. The item spec contains identifying information about each item processed. The number of item specs will be equal to the value of TotalProcessedWithWarning. If TotalProcessedWithWarning = 0, ProcessedWithWarning will not be populated. The items specs that follow use the exact same item specs as described above. | |||||||||
| ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with the processing code for each item updated with warning. | |||||||||
| ie:ADM_CreateServiceLinkSpec | 0...1 | - | - | - | O | Use for the Administration Create Service Link message. Contains information required to create a ServiceLink for a trade partner to become a subscriber to a specific Service published by the company.
To create multiple ServiceLinks to one or more Services, repeat the CreateServiceLink element, one for each trade partner / Service combination. |
|||||||||
| cmn:ServiceId | 1...1 | String | 1/* | - | M | The Service Identifier for the Service to which a ServiceLink subscriber is added, exactly as it appears in the Published Service Settings.17 | |||||||||
| cmn:PartnerId | 1...1 | String | 1/* | - | M | Identifier of the trade partner that is a ServiceLink subscriber to the Service. cmn:PartnerId and @type must match an identifier configured in Service Partners (e.g. the Manage Partners Admin screen).18 | |||||||||
| @type | 1...1 | String | 1/* | Location | O |
Attribute identifying the trade partner identifier type. Valid values:19
|
|||||||||
| cmn:Email | 1...1 | String | 1/* | - | M | The business email address of the person designated as the ServiceLink Admin for the trade partner company. This person is permitted to add additional users at the trade partner company to access the ServiceLink.
If the email address does not have a matching user account in the trade partner company, the Company Administrator receives the notification regarding the creation of the ServiceLink. If the trade partner does not yet have a Company Adminstrator, an email is sent to the provided email address with instructions for how to contact TraceLink support to activate a user account.20 |
|||||||||
| ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning.21 | |||||||||
| ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. | |||||||||
| ie:FailedItem | 0...1 | - | - | - | O | This element contains one item spec with processing code and processing message for each item that failed to be updated. The item spec contains identifying information about each item that failed The number of item specs will be equal to the value of TotalFailed. If TotalFailed = 0, ie: FailedItem will not be populated. | |||||||||
| ie:ProcessedItem | 1...* | - | - | - | M | List of one or more item specs with the processing code for each item that failed to be updated. | |||||||||
| ie:ADM_CreateServiceLinkSpec | 0...1 | - | - | - | O | Use for the Administration Create Service Link message. Contains information required to create a ServiceLink for a trade partner to become a subscriber to a specific Service published by the company.
To create multiple ServiceLinks to one or more Services, repeat the CreateServiceLink element, one for each trade partner / Service combination. |
|||||||||
| cmn:ServiceId | 1...1 | String | 1/* | - | M | The Service Identifier for the Service to which a ServiceLink subscriber is added, exactly as it appears in the Published Service Settings.22 | |||||||||
| cmn:PartnerId | 1...1 | String | 1/* | - | M | Identifier of the trade partner that is a ServiceLink subscriber to the Service. cmn:PartnerId and @type must match an identifier configured in Service Partners (e.g. the Manage Partners Admin screen).23 | |||||||||
| @type | 1...1 | String | 1/* | Location | O |
Attribute identifying the trade partner identifier type. Valid values:24
|
|||||||||
| cmn:Email | 1...1 | String | 1/* | - | M | The business email address of the person designated as the ServiceLink Admin for the trade partner company. This person is permitted to add additional users at the trade partner company to access the ServiceLink.
If the email address does not have a matching user account in the trade partner company, the Company Administrator receives the notification regarding the creation of the ServiceLink. If the trade partner does not yet have a Company Adminstrator, an email is sent to the provided email address with instructions for how to contact TraceLink support to activate a user account.25 |
|||||||||
| ie:ProcessingCode | 1...1 | String | 1/* | - | M | The processing code assigned by the system to indicate the success, failure, or warning.26 | |||||||||
| ie:ProcessingMessage | 0...* | String | 1/* | - | O | The processing message with detail on why the item in the item spec incurred a warning or failure. | |||||||||
