This section describes the XML syntax you can include in event mappers that you create for reports in the Scenarios module.
<mapper>
The <mapper> tag (required) is the root tag for defining a mapper object.
It can contain the following child tags:
<registry-descriptor> (required)
<input-filter> (required)
<data-listener> (required)
<database> (required)
<registry-descriptor>
The <registry-descriptor> tag (required) is a wrapper for information that identifies this event mapper to the registry.
It can contain the following child tags:
<id>(required). Unique ID for the mapper (used for external reference).<display-name>(optional). Text that defines the display name of the mapper as it will appear in the ACC (the text appears in the Event Mapper field in the Dataset window).<description>(optional).
<input-filter>
The <input-filter> tag (required) has one attribute, context, that determines the purpose of the event mapper.
The context attribute (required) can be set to one of the following three values:
"jms"– use for mappers that you want to accept data from JMS messages."read-only"– use for mappers that do not record data through scenarios but are used instead for reporting on existing repository data."audit"– use for mappers that you want to accept data from audit trail events that you have included in recorder scenarios. For more information, refer to Creating an Audit Trail in the ATG Personalization Guide for Business Users.
The <input-filter> tag has the following child tags:
<value>– Required only if you set thecontextattribute to"jms". It identifies the JMS message to use to collect data. For"read-only"and"audit"context attribute settings, no<value>tag is required.
Example:
<input-filter context="jms">
<value>atg.dps.ProfilePropertyUpdate</value>
</input-filter>
<data-listener>
The <data-listener> tag (required) specifies the Nucleus path for the component of class atg.reporting.dataset.DatasetSQLLogger that you created to collect data (see Creating a New Data Collection Object for more information).
Example:
<data-listener>/atg/reporting/dataset/ProfileUpdateLoggerQueue
</data-listener>
<database>
The <database> tag (required) is a wrapper that describes the destination database for the data you want to record.
It can contain the following child tags:
<transaction-manager> (required)
<datasource> (required)
<table> (required)
<transaction-manager>
The <transaction-manager> tag (required) specifies the Nucleus address of the Transaction Manager service to use to track transaction activity for this event mapper.
Example:
<transaction-manager>/atg/dynamo/transaction/TransactionManager
</transaction-manager>
For more information, see Transaction Management in the ATG Platform Programming Guide.
<datasource>
The <datasource> tag (required) specifies the JDBC connection pool to use to create connections to the database where this event mapper stores the data it records. For more information, refer to the ATG Installation and Configuration Guide.
Example:
<datasource>dynamo:/atg/dynamo/jdbc/JTDataSource</datasource>
<table>
The <table> wrapper (required) defines the database table that will be used to store the data that this mapper records. It can contain the following child tags:
<name>(required). The name of the table to use.<display-name>(optional). Text that defines the display name of the table as it will appear in the ACC (the text appears in the description of the mapper in the Dataset window).<mappings> (required) . The database columns to which you want to map the properties you are recording.
<mappings>
The <mappings> tag is a wrapper that contains one or more dataset mappings that map the property or properties you are recording to appropriate database columns.
It can contain the following child tags:
<dataset-mapping>
The <dataset-mapping> tag contains information that specifies the column to use to identify this dataset within the database. This mapping is required.
This tag can have the following child tags:
<display-name>(optional) Text that defines the name of this property in the Choose the Axis Items dropdown list (see above).<column>(required) The name of the database column to which you want to record this data.<type>(required) The Java type of the property to record to the specified column.<property>(required) The data to record.
Example:
<dataset-mapping hidden="true"> <display-name>Dataset Id</display-name> <column>id</column> <type>java.lang.String</type> <property>datasetId</property> </dataset-mapping>
The hidden attribute is no longer used by ATG products.
<timestamp-mapping>
The <timestamp-mapping> tag specifies the column to use within this dataset to store information about the time that data is recorded. This mapping is required.
The <timestamp-mapping> tag can have the following child tags:
<display-name>(optional).<display-name>(optional) Text that defines the name of this property in the Choose the Axis Items dropdown list (see above).<column>(required). The name of the database column to which you want to record this data.<type>(required). Specifies the Java type for this data. Note thatjava.sql.Timestampis the only Java type you can use in a<timestamp-mapping>tag for an Scenarios module event mapper.<property>(required). The data to record.
Example:
<timestamp-mapping hidden="true"> <display-name>Time Stamp</display-name> <column>clocktime</column> <type>java.sql.Timestamp</type> <property>timestamp</property> </timestamp-mapping>
The hidden attribute is no longer used by ATG products.
<property-mapping>
The <property-mapping> tag specifies the column to use to store the given piece of data as well as the actual data to record.
This tag can have the following child tags:
<display-name>(optional). Text that defines the name of this property in the Choose the Axis Items dropdown list (see above).<column>(required). The name of the database column to which you want to record this data.<type>(required). The Java type of the data:java.lang.Stringjava.lang.Number(and its subclasses)java.sql.Timestamp
<property>(required). The data to record. Refers to theatg.process.ProcessExecutionContextobject, which is the object that gets passed to the mapper. Use the following attributes to specify the object and the property you are recording:context.request– a property of the current HTTP request object if the scenario segment is being executed in the context of an HTTP request. Example:<property>context.request.session.id</property>context.response– a property of the current HTTP response, if the scenario segment is being executed in the context of an HTTP request.Example:
<property>context.response.SC_NOT_FOUND</property>context.message– a property of the JMS message that triggered the recorder scenario. Example:<property>context.message.reportingOldValues
</property>Note that many of the JMS messages that come with the ATG system contain properties designed to make reporting easier. These properties are typically String representations of data that could not normally be recorded because of
typerestrictions for Scenarios module data collection (java.lang.String,java.lang.Number, andjava.sql.Timestamponly). The property shown above,reportingOldValues, is an example; it allows you to record a List property,oldValues, as a String.Usually the names of these properties start with
reporting, which gives you an easy way to identify them in the API.context.profile– a profile property of the user going through the scenario segment if the segment is being executed in the context of an individual user. Example:<property>context.profile.repositoryid</property>.context.label– for use in event mappers where you set the<input-filter>tagcontextattribute to"audit". The label is a String that is mapped by default to thelabelcolumn in thedss_audit_trailtable. The data that is recorded is the Label value that you specify within the Record Audit Trail scenario action.
Example:<property>context.label</property>
Example 1:
<property-mapping> <display-name>Old Values</display-name> <column>oldvalues</column> <type>java.lang.String</type> <property>context.message.reportingOldValues</property> </property-mapping>
Example 2:
<property-mapping> <display-name>Label</display-name> <column>label</column> <type>java.lang.String</type> <property>context.label</property> </property-mapping>
The hidden attribute is no longer used by ATG products.
<repository-item-mapping>
The <repository-item-mapping> tag specifies the column to use to store the given piece of data as well as the actual data to record. Use this tag for data that is stored as a repository item (for example, profile data).
This tag can have the following child tags:
<display-name>(optional). Text that defines the name of this property in the Choose the Axis Items dropdown list (see above).<column>(required). The name of the database column to which you want to record this data.<type>(required). The Java type of the data.<property>(required). The data to record. See the description of the<property-mapping>tag for information about thecontextattribute.<component>(required). The Nucleus component that represents the repository that stores the data. Example:<component>/atg/userprofiling/ProfileAdapterRepository</component>
Example:
<repository-item-mapping> <display-name>Profile Id</display-name> <column>profileid</column> <type>java.lang.String</type> <property>context.profile.repositoryid</property> <component>/atg/userprofiling/ProfileAdapterRepository</component> </repository-item-mapping>
The hidden attribute is no longer used by ATG products.
