85
IBM Business Intelligence Pattern Version 2.2.0 User Guide

User Guide Pattern

Embed Size (px)

DESCRIPTION

bj

Citation preview

Page 1: User Guide Pattern

IBM Business Intelligence PatternVersion 2.2.0

User Guide

���

Page 2: User Guide Pattern

NoteBefore using this information and the product it supports, read the information in “Notices” on page 73.

Product Information

This document applies to IBM Business Intelligence Pattern version 2.2.0 and may also apply to subsequent releases.

Licensed Materials - Property of IBM

© Copyright IBM Corporation 2012, 2014.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 3: User Guide Pattern

Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1. What's new? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Patterns in Cognos Business Intelligence . . . . . . . . . . . . . . . . . . . . . . . . . . 1New features in IBM Business Intelligence Pattern 2.2 . . . . . . . . . . . . . . . . . . . . . 2Changed features in IBM Business Intelligence Pattern 2.2 . . . . . . . . . . . . . . . . . . . . 3New features in IBM Business Intelligence Pattern 2.0 . . . . . . . . . . . . . . . . . . . . . 4Changed features in IBM Business Intelligence Pattern 2.0 . . . . . . . . . . . . . . . . . . . . 5

Chapter 2. Prepare to install IBM Business Intelligence Pattern . . . . . . . . . . . . 7Review the Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Verify system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Review the implementation process. . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 3. Installing IBM Business Intelligence Pattern . . . . . . . . . . . . . . . 11Preinstallation checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Installation checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Post-installation checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 4. Planning the deployment of Business Intelligence solutions in cloudenvironments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Deploying the ELB Proxy Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Preparing your databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Setting up access to your content store databases, audit databases, and data sources . . . . . . . . . . . 17Setting up IBM Cognos Business Insight connectivity to TM1 data . . . . . . . . . . . . . . . . . 18Setting up access to SAP NetWeaver Business Warehouse servers . . . . . . . . . . . . . . . . . 19Adding supplementary fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Reviewing security requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Updating your network configuration . . . . . . . . . . . . . . . . . . . . . . . . . 20Adding support for PowerCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Chapter 5. IBM Business Intelligence Pattern components and templates . . . . . . . 23IBM Cognos Business Intelligence component . . . . . . . . . . . . . . . . . . . . . . . . 25IBM Cognos Dynamic Cubes component . . . . . . . . . . . . . . . . . . . . . . . . . 29Business Intelligence scaling policy . . . . . . . . . . . . . . . . . . . . . . . . . . . 30User registry components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Multitenant environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37NFS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Creating application templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications . . . . . 45Post-deployment tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Access to the IBM Business Intelligence application . . . . . . . . . . . . . . . . . . . . . 45Importing or exporting BI deployment archives . . . . . . . . . . . . . . . . . . . . . . 46Rendering images in HTML and PDF reports . . . . . . . . . . . . . . . . . . . . . . . 46Copying PowerCubes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Configuring IBM Cognos BI products to connect to a BI virtual application . . . . . . . . . . . . . 48Securing your BI virtual application by setting the HTTPOnly parameter . . . . . . . . . . . . . . 48Moving a BI virtual application to a production environment. . . . . . . . . . . . . . . . . . 49NFS server content back up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Maintenance of BI virtual applications . . . . . . . . . . . . . . . . . . . . . . . . . . 50Applying fix packs and interim fixes . . . . . . . . . . . . . . . . . . . . . . . . . . 50Updating user credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Updating content store or audit database information . . . . . . . . . . . . . . . . . . . . 52

© Copyright IBM Corp. 2012, 2014 iii

Page 4: User Guide Pattern

Updating drivers and configuration files to access data . . . . . . . . . . . . . . . . . . . . 52Updating the list of valid domain names and host names . . . . . . . . . . . . . . . . . . . 53Updating notification mail server information . . . . . . . . . . . . . . . . . . . . . . . 54Updating fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Appendix A. Accessibility features . . . . . . . . . . . . . . . . . . . . . . . . 57

Appendix B. IBM Business Intelligence Pattern virtual applications troubleshooting . . 59Troubleshoot a problem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Searching knowledge bases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Getting fixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Contacting IBM Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Exchanging information with IBM . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Subscribing to Support updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Accessing the log files for error diagnosis . . . . . . . . . . . . . . . . . . . . . . . . . 65Cognos user cannot log in to the NFS server . . . . . . . . . . . . . . . . . . . . . . . . 66Deployment fails when starting IBM Business Intelligence Pattern . . . . . . . . . . . . . . . . . 67

Appendix C. Installation and configuration worksheet . . . . . . . . . . . . . . . 69

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

iv IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 5: User Guide Pattern

Introduction

IBM Business Intelligence Pattern is a cloud solution designed to speed up yourdeployment of IBM Cognos Business Intelligence, lower costs, and reduce ITbacklog.

Your Cognos Business Intelligence environment can be up and running withinminutes in a fault-tolerant environment with elastic scaling so that you are usingyour resources at optimum levels. You can easily set up multiple environments asneeded and just as rapidly take them down.

For more information, go to the IBM Business Intelligence Pattern productinformation page (http://www-03.ibm.com/software/products/en/bi-pattern).

Accessibility features

Accessibility features help users who have a physical disability, such as restrictedmobility or limited vision, to use information technology products. This producthas accessibility features. For information on these features, see Appendix A,“Accessibility features,” on page 57.

Audience

To use this documentation effectively, you should be familiar with yourinformation technology infrastructure and with the business needs of the people inyour organization who will use Cognos® BI.

Finding information

To find product documentation on the web, including all translateddocumentation, access IBM® Knowledge Center (http://www.ibm.com/support/knowledgecenter).

Forward-looking statements

This documentation describes the current functionality of the product. Referencesto items that are not currently available may be included. No implication of anyfuture availability should be inferred. Any such references are not a commitment,promise, or legal obligation to deliver any material, code, or functionality. Thedevelopment, release, and timing of features or functionality remain at the solediscretion of IBM.

© Copyright IBM Corp. 2012, 2014 v

Page 6: User Guide Pattern

vi IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 7: User Guide Pattern

Chapter 1. What's new?

Review the list of new and changed for this release. This information helps youplan your upgrade and application deployment strategies as well as the trainingrequirements for your users.

Patterns in Cognos Business IntelligenceIn addition to the IBM Cognos Business Intelligence physical installation kit, IBMCognos Business Intelligence 10.2.2 includes IBM Business Intelligence Pattern 2.2.0and IBM Business Intelligence Pattern with BLU Acceleration 1.2.0.

The patterns contain reusable and customizable components that can reduce thetime and effort that is required to deploy and manage IBM Cognos BusinessIntelligence environments. They provide the following advantages:

Faster time to valueHave your Cognos Business Intelligence environment up and runningwithin minutes. Reduce configuration errors through centralizedconfiguration of your entire Cognos Business Intelligence environment. Youcan bring up and bring down multiple environments whenever required.

Management and monitoringThere is a single point of management from one screen and easy access tologs and system metrics for the entire environment.

Lower cost of ownershipVirtualized hardware is deployed as necessary, and there is a single entrypoint for applying updates to the entire Cognos Business Intelligenceenvironment.

The features that differentiate Cognos Business Intelligence, Business IntelligencePattern, and Business Intelligence Pattern with BLU Acceleration are described inthe following sections.

Cognos Business Intelligence

You can install IBM Cognos Business Intelligence on any of the supportedoperating systems, using the architecture of your choice. Cognos BusinessIntelligence provides access to the full range of configuration and tuning optionsand can connect to supported data sources in both compatible mode and dynamicquery mode.

Business Intelligence Pattern

You can deploy IBM Business Intelligence Pattern on IBM PureApplication®

System, IBM PureApplication Service Platform, and other cloud providers by usingIBM Cloud Orchestrator.

Business Intelligence Pattern is designed for use with dynamic query mode so thatit can use its advanced query capabilities for query planning, execution, andresults. Limited support is available for compatible query mode data sources.

© Copyright IBM Corp. 2012, 2014 1

Page 8: User Guide Pattern

Business Intelligence Pattern contains built-in automatic application scaling basedon CPU and report server usage load to meet unpredictable demand. Failover isavailable by default on the Content Manager and reporting layers.

Business Intelligence Pattern with BLU Acceleration

You can deploy IBM Business Intelligence Pattern with BLU Acceleration on IBMPureApplication System and IBM PureApplication Service Platform.

Business Intelligence Pattern with BLU Acceleration is integrated with IBM DB2®

BLU Acceleration to use columnar processing and dynamic cubes. DB2 BLUAcceleration provides in-memory capabilities and automatic tools that are based onDynamic Query Analyzer to optimize and publish in-database aggregates.

Business Intelligence Pattern with BLU Acceleration provides performancemonitoring and analysis dashboards and reports that help the BI administrator toquickly pinpoint performance problems and discover areas for potentialimprovement. The reports and dashboards help the modeler and report author tobuild better models, dashboards, reports, and queries through guided analysis andbest practice recommendations.

New features in IBM Business Intelligence Pattern 2.2IBM Business Intelligence Pattern 2.2 includes new features and featureenhancements.

Scaled-in log files

If you use scaling policies, log files for virtual machines are now available after amachine has scaled in.

Support for IBM Cognos PowerCube data sources

You can now configure a BI Pattern virtual application to support a PowerCubedata source when it is deployed.

Improved scaling policy

The scaling policy now includes options for using CPU utilization or report servicequeue as trigger events to add additional temporary virtual machines to processincreased workload.

SSL connections to IBM Cognos BI databases

You can now use the secure sockets layer (SSL) protocol for communication todatabases used by IBM Cognos BI, including the content store and audit databases.

External object store

Instead of storing reports in the content store database, you can configure ContentManager to store report outputs to the NFS server that is deployed by the pattern.Report output is available through IBM Cognos Connection but the size of thecontent store database is reduced, providing performance improvements forContent Manager.Related concepts:

2 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 9: User Guide Pattern

“Business Intelligence scaling policy” on page 30You can add a scaling policy to an BI Pattern deployment to manage the workloadmore effectively and improve overall performance.“IBM Cognos Business Intelligence component” on page 25To create a BI pattern, you configure the Business Intelligence component in theVirtual Application Builder. You can optionally add a scaling policy. You can alsoconnect the Business Intelligence component to multiple existing User Registrycomponents or to multiple Dynamic Cubes components.Related tasks:“Accessing the log files for error diagnosis” on page 65Log files can help you troubleshoot problems by recording the activities that takeplace when you work with a product.“Adding support for PowerCubes” on page 21By default, when you deploy a BI Pattern virtual application, the Report Server isconfigured in 64-bit execution mode. If a deployment is configured to use IBMCognos PowerCubes as a data source, when you run a report it fails with errorQFS-ERR-0141.

Changed features in IBM Business Intelligence Pattern 2.2Review the list of changed features to understand the changes in existingfunctionality from the previous release.

IBM Cognos Business Intelligence 10.2.2 support

The IBM Business Intelligence Pattern 2.2 pattern type provisions IBM CognosBusiness Intelligence Version 10.2.2 virtual applications. To provision IBM CognosBusiness Intelligence Version 10.2.1 virtual applications, use the IBM BusinessIntelligence Pattern 2.0 pattern type.

Improved support for Framework Manager and Cube Designerconfiguration

IBM Business Intelligence Pattern 2.2 includes improvements to endpoints tosupport Framework Manager and Cube Designer configuration.

Multitenancy supported for all user registry types

You can now configure multitenancy for all user registry types.

IBM Cognos Mobile is now included in the IBM BusinessIntelligence package

A separate installation package is no longer required to include IBM CognosMobile in your IBM Cognos Business Intelligence environment.Related concepts:“Multitenant environments” on page 37Multitenancy provides the capability to support multiple customers ororganizations, called tenants, by using a single deployment of an application whileensuring that each tenant users can access only the data that they are authorized touse. Such applications are called multitenant applications. Multitenant applicationsminimize the extra costs associated with these environments.

Chapter 1. What's new? 3

Page 10: User Guide Pattern

“Access to the IBM Business Intelligence application” on page 45After the virtual application is deployed and started, you can access the BusinessIntelligence application. To do this, you must determine the application endpointURL by using the Virtual Application Instances dashboard.

New features in IBM Business Intelligence Pattern 2.0With Business Intelligence Pattern 2.0 you can quickly deploy IBM CognosBusiness Intelligence 10.2.1 solutions in private cloud environments using virtualapplication patterns.

Dynamic Cubes 10.2.1 support

You can use a new Dynamic Cubes component to create patterns that provisionIBM Cognos Dynamic Cubes 10.2.1 applications.

For information, see “IBM Cognos Dynamic Cubes component” on page 29.

IBM Cognos Mobile 10.2.1 Support

Mobile devices can use virtual applications that are created with BusinessIntelligence Pattern 2.0.

For information about preparing the content store for mobile applications, see“Cognos Mobile database preparation” on page 17.

Multitenancy support

You can create BI patterns that use the IBM Cognos Business Intelligence built-inmultitenancy capabilities. You enable multitenancy support by specifying advancedauthentication properties and custom LDAP properties in the user registrycomponents.

For information about enabling multitenancy features, see “User registrycomponents” on page 31.

Additional currencies support

Business Intelligence virtual applications are configured to automatically supportall the additional currency symbols that can be used in IBM Cognos BusinessIntelligence 10.2.1.

Single signon support

You can configure virtual applications to use single signon between LDAP userregistries and the IBM Cognos components. You enable this feature with theexternal identity mapping property.

For information about enabling external identity mapping, see “User registrycomponents” on page 31.

4 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 11: User Guide Pattern

Supplementary fonts support

By default, BI virtual applications include the default fonts that are installed withIBM Cognos Business Intelligence 10.2.1. In Business Intelligence Pattern 2.0, youcan customize your patterns by adding supplementary fonts to the base set of fontsavailable.

For more information, see “Adding supplementary fonts” on page 20.

Custom Java™ Provider

You can attach a custom Java authentication provider to an IBM Cognos BusinessIntelligence component to provide a user registry (namespace) forcontainer-managed security.

For more information, see “Custom Java Provider” on page 36.

Changed features in IBM Business Intelligence Pattern 2.0Review the list of changed features to understand the changes in existingfunctionality from the previous release.

IBM Cognos Business Intelligence 10.2.1 support

The IBM Business Intelligence Pattern 2.0 pattern type provisions IBM CognosBusiness Intelligence Version 10.2.1 virtual applications. To provision IBM CognosBusiness Intelligence Version 10.1.1 virtual applications, use the IBM BusinessIntelligence Pattern 1.0 pattern type.

Content store settings optimization

In Business Intelligence Pattern 1.0, content store settings are optimized when youdeploy virtual applications that point to a new content store. In BusinessIntelligence Pattern 2.0, content store settings are optimized at deployment time forapplications that use either an existing content store or a new content store.

Changes to default values for some LDAP property mappings

The default values for some LDAP properties are updated to match the defaultvalues that changed for IBM Cognos Business Intelligence Version 10.2.1.

Content store dispatcher settings are unregistered

When you migrate to a cloud environment, any dispatchers previously registeredfor the content store will be unregistered. Therefore, you should take a note of anyoptimization settings applied at the dispatcher level before migrating to a cloudenvironment.

Review these settings before you apply them to the cloud environment.

The runtime log file captures more data

In Business Intelligence Pattern 2.0, the cogserver.log file can store up to 400 MBof data.

Chapter 1. What's new? 5

Page 12: User Guide Pattern

For more information about the cogserver.log file, see “Accessing the log files forerror diagnosis” on page 65.

6 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 13: User Guide Pattern

Chapter 2. Prepare to install IBM Business Intelligence Pattern

Before you install IBM Business Intelligence Pattern (BI Pattern), review the systemrequirements and implementation workflow.

Review the Release NotesBefore you install your product, it is important to be aware of all issues that mayaffect your installation strategy.

Review the IBM Business Intelligence Pattern Release Notes before you install. TheRelease Notes are available from Knowledge Center (http://www.ibm.com/support/knowledgecenter/).

Verify system requirementsBefore you install BI Pattern, verify that your hardware and software meet therequirements.

Software product compatibility reports are available from the SoftwareEnvironments site (http://www.ibm.com/support/docview.wss?uid=swg27042164). If there is a conflict between the informationprovided in the product documentation and the information in the compatibilityreports, the information in the compatibility reports takes precedence.

Hardware requirements

You require access to IBM PureApplication System W1500 Version 1.0.0.4 or IBMPureApplication System W1700 Version 1.0.0.0.

You also require a computer that uses either a Microsoft Windows, or Red HatEnterprise Linux operating system where you can download the installation filesand connect to IBM PureApplication System.

Software requirementsv Java Runtime Environment (JRE) on the computer where the BI Pattern

installation files are downloaded. If the system is configured to use SSL and hasa JRE provided by IBM, the JRE must be Java 6 SR3 or later, otherwise theinstallation will fail.

v The base operating system image on the system must be either IBM OS imagefor Red Hat Linux Systems V2.0.0.2 or AIX® V2.0.0.1.

v A Type 4 Java Database Connectivity (JDBC) driver for connecting to thedatabase used for the content store, and for connecting to the audit database.The following databases are supported:– DB2 for Linux, UNIX, and Windows– DB2 for z/OS®

– Oracle– Microsoft SQL ServerTo find out which database versions are supported for the content store, seeSoftware Environments site (http://www.ibm.com/support/docview.wss?uid=swg27042164).

© Copyright IBM Corp. 2012, 2014 7

Page 14: User Guide Pattern

v Type 4 JDBC drivers for connecting to the following relational data sources:– DB2 for Linux, UNIX, and Windows– DB2 for z/OS– Oracle– Microsoft SQL ServerTo find out which relational data sources versions are supported, see SoftwareEnvironments site (http://www.ibm.com/support/docview.wss?uid=swg27042164).

v To connect to SAP NetWeaver Business Warehouse (SAP BW), copies of the32-bit and 64-bit versions of the SAP BW librfccm.so library files.

v For user authentication, LDAP Version 3 Compliant Directory Servers, such asIBM Tivoli® Directory Server. You can also use a custom authentication provider,if one exists.

Review the implementation processReview the steps required to implement BI solutions into private cloudenvironments using IBM Business Intelligence Pattern.1. Install IBM Business Intelligence Pattern on your system. For installation

information, see Chapter 3, “Installing IBM Business Intelligence Pattern,” onpage 11.

2. Plan your deployment. For planning information, see Chapter 4, “Planning thedeployment of Business Intelligence solutions in cloud environments,” onpage 13.

3. Create your Business Intelligence virtual application pattern. For informationabout creating a BI pattern, see Chapter 5, “IBM Business Intelligence Patterncomponents and templates,” on page 23.

4. Deploy your application pattern to the cloud group where the ELB sharedservice is running. For information on how to deploy applications, refer toyour system documentation.

5. Perform any applicable post-deployment configuration tasks. For informationabout post-deployment tasks, see “Post-deployment tasks” on page 45.

6. Apply the latest BI fix packs in all environments. For information aboutapplying fix packs, see “Applying fix packs and interim fixes” on page 50.

7. Access and test the BI virtual application. For information about accessing thevirtual application instance, see “Access to the IBM Business Intelligenceapplication” on page 45.

8. Determine a backup strategy for the content of the NFS server. Forinformation about which directories to back up, see “NFS server content backup” on page 49.

9. Move your application to a production environment. For information aboutsetting up a production environment, see “Moving a BI virtual application toa production environment” on page 49.

10. Maintain the virtual application instance. For the list of operations that youcan run on virtual application instances, see “Maintenance of BI virtualapplications” on page 50.

Related tasks:Chapter 3, “Installing IBM Business Intelligence Pattern,” on page 11Use checklists to complete the IBM Business Intelligence Pattern (BI Pattern)installation on your system.Related information:

8 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 15: User Guide Pattern

Chapter 4, “Planning the deployment of Business Intelligence solutions in cloudenvironments,” on page 13Before you can implement BI solutions in cloud environments, you must collectinformation about your environment and prepare artifacts that are required whenyou are ready to define a BI pattern.Chapter 5, “IBM Business Intelligence Pattern components and templates,” on page23IBM Business Intelligence Pattern (BI Pattern) virtual applications containmiddleware components that represent the Business Intelligence service for the BIvirtual application instance. BI Pattern virtual applications can also include apolicy that determines the scaling requirements of the deployed applications.

Chapter 2. Prepare to install IBM Business Intelligence Pattern 9

Page 16: User Guide Pattern

10 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 17: User Guide Pattern

Chapter 3. Installing IBM Business Intelligence Pattern

Use checklists to complete the IBM Business Intelligence Pattern (BI Pattern)installation on your system.

Preinstallation checklistThere are some tasks that you must do before you install IBM Business IntelligencePattern.__ v Review the information in Chapter 2, “Prepare to install IBM Business

Intelligence Pattern,” on page 7.__ v If you do not have the IBM Business Intelligence Pattern part numbers,

review the download instructions in the download document(http://www.ibm.com/support/docview.wss?uid=swg24037529).

__ v Print the installation and configuration worksheet to record the systeminformation required during the implementation of IBM Business IntelligencePattern.

Installation checklistYou run the installation program from a computer that can access the systemwhere you want to install BI Pattern.__ 1. Record the system information for the target IBM PureApplication System

on the installation and configuration worksheet.__ 2. Get access to a computer that uses either a Windows or Linux operating

system where you can access the target IBM PureApplication System andwhere you can copy the installation files.

Note: If you are using a computer with a Linux operating system, loginusing a non-root user account.

__ 3. Verify that the computer has Java Runtime Environment (JRE) and that thePATH environment variable includes the bin directory of the JRE.

__ 4. Access Passport Advantage® and download the following packages:v Download IBM Business Intelligence Pattern version 2.2v Download into a separate directory the 64-bit version of either the Linux

or AIX operating system of IBM Cognos Business Intelligence Version10.2.2

__ 5. Uncompress into an empty directory the BI Pattern compressed archive(tar.gz) file.

__ 6. Run the install.bat (Windows environments) or install.sh (Linuxenvironments) command.For example,cd /data/downloads/software/COGNOSPattern/2.2

./install.sh <targetIP> <username> <password> /data/downloads/software/COGNOS/10.2.2

__ 7. Follow the prompts of the installation program to upload to your system theinstallation files for BI Pattern, IBM Cognos Business Intelligence Version10.2.2.

© Copyright IBM Corp. 2012, 2014 11

Page 18: User Guide Pattern

Post-installation checklistAfter you install the BI Pattern type on your system, you must log in to yoursystem and enable the BI Pattern type before you can use it.__ 1. Log in to your system as an administrator or with an account that can work

with product licenses.__ 2. Ensure that the foundation pattern type is enabled. The foundation pattern

type is a prerequisite to using all other pattern types.__ 3. Enable the BI Pattern type. For information about enabling pattern types, see

the documentation for your system.

12 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 19: User Guide Pattern

Chapter 4. Planning the deployment of Business Intelligencesolutions in cloud environments

Before you can implement BI solutions in cloud environments, you must collectinformation about your environment and prepare artifacts that are required whenyou are ready to define a BI pattern.

Use the following checklist to help you plan your virtual application deployment:__ 1. Determine whether your virtual applications connect to an existing Business

Intelligence content store or a new one. For information about preparing thecontent store database, see “Preparing your databases” on page 15.For an Oracle or IBM DB2 content store, create a compressed file containinga JDBC driver that your application will use to connect to the databases. Forinformation about the JDBC drivers and the compressed files for the contentstore, see “Setting up access to your content store databases, audit databases,and data sources” on page 17.Record information about the database used for the content store on theinstallation and configuration worksheet:

__ 2. Determine whether your virtual applications connect to an existing auditdatabase or create one of the same type as your content store. Forinformation about preparing an audit database, see “Preparing yourdatabases” on page 15.Record information about the audit database on the installation andconfiguration worksheet

__ 3. Perform capacity planning. This helps you determine the type of virtualinstances needed (static and dynamic), the size of the instances, and otherinformation required when defining a BI pattern. You can look at existingsystem metrics and trends as a baseline for this exercise. For informationabout capacity planning, see “Deployment throughput” on page 28.

__ 4. Determine your data sources and TM1® connectivity requirements. Then,prepare the compressed files that contain the files required to connect toyour data sources.Record information about your data source connectivity requirements on theinstallation and configuration worksheet

__ 5. Determine whether your application requires user authentication. By default,anonymous logon is enabled if there is no user registry attached to the BIcomponent. With an existing authentication namespace (user registry), whenyou configure the BI component, use the administrative credentials that yourBI component is pointing to, otherwise the deployment will fail.Record information about the existing authentication namespace on theinstallation and configuration worksheet:

__ 6. To configure your application to support multiple tenants, collectinformation about how the tenancy information is determined for the usersin your environment and record the information on the installation andconfiguration worksheet. Tenancy is determined using one of the followingscenarios.v The application uses the hierarchy information.

© Copyright IBM Corp. 2012, 2014 13

Page 20: User Guide Pattern

Important: If you use Active Directory user registries, set also theMultiDomainTree advanced property to true to map the tenants todomains.

v The application uses specific object attributes from your authenticationprovider, such as a department number (departmentNumber).

v The application uses a custom Java class. Compile the custom Java classfile into a JAR file and include it in a compressed file using thewebapps/p2pd/WEB-INF/lib path.

__ 7. Determine which cloud group will contain the virtual application instance.Verify that the cloud group has the following characteristics:__ v The cloud group has a running instance of the elastic load balancing

(ELB) shared service. For information about deploying the ELB service,see “Deploying the ELB Proxy Service.”

__ v The cloud group has the required CPU, memory, disk, and IP addressesto run the application, including any resources needed during scalingoperations.

__ 8. Determine whether you want to set up Secure Shell (SSH) key-based accessfor your deployed application. For information about whether you requireSSH key-based access, see “NFS server” on page 41.

__ 9. Determine if the first entry point for your virtual application is through anexternal proxy host configured to use the Secure Socket Layer (SSL)protocol. If you enable SSL, it must be on port 443.

After you have completed these tasks, you can define a pattern for your BI virtualapplication. For information about creating a BI pattern, see Chapter 5, “IBMBusiness Intelligence Pattern components and templates,” on page 23.

Deploying the ELB Proxy ServiceElastic load balancing (ELB) is a shared service that provides routing and loadbalancing to deployed applications. Before you can deploy BI applications in acloud group, one instance of the ELB Proxy Service must be running in that cloudgroup. If there is an instance already running, you do not need to deploy anotherone.

Before you begin

Confirm with your system administrator whether an instance of the ELB ProxyService is running in the cloud group where you want to deploy your virtualapplications. Users with administrative permissions or system administrators canview the list of deployed shared services by using Instances > Shared Services. Ifthe ELB Proxy Service is not running, use this procedure to deploy an instance ofit.

Procedure1. Log in to your system as an administrator or with an account that can work

with shared services. For information about the roles and user permissionsrequired, see the documentation for your system.

2. Click Cloud > Shared Services.3. From the Shared Services palette, select ELB Proxy Service, then click Deploy.4. Follow the prompts to deploy an instance of the shared service in the cloud

group where you want to deploy BI pattern applications. You can accept or

14 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 21: User Guide Pattern

change the default values. For more information about the ELB Proxy Service,refer to the documentation for your system.

5. To monitor the deployment of the shared service, click Instances > SharedServices.

Results

After the ELB Proxy Service deployment is complete, the ELB Proxy Service statusis running and the health is normal.

What to do next

BI pattern applications can be deployed in this cloud group.

Preparing your databasesBefore you can create a pattern for your BI virtual application, you must set up thedatabases that are used by the BI Pattern components.

The database type for the content store database and the audit database must bethe same.

Database options

You have several options for the content store database and audit database used bythe BI virtual application.v You can use a virtual system pattern or virtual application pattern to build and

deploy an IBM DB2 database to the cloud. The use of a virtual pattern integratesthe database component used by IBM Business Intelligence into the cloudinfrastructure.When you deploy software using virtual system patterns, you mostly managethe environment through administration consoles, but instead of focusing onchanging the way you operate or manage the software, you focus on improvingthe software delivery.With virtual application patterns, you fundamentally change everything aboutthose environments. You are working with a highly optimized and automatedsolution with built-in feature to manage high availability and dynamicallyreacting to changing conditions based on your specified business levelrequirements.You may need to support specific configurations that do not fit easily into analready available virtual application pattern type. You then might choose tocreate your own virtual application patterns type or use a virtual system patternto create the exact topology that your application requires, perhaps replicating apreviously implemented physical environment. In other cases, you may find thatyour application fits well into one of the virtual application pattern types thatare already provided.Try to leverage the optimization and convenience of a virtual application patternas they should provide the lowest total cost of ownership and shortest time tovalue. However, you might have scenarios which require detailed configurationsand controls that can only be found with virtual system patterns. Understandingall of your options and making an informed decision based on your use caseand what you want your user experience to be.For more information about virtual patterns, see your system documentation onKnowledge Center: SmartCloud Orchestrator (http://www-01.ibm.com/

Chapter 4. Planning the deployment of Business Intelligence solutions in cloud environments 15

Page 22: User Guide Pattern

support/knowledgecenter/SS4KMC/welcome) or PureApplication System(http://www-01.ibm.com/support/knowledgecenter/SSGRP3/welcome).

v You can connect to an instance of a supported database running on a systemoutside of the cloud infrastructure. Using a database on a remote system doesnot offer the same advantages that are available with building and deploying adatabase using a virtual pattern.

You can use script files to create content store and audit databases. For moreinformation, see Creating IBM DB2 databases for use by IBM Business IntelligencePattern (http://www-01.ibm.com/support/docview.wss?uid=swg27042411).

Content store database preparation

Determine which content store to associate with your BI virtual application. Youcan reuse an existing content store, create a content store, or use a content storedatabase backup and restore it into a new content store. The database backup andrestore option is suited for large content stores and has the least amount ofdowntime.

At deployment time, BI virtual applications optimize specific content store settingsto ensure an optimal application performance.

If you are reusing an existing content store, complete the following steps:1. Shut down any existing application that is connected to your content store.2. Back up your existing content store. For information about backing up

databases, see the documentation of your database vendor.3. Review existing content store settings and make changes as required. BI virtual

applications optimize content store settings related to the number of processesfor the report and batch report services.

If you are creating a content store, complete the following steps:1. Create a deployment archive from IBM Cognos Administration.2. Create a content store database.

If you are using the database backup and restore option, complete the followingsteps:1. Back up your existing content store database.2. Create an instance of the database from the content store database backup.

Audit database preparation

Determine whether you can reuse an existing audit database or create one with thesame type as the content store database.

If you are reusing an existing audit database, complete the following steps:1. Shut down any existing application that is connected to your audit database.2. Back up your existing audit database.

If you are creating an audit database, complete the following steps:1. Create a deployment archive from IBM Cognos Administration.2. Create an audit database.

16 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 23: User Guide Pattern

Cognos Mobile database preparation

BI Pattern virtual applications share the same database for the Business Intelligencecontent store and the Cognos Mobile content store. A separate database for CognosMobile is not supported with BI Pattern.

Setting up access to your content store databases, audit databases,and data sources

You must upload JDBC drivers to your system to associate a content store and anaudit database with your virtual application. You must also upload JDBC driversso that your virtual application can access your data sources. JDBC drivers arerequired for Oracle and IBM DB2 databases only.

About this task

For Oracle and IBM DB2, you must upload the content store JDBC drivers atdeployment time. Data source drivers can be added at deployment time or later.The database type for both the content store database and the audit database mustbe the same.

Important: Drivers are associated with a virtual application. If you add a driver toa virtual application or if you refresh an existing driver, you must also add all thedrivers associated with the virtual application, even if the drivers have notchanged.

You can obtain the latest JDBC drivers for DB2 databases at Download Fix Packsby version for IBM Data Server Client Packages (http://www.ibm.com/support/docview.wss?uid=swg27016878).

Procedure1. Create a compressed file with the appropriate database JDBC driver required to

connect to an existing content store. For information about the files required toset up connectivity to your content store, see the IBM Cognos BusinessIntelligence Installation and Configuration Guide.

Exception: You do not need to upload a JDBC driver if you are using aMicrosoft SQL Server database as your content store.

2. Create a compressed file with the appropriate database JDBC drivers requiredfor data source connectivity.For information about the files required to set up connectivity to your relationaldata source provider, see the IBM Cognos 10 Dynamic Query Cookbook in theProven Practices section of the IBM Cognos Customer Center(http://www.ibm.com/software/data/cognos/customercenter/).

3. From your system, use the Virtual Application console to upload thecompressed JDBC driver files. Depending on whether your pattern is deployed,there are two ways to upload the compressed file:v If your BI virtual application instance is deployed, you can update the JDBC

drivers. For information about updating the content store or audit databasedrivers, see “Updating content store or audit database information” on page52. For information about updating the data sources drivers, see “Updatingdrivers and configuration files to access data” on page 52.

Chapter 4. Planning the deployment of Business Intelligence solutions in cloud environments 17

Page 24: User Guide Pattern

v If your BI virtual application is not deployed, you can add the files whilecreating the virtual application pattern. For more information, see Chapter 5,“IBM Business Intelligence Pattern components and templates,” on page 23.

What to do next

When you refresh the drivers or add new drivers, ensure that the compressed fileincludes all the drivers needed for the deployment. Missing drivers from thecompressed file are no longer associated with your virtual application.

Setting up IBM Cognos Business Insight connectivity to TM1 dataBefore BI Pattern application instances can access TM1 data in IBM CognosBusiness Insight, you must upload a set of TM1 configuration files to your BIPattern application template.

If you are working with multiple locales, you must upload a set of files for eachlocale.

Environments with existing TM1 and BI configurations

If your IBM Cognos Business Intelligence (BI) environment already accesses TM1servers, follow these steps to reuse your configuration files and to upload them toyour system:1. From a computer where IBM Business Intelligence is installed, copy the

following TM1 configuration files into a compressed (.zip) file:v variables_TM1.xml. This file is in the c10_location\templates\ps\portal

directory.v tm1_contribution.atom. This file is in the c10_location\configuration\icd\

contributions\contrib directory.In addition, for each locale that you need to use in your environment, copy thefollowing TM1 files into the compressed file:v tm1_locale.properties where locale represents the locale used. This file is in

the c10_location\configuration\icd\contributions\contrib directory.v tm1buxmsgs_locale.xml where locale represents the locale used. This file is in

the c10_location\templates\ps\messages directory.2. From your system, use the Virtual Application console to upload the

compressed file. Depending on whether your application is deployed, there aretwo ways to upload the compressed file:v If your BI Pattern application instance is deployed, you can update the

configuration files. For more information, see Updating drivers andconfiguration files.

v If your BI Pattern application is not deployed, you can add theconfiguration files when creating the virtual application pattern. For moreinformation, see Chapter 5, “IBM Business Intelligence Pattern componentsand templates,” on page 23.

Environments without an existing TM1 and BI configuration

If your IBM Cognos Business Intelligence environment does not access TM1servers, IBM Business Intelligence Pattern provides sample TM1 configuration files.Use the following steps to set up access to TM1 servers:

18 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 25: User Guide Pattern

1. Go to the computer where the IBM Business Intelligence Pattern package wasuncompressed and go to the BI_Pattern_install\samples\TM1 directory.

2. Copy the following files into a new directory:v tm1buxmsgs_EN.xml

v tm1_en.properties

v tm1_contribution.atom

v variables_TM1.xml

3. Update each configuration file with values that are appropriate for yourenvironment. If your environment supports multiple locales, copy thetm1_en.properties and the tm1buxmsgs_EN.xml files and create a version foreach locale. For information about the naming convention and how to updatethese files, see the IBM Cognos Business Intelligence Installation and ConfigurationGuide.

4. Create a compressed (.zip) file and include the updated TM1 configurationfiles.

5. From your system, use the Virtual Application console to upload thecompressed file. Depending on whether your application is deployed, there aretwo ways to upload the compressed file:v If your BI Pattern application instance is deployed, you can update the

configuration files. For more information, see Updating drivers andconfiguration files.

v If your BI Pattern application is not deployed, you can add theconfiguration files when creating the virtual application pattern. For moreinformation, see Chapter 5, “IBM Business Intelligence Pattern componentsand templates,” on page 23.

Setting up access to SAP NetWeaver Business Warehouse serversBefore BI Pattern application instances can use SAP NetWeaver BusinessWarehouse (SAP BW) data, you must upload a set of files to your cloudenvironment.

BI Pattern applications requires that you package two SAP BW library files in aspecific directory structure. Follow these steps to create a compressed file (.zip)with the correct directory structure:1. Copy the 32-bit version of the SAP BW librfccm.so library file in a bin

directory of the compressed file.2. Copy the 64-bit version of the SAP BW librfccm.so library file in a bin64

directory of the compressed file.3. From your system, use the Virtual Application console to upload the

compressed file. Depending on whether your pattern is deployed, there are twoways to upload the compressed file:v If your BI Pattern application instance is deployed, you can update the files.

For more information, see “Updating drivers and configuration files to accessdata” on page 52.

v If your BI Pattern application is not deployed, you can add the files whilecreating the application pattern. For more information, see Chapter 5, “IBMBusiness Intelligence Pattern components and templates,” on page 23.

Chapter 4. Planning the deployment of Business Intelligence solutions in cloud environments 19

Page 26: User Guide Pattern

Adding supplementary fontsIf your environment requires fonts that are not installed with IBM Cognos BusinessIntelligence, you can install a set of supplementary fonts. These additional fontsbecome automatically available when authoring reports.

You associate new fonts to your BI Pattern virtual application by uploading acompressed file that contains the complete list of the additional fonts. These fontsare then associated with your virtual application instances. You can add font filesat deployment time or later.

If you add fonts after your virtual application is deployed or if you refresh existingfonts, ensure that the compressed file contains all the fonts that were previouslyassociated with the virtual application, even if the fonts have not changed.

Procedure1. Create a compressed file with the additional TrueType font files. The supported

file extensions are ttf or ttc.2. From your system, use the Virtual Application console to upload the

compressed file. Depending on whether your pattern is deployed, there are twoways to upload the compressed file:v If your BI virtual application instance is deployed, you can update the font

files. For information about updating the fonts files, see “Updating fonts” onpage 55.

v If your BI virtual application is not deployed, you can add the font fileswhile creating the virtual application pattern. For more information, see“Fonts” on page 28.

Reviewing security requirementsDepending on the security requirements of your environment, you might want toupdate your network configuration or set up additional security features. Beforeadding more security features for your BI Pattern virtual applications, determineyour private cloud environment security requirements.

BI Pattern virtual applications benefit from the built-in security features that areinherited from IBM Cognos Business Intelligence. In addition, virtual applicationscan take advantage of the security features of the private cloud framework.

For information about setting security in BI environments, see “Securing your BIvirtual application by setting the HTTPOnly parameter” on page 48.

Updating your network configurationTo protect your infrastructure from threats against your BI Pattern applications,you can configure an additional SSL-enabled entry point and add networkfirewalls.

The following diagram shows how you can combine BI patterns and networkfirewalls in your private cloud environment. In the first tier, users send requeststhrough an SSL-enabled entry point. These requests are then validated through anetwork firewall before reaching the tier of servers where the private cloudenvironment runs the BI patterns. This tier might contain database patterns for theBI content store and query databases. To further secure your environment,configure a network firewall to secure any authentication sources and databases

20 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 27: User Guide Pattern

located outside the private cloud.

On an AIX operating system, the firewall is disabled by default. To enable thefirewall, on an IBM PureApplication System 1700 server, you must enable IPSecfiltering after the deployment of IBM Cognos Business Intelligence. For moreinformation, see the web document titled BI Pattern - Additional hardening onIBM PureApplication System 1700 when IPSec filtering is enabled.

Adding support for PowerCubes

By default, when you deploy a BI Pattern virtual application, the Report Server isconfigured in 64-bit execution mode. If a deployment is configured to use IBMCognos PowerCubes as a data source, when you run a report it fails with errorQFS-ERR-0141.

If this error occurs, you must update the application configuration to supportPowerCubes. You can change the configuration by using one of the followingmethods:v Update the application from the Virtual Application Builder.

If you choose this method, you must deploy the virtual application again.v Update the deployed virtual application via an operation.

Figure 1. IBM Business Intelligence Pattern architecture using an SSL-enabled entry pointand network firewalls

Chapter 4. Planning the deployment of Business Intelligence solutions in cloud environments 21

Page 28: User Guide Pattern

Procedure1. To change the configuration from the Virtual Application Builder:

a. Click Patterns > Virtual Applications.b. Select the Business Intelligence virtual application to update, and click

Open.c. Expand Data source connectivity, and select Support Cognos PowerCubes.d. Save the application pattern and deploy it.

2. To update a deployed virtual application instance via an operation:a. Click Instances > Virtual Application.b. Select the Business Intelligence virtual application to update, and click

Manage.c. Click the Operations tab, and then select the Business Intelligence

application (CognosBICM1).d. In the Fundamental section, expand the Update Configuration section.e. Select Support Cognos PowerCubes, and then click Submit.

Results

The configuration change does not affect the IBM Cognos Dynamic Cubescomponent. It continues to run as a 64-bit application.

22 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 29: User Guide Pattern

Chapter 5. IBM Business Intelligence Pattern components andtemplates

IBM Business Intelligence Pattern (BI Pattern) virtual applications containmiddleware components that represent the Business Intelligence service for the BIvirtual application instance. BI Pattern virtual applications can also include apolicy that determines the scaling requirements of the deployed applications.

Architecture

IBM Business Intelligence Pattern contains components that you configure andconnect using the console of your system to create a virtual application pattern.You can then deploy the pattern to provision Business Intelligence virtualapplications. You can choose the following BI Pattern components:v Business Intelligence analytics component, which represents a service to deploy

IBM Cognos Business Intelligence applications. BI patterns must include oneBusiness Intelligence component.

v Dynamic Cubes analytics component, which represents a service to deploy IBMCognos Dynamic Cubes applications. BI patterns can include one or moreDynamic Cubes components, each one connected to the Business Intelligencecomponent.

v Existing user registry components, which provide a user registry (namespace)for container-managed security. If you do not configure and connect a userregistry to a Business Intelligence component, anonymous logon to yourapplication is enabled by default. You can have multiple user registries, and eachone must be connected to the Business Intelligence component that exists inyour pattern.

These components include the configuration specifications and user registryspecifications required for the application deployment. In addition, they containartifacts, such as the drivers needed to connect to a content store, an auditdatabase, and data sources.

You can also attach an optional scaling policy to the BI Pattern virtual application.The scaling policy dynamically manages the resources allocated to your BI Patternvirtual application.

The following diagram shows some of the BI Pattern virtual applicationcomponents and the topology that can be generated when these components aredeployed. In this example, the BI instance authenticates users through an externalauthentication provider.

© Copyright IBM Corp. 2012, 2014 23

Page 30: User Guide Pattern

Application templates that contains some of these components are provided withIBM Business Intelligence Pattern.

After the BI Pattern virtual application is deployed, a BI virtual applicationinstance is created. The BI instance generates middleware services that provision aminimum of four virtual machines hosting the Cognos BI Application Tiercomponents, the Content Manager Tier components, and an NFS server. The NFSserver acts as a repository for sharing content. The BI scaling policy determines theelasticity of the deployment and manages the addition and removal of the virtualmachines, as needed.

The following roles can be associated with the deployed middleware services:

CognosBICM1 or CognosBICM2These roles identify the virtual machines that host the active and thestandby Content Manager.

CognosBIASThis role identifies the virtual machine that hosts an application server(Application Tier) component.

Figure 2. BI Pattern virtual application components

24 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 31: User Guide Pattern

CognosBIASAutoScaleThis role identifies a scalable virtual machine that hosts an applicationserver component.

CognosBINFSServerThis role identifies the virtual machine that hosts the NFS server.

CognosBIASDC-Dynamic_cubes_server_nameThis role identifies the virtual machine that hosts a Dynamic Cubes server.

IBM Cognos Business Intelligence componentTo create a BI pattern, you configure the Business Intelligence component in theVirtual Application Builder. You can optionally add a scaling policy. You can alsoconnect the Business Intelligence component to multiple existing User Registrycomponents or to multiple Dynamic Cubes components.

General configuration settings

You can specify the following general configuration settings:

Name A unique name that identifies the BI component in the Virtual ApplicationBuilder.

Enable SSLSelect this option to enable SSL communication between Cognos BIcomponents. When this option is selected, the pattern turns on SSLbetween the Elastic Load Balancing (ELB) service and Cognos BI, turns onSSL between all Cognos BI components, and generates applicationendpoints the use HTTPS. The SSL configuration uses port number 443.

You can use the secure sockets layer (SSL) protocol for communication tothe content store and audit databases. SSL must be enabled on the contentstore and audit database server before deploying the pattern. To use securesockets layer (SSL) for database connections, you must identify the SSLcertificate in the Content store and audit database settings.

For information about configuring SSL on your first-tier proxy server, referto the documentation for your proxy server. If you configure yourenvironment to use SSL only on the first-tier proxy service withoutselecting the Enable SSL option, SSL is used only between the end user'sbrowser and the proxy service.

To change the SSL setting after the pattern is deployed, you must back updata on the NFS server, terminate you deployment, change the SSL setting,and then redeploy the pattern.

Application host name aliasA unique name that the ELB Proxy Service uses to relay incoming requeststo a BI Pattern application instance. This value represents the web aliasname used to construct entry points to the application instance. Forexample, if the application host name alias is ibmcognos, then the entrypoints to the application would be http://ibmcognos/p2pd andhttp://ibmcognos/p2pd/servlet/dispatch.

To change this setting after the pattern is deployed, you must back up anydata on the NFS server, terminate your deployment, change the name, andthen redeploy the pattern.

Valid domains or hostsThe list of domain names or host names separated by commas. These are

Chapter 5. IBM Business Intelligence Pattern components and templates 25

Page 32: User Guide Pattern

used by IBM Cognos Application Firewall (CAF) to validate requests withhost names and domain names. For example, *.mycompany.com, hostname,hostname:80.

Content store and audit databases information

BI Pattern application instances require access to a content store database and anaudit database. If you are moving an existing BI application to the cloudenvironment and want to reuse existing databases, review the content storesettings to ensure that they are optimized for the cloud environment. A subset ofthe content store settings are automatically optimized at deployment time.

For BI Pattern application instances to locate the content store and audit databases,you must provide the following attributes:

Content store database nameThe name of the database for the Business Intelligence and mobile contentstore.

Content store database server and port numberThe host name and port number of the content store database, separatedby a colon. For example: dbservername:50000.

Content store database user nameThe user name of an account with database administrator privileges for thecontent store database.

Content store database passwordThe password associated with the user name with database administratorprivileges for the content store database.

Content store database SSL certificateThe name of the compressed (.zip) file containing the certificate databasefiles required by Content Manager for establishing SSL connections. Youmust enable SSL for the Business Intelligence component to turn on SSLcommunication between the BI components and the content store database.You can update this setting after deployment.

Ensure that you enable SSL on your database server before you configureBI Pattern to use SSL for the database connections. Ensure that you exportthe SSL certificate from your database server and have it available in alocation you can access from BI Pattern system.

Audit database nameThe name for the audit database.

Audit database server and port numberThe host name and port number of the audit database, separated by acolon. Example: dbservername:50000.

Audit database user nameThe user name of an account with database administrator privileges for theaudit database.

Audit database passwordThe password associated with the user name with database administratorprivileges for the audit database.

Audit database SSL certificateThe name of the compressed (.zip) file containing the certificate databasefiles required for establishing SSL connections. You must enable SSL for the

26 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 33: User Guide Pattern

Business Intelligence component to turn on SSL communication betweenthe BI components and the audit database. You can update this settingafter deployment.

Ensure that you enable SSL on your database server before you configureBI Pattern to use SSL for the database connections. Ensure that you exportthe SSL certificate from your database server and have it available in alocation you can access from BI Pattern system.

Database JDBC driverThe name of the compressed (zip) file containing the files required forconnecting to the content store and audit databases. These files are onlyrequired for DB2 and Oracle databases. For information about preparingthe required files, see “Setting up access to your content store databases,audit databases, and data sources” on page 17.

Data source connectivity

You must upload the drivers required for data source connectivity of your BIPattern applications by specifying the following attributes either at deploymenttime or after the applications are deployed:

Data sources JDBC driversThe name of the compressed (zip) file containing one or more JDBCdrivers and license files for Business Intelligence relational data sourceconnectivity. For information about preparing the required files, see“Setting up access to your content store databases, audit databases, anddata sources” on page 17

SAP BW driversThe name of the compressed (zip) file containing the 32-bit and 64-bitlibrary files required for SAP NetWeaver Business Warehouse (SAP BW)connectivity. For information about using SAP BW data sources, see“Setting up access to SAP NetWeaver Business Warehouse servers” onpage 19.

TM1 configuration filesThe name of the compressed (zip) file containing specific TM1configuration files required for IBM Cognos Business Insight integration.For information about accessing TM1 data, see “Setting up IBM CognosBusiness Insight connectivity to TM1 data” on page 18.

Notification

You can set up BI Pattern applications for email notification using the followingattributes:

Notification mail server and port numberThe host name and port number of the mail server computer. The syntax ishost:port. For example, mailservername:25.

Notification user IDThe user ID required to log in to the email account. If the mail server doesnot require authentication, leave it blank.

Notification passwordThe password required for the email account that is used to log in to themail server. If the mail server does not require authentication, leave itblank.

Chapter 5. IBM Business Intelligence Pattern components and templates 27

Page 34: User Guide Pattern

Notification default senderThe email address of the sender of outgoing messages. For example,[email protected].

Administrative credentials

If your virtual applications use a CPU-based scaling policy, you must provide usercredentials with administrative privileges. BI Pattern virtual applications use thesecredentials to administer, optimize, and maintain the deployed virtual applications.If your virtual applications use a static scaling policy, these credentials are ignored.To specify administrative credentials, use the following attributes:

Administrative namespace IDThe identifier of the namespace associated with a user with administrativeprivileges. The namespace ID must be defined in an Existing User Registrycomponent; or if a user registry is not configured yet, specify NONE.

Administrative usernameThe username with administrative privileges for deploying andadministering BI Pattern applications.

Administrative passwordThe password for the username used for deploying and administering BIPattern application instances.

Fonts

If your environment requires fonts that are not installed with IBM Cognos BusinessIntelligence, you can install a set of supplementary fonts. You must package theseadditional fonts in a compressed file and then specify the file name in thefollowing attribute:

Supplementary fontsThe name of the compressed (zip) file containing additional font files thatcan be used when authoring reports. The file must contain the completelist of additional fonts. The supported font file extensions are ttf or ttc.For more information about fonts, see “Adding supplementary fonts” onpage 20.

Deployment throughput

Deployment throughput options specify whether predefined settings or customizedsettings are used for the allocation of server resources used by BI Patternapplication instances. To select a value appropriate for your environment, considerthe amount of resources available in the cloud group where the application isdeployed, and also review existing system metrics and trends as a baseline.

Use your console to select standard options for applications with low, medium, orhigh throughput. For the list of available settings, use the online help of yoursystem. To customize the server allocation of resources, you can select advanceddeployment throughput options:

Application servers resource allocation for CPU, RAM (GB), and disk space(GB) The allocation of the virtual CPU, RAM, and disk space resources for the

IBM Cognos BI Application Server Tier. The default values are servers withtwo virtual CPUs, 16 GB of RAM, and 50 GB of disk space.

Content Manager server resource allocation for CPU, RAM (GB), and disk space(GB) The allocation of the virtual CPU, RAM, and disk space resources for the

28 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 35: User Guide Pattern

IBM Cognos BI Content Manager Server Tier. The default values areservers with two virtual CPUs, 8 GB of RAM, and 50 GB of disk space.

NFS server resource allocation for CPU, RAM (GB), and disk space (GB)The allocation of the virtual CPU, RAM, and disk space resources of theNFS server. The default values are servers with one virtual CPU, 4 GB ofRAM, and 50 GB of disk space.

External object store

Using an external object store for report output reduces the size of the contentstore database and provides performance improvements for Content Manager.

Enable external object storeSelect this setting to configure Content Manager to store report outputs ona network share.

IBM Cognos Dynamic Cubes componentWhen you create patterns, you can add one or more Dynamic Cubes componentsand connect them to the Business Intelligence component.

The Dynamic Cubes component contains the following types of configurationoptions:v General configuration settingsv Deployment throughput options

General configuration settings

You can specify the following general configuration settings:

Name A unique name that identifies the Dynamic Cubes component in theVirtual Application Builder.

Number of static instancesThe number of virtual machines instances for the Dynamic Cubes servers.New machines are not provisioned or removed at run time.

Deployment throughput

Deployment throughput options specify whether predefined settings or customizedsettings are used for the allocation of server resources used by BI Patternapplication instances. To select a value appropriate for your environment, considerthe amount of resources available in the cloud group where the application isdeployed and also review existing system metrics and trends as a baseline.

Use your console to select standard options for applications with small, medium,or large throughput. For the list of available settings, use the online help of yoursystem. To customize the server allocation of resources, you can select thefollowing advanced deployment throughput options:

Application servers resource allocation for CPU, RAM (GB), and disk space(GB) The allocation of the virtual CPU, RAM, and disk space resources for the

IBM Cognos BI Application Server Tier. The default values are servers withtwo virtual CPUs, 16 GB of RAM, and 50 GB of disk space.

Dynamic Cubes servers resource allocation for CPU, RAM (GB), and disk space(GB) The allocation of the virtual CPU, RAM, and disk space resources for the

Chapter 5. IBM Business Intelligence Pattern components and templates 29

Page 36: User Guide Pattern

IBM Cognos BI Dynamic Query Server Tier. The default values are serverswith one virtual CPU, 4 GB of RAM, and 10 GB of disk space.

Note:

After installing BI Pattern, and consistent with IBM Business Intelligence behavior,you must define routing rules to ensure that dynamic cube-based reports aredirected to the dynamic query server for execution. To ensure that your serverprocesses dynamic cube requests, you must:v assign a server group to the dispatcherv assign a routing set to all packages associated with a dynamic cubev create a routing rule to send queries for the routing set to the server group

You can set routing rules in IBM Cognos Administration or you can use the IBMCognos Software Development Kit. For information about creating routing rules inIBM Cognos Administration, see Set Routing Keywords for Server Groups in theIBM Cognos Business Intelligence Administration and Security Guide and Configure adynamic cube for the query service in the IBM Cognos Dynamic Cubes UserGuide. For information about creating custom routing rules using the SDK, see theIBM Cognos Software Development Kit Developer Guide.

Business Intelligence scaling policyYou can add a scaling policy to an BI Pattern deployment to manage the workloadmore effectively and improve overall performance.

To add a scaling policy to a Business Intelligence component, in VirtualApplication Builder, click Add policy for application > Scaling policy. Click Helpon the scaling policy component for information about properties for the scalingpolicy.

To ensure that the BI Pattern virtual applications do not consume unnecessaryresources and degrade overall system performance, consult the systemadministrator before increasing the default scaling policy settings.

There are two scaling policy options.

Disabled

The Disabled option includes a setting for specifying the number of virtualmachines that are available at all times. Maintaining a specific number of activevirtual machines is appropriate when your application workload is constant.Additional virtual machines are not added to the environment when the workloadexceeds the expected volume.

Enabled

The Enabled option includes settings for specifying the number of virtualmachines that are always available, and the number of additional temporaryvirtual machines that will be activated to process increased workload. This scalingoption also includes time and trigger event settings. The Time (minutes) to triggeradd or remove and Timeout (minutes) settings control when temporary virtualmachines are added or removed from the environment. CPU utilization and reportservice queue are the conditions that you can use as trigger events to add orremove temporary virtual machines.

30 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 37: User Guide Pattern

Use CPU utilization condition as a trigger event when your application workloadis difficult to predict. Use report service queue condition as a trigger event whenthe workload frequently includes a high volume of concurrent report requests thatcreates a backlog of unprocessed requests. When you select the CPU utilization orreport service queue option, the condition of either CPU utilization or reportservice queue will trigger the addition or removal of temporary virtual machines.

For environments that use external products, such as IBM Cognos FrameworkManager, you must use at least one static virtual machine to ensure that theexternal products can connect to the BI server at all times.

User registry componentsYou define the user authentication sources for your BI applications by configuringand then connecting user registry (namespace) components to a BusinessIntelligence component. When user registry components are not defined in yourapplication pattern, anonymous logon to your virtual application is enabled bydefault.

Before you can use these external resources, they must already exist in yourenvironment and be configured for use in authentication. For information aboutLDAP configuration and custom Java authentication provider, see the IBM CognosBusiness Intelligence documentation.

If your applications require LDAP attributes that are not included in the IBM TivoliDirectory Server or the Microsoft Active Directory user registry component, use theGeneric LDAP Directory Server component.

IBM Tivoli Directory Server

An IBM Tivoli Directory Server user registry component represents an existingLightweight Directory Access Protocol (LDAP) services that you can connect to aBI component. This LDAP service provides a user registry (namespace) forcontainer-managed security.

You can specify the following attributes for each user registry:

Name A unique name that represents the name of the namespace. Specify thisname for maintenance operations on a user registry.

Namespace IDA unique value that identifies this namespace. This value is used internallyat run time by IBM Cognos BI components. You specify this identifierwhen you define a pattern.

Server and port numberThe host name and the port number for the directory server, separated bya colon. Instead of the host name, you can specify the IP address. Forexample, ldapservername:389.

Base distinguished nameThe base distinguished name of the LDAP server.

User lookupThe user lookup information used for binding to the LDAP directoryserver.

Chapter 5. IBM Business Intelligence Pattern components and templates 31

Page 38: User Guide Pattern

Bind user DNThe user ID used for binding to the LDAP server when performing asearch using the user lookup property, or when performing all operationsusing the external identity mapping.

PasswordThe password for the user ID used for binding to the LDAP server.

Use bind credentials for searchSpecifies whether to use bind credentials to search.

This option affects only users who do not use an external identitymapping. If you select this option, the bind credentials that are provided inthe namespace configuration are used to search in the LDAP directoryserver. If you do not select this option, or bind credentials are notavailable, the authenticated user credentials are for searching.

SSL certificate databaseSpecifies the name of the compressed (zip) file containing the certificatedatabase files that are required by the LDAP directory server forestablishing SSL connections.

Your administrator must create this file when enabling SSL for use with anLDAP directory server. For more information, see the IBM Cognos BusinessIntelligence Administration and Security Guide.

MultitenancyFor more information, see “Multitenant environments” on page 37.

Microsoft Active Directory

A Microsoft Active Directory user registry component represents an existing LDAPservice that can be connected to a BI component. This LDAP service provides auser registry (namespace) for container-managed security.

You can specify the following attributes for each user registry:

Name A unique name that represents the name of the namespace. Specify thisname for maintenance operations on a user registry.

Namespace IDA unique value that identifies this namespace. This value is used internallyat run time by IBM Cognos BI components. You specify this identifierwhen you define a pattern.

Server and port numberThe host name and the port number for the directory server, separated bya colon. Instead of the host name, you can specify the IP address. Forexample, ldapservername:389.

Base distinguished nameThe base distinguished name of the LDAP server.

User lookupThe user lookup information used for binding to the LDAP directoryserver.

Bind user DNThe user ID used for binding to the LDAP server when performing asearch using the user lookup property, or when performing all operationsusing the external identity mapping.

32 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 39: User Guide Pattern

PasswordThe password for the user ID used for binding to the LDAP server.

Use bind credentials for searchSpecifies whether to use bind credentials to search.

This option affects only users who do not use an external identitymapping. If you select this option, the bind credentials that are provided inthe namespace configuration are used to search in the LDAP directoryserver. If you do not select this option, or bind credentials are notavailable, the authenticated user credentials are for searching.

SSL certificate databaseSpecifies the name of the compressed (zip) file containing the certificatedatabase files that are required by the LDAP directory server forestablishing SSL connections.

Your administrator must create this file when enabling SSL for use with anLDAP directory server. For more information, see the IBM Cognos BusinessIntelligence Administration and Security Guide.

MultitenancyFor more information, see “Multitenant environments” on page 37.

Generic LDAP Directory Server

A Generic LDAP Directory Server user registry component represents an existingLDAP service that can be connected to a BI component. This LDAP serviceprovides a user registry (namespace) for container-managed security.

You can provide the following attributes for each user registry:

Name A unique name that represents the name of the namespace. Specify thisname for maintenance operations on a user registry.

Namespace IDA unique value that identifies this namespace. This value is used internallyat run time by IBM Cognos BI components. You specify this identifierwhen you define a pattern.

Server and port numberThe host name and the port number for the directory server, separated bya colon. Instead of the host name, you can specify the IP address. Forexample, ldapservername:389.

Base distinguished nameThe base distinguished name of the LDAP server.

User lookupThe user lookup information used for binding to the LDAP directoryserver.

External identity mappingThe mapping used to construct a distinguished name (DN) or a searchfilter to locate a user in the LDAP directory server. If the applicationcannot find the environment variable or the DN in the LDAP server, itattempts to use the User lookup property to construct the DN.

If you specify ${environment("ENVIRONMENT_VARIABLE_NAME")}, all instancesof this string are replaced by the value of the environment variableprovided by the web server. If the string does not begin with an openparenthesis, the result of the substitution is assumed to be the user's DN.

Chapter 5. IBM Business Intelligence Pattern components and templates 33

Page 40: User Guide Pattern

For example, uid=${environment("REMOTE_USER")},ou=people, base DN,where base DN is the Base Distinguished Name parameter value. If thevalue begins with an open parenthesis, the result of the substitution isassumed to be a search filter. For example,(userPrincipalName=${environment("REMOTE_USER")}). In this case, youmust either enable anonymous access to the LDAP directory server or setthe Bind user DN and Password properties.

For more information about LDAP mapping, see the IBM Cognos BusinessIntelligence Architecture and Deployment guide.

Bind user DNThe user ID used for binding to the LDAP server when performing asearch using the user lookup property, or when performing all operationsusing the external identity mapping.

PasswordThe password for the user ID used for binding to the LDAP server.

Use bind credentials for searchSpecifies whether to use bind credentials to search.

This option affects only users who do not use an external identitymapping. If you select this option, the bind credentials that are provided inthe namespace configuration are used to search in the LDAP directoryserver. If you do not select this option, or bind credentials are notavailable, the authenticated user credentials are for searching.

Unique identifierThe value used to uniquely identify objects stored in the LDAP directoryserver.

SSL certificate databaseSpecifies the name of the compressed (zip) file containing the certificatedatabase files that are required by the LDAP directory server forestablishing SSL connections.

Your administrator must create this file when enabling SSL for use with anLDAP directory server. For more information, see the IBM Cognos BusinessIntelligence Administration and Security Guide.

MultitenancyFor more information, see “Multitenant environments” on page 37.

The Generic LDAP Directory Server user registry component provides thefollowing groups of additional attributes:v For folder mappings:

Name The LDAP attribute used for the “name” property of a folder.

Object classThe name of the LDAP object class used to identify a folder.

DescriptionThe LDAP attribute used for the “description” property of a folder.

v For group mappings:

Name The LDAP attribute used for the “name” property of a group.

Object classThe name of the LDAP object class used to identify a group.

34 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 41: User Guide Pattern

DescriptionThe LDAP attribute used for the “description” property of a group.

MemberThe LDAP attribute used for the “member” property of a group.

v For account mappings:

Name The LDAP attribute used for the “name” property of an account.

Account object classThe name of the LDAP object class used to identify an account.

DescriptionThe LDAP attribute used for the “description” property of an account.

Product localeThe LDAP attribute used for the “productLocale” property of anaccount.

Content localeThe LDAP attribute used for the “contentLocale” property of an account.

UsernameThe LDAP attribute used for the “userName” property of an account.

PasswordThe LDAP attribute used for the “password” property of an account.

SurnameThe LDAP attribute used for the “surname” property of an account.

Given nameThe LDAP attribute used for the “givenName” property of an account.

Postal addressThe LDAP attribute used for the “postalAddress” property of anaccount.

Email The LDAP attribute used for the “email” property of an account.

Business phoneThe LDAP attribute used for the “businessPhone” property of anaccount.

Home phone:The LDAP attribute used for the “homePhone” property of an account.

Mobile phoneThe LDAP attribute used for the “mobilePhone” property of an account.

Pager phoneThe LDAP attribute used for the “pagerPhone” property of an account.

Fax/PhoneThe LDAP attribute used for the “faxPhone” property of an account.

v For advanced authentication properties:

Advanced propertiesThe number of authentication properties that you want to set. Blankentries are ignored.

Name The name of the advanced property for the user registry.

Value The value associated with the advanced property.v For custom LDAP properties:

Chapter 5. IBM Business Intelligence Pattern components and templates 35

Page 42: User Guide Pattern

Custom propertiesThe number of authentication properties that you want to set. Blankentries are ignored.

Name The name of the custom property. For example, dept.

Value The value associated with a custom property.v For custom files:

MultitenancyFor more information, see “Multitenant environments” on page 37.

Custom filesThe name of the compressed file that contains custom files that arerequired by your Custom Java Provider user registry. When you deployyour pattern, the custom files are copied in the file structure specified inthe compressed file.

Custom Java Provider

An Existing User Registry (Custom Java Provider) component represents a customJava authentication provider that can be attached to an IBM Cognos BusinessIntelligence component. The custom Java authentication provider provides a userregistry (namespace) for container-managed security. This external resource mustalready exist in your environment and be configured for use in authentication.

You can provide the following attributes for each user registry:

Name A unique name that represents the name of the namespace. Specify thisname for maintenance operations on a user registry.

Namespace IDA unique value that identifies this namespace. This value is used internallyat run time by IBM Cognos BI components. You specify this identifierwhen you define a pattern.

Java class nameThe name of the Java class to authenticate users.

Selectable for authenticationWhen this option is selected, application users can select this user registryon the logon page of the application.

MultitenancyFor more information, see “Multitenant environments” on page 37.

The Custom Java Provider user registry component provides the following groupsof additional attributes:v For advanced authentication properties:

Advanced propertiesThe number of authentication properties that you want to set. Blankentries are ignored.

Name The name of the advanced property for the user registry.

Value The value associated with the advanced property.v For custom files:

MultitenancyFor more information, see “Multitenant environments” on page 37.

36 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 43: User Guide Pattern

Custom filesThe name of the compressed file that contains custom files that arerequired by your Custom Java Provider user registry. When you deployyour pattern, the custom files are copied in the file structure specified inthe compressed file.

Multitenant environmentsMultitenancy provides the capability to support multiple customers ororganizations, called tenants, by using a single deployment of an application whileensuring that each tenant users can access only the data that they are authorized touse. Such applications are called multitenant applications. Multitenant applicationsminimize the extra costs associated with these environments.

IBM Cognos Business Intelligence provides built-in multitenancy capabilities. TheCognos BI multitenancy feature does not require you to perform additionaladministration tasks to manage tenants because it reuses your existingauthentication infrastructure. When multitenancy is enabled, it does not affect howyou currently manage your users and groups. To add, remove, or manage tenants,you use your existing authentication provider.

Objects within Content Manager can be associated to a particular tenant or becategorized as public. Public objects are visible by all users regardless of the user'stenancy if the object security policies permit access.

The following diagram shows an example how the Cognos BI multitenancycapabilities isolate access to objects in your content store. Users can access only theobjects that they are authorized to access within each tenant grouping.

In this example, the users have access to the following objects:v Users that belong to Tenant 1 can access object_1, object_2, and object_3.v Users that belong to Tenant 2 can access object_3, object_4, object_5, and

object_6.

The system administrator can access all objects in the content store.

When accessing objects, object tenancy is evaluated before object accesspermissions. Therefore, users in a multitenant application see only the objects thatare associated with their tenant and objects that are categorized as public.

Figure 3. Content store configured to use the Cognos BI multitenancy capabilities

Chapter 5. IBM Business Intelligence Pattern components and templates 37

Page 44: User Guide Pattern

Configuring multitenancyTo configure multitenancy in your IBM Cognos Business Intelligence installation,you need to specify the multitenancy properties in the IBM Cognos BusinessIntelligence component. The values for the multitenancy properties are different foreach environment and depend on how you map the tenancy information toindividual users in your environment.

Important: You should not need to modify anything in your authenticationprovider to configure multitenancy.

Before you configure multitenancy, you must decide how to map the user accountin your authentication provider to the tenant. You can use for this purpose theposition of a user within the hierarchy in your authentication provider or the useraccount properties in your authentication provider. You can also implement acustom tenant provider. To use the last option, you must have the IBM CognosSoftware Development Kit. The decision to choose the proper implementationmethod requires careful planning and knowledge of your authentication provider.

Depending on your decision how to map the user account to the tenant, chooseone of the following methods to configure multitenency.v “Configuring multitenancy that is based on a hierarchy node”v “Configuring multitenancy that is based on a user account attribute” on page 39v “Configuring multitenancy that is based on a custom tenant provider” on page

39

Configuring multitenancy that is based on a hierarchy node:

You can reuse the node structure information within a hierarchy of yourauthentication provider when configuring your tenant.

You can use the ancestors user account attribute for this purpose. The ancestorsattribute represents the hierarchical path to a user account in the form of an array.The following table shows how you might map the ancestors attribute to ahierarchy to identify the tenancy information.

Table 1. Ancestors attribute mapped to the hierarchy information

Ancestors information Hierarchy LDAP example

ancestors[0] Directory node

ancestors[1] Namespace ID base DN

ancestors[2] Tenant grouping,such as a folder

organizational units

For example, if users are stored in an LDAP directory and tenants are directlyunder the base Distinguished Name (DN) as organizational units, you can set thePattern type to the following value: ~/ancestors[2]/defaultName.

In addition to defaultName, the following ancestors qualifiers can return tenancyinformation:v name/locale

The locale parameter in this example is based on the mapping in the namespaceconfiguration. If no locale is given, the name is the title of the object. Forexample, you might specify: ~/ancestors[2]/name/EN-ca

v searchPath/objectID

38 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 45: User Guide Pattern

For example, you might specify: ~/ancestors[2]/searchPath/objectId

After multitenancy is enabled, the system administrator must set the tenancyinformation for objects in the content store. For more information, see the Tenantadministration topics in the IBM Cognos Business Intelligence Administration andSecurity Guide.

Configuring multitenancy that is based on a user account attribute:

You can designate a specific user account attribute in your authentication providerto map to the tenant. After you choose the user account attribute that you want tomap to the tenant, you must create a custom property and map it to that attribute.

The user account attribute that you choose to identify the user's tenant should beused only for this purpose.

For example, you can decide that the businessUnit attribute of an LDAP useraccount would identify the user's tenant. In this case, you set the Pattern typeproperty as follows: ~/parameters/parameter_name. Next, you specify a customproperty named parameter_name and associate this property with the user accountattribute businessUnit

After multitenancy is enabled, the system administrator must set the tenancyinformation for objects in the content store. For more information, see the Tenantadministration topics in the IBM Cognos Business Intelligence Administration andSecurity Guide.

Configuring multitenancy that is based on a custom tenant provider:

You can create a custom Java class and reference it when configuring multitenancy.You can use this method when you need to join data from multiple authenticationproviders, or from an authentication provider and a relational database. You mustuse the IBM Cognos Software Development Kit for this method.

Before you can configure multitenancy by using this method, you must performthe following tasks.v Compile any required custom Java class files into JAR files and either place the

files into the c10_location/webapps/p2pd/WEB-INF/lib directory with anyassociated files, or update the CLASSPATH environment variable to include thepath to these files.

v Implement the ITenantProvider interface by using the IBM Cognos CustomAuthentication Provider and define the custom Java class in that interface. Forexample, the custom Java class name can be com.example.class. For moreinformation, see the IBM Cognos Software Development Kit Custom AuthenticationProvider Developer Guide.

Tip: IBM Cognos Custom Authentication Provider includes a sample customJava class that you can use. You can find the sample files in thec10_location\sdk\java\AuthenticationProvider\MultiTenancyTenantProviderSample directory.

After multitenancy is enabled, the system administrator must set the tenancyinformation for objects in the content store. For more information, see the Tenantadministration topics in the IBM Cognos Business Intelligence Administration andSecurity Guide.

Chapter 5. IBM Business Intelligence Pattern components and templates 39

Page 46: User Guide Pattern

Enabling multitenancyTo enable IBM Cognos multitenancy capabilities, you set properties for userregistry components.

Before you beginv Identify how tenant information is determined for individual users in your

environment. For more information, see “Configuring multitenancy” on page 38.v Compile any required custom Java class files into JAR files and either place

them into the c10_location/webapps/p2pd/WEB-INF/lib directory along with anyassociated files, or update the CLASSPATH environment variable to include thepath to these files. This is required only if using a custom Java authenticationprovider.

v If a namespace is not configured to use multitenancy, then policies andpermissions for objects are used to determine who can access the objects. Ifmultitenancy is applied to multiple namespaces, the tenant IDs in allnamespaces must be unique.

About this task

Tenant ID mapping type and Tenant bounding set mapping type are the twoproperties associated with multitenancy. The Tenant ID mapping type property ismandatory to enable multitenancy. The Tenant bounding set mapping typeproperty is optional and used to set up delegated tenant administration.

Both properties can have independent implementations. For example, you can usethe position of a user within a hierarchy to determine the Tenant ID mapping typeproperty and create custom code to determine the Tenant bounding set mappingtype property.

Procedure1. Click Patterns > Virtual Applications.2. Select the Business Intelligence virtual application to update, and click Open.3. Select an existing user registry component.4. Under Multitenancy, click the Tenant ID mapping type property and select

one of the following properties:v Pattern

– When using the hierarchy information, you could specify the followingvalue for this property:~/ancestors[2]/defaultName

– When using specific object attributes from your authentication provider,such as businessUnit, you could specify the following value for thisproperty:~/parameters/parameter_name

v Provider class

To use a custom Java class, you only need to specify the name of the Javaclass that you created. The ITenantProvider interface must already beimplemented using the IBM Cognos Custom Authentication Provider.

5. Optional: Under Multitenancy, specify the Tenant bounding set mapping typeproperty.Click the edit button for this property and specify one of the followingproperties:v Pattern

40 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 47: User Guide Pattern

You could specify the following value for this property:~/parameters/boundingSet

v Provider class

To use a custom Java class, you only need to specify the name of the Javaclass that you created. The IBoundingSetProvider interface must already beimplemented using IBM Cognos Custom Authentication Provider.

6. Restart the IBM Cognos service for the changes to take effect.

What to do next

After multitenancy is enabled, the system administrator must set the tenancyinformation for the objects in the content store. For more information, see theTenant administration topics in the IBM Cognos Business Intelligence Administrationand Security Guide.

Disabling multitenancyTo disable multitenancy, you must remove the multitenancy properties from theuser registry component.

All tenant IDs must be removed from all objects in the content store. If all tenantIDs are not removed after disabling multitenancy, the application behavior mightbe unpredictable. To fully understand the multitenancy features, test the systembefore enabling multitenancy in a production environment. After multitenancy isdisabled, the system IBM Cognos BI administrator must review and update thepolicies on objects and then update the tenancy to public. For more information,see the Tenant administration topics in the IBM Cognos Business IntelligenceAdministration and Security Guide.

NFS serverAn NFS server is automatically configured as part of your deployment of IBMBusiness Intelligence Pattern. The NFS server acts as a repository for sharingcontent between virtual machines in the deployment. To use the NFS server, youmust log in as a special user named “cognos” and copy files manually to specificdirectories.

Before you can work with the NFS server, you must add Secure Shell (SSH)key-based access when deploying the virtual application pattern. When deployinga virtual application pattern, you can configure an RSA key pair to enable SSH keybased access to the virtual machines. You can either provide your ownexternally-generated public key or use a key pair that is generated by the system.For information about configuring SSH key-based access, see the documentationfor your system.

You must access the NFS server for the following tasks:v Rendering images. For information about where to copy images, see “Rendering

images in HTML and PDF reports” on page 46.v Importing and exporting deployment archives. For information about working

with deployment archives, see “Importing or exporting BI deployment archives”on page 46.

v Using PowerCubes. For information about using PowerCubes, see “CopyingPowerCubes” on page 47.

Chapter 5. IBM Business Intelligence Pattern components and templates 41

Page 48: User Guide Pattern

It is important to determine a backup strategy for the content of the NFS serverbecause the NFS server is deleted when your virtual application is deleted. Formore information, see “NFS server content back up” on page 49.

Creating application templatesYou can use application templates to create a Business Intelligence (BI) Patternvirtual application.

Some application templates are provided with the BI Pattern type. You can alsocreate and save your own templates to eliminate common tasks such as definingconnection information to your LDAP servers.

When you create a new virtual application, you can select one of the following BIPattern application templates and change it to suit your environment:

Blank IBM Business Intelligence application templateThis application template contains the BI component. If you do not add auser registry to this template, the deployed virtual application hasanonymous signon enabled by default.

Sample IBM Business Intelligence application templateThis application template contains the BI component, a scaling policy, andan IBM Tivoli Directory Server namespace (user registry).

Procedure1. Create a BI virtual application pattern.

There are multiple ways to create a virtual application pattern using a template.For example, depending on your administrative credentials, you can use thePattern or the Catalog menu. For information about using a pattern template tocreate a virtual application, see the documentation for your system.

2. Update the application components using the Virtual Application Builder.For information about updating the IBM Cognos Business Intelligence (BI)components, see Chapter 5, “IBM Business Intelligence Pattern components andtemplates,” on page 23.

3. Save the application pattern.

What to do next

After you have created your application pattern, perform the following steps:1. Deploy your application pattern to the cloud group where the ELB shared

service is running. For information on how to deploy applications, refer to yoursystem documentation.

2. Perform any applicable post-deployment configuration tasks. For moreinformation, see “Post-deployment tasks” on page 45.

3. Apply the latest BI fix packs in all environments. For more information, see“Applying fix packs and interim fixes” on page 50.

4. Access and test the BI virtual application. For more information, see “Access tothe IBM Business Intelligence application” on page 45.

5. Determine a backup strategy for the content of the NFS server. For moreinformation, see “NFS server content back up” on page 49.

6. Move your application to a production environment. For more information, see“Moving a BI virtual application to a production environment” on page 49.

42 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 49: User Guide Pattern

7. Maintain the virtual application instance. For the list of operations that you canrun on virtual application instances, see “Maintenance of BI virtualapplications” on page 50.

Chapter 5. IBM Business Intelligence Pattern components and templates 43

Page 50: User Guide Pattern

44 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 51: User Guide Pattern

Chapter 6. Administer IBM Business Intelligence Patternvirtual applications

After your BI Pattern virtual applications are deployed, you can performpost-deployment tasks to ensure that your applications are performing well.

Post-deployment tasksYou can perform administration tasks to ensure that your applications runoptimally.

Access to the IBM Business Intelligence applicationAfter the virtual application is deployed and started, you can access the BusinessIntelligence application. To do this, you must determine the application endpointURL by using the Virtual Application Instances dashboard.

Each virtual application instance has at least four virtual machines associated withit. Some of the virtual machines have endpoints that provide access to differentcomponents of your BI application. Virtual machines with the following roles haveendpoints that you can use:

CognosBICM1 or CognosBICM2The endpoint information contains a link that you can use to viewinformation about the active or the standby Content Manager and todetermine which of the virtual machines hosts the active Content Manager.For example, the endpoint information might appear as follows:Endpoint informationCognos BI Content Manager URI: http://172.0.16.1:9300/p2pd/servlet

CognosBIAS, CognosBIASAutoScale or starts with CognosBIASDCThe endpoint information contains links to your virtual applicationinstance, and provides information that you can use to configure otherproducts to connect to your virtual application instance. For example, theendpoint information might appear as follows:Endpoint informationApplication URI: http://ibmcognos/p2pdLocal application URI: http://172.0.16.1:9300/p2pd/servlet/dispatchURI for external applications: http://172.0.16.1:9300/p2pd/servlet/dispatch

To access the BI application Home page or Login page, use theApplication URI endpoint.

Important: To access the virtual host name, register a DNS entry for thevirtual host name.

When you configure other applications to connect to your virtualapplication instance, use the URI for external applications and the Localapplication URI information. For information about configuringFramework Manager, Cube Designer or Lifecycle Manager, see“Configuring IBM Cognos BI products to connect to a BI virtualapplication” on page 48.

© Copyright IBM Corp. 2012, 2014 45

Page 52: User Guide Pattern

Importing or exporting BI deployment archivesYou can use Business Intelligence (BI) deployment archives in your cloudenvironment.

First, you must copy the BI deployment archive to the NFS server of the virtualapplication instance. Then, a BI administrator can use IBM Cognos Administrationto import or export the deployment archive into the BI application.

Before you beginv You successfully deployed a virtual application instance of the IBM Business

Intelligence Pattern (BI Pattern).v You have access to the source environment where the deployment archives are

stored.v You know the IP address of the virtual machine that is hosting the NFS server.

You can use the workload console of your system to determine the IP address ofthe NFS server.

About this task

You must repeat this procedure whenever you redeploy an instance of the virtualapplication.

When you deploy a BI Pattern application, a cognos user account is automaticallycreated on the NFS server. You must log in to the NFS server as the cognos userand copy the deployment archives to the /data/deployment directory.

Procedure1. Log in to the NFS server as the cognos user.

If you cannot log in, the RSA key pair might be out of sync. For informationabout copying the virtuser key to the /home directory of the cognos user, see“Cognos user cannot log in to the NFS server” on page 66.

2. Find the deployment archive files in your source environment and copy themto the /data/deployment directory in the NFS server.

3. Open IBM Cognos Administration and log in as an administrator.4. Import or export the deployment archives. For information about working with

deployment archives, see the IBM Cognos Business Intelligence Administration andSecurity Guide.

Rendering images in HTML and PDF reportsFor images to display in HTML and PDF reports in your deployed application, youmust copy the images to the virtual application NFS server to make the imagesavailable to all the application servers.

Before you beginv You successfully deployed a virtual application instance of the IBM Business

Intelligence Pattern (BI Pattern).v You have access to the source environment where the images are stored.v You know the IP address of the virtual machine that is hosting the NFS server.

You can use the workload console of your system to determine the IP address ofthe NFS server.

46 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 53: User Guide Pattern

About this task

You must repeat this procedure whenever you redeploy an instance of the virtualapplication.

When you deploy a BI Pattern application, a cognos user account is automaticallycreated on the NFS server. You must log in to the NFS server as the cognos userand copy the images to the /data/images directory.

Procedure1. Log in to the NFS server as the cognos user.

If you cannot log in, the RSA key pair might be out of sync. For informationabout copying the virtuser key to the \home directory of the cognos user, see“Cognos user cannot log in to the NFS server” on page 66.

2. Find the images in your source environment and copy them to the/data/images directory in the NFS server.

3. Add references to your images in your BI reports using the following syntax:http://virtual_host/p2pd/images/image_name. For example, to add an imagecalled logo.jpg, you might specify http://ibmcognos/p2pd/images/logo.jpg.For information about working with images, see Insert an Image in a Report inthe IBM Cognos Report Studio User Guide.

Copying PowerCubesTo use PowerCubes in your Business Intelligence virtual applications, you mustcopy the PowerCubes to the NFS server to make the data available to all theapplication servers.

Before you beginv You successfully deployed a virtual application instance of the IBM Business

Intelligence Pattern (BI Pattern).v You have access to the source environment where the PowerCubes are stored.v You know the IP address of the virtual machine that is hosting the NFS server.

You can use the workload console of your system to determine the IP address ofthe NFS server.

About this task

You must repeat this procedure whenever you redeploy an instance of the virtualapplication.

When you deploy a BI Pattern application, a cognos user account is automaticallycreated on the NFS server. You must log in to the NFS server as the cognos userand copy the PowerCubes to the /data/cubes directory.

Procedure1. Log in to the NFS server as the cognos user.

If you cannot log in, the RSA key pair might be out of sync. For informationabout copying the virtuser key to the \home directory of the cognos user, see“Cognos user cannot log in to the NFS server” on page 66.

2. Find the PowerCubes in your source environment, and copy them to the/data/cubes directory in the NFS server.

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications 47

Page 54: User Guide Pattern

3. Make the PowerCubes available to your application users by creating packagesand publishing them from Transformer or Framework Manager. You can alsocreate PowerCube packages in IBM Cognos BI. To specify the NFS serverlocation of a PowerCube, use the following syntax: ../cubes/PowerCube_name.For example, to add a cube called outdoors.mdc, you can specify../cubes/outdoors.mdc in IBM Cognos Administration or Framework Manager.For information about deploying PowerCubes, see the IBM Cognos BusinessIntelligence documentation.

Configuring IBM Cognos BI products to connect to a BI virtualapplication

For Business Intelligence (BI) products, such as Framework Manager, CubeDesigner or Lifecycle Manager, you must update their configurations with thelocation of your virtual application instance to connect to it.

On each computer where IBM Cognos BI client products are installed, you mustupdate the Gateway URI and the Dispatcher URI for external applicationsproperties using IBM Cognos Configuration.

Before you begin

Obtain the endpoint information for your virtual application instance. To obtain it,you can use the Virtual Application Instances dashboard and click the Endpointlink of any virtual machines that host a BI application server. For example,assuming an application with a virtual host name of ibmcognos, the endpointinformation might be as follows:Endpoint informationApplication URI: http://ibmcognos/p2pdLocal application URI: http://172.0.16.1:9300/p2pd/servlet/dispatchURI for external applications: http://172.0.16.1:9300/p2pd/servlet/dispatch

Procedure1. Start IBM Cognos Configuration.2. In the Explorer window, click Environment.3. In the Properties window, update the following properties to point to your

virtual application instance:a. Update the Gateway URI property with the information provided by the

Local application URI endpoint value using the following syntax:http://IP address of local dispatcher:9300/p2pd/servlet/dispatch

For example: http://172.0.16.1:9300/p2pd/servlet/dispatchb. Update the Dispatcher URI for external applications property with the

information provided by the URI for external applications endpoint valueusing the following syntax:http://IP address of local dispatcher:9300/p2pd/servlet/dispatch

For example: http://172.0.16.1:9300/p2pd/servlet/dispatch4. From the File menu, click Save.

Securing your BI virtual application by setting the HTTPOnlyparameter

Depending on your environment, you can decide to add additional securityfeatures to your virtual application instances.

48 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 55: User Guide Pattern

Enabling the HTTPOnly attribute prevents malicious scripts from stealing thesession identity of a user. You set this attribute in IBM Cognos Administration.

Before you begin

Administrators who want to enable this attribute must ensure that users have aweb browser that supports the HTTPOnly attribute.

Procedure1. Go to IBM Cognos Administration.2. On the Status tab, click System.3. In the Scorecard pane, from the System drop-down menu, click Set properties.4. Click the Settings tab.5. From the Category list, select Environment.6. For the HTTPOnly Cookie Support parameter, select the corresponding check

box in the Value column.7. Click OK.

Moving a BI virtual application to a production environmentAfter you test your BI virtual application, you can move it to a productionenvironment.

Procedure1. Complete one of the following tasks:

v Perform a full content store deployment.v Perform a database backup of your existing content store and restore the

content into a new content store database. For information about databasebackups, see the documentation for your database vendor.

2. To enable the virtual host name to work for the application users, register aDNS entry for the virtual host name.

3. Update any content with URL links so that those links point to the newendpoint information. Test your changes.

4. For your application to use SSL on the first-tier proxy, make sure that SSL isconfigured on port 443 of the first-tier proxy.

NFS server content back upWork with your system administrator to determine a backup strategy for thecontent of the NFS server. Perform regular backups of the content of the NFSserver to ensure that you can recover application data if your virtual applicationinstance is deleted.

Back up the following directories because they contain important informationabout your virtual application instance:v /data/cubes

v /data/images

v /data/deployment

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications 49

Page 56: User Guide Pattern

Maintenance of BI virtual applicationsFrom time to time, you must apply maintenance activities to virtual applications,such as password updates or software updates. These maintenance activities arecalled operations. Before you apply operations, an application must be inmaintenance mode.

From your system, you can submit a maintenance operation for eachadministration task separately or you can combine multiple tasks into a singlemaintenance operation. Combining multiple operations reduces the downtime ofyour virtual applications. After a maintenance operation is applied, the systemrestarts the virtual application automatically. If the virtual application cannot berestarted, review the log files to determine the cause of the problem.

Applying fix packs and interim fixesAfter your virtual application is deployed, you can use your system to upload IBMCognos Business Intelligence (BI) fix packs and interim fixes. You can associate theappropriate fixes to specific virtual application instances, as needed.

Before you begin1. Download the latest BI fix pack and interim fixes from Fix Central.2. Add the BI fix packs and interim fixes as emergency fixes to the catalog of your

system. Associate the fix files to the IBM Business Intelligence cognosbi/2.2.0.0plug-in.For information about creating fixes, see the documentation for your system.

Procedure1. Set the application to Maintaineance mode.2. Click Instances > Virtual Application. The Virtual Application Instances

palette displays.3. Select the Business Intelligence virtual application that you want to update.4. Click the Manage icon.5. Click the Operation tab.6. From the Operations palette, select the Business Intelligence application

(CognosBICM1).7. In the Product maintenance section, expand the Install IBM Cognos Business

Intelligence Updates section.8. Click the Select button to choose which product updates to apply to your

virtual application.9. Click the Submit button.

10. Check the progress of the update in the Operation Execution Results sectionto verify that the fix was applied successfully.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > VirtualApplications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

50 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 57: User Guide Pattern

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating user credentialsYou can update user names and passwords for the components used by the virtualapplication instances. In addition, you can update the credentials used for bindingto the LDAP server.

Before you begin

Your application must be deployed, and all of your virtual machines, must bestarted before you can change the configuration.

Before you submit an operation, put your virtual application instance inmaintenance mode until the operation is applied.

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operation tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. Depending on the credentials that you want to update, expand the following

sections:v For the credentials used to access the content store, the audit database, or the

notification mail server, or to perform administrative tasks, go to theFundamental section and expand the Update configuration section.

v For the credentials used for binding to the LDAP server, go to the Userregistry section and expand the Update user registry binding credentialssection.

7. Type the new values.

Important:

v When you update the binding credentials for the user registry, you mustspecify the name of the existing user registry in the User registry name field.This value represents the namespace name.

v When you update the administrative credentials, you must specify thenamespace ID in the Administrative namespace ID field.

8. Click Submit.9. To monitor the progress of the operation, click the Refresh icon.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > VirtualApplications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications 51

Page 58: User Guide Pattern

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating content store or audit database informationAfter you deploy an application, you can point to a new content store or auditdatabase.

Before you beginv Your application must be deployed, and all of your virtual machines must be

started before you can change the configuration.v Your content store and audit databases must already exist.

About this task

Any database JDBC driver that you upload is used to connect to both the contentstore database and the audit database. You cannot change the type of databasefrom the initial deployment.

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operation tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. In the Fundamental section, expand the Update configuration section.7. Type the new values for the Content store or audit database. For information

on creating the compressed file for the required files to connect to DB2 orOracle databases, see “Setting up access to your content store databases, auditdatabases, and data sources” on page 17.

8. Click Submit.9. To monitor the progress of the operation, click the Refresh icon.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > VirtualApplications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating drivers and configuration files to access dataAfter you deploy an application, you can update the files required to access yourdata sources, the SAP NetWeaver Business Warehouse (SAP BW) server, and theTM1 data server.

52 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 59: User Guide Pattern

Before you begin

Prepare the compressed files that contain the drivers and configuration files. Thecompressed files must include all the drivers and files required by your virtualapplication instance, even if these files have not changed.

The name of the compressed files does not have to match the name of thecompressed file that was used in the original deployment. However, some of thecompressed files must have a specific directory structure. For information aboutthe files and directory structure required, see the following topics:v Setting up access to your data sourcesv “Setting up access to SAP NetWeaver Business Warehouse servers” on page 19v “Setting up IBM Cognos Business Insight connectivity to TM1 data” on page 18

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operation tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. In the Fundamental section, expand the Update configuration section.7. Click the Edit button to select the compressed files.8. Click Submit.9. To monitor the progress of the operation, click the Refresh icon.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > VirtualApplications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating the list of valid domain names and host namesAfter you deploy an application, you can update the list of domain names or hostnames used by IBM Cognos Application Firewall (CAF) to validate requests.

Before you begin

Your application must be deployed, and all of your virtual machines must bestarted before you can change the configuration.

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications 53

Page 60: User Guide Pattern

2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operation tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. In the Fundamental section, expand the Update configuration section.7. In the Valid domains or hosts field, type domain names and host names

separated by a comma. For example: *.mycompany.com, hostname, hostname:80.8. Click Submit.9. To monitor the progress of the operation, click the Refresh icon.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > VirtualApplications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating notification mail server informationAfter you deploy an application, you can update the notification mail serverinformation.

Before you begin

Your application must be deployed, and all of your virtual machines must bestarted before you can change the configuration.

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operation tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. In the Fundamental section, expand the Update configuration section.7. Specify the new values for the notification mail server.8. Click Submit.9. To monitor the progress of the operation, click the Refresh icon.

What to do next

After the values are applied to your virtual instance, the instance restartsautomatically. To monitor the status of the instance, click Instances > Virtual

54 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 61: User Guide Pattern

Applications. From the Virtual Application Instances palette, select the instance toview detailed information about the status of the operation.

Important: If the credentials for the content store are not valid, the virtual instancecannot automatically restart.

If your virtual application instance is still in maintenance mode, click the Resumeicon to exit maintenance mode.

Updating fontsAfter you deploy an application, you can add new fonts or refresh existing fontsby uploading a compressed file that contains all the supplementary font filesassociated with your application. You do not need to upload the fonts that areincluded by default with IBM Cognos Business Intelligence version.

Before you beginv Your application must be deployed, and all of your virtual machines must be

started before you can change the configuration.v Prepare a compressed file that contains the TrueType font files. The compressed

file must include all the supplementary font files (ttf or ttc format) required byyour virtual application instance, even when these font files have not changed.

v The name of the compressed file does not have to match the name of thecompressed file that was used in the original deployment.

Procedure1. Click Instances > Virtual Application. The Virtual Application Instances palette

displays.2. Select the Business Intelligence virtual application that you want to update.3. Click the Manage icon.4. Click the Operations tab.5. From the Operations palette, select the Business Intelligence application

(CognosBICM1).6. In the Fundamental section, expand the Update configuration section.7. In the Supplementary fonts box specify the name of the compressed file that

contains all the fonts to associate with your deployment.8. Click Submit.

Chapter 6. Administer IBM Business Intelligence Pattern virtual applications 55

Page 62: User Guide Pattern

56 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 63: User Guide Pattern

Appendix A. Accessibility features

Accessibility features help users who have a physical disability, such as restrictedmobility or limited vision, to use information technology products.

For information about the commitment that IBM has to accessibility, see the IBMAccessibility Center (http://www.ibm.com/able).

Keyboard navigation

This product uses standard browser navigation keys.

The Virtual Application Builder, however is not keyboard accessible. If you need towork with virtual application patterns without using a mouse, you can use thecommand-line interface provided by your system or the REST API.

© Copyright IBM Corp. 2012, 2014 57

Page 64: User Guide Pattern

58 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 65: User Guide Pattern

Appendix B. IBM Business Intelligence Pattern virtualapplications troubleshooting

The troubleshooting information helps you understand, isolate, and resolveproblems with IBM Business Intelligence Pattern, and contains instructions forusing the problem determination resources that are provided with your products.

Troubleshoot a problemTroubleshooting is a systematic approach to solving a problem. The goal oftroubleshooting is to determine why something does not work as expected andhow to resolve the problem.

The first step in the troubleshooting process is to describe the problem completely.Problem descriptions help you and the IBM technical-support representative knowwhere to start to find the cause of the problem. This step includes asking yourselfbasic questions:v What are the symptoms of the problem?v Where does the problem occur?v When does the problem occur?v Under which conditions does the problem occur?v Can the problem be reproduced?

The answers to these questions typically lead to a good description of the problem,which can then lead to a resolution of the problem.

What are the symptoms of the problem?

When starting to describe a problem, the most obvious question is “What is theproblem?” This question might seem straightforward; however, you can break itdown into several focused questions that create a more descriptive picture of theproblem. These questions can include:v Who, or what, is reporting the problem?v What are the error codes and messages?v How does the system fail? For example, is the problem a loop, hang, crash,

performance degradation, or incorrect result?

Where does the problem occur?

Determining where the problem originates is not always easy, but it is one of themost important steps in resolving a problem. Many layers of technology can existbetween the reporting and failing components. Networks, disks, and drivers areonly a few of the components to consider when you are investigating problems.

The following questions help you to isolate the problem layer:v Is the problem specific to one platform or operating system, or is it common

across multiple platforms or operating systems?v Is the current environment and configuration supported?

© Copyright IBM Corp. 2012, 2014 59

Page 66: User Guide Pattern

If one layer reports the problem, the problem does not necessarily originate in thatlayer. Part of identifying where a problem originates is understanding theenvironment in which it exists. Take some time to completely describe the problemenvironment, including the operating system and version, all correspondingsoftware and versions, and the hardware. Confirm that you are running within anenvironment that is supported; many problems can be traced back to incompatiblelevels of software that are not intended to run together or have not been fullytested together.

When does the problem occur?

Develop a detailed timeline of events leading up to a failure, especially for casesthat are one-time occurrences. You can most easily develop a timeline by workingbackward: Start at the time an error was reported (as precisely as possible, evendown to the millisecond), and work backward through the available logs andinformation. Typically, you need to look only as far as the first suspicious eventthat you find in a diagnostic log.

To develop a detailed timeline of events, answer these questions:v Does the problem happen only at a certain time of day or night?v How often does the problem happen?v What sequence of events leads up to the time that the problem is reported?v Does the problem happen after an environment change, such as an upgrade or

an installation of software or hardware?

Under which conditions does the problem occur?

Knowing which systems and applications are running at the time that a problemoccurs is an important part of troubleshooting. These questions about yourenvironment can help you to identify the cause of the problem:v Does the problem always occur when the same task is being performed?v Does a certain sequence of events need to occur for the problem to occur?v Do any other applications fail at the same time?

Answering these types of questions can help you explain the environment inwhich the problem occurs and correlate any dependencies. Remember that justbecause multiple problems might have occurred around the same time, theproblems are not necessarily related.

Can the problem be reproduced?

Problems that you can reproduce are often easier to solve. However, problems thatyou can reproduce can have a disadvantage. If the problem has a significantbusiness impact, you do not want it to recur. If possible, re-create the problem in atest or development environment, which typically offers you more flexibility andcontrol during your investigation. Answer the following questions:v Can the problem be re-created on a test system?v Are multiple users or applications encountering the same type of problem?v Can the problem be re-created by running a single command, a set of

commands, or a particular application?

60 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 67: User Guide Pattern

Searching knowledge basesYou can often find solutions to problems by searching IBM knowledge bases. Youcan optimize your results by using available resources, support tools, and searchmethods.

About this task

You can find useful information by searching the information center for IBMCognos, but sometimes you need to look beyond the information center to resolveproblems.

Procedure

To search knowledge bases for information that you need, use one or more of thefollowing approaches:v Find the content that you need by using the IBM Support Portal

(http://www.ibm.com/support/entry/portal/).The IBM Support Portal is a unified, centralized view of all technical supporttools and information for all IBM systems, software, and services. The IBMSupport Portal lets you access the IBM electronic support portfolio from oneplace. You can tailor the pages to focus on the information and resources thatyou need for problem prevention and faster problem resolution. Familiarizeyourself with the IBM Support Portal by viewing the demo videos(https://www.ibm.com/blogs/SPNA/entry/the_ibm_support_portal_videos)about this tool. These videos introduce you to the IBM Support Portal, exploretroubleshooting and other resources, and demonstrate how you can tailor thepage by moving, adding, and deleting portlets.

v Search for content about IBM Cognos by using one of the following additionaltechnical resources:– IBM Cognos BI APARs (problem reports) (http://www.ibm.com/search/

csass/search?q=&ibm-go-btn.x=0&ibm-go-btn.y=0&ibm-go-btn=Go&sn=spe&filter=language:en+collection:dblue+ibmcontenttypeid:CT748&prod=U487531B48832U38::#q%253d%2526filter%253d%252btsswrelease%253a841%2520%252bibmcontenttypeid%253aCT748%2520%252blanguage%253aen%2520%252bcollection%253adblue%2526prod%253dU487531B48832U38%2526sn%253dspe%2526sortby%253d-moddate%2526o%253d0)

– Searching technotes (https://www.ibm.com/support/docview.wss?uid=swg21373237).

– IBM Cognos forums and communities (http://www.ibm.com/support/entry/portal/Forums_communities/Software/Information_Management/Cognos_Business_Intelligence_and_Financial_Performance_Management).

v Search for content by using the IBM masthead search. You can use the IBMmasthead search by typing your search string into the Search field on anyibm.com® page.

v Search for content by using any external search engine, such as Google, Yahoo,or Bing. If you use an external search engine, your results are more likely toinclude information that is outside the ibm.com domain. Sometimes you canfind useful problem-solving information about IBM products in newsgroups,forums, and blogs that are not on ibm.com.

Tip: Include “IBM” and the name of the product in your search if you arelooking for information about an IBM product.

Appendix B. Troubleshooting 61

Page 68: User Guide Pattern

Getting fixesA product fix might be available to resolve your problem.

Procedure

To find and install fixes:1. Go to Fix Central (http://www.ibm.com/support/fixcentral/) to determine

which fix you need.2. Download the fix. Open the download document and follow the link in the

“Download package” section.3. Apply the fix by following the instructions in the “Installation Instructions”

section of the download document.4. Subscribe to receive weekly email notifications about fixes and other IBM

Support information.

Contacting IBM SupportIBM Support provides access to a variety of IBM resources for help with softwarequestions.

Before you begin

After trying to find your answer or solution by using other self-help options suchas technotes, you can contact IBM Support. Before contacting IBM Support, yourcompany must have an active IBM maintenance contract, and you must beauthorized to submit problems to IBM. You should also have the followinginformation at hand:v Your customer identification numberv Your service request number, if it is an ongoing service requestv The phone number where you can be reachedv The version of the software you usev The version of the operating environment you usev A description of what you were doing when the problem occurredv The exact wording of any error messages that displayv Any steps you took to attempt to solve the problem

For information about the types of available support, see the Support portfoliotopic in the Software Support Handbook.

Procedure

Complete the following steps to contact IBM Support with a problem:1. Define the problem, gather background information, and determine the severity

of the problem. For more information, see the Getting IBM support(http://www14.software.ibm.com/webapp/set2/sas/f/handbook/getsupport.html) topic in the Software Support Handbook.

2. Gather diagnostic information.3. Submit the problem to IBM Support in one of the following ways:

v By using IBM Support Assistant (ISA): Use this feature to open, update, andview an Electronic Service Request with IBM. Any data that has beencollected can be attached to the service request. This expedites the analysisand reduces the time to resolution.

62 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 69: User Guide Pattern

v Online through the IBM Support Portal (http://www.ibm.com/software/support/). You can open, update, and view all your Service Requests fromthe Service Request portlet on the Service Request page.

v By phone: For the phone number to call, see the Directory of worldwidecontacts (http://www.ibm.com/planetwide/) web page.

Results

If the problem that you submit is for a software defect or for missing or inaccuratedocumentation, IBM Support creates an Authorized Program Analysis Report(APAR). The APAR describes the problem in detail. Whenever possible, IBMSupport provides a workaround that you can implement until the APAR isresolved and a fix is delivered. IBM publishes resolved APARs on the IBM Supportwebsite daily, so that other users who experience the same problem can benefitfrom the same resolution.

Exchanging information with IBMTo diagnose or identify a problem, you might need to provide IBM Support withdata and information from your system.

In other cases, IBM Support might provide you with tools or utilities to use forproblem determination.

Sending information to IBM SupportTo reduce the time that it takes to resolve your problem, you can send trace anddiagnostic information to IBM Support.

Procedure1. Open a problem management record (PMR). You can use the IBM Support

Assistant (http://www.ibm.com/software/support/isa) or the IBM ServiceRequest tool (http://www.ibm.com/support/servicerequest).

2. Collect the diagnostic data that you need. Diagnostic data helps reduce thetime that it takes to resolve your PMR. You can collect the diagnostic datamanually or automatically.

3. Compress the files by using the TRSMAIN or AMATERSE program. Downloadthe free utility from the IBM to the IBM Cognos BI system and then install theutility using the TSO RECEIVE command.

4. Transfer the files to IBM. You can use one of the following methods to transferthe files to IBM:v The Service Request tool (http://www.ibm.com/support/servicerequest)v Standard data upload methods: FTP, HTTPv Secure data upload methods: FTPS, SFTP, HTTPSv EmailIf you are using an IBM Cognos product and you use ServiceLink / IBMLinkto submit PMRs, you can send diagnostic data to IBM Support in an email orby using FTP.All of these data exchange methods are explained on the IBM Support site(http://www.ibm.com/software/support/exchangeinfo.html).

Receiving information from IBM SupportOccasionally an IBM technical-support representative might ask you to downloaddiagnostic tools or other files. You can use FTP to download these files.

Appendix B. Troubleshooting 63

Page 70: User Guide Pattern

Before you begin

Ensure that your IBM technical-support representative provided you with thepreferred server to use for downloading the files and the exact directory and filenames to access.

Procedure

To download files from IBM Support:1. Use FTP to connect to the site that your IBM technical-support representative

provided and log in as anonymous. Use your email address as the password.2. Change to the appropriate directory:

a. Change to the /fromibm directory.cd fromibm

b. Change to the directory that your IBM technical-support representativeprovided.cd nameofdirectory

3. Enable binary mode for your session.binary

4. Use the get command to download the file that your IBM technical-supportrepresentative specified.get filename.extension

5. End your FTP session.quit

Subscribing to Support updatesTo stay informed of important information about the IBM products that you use,you can subscribe to updates.

About this task

By subscribing to receive updates, you can receive important technical informationand updates for specific Support tools and resources. You can subscribe to updatesby using one of two approaches:

RSS feeds and social media subscriptionsThe following RSS feeds and social media subscriptions are available forIBM Cognos BI:v RSS feed for a developerWorks® forum (http://www.ibm.com/

developerworks/forums/forum.jspa?forumID=1573).v Subscription to Cognos Support notebook blog (https://www.ibm.com/

developerworks/mydeveloperworks/blogs/roller-ui/rendering/feed/cognossupport/entries/atom?lang=en).

v RSS feed for the Support site for IBM Cognos Business Intelligence(http://www-947.ibm.com/systems/support/myfeed/xmlfeeder.wss?feeder.requid=feeder.create_public_feed&feeder.feedtype=RSS&feeder.maxfeed=25&OC=SS9RTN&feeder.subdefkey=swgimgmt&feeder.channel.title=Cognos%208%20Business%20Intelligence&feeder.channel.descr=The%20latest%20updates%20about%20Cognos%208%20Business%20Intelligence).

64 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 71: User Guide Pattern

For general information about RSS, including steps for getting started anda list of RSS-enabled IBM web pages, visit the IBM Software Support RSSfeeds (http://www.ibm.com/software/support/rss/) site.

My NotificationsWith My Notifications, you can subscribe to Support updates for any IBMproduct. You can specify that you want to receive daily or weekly emailannouncements. You can specify what type of information you want toreceive, such as publications, hints and tips, product flashes (also known asalerts), downloads, and drivers. My Notifications enables you to customizeand categorize the products that you want to be informed about and thedelivery methods that best suit your needs.

Procedure

To subscribe to Support updates:1. Subscribe to the Product RSS feeds.2. To subscribe to My Notifications, begin by going to the IBM Support Portal

(http://www.ibm.com/software/support/) and clicking My Notifications inthe Notifications portlet.

3. If you have already registered for My support, sign in and skip to the nextstep. If you have not registered, click Register now. Complete the registrationform using your email address as your IBM ID and click Submit.

4. Click Edit profile.5. Click Add products and choose a product category; for example, Software.6. In the second list, select a product segment; for example, Data & Information

Management.7. In the third list, select a product subsegment, for example, Databases.8. Select the products that you want to receive updates for.9. Click Add products.

10. After selecting all products that are of interest to you, click Subscribe to emailon the Edit profile tab.

11. Select Please send these documents by weekly email.12. Update your email address as needed.13. In the Documents list, select the product category; for example, Software.14. Select the types of documents that you want to receive information for.15. Click Update.

Results

Until you modify your RSS feeds and My Notifications preferences, you receivenotifications of updates that you have requested. You can modify your preferenceswhen needed (for example, if you stop using one product and begin using anotherproduct).

Accessing the log files for error diagnosisLog files can help you troubleshoot problems by recording the activities that takeplace when you work with a product.

Operations that are performed in IBM Business Intelligence Pattern are recorded invarious log files for tracking purposes. For information about accessing andviewing the logs, see the documentation for your system. Logs are organized by

Appendix B. Troubleshooting 65

Page 72: User Guide Pattern

virtual machine name. They are grouped under categories such asDeploymentInlet, OS, IWD Agent, and also under the role of the virtual machine.

If your BI Pattern application includes a scaling policy, log files for virtualmachines are compressed and archived when a dispatcher scales in. Thecompressed log files are found in a timestamped archive in the /data/scaledin_logsfolder of the virtual machine where the CognosBINFSServer role exists. You canaccess these archives by using the system's log viewer or by secure FTP to thevirtual machine where the CognosBINFSServer role exists.

To help with runtime error diagnosis, you can assess the cogserver.log file of avirtual application. In Business Intelligence Pattern 2.0, the cogserver.log file canstore up to 400 MB of data. The default size of a log file is 20 MB, with anadditional file that is kept as an archive with a .1 suffix. For example, when thecurrent log file reaches the 20 MB limit, another file is created calledcogserver.log.1, when that file reaches the 20 MB limit a file calledcogserver.log.2 is created, and so on, up to a maximum of 20 files. When thecogserver.log.20 file reaches the 20 MB limit, the data is rewritten to thecogserver.log file.

The following Business Intelligence virtual applications have their owncogserver.log file.v CognosBIASAutoScale

v CognosBIAS

v CognosBICM2

v CognosBICM1

For information about the Business Intelligence log files, review the IBM CognosBusiness Intelligence Troubleshooting Guide.

Procedure1. Click Instances > Virtual Application.

2. Select the Business Intelligence virtual application whose cogserver.log fileyou want to use for diagnosis.

3. Click the Manage icon.4. Click the Logging tab.5. Expand the Business Intelligence virtual machine that has the error that you

want to diagnose.6. Expand the IBMCognos<virtual_machine_role> > c10_64/logs folders.

Where <virtual_machine_role> is the role of the Business Intelligence virtualmachine.For example,v IBMCognosBIASv IBMCognosBICM1

Cognos user cannot log in to the NFS serverIn some cases, you can no longer use the cognos account to log in to the NFSserver. This happens when the public key of the cognos user account was removedor the public key does not match the private key associated with the virtualapplication.

66 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 73: User Guide Pattern

To fix this problem, you can manually update the public key in theauthorized_keys file for the cognos user account. When you update the keymanually, it does not affect the availability of your BI application.

To manually update the public key file for the cognos user account, perform thefollowing steps:1. On the NFS server, log in as virtuser.

For example, you might run a command similar to the following command:ssh -i id_rsa virtuser@machine_ip

wherev id_rsa represents a file in the current directory with the public key filev machine_ip represents the IP address of the NFS server

2. Gain root access by running the following command: sudo su -.3. Copy the authorized_keys file from the /home/virtuser/.ssh/ directory to the

/home/cognos/.ssh/ directory.4. Verify that the file ownership of the public key is the cognos user. If not,

change the file ownership so that it is owned by the cognos user.

Deployment fails when starting IBM Business Intelligence PatternIf your deployment fails and no error message is displayed, review the logs for thefollowing error:Unable to print or tune the deployment.Check the Administrative Namespace ID or credentials.

Procedure1. Click Instances and then click Virtual Applications.2. Select the Business Intelligence virtual application that contains the trace.log file

you want to review.3. Click Manage.4. Click the Logging tab.5. Expand the Business Intelligence CM1 virtual machine.6. Expand the IWD Agent .../logs/CM1 server name folders.7. Click the trace.log file. This will populate the log contents in the viewing pane.8. At the top of the viewing pane, search for error: CM-REQ-4342. This will help

confirm the cause of the issue.

ResultsERROR Unable to print or tune the deployment.

Check the Administrative Namespace ID or credentials:

CM-REQ-4342 An error occurred with the client.

This issue may occur when a User Registry Component has been populated on theVirtual Application Builder canvas, but the Administrative namespace ID,Administrative username and Administrative password have not been accuratelypopulated on the Business Intelligence Analytics component.

This message is written to the IBM BI Pattern (IWD Agent) trace.log associatedwith the Cognos CM1 server.

Appendix B. Troubleshooting 67

Page 74: User Guide Pattern

To resolve the problem, accurately enter the Administrative namespace ID asdefined in the User Registry Component into the Administrative credentialssection of the Business Intelligence component. By entering the Administrativenamespace ID along with an Administrative username and password, the requiredauthentication references can be made.

For more information, see step 6 of the Planning the deployment of BusinessIntelligence solutions in cloud environments checklist and the AdministrativeCredentials section of IBM Cognos Business Intelligence component.

68 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 75: User Guide Pattern

Appendix C. Installation and configuration worksheet

Use the worksheet to record the system information required during theinstallation and configuration of IBM Business Intelligence Pattern.

Information for the IBM PureApplications System

Table 2. Information for the IBM PureApplication System

System information Your value

The host name or the IP address of thetarget system.

Sample value: 9.24.207.202

The userid and password of a user that caninstall the BI Pattern type on the targetsystem.

Database information for the content store

Table 3. Database information for the content store

Content store information Your value

Content store database name

Sample value: Salesdb

Content store database server and portnumber

Sample value: dbservername:50000

Content store database user name andpassword

For Oracle and IBM DB2, fully qualifiedname of the compressed file with the JDBCdriver to connect to the content store.

Sample value: c:\drivers\db2cs.zip

Audit database information

Table 4. Audit database information

Audit database information Your value

Audit database name

Sample value: Auditdb

Audit database server and port number

Sample value: dbservername:50000

Audit database user name and password

© Copyright IBM Corp. 2012, 2014 69

Page 76: User Guide Pattern

Configuration information for data sources

Table 5. Configuration information for data sources

Data source connectivity information Your value

Name of the compressed file with the datasources JDBC drivers. For information aboutsetting up access to your data sources, see“Setting up access to your content storedatabases, audit databases, and datasources” on page 17.

Sample value: c:\drivers\ds.zip

Name of the compressed file with the 32-bitand 64-bit library files required for SAPNetWeaver Business Warehouse (SAP BW).For information about setting up access, see“Setting up access to SAP NetWeaverBusiness Warehouse servers” on page 19.

Sample value: c:\drivers\sapbw.zip

Name of the compressed file with the TM1configuration files required for IBM CognosBusiness Insight connectivity. Forinformation about setting up access, see“Setting up IBM Cognos Business Insightconnectivity to TM1 data” on page 18.

Sample value: c:\drivers\tm.zip

Configuration information for an existing authenticationnamespace

Table 6. Configuration information for an existing authentication namespace

Information Your value

Administrative namespace ID

Administrative username

Administrative password

Configuration information for tenancy

Table 7. Configuration information for environments where tenancy is determined by thehierarchy

Information Your value

Determine the value for themultitenancy.TenantPattern advancedproperty.

Sample value: ~/ancestors[2]/defaultName

70 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 77: User Guide Pattern

Table 8. Configuration information for environments where tenancy is determined by objectattributes

Information Your value

Determine the value for themultitenancy.TenantPattern advancedproperty.

Sample value: ~/parameters/dept

Set the value for theAdditionalUserPropertiesToQuery advancedproperty.

Sample value: parameters

Set the value for the dept LDAP customproperty.

Sample value: departmentNumber

Table 9. Configuration information for environments where tenancy is determined by using acustom Java class

Custom files information Your value

Set the value for themultitenancy.ITenantProvider advancedproperty to match the name of the customJava class.

Sample value: com.tenantinfo.Class

Optional: Record any other advancedproperties and values applicable to yourenvironment.

Name of the compressed file containing thecustom Java class. The directory structureinside the compressed file determines whereto copy the custom Java class.

Sample value: c:\drivers\custom.zip

Database information required in BI virtual applications

Table 10. Database information required in BI virtual application

Database information Your value

Name

Sample value: dbaas

Host

Sample value: 9.24.205.34

Port number

Sample value: 50000

Password for the appdba User (ApplicationDBA)

Sample value: owU1LdiDB62i6ehh

Appendix C. Installation and configuration worksheet 71

Page 78: User Guide Pattern

Table 10. Database information required in BI virtual application (continued)

Database information Your value

Database level

Sample value: 9.7.0.5

72 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 79: User Guide Pattern

Notices

This information was developed for products and services offered worldwide.

This material may be available from IBM in other languages. However, you may berequired to own a copy of the product or product version in that language in orderto access it.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service. This document maydescribe products, services, or features that are not included in the Program orlicense entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain 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 beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

© Copyright IBM Corp. 2012, 2014 73

Page 80: User Guide Pattern

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Software GroupAttention: Licensing3755 Riverside Dr.Ottawa, ONK1V 1B7Canada

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 materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

74 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 81: User Guide Pattern

This Software Offering does not use cookies or other technologies to collectpersonally identifiable information.

Trademarks

IBM, the IBM logo and ibm.com are trademarks or registered trademarks ofInternational 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 andtrademark information ” at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of

Microsoft Corporation in the United States, other countries, or both.v Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.v UNIX is a registered trademark of The Open Group in the United States and

other countries.v Java and all Java-based trademarks and logos are trademarks or registered

trademarks of Oracle and/or its affiliates.

Notices 75

Page 82: User Guide Pattern

76 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 83: User Guide Pattern

Index

Aaccessibility features 57administrative credentials

specifications 25application host name alias

overview 25application server resources

customization 25application server role 23application tier 23application URI

endpoint 45architecture

overview 23security 20

artifactscollection 13

audience of document vaudit databases

JDBC driversconfiguring 25updating 17

preparation 15specifications 25

Bbacking up

NFS server 50BI Pattern applications

accessing 45application server role 23architecture 23content manager roles 23creation 42deployment topology 23endpoints 45maintenance

changing audit database 52changing content store 52overview 50

middleware componentsdescription 23

NFS server role 23operations 50post-deployment tasks 45scalable application server role 23scaling policies

description 23templates 45user authentication sources 31

Business Intelligence componentapplication host name alias

description 25configuration settings

administrative credentials 25audit database 25content store 25data sources 25deployment throughput options 25

Business Intelligence component (continued)configuration settings (continued)

general 25notification mail server 25SAP data 25TM1 servers 25

overview 23

Cchecklist

installation 11post-installation 12preinstallation 11

cogserver.logerror diagnosis 66

componentsoverview 23

compressed filesstructure

configuring 17content manager 23

endpoints 45resources customization 25

content storeJDBC drivers

configuring 17updating 17

specifications 25content store database

preparation 15CPU-based scaling 30Cube Designer

connecting to BI Pattern applicationsconfiguration 48

Ddata sources

JDBC driversconfiguring 25updating 17

deployed applicationexample 23

deployingelastic load balancing (ELB) shared service 14overview 13

deployment archivesexporting 46importing 46

deployment throughputspecifications 25

domain listschanges 53specifications 25

dynamic cubescomponent 29configuration settings 29deployment throughput 29

© Copyright IBM Corp. 2012, 2014 77

Page 84: User Guide Pattern

Eendpoints

overview 45error diagnosis

cogserver.log 66

Ffeatures

changed 3, 5new 2, 4

fix packsapplying 50

fontsadding 20updating 55

Framework Managerconnecting to BI Pattern applications

configuration 48

Ggetting started 11

Hhardware prerequisites 7hotsites

applying 50HTTPOnly parameter 49

IIBM Support

contacting 62sending and receiving information 63

IBM Tivoli Directory Serveruser registry component 31

imagesrendering 46

implementationBI Pattern applications 13

installationchecklist 11

interim fixesapplying 50

LLDAP Directory Server

user registry component 31Lifecycle Manager

connecting to BI Pattern applicationsconfiguration 48

Local application URIendpoint 45

log filesscaled-in 59troubleshooting 59

logging databasepreparation 15

login pageaccessing 45

Mmaintaining

audit database drivers 17content store drivers 17data source drivers 53domain lists 53fix packs 50notification mail server 54SAP libraries updates 53TM1 configuration files 53TM1 server access 18

Microsoft Active Directoryuser registry component 31

middleware servicesoverview 23

Mobile databasepreparation 15

multitenancy 37configuring 38disabling multitenancy settings 41enabling multitenancy settings 38, 39, 40

Nnamespaces

user authentication sources 31NFS server

backing up 50content updates 41customization 25deployment archives 46images 46login errors 67overview 41PowerCubes 47SSH key-based access 41updating 41

notification mail serverchanges 54specifications 25

Ppatterns in IBM Cognos BI 1planning

overview 13post-installation

checklist 12PowerCube support 21PowerCubes

copying 47preinstallation

checklist 11preparing to install 7prerequisites 7problem determination

exchanging information with IBM Support 63production environments

steps 49

QQFS-ERR-0141 21

78 IBM Business Intelligence Pattern Version 2.2.0: User Guide

Page 85: User Guide Pattern

Rrelease notes

reviewing before you install 7Report server-based scaling 30reviewing the release notes before you install 7roles

overview 23RSS feeds

troubleshooting 64

SSAP NetWeaver Business Warehouse (SAP BW) servers

access 19scaling policies

CPU-based 30overview 23, 30Report server-based 30specifications 30static 30

security 20HTTPOnly parameter 49network configuration changes 20requirements 20

software prerequisites 7software updates 50SSL enablement

description 25static scaling 30steps

planning 13subscribing

troubleshooting templates 64supplementary fonts

adding 20

Ttemplates

overview 42TM1 servers

configuring 18

TM1 servers (continued)IBM Cognos Business Insight access 18

troubleshooting 59contacting IBM Support 62exchanging information with IBM Support 63fixes

getting 62getting fixes 62identifying problems 59knowledge bases

searching for troubleshooting solutions 61log files 59NFS server 67scaled-in log files 59searching knowledge bases 61subscribing to support 64virtual machines 59

Uupdating

binding credentials to LDAP server 51fonts 55passwords 51user names 51

URI for external applicationsendpoint 45

URL linksdeployed applications 45

user authentication sourcesuser registry components 31

user registriesoverview 23

user registry componentsauthentication sources 31specifications 31

Wworksheet 69

Index 79