Outbound messages

The HCL Commerce outbound messaging system includes JSP pages for a number of message types. When a message of one of these types is generated within HCL Commerce, the message composition service uses the corresponding JSP page to create the outbound message. After it is created, the outbound message can be sent through whatever transports have been assigned to the message type in the Administration Console Management Center.

The following table shows message types that use composition templates and for many cases, the corresponding JSP files. In general, to determine which JSP file you need to edit to work with a message, do the following steps:

1. Identify the message type that allows you to generate the message.
2. Use the following SQL query to identify the view name:

   select name, viewname from msgtypes where name='
   message type name found in this table'
   

   Note: Unless otherwise notified in the table below, the View name is the same as the Message type name, with the addition of the string "View." For example, if the message type name is ShoppingCartTransfer, the view name is ShoppingCartTransferView.
3. To determine the JSP file location, search for the view name in the following files:
   • For remote stores:
     • WC_eardir/Stores.war/WEB-INF/struts-config-ext.xml (for customization and store publishing)
     • struts-config-migrate.xml (entries exist after migration)
     • struts-config.xml (default entries)
       Note: See Configuring a Web application for more information.
   • If migrating from WebSphere Commerce version 7 or 8 to HCL Commerce version 91:
     • WC_eardir/Stores.war/src/struts-wcs-stores-custom.xml (for customization and store publishing)
     • struts-wcs-stores-migrate.xml (entries exist after migration)
     • struts-stores.xml (default entries)
     Note: From HCL Commerce version 9.1 onwards, Struts 2 configuration is used. See Struts 2 configuration file changes for more information.
   Note: See Customizing storefront pages for information related to storefront pages.

4. The order of search should be done according to the list found in web.xml. For example, for view name of "OrderCreateXMLFormatView" using stand device format of "-3", the corresponding entry for store 0 is as follows:

   
   <forward className="com.ibm.commerce.struts.ECActionForward"
   name="OrderCreateXMLFormatView/0/-3" path="/OrderCreateXML.jsp">
   <set-property property="resourceClassName"
   value="com.ibm.commerce.messaging.viewcommands.MessagingViewCommandImpl"/>
   <set-property property="properties" value="storeDir=no"/>
   <set-property property="interfaceName"
   value="com.ibm.commerce.messaging.viewcommands.MessagingViewCommand"/>
   <set-property property="implClassName"
   value="com.ibm.commerce.messaging.viewcommands.MessagingViewCommandImpl"/>
   <set-property property="direct" value="true"/>
   </forward>
   

   The file name is OrderCreateXML.jsp. This JSP file is located at

   WC_eardir/Stores.war/WebContent/WEB-INF directory

   Files should not be directly modified or copied to this directory. The correct way to update files in these directories is to use the Administration Console or the WebSphere Application Server wsadmin scripting. For more information, see the Ways to update application files topic.

5. Identify the store using the following SQL query:

   
   select identifier, storeent_id from storeent where storeent_id = 
   store entity ID of your store
   

6. The JSP files are in the store directory with the same name as your store identifier, in the following directory:
   • WC_eardir/Stores.war
   • workspace_dir\Stores\Web Content