Outbound messages

The HCL Commerce outbound messaging system can process different message types. Each message type is sent to the messaging system in response to a specific type of event that occurs within the HCL Commerce system. You specify the message type and settings in the Administration Console. The messaging system processes the message according to the type and settings that you specified, such as mail server, server port, sender, and subject. You change the content of the mail by modifying the JSP file that corresponds to the message type.

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.

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:
    • 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)

    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.

  4. Identify the store using the following SQL query:
    
    select identifier, storeent_id from storeent where storeent_id = 
    store entity ID of your store
    
  5. The JSP files are in the store directory with the same name as your store identifier, in the following directory:
    • For IBM i OS operating systemAIXLinuxWindows WC_eardir/Stores.war
    • HCL Commerce Developer workspace_dir\Stores\Web Content
Type Name of message in the Administration Console Message type name in MSGTYPES table Usage Default JSP file Task or controller command or JSP page Default recipient
e-mail Notification to content contributor for a task activation ActivateTaskNotification Informs Content Contributors that the tasks that they have been assigned are now active. ActivateTaskNotification.jsp com.ibm.commerce.contentmanagement.commands.SendActivateTaskEmailCmd Members of the task group.
e-mail Message to notify approvers ApproversNotify Send a message to notify approvers. ApproverNotification.jsp com.ibm.commerce.approval.commands.ApproversNotifyCmd Approvers. Informs them of the request for approval.
e-mail A broadcast message BroadcastMessage Configure this message type to send broadcast message to customers. To send broadcast messages you need to create a broadcast message JSP template. BroadcastMessage.jsp

See note 1.

com.ibm.commerce.messaging.commands.BroadcastMessageCmd One of the request parameters when the command is invoked.
e-mail Notification message for saving coupons. CouponsSavedNotification A message to inform a user that a coupon has been saved in the wallet for later use. CouponsSavedNotification.jsp

See note 1.

PersistCouponForLaterUseCmd The shopper's e-mail address.
e-mail Message submitted by customer CustomerMessage A message sent by a customer to the Site Administrator. See note 2. [only found in FeedbackSendDisplay.jsp(workspace\Stores\WebContent\CommercePlaza\StoreInfoArea\FeedbackSendDisplay.jsp), not found in any command ] Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail Message that contains the customer's interest item list InterestItemListMessage A message sent by a customer containing his or her interest item list (wish list). Messages/InterestItemListNotify.jsp com.ibm.commerce.messaging.commands.InterestItemListMessageCmd Recipient entered by the user.
e-mail Description of an error condition occurring in HCL Commerce ErrorMessage(View name: ErrorView) Configure this message type to enable administrators to receive e-mail messages when an error occurs in HCL Commerce. See note 2. com.ibm.commerce.ras.ErrorNotification Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail An Invoice message Invoice To send an invoice. Invoice.jsp

See note 1.

com.ibm.commerce.payment.commands.PrepareInvoiceCmd Get member id of Buyer Contact participant from Account. The Buyer Contact is to be the recipient of Invoices.
e-mail Message for notifying the merchant of an order MerchantOrderNotify Related to the NotifyMerchant parameter of the OrderProcess command. MerchantOrderNotification.jsp com.ibm.commerce.payment.commands.PaySynchronizePMCmd calls NotificationHelper#storeOrderNotify, the method calls com.ibm.commerce.order.commands.OrderNotifyCmd The e-mail address of the store. Set in the column EMAIL1 of the STADDRESS table.
e-mail Message for an authorized order OrderAuthorized Indicates that an order has been authorized. OrderAuthorized.jsp com.ibm.commerce.payment.commands.PaySynchronizePMCmd calls NotificationHelper#shopperOrderNotify, the method calls com.ibm.commerce.order.commands.OrderNotifyCmd Guest shopper (who provided an e-mail address during order check-out process) or the registered shopper of the order.
e-mail Notification message for a canceled order OrderCancel Indicates that an order has been canceled. OrderCanceledNotification.jsp com.ibm.commerce.order.commands.AdminOrderCancelCmd calls NotificationHelper#shopperOrderNotify, the method calls com.ibm.commerce.order.commands.OrderNotifyCmd Guest shopper (who provided an e-mail address during order check-out process) or the registered shopper of the order.
e-mail Notification message for a merchant of a canceled order OrderCancelForMerchant(View name: OrderCancelView) Notification message for a merchant for a canceled order. OrderCanceledNotification.jsp com.ibm.commerce.order.commands.AdminOrderCancelCmd calls NotificationHelper#storeOrderNotify, the method calls com.ibm.commerce.order.commands.OrderNotifyCmd The e-mail address of the store. Set in the column EMAIL1 of the STADDRESS table.
e-mail Message for a changed order OrderChanged Indicates the order has been changed by a CSR. The e-mail will be sent to the customer. OrderChanged.jsp com.ibm.commerce.order.commands.OrderNotifyCmd Guest shopper (who provided an e-mail address during order checkout process) or the registered shopper of the order.
e-mail Message for a received order OrderReceived Indicates that an order has been received. This message is sent when a shopper submits an order successfully. OrderReceived.jsp com.ibm.commerce.order.commands.OrderNotifyCmd Guest shopper (who provided an e-mail address during order check-out process) or the registered shopper of the order. If the command is com.ibm.commerce.order.commands.OrderNotifyCmd or com.ibm.commerce.tools.optools.order.commands.CSREmailOrderCmd, EMAIL1 of the billing address record in ADDRESS table is used.
e-mail Notification message of the order status OrderStatusNotify Indicates that the status of an order has changed. OrderStatusNotify.jsp com.ibm.commerce.messaging.commands.OrderStatusNotifySendCmd Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail Message for daily new orders summary report OrderSummaryReportNotification This report sends a brief summary of each order that was placed on the previous day in the store. OrderSummaryReportNotification.jsp com.ibm.commerce.store.commands.ReportsNotifyCmd Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail Notification message for password reset PasswordNotify Configure this message type to enable e-mail messages to be sent to customers indicating that their password has been reset. PasswordResetNotification.jsp com.ibm.commerce.security.commands.SendPasswordNotificationCmd The user whose password will be reset.
e-mail Notification to task group approver for a task group changed to ready to approve state ReadyToApproveTaskGroupNotification Informs Task Group Approvers that a task group is ready for approval. ReadyToApproveTaskGroupNotification.jsp com.ibm.commerce.contentmanagement.commands.SendReadyToApproveTaskGroupEmailCmd Approvers of the task group.
e-mail Notification to content contributor for a task rejection RejectTaskNotification Informs Content Contributors that a task has been rejected. RejectTaskNotification.jsp com.ibm.commerce.contentmanagement.commands.SendRejectTaskEmailCmd Members of the task.
e-mail Message for notifying the customer of an order release manifestation ReleaseShipNotify Informs customers of an order release manifest. ReleaseShipNotify.jsp com.ibm.commerce.messaging.commands.ReleaseShipNotifyCmd Guest shopper (who provided an e-mail address during order check-out process) or the registered shopper of the order.
e-mail Notification of approved reseller registration ResellerRegistrationApprovedNotification Message sent by an administrator to a reseller to inform registration approval. ResellerRegistrationApprovedNotification.jsp com.ibm.commerce.usermanagement.commands.OrgEntityRegistrationAddPostApprovalNotificationCmd User.Informs the user that registration was approved.
e-mail Notification of rejected reseller registration ResellerRegistrationRejectedNotification Message sent by an administrator to a reseller to inform registration rejection. ResellerRegistrationRejectedNotification.jsp com.ibm.commerce.usermanagement.commands.OrgEntityRegistrationAddPostApprovalNotificationCmd User. Informs the user that registration was rejected.
e-mail Response Notification Message ResponseNotification Used for RFQ responses. ResponseNotification.jsp com.ibm.commerce.rfq.commands.NotifyRFQResponseCmd RFQ owner.
e-mail RFQ Close Message RFQCloseMessage Informs the RFQ owner that all sellers have been told that no more responses will be accepted. Informs the seller's sales managers and seller member groups that no more responses are being accepted by the RFQ owner. RFQCloseMessage.jsp com.ibm.commerce.utf.commands.RFQNotificationClosedMonitorCmd RFQ owner and RFQ related members.
e-mail RFQ Complete Message RFQCompleteMessage Informs the seller's sales managers and seller member groups that winners have been selected and that an order or contract process has been initiated. RFQCompleteMessage.jsp com.ibm.commerce.utf.commands.RFQNotificationCompletedMonitorCmd RFQ owner and RFQ related members.
e-mail RFQ Submit Message RFQSubmitMessage Informs the RFQ owner that the RFQ request has been transmitted to sellers. Informs the seller's sales managers and seller member groups that an RFQ request has been transmitted to them. RFQSubmitMessage.jsp com.ibm.commerce.utf.commands.RFQNotificationSubmittedMonitorCmd RFQ owner and RFQ related members.
e-mail Message for site commerce reports SiteCommerceReportNotification The commerce reports show important summary information about your site and orders placed on the entire site. SiteCommerceReportNotification.jsp com.ibm.commerce.store.commands.ReportsNotifyCmd Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail Message for store commerce reports StoreCommerceReportNotification The commerce reports show important summary information about the products sold in your store and the regions from where the customers come from. StoreCommerceReportNotification.jsp com.ibm.commerce.store.commands.ReportsNotifyCmd Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail Message for monthly storefront usage report StoreUsageReportNotification This report provides key criteria for the site such as: orders, customer visits, and total sales. StoreUsageReportNotification.jsp com.ibm.commerce.store.commands.ReportsNotifyCmd Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
e-mail User account activation by e-mail UserAccountEmailActivateMessage Enables e-mail messages to be sent to customers after they register with a store, if the account activation by e-mail change flow option is enabled. UserRegistrationEmailActivateNotification.jsp com.ibm.commerce.member.facade.server.commands.UserRegistrationAddCheckApprovalCmd com.ibm.commerce.member.facade.server.commands.UserRegistrationEmailActivateResendCmd The customer that registered with the store.
integration message Checks the quantity and availability against a backend system for a list of part numbers BatchAvailability

(Message name: batchAvailabilityRequest)

Sends a request to an external system to get availability information for a list of products. BatchAvailability.jsp com.ibm.commerce.messaging.commands.RequestBatchAvailabilityPolicyCmd (Implementation class: com.ibm.commerce.messaging.commands.GetBatchAvailabilityCmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
integration message Checks inventory availability from a backend system CheckInventoryAvailabilityBE

(Message name: Request_WCS_BE_ProductInventory)(View name: CheckInventoryAvailabilityView)

To request inventory availability of products from a fulfillment center. InventoryAvailabilityCheck.jsp com.ibm.commerce.fulfillment.commands.CheckInventoryAvailabilityCmd (Implementation class: com.ibm.commerce.fulfillment.commands.CheckInventoryAvailabilityBECmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
integration message Outbound message for HCL Commerce order create OrderCreateFixFormat

(Legacy message)

Indicates that an order has been created in HCL Commerce. The message can be used to send an outbound HCL Commerce order create message to a back-end system. com.ibm.commerce.order.commands.OrderMessagingCmd (Implementation class: com.ibm.commerce.messaging.commands.SendWCSOrderCmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
integration message Outbound message for HCL Commerce XML create OrderCreateXMLFormat

(Message name: Report_NC_PurchaseOrder)

Indicates that an order has been created in HCL Commerce. The message can be used to send an outbound HCL Commerce order create message to a back-end system. OrderCreateXML.jsp com.ibm.commerce.order.commands.OrderMessagingCmd (Implementation class: com.ibm.commerce.messaging.commands.SendXMLOrderCmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
integration message Checks the price, quantity and availability from a backend system for a list of part numbers and quantities PriceAndAvailabilityCheck

(Message name: Update_WCS_PriceAndAvailability)

Sent to a back-end system to request price and availability information of products. PriceAndAvailabilityCheck.jsp com.ibm.commerce.messaging.commands.RequestOrderQuotationPolicyCmd (Implementation class: com.ibm.commerce.messaging.commands.GetPriceAndAvailabilityCmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
integration message Transfers the shopping cart to a backend system. ShoppingCartTransfer

(Message name: Update_WCS_ShoppingCartTransfer)

The shopping cart will be sent to a back-end system for order management or fulfillment. ShopCartTransfer.jsp com.ibm.commerce.messaging.commands.RequestOrderQuotationPolicyCmd com.ibm.commerce.messaging.commands.TransferShopCartPolicyCmd (Implementation class: com.ibm.commerce.messaging.commands.TransferShopcartCmdImpl) Recipient specified when the message type was assigned to the e-mail transport in the Administration Console.
SMS Outbound message for HCL Commerce Marketing Component to send SMS messages. MarketingMessage Sends a marketing message using the SMS transport. See Action: Send Message. com.ibm.commerce.marketing.commands.elements.SendSMSActionTaskCmd The recipient is the user. It informs the user of marketing campaigns.
Notes:
  1. No JSP page is provided, but the default name has been registered in the struts-config.xml file.
  2. You must create a JSP page for this message, and register the JSP page in the struts-config-ext.xml file. This file is for customization.
  3. An integration message can be an XML message.