This section provides examples of the configuration files required to create data collection components. The example components collect operational data about abandoned orders. Oracle ATG Web Commerce Business Intelligence does not collect this data by default. See general information about data collection components in Data Collection Process.
Example Event Listener Component
This section provides example configuration files for an event listener component. See general information about these components in Event Listener Component.
Create an event listener component with the following component configuration file:
$class=atg.service.datacollection.MessageSinkDataListenerService
dataListener=/mycompany/reporting/datacollection/MyEventQueue
Register the event listener component with the Oracle ATG Web Commerce messaging system patch bay. Configure it to receive the events that contain the operational information that you want to collect. For example, the message-sink element in the following XML configuration file registers an event listener component to receive abandoned order events. Add a file like this to the configuration path of your web application at /atg/dynamo/messaging/dynamoMessagingSystem.xml
.
<?xml version="1.0" encoding="ISO-8859-1" ?> <dynamo-message-system> <patchbay> <message-sink> <nucleus-name>/mycompany/reporting/datacollection/MyEventListener </nucleus-name> <input-port> <port-name>OrderAbandonedPort</port-name> <input-destination> <provider-name> local </provider-name> <destination-name> localdms:/local/Order/OrderAbandoned </destination-name> <destination-type> Topic </destination-type> </input-destination> </input-port> </message-sink> </patchbay> </dynamo-message-system>
Example Event Queue Component
This section provides example configuration properties for an event queue component. See general information about these components in Event Queue Component.
Create an event queue component with the following component configuration file:
$class=atg.service.datacollection.DataCollectorQueue
dataListeners=/mycompany/reporting/datacollection/MyFileLogger
Example Data File Writing Component
This section provides example configuration properties for a data file writing component. See general information about these components in Data File Writing Component.
Create a data file writing component with the following component configuration file:
$class=atg.service.datacollection.RotationAwareFormattingFileLogger # -------------------------------------- # Log file path and name properties # -------------------------------------- # The base directory for log files defaultRoot^=/atg/dynamo/service/DWDataCollectionConfig.defaultRoot # The file name for log files. This may include a subdirectory. logFileName=my-abandoned-orders_ # Insert an optional unique identifier in each file name UIDLogFileName=true # The component that will generate the unique identifiers idGenerator=/atg/dynamo/service/IdGenerator # The file name extension for log files logFileExtension=.data # -------------------------------------- # Logged data configuration # -------------------------------------- formatFields=object.abandonmentState,object.orderId,object.profileId, object.type # -------------------------------------- # Log file rotation scheduling properties # -------------------------------------- # An identifier for the scheduled task jobName=MyLog # The log file rotation schedule schedule=every 1 hour without catch up # The maximum number of records in a log file. If the number of records # reaches this threshold, the application will rotate the file. dataItemThreshold=10000 # The centralized Dynamo scheduling component scheduler=/atg/dynamo/service/Scheduler # The messageSource component that will send log rotation messages messageSource=/atg/dynamo/service/LogRotationMessageSource # The Java Messaging Service (JMS) type logRotationMessageType=atg.commerce.order.abandoned.OrderAbandoned # -------------------------------------- # Enable or disable this component # -------------------------------------- enabled^=/atg/dynamo/service/DWDataCollectionConfig.enabled