Configuration Manager - Commerce - Messaging

To enable messaging, use the Messaging page of the Configuration Manager.

User Template File
Enter the name of the XML message template definition file where you define new inbound XML messages. Enter the file name with no path information. WebSphere Commerce searches the application's class path for this file with the directory listed as the Template Path (default value, messaging).
For example, if you use the default value, the runtime searches for messaging/user_template.xml in the application's class path. The default file that is used by the class loader is,
WC_profiledir/installedApps/cell_name/WC_instance_name.ear/xml/messaging/user_template.xml
.

The WC_profiledir/installedApps/cell_name/WC_instance_name.ear/xml directory is defined in the WebSphere Commerce application's class path.

Add a TemplateDocument and a TemplateTag node to this file for each new XML message that you want to support.

IBM recommends that you use the following default user template definition file: user_template.xml

After you update your WebSphere Commerce configuration to use a new User Template File, you must update the EAR file with the new template XML file. To update the EAR file, see Ways to update application files.

For more information, see the following topics.
Inbound Message DTD Path
Enter a subdirectory of the class path where all the DTD files for inbound XML messages are found.

The subdirectory is created in the default directory, WC_installdir/wc.ear/xml/. For example, if the subdirectory that you entered is messaging, then the resulting path is WC_installdir/wc.ear/xml/messaging.

WebSphere Commerce automatically adds the default directory to the searched class path to locate the DTD files. For information about updating files DTD and template files, see the following topics.

If a separate directory is specified, ensure that the parent directory of this new location is included as part of the class path. If a new value is used, you must update the EAR with the new class path (if necessary) and the DTD files through the WebSphere Application Server administrative tools. For more information, see Ways to update application files.

Web Controller User ID
Enter the WebSphere Commerce ID that is used by WebSphere Commerce to execute all the inbound messages from the Listener for IBM MQ. Ensure that the ID has Site Administrator authority.

Ensure that only authorized persons have the authority to update the User Template File and System Template File fields since the inbound XML messages can be mapped to execute WebSphere Commerce commands by using this ID. The User Template File and System Template File are relative to the template path by default.

This ID is used when com.ibm.commerce.messaging.programadapter.security.DefaultCredentialsProgramAdapterSession ContextImpl is used for the SessionContext of a program adapter. For more information, see Program Adapter

System Template File
Enter the name of the XML message template definition file that contains the outline of all inbound XML messages that are supported by the Listener for IBM MQ.

This file defines the data fields for each message, mapping the message to the appropriate WebSphere Commerce controller command, and mapping each field within the message to the appropriate parameter for that command.

This file is also located by using the application's class path. The directory that is specified in Template Path is added to this file path when WebSphere Commerce searches for it.

IBM recommends that you use the following default system template definition file: sys_template.xml

After you create or update the template file, you must update the EAR file. For more information, see Ways to update application files.

Template Path

Enter a subdirectory of the class path where the User Template File and the System Template File are found.

If a separate directory is specified, ensure that the parent directory of this new location is included as part of the class path. If a new value is used, you must update the EAR with the new class path (if necessary) and the template files through the WebSphere Application Server. For more information, see Ways to update application files.

Inbound Message DTD Files
This is the list of the DTD and includes files for inbound XML messages. If you add a new inbound XML message, you need to add it in this field. These files are similar to Template Files, in that they are located by using the application's class path. The directory that is specified in the Inbound Message DTD Path is prepended to these files when WebSphere Commerce searches for them. The defaults are
  • NCCommon.mod
  • NCCustomer_10.mod
  • Create_NC_Customer_10.dtd
  • Update_NC_Customer_10.dtd
  • Update_NC_OrderStatus_10.dtd
  • Update_NC_ProductInventory_10.dtd
  • Update_NC_ProductPrice_10.dtd
  • Create_WCS_Customer_20.dtd
  • Create_WCS_Customer_30.dtd
  • Update_WCS_Customer_20.dtd
  • Create_WCS_Customer_30.dtd
  • Update_WCS_OrderStatus_20.dtd
  • Update_WCS_ProductPrice_20.dtd
  • Inquire_WCS_PickPackListDetail_10.dtd
  • Create_WCS_PickBatch_10.dtd
  • Create_WCS_ExpectedInventoryRecord_10.dtd
  • Create_WCS_InventoryReceipt_10.dtd
  • Update_WCS_InventoryReceipt_10.dtd
  • Create_WCS_ShipmentConfirmation_10.dtd
  • Create_WCS_ShipmentConfirmation_20.dtd
  • Update_WCS_ProductInventory_20.dtd
  • Request_WCS_BE_ProductInventory_10.dtd
  • Update_WCS_OrderStatus_30.dtd
  • Update_WCS_PriceAvailability_10.dtd
  • Update_WCS_ShoppingCartTransfer_10.dtd
  • Update_WCS_BatchAvailability_10.dtd
Note: You can remove the files that you do not need. When a new DTD file is created, you must update the EAR. To update the EAR file, see Ways to update application files.