The WebSphere Commerce offers support for messages which use the legacy message format. Unless you are migrating from a previous version of WebSphere Commerce Suite, it is recommended that you use 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 | CUSTOMER_NEW_PROLOG_DATA CUSTOMER_NEW_HDR010_DATA DATUSR_DATA for inbound messages |
UserRegistration Add |
Customer Update | Inbound | CUSTOMER_UPDATE_PROLOG_DATA CUSTOMER_UPDATE_HDR010_DATA DATUSR_DATA for inbound messages |
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 | PRODUCT_PRICE_UPDATE_PROLOG_DATA PRODUCT_PRICE_UPDATE_HDR010_DATA |
ProductOffer PriceUpdate |
Product Quantity Update | Inbound | PRODUCT_QUANTITY_UPDATE_PROLOG_DATA PRODUCT_QUANTITY_UPDATE_HDR010_DATA |
ProductInventory Update |