Installation roadmap
Use the installation roadmap to quickly find the information that you need for installing IBM® EMM reports.
The following table provides a high level overview of the IBM EMM reports installation process, with brief descriptions of the steps involved and information on where to find detailed instructions:
| Step | Description | Where to find details |
|---|---|---|
| Installing reporting components | ||
| Understanding prerequisites. | Understand system prerequisites that are required for installing reports. | See IBM Enterprise Marketing Management Products Recommended Software Environments and Minimum System Requirements. |
| Understanding prerequisites for eMessage. | Understand additional prerequisites for installing eMessage reports. | See Prerequisites for eMessage Reports |
| Installing IBM EMM products. | Install the products that provide the data that is used in reports. | See the individual product installation guides. |
| Setting up a system user. | Configure a user with access to the Settings > Configuration and Settings > Report SQL Generator pages so you can log in as this user when you need to configure the reporting properties and generate the SQL used to create reporting schema. | See Configuring a user with the ReportsSystem role. |
| Installing the reporting schemas on the machine where the Marketing Platform is installed. | Place the HCL master installer and the report pack installers in the same directory and launch the master installer. | See Installing reporting schemas on the IBM EMM system |
| Creating JDBC data sources. | In the application server where the Marketing Platform is deployed, create JDBC data source connections to the system table databases for the products you want to use for reporting. | See Creating JDBC data sources. |
| Installing and testing IBM Cognos® BI | ||
| Installing IBM Cognos BI | Use the IBM Cognos documentation to guide your installation, and then test the system. | See Install and test IBM Cognos BI. |
| Installing IBM EMM integration components and report models on the Cognos system | ||
| Obtaining the JDBC driver used for the Marketing Platform system tables. | Copy the JDBC driver used for Marketing Platform to the machine where the Cognos Content Manager is installed. When HCL authentication is implemented, Cognos uses this when it obtains user information. | See Obtain the JDBC driver for the Marketing Platform system tables. |
| Installing the reporting models and integration component on the Cognos system. | Place the IBM EMM master installer, Marketing Platform installer, and product report pack installers in the same directory on the machine where the Cognos Content Manager is installed, and launch the master installer. | See Installing the reporting models and integration component on the HCL Cognos system. |
| Creating the Cognos data sources for the IBM EMM application databases. | The Cognos applications need to connect to the IBM EMM application data sources for the reports. Use the Administration section of Cognos Connection to create these data sources. | See Creating HCL Cognos data sources for IBM EMM application databases. |
| Setting up email notification. | If you want to enable an option for sending a report as an email attachment, configure notification in Cognos Configuration. | See Setting up email notifications. |
| Configuring the Cognos firewall. | In Cognos Configuration, specify the IBM EMM system as a valid domain or host. | See Configuring HCL Cognos Application Firewall for IBM EMM. |
| For eMessage, running scripts to create staging tables, indexes, and stored procedures. | Run the scripts that are necessary to create staging tables, indexes, and stored procedures for eMessage reports. | See For eMessage reports, creating stored procedures, staging tables, and indexes |
| Loading the templates for the Reports SQL Generator. | To implement reporting for Campaign, eMessage, and Interact, you create reporting views or tables from which the reports extract reportable data. The reports packs contain templates that the Reports SQL Generator uses when generating SQL scripts for creating these views or tables. In this step, you load these templates into the Marketing Platform system table database. | See Loading templates for Reports SQL Generator. |
| Generating the view or table creation scripts. | Set some required configuration properties, and then use the Report SQL Generator to produce the SQL for creating the reporting views or tables. | See Generating view or table creation scripts. |
| Creating the reporting views or tables. | Create the views or tables in the IBM EMM product system table databases. | See one of the following topics:. |
| Importing the reports folder. | In Cognos Connection, import the compressed file for reports. | See Importing the reports folder in Cognos Connection. |
| Configuring and publishing the data model. | If the data source login you used when you created the Cognos data sources is not the owner of the IBM EMM system tables, perform this step. | See Configuring and publishing the data model. |
| Enabling internal links in the reports. | The IBM EMM reports have standard links. To enable them, you must configure the redirect URL in the Cognos data model. | See Enabling internal links in the reports. |
| Verifying the data source names and publish. | This step varies, depending on whether you used the default data source names in Cognos Connection, as described in that step. | See Verifying data source names and publishing. |
| Configuring the Cognos reporting properties in IBM EMM. | Log in to IBM EMM and set Cognos reporting properties. | See Configuring Cognos reporting properties in Marketing Platform. |
| Configuring report folder permissions. | To give users permission to run reports from within IBM EMM applications, assign the default ReportsUser role to the appropriate user groups or users. | See Setting report folder permissions. |
| For eMessage, running and scheduling stored procedures. | eMessage reports use data that is contained
in staging tables, which are populated by stored procedures that perform
a delta refresh operation. The scheduling of the procedures depends
on your database. Scheduling the procedures must be done by a database
administrator who is familiar with your IBM Campaign and eMessage environments and with your business
requirements. Note: You cannot see data in eMessage reports until
you run the stored procedures. |
See Running and scheduling stored procedures for eMessage. |
| Stored procedures for the Interact Event Pattern report. | The Interact Event Pattern report uses the
data that is contained in staging tables, which are populated by stored
procedures. The stored procedures perform a delta refresh operation. The Interact ETL triggers the report data aggregation automatically so you do not need to configure database jobs to perform a delta refresh. |
See Stored procedures for the Interact Event Pattern report. |
| Enabling the stored procedures for the Interact Event Pattern report | The Interact Event Pattern report uses the delta refresh process for data aggregation process so that reports can render faster. | See Enabling the stored procedures for the Interact Event Pattern report. |
| For Interact Event Pattern report, changing the degree of parallel executions | Increase the degree of parallel execution for the Interact Event Pattern report aggregation process to increase speed and improve performance. | See For Interact Event Pattern report, changing the degree of parallel execution. |
| Testing your configuration without authentication enabled. | After the reports are installed and configured, but before you enable authentication, test the setup by running some reports. | See Testing your configuration before enabling authentication. |
| Configuring Cognos to use IBM EMM authentication. | The IBM EMM Authentication Provider enables the Cognos applications to use IBM EMM authentication to communicate with the Marketing Platform as if it were another application in the suite. This step has several sub-steps. | See Configure IBM Cognos to use IBM EMM authentication. |
| Testing your configuration with authentication configured. | After you configure Cognos to use IBM EMM authentication, test the system again. | See Testing your configuration with authentication configured. |
| Customizing reports | ||
| Completing customization steps. | At this point, reporting is working properly and the example reports are in their default state. You may need to customize the reports or reporting schemas for Campaign, Interact, or Marketing Operations. | See Customizing reporting schemas. |