Configuring Sales Center events

You can configure the batch size and frequency of Sales Center events sent to IBM Digital Analytics, formerly known as Coremetrics Analytics.

Procedure

  1. Edit the WebSphere Commerce configuration file:
    1. Update the event configuration:
      1. Search the file for the following string: Analytics Event Processor. Scroll down to find the event elements. The code segment resembles the following code:
        
        <supportedEvents processState="-10" purgeState="-20"
              mapper="mapCommonEvents.xml" maxBatchSize="250">
           <event type="Member" listen="
              true" mapper="mapMemberEvent.xml"/>
           <event type="OrderCreation" listen="
              true" mapper="mapOrderCreation.xml"/>
           <event type="OrderItemCreation" listen="
              true" mapper="mapOrderItemCreation.xml"/>
           <event type="OrderItemUpdate listen="
              true" mapper="mapOrderItemUpdate.xml"/>
           <event type="OrderItemShipment" listen="
              true" mapper="mapOrderItemShipment.xml"/>
           <event type="OrderCancellation" listen="
              true" mapper="mapOrderCancellation.xml"/>
           <event type="OrderSubmission" listen="
              true" mapper="mapOrderSubmission.xml"/>
        </supportedEvents>
        
      2. Configure the maxBatchSize. This value determines the maximum number of events to process per transaction. This value must be set as large as possible while still ensuring that the EventMapper completes the processing in less than the maximum WebSphere Application Server transaction timeout setting (20-minute default). Do not set this value too small because of the additional performance requirements for starting and stopping transactions.
      3. Enable individual events by setting their listen attribute to true. This attribute is the attribute in bold in the preceding code sample.
      4. Disable events by setting their listen attribute to false.
    2. Configure the information about your store:
      1. Scroll down from the code segment that is edited in step 2a, to the stores element. Update the store element with data that reflects your store. The code segment resembles the following code:
        
        <store enabled="false" storeId="-1" >
           <configuration 
              transmitEnabled="false"
              transmitClassName="com.ibm.commerce.bi.events.transmit.CMWebServiceTransmitter"
              cmClientID="assignedID" 
              username="store1user" 
              password="encrypted_store1pass"
              sslKeyStore="/usr/WebSphere/AppServer/profiles/demo/etc/DummyServerKeyFile.jks"
              sslKeyPassphrase="WebAS"
              sslTrustStore="/usr/WebSphere/AppServer/profiles/demo/etc/DummyServerTrustFile.jks"
              sslTrustPassphrase="WebAS"
              serviceURL="https://wscreceiver.coremetrics.com/Receiver/sendEventData" />
        </store>
        
        Notice the information that is highlighted in bold in the preceding sample. These highlighted pieces of code must be updated with your store information:
        enabled
        A boolean flag, which indicates whether IBM Digital Analytics is enabled for the store that is identified by the storeId.
        storeId
        The ID of your store in the WebSphere Commerce database.
        transmitEnabled
        A boolean flag, which specifies whether the events are to be transmitted to IBM Digital Analytics using the web service transmitter. The transmitEnabled attribute must be set to false if you want to manually send the event data to IBM Digital Analytics which is generated by the EventFileGeneration utility. If the value is set to true, the events are transmitted to IBM Digital Analytics using the web service transmitter.
        cmClientID
        A IBM Digital Analytics client ID. This ID is provided by IBM Digital Analytics when you negotiate your service contract.
        username
        The username that is used to access IBM Digital Analytics.
        password
        The password that is associated with the username.
        sslKeyStore
        The fully qualified path and file name of the Secure Sockets Layer (SSL) key database file for your store.
        Note: For testing purposes, you can create self-signed certificates. The Dummy key and trust file certificate are expired and are not to be used. For more information about the Dummy key and trust file certificate and how to replace them, see the WebSphere Application Server Security Guide.
        sslKeyPassphrase
        The password for the key database file.
        sslTrustStore
        The fully qualified path and file name of the SSL trust database file for your store.
        sslTrustPassphrase
        The password for the truststore database file.
        serviceURL
        The URL of the web service that the event data is sent to. This URL is to be provided by IBM Digital Analytics when you negotiate your service contract.
  2. Deploy the updated file to the application server.
  3. Restart WebSphere Commerce.
  4. Optional: Configure the scheduled job to set the frequency of the event processing. By default, the job is scheduled to run every hour. If this setting negatively affects performance, you can change the time interval. To configure the job, see Editing the configuration for a scheduled job, and edit the EventProcessor job.