Back-end integration legacy messages
The WebSphere Commerce offers support for messages which use the legacy message format. Unless we are migrating from a previous version of WebSphere Commerce Suite, IBM recommends using the XML messages instead, since they accomplish the same function, and are easier to read and maintain.
The format of the WebSphere Commerce messages consists of two sections: the message descriptor and the application data. In the case of inbound messages, the message descriptor contains control information required to operate, such as the message identity and type. The application data contains the information to be processed. All WebSphere Commerce messages consist of a set of tags and records in a logical sequence and defined data segments within the records. The <PROLOG>, <HDR>, <ITM>, and <DATUSR> records, which are included in the supported messages, adhere to the following format:
<TAG>DATA SEGMENT</TAG>
where the data segment is identified with a _DATA suffix. For instance, a record for the Order Create message looks like this:
<HDR010>ORDER_CREATE_HDR010_DATA</HDR010>
Each data segment (in this example, ORDER_CREATE_HDR010_DATA) must be replaced with specific field and database table information for the particular message.
The following table outlines the six supported messages, as well as the controller command called by each one:
Message Name Message Type Data Segment Controller Command Customer New Inbound
UserRegistration Add Customer Update Inbound
UserRegistration Update Order Create Outbound
- ORDER_CREATE_PROLOG_DATA
- ORDER_CREATE_HDR010_DATA
- ORDER_CREATE_HDR020_DATA
- ORDER_CREATE_HDR030_DATA
- ORDER_CREATE_HDR040_DATA
- DATUSR_DATA for outbound messages
- ORDER_CREATE_ITM010_DATA
SendWCSOrder Order Status Update Inbound
- ORDER_STATUS_UPDATE_PROLOG_DATA
- ORDER_STATUS_UPDATE_HDR010_DATA
- DATUSR_DATA for inbound messages
- ORDER_STATUS_UPDATE_ITM010_DATA
OrderStatus Product Price Update Inbound
ProductOffer PriceUpdate Product Quantity Update Inbound
ProductInventory Update
- NCCommon.mod - source file
WebSphere Commerce defines all inbound XML messages based on DTD files. Each DTD file consists of several XML elements and the NCCommon.mod file.- NCCustomer_10.mod - source file
WebSphere Commerce defines all inbound XML messages based on DTD files. Each DTD file consists of several XML elements and the NCCommon.mod file. In addition, the Create_NC_Customer_10.dtd and Update_NC_Customer_10.dtd files also include information from the NCCustomer10.mod customer common file.- NCCustomer_10.mod file
The NCCustomer_10.mod customer common file consists of customer information for new customers. It is used for both the Create_NC_Customer and Update_NC_Customer messages.- UserData element for inbound messages
All inbound messages include the UserData XML element as an optional element. Include the UserDataField element to transport additional data. We can customize the fields to pass extra data that is not included in the messages.- UserData element for outbound messages
The outbound XML message Report_NC_PurchaseOrder includes the UserData XML element as an optional element. Include the UserDataField element in this message to send additional data. We can customize the fields to pass extra data that is not included in the messages.- Customer New message
The Customer New message is a legacy format inbound message that contains customer information for a customer. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message. WebSphere Commerce updates information for a new customer by calling the UserRegistrationAdd controller command.- Customer Update message
The Customer Update message is an inbound message that contains customer information for a customer. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message. WebSphere Commerce updates information for a registered customer by calling the UserRegistrationUpdate command.- Order Create message
The Order Create message is an outbound message that contains order details for a completed order. The WebSphere Commerce system generates this message and sends its data to an outbound message queue, where a back-end system receives the message. This application takes the message and continues any back-end business processes required to complete the specified task for the order. Use Order Create to fulfill the order process of orders that begin with the WebSphere Commerce system, but also require some additional or back-end work by a separate system.- Order Status Update message
The Order Status Update message is an inbound message that contains status information for a WebSphere Commerce order. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message. WebSphere Commerce uses the OrderStatus command to update the tables ORDSTAT and ORDISTAT with the new order status information.- Product Price Update message
The Product Price Update message is an inbound message that contains price information for a product. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue. When the WebSphere Commerce system receives the message, it runs the ProductOfferPriceUpdate command.- Product Quantity Update message
The Product Quantity Update message is an inbound message that contains inventory information for a product. A back-end application generates this message and sends it to the WebSphere Commerce inbound message queue, where the WebSphere Commerce system receives the message.
Related concepts
Order notification
Related reference
Outbound message extension for order create messages