Purpose of document
The IBM Cognos Business Intelligence (BI) 10.2 release contains features which significantly enhance the capabilities of consumers to perform rich analysis of BI data. This document describes how users of IBM Cognos Analytic Applications can gain immediate benefit from these capabilities in their production environment while continuing to take full advantage of their existing application implementation with minimal IT overhead.
The method to deploy analytic reports generated by IBM Cognos Adaptive Application Framework 10.1.1 into IBM Cognos Business Intelligence 10.2 is described together with procedures to maintain the existing application and database, incrementally load data and generate reports.
Analytic content such as reports and dashboards, including reports created using earlier versions of the Adaptive Application Framework, can be deployed to the Cognos BI 10.2 platform. This allows consumers to take immediate advantage of capabilities offered by the platform without having to upgrade the analytic application or data repository.
However, it is not possible to configure the Adaptive Application Framework 10.1.1 generation of tools to interact directly with the Cognos BI 10.2 platform. Follow the procedures outlined in this document to maintain and deploy the application correctly. For more information refer to the guidelines on upgrade contained in the chapter titled Upgrade IBM Cognos Business Intelligence in the IBM Cognos Business Intelligence Installation and Configuration Guide. The techniques used to create deployment archives and export and import these into IBM Cognos BI are used extensively in this document.
Figure 1 - Topology of software components
Figure 1 shows how the software components are distributed and interact. Note that both Cognos BI 10.1.1 and Cognos BI 10.2 are installed on separate servers. The Adaptive Application Framework is configured with Cognos BI 10.1.1 and is operated as normal in that environment. Analytic content, such as reports, are deployed to the Cognos BI 10.2 environment via export archives which are copied between the BI servers. This allows reports to be run and take advantage of capabilities supported by Cognos BI 10.2.
A single data repository containing both metadata and data for the application is all that is required. Data is read from and written to the repository by the Adaptive Application Framework. Cognos BI 10.2 reads data from the repository using the target model package deployed in the export archive.
The Adaptive Application Framework is used as normal to perform all tasks to maintain the application, such as modelling, load management and report management. Changes to the model configuration and settings are stored in the data repository’s application metadata by the Adaptive Application Framework. Adaptive Warehouse is used to configure the warehouse model and to perform load management using the source model package published to Cognos BI 10.1.1 to query data from the source system and then load it into the repository. The target model is published to Cognos BI 10.1.1 and is used by Adaptive Analytics to preview reports.
Cognos BI 10.2 is used to execute reports and perform analysis. When reports are executed they query for the data contained in the application data repository using the target model package deployed to Cognos BI 10.2.
For further details on the initial deployment of content to Cognos BI 10.2 see the section titled Initial deployment. For details of how to continue to maintain content during ongoing operations see the section titled Ongoing operations.
To move analytic content such as reports generated by Adaptive Analytics or custom content authored using Report Studio, Query Studio or Analysis Studio to Cognos BI 10.2, follow the upgrade process documented in chapter titled Upgrade IBM Cognos Business Intelligence in the IBM Cognos Business Intelligence Installation and Configuration Guide. This process describes how to create an export deployment archive in the Cognos BI 10.1.1 environment and copy that to the Cognos BI 10.2 installation.
Figure 2 shows the items are included in the export deployment specification,
- The root folder for your Adaptive Analytics generated reports. Normally this folder is called Analytic Applications.
- The application model package published to the content store. This is known as the target model package.
- Any custom reports and/or analyses.
Figure 2 - Exporting report deployments and model packages
Ensure that the option to Include data sources and connections is checked and, if necessary, that the data source signons are also included. This will ensure that the data source connections are correctly aligned with the analytic content. It is important that the name used for the data source is not changed as this name is referred to in the application model package. If the data source is not included in the deployment archive then it can be created in Cognos BI 10.2 using the IBM Cognos Administration tool, making sure that the name of the data source being created is given the same value as the data source in Cognos BI 10.1.1 for the reason stated above.
The export deployment archive will be written out to the deployment folder under the root install directory of Cognos BI 10.1.1. Copy this file to the Cognos BI 10.2 server and paste it into the deployment folder under the Cognos BI 10.2 install directory. Import the archive. The import process will upgrade report specifications in the archive automatically.
Test the deployed content to ensure that it is working as expected. The layout and data contained in the reports should be compared to that generated in the Cognos BI 10.1.1 environment to ensure that it is producing the correct results in the Cognos BI 10.2 environment.
As previously stated, it is important that both Cognos BI 10.1.1 and Cognos BI 10.2 define a data source which points to the application database and which have the same name in IBM Cognos Administration. This will allow the Adaptive Application Framework to perform operations, such as loading data while also generating content which can be deployed to Cognos BI 10.2.
Load management performs the following tasks,
- Load - data from the source system is loaded into the application database
- Database Synchronization - updates the application database schema
- Framework Manager - synchronization and publish of the application source and target models to Cognos BI
The target model for the application should be published to Cognos BI 10.1.1 whenever a change is made to the target model or a change is made to the warehouse model (as this will also affect the target model). This will allow report managers to preview reports being modelled in Adaptive Analytics. Ensure that the target model package is selected during the Framework Manager operation to synchronise and publish the model to Cognos BI 10.1.1. The published package should be tested to verify the expected reporting behaviour. The target model package will also need to be copied to Cognos BI 10.2 using the procedure described next in the section Deploying the target model package.
The source model package should be published to Cognos BI 10.1.1 as normal. This package is used to query for data in the source system during the Load operation. There is no need to copy the source model package to Cognos BI 10.2.
Updates to the application database schema are performed directly on the database by the Adaptive Application Framework when load management is run without passing through Cognos BI. This operation can be performed as normal, either during the Database Synchronization operation or separately using the generated DDL script.
Data is loaded directly into the application database by Adaptive Warehouse during the Load operation. The queries which extract data from the source system must be executed against Cognos BI 10.1.1 and also must be performed by the Adaptive Application Framework when configured with Cognos BI 10.1.1. The source model package published during the Framework Manager operation is used to execute the source queries.
Deploying the target model package
It is necessary to deploy the target model package to Cognos BI 10.2 whenever a change is made to the target model. As noted above, the Adaptive Application Framework will publish the target model package to Cognos BI 10.1.1 during load management. The package must then be copied separately to Cognos BI 10.2.
The target model package is copied to Cognos BI 10.2 by creating an export deployment archive in Cognos BI 10.1.1. When creating the export specification ensure that the application model package published to the content store (i.e. the target model package) is selected.
Unlike the initial deployment, do not select the option to Include data sources and connections unless the data source connecting to the application database has not previously been created in Cognos BI 10.2. This will prevent modifications to signons or permissions made in the BI 10.2 environment from being overwritten.
The export deployment archive will be written out to the deployment folder under the root install directory of Cognos BI 10.1.1. Copy this file to the Cognos BI 10.2 server and paste it into the deployment folder under the BI 10.2 install directory and then import the archive.
Deploying analytic content
The report manager can continue to develop and test new analytic content using Adaptive Analytics even though the Adaptive Application Framework is configured with Cognos BI 10.1.1. The behaviour of the target model and BI report specifications will be functionally equivalent in both environments. However, once the content has been developed it needs to be deployed to Cognos BI 10.2.
First create a deployment archive as normal from within Adaptive Analytics by clicking on the Generate Deployment Archive button. A dialog is then displayed which allows the folder in which to save the archive to be selected. If the Cognos BI 10.2 install location is accessible, then the deployment folder under the root can be selected here, otherwise select an accessible location and copy the deployment archive to the Cognos BI 10.2 server after the archive has been generated.
The deployment archive can now be imported into Cognos BI 10.2. The report specifications contained in the archive can be either upgraded to the latest versions or kept as existing report specification versions.
Finally, test the deployed reports to ensure that the expected results are obtained.