Version 1 Release 0
November 25, 2015
IBM Campaign Reports Builder
Accelerator
IBM
Note
Before using this information and the product it supports, read the information in “Notices” on page 37.
This edition applies to version 9, release 1, modification 0 of IBM Campaign and IBM EMM Reports and to all
subsequent releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2015.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. Overview of IBM Campaign
Reports Builder . . . . . . . . . ..
1
Hardware and software requirements .
Additional documentation . . . . .
2
2
.
.
.
.
.
.
..
..
Chapter 2. Installing and configuring
IBM Campaign Reports Builder. . . ..
5
Creating views for different audiences . . .
Uninstalling IBM Campaign Reports Builder.
7
9
.
.
..
..
Chapter 3. How IBM Campaign Reports
Builder works . . . . . . . . . . .. 11
Known problems and solutions . . . . . .
Building reports in IBM Cognos Query Studio.
Views/Materialized Views . . . . . . .
© Copyright IBM Corp. 2015
..
..
..
11
12
13
Business View: IBM Campaign Reports Builder
Package . . . . . . . . . . . . . ..
Business View: IBM Campaign Reports Builder
Package for Drill Down . . . . . . . . ..
Example: Creating a relational report in IBM Cognos
Query Studio . . . . . . . . . . . . ..
Example: Creating a dimensional report in IBM
Cognos Query Studio . . . . . . . . . ..
20
26
29
31
Before you contact IBM technical
support . . . . . . . . . . . . ..
35
Notices . . . . . . . . . . . . ..
37
Trademarks . . . . . . . . . . . . ..
Privacy Policy and Terms of Use Considerations ..
39
39
iii
iv
IBM Campaign Reports Builder
Chapter 1. Overview of IBM Campaign Reports Builder
IBM Campaign Reports Builder gives marketers deeper insight into campaign
performance metrics. It enables marketers to create and visualize data dynamically
on their own, with the simple dragging and dropping of predefined data elements.
The Reports Builder also provides drill down capabilities.
With Reports Builder, marketers can perform the following tasks:
v Define metrics and calculations.
v Define filters, conditional styling, and grouping and sorting options on the
reports.
v Save built reports for later use.
v Export and print report data.
Reports Builder provides new materialized views, including predefined key
performance indicators (KPIs) and dimensions. Reports Builder supports the ability
to view data on offer versions, which the out of box reports do not provide.
Note: This release is available only for IBM EMM Reports deployment with
English locale.
Intended audience
This document is intended for system administrators and marketers. System
administrators can use this document to install and configure IBM Campaign
Reports Builder. Marketers can use this document to build their own IBM
Campaign reports. This document is intended as a supplement to existing
documentation about the IBM EMM reports that are used in IBM Campaign.
Before you begin installation
Review the following information before you install Reports Builder:
v All configuration steps must be completed manually.
v If you have a multi-partition Campaign environment, you must implement this
solution for each partition.
v This solution requires that additional views and materialized views be created in
the IBM Campaign system table schema.
v Before you upgrade to the next release of IBM EMM Reports, you must uninstall
this solution.
Security
To secure reports and folders at the user level, use Unica Secure CJAP
authentication. Security is described in more detail in the IBM EMM Reports:
Installation and Configuration Guide. The Unica Secure CJAP is described in the topic
"How to implement CJAP security". Folder level security is described in the topic
“User authorization for Cognos folders and reports”.
Users who are restricted from viewing reports and folders that were generated
with Reports Builder are not able to view those reports or folders in IBM
Campaign.
© Copyright IBM Corp. 2015
1
Before you begin using Reports Builder
View the IBM Cognos Query Studio tutorials that are posted on YouTube:
v Part 1, Introduction to IBM Rational RRDI Report Authoring:
https://www.youtube.com/watch?v=_fwkQ0bcWcQ
v Part 2, Using the IBM Cognos Query Studio User Interface and Data Package:
http://www.youtube.com/watch?v=2E-x37JiFkc
v Part 3, Build a List report in IBM Cognos Query Studio:
https://www.youtube.com/watch?v=FjWBhbESNA4
v Part 4, Build a Crosstab and Chart in IBM Cognos Query Studio:
https://www.youtube.com/watch?v=XRY54Oh9n8k
Hardware and software requirements
To use Reports Builder, you must have access to an IBM Cognos server. You must
have either IBM Cognos Query Studio or IBM Cognos Report Studio installed in
your IBM Cognos Business Intelligence environment. We recommend IBM Query
Studio for marketers.
Reports Builder is supported for the following products and versions:
v IBM Campaign versions 9.1.x
v IBM Cognos versions 10.2 (for Campaign 9.1) and 10.2.1 FP2 or later (for
Campaign 9.1.1 and later)
Note: A defect (asterisk displayed in Cost/Revenue KPIs instead of currency
symbol) was found on the 10.2.1 release for Reports Builder. However, IBM
Campaign 9.1.1 (and later) is supported on 10.2.1 only. If you are not concerned
with this defect, you can use 10.2.1.0. It is not a blocking issue and does not
affect the IBM Campaign 9.1 release.
v System databases: IBM DB2, Oracle, and SQL Server
Note: Refer to the IBM Enterprise Marketing Management Products Recommended
Software Environments and Minimum System Requirements for the supported
database versions.
Additional reporting tools
To use IBM Campaign Reports Builder, you must have one of the following
products installed in your system:
v To view one set of data at a time, use IBM Cognos Query Studio.
v To view multiple sets of data together, use IBM Cognos Report Studio.
We recommend that marketers view one set of data at a time with IBM Cognos
Query Studio. IBM Cognos Query Studio is the reporting tool for creating simple
queries and reports in IBM Cognos Business Intelligence.
Additional documentation
Additional information about reports can be found in the IBM Cognos
documentation and the ExperienceOne (formerly EMM) documentation.
2
IBM Campaign Reports Builder
IBM Cognos documentation
Information about IBM Cognos Query Studio and IBM Cognos Reports Studio can
be found in the IBM Knowledge Center:
v For IBM Cognos version 10.2.0:
http://www.ibm.com/support/knowledgecenter/SSEP7J_10.2.0/
com.ibm.swg.ba.cognos.cbi.doc/welcome.html
v For IBM Cognos version 10.2.1:
http://www.ibm.com/support/knowledgecenter/SSEP7J_10.2.1/
com.ibm.swg.ba.cognos.cbi.doc/welcome.html
To access information about Query Studio and Reports Studio, in the left
navigation pane, click Author and Create.
To access information about administration and security, in the left navigation
pane, click Administer and Deploy.
ExperienceOne documentation
Information about the IBM EMM reports can be found in the IBM Knowledge
Center:
v IBM EMM Reports 9.1.1 and later:
http://www.ibm.com/support/knowledgecenter/SSZPE3/
kc_welcome_platform.dita
Click the link for the version of IBM Marketing Platform and then click the link
for the IBM Reports Installation and Configuration Guide.
v IBM Campaign 9.1.1 and later (section titled "IBM Campaign reports overview"):
http://www.ibm.com/support/knowledgecenter/SSCVKV/Campaign/
kc_welcome_campaign.dita
v IBM EMM Reports 9.1:
http://doc.unica.com/products/platform/9_1_0/en_us/help/wwhelp/
wwhimpl/js/html/wwhelp.htm
v IBM Campaign 9.1 (section titled "IBM Campaign reports overview"):
http://doc.unica.com/products/campaign/9_1_0/en_us/help/wwhelp/
wwhimpl/js/html/wwhelp.htm
Chapter 1. Overview of IBM Campaign Reports Builder
3
4
IBM Campaign Reports Builder
Chapter 2. Installing and configuring IBM Campaign Reports
Builder
Administrators can install and configure the Reports Builder.
Before you begin
Download the IBMCampaignReportsBuilderAccelarator1.0.0.zip file into your
Cognos deployment folder. This file contains the following files and folders:
v IBMCampaignReportsBuilder.zip
This compressed file contains the following packages and folders:
– IBM Campaign Reports Builder Package
– IBM Campaign Reports Builder Package for Drill Down
– Affinium Campaign folder
v IBMCampaignReportsBuilderModel
This folder contains the data model files.
v ddl
This folder contains database scripts that have to be run against the IBM
Campaign system schema to configure the Reports Builder. These scripts are
specific to the database type. This folder contains the following SQL files:
– The icar_<database type>_common.sql script contains the view definitions
that are needed to build reports with the default audience level of
"Customer".
– The icar_<database type>_custom.sql script contains the view definitions
that are needed to build reports for different audience levels.
– The icar_<database type>_drop.sql script contains the drop statement for
the views.
– The icar_<database type>_template.sql script contains the view definitions
with the tokens that are needed to build reports for different audience levels.
About this task
The type of database you use determines what type of views are used:
Database type
Type of view
DB2
Materialized Query Tables
Oracle
Materialized Views
SQL Server
Views
Note: Materialized views need to be refreshed whenever the IBM Campaign data
is updated. Database administrators can create jobs to periodically refresh the
materialized views.
To install and configure the Reports builder, complete the following steps.
© Copyright IBM Corp. 2015
5
Procedure
1. In the ddl\<database type> folder, run the icar_<database type>_common.sql
script on the IBM Campaign system tables schema.
For example, if the IBM Campaign system tables are on DB2, navigate to
ddl\db2 and run icar_db2_common.sql.
Note: For DB2, although you might see the following error, you can ignore it.
Despite the error, the materialized views are successfully created.
SQL20059W The materialized query table-name may not be used to optimize
the processing of queries.
2. If you plan to use only the default audience level of "Customer", complete this
step. However, if you plan to use other audience levels, skip this step and
complete the steps in “Creating views for different audiences” on page 7
instead.
In the ddl\<database type> folder, run icar_<database type>_custom.sql on
the IBM Campaign system database. For example, if your database is DB2,
navigate to ddl\db2 and run icar_db2_custom.sql.
3. Optional: If the CampaignDS datasource does not already exist, complete the
following steps:
a. Use the Administration section to create the datasource with the name
CampaignDS.
b. Select the database type to match that of the IBM application database.
c. Complete the database-specific fields.
Note: Be sure that you specify the IBM Campaign application database and
not the Cognos content store.
Reports Builder does not support Dynamic Query Mode, so do not
configure a JDBC connection when you create the CampaignDS datasource.
For details about these fields, refer to the IBM Cognos documentation.
d. In the Signon section, select the options Password and Create a Signon that
the Everyone group can use. Specify the user credentials for the IBM
Campaign application database user.
e. Verify that you configured each data source correctly by using the Test
Connection feature.
4. To import Reports Builder into IBM Cognos Connection, complete the following
steps:
a. Download and extract the Reports Builder.
b. Browse the extracted directory and copy the compressed reports archive file
IBMCampaignReportsBuilder.zip to the directory where your Cognos
deployment archives are saved.
The default location is the deployment directory under your IBM Cognos
installation. This directory is specified in the Cognos Configuration tool that
is installed with the Cognos Content Manager. For example,
cognos\deployment.
Note: In a distributed IBM Cognos environment, this location is on the
system where Content Manager is located.
c. From the Launch Option, click IBM Cognos Administration.
d. Click the Configuration tab.
e. Click Content Administration.
6
IBM Campaign Reports Builder
f. Click the icon on the toolbar for New Import.
g. Complete the steps in the New Import Wizard. Use the following
guidelines:
v Select the reports archive that you copied in step b.
v In the Public folders content list, select the package that is displayed as a
blue folder.
5. Optional: IBM Cognos Reports Builder packages are available in the IBM
Cognos environment when you import IBMCampaignReportsBuilder.zip using
IBM Cognos Connection. If you want to enhance the out of box model,
complete the following steps:
a. In the IBMCampaignReportsBuilderAccelarator1.0.0.zip extracted folder,
locate IBMCampaignReportsBuilderModel. Copy this into the IBM Cognos
deployment directory, which IBM Cognos Framework Manager can access.
The files constitute the application-specific data model.
b. Open IBMCampaignReportsBuilderModel.cpf in Framework Manager.
c. Customize IBMCampaignReportsBuilderModel.cpf as necessary.
d. Publish packages to the Cognos content store.
6. Optional: If you do not already use IBM Campaign reports, you must configure
the reporting properties in IBM Marketing Platform. For specific steps, refer to
the "Configuring Cognos reporting properties in Marketing Platform" topic in
the IBM EMM Reports: Installation and Configuration Guide.
Creating views for different audiences
The default audience for Reports Builder is "Customer". System administrators can
change this option to allow different audiences in reports.
About this task
Audience levels can be text, numeric, or a composite.
If you use single key audience, start with step 1 and then continue to step 3. If you
use composite key audience, start with step 2 and then continue to step 3.
Procedure
1. If you have a single audience level and that level is not Customer, then you
must update the icar_<database type>_template.sql SQL template for your
audience level. In the icar_<database type>_template.sql file, replace the
following four tokens with respect to the audience:
Token
Replacement
%contactHistoryTableName%
Replace with the name of the Contact
history table name for your audience level.
%dtlContactHistoryTableName%
Replace with the name of the Detailed
Contact history table name for your
audience level.
%responseHistoryTableName%
Replace with the name of the Response
history table name for your audience level.
%audienceKey%
Replace with the key of your audience level,
which is the column name for the audience
level in the Contact, Detailed Contact, or
Response History table.
Chapter 2. Installing and configuring IBM Campaign Reports Builder
7
Note: Regardless of whether the audience is text or numeric, use the CAST
function and define the audience as VARCHAR.
2. If you have composite audience levels, update the icar_<database
type>_template.sql SQL template to include one CAST function for each
audience level. Then, concatenate them into temp.sql using the CAST
statements.
Note: The concatenate operator is dependent on the database type:
Database type
Concatenate operator
DB2
||
Oracle
+
SQL Server
||
For example, you use a DB2 database. You have two audience keys
(AudienceKey1 and AudienceKey2) with the contact history table
ContactHistory. The original string is:
cast((CASE WHEN UA_Treatment.CntrlTreatmtFlag = 0 and
UA_ContactStatus.CountsAsContact=1 THEN %contactHistoryTableName%.
%audienceKey% END) as varchar(50))
You create the following statements:
(cast(CASE WHEN UA_Treatment.CntrlTreatmtFlag = 0 and
UA_ContactStatus.CountsAsContact=1 THEN ContactHistory.AudienceKey1 END)
||
cast(CASE WHEN UA_Treatment.CntrlTreatmtFlag = 0 and
UA_ContactStatus.CountsAsContact=1 THEN ContactHistory.AudienceKey2
END))as varchar(50))
3. For each of the tables listed below, complete steps 3a through 3d to collect the
data for all system audiences and merge them into one table. (The examples
show how steps 3a through 3d are done for ICR_CCOCH_DY_ALL.) After
collecting the data for all six tables, complete step 3e.
v ICR_CCOCH_DY_ALL
v ICR_CCORH_DY_ALL
v ICR_CORBO_ALL
v ICR_OPM_SUMMARY
v ICR_UNIQUE_RECIPIENTS
v ICR_UNIQUE_RESPONDERS
Note: Three tables are not affected:
v ICR_CCOCH_DY
v ICR_CCORH_DY
v ICR_CORBO
Note: The following examples are for DB2, which uses the REFRESH command.
For Oracle, use the CREATE MATERIALIZED VIEW command. For SQL, use the
CREATE VIEW command.
a. To use the "Customer" audience as well as the new audience, copy the
CREATE TABLE definition from icar_<database type>_custom.sql to a
temporary file, such as temp.sql.
The following code shows an example of what temp.sql looks like after
your changes.
8
IBM Campaign Reports Builder
CREATE TABLE ICR_CCOCH_DY_ALL AS
(( SELECT DISTINCT
UA_Treatment.CampaignID AS CAMPAIGNID,
UA_Treatment.CellID AS CELLID,
[Continue for the out of box script without the REFRESH line.]
))DATA INITIALLY DEFERRED REFRESH DEFERRED;
b. Append the table definition that you modified in either step 1 or 2 from
icar_<database type>_template.sql to the temporary file temp.sql.
The following code shows an example of what temp.sql looks like after
your changes.
--CREATE TABLE ICR_CCOCH_DY_ALL AS
(( SELECT DISTINCT
UA_Treatment.CampaignID AS CAMPAIGNID,
UA_Treatment.CellID AS CELLID,
[Continue for each reference in the table.]
))
--DATA INITIALLY DEFERRED REFRESH DEFERRED;
c. Remove commented lines.
For this example, remove the following commented lines:
--CREATE TABLE ICR_CCOCH_DY_ALL AS
--DATA INITIALLY DEFERRED REFRESH DEFERRED;
d. Insert the UNION command to merge the table definitions.
The following code shows an example of what temp.sql looks like after
your changes.
CREATE TABLE ICR_CCOCH_DY_ALL AS
((SELECT DISTINCT
UA_Treatment.CampaignID AS CAMPAIGNID,
UA_Treatment.CellID AS CELLID,
[Continue for the out of box script without the REFRESH line.]
)
UNION
(SELECT DISTINCT
UA_Treatment.CampaignID AS CAMPAIGNID,
UA_Treatment.CellID AS CELLID,
[Continue for each reference in the table.]
))
DATA INITIALLY DEFERRED REFRESH DEFERRED;
Note: For DB2, the REFRESH line must be the last line in each table.
e. In the database command editor, run the temp.sql file to create the tables.
Uninstalling IBM Campaign Reports Builder
Before you upgrade to a newer version of ExperienceOne Reports, you must
uninstall the Reports Builder.
Chapter 2. Installing and configuring IBM Campaign Reports Builder
9
About this task
To uninstall the Reports Builder, complete the following steps.
Procedure
1. On IBM Campaign, drop the Views/Materialized Views from the system
schema by running the icar_<database type>_drop.sql script.
2. In IBM Cognos Connection, select IBM Campaign Reports Builder Package
and IBM Campaign Reports Builder Package for Drill Down and click Delete.
The package data is removed from the Cognos Content store.
3. In IBM Cognos Connection, navigate to Public Folders > Affinium Campaign
and select Sample Reports. Then, click Delete.
4. Open the framework manager by selecting File Manager > Projects > delete
and select the IBMCampaignReportsBuilderModel.cpf file.
All metadata files for Reports Builder are deleted.
10
IBM Campaign Reports Builder
Chapter 3. How IBM Campaign Reports Builder works
With Reports Builder, marketers can create their own reports in IBM Query Studio
and then save, print, and export the report output.
To view reports in IBM Campaign, you must save the reports in the IBM
Campaign report root folder (Affinium Campaign) in IBM Cognos. In IBM
Campaign, open the saved report by selecting Analytics > Campaign Analytics.
Reports can be either public or private:
v Save public reports in a folder that is accessible to all users.
v Save private reports in secure folders. Administrators can implement folder-level
security in Cognos.
Reporting packages in the data model
The new data model includes two packages for published content. The data model
serves any IBM Campaign reports for predefined dimensions and measures. You
can create relational reports such as lists, charts, pivots, and drill down reports.
This model requires a new set of database materialized views to provide the query
results for the report.
Choose the appropriate package when you build a report:
v For relational reporting, select IBM Campaign Reports Builder Package.
v For drill down reports, select IBM Campaign Reports Builder Package for Drill
Down.
Known problems and solutions
There are several limitations when you use IBM Cognos Query Studio to build
reports. We recommend that you use IBM Cognos Reports Studio instead to avoid
those limitations.
v The ROI value is incorrect because its formula refers to both calculated items net
profit and total contact cost.
This is a limitation of IBM Cognos Query Studio. When a calculation is based on
multiple calculations, the summary value is calculated incorrectly.
v The summary value of Unique KPIs will always be incorrect. To either hide the
summary value or choose the total summary, complete the following steps:
1. Right-click the Unique KPI title.
2. Click Summarize.
3. Do one of the following steps:
– To hide the summary, set Summary for footers to None.
– To view the basic total, set Summary for footers to Total.
v You will get incorrect values when you use an offer with a number data type
offer attribute (such as Offer Fixed Cost) in multiple campaign runs. If you want
the number attribute multiple times, count the number attribute separately for
each run. Then, use a contact calendar attribute (for example, Contact Date) in
your reports.
© Copyright IBM Corp. 2015
11
v To avoid double data counts when you analyze responses without contacts, use
only a Response Calendar. To analyze contact and response data together, do not
use any Response Calendar dimension.
v To avoid double data counts when you analyze data at the campaign level, do
not use Offer Attributes.
Building reports in IBM Cognos Query Studio
Build reports in either IBM Cognos Query Studio or IBM Cognos Report Studio.
After you save the report, you can log in to IBM Campaign to run the report with
the data in IBM Campaign.
About this task
Reports builder provides the following unique measures:
v Unique Recipients
v Unique Recipients Control Group
v Unique Responders
v Unique Responders Control Group
v Not Contacted Responders
You have limited access to the unique KPIs. These unique KPIs are limited to the
following entities in the model:
v Campaign
v Offer
v Campaign and Offer
v Campaign and Cell
v Campaign and Cell and Offer
Tips: Consider the following items when you build reports:
v Use a Response Calendar only when you analyze responses without contacts. Do
not use any Response Calendar dimensions to analyze contact and response data
together.
v Unique Recipient and Unique Responder KPIs are calculated during runtime, so
performance might not be optimal. You might want to schedule these types of
reports during low-use times.
To build a report in IBM Query studio and view it in IBM Campaign, complete the
following steps.
Procedure
1. In your web browser, navigate to IBM Cognos (http://<hostname>:<port>/
ibmcognos).
2. If you see the Welcome page, click Query my data. If you see Public folders,
select Launch > Query Studio.
3. Select a package, either IBM Campaign Reports Builder Package or IBM
Campaign Reports Builder Package for Drill Down.
4. In Query Studio, create a report.
Select the views that you want in your report. The query items that are
contained in the views are described in the following topics:
v “Views/Materialized Views” on page 13
12
IBM Campaign Reports Builder
5.
6.
7.
8.
9.
v “Business View: IBM Campaign Reports Builder Package” on page 20
v “Business View: IBM Campaign Reports Builder Package for Drill Down” on
page 26
For more information about creating reports, refer to the IBM Cognos Query
Studio User Guide.
Save the report in one of the folders that is accessible from IBM Campaign.
In your web browser, navigate to IBM Unica (http://<hostname>:<port>/
unica).
Select Analytics > Campaign Analytics.
Navigate to the folder from step 5.
Run the report.
Views/Materialized Views
The following tables list the columns and references for the Views/Materialized
Views that are available in Reports Builder.
ICR_CAMPAIGN
This view is based on the UA_Campaign table and provides information about
campaigns.
Column
Reference
CAMPAIGNID
UA_Campaign.CampaignID
NAME
UA_Campaign.Name
DESCRIPTION
UA_Campaign.Description
CAMPAIGNCODE
UA_Campaign.CampaignCode
OBJECTIVES
UA_Campaign.Objectives
LASTRUNDATE
UA_Campaign.LastRunDate
INITIATIVE
UA_Campaign.Initiative
CREATEDATE
UA_Campaign.CreateDate
UPDATEDATE
UA_Campaign.UpdateDate
STARTDATE
UA_Campaign.StartDate
ENDDATE
UA_Campaign.EndDate
CREATEBY
UA_Campaign.CreateBy
UPDATEBY
UA_Campaign.UpdateBy
RUNBY
UA_Campaign.RunBy
PROJECTID
UA_Campaign.ProjectID
CREATEORFLAG
UA_Campaign.CreatorFlag
ICR_OFFER
This view is based on the UA_Offer and UA_OfferHistory tables and provides
information about offers and offer versions.
Column
Reference
OFFERID
UA_Offer.OfferID
Chapter 3. How IBM Campaign Reports Builder works
13
Column
Reference
OFFERHISTORYID
UA_Treatment.OfferHistoryID
NAME
UA_Offer.Name
DESCRIPTION
UA_Offer.Description
OFFERCODE1
UA_Offer.OfferCode1
OFFERCODE2
UA_Offer.OfferCode2
OFFERCODE3
UA_Offer.OfferCode3
OFFERCODE4
UA_Offer.OfferCode4
OFFERCODE5
UA_Offer.OfferCode5
CREATEDATE
UA_Offer.CreateDate
CREATEBY
UA_Offer.CreateBy
UPDATEDATE
UA_Offer.UpdateDate
UPDATEBY
UA_Offer.UpdateBy
RETIRED
UA_Offer.Retired
ICR_CELL
This view is based on the UA_TARGETCELLS table and provides information
about cells.
Column
Reference
CELLID
UA_TargetCells.CellID
CELLNAME
UA_TargetCells.CellName
CELLCODE
UA_TargetCells.CellCode
CONTROLCELLID
UA_TargetCells.ControlCellID
ISCONTROL
UA_TargetCells.IsControl
CAMPAIGNID
UA_TargetCells.CampaignID
ICR_OFFEREXTATTR
This view is based on the UA_ OFFERHISTATTRIB and the UA_TREATMENT
tables. This view provides information about offer attributes with the
corresponding offer history.
14
Column
Reference
OFFERID
UA_Treatment.OfferID
CAMPAIGNID
UA_Treatment.CampaignID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
EFFECTIVE_DATE
UA_OfferHistAttrib.DatetimeValue
EXPIRATION_DATE
UA_OfferHistAttrib.DatetimeValue
CHANNEL
UA_OfferHistAttrib.StringValue
EXPIRATION_DUR
UA_OfferHistAttrib.NumberValue
COST_PER_CONTACT
UA_OfferHistAttrib.NumberValue
REVENUE_PER_RESP
UA_OfferHistAttrib.NumberValue
IBM Campaign Reports Builder
Column
Reference
OFFER_FIXED_COST
UA_OfferHistAttrib.NumberValue
OFFER_FULFILL_COST
UA_OfferHistAttrib.NumberValue
ICR_CCOCH_DY_ALL
This view provides contact summary data at the campaign, cell, and offer levels.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
CONTROLCELLID
UA_Treatment.CntrlCellID
OFFERID
UA_Treatment.OfferID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_Calendar.DateID
NUM_OF_OFFERS
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_Treatment.TreatmentSize END)
NUM_OF_OFFERS_CG
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_Treatment.TreatmentSize END)
ICR_CCOCH_DY
This view provides contact summary data at the campaign, cell (both target and
control cell), and offer levels.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
OFFERID
UA_Treatment.OfferID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_Calendar.DateID
NUM_OF_OFFERS
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_Treatment.TreatmentSize END)
NUM_OF_OFFERS_CG
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_Treatment.TreatmentSize END)
ICR_CCORH_DY_ALL
This view provides contact summary data at the campaign, cell, and offer levels.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
CONTROLCELLID
UA_Treatment.CntrlCellID
OFFERID
UA_Treatment.OfferID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
Chapter 3. How IBM Campaign Reports Builder works
15
Column
Reference
CONTACTDATEID
UA_Calendar.DateID
RESP_TRANS
count (CASE UA_Treatment.CntrlTreatmtFlag WHEN 0
THEN UA_ResponseHistory.BestAttrib END)
RESP_TRANS_CG
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.BestAttrib END)
RESP_AFTER_EXP
count (CASE WHEN
UA_ResponseHistory.WithinDateRangeFlg=0 AND
UA_Treatment.CntrlTreatmtFlag=0 THEN
UA_ResponseHistory.BestAttrib END)
RESP_AFTER_EXP_CG
count (CASE WHEN
UA_ResponseHistory.WithinDateRangeFlg=0 AND
UA_Treatment.CntrlTreatmtFlag=1 THEN
UA_ResponseHistory.BestAttrib END)
REVENUE_PER_RESP
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
REV_PER_RESP_CG
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
GROSS_REVENUE
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
GROSS_REVENUE_CG
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
ICR_CCORH_DY
This view provides contact summary data at the campaign, cell (both target and
control cell), and offer levels.
16
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
OFFERID
UA_Treatment.OfferID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_Calendar.DateID
RESP_TRANS
count (CASE UA_Treatment.CntrlTreatmtFlag WHEN 0
THEN UA_ResponseHistory.BestAttrib END)
RESP_TRANS_CG
count(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.BestAttrib END)
RESP_AFTER_EXP
count (CASE WHEN
UA_ResponseHistory.WithinDateRangeFlg=0 AND
UA_Treatment.CntrlTreatmtFlag=0 THEN
UA_ResponseHistory.BestAttrib END)
RESP_AFTER_EXP_CG
count (CASE WHEN
UA_ResponseHistory.WithinDateRangeFlg=0 AND
UA_Treatment.CntrlTreatmtFlag=1 THEN
UA_ResponseHistory.BestAttrib END)
REVENUE_PER_RESP
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
REV_PER_RESP_CG
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
IBM Campaign Reports Builder
Column
Reference
GROSS_REVENUE
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
GROSS_REVENUE_CG
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
ICR_CORBO_ALL
This view provides response breakout data at the campaign, cell, and offer levels.
This view provides information about response data for different response types.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
OFFERID
UA_Treatment.OfferID
CELLID
UA_Treatment.CellID
ISCONTROL
UA_TargetCells.CntrlTreatmtFlag
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_ContactDate.CONTACTDATEID
RESPDATEID
UA_ResponseHistory.DateID
ALL_RESPONSES
SUM(1)
ALL_COUNTS_AS_RESP
Count(case when UA_UsrResponseType.CountsAsResponse=1
then UA_ResponseHistory.CustomerID end)
EXPLORE_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='EXP' THEN 1
END)
EXPLORE_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='EXP' THEN 1
END)
CONSIDER_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='CON' THEN 1
END)
CONSIDER_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='CON' THEN 1
END)
COMMIT_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='CMT' THEN 1
END)
COMMIT_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='CMT' THEN 1
END)
FULFILL_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='FFL' THEN 1
END)
FULFILL_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='FFL' THEN 1
END)
USAGE_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='USE' THEN 1
END)
Chapter 3. How IBM Campaign Reports Builder works
17
Column
Reference
USAGE_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='USE' THEN 1
END)
UNKNOWN_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='UKN' THEN 1
END)
UNKNOWN_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='UKN' THEN 1
END)
ICR_CORBO
This view provides response breakout data from the ICR_CORBO_ALL table as the
union of data for control cell 0 and control cell 1. This view provides information
about response data for different response types.
18
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
OFFERID
UA_Treatment.OfferID
CELLID
UA_Treatment.CellID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_ContactDate.CONTACTDATEID
RESPDATEID
UA_ResponseHistory.DateID
ALL_COUNTS_AS_RESP
SUM(UA_UsrResponseType.CountsAsResponse)
ALL_RESPONSES
SUM(1)
EXPLORE_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='EXP' THEN 1
END)
EXPLORE_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='EXP' THEN 1
END)
CONSIDER_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='CON' THEN 1
END)
CONSIDER_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='CON' THEN 1
END)
COMMIT_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='CMT' THEN 1
END)
COMMIT_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='CMT' THEN 1
END)
FULFILL_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='FFL' THEN 1
END)
FULFILL_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='FFL' THEN 1
END)
IBM Campaign Reports Builder
Column
Reference
USAGE_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='USE' THEN 1
END)
USAGE_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='USE' THEN 1
END)
UNKNOWN_COUNT
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=0 AND
UA_UsrResponseType.ResponseTypeCode='UKN' THEN 1
END)
UNKNOWN_COUNT_CG
SUM(CASE WHEN UA_Treatment.CntrlTreatmtFlag=1 AND
UA_UsrResponseType.ResponseTypeCode='UKN' THEN 1
END)
ICR_OPM_SUMMARY
This view provides information about offer performance summary.
Column
Reference
OFFERID
UA_Treatment.OfferID
BEST_MATCH
sum(UA_ResponseHistory.BestAttrib)
BEST_MATCH_CG
sum(UA_Treatment.CntrlTreatmtFlag *
UA_ResponseHistory.BestAttrib)
FRACTIONAL_MATCH
sum(UA_ResponseHistory.FractionalAttrib)
MULTIPLE_MATCH
sum(CEIL(UA_ResponseHistory.FractionalAttrib))
REVENUE_PER_RESP
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
REV_PER_RESP_CG
AVG(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
GROSS_REVENUE
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 0 THEN
UA_ResponseHistory.ResponseRevenue END)
GROSS_REVENUE_CG
SUM(CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ResponseHistory.ResponseRevenue END)
ICR_UNIQUE_RECIPIENTS
This view provides contact summary data at the campaign, cell, and offer levels as
well as unique recipient data.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
OFFERID
UA_Treatment.OfferID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
CONTACTDATEID
UA_Calendar.DATEID
UNIQUE_RECIPIENTS
Cast((CASE WHEN UA_Treatment.CntrlTreatmtFlag = 0 and
UA_ContactStatus.CountsAsContact=1 THEN
UA_ContactHistory.CustomerID END) as Varchar(50))
Chapter 3. How IBM Campaign Reports Builder works
19
Column
Reference
UNIQUE_RECIP_CG
Cast((CASE UA_Treatment.CntrlTreatmtFlag WHEN 1 THEN
UA_ContactHistory.CustomerID END)) as Varchar(50))
ICR_UNIQUE_RESPONDERS
This view provides response summary data at the campaign, cell, and offer levels
as well as unique responder data.
Note: Numeric audience IDs are type Cast into a Varchar data type so that data
for multiple audience levels can be shown on the reports. A Count Distinct
function is performed on this type Cast Varchar data type.
Column
Reference
CAMPAIGNID
UA_Treatment.CampaignID
CELLID
UA_Treatment.CellID
OFFERID
UA_Treatment.OfferID
CONTACTDATEID
UA_Calendar.DateID
RESPDATEID
UA_ResponseHistory.DateID
OFFERHISTORYID
UA_Treatment.OfferHistoryID
UNIQUE_RESPONDERS
Cast((CASE WHEN
UA_TREATMENT.CNTRLTREATMTFLAG = 0 THEN
UA_RESPONSEHISTORY.CUSTOMERID END)) as
Varchar(50))
UNIQUE_RESP_CG
Cast((CASE WHEN
UA_TREATMENT.CNTRLTREATMTFLAG = 1 THEN
UA_RESPONSEHISTORY.CUSTOMERID END)) as
Varchar(50))
NOT_CONT_RESP
Cast((CASE WHEN UA_ResponseHistory.OrigContactedFlg =
0 AND UA_Treatment.CntrlTreatmtFlag= 0 THEN
UA_ResponseHistory.CustomerID END)) as Varchar(50))
ICR_LOOKUP
This table is used to store the localized values.
Column
Reference
LKUP_ID
LKUP_CATEGORY
LKUP_VALUE
LOCALE
Business View: IBM Campaign Reports Builder Package
The objects within the business view of the IBM Campaign Reports Builder
Package are available to report authors. The following tables describe the query
items that are contained within the query subjects of this business view.
20
IBM Campaign Reports Builder
Campaign
Query items
Use
Description
Campaign
Attribute
Name of campaign
Campaign Description
Attribute
Description of the campaign
Campaign Code
Attribute
Code for the campaign
Campaign Objectives
Attribute
Description of the campaign objectives
Campaign Last Run
Date
Identifier
Date and time that the campaign was last run
Campaign Initiative
Attribute
Initiative that is associated with this
campaign
Campaign Created
Date
Identifier
Date and time that the campaign was created
Campaign Updated
Date
Identifier
Date and time that the object was last
updated
Campaign Start Date
Identifier
Date that the campaign is effective
Campaign End Date
Identifier
Date that the campaign expires
Campaign Created by
Attribute
IBM Marketing Platform user ID of the user
who created the campaign
Campaign Updated by Attribute
IBM Marketing Platform user ID for the user
who last updated the object
Campaign Run by
Attribute
IBM Marketing Platform user ID for the user
who last ran the campaign
Campaign Project ID
Identifier
Marketing Operations project ID
Campaign Creator
Flag
Attribute
Application that created the custom
campaign
Query items
Use
Description
Offer
Attribute
Name of offer
Offer Description
Attribute
Description of the offer
Offer Code1
Attribute
First part of the offer code
Offer Code2
Attribute
First part of the offer code. Populated if
NumberOfOfferCodes >= 2.
Offer Code3
Attribute
First part of the offer code. Populated if
NumberOfOfferCodes >= 3.
Offer Code4
Attribute
First part of the offer code. Populated if
NumberOfOfferCodes >= 4.
Offer Code5
Attribute
First part of the offer code. Populated if
NumberOfOfferCodes >= 5.
Offer Created Date
Identifier
Date and time that the offer was created
Offer Created by
Identifier
IBM Marketing Platform user ID of the user
who created the offer
Offer Updated Date
Identifier
Date and time the offer was last updated
Offer Updated by
Identifier
IBM Marketing Platform user ID for the user
who last updated the offer
Offer
Chapter 3. How IBM Campaign Reports Builder works
21
Query items
Use
Description
Is Offer Retired
Attribute
Specifies whether an offer was retired
Query items
Use
Description
Segment (Cell)
Attribute
Name of cell
Cell Code
Attribute
String value that identifies the cell
Query items
Use
Description
Contact Date ID
Identifier
Date identifier that represents the Contact
Date
Contact Month ID
Identifier
Month identifier that represents the Contact
Month
Contact Year
Attribute
Four-digit year for the date
Contact Fiscal Year
Attribute
Four-digit fiscal year for the date
Contact Month Year
Attribute
Month year value in which the date falls
Contact Date
Attribute
The date represented in this row
Cell
Contact Calendar
Response Calendar
Query items
Use
Description
Response Date ID
Identifier
Date identifier that represents the Response
Date
Response Month ID
Identifier
Month identifier that represents the Response
Month
Response Year
Attribute
Four-digit year for the date
Response Fiscal Year
Attribute
Four-digit fiscal year for the date
Response Month Year
Attribute
Month year value in which the date falls
Response Date
Attribute
The date represented in this row
Contact measures
Query items
Use
Description
Offers Given
Fact
Number of offers given to individuals
Offers Given Control
Group
Fact
Number of offers given to individuals from
the control group
Response measures
In response measures, the Revenue Per Response and Revenue Per Response
Control Group have average aggregate functions that provide the average value for
complete data. To get the correct average value for the selected dimension or
filters, select the column and apply the summarize property. Set it to the desired
property when you build the report in either Query Studio or Report Studio.
22
IBM Campaign Reports Builder
Query items
Use
Description
Response Transactions
Fact
Number of responses received
Response Transactions
Control Group
Fact
Number of responses received from the
control group
Responses after
Expiration
Fact
Number of individuals who responded after
the offer expired
Responses after
Expiration Control
Group
Fact
Number of individuals from the control
group who responded after the offer expired
Revenue per Response Fact
Revenue obtained for each response
Revenue per Response Fact
Control Group
Revenue obtained for each response from the
control group
Gross Revenue
Total revenue
Fact
Gross Revenue Control Fact
Group
Total revenue from the control group
Offer attributes
Query items
Use
Description
Offer Version ID
Identifier
Identifier for the offer version
Offer Effective Date
Identifier
Date that the offer is effective
Offer Expiration Date
Identifier
Date that the offer expires
Channel
Attribute
Channel that was used to send the offer
Offer Expiration
Duration
Attribute
Duration in which the offer is valid
Cost per Contact
Attribute
Cost associated with each contact
Offer Fixed Cost
Attribute
Fixed cost that is associated with the offer
Offer Fulfillment Cost
Attribute
Fulfillment cost that is associated with the
offer
Response breakout by response types
Response types that are indicated with an asterisk (*) are the response types with
UA_USRRESPONSETYPE.CountsAsResponse=1. The system table contains the following
values for the response types:
v 0 - does not count as a response
v 1 - counts as a positive response
v 2 - counts as a negative response
"Counts As Response (All)" is the sum of all such response types.
Query items
Use
Description
Responses (ALL)
Fact
Sum of all responses
*Counts as Response
(All)
Fact
Sum of all responses that count as responses
*Commit Count
Fact
Sum of responses received for the Response
Type Code CMT
Chapter 3. How IBM Campaign Reports Builder works
23
Query items
Use
Description
*Commit Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code CMT
*Unknown Count
Fact
Sum of responses received for the Response
Type Code UKN
*Unknown Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code UKN
Consider Count
Fact
Sum of responses received for the Response
Type Code CON
Consider Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code CON
Explore Count
Fact
Sum of responses received for the Response
Type Code EXP
Explore Count Control Fact
Group
Sum of responses received from the control
group for the Response Type Code EXP
Fulfill Count
Fact
Sum of responses received for the Response
Type Code FFL
Fulfill Count Control
Group
Fact
Sum of responses received from the control
group for the Response Type Code FFL
Usage Count
Fact
Sum of responses received for the Response
Type Code USE
Usage Count Control
Group
Fact
Sum of responses received from the control
group for the Response Type Code USE
Other Response Types
Fact
All responses minus the sum of responses
that are counted as responses
Note: For all of the Unique KPIs, apply the correct aggregation property when you
build your reports in Query Studio or Report Studio to get the correct summary
data at different levels and with different filters.
Unique measures by campaign
Table 1. Unique recipients by campaign
Query items
Use
Description
Unique Recipients
Fact
Number of unique individuals who received
the offer
Unique Recipients
Control Group
Fact
Number of unique individuals from the
control group who received the offer
Table 2. Unique responders by campaign
24
Query items
Use
Description
Unique Responders
Fact
Number of unique individuals who
responded to the offer
Unique Responders
Control Group
Fact
Number of unique individuals from the
control group who responded to the offer
Not Contacted
Responders
Fact
Number of individuals who were not
contacted (controlled)
IBM Campaign Reports Builder
Unique measures by offer
Table 3. Unique recipients by offer
Query items
Use
Description
Unique Recipients
Fact
Number of unique individuals who
received the offer
Unique Recipients Control Fact
Group
Number of unique individuals from the
control group who received the offer
Table 4. Unique responders by offer
Query items
Use
Description
Unique Responders
Fact
Number of unique individuals who
responded to the offer
Unique Responders
Control Group
Fact
Number of unique individuals from the
control group who responded to the offer
Not Contacted
Responders
Fact
Number of individuals who were not
contacted (controlled)
Unique measures by campaign and offer
Table 5. Unique recipients by campaign and offer
Query items
Use
Description
Unique Recipients
Fact
Number of unique individuals who
received the offer
Unique Recipients Control Fact
Group
Number of unique individuals from the
control group who received the offer
Table 6. Unique responders by campaign and offer
Query items
Use
Description
Unique Responders
Fact
Number of unique individuals who
responded to the offer
Unique Responders
Control Group
Fact
Number of unique individuals from the
control group who responded to the offer
Not Contacted
Responders
Fact
Number of individuals who were not
contacted (controlled)
Unique measures by campaign and cell
Table 7. Unique recipients by campaign and cell
Query items
Use
Description
Unique Recipients
Fact
Number of unique individuals who
received the offer
Unique Recipients Control Fact
Group
Number of unique individuals from the
control group who received the offer
Chapter 3. How IBM Campaign Reports Builder works
25
Table 8. Unique responders by campaign and cell
Query items
Use
Description
Unique Responders
Fact
Number of unique individuals who
responded to the offer
Unique Responders
Control Group
Fact
Number of unique individuals from the
control group who responded to the offer
Not Contacted
Responders
Fact
Number of individuals who were not
contacted (controlled)
Unique measures by campaign, cell, and offer
Table 9. Unique recipients by campaign, cell, and offer
Query items
Use
Description
Unique Recipients
Fact
Number of unique individuals who
received the offer
Unique Recipients Control Fact
Group
Number of unique individuals from the
control group who received the offer
Table 10. Unique responders by campaign, cell, and offer
Query items
Use
Description
Unique Responders
Fact
Number of unique individuals who
responded to the offer
Unique Responders
Control Group
Fact
Number of unique individuals from the
control group who responded to the offer
Not Contacted
Responders
Fact
Number of individuals who were not
contacted (controlled)
Offer performance metrics
Note: Offer performance metrics should be used only for offer performance
analysis.
Query items
Use
Description
Best Match
Fact
Sum of all responses that are attributed as
“Best" treatment
Best Match Control
Group
Fact
Sum of all responses from the control group
that are attributed as “Best" treatment
Fractioned Match
Fact
Sum of all responses that are attributed by
fractional response values
Multiple Match
Fact
Sum of all responses from the control group
that are attributed by fractional response
values
Business View: IBM Campaign Reports Builder Package for Drill Down
The objects within the business view of the IBM Campaign Reports Builder
Package for Drill Down are available to report authors. The following tables
describe the query items that are contained within the query subjects of this
business view.
26
IBM Campaign Reports Builder
Measure dimensions: Contact measures
Query items
Use
Description
Offers Given
Fact
Number of offers given to individuals
Offers Given Control
Group
Fact
Number of offers given to the individuals
from the control group
Measure dimensions: Response measures
Query items
Use
Description
Response Transactions
Fact
Number of responses received
Response Transactions
Control Group
Fact
Number of responses received from the
control group
Responses after
Expiration
Fact
Number of individuals who responded after
the offer expired
Responses after
Expiration Control
Group
Fact
Number of individuals from the control
group who responded after the offer expired
Revenue per Response Fact
Revenue obtained for each response
Revenue per Response Fact
Control Group
Revenue obtained for each response from
control group
Gross Revenue
Total revenue
Fact
Gross Revenue Control Fact
Group
Total revenue from the control group
Measure dimensions: Offer attributes
Query items
Use
Description
Offer Version ID
Identifier
Identifier for the offer version
Offer Effective Date
Identifier
Date the offer is effective
Offer Expiration Date
Identifier
Date the offer expires
Channel
Attribute
Channel that was used to send the offer
Offer Expiration
Duration
Attribute
Duration in which the offer is valid
Cost per Contact
Attribute
Cost associated with each contact
Offer Fixed Cost
Attribute
Fixed cost that is associated with the offer
Offer Fulfillment Cost
Attribute
Fulfillment cost that is associated with the
offer
Regular dimensions: Campaign
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Month ID
Month
Level 3
Contact Date ID
Day
Chapter 3. How IBM Campaign Reports Builder works
27
Regular dimensions: Campaign cell
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Cell ID
Cell
Regular dimensions: Campaign offer
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Offer ID
Offer
Regular dimensions: Campaign cell offer
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Cell ID
Cell
Level 3
Offer ID
Offer
Regular dimensions: Monthly campaign offer performance
Note: When you pull only the month dimension into a report, it shows a complete
month calendar. But when you pull any measure against it, the report shows the
relevant month values.
Hierarchy
Business key
Member caption
Level 1
Month ID
Month
Level 2
Campaign ID
Campaign
Level 3
Offer ID
Offer
Measure dimensions: Response breakout by response types
Response types that are indicated with an asterisk (*) are the response types with
UA_USRRESPONSETYPE.CountsAsResponse=1. The system table contains the following
values for the response types:
v 0 - does not count as a response
v 1 - counts as a positive response
v 2 - counts as a negative response
"Counts As Response (All)" is the sum of all such response types.
28
Query items
Use
Description
Responses (ALL)
Fact
Sum of all responses
*Counts as Response
(All)
Fact
Sum of all responses that counts as responses
*Commit Count
Fact
Sum of responses received for the Response
Type Code CMT
IBM Campaign Reports Builder
Query items
Use
Description
*Commit Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code CMT
*Unknown Count
Fact
Sum of responses received for the Response
Type Code UKN
*Unknown Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code UKN
Consider Count
Fact
Sum of responses received for the Response
Type Code CON
Consider Count
Control Group
Fact
Sum of responses received from the control
group for the Response Type Code CON
Explore Count
Fact
Sum of responses received for the Response
Type Code EXP
Explore Count Control Fact
Group
Sum of responses received from the control
group for the Response Type Code EXP
Fulfill Count
Fact
Sum of responses received for the Response
Type Code FFL
Fulfill Count Control
Group
Fact
Sum of responses received from the control
group for the Response Type Code FFL
Usage Count
Fact
Sum of responses received for the Response
Type Code USE
Usage Count Control
Group
Fact
Sum of responses received from the control
group for the Response Type Code USE
Other Response Types
Fact
All responses minus the sum of responses
that are counted as responses
Regular dimensions: Campaign offer day response breakout
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Offer ID
Offer
Level 3
Contact Date ID
Day
Regular dimensions: Campaign day response breakout
Hierarchy
Business key
Member caption
Level 1
Campaign ID
Campaign
Level 2
Contact Date ID
Day
Example: Creating a relational report in IBM Cognos Query Studio
For this example, use IBM Cognos Query Studio to create a relational report.
About this task
To analyze campaign offer performance for contact and response measures, create a
report to view your campaign and offer for the following information:
v Offers given
Chapter 3. How IBM Campaign Reports Builder works
29
v
v
v
v
Unique responders
Cost
Gross revenue
ROI measures
To create a report in IBM Cognos Query Studio, complete the following steps:
Procedure
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
30
Use IBM Cognos Connection to access IBM Query Studio.
Click Query my data.
Select IBM Campaign Reports Builder Package.
Expand Business View > Relational View.
Drag and drop the desired reporting components into the design area.
Expand the campaign and insert Campaign.
Select the campaign and click the Group by icon
.
Expand the offer and insert Offer.
Expand the contact measures and insert Offers Given.
Select Unique measures > By Campaign and Offer > Unique Responders by
Campaign and Offer and insert Unique Responders.
Expand the offer attributes and insert Cost per Contact.
To calculate the Cost measure, complete the following steps:
a. Select the columns Offers Given and Cost per Contact.
b. Right-click and select calculate.
c. Select operations as multiplication.
d. Choose the new item name as Total Cost.
e. Click Insert.
Expand the response measures and insert Gross Revenue.
To calculate the Profit measure, complete the following steps:
a. Select Total Cost and Gross Revenue.
b. Right-click and select calculate.
c. Select operations as subtraction.
d. Choose the new item name as Net Profit.
e. Click Insert.
To calculate ROI, complete the following steps:
a. Select Net Profit and Total Cost.
b. Right-click and select calculate.
c. Select operations as Division.
d. Choose the new item name as ROI %.
e. Click Insert.
f. Right-click ROI % and select Format data > category as percentage.
g. Click OK.
IBM Cognos Query Studio has limitations on summary values for the
calculate % values. To hide this value, complete the following steps:
a. Right-click on the ROI.
b. Click Summarize.
c. Remove the check mark for Show summaries for footers.
IBM Campaign Reports Builder
17. To
a.
b.
c.
18. To
a.
b.
c.
d.
e.
view filtered campaigns, complete the following steps:
Right-click in the Campaign column and select Filter.
Select the campaigns for the report.
Click OK.
define conditional styling, complete the following steps:
Right-click on the Gross Revenue.
Select Define conditional styles.
Type a value, such as 140, and insert.
Set a font color for each condition.
Click Apply.
Note: Repeat step 18 to conditionally style the KPIs wherever required.
19. To view all KPIs over a campaign in a pie chart, select the campaign and click
the chart icon
.
20. Save the report in the root folder Affinium Campaign/Sample Reports with the
name Campaign Offer Financial Summary.
Results
The following screen shows the output from this report.
Example: Creating a dimensional report in IBM Cognos Query Studio
For this example, use IBM Cognos Query Studio to create a dimensional report.
Chapter 3. How IBM Campaign Reports Builder works
31
About this task
To analyze campaign breakout responses for the following levels:
v campaign
v offer
v date
To create a report in IBM Cognos Query Studio, complete the following steps:
Procedure
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Use IBM Cognos Connection to access IBM Query Studio.
Click Query my data.
Select IBM Campaign Reports Builder Package for Drill Down.
Select Business View > Dimensional View.
Drag and drop Campaign Offer Day Response Breakout > Campaign into
the design area.
Expand the contact measures and insert Offers Given.
Expand the Response measures and insert Response Transaction.
To calculate % Responses, complete the following steps:
a. Select Offers Given and Response Transaction.
b. Right-click and select calculate.
c. Select the operation type Percentage.
d. Choose the new item name as Response %.
e. Click Insert.
Expand Response breakout by Response types and insert KPI measures such
as Responses(All), Commit Count, and Explore Count.
Save the report in the root folder Affinium Campaign/Sample Reports with the
name Campaign Response Breakout.
Results
Note: The following sample reports were taken from IBM Cognos 10.2.0 with IBM
Campaign 9.1. The reports might look different in IBM Cognos 10.2.1 with IBM
Campaign 9.1.1 or later versions.
The following screen shows the output from this report for the campaign level.
The following screen shows the output from this report after drill down at the
offer level.
32
IBM Campaign Reports Builder
The following screen shows the output from this report after drill down at the date
level.
Chapter 3. How IBM Campaign Reports Builder works
33
34
IBM Campaign Reports Builder
Before you contact IBM technical support
If you encounter a problem that you cannot resolve by consulting the
documentation, your company's designated support contact can log a call with
IBM® technical support. Use these guidelines to ensure that your problem is
resolved efficiently and successfully.
If you are not a designated support contact at your company, contact your IBM
administrator for information.
Note: Technical Support does not write or create API scripts. For assistance in
implementing our API offerings, contact IBM Professional Services.
Information to gather
Before you contact IBM technical support, gather the following information:
v A brief description of the nature of your issue.
v Detailed error messages that you see when the issue occurs.
v Detailed steps to reproduce the issue.
v Related log files, session files, configuration files, and data files.
v Information about your product and system environment, which you can obtain
as described in "System information."
System information
When you call IBM technical support, you might be asked to provide information
about your environment.
If your problem does not prevent you from logging in, much of this information is
available on the About page, which provides information about your installed IBM
applications.
You can access the About page by selecting Help > About. If the About page is not
accessible, check for a version.txt file that is located under the installation
directory for your application.
Contact information for IBM technical support
For ways to contact IBM technical support, see the IBM Product Technical Support
website: (http://www.ibm.com/support/entry/portal/open_service_request).
Note: To enter a support request, you must log in with an IBM account. This
account must be linked to your IBM customer number. To learn more about
associating your account with your IBM customer number, see Support Resources
> Entitled Software Support on the Support Portal.
© Copyright IBM Corp. 2015
35
36
IBM Campaign Reports Builder
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
© Copyright IBM Corp. 2015
37
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
B1WA LKG1
550 King Street
Littleton, MA 01460-1250
U.S.A.
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
38
IBM Campaign Reports Builder
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at www.ibm.com/legal/copytrade.shtml.
Privacy Policy and Terms of Use Considerations
IBM Software products, including software as a service solutions, ("Software
Offerings") may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user or for other purposes. A cookie is a piece of data that a web site can
send to your browser, which may then be stored on your computer as a tag that
identifies your computer. In many cases, no personal information is collected by
these cookies. If a Software Offering you are using enables you to collect personal
information through cookies and similar technologies, we inform you about the
specifics below.
Depending upon the configurations deployed, this Software Offering may use
session and persistent cookies that collect each user's user name, and other
personal information for purposes of session management, enhanced user usability,
or other usage tracking or functional purposes. These cookies can be disabled, but
disabling them will also eliminate the functionality they enable.
Various jurisdictions regulate the collection of personal information through
cookies and similar technologies. If the configurations deployed for this Software
Offering provide you as customer the ability to collect personal information from
end users via cookies and other technologies, you should seek your own legal
advice about any laws applicable to such data collection, including any
requirements for providing notice and consent where appropriate.
IBM requires that Clients (1) provide a clear and conspicuous link to Customer's
website terms of use (e.g. privacy policy) which includes a link to IBM's and
Client's data collection and use practices, (2) notify that cookies and clear gifs/web
beacons are being placed on the visitor's computer by IBM on the Client's behalf
along with an explanation of the purpose of such technology, and (3) to the extent
required by law, obtain consent from website visitors prior to the placement of
cookies and clear gifs/web beacons placed by Client or IBM on Client's behalf on
website visitor's devices
For more information about the use of various technologies, including cookies, for
these purposes, See IBM's Online Privacy Statement at: http://www.ibm.com/
privacy/details/us/en section entitled "Cookies, Web Beacons and Other
Technologies."
Notices
39
40
IBM Campaign Reports Builder
IBM®
Printed in USA