01i.installing & Configuring IBM Cognos Controller 10.1.1 Server - Proven Practice

Proven Practice
Installing & Configuring IBM

Cognos Controller 10.1.1 server
Product(s): IBM Cognos Controller
Area of Interest: Infrastructure
Installing & Configuring IBM Cognos Controller 10.1.1 server
Copyright and Trademarks

Licensed Materials - Property of IBM.
Copyright IBM Corp. 2009
IBM, the IBM logo, and Cognos are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies. A
current list of IBM trademarks is available on the Web at
http://www.ibm.com/legal/copytrade.shtml
While every attempt has been made to ensure that the information in this document
is accurate and complete, some typographical errors or technical inaccuracies may
exist. IBM does not accept responsibility for any kind of loss resulting from the use of
information contained in this document. The information contained in this document
is subject to change without notice.
This document is maintained by the Best Practices, Product and Technology team.
You can send comments, suggestions, and additions to cscogpp@ca.ibm.com.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States, and/or other countries.
IT Infrastructure Library is a registered trademark of the Central Computer and Telecommunications Agency which is
now part of the Office of Government Commerce.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep,
Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United
States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United
States, other countries, or both.
ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is
registered in the U.S. Patent and Trademark Office.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United States, other countries, or
both and is used under license therefrom.
Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other
countries, or both.
Suitable for PUBLIC (external)

use
Contents
INTRODUCTION........................................................................................................ 6
1.1
1.2
1.3
PURPOSE ............................................................................................................ 6
APPLICABILITY ..................................................................................................... 6
EXCLUSIONS AND EXCEPTIONS .................................................................................. 6
IMPORTANT NOTES, TIPS AND WARNINGS ................................................. 8
2.1
DO NOT IGNORE/SKIP ANY SECTIONS OF THIS DOCUMENT, UNLESS YOU UNDERSTAND THE
CONSEQUENCES! ............................................................................................................... 8
2.2
SERVER NAME CONVENTIONS FQDN AND NETBIOS ...................................................... 9
INITIAL SERVER PREREQUISITES .............................................................. 10
3.1
3.2
3.3
3.4
3.5
3.6
SERVER HARDWARE RECOMMENDATIONS .................................................................... 10

VMWARE / ESX (AND OTHER VIRTUAL PLATFORMS) ...................................................... 10
32BIT / 64 BIT................................................................................................... 10
OPERATING SYSTEM ............................................................................................. 11
WINDOWS SERVICE PACK ...................................................................................... 11
REQUIRED WINDOWS COMPONENTS MICROSOFT IIS WEBSERVER & ENABLE NETWORK COM+
ACCESS 12
3.7
OTHER MICROSOFT SOFTWARE ............................................................................... 14
16
3.8
DATABASE CLIENT SOFTWARE ................................................................................. 17
3.9
OTHER (NON-IBM/COGNOS) SOFTWARE .................................................................... 19
3.10
OTHER MISCELLANEOUS WINDOWS SETTINGS .............................................................. 20
3.11
WINDOWS 2008 UAC .......................................................................................... 21
3.12
ENABLE THE WINDOWS 2008 POLICY 'DO NOT FORCEFULLY UNLOAD THE USER REGISTRY AT USER
LOGOFF'. 21
3.13
ADD THE STATHREADPOOL REGISTRY KEY TO MODIFY COM+ BEHAVIOUR ........................ 21
3.14
BEST PRACTICES BEFORE PROCEEDING ....................................................................... 22
4
RECOMMENDED SERVER SYSTEM SETTINGS ............................................. 23
4.1
4.2
4.3
4.4
4.5
4.6
4.7
4.8
CREATE A CONTROLLER SYSTEM WINDOWS DOMAIN USER ............................................... 23

REGISTER ASP.NET 2.0 (SP2) .............................................................................. 23
ALLOW COGNOS CGI/ISAPI EXTENSIONS .................................................................. 25
OPTIMISE IIS WEBSITE APPLICATION POOL SETTINGS ................................................... 28
OPTIMISE IIS WEBSITE MAXALLOWEDCONTENTLENGTH SETTING...................................... 29
DISABLE INTERNET EXPLORER ENHANCED SECURITY CONFIGURATION ................................. 30
DISABLE INTERNET EXPLORERS PUBLISHER CERTIFICATE REVOCATION CHECKING ................... 30
ADD SERVERS TO TRUSTED SITES ZONE IN IE .............................................................. 31
DATABASE PREPARATION .......................................................................... 32
5.1
DEFAULT COLLATION SETTING FOR SQL SERVER .......................................................... 32
5.2
UPGRADE SQL TO LATEST SERVICE PACK ................................................................... 34
5.3
POST-INSTALL SQL SERVER OPTIMISATIONS ............................................................... 34
5.4
CONTROLLER SQL LOGIN USER AND DATABASE CREATION ................................................ 35
5.5
CREATE AN OPTIMISE2 (A.K.A. ADVANCED EXCEL LINK OR E.R.O. ENHANCED REPORTING
OPTIMISATION) SHARE ..................................................................................................... 37
5.6
RESTORE OTHER DATABASES (IF NECESSARY) ............................................................... 37
5.7
CREATE DATABASE MAINTENANCE PLANS ................................................................... 37
6
INSTALLATION OF CONTROLLER SERVER .................................................. 38
6.1
6.2
6.3
6.4
DOWNLOAD THE CONTROLLER 10.1.1 RTM SOFTWARE FROM THE IBM WEBSITE ................... 38
DOWNLOAD ANY PREFERRED/RECOMMENDED (POST 10.1 RTM) INTERIM FIX PACKS ............... 38
OBTAIN A SUITABLE JDBC DRIVER ........................................................................... 38
SERVER SOFTWARE INSTALLATION............................................................................ 39
use
6.5
INSTALL/APPLY REQUIRED INTERIM FIX ...................................................................... 40
CONFIGURATION OF CONTROLLER SERVER .............................................. 41
7.1
IBM COGNOS CONTROLLER JAVA PROXY WINDOWS SERVICE USER ACCOUNT ...................... 41
7.2
CHECK JAVA_HOME ENVIRONMENT VARIABLE FOR BI ................................................... 41
7.3
COPY REQUIRED JDBC DRIVERS ONTO SERVER ............................................................. 42
7.4
OPTIONAL - CONFIGURE CCR-DBTYPES.PROPERTIES FILE ............................................... 42
7.5
FOR ORACLE ONLY - CONFIGURE CCR-SYSTEM-PROPERTIES.PROPERTIES FILE ....................... 43
7.6
CONFIGURE JRE ENVIRONMENT SYSTEM VARIABLE FOR JAVA-RELATED FUNCTIONALITY (AFC/FAP
ETC.)
43
7.7
CONFIGURE CCR_INTEGRATION_SERVER_DEPLOY_HOME SYSTEM ENVIRONMENT VARIABLE43
7.8
COGNOS BI REPORT SERVER CONFIGURATION ............................................................. 44
7.9
TEST THE COGNOS BI RUNTIME REPORTING SERVER .................................................... 48
7.10
IMPORT THE CONTROLLER STANDARD REPORTS FRAMEWORK MANAGER MODEL VIA COGNOS
CONNECTION................................................................................................................. 48
7.11
CONTROLLER SERVER IIS/WEB CONFIGURATION ........................................................... 49
7.12
ENABLE BATCH SERVICE(S) .................................................................................... 56
7.13
ENABLE OPTIMISE2 ............................................................................................. 56
7.14
USE DATABASE CONVERSION UTILITY TO POPULATE DATABASES ..................................... 57
8
INSTALL AND CONFIGURE FINANCIAL ANALYTICS PUBLISH (FAP) .......... 59
8.1
8.2
8.3
8.4
8.5
8.6
8.7
8.8
8.9
8.10
8.11
8.12
8.13
8.14
8.15
8.16
OVERVIEW ........................................................................................................ 59
FURTHER PREPARATION INFORMATION / READING ......................................................... 59
COMPONENT INSTALLATION LOCATIONS - INITIAL ASSUMPTIONS ....................................... 60
CREATING A FINANCIAL ANALYTICS PUBLISHER DATABASE ............................................... 60
CREATING TABLES INSIDE FAP DATABASE ................................................................... 61
ENABLE AUDIT TRAIL TRIGGERS FOR FAP INSIDE CONTROLLER ...................................... 62
INSTALL THE DATABASE CLIENT SOFTWARE ON THE TM1 SERVER ....................................... 62
CREATING AN ODBC DATA SOURCE FOR TM1 ............................................................. 62
INSTALLING IBM COGNOS TM1 10.1.0 SOFTWARE ....................................................... 63
CREATING A NEW TM1 SERVER DATA LOCATION .......................................................... 64
INSTALLING A TM1 SERVER AS A WINDOWS SERVICE..................................................... 64
INSTALLING AND CONFIGURING THE FINANCIAL ANALYTICS PUBLISHER SERVICE..................... 65
INSTALLING THE 32-BIT TM1 CLIENT ....................................................................... 66
ADD A PATH FOR THE TM1 32-BIT CLIENT SYSTEM VARIABLES ......................................... 67
INSTALL THE FINANCIAL ANALYTICS PUBLISHER ............................................................ 67
CONFIGURE THE FINANCIAL ANALYTICS PUBLISHER TO PUBLISH DATA ................................. 68
POST-INSTALL OPTIMISATIONS ................................................................ 69
9.1
9.2
9.3
9.4
RECOMMENDED: PROACTIVE SERVER REBOOTS ............................................................ 69

RECOMMENDED: SPLIT THE COM+ APPLICATION .......................................................... 69
OPTIONAL: ENABLE EMAIL FUNCTIONALITY ................................................................. 70
OPTIONAL: CHANGE CONTROLLER STANDARD REPORTS TO USE ISAPI NOT CGI TECHNOLOGY .. 71
10
CREATING A SOFTWARE REPOSITORY SHARE ......................................... 74
10.1
OVERVIEW ........................................................................................................ 74
11
TESTING ON APPLICATION SERVER ........................................................... 75
11.1
11.2
11.3
11.4
INSTALL CLIENT SOFTWARE ON THE APPLICATION SERVER ............................................... 75

LAUNCH CONTROLLER AND PERFORM BASIC TESTING ON APPLICATION SERVER ITSELF ............... 75
TROUBLESHOOTING ............................................................................................. 77
GENERAL WINDOWS (NON-COGNOS SPECIFIC) PERFORMANCE TESTING ............................... 78
12
INSTALL CLIENT SOFTWARE ON USERS PC ............................................... 79
12.1
IMPORTANT: ENSURE THAT THE CUSTOMER IS GIVEN GOOD INSTRUCTIONS ON HOW TO INSTALL THE
CONTROLLER CLIENT........................................................................................................ 79

use
13
BASIC TESTING FOR EACH CLIENT PC INSTALLATION .............................. 79
13.1
13.2
MAIN CONTROLLER PROGRAM ................................................................................. 79

EXCEL LINK ....................................................................................................... 79
14
INSTALLING ON A CITRIX (OR TERMINAL SERVICES) SERVER ................. 79
14.1
OVERVIEW ........................................................................................................ 79
15
APPENDICES FURTHER READING ............................................................ 80
15.1
POTENTIAL ADDITIONS/ENHANCEMENTS/OPTIMISATIONS................................................ 80

use
Introduction
1.1
Purpose
This document is designed to be a simple/basic guide (complete with screenshots) for how to
install a standard Controller 10.1.1 system from scratch.
This document is intended to be utilised by IBM Cognos (and partners) technical consultants,
to help perform an installation of Controller 10.1.1 server in simple / standard
environments.
It is also possible for less-experienced people (for example customers I.T. departments) to
use this document too, so long as:
It will be a simple/standard implementation of Controller
The customer accepts responsibility for any problems that may arise from the
use of this document
In other words, the customer accepts that IBMs recommendation is always to

employ an experienced IBM Cognos Technical Consultant to help them install
Controller.
Employing an experienced IBM technical consultant will ensure that the risk is
minimised of unexpected issues arising from an upgrade.
By following these best practices the intention is to make Controller installation
as easy as possible, with the minimum of possibility for errors/issues.
The author suggests that experienced technical consultants can also use this document as an
aide-memoir, i.e. a concise set of instructions for installing the software as per current best
practices, for typical situations.
1.2
Applicability
This document is based on installing Controller 10.1.1 RTM (released June
2012)
1.3
Exclusions and Exceptions

There are an infinite variety of possible customer I.T.
environments/needs/specialist requirements. Therefore, IBM has intentionally
made Controller flexible to give the customer many different ways to install
Controller 10.1.1. Therefore the advice in this document may have to be
modified by the reader to fit in with their specific needs/environment.
Although this document demonstrates proven practices suitable for most
environments, it is not necessarily perfect for all environments.
Employing an experienced IBM Cognos technical consultant to
upgrade your Controller server(s) is always the recommended &
ideal scenario.

use
This document is not intended to entirely replace the official standard

documentation (located on the install CDs) such as:
ctrl_arch.pdf Architecture and Deployment guide
ctrl_inst.pdf Installation and Configuration guide
qrc_ctrl_inst.pdf Getting Started Installation guide
Instead you can use this guide as a concise summary companion to the
official documentation. In any event of overlap, the standard documentation
takes precedence.
NOTE: This document was last updated by the author May 1st 2013.

use
2 Important Notes, Tips and WARNINGS

2.1
Do not ignore/skip any sections of this document, unless you

understand the consequences!
It is perfectly possible to upgrade Controller and get it (initially) working without

performing some of the steps that the author prescribes/recommends. However,
customer feedback has confirmed that, unless you perform all of my
recommended/extra steps, the customers Controller system will NOT work well in
the long-term.
Therefore, throughout this document, there will be hints & tips in blue boxes such
as this one:
TIP: Ignoring the tips may cause the Controller system to be slow, unreliable or have longterm issues.
In addition, there are will be VITAL information inside red boxes
WARNING: If the information in these boxes is ignored, the Controller system is likely not to work
at all correctly.
Many of the authors tips and recommendations refer to IBMs excellent

knowledgebase, which contain the IBM Technotes (previously known as KB
articles). This can be found here:
http://www-947.ibm.com/support/entry/portal/Overview/Software/Information_Management/Cognos_Controller
It is absolutely VITAL that the reader uses this knowledgebase resource, since it is
an invaluable help for almost all issues.
In addition, all public Proven Practice documents can be found here:
http://www.ibm.com/developerworks/data/library/cognos/cognosprovenpractices.html

use
2.2
Server name conventions FQDN and NetBIOS
Throughout this document, the author shall talk about configurations that refer to
the <servername> of your Controller server. There are two main conventions for
server naming:
1. NetBIOS for example MYSERVERNAME
2. FQDN for example MYSERVERNAME.uk.companyname.com
Alternatively, you may even be using something else to refer to your servers. For
example, you may want to use a virtual DNS name (for Disaster Recovery
purposes).
Whatever naming convention that you choose, you *must* use the SAME (correct)
version of your server name at *all* times, to retain consistency.
WARNING: To summarise, customers should typically use NetBIOS or FQDN names
throughout their entire configuration/deployment, but not both (a mixture).

Using a mixture of naming conventions will cause complications/problems later.

use
10
3 Initial Server Prerequisites

3.1
Server hardware recommendations
It is, of course, vital the customers deploy Controller on hardware that is sufficiently powerful
to give the end users a good experience.
Please refer to the authors companion Proven Practice document Controller 10.1
Architecture and Server Sizing for my server hardware recommendations (based on customer
success/feedback). For example (for most customers) each Controller application server should
typically have at least 4 CPU cores and 4Gb RAM assigned to it.
3.2
VMWare / ESX (and other virtual platforms)
Increasingly, customers are choosing to deploy Controller on virtual hardware. Naturally,

Controller will work on virtual platforms such as VMWare/ESX.
However, please be aware that a number of customers have experiences errors (for example
see Technote 1385378) and performance problems caused by poorly-configured/poorlyspecified virtual server systems (ESX etc.).
Therefore, do not make the mistake of
assuming (without checking) that your existing virtual host hardware has enough
resources to cope with the demand of Controller
or assuming that you can ignore the recommended hardware requirements (for example
number of separate CPU cores that should be assigned to the server) when using a virtual
server system.
TIP: The author has written many of his virtual server hints/tips/best-practices inside the
following IBM Technote: http://www-01.ibm.com/support/docview.wss?uid=swg21365257
As a general observation, the author sees fewer performance/stability problems at customers
who deploy Controller on real (physical) hardware, compared with customers who deploy
on virtual (VMWare etc.) systems.
3.3
32bit / 64 bit
Controller is a 32-bit application, but it is compatible to be run on a 64-bit Windows operating

system (see Technote 1364750). If customers choose 64-bit operating systems for Controller,
please be aware that:
It is slightly more complicated to install/troubleshoot Controller running on 64-bit
operating systems (extra steps are necessary during the installation procedure)
Sometimes advice will need to be modified for the 64-bit architecture (for example
older IBM Technotes will generally refer to 32-bit registry key locations these will
need to be modified for the WOW6432node location)
However, when using TM1, be aware that TM1 server is best deployed/installed on a
64-bit server, so please always use a 64-bit operating system for TM1 server.

use
11
This document shall include some tips for using 64-bit operating systems wherever you see
the following graphic:
TIP: For more information, see IBM Technote 1374283.
IMPORTANT:
Controller is a 32-bit product, and therefore integrates only with 32-bit libraries.
Therefore, whenever this document refers to installing components (such as
Windows 2003 Support Tools, or database client software etc.) it refers to
installing the 32-bit version only.
In other words, when using a 64-bit operating system

you must ensure that you install 32-bit versions of all
the required pre-requisite third-party software...
...such as:
Windows 2003 Support Tools 32 bit
SOAP Toolkit 32 bit
Microsoft SQL client 32 bit
Oracle client 32 bit
etc.
This document will specifically mention if it is required to install a 64-bit version instead.
3.4
Operating System
TIP: Full details of the supported software environments for all Controller versions are listed here:
http://www-01.ibm.com/support/docview.wss?rs=3450&uid=swg27014433
In particular, the supported environments for Controller 10.1.1 are here:
http://www-01.ibm.com/support/docview.wss?uid=swg27024069
Controller 10.1.1 actively supports Windows 2008 Server R2. Therefore, although other
environments are supported, this document shall mainly assume that you are using
Windows 2008 R2 (64-bit) server.
TIP: Some of the screens/procedures will look slightly different in other operating systems.
Where possible, specific details for Windows 2003 are stated next to the Windows 2003 logo.
For more examples/details, see the Appendix section (for example section 15.2) at the end of this
document.
3.5
Windows Service Pack
As a general best practice, ensure that your operating system is patched to the latest
Microsoft Windows service pack, for example (at the time of writing):
Windows 2008 original release: SP2
Windows 2008 R2: SP1.

use
3.6
12
Required Windows Components Microsoft IIS webserver & Enable

network COM+ access
By default, several required Windows components are not installed/enabled (such as IIS and Enable
network COM+ access which is required to load balance the Controller COM+ application across
remote server(s)). Therefore:
Click Start Settings Control Panel
Click Programs and Features Turn Windows features on or off
TIP: Alternatively, simply right-click on My Computer and choose Manage
Select Roles and click Add Roles
If prompted, click Next
Tick Application Server
Click Add Required Features
Tick Web Server (IIS)
Click Next, Next
Tick 'Web Server (IIS) Support' and click 'Add Required Role Services'
Tick 'COM+ Network Access' and click Next'
Click 'Next', then tick the box CGI

use
Click Next
Click 'Install' and then finally 'Close'
13
Launch http://servername and ensure that the default website appears successfully before
proceeding to the next stage.
On Windows 2003: The following
o
Launch Control Panel - Add/Remove Programs Windows Components
Highlight Application Server and click Details
Tick the sections:
Application Server Console
Enable network COM+ access
Internet Information Services (IIS)
TIP: If you want more detail about which IIS services to enable, the following describes the default IIS options, which are
known to work fine:
o
Common Files ticked
Internet Information Services Manager ticked
World Wide Web Service ticked (grey)
<All others> - unticked
Drilling down further with details, this just has World Wide Web Service ticked
Launch http://servername and ensure that the default website appears successfully before proceeding to the next
stage.

use
3.7
14
Other Microsoft Software
Install each the following Microsoft software/components on your application server:

MS Internet Explorer 9
TIP: You can use IE6 / IE7 or IE8 if you prefer, but these versions are only supported
as compatible, not active.
MS Excel 2003, 2007 or 2010
TIP:
It is not strictly 100% necessary to install MS Office on your application server. However, the
author recommends that you install Microsoft Excel on the application server (either Excel
2003, 2007 or 2010), because it makes testing immediately after the installation (plus
throughout the future lifetime of the Controller system) very easy
Although Office XP (2002) is officially supported as compatible, there are known Microsoft
issues with this version, so the author does not recommend using this version
Although Office 2000 is no longer supported, it is useful to install this version instead if your
customer is migrating from Controller 2.x to 8.5. Installing Office 2000 will allow forms and
reports to be migrated from Controller 2.x. See IBM Technotes such as 1347630, 1347477
and 1371088 for more details.
IMPORTANT: After installing MS Office, you *must* install the latest Microsoft Office service
pack (for example SP3, SP2 and SP1 respectively for Excel 2003, 2007 and 2010) afterwards.
These service packs solve a LARGE number of known problems.
This is *especially* vital for Excel 2007. For more details, see IBM Technote 1394945.
Windows 2003 Support Tools
Since version 10.1.1 it is no longer necessary to install this.
SOAP Toolkit 3.0
Launch the file soapsdk.exe and perform a default install.

TIP: This is currently downloadable from here:

use
15
Microsoft Visual C++ 2005 Redistributable Package (x86)
Launch the file vcredist_x86.exe and perform a default install.

TIP: This helps to run the IBM Controller Java Proxy server service. This file is currently
downloadable from here:
http://www.microsoft.com/downloads/details.aspx?familyid=32bc1bee-a3f9-4c13-9c99220b62a191ee&displaylang=en
.NET 2.0 Framework SP2

By default, .NET 2.0 is already installed on Windows 2008. However, to ensure that it is
patched to the latest version (.NET 2.0 SP2) the author recommends that you install .NET
3.5 SP1 [this will install .NET 2.0 SP2 too].
TIP:
.NET 3.5 SP1 is the file dotnetfx35setup.exe

At the time of writing, it was available here:
http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-831981da479ab0d7&DisplayLang=en
For Windows 2003 x86, .NET 2.0 SP2 is the file NetFx20SP2_x86.exe (approx 24Mb)
It is known as Microsoft .NET Framework 2.0 Service Pack 2 (x86)
At the time that this document was written, it was currently downloadable from here:
http://www.microsoft.com/downloads/details.aspx?FamilyID=5b2c0358-915b-4eb5-9b1d10e506da9d0f&displaylang=en
WARNING: It is vital that you do not install the original .NET 2.0 RTM release.
For more information, see IBM Technote #1371440.
Instead, you must install NET 2.0 SP1 or later (SP2 recommended by author) since it contains a huge
number of Microsoft bug-fixes, plus can increase the performance of Controller considerably.

use
16
Windows 2003 x64:

Download and install the x64 version, which is called NetFx20SP2_x64.exe.
TIP: This will install two versions of .NET Framework: 32bit and 64bit. Controller is a 32bit application,
therefore IIS needs to know which mode (32 or 64) and subsequently, which set of libraries (32 or 64) to use.
=> To inform IIS to use the 32-bit version of ASP.NET 2.0, you need follow these steps:
Click Start, click Run, type cmd, and then click OK.
Type the following command to enable the 32-bit mode:

cscript %SYSTEMDRIVE%\inetpub\adminscripts\adsutil.vbs SET
W3SVC/AppPools/Enable32bitAppOnWin64 1
Windows 2008 x64:

Perform the following steps:
1.
Right-click on "Computer" and choose "manage"
2.
Expand "Roles - Web Server (IIS) - Internet Information Services"
3.
Open section <Servername> - "Application Pools"
4.
Right-click on the relevant application pool (for example "DefaultAppPool") and choose "Advanced
Settings"
5.
Near the top, change the value for "Enable 32-Bit Applications" from the default ("false") to "True"
6.
Click OK
7.
Reboot the server

use
3.8
17
Database client software

IMPORTANT REMINDER: Controller is a 32-bit product, and therefore integrates only with
32-bit libraries.
In other words, when using a 64-bit operating system you must ensure that
you install 32-bit versions of all the required pre-requisite third-party
software such as database clients etc.
Depending on which database platform you are using (SQL, Oracle or DB2), you will need to
install some/all of the following:
SQL Client components
TIP: Several features (for example the Publish to CognosBI Data Mart and FAP
functionality) in Controller rely on 3rd-party components (for example Microsoft DLLs) to be
present on the application server (see IBM Technote 1371096 for more details).
If using SQL 2005 as your database server:

o
Insert SQL 2005 cd-rom and launch the autorun menu
Choose 'Install - Server components, tools, Books Online, and samples'
Accept all the default values during the wizard, *until* you reach the screen 'Components to Install'
Tick the box 'Workstation components, Books Online and development tools', but leave all other
boxes unticked
Click 'Next', and then continue choosing all the default options
After the product has finished installing, download latest service pack (e.g. SP4 = '
SQLServer2005SP4-KB2463332-x86-ENU.exe) from Microsoft
Double-click to upgrade the client tools to SP4, then reboot application server
If using SQL 2008 as your database server:

o
Insert SQL 2008 (32-bit = x86) cd-rom and launch the autorun menu
This will automatically download.NET 3.5 SP1 from the internet and install it
Afterwards, choose 'Installation New SQL Server stand-alone installation
In the Feature Selection screen, as a minimum tick the following:

o
Client Tools Connectivity
Client Tools Backwards Compatibility
Client Tools SDK
Management Tools Complete
Accept all the default values during the wizard
After the product has finished installing, download latest service pack (for example SP2 for 32-bit =
SQLServer2008SP2-KB2285068-x86-ENU.exe) from Microsoft
Double-click to upgrade the client tools to SP2, then reboot application server
If you are not going to publish Controller data to Data Marts (see blue box above) then you can skip the
next step:
o
If you do have the SQL 2005 cd-rom media, then simply perform the same steps (see above) to
install the SQL 2005 'Workstation components, Books Online and development tools', and (as a
best practice) patch to SQL 2005 SP4.
If you do not have the SQL 2005 cd-rom installation media, then download and install the
components (e.g. Microsoft SQL Server 2005 Backward Compatibility Components =
SQLServer2005_BC.msi
see IBM Technote 1472432 for more details).

use
18
Oracle 11g (or 10g) client components
WARNING
Do not ignore ANY of the advice that I give in this section, otherwise you WILL get problems with Controller!
There are several pieces of advice that are the same whether you use Oracle 10g or 11g:
During the Oracle client installation wizard, you must choose a FULL (Administrator)
installation.
o Do not try to cut down the Oracle client installation by choosing to install
fewer Oracle client components.
Make sure that you install the release 2 versions of the Oracle client.
o For example, install Oracle 10G rel2 or Oracle 11G rel2 client.
NOTE: To repeat an earlier comment, if using a 64-bit operating system for your application
server, you must install use the 32-bit version of the Oracle client onto the application server.
Oracle 10G
It is *absolutely vital* that you install the full Oracle 10G rel2 client correctly on the
application server, and also patch the Oracle client afterwards. For example, see IBM
Technote 1347434.
For full details of how to do this correctly see the ProvenPractice document Step-by-Step
guide to installing Oracle 10G Client on a Controller 8.3 Application server.
Oracle 11G
It is *absolutely vital* that you install that you either:
(a) Install the full Oracle 11G rel2 11.2.0.1 client on the application server and also patch the
Oracle client afterwards with Oracle patch #10100100 (also known as "11.2.0.1.0 Patch 6
(11.2.0.1.6P) 32-bit").
For full details of how to do this correctly see IBM Technote 1448885.
or (b) install the full Oracle 11G rel2 11.2.0.3 client on the application server.
This is also known as p10404530_112030_WINNT_3of6.zip.
DB2 (9.7) client components
TIP: Controller 10.1 has been officially tested using DB2 9.7 FP1. However, at the time of
writing, the latest FixPack version is 9.7 FP6.
Insert the DB2 9.7 32-bit installation CD-ROM/media
Launch setup.exe
Inside the "DB2 Setup Launchpad", choose "Install a Product"
Underneath "IBM Data Server Client Version 9.7" choose "Install New"
Inside the "Select the installation type" choose "Custom"
Accept all the defaults *except* inside the "Enable operating system security for
DB2 objects" untick the option "Enable operating system security" (see Technote
1504470 for why)
Finish the wizard

use
3.9
19
Other (non-IBM/Cognos) software
Install Adobe Reader X (e.g. AdbeRdr1013_en_US.exe) on your server.
WARNING: Afterwards, you *must* launch Acrobat Reader and accept the license agreement,
otherwise you may have unexpected issues later!

use
20
3.10 Other Miscellaneous Windows settings
Ensure that all servers (e.g. SQL, Application#1, APP#2, Citrix #1, Citrix#2) are members
of the same domain
o
Windows 2003 SP1 and later (plus Windows XP SPx+) introduces a new setting "Data
Execution Prevention" (DEP)
o
If they are not in the same Windows domain, then this will cause problems when
using advanced functionality (for example MSAS Data Mart publishes, and also
using Optimise2/ERO
To avoid potential problems, please change this to "essential programs and

services only":
In the unlikely event that your servers CPUs support the older (circa 2005/2006) Intel
HyperThreading (HT) (for example, they have Intel Xeon CPUs) then disable HT in the
BIOS for all servers

use
21
3.11 Windows 2008 UAC

Since Controller 10.1.1, disabling UAC is no longer necessary (either on the server or the
client device).
However, to make the installation much easier (fewer prompts during the software
install/configuration) the author typically disables the Windows 2008 UAC prompts before
continuing (you can re-enable UAC once everything is installed/working):
Start - Settings - Control Panel
Click "User Accounts- User Accounts"
Click "Change User Account Control settings"
Change slider setting to "Never notify"
Click OK
3.12 Enable the Windows 2008 policy 'Do not forcefully unload the user
registry at user logoff'.
VITAL: If using Windows 2008, then to stop various error messages (see Technote
#1497069) you should:
Launch the group policy editor (click "Start - Run" then type "gpedit.msc")
Navigate "Computer Configuration -> Administrative Templates -> System->

UserProfiles"
Double-click on "Do not forcefully unload the user registry at user logoff"
Change the setting from Not Configured to Enabled.
3.13 Add the STAThreadPool registry key to modify COM+ behaviour

The following advice is new from March 2013, and is based upon feedback from several
customers.
VITAL: To prevent regular freezing for all users when one user performs an intensive task
(see Technote #1621584) you should create the following registry key:

use
22
TIP: The easiest method to achieve this is to:

Launch NOTEPAD
Paste in the following contents:
Windows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\COM3\STAThreadPool]
"EmulateMTSBehavior"=dword:00000001
Save this file as "1621584_COM+_Fix.reg"

Double-click on "1621584_COM+_Fix.reg" to add its information to the registry.
3.14 Best practices before proceeding

The author recommends:
Enable Terminal Services (remote connection) on all the servers (for ease of remote
administration of them in the future)
Ensure that your application server has a fast (a minimum of 100Mb Full Duplex) network
connection to/from the database server
o
Ideally you should be using gigabit network connections
IMPORTANT TIP: Try copying a large folder (for example the 500Mb i386 folder, found on the
Win2003 installation CD-ROM) from the Controller application server to the database server, across
the network. How long does this take? 500Mb should only take 2 to 3 minutes to copy across a
100b Full Duplex network.
This is one of the best tests that you can perform, during the installation, since it is a fairly common
problem to find out (afterwards) that there is poor network connectivity causing Controller
performance problems.
Double-check the Regional settings, before installing any software.

o
Typically, ensure that your server has been installed with the appropriate
setting for your country (e.g. English (UK)) as default regional
options/language/keyboard.
These regional settings choices should be consistent (the same) between the
various servers (Database, Application server and Citrix servers) involved
Having a mixture of Regional Settings increases the likelihood of

experiencing application issues

use
23
4 Recommended Server System Settings

4.1
Create a Controller System Windows domain user
The Controller COM+ application must run under a Domain User account (to allow advanced
Controller functionality to work as intended).
Create a Windows (Active Directory) domain user (e.g. DOMAIN\Controller_system)
o Ensure that the users password is not set to expire

Add this Domain User to the local administrators group that resides on the application
server
o
o
i.e. right-click on My Computer, and choose Manage

Expand Local Users and Groups - Groups
Open up Administrators and add the domain user here
Ensure that the customer does not have a policy (e.g. an AD Group Policy) which
periodically automatically removes non-recognised accounts from the local
Administrators group
Best Practice
Add this Controller service Windows user to the local administrators group for *all* servers that
are dedicated for Controller-only use (for example, you may have dedicated SQL/Citrix servers)
This is best practice makes the installation (and future troubleshooting work) easier.
Important:
As a best practice, all future parts of this document should be performed whilst logged on as the
Controller system Windows user account (for example DOMAIN\Controller_system)
that you have previously created (see above).
4.2
Register ASP.NET 2.0 (SP2)
ASP.NET is an IIS extension that ships with the .NET Framework, but it isn't installed by
default. It needs to be registered and configured to run before Controller will work.
Open a Command Prompt Window
change directory to c:\windows\Microsoft.NET\Framework\v2.0.50727

When using Windows 200x 64-bit, this should be the following folder:
c:\windows\Microsoft.NET\Framework64\v2.0.50727
Run the following command: aspnet_regiis.exe /i

use
Right-click on 'My Computer' and choose 'Manage'
Expand 'Server Manager - Roles - Web Server (IIS)'
Click 'Internet Information Services'
Inside the 'Connections' section, highlight your server
Double-click on ISAPI and CGI restrictions
Ensure that 'ASP.NET v2.0.50727' is set to 'Allowed'
Finally, inside IIS Manager, open the section Application Pools
Double-click on DefaultAppPool and ensure that its .NET Framework version is set to
.NET Framework v2.0.50727:
24
Open IIS Manager (Start > Control Panel > Administrative Tools > Internet Information Services (IIS) Manager
Open Web Service Extensions, and select ASP.NET v2.0.50727 in the right-hand panel
Expand 'Web Sites', right-click on 'Default Web Site' and choose 'properties'
Click 'ASP.NET' tab
Ensure that the 'ASP.NET version' is set to '2.0.50727'
Double-check to make sure it is set to Allowed

use
25
In Windows 2003 x64, open IIS Manager (Start > Control Panel > Administrative Tools > Internet
Information Services (IIS) Manager
Make sure that the status of ASP.NET version 2.0.50727 (32-bit) is set to 'Allowed' in the Web
service extension list in Internet Information Services Manager
Expand 'Web Sites', right-click on 'Default Web Site' and choose 'properties'
Click 'ASP.NET' tab
Ensure that the 'ASP.NET version' is set to '2.0.50727'
TIP: For more information, see: http://support.microsoft.com/kb/894435/en
4.3
Allow Cognos CGI/ISAPI extensions
The Cognos 10 BI server engine can either use CGI or ISAPI (see later section for more
details). By default, these are both disabled. After you have chosen which one to use (default
= CGI) you must enable the relevant extension by using either of the following methods
(quick or slow):
QUICK AND EASY METHOD:
Open the IIS administrative Manager tool, highlight your server, and open ISAPI and
CGI Restrictions

use
Right-click on the white background, and choose Edit Feature Settings
Tick the relevant box (either Allow unspecified CGI modules or Allow unspecified
ISAPI modules) depending on which technology you intend to use.
Click OK.
SLOWER/MORE PRECISE METHOD:

For more precise security control, you should:
o
Right-click on the white background, and choose Add
Inside the Add ISAPI or CGI Restriction box, create a new Webserver extension
For example, call the Description either Cognos.cgi or cognosisapi.dll (depending on your needs)
Inside the ISAPI or CGI path configure it to allow the relevant file, which (by default) is either:
o
C:\Program Files\Ibm\Cognos\c10\cgi-bin\cognos.cgi
Make sure that "Allow extension path to execute" is ticked
Or C:\Program Files\Ibm\Cognos\c10\cgi-bin\cognosisapi.dll

use
26
27
QUICK AND EASY METHOD:
Open the IIS administrative tool, and open Web Service Extensions
Highlight the relevant section (either All Unknown CGI Extensions or All Unknown ISAPI Extensions
and then click on the Allow button:
SLOWER/MORE PRECISE METHOD:

For more precise security control, you should:
o
Create a new Webserver extension (for example, called Cognos8)
Configure it to allow the relevant file(s), for example:

o
C:\Program Files\ibm\Cognos\c10\cgi-bin\cognos.cgi
o
Or C:\Program Files\ibm\Cognos\c10\cgi-bin\cognosisapi.dll

use
4.4
Optimise IIS website Application Pool settings
Inside IIS Manager, open the section 'Application Pools'
Right-click on 'DefaultAppPool' and choose 'Advanced Settings'
Under 'Process Model', change the setting for 'Idle Time-out (minutes)' from the
default (20) to 60
Right-click on DefaultAppPool and choose properties then performance tab

o
Increase IIS timeout from default (20 mins) to 60 mins (see below):

use
28
4.5
29
Optimise IIS website maxAllowedContentLength setting
NOTE: This section *only* required when using Windows 2008 (i.e. not Windows 2003).
Open the file c10\ControllerProxyServer\Web.config" inside NOTEPAD
Scroll all the way to the bottom, and (just before the final line ("</configuration>")
add a few lines of extra text (blue):
</system.diagnostics>
<system.webServer>
<security>
<requestFiltering>
<requestLimits maxAllowedContentLength="3145728000"/>
</requestFiltering>
</security>
</system.webServer>
</configuration>
Save
TIP: For more details, see Technote 1601102.

use
4.6
Disable Internet Explorer Enhanced Security Configuration
Right-click on 'My Computer' and choose 'Manage'
Highlight Server Manager (at the top of the screen), and then open section
'Features'
Inside the section 'Security Information' click on 'Configure IE ESC'
30
Ensure that 'Internet Explorer Enhanced Security Configuration' is configured to be

'Off' for both Administrators and Users.
Inside Control Panel Add/Remove Programs Windows Components, untick the box Internet
Explorer Enhanced Security Configuration.
4.7 Disable Internet Explorers publisher certificate revocation checking

If your application server cannot connect to the internet, then you will receive large delays
when you attempt to run the Controller .NET software. To solve this, launch Internet
Explorer, and click Tools Options.
Click Advanced tab and UNTICK Check for publishers certificate revocation:

use
4.8
31
Add servers to Trusted Sites zone in IE
Important: It is VITAL to ensure that communication between the application servers is not
blocked by Internet Explorer. Therefore, you MUST perform the following steps:
Launch Internet Explorer, and click Tools Options
Click Security, select Trusted sites and click sites button:
Untick the box Require server verification and add all the addresses for all the
separate Controller servers (e.g. report server, gateway etc.) in here
TIP: In case you need it later, it is recommended you add both the NetBIOS and FQDN names,
*plus* localhost
In other words, if you have 3 Controller application servers, add the following:
o
http://controllerAPP/ , http://controllerapp.domain.com/
http://controllerREP/ , http://controllerREP.domain.com/
http://controllerGWY/ , http://controllerGWY.domain.com/
http://localhost
Finally (see IBM Technote #1347295) you must:

o
o
Open the Internet Options, Security tab

Change the security level for the Trusted sites from the default Medium to
Medium-Low

use
32
5 Database Preparation
TIP: The following section assumes you are using Microsoft SQL. If you are using Oracle 9i/10G,
please refer to the authors companion Proven Practice documentation, for example Guide to
installing Oracle 11G rel2 Server _and creating databases_ on Windows,
for Controller 8.5.1 - Proven Practice..
5.1
Default Collation Setting for SQL server
Important: It is vital that you read and understand this section. Using the wrong database
collation for the Controller application repository database will cause problems in the future.
Controller should work with almost any case-insensitive server collation setting.
NOTE: We do not recommend using "uppercase
SQL_Latin1_General_Pref_CP1_CI_AS) because:
preference"
(for
example
no testing has been performed with uppercase preference collation settings
we believe that it can potentially cause errors with alphanumeric keys. Since
alphanumeric keys are used extensively in Controller, I would take this as a strong
warning not to use it.
However, you cannot transfer a database from one SQL server (to a different SQL server)
if the 2 servers have different server default collation settings.
This is because the Controller database *must* match the collation setting of the TEMPDB
database, so that it can transfer information correctly. For more information, see IBM
Technotes #1345692 & 1347234.
Since the customer will want to transfer their database between customer Cognos
Support and IBM Cognos consultant, it is essential that they are aware that each SQL
server (that they transfer the database to/from) must have the same collation
setting for its TEMPDB database (also known as having the same default collation
setting).
Therefore (if at all possible) you should try your best to ensure that your SQL server has
the IBM Cognos preferred collation setting of SQL_Latin1_General_CP1_CI_AS.

use
33
TIP: You can check what your SQL 2005/8 servers default collation setting is, by using the
SQL Server Management Studio tool. Right-click on server, and click properties see
below for an example:
TIP: If you yourself are installing the Microsoft SQL server, then you may decide that you want
to use IBM Cognos customers most popular collation (SQL_Latin1_General_CP1_CI_AS).
To achieve this, you need to ensure that you choose a custom install. During the installation
wizard, you choose a custom installation of SQL (see below for an example for SQL 2000)
During the wizard, when you reach the collation settings screen, choose dictionary order,
case-insensitive, for use with 1252 Character Set, which will appear similar to the following:
TIP: Publishing to OLAP Data Marts is no longer supported (from Controller 10.1) so
there is no longer any need to install the MSAS (Analysis Services) components.

use
5.2
34
Upgrade SQL to latest Service Pack
Naturally, after installing SQL it is standard best practice to immediately patch it to the latest
Microsoft service packs.
At the time of writing, assuming running 32-bit versions, the author recommends:
SQL 2005: Install SP4 by downloading and running the relevant file (typically
SQLServer2005SP4-KB2463332-x86-ENU.exe).
SQL 2008:
o
o
5.3
R1 - Install SP3 by downloading and running the relevant file (for example
SQLServer2008SP3-KB2546951-x86-ENU.exe for 32-bit version).
R2 - Install SP2 by downloading and running the relevant file (for example
SQLServer2008R2SP2-KB2630458-x86-ENU.exe for 32-bit version).
Post-install SQL Server Optimisations
Maximum server memory (in MB)
Important: if using SQL 2005/8 64-bit version, then (for performance reasons) it has
been found that it is best to re-configure your SQL server to NOT use all the servers RAM.
Instead, modify the SQL memory setting Maximum server memory (in MB) to
be less than (for example 75%) the total of RAM in the server.
o
For example, in a 16Gb RAM server, it is suggested to change the value to 12288
(which equates to 12Gb).
For more details, see Technote #1498586.
SQL Server parallelism
Relatively recently, the author has noticed that some customers can greatly benefit from
changing their SQL "Max Degree of Parallelism" setting (see Technotes 1595955, 1590091,
1347497 & 1634615 for example).
There is a balance to be had between speeding up consolidations and stopping the system
getting overloaded by large/complex processes. As a general guide, the author recommends:
For underpowered (below recommended specifications) SQL servers with only 2 or 3 CPUs
(CPU cores) - change the value to 1
For SQL servers with 4 to 7 CPUs - change the value to 2 or 3
For SQL servers with 8 to 12 CPUs - change the value to 3 or 4
For SQL servers with 12 to 16 CPUs - change the value to 4 or 5 or 6.
General Performance Tips:

Finally, there are several general ways to improve SQL performance, including:
Ensure that system/TEMPDB, DATA and LOGS and are on separate arrays, for maximum
performance
Change the default storage location for the DATA/LOG files on the SQL server at this point, to
save time in the future.
Ideally, the SQL server should be running on a server dedicated to this task only. However, if
it is performing another role (e.g. it is a development/test Controller Application server) then
modify the SQL Servers memory settings so that it does not use all the available RAM.

use
5.4
35
Controller SQL login user and database creation
TIP: If you require exact step-by-step instructions, then follow the authors separate document
17. Basic database tasks using SQL 2005 and Controller 8pdf.
See Technote #1347969 for this document, and more information on this subject.
Create blank SQL database(s) for Controller application repository (i.e. financial data)
Most customers have a need for live, test and training databases
Best practice: call these ControllerLIVE, ControllerTEST and ControllerTRAIN respectively
Create blank SQL database for Controller Cognos 8 BI ContentStore (i.e. report server configuration
data)
Best practice: call this ControllerContentStore
Create SQL login

To enable SQL logins, you must ensure that your SQL server is set to mixed-mode authentication
By convention, Cognos recommends using the SQL login called fastnet, although any name could be
used (although cannot start with a number e.g. 1cognos since get errors with certain processes e.g.
DBMAINT).
Important:
The password for fastnet cannot contain any & characters.
For most situations, do NOT tick the Enforce password policy checkbox
Also, ensure that this SQL login (e.g. fastnet) has its default language set to
English. Otherwise you may get strange issues, such as standard reports having
incorrect decimal characters.

use
36
Give SQL login database access rights

Click on server roles and ensure that ONLY the roles public and bulkadmin (known in
previous versions of SQL as bulk-insert administrators aer ticked
For your information, the bulkadmin is required for Optimise2 (ERO) to work
VITAL: Do *not* give the SQL login (e.g. fastnet) sysadmin rights.
See Technotes such as #1347546 for why not.
Ensure that fastnet is given dbowner rights to the following databases:

1.
tempdb required since Controller extensively uses this database
2.
model required since SQL will occasionally recreate tempdb from a copy of model, e.g.
whenever SQL is restarted
3.
all Controller application databases (for example ControllerLIVE, ControllerTEST,

ControllerTRAIN etc.)
Information: The SQL login fastnet requires dbowner rights to the database tempdb
to allow the ERO (Enhanced Report Optimisation also known as Optimise2) feature
to work.
By default SQL will allow the user fastnet read /write access to TEMPDB (regardless of whether we use Optimise2 or
not). However, the reason why the Controller SQL login specifically needs dbowner rights is because of a confirmed
Microsoft limitation of their SQL product, where BULK INSERT (which is the technique behind Optimise2), requires
dbowner rights.
NOTE: The fact that fastnet is dbowner for TEMPDB should not affect other applications. Using Optimise2 should, in fact,
affect other applications using the same SQL Server to a lesser extent than if Optimise2 wasnt used! By using Optimise2,
temporary tables are created in tempdb for a shorter period of time (than if not using Optimise2), thus holding a shared
resource for a shorter period of time (good).

use
5.5
37
Create an Optimise2 (a.k.a. Advanced Excel Link or E.R.O.

Enhanced Reporting Optimisation) share
In most circumstances, it is easiest to place this share on the SQL server:
Create a folder on the

controller_BI_share$)
Modify the share and NTFS permissions of it so that the Controller service account user (for example
domain\controller_system) has full control rights
Create a subfolder for each of the databases
For more information, see Technote # 1347048.
5.6
SQL
server
(e.g.
called
controller_BI_share)
and
share
it
(e.g.
For example ControllerLIVE, ControllerTEST, ControllerTRAINING
Restore other databases (if necessary)
You may already have a Controller database to restore (e.g. sent from the application consultant). Use the SQL
Enterprise Manager interface to restore the database. After restoration, you will have to remove orphaned users
(synchronise SQL logins) by:
launch Query Analyser
change database to one you have just restored
run the following script (update_user.SQL):

EXECUTE sp_change_users_login 'Update_One', 'fastnet', 'fastnet'
GO
TIP: change *both* the users fastnet and fastnet for the name of your SQL login (e.g. cognos or whatever).
5.7
Create Database Maintenance Plans
Important: It is VITAL that, for performance and stability reasons, your SQL server has a
Database Maintenance plan configured. See Technote 1347569 for more information.
SQL:
The authors best practices are:
Create a database maintenance plan (e.g. called Controller databases) which:

o
Optimises/re-indexes/update_statistics once a week (e.g. every Sunday morning at 4am)
o
Backs up the database nightly
o
Backs up the transaction logs nightly
In addition, it is HIGHLY recommended that:

o
You configure an *additional* new maintenance job, which merely update the statistics every night

This will speed up certain operations inside Controller
See the separate IBM Technotes #1347569 & 1396973 for full details.
Oracle: There are recommended scripts inside the official documentation, however for more details see the
authors separate Proven Practice documents:
06. Guide to installing Oracle 10G Server _and creating databases_ on
Windows, for Controller 8.2 - June 21 2007.pdf
and Guide to installing Oracle 11G rel2 Server _and creating databases_ on
Windows, for Controller 8.5.1.
TIP: For more best-practice hints & tips, see Technote# 1346962.

use
38
6 Installation of Controller Server

Download the Controller 10.1.1 RTM software from the IBM website
6.1
Instructions for how to download 10.1.1 are found here:

TIP: Typically, most customers will only need to download the following components:
(1) Main Controller server software
CI7MNML = Controller 10.1.1 Microsoft Windows Multilingual
(2) TM1 Server (typically both 32-bit and 64 bit)
CI5TAML = TM1 32-Bit 10.1.0 Windows Multilingual
CI5TBML = TM1 64-Bit 10.1.0 Windows Multilingual
TIP: TM1 64-bit version is (or course) a 64-bit piece of software. Therefore, there are
performance/stability improvements in using the 64-bit version.
In general, when using Controller FAP it is recommended to have a dedicated (TM1 only)
server running a 64-bit operating system, using the 64-bit version of TM1.
However, you will also have to install the 32-bit TM1 client on the FAP server (typically
the main Controller application server) see later.
Download any preferred/recommended (post 10.1 RTM) Interim Fix

Packs
6.2
At the time of writing, the latest/recommended Interim Fix (IF) pack for all customers is IF1.
See here: http://www-01.ibm.com/support/docview.wss?uid=swg21605078
Obtain this IF1 file (up_cntrl_win32_10.1.6235.100_ml.tar.gz) before continuing.
Obtain a suitable JDBC driver
6.3
New since Controller 10.1, Controller now uses JDBC connectivity to access the Controller
databases. Controller does not ship with a JDBC driver in the software itself, so you must
download a suitable JDBC driver from the relevant database providers website.
For example:
TIP:
Database Server
Description
Filename
Microsoft SQL
JDBC driver
sqljdbc4.jar
Oracle
JDBC thin driver
ojdbc14.jar
IBM DB2
DB2 driver
db2jcc.jar
sqljdbc4.jar see http://www-01.ibm.com/support/docview.wss?uid=swg21500432

ojdbc14.jar - easily copied from any Oracle client installation, which therefore should
already a folder on the Controller application server.
o For example, if using Oracle 10G then by default the file is located here:
C:\oracle\product\10.2.0\client_1\jdbc\lib
db2jcc.jar
use
6.4
39
Server Software installation
TIP: The following assumes that there is only 1 application server, with all components
installed and running on this server.
Launch the installation program issetup.exe (located inside <cdrom>\win32)
Select the installation language and click the Next button
I agree, Next
Choose the installation location (default C:\Program Files\ibm\cognos\c10), and click the
Next button
Select all components (default) and click the Next button
this is used only for the installation, it is not the default product language
Accept the default shortcut folder (this is for the start menu) and click the Next button
Click the Next button to start the install
After the installation has completed, leave the option Start Cognos Configuration deselected and
click the Finish button

use
40
Important:
There have been a small number of occasions (in the past) where the Controller installation does not register all COM+
components correctly. Therefore, check that the number of components that appear (see below) is 263:
TIPS:
To view the total number, right-click on Components and select View Customise Description Bar
Controller 10.1.1 should have 263 objects
6.5
You will have to close Component Services and re-launch the tool to see the change
Install/apply required Interim Fix
Important: It is VITAL that the patch (IF) is installed without any IBM Cognos-related
services/processes running.
Stop the following Windows services:
IBM Cognos service
IBM Cognos Controller Batch Server
IBM Cognos Controller Java Proxy
IBM Cognos Controller User Manager
IBM Cognos FAP Service
Internet Information Services (IIE) Manager (the Default Web Site)
Stop the Components Services COM+ application called IBMCOGNOSCONTROLLER
Extract the Interim Fix file (for example Controller 10.1.1 IF1 = up_cntrl_win32_10.1.6235.100_ml.tar.gz)
After extracting the IF fix, launch \win32\issetup.exe
Follow the directions in the installation wizard, installing in the same location as used before
When prompted, choose to create a backup copy of the affected files
Follow the directions in the installation wizard
Afterwards, reboot the application server (to ensure that all files are 100% registered and to allow the
stopped Windows services to start again).
TIP: For more details, see IBM Technote: http://www-01.ibm.com/support/docview.wss?uid=swg21602419

use
41
7 Configuration of Controller Server

7.1
IBM Cognos Controller Java Proxy Windows Service User Account

Modify the Windows service IBM Cognos Controller Java Proxy so that it does NOT
run under the default Windows user (Local System).
Instead, change it to run under your Controller COM+ user account (for example
<DOMAIN>\Controller_system:
TIP: For more information on the COM+ user, see previous section "Create a Controller
System Windows domain user" and future section "Controller Server configuration".
7.2
Check JAVA_HOME environment variable for BI
TIP: Previous versions of Controller/Cognos 8 BI recommended having a JAVA_HOME variable.

From Controller 8.5 and later versions, this is no longer necessary.
Therefore, if you are 100% sure you do not have a JAVA_HOME variable configured, then you
can skip this section.
NOTE: It does no harm having a variable configured, so long as it has the correct value.
Logon to your Controller application server (report server), right-click on My Computer and choose
properties
Inside your system properties, select the Advanced Tab
Click the Environment Variables button, and locate the System Variables section
If there exists a variable called JAVA_HOME , then

o
Either delete this variable
Or ensure that its value is correct, for example: <installDir>\bin\jre\6.0
NOTE: Youll have to reboot the server now for this JAVA_HOME variable change to take place

use
7.3
42
Copy required JDBC drivers onto server
Copy the JDBC driver(s) (see earlier in this document for more details) into the 'Integration', Lib and c10
folders.
TIP: By default, the folders are located here:
TIP:
7.4
1.
C:\Program Files\ibm\cognos\c10\server\Integration
2.
C:\Program Files\ibm\cognos\c10\server\FAP\lib
3.
C:\Program Files\ibm\cognos\c10
The JDBC driver filenames are:

For SQL, the JDBC file is sqljdbc4.jar
For Oracle, the JDBC file is ojdbc14.jar
For DB2, the JDBC file is db2jcc.jar
Optional - Configure ccr-dbTypes.properties file
NOTE: For most customer's environments, the Java database connection file ("ccrdbTypes.properties") can be left as the default value (blank).
Therefore, for most installations, you should skip this section.
Optional (rarely necessary): Open the integration folder (default: C:\Program Files\ibm\cognos\c10\server\Integration)
and perform the following:
Create a copy of the file ccr-dbTypes.properties and name it BACKUP_ORIGINAL_BLANK.ccrdbTypes.properties
Open the file ccr-dbTypes.properties in NOTEPAD
Inside the file, add the values (in blue, listed below) appropriate for your chosen database server (SQL, Oracle
or DB2)
Save file
Create a copy of
dbTypes.properties
the
file
ccr-dbTypes.properties
and
name
Below are the three different types of entries to choose from:

MS SQL Server:
SQL_SERVER.name = MS SQLServer (Microsoft native)
SQL_SERVER.driver = com.microsoft.sqlserver.jdbc.SQLServerDriver
SQL_SERVER.url = jdbc:sqlserver://%s%s;databaseName=%s
Oracle
ORACLETHIN.name = Oracle thin
ORACLETHIN.driver =oracle.jdbc.driver.OracleDriver
ORACLETHIN.url = jdbc:oracle:thin:@%s%s:%s
IBM DB2
DB2.name = DB2
DB2.driver = com.ibm.db2.jcc.DB2Driver
DB2.url = jdbc:db2://%s%s/%s
TIP: More information is available in the ccr-dbTypes.properties file.

use
it
BACKUP_MODIFIED.ccr-
7.5
43
For Oracle Only - Configure ccr-system-properties.properties file
If using Oracle, then you need to specify the location of the TNSNAMES.ORA file in the ccr-systemproperties.properties file in the ...Server\integration folder.
For Oracle 10.2, by default the location of the TNSNAMES.ORA file is usually the directory:
C:\oracle\product\10.2.0\client_1\NETWORK\ADMIN. Therefore, in the case of a default Oracle 10G rel2 client
install, you need to modify the file as follows:
# Oracle Network admin directory path, the location of the TNSNAMES.ORA
oracle.net.tns_admin=C:\\oracle\\product\\10.2.0\\client_1\\NETWORK\\ADMIN
7.6
file
Configure JRE environment system variable for Java-related

functionality (AFC/FAP etc.)
Since Controller 10.1.1, there is no need to configure a system variable CCR_JAVA_Home.
7.7
Configure CCR_INTEGRATION_SERVER_DEPLOY_HOME system

environment variable
NOTE: This step is unnecessary for Controller version from 10.1.1697 (10.1.1 FP1 IF2) and later.
However, due to a defect (PM78357) this is still necessary if you are using earlier versions.
Logon to the Controller application server as an administrator
Right-click on My Computer and choose properties
Inside your system properties, select the Advanced Tab
Click the Environment Variables button
Click the New button in the System Variables group
Enter CCR_INTEGRATION_SERVER_DEPLOY_HOME as the Variable name
Enter the path for the variable value, such as:
Click the OK button three times
C:\Program Files (x86)\IBM\Cognos\C10\Server\Integration

use
7.8
44
Cognos BI Report Server configuration
Note: These instructions assume that Microsoft SQL Server is the database type used.
Create the ContentStore -*only* if you have not already done so inside step 4.3 of this document!
o
Logon to the SQL Server as an administrator, and launch SQL Server Enterprise Manager
Expand Microsoft SQL Servers > SQL Server Group > Local > Databases
Right click on Databases and select the New Database... option from the popup menu
Enter the new database name (for example ControllerContentStore)
Click OK
Add a user to the database

o
Expand the ControllerContentStore database entry in the tree control in the left pane
Right click on the User entry, and select New Database User... entry from the popup menu
Choose <New> in the Login name: drop down
A new dialog will appear. Enter your SQL login name (for example fastnet) in the Name edit
field
Select SQL Server Authentication as the Authentication type
Enter a password
Set ControllerContentStore in the Database: drop down in the Defaults section, and Click OK
Confirm the password and click OK
Click Yes
Set fastnet in the Login name: drop down
Select db_owner and db_ddladmin in the Permit in Database Role, and Click OK
Add the Cognos BI runtime virtual directories

o
Add the ibmcognos virtual directory

Launch IIS Manager
In the tree control in the left pane expand (machine name) > Web Sites > Default
Web Site
Right click the default web site
Choose 'Add Virtual Directory'
Enter ibmcognos in the Alias
In the Physical path browse to the (installdir)\webcontent path (for example

C:\Program Files\ibm\cognos\c10\webcontent) and click Next
Click OK

use

o
Add the cgi-bin virtual directory

Right click on the new ibmcognos entry
Choose 'Add Virtual Directory'
Enter cgi-bin in the Alias field
In the Physical path browse to (installdir)\cgi-bin path (for example

C:\Program Files\ibm\cognos\c10\cgi-bin) and click the Next button
Next, you need to:
45
Highlight the cgi-bin virtual directory
Double-click on Handler Mappings
Click on Add Module Mapping
Enter the values exactly as appear below (*.cgi, CgiModule, cgi-bin):
Click OK.

use
46
By default handlers defined in IIS 7.0 for either CGI or ISAPI modules do not process the full path information
in a URI. Therefore (see Technote 1390241) on Windows 2008 you must perform the following:
Using Windows Explorer, open the cgi-bin folder (default = C:\Program Files\ibm\cognos\c10\cgibin)
Launch NOTEPAD.EXE and edit the file web.config:
Add the text allowPathInfo=true after the word unspecified
TIP: The file will now look similar to:
Add the ibmcognos virtual directory

Launch IIS Manager
In the tree control in the left pane expand (machine name) > Web Sites > Default Web
Site
Right click the default web site
Select New > Virtual Directory... from the popup menu
Enter ibmcognos in the Alias edit field and click the Next button
Browse to the (installdir)\webcontent path (e.g. C:\Program Files\ibm\cognos\c10

webcontent) and click Next
Keep the default permissions (Read only) and click the Next button, then Finish
Add the cgi-bin virtual directory

Right click on the new ibmcognos entry
Enter cgi-bin in the Alias edit field and click the Next
Browse to the (installdir)\cgi-bin path (e.g. C:\Program Files\ibm\cognos\c10\cgibin) and click the Next button
Select the Read , Run Scripts and Execute permission, and click the Next, then finish
buttons
Launch Cognos Configuration (Start Menu > IBM Cognos 10 > Cognos Configuration)
o
Navigate throughout Cognos Configuration, and modify all the relevant references which (by
default) initially refer to localhost. Change them to the appropriate real servername
In the tree control in the left pane, click on the Local Configuration > Data Access >
Content Manager > Content Store entry
e.g. change local configuration environment and Environment Portal Services
TIP: Previous versions of Controller had the default contentstore type set to Microsoft SQL. From Controller 8.4 onwards,
this is now DB2. Therefore, we shall change this to SQL in the next steps
Right-click on Content Store and choose Delete, then click yes to confirm

use

o
Right-click on Content Manager and choose 'New resource' - 'Database'
47
Select 'Microsoft SQL Server database'
Type the name 'Content Store'
In the right pane, click on the UserId and password, then on the edit button (it has a pencil
icon). Enter the user id and password, then click the ok button
Fill in the other entries, to point to your ContentStore database:
In the left pane, right click on the Content Store entry, and select the Test option from the
popup menu item. Ensure it's successful (this will take a minute or so)
In the tree control in the left pane, click on the Local Configuration > Security > Cognos
Application Firewall entry
In the right pane, set the Enable CAF Validation option to False
TIP: The only reason for disabling the CAF is to give sensible error messages during the initial testing/development phase.
When the server goes into production, this should be changed to True.
In the tree control in the left pane, click on the Local Configuration
Click the Save Button, and then the Start Service button in the main toolbar (this can take
several minutes)
If you get an error at this stage, you may find that you need to reboot and try again.

use
7.9
48
Test the Cognos BI runtime Reporting Server
TIP: Test Controller directly from the application server itself first, before trying on remote client PCs.
Launch Internet Explorer, and enter http://(machine name)/ibmcognos as the address
- If Cognos Connection loads, the install was successful!!
7.10 Import the Controller Standard Reports Framework Manager

model via Cognos Connection
Launch Cognos Connection from http://servername/ibmcognos
Click Administer IBM Cognos content
Click the Configuration tab, then Content Administration
click New Import button
Select the Controller entry, then click Next then Next
Tick the box next to the Controller entry, and click Next
Click Next, then Next then Finish
Click Run, then OK
Click then home icon (you should see a Controller folder if everything was successful)
TIP: For performance reasons, you should NOT have the Report Server service (i.e. the Windows service called IBM
Cognos) running on the same server as your database server (for example SQL 2005). However, if you do (e.g. this is a
very small demo/test server) then you may get an issue after a reboot, where the Cognos BI service does not successfully
(automatically) start
o
This is caused by the SQL ContentStore database not being available when the IBM Cognos Windows
service tries to start
There are many different ways to solve this. See IBM Technote 1347377 for more details.

use
49
7.11 Controller Server IIS/web configuration

Ensure the Controller Application Repository Database exists
o
See previous section of this document for advice.
Add the Controller virtual directories

o Add the controllerbin virtual directory
Launch IIS Manager
In the tree control in the left pane expand (machine name) > Sites > Default Web Site
Right click the ibmcognos virtual directory and choose Add Virtual Directory
Enter controllerbin in the Alias edit field
Browse
to
the
<installdir>\webcontent\ccr
Files\ibm\cognos\c10\webcontent\ccr) and click OK
path
(typically
C:\Program
o Add the controller virtual directory

Right click the ibmcognos virtual directory and choose Add Virtual Directory
Enter controller in the Alias edit field
Browse
to
the
<installdir>\ccrvdir
(x86)\ibm\cognos\c10\ccrvdir) and click OK
path
(typically
C:\Program
Highlight the new virtual directory (controller) and then click HTTP Redirect:
Files
Tick the redirect request to box, and enter /ibmcognos/controllerbin/ccr.exe

use
50
Click Apply button (top right corner)
TIP: The section above controls where the clients web browser redirects when they click the Controller link inside
Cognos Connection. Therefore, if you have your Client Distribution Server on a different server, you should redirect to a
different server. For example: http://CTRLsvrCDS/ibmcognos/controllerbin/ccr.exe
Add the controllerserver application

o Right click on the ibmcognos entry, select Add Application from the popup menu
o Enter controllerserver in the Alias edit field
o Browse to the (installdir)\ControllerProxyServer path and click OK
Add the controllerhelp virtual directory

o Right click on the ibmcognos entry, select New > Virtual Directory... from the popup menu
o Enter controllerhelp in the Alias edit field and click Next
o Browse to the (installdir)\webcontent path and click OK

use
51
o Add the controllerbin virtual directory

Launch IIS Manager
In the tree control in the left pane expand (machine name) > Web Sites > Default Web Site
Right click the ibmcognos virtual directory
Enter controllerbin in the Alias edit field, Next
Browse
to
the
<installdir>\webcontent\ccr
Files\ibm\cognos\c10\webcontent\ccr) and click Next
path
(typically
C:\Program
Set the permissions to Read and Run Scripts and Next then Finish
o Add the controller virtual directory
Right click the ibmcognos web site, select New > Virtual Directory
Enter controller in the Alias edit field and click Next
Browse to the same path as above (e.g. C:\Program Files\ibm\cognos\c10\webcontent\ccr) and

click Next
Set the permissions to Read and Run Scripts and click Next then Finish
NOW: Right click on the controller virtual directory and select properties from the popup menu
Select the "A redirection to a URL" option
In the redirect to edit field, enter /ibmcognos/controllerbin/ccr.exe
TIP: This section controls where the clients web browser redirects when they click the Controller link inside Cognos
Connection. Therefore, if you have your Client Distribution Server on a different server, you should redirect to a different
server. For example: http://CTRLsvrCDS/ibmcognos/controllerbin/ccr.exe
o
Add the controllerserver virtual directory

o Enter controllerserver in the Alias edit field and click Next
o Browse to the (installdir)\ControllerProxyServer path and click Next
o Select the Read and Run Scripts permissions and click Next, then Finish
Add the controllerhelp virtual directory

o Enter controllerhelp in the Alias edit field and click Next
o Browse to the (installdir)\webcontent path and click Next
o Select the Read permission and click Next, then Finish

use
52
Launch Controller Configuration (Start Menu >IBM Cognos 10 > IBM Cognos Controller > Controller Configuration)
Configure COM+ Server
o In the tree control in the left pane, expand Cognos Controller Configuration > Web Services
Server > COM+ Server
o In the right pane, select the Specify Account option
Enter
an
administrative
Windows
domain\controller_system)
Enter and confirm the password
user
in
the
User
edit
field
(e.g.
Important: It is VITAL that the Windows user entered here is:

o
A domain user (for example of why, see IBM Technote 1347048)
A member of the local Administrators group on the application server itself (see # 1367316)
o In the Controller COM+ roles and users, click in the area, and then click the New (white page)
button from the main tool bar
o In the COM+ Role, enter a suitable name, such as ControllerUsers
o In the COM+ User, enter everyone
o Repeat the three previous steps, but enter NT AUTHORITY\SYSTEM as the user
o Click on SAVE icon (top left corner)

TIP: For more precise security controls, you can narrow the security further by using the following COM+ roles and users
instead of the ones that I listed above:
o
ControllerUsers
NT AUTHORITY\IUSR_<Servername> (the Widows account that, by default, runs
Controllers virtual Controller directories in the default website)
ControllerUsers
NT AUTHORITY\NETWORK SERVICE (the account running the default application
pool in which Controllers virtual directories have write access)
ControllerUsers
service)
NT AUTHORITY\SYSTEM (the account which runs the Controller Windows batch
Configure the database connection

In the tree control in the left pane, expand Cognos Controller Configuration > Web Services
Server > Database Connections
Click the New button in the main tool bar
In the right pane, enter the following information:

o
Databasetype: SQL Server (TIP: you can simply double-click on this cell to change it)
Name: default
(for example)
TIP: usually the name of the server and/or purpose is used to help identify the database e.g. default and
controllertest)
IMPORTANT: The database connection names are case-sensitive.

Therefore, for SelectDB and single-user mode to work correctly, your main (live) database should never be called Default.
Instead, it should be default with all characters lowercase!
For more information, see IBM Technote 1364826 .
NOTE: Previous versions of this document recommended using Default (and not default). The change in recommendations is
because of a code change that has occurred from 8.5.1 onwards. For more information, see Technote #1406756.

use
Provider:
SQLNCLI.1
53
(for SQL Server 2005 & 2008 databases)
TIP:
o
For Oracle, this should be OraOLEDB.Oracle.1
For DB2, this should typically be IBMDADB2.DB2COPY1
NOTE: Previous versions of this document recommended using

SQLOLEDB.1 is no longer supported from Controller 10.1 onwards
SQLOLEDB.1 instead of SQLNCLI.1. However,
NOTE:
User ID: The user ID used in the Create Controller Database step (e.g. fastnet)
Password: The Password used in the Create Controller Database step
Initial catalog: The name of the database created previously step (e.g. ControllerLive)
Data source: The name of the database server
Click the save button in the main tool bar
Configure the location of the Cognos Report server (i.e. typically the same as the Controller application server,
unless you have a distributed installation where you have a separate BI/Report server)
In the tree control in the left pane, expand Cognos Controller Configuration > Web Services
Server > Report Server
TIP: You may receive the following message, which you should acknowledge OK:
If you get this error, it will always appear (when you launch Controller Configuration) until you follow the details inside
later section entitled Configure the location of the Cognos Report server
In the right pane, in the report server field, change the Report Server section
o
from http://localhost/ ibmcognos/...
to http://<servername>/ibmcognos/...
Click on the save icon at the top-left corner of Controller Configuration

use
54
IMPORTANT: In some situations, the Report Server section may APPEAR to have already have
been filled in with the correct servername (not localhost) already appearing. If this is true, then you
*must* make a subtle change, re-save and then reverse the change, and re-save.
=> If you do not this, then these settings will not get saved and registered properly!
Ensure that the dispatcher URI is set to http://<servername>/ibmcognos/...
In other words, the screen should now look similar to:
Ensure that Controller is the package name, and click Save

At this stage, you should see the following message, and you should click Repair.
TIP: This step ensures that the system reports can work (handled by the Cognos BI runtime component).
Clicking on the Repair button creates a connection (data source) between Controller and Cognos BI reporting services.
This step (pressing the repair button) has to be done again whenever you create a new database connection in the future.

use
55
Inside the Client Distribution Server Config, ensure that:
SelectDB is set as appropriate

o
Typically set this to off so that (by default) users can only see the single default database
connection
Then, the superusers (who want to see multiple databases e.g. test/training databases) can
click on maintain Database Database Selection Mode in order to see the other databases.
Ensure that all end users PCs can resolve the URLs that are specified
o
Typically this means changing the NetBIOS names (e.g. MYSERVER) into FQDN names (e.g.
MYSERVER.companyname.com)
The settings (CASUrl, WSSUrl and HelpUrl) defined here are the ones that the client PCs will attempt
to use, so it is VITAL that they are correct
After making changes, you must click the save icon
Finally, you need to:
Open the folder C:\Windows\System32\inetsrv\config
Launch Notepad.exe and edit the file applicationHost.config
Search for requestFiltering section
Modify the value for .config to true:
In other words, modify the line to read: <add fileExtension=".config" allowed="true" />

use
56
TIP: Check IIS settings, especially if this is a shared web-server (i.e. your webserver is hosting other non-Cognos websites,
for example sharepoint server), by performing the following steps:
Launch Notepad
Open the file C:\Inetpub\wwwroot\explore.exe.config
Ensure that the entries for Controller 8 are using the correct server name convention (e.g. NetBIOS or FQDN),
similar to the following:
<add key="CASUrl" value="http://servername/ibmcognos/controllerbin" />
<add key="WSSUrl" value="http://servername/ibmcognos/controllerserver" />
Repeat the above for the file C:\Inetpub\wwwroot\iexplore.exe.config
7.12 Enable Batch service(s)

Inside Cognos Controller Configuration, open Web Services Server and then Batch Services
IMPORTANT: Unless the customer has exceptional needs/requirements, you should only enable 1
batch service (no more) See Technote 1370901 for full details.
Therefore, click on Controller Batch Process 1 and press the play icon so that the status changes to
Running
7.13 Enable Optimise2

IMPORTANT: Optimise2 (also known as ERO) is HUGELY useful for speeding up Controller Excelbased reports. It is VITAL that this is configured, to allow the end users to speed up their system.
See IBM Technote #1347048 for full details of how to configure ERO/Optimise2.

use
57
7.14 Use Database Conversion Utility to populate databases

TIP: The Database Conversion Utility changed between Controller 8.5.1 and 10.1. It now uses JAVA.
Open the section Database Connections and highlight the new database (for example called default)
click the Run (green play) button in the main tool bar
The first time that you run this utility (assuming that you have no JAVA_HOME variable) you *may* be asked for a
Java location:
Choose the folder (default = C:\Program Files\ibm\cognos\c10\bin\jre\6.0):

use
58
Ensure that the "UDL File" is pointing to the relevant database connection (for example: C:\Program
Files\ibm\cognos\c10\Data\default.udl)
Ensure that "Controller DB" is selected
Click "Connect"
Because this database is a brand new blank database, the Current Version will be set to zero (0). Therefore,
click Create DB:
When the script has finished running, it will say Done
Now click on Upgrade to upgrade the database from the current version (813) to the latest (849):
When finished, there will be a message saying DB succesfully upgraded to version: 849

use
59
8 Install and Configure Financial Analytics Publish (FAP)

8.1
Overview
FAP was originally introduced in Controller 8.5. It allows near real-time reporting from
Controller, by trickle-publishing the Controller data to a TM1 cube. It consists of:
Financial Analytics Publisher client
o This is the admin console for FAP.
o This is typically installed on the Controller application server
o However, some customers may prefer to install this on a limited number of
superusers PCs.
TIP: For instructions, on how to install the FAP Client on an end users PC, see Technote 1505119 here:
Financial Analytics Publisher database

o This may be located on a separate/dedicated database server.
Financial Analytics Publisher Service
o The author typically installs this on the Controller application server itself
However, some/many customers choose to instead install it on a
separate/dedicated TM1 application server.
TM1
o This is typically located on a separate/dedicated TM1 application server.
TIP: Controller 10.1.1 is bundled with TM1 version 10.1.0 (32-bit and 64-bit versions). Therefore, before continuing,
please ensure that you have downloaded one of the following (as appropriate):
o
Either CI5TAML = TM1 32-Bit v10.1.0 Windows Multilingual
or CI5TBML = TM1 64-Bit v10.1.0 Windows Multilingual
See earlier for more details.
IMPORTANT: Only certain versions of TM1 are tested/supported with Controller 10.1.1
Do not attempt to use incompatible versions of TM1 (for example see Technote # 1417823).
The potential benefits of using FAP are so huge, that it is strongly recommended that all
customers install and configure FAP, as part of their Controller system.
8.2
Further preparation information / reading
For more information on how to install TM1 10.1.0, see:

o
The official Controller document Installation and Configuration Guide

(ctrl_inst.pdf)
The official TM1 10.1.0 document TM1 Installation Guide (tm1install.pdf)
The separate Proven Practice document (Installing the Financial Analytical Publisher
(FAP) for Controller 8.5)
The following sections are based on the official Installation and Configuration Guide
TIP: Many of the steps listed below (for example creating a new SQL database, or installing IIS) are
similar/the same as the steps needed to perform on the Controller application server itself.
Therefore, for more guidance/detailed-instructions of how to perform some of the following tasks, please
refer to earlier in this document.

use
8.3
60
Component installation locations - Initial Assumptions
As the installation of Financial Analytics Publisher includes several different server

components, there are a number of different options on how to perform the installation.
This document shall assume that
o
The Financial Analytics Publisher client (that is, the admin console) and the Financial
Analytics Publisher Service will be installed on the Controller application server
o
If you choose a different configuration (for example the FAP service to be installed on
the TM1 server) then you will have to install some pre-requisites on the TM1 server
For example, you would need to install/configure JRE and CCR_JAVA_Home (see
scenario 6 of Technote 1424705).
There is a separate/dedicated database server (e.g. SQL server) hosting the Financial
Analytics Publisher database,
There is a separate/dedicated application server, upon which TM1 is installed.
NOTE: To repeat the above, the following instructions assume that you have a dedicated TM1 server, upon which NO
Controller components are installed. In other words, ONLY the TM1 application server and TM1 database are going to
be hosted on the TM1 server. This is the most likely/common/recommended configuration for most customers.
In addition, the following instructions assume that the customers requirements are
standard. Therefore, the options are generally left as the defaults. If your customer
has any specific requirements, then please refer to an experienced TM1 consultant
who can modify the settings as appropriate.
8.4
Creating a Financial Analytics Publisher Database
If you are installing the IBM Cognos Controller Financial Analytics Publisher Client for the first
time, you must create an empty Financial Analytics Publisher database. This is because
Financial Analytics Publisher requires a database to publish data from the Controller database.
In other words,:
You need to create a blank database
(labelled Controller Published Data
Mart in diagram on left hand side)
This stores the data that is
continuously being trickle-published
out of the Controller Operational
Database (more commonly known as
the Controller application repository
database).
TM1 itself will then build cubes in memory from the

data that is held in the Data Mart (see diagram on the
right).
In other words, the TM1 cubes are not stored
in the SQL database, but instead they are
dynamically created from it.

use
Logon to your database server (for example SQL 2005) and create a new FAP data mart
database (for example called ControllerLive_FAP_data_mart)
Ensure that your SQL login (for example fastnet) has dbowner rights to this database
8.5
61
Creating tables inside FAP Database
TIP: Previous versions of Controller (8.5.x) required you to run the script nrtr_createTables.sql. This is no
longer the method to use, from Controller 10.1 onwards.
Launch Controller Configuration and then:
Open Database Connections and create a new entry
Choose your settings for the FAP database, for example:
database Type (for example SQL Server)
Name: controller_fap_data_mart
Provider: SQLNCLI.1
User id: fastnet
Password: <password>
Initial Catalog: controller_fap_data_mart
Data source: <SQL_server>
Click Save
Select this database connection (for example controller_fap_data_mart) and click the
run button (green triangle). This will launch the "Database Conversion Utility"
Check that the "UDL File" is correctly pointing to your FAP database
Click the "FAP DB" radio button
Click "Connect"
Click Create DB (see below)
If necessary, click Upgrade.
IMPORTANT: After doing the above steps, you should tidy up the new Database
Connection by moving the UDL file (for example C:\Program Files\ibm\cognos\c10\data\
controller_fap_data_mart.UDL) to a new folder (for example C:\Program
Files\ibm\cognos\FAP_UDL). If you do not do this, then users will see this in their list of
databases to choose from when they launch Controller.

use
8.6
62
Enable Audit Trail Triggers for FAP inside Controller
TIP: This is a new requirement from Controller 10.1 onwards - without enabling the audit trail FAP will
not work (because these functions use the same triggers and the same table).
Obtain a short period of downtime (nobody in Controller) and then:
Click "Maintain User Single mode"
Click "Maintain System Audit Log Configuration"
Tick (enable) the box "Enable tracking of data change details for Audit Trial and
Financial Analytics Publisher"
Click "OK" then "OK"
Click "Close"
8.7
Install the database client software on the TM1 server
TIP: Assuming that your TM1 server is a separate/dedicated server (not the same as the Controller
application server) then you will need to first install the database client software for your relational
database (for example the SQL 2005 native client).
This is required so that the next step (creating an ODBC Data Source for TM1) works.
The following assumes that you are using Microsoft SQL (not Oracle/DB2). For more precise
instructions on how to do this, refer back to earlier in this document:
Logon to the TM1 server as the COM+ Administrator account
Install the relevant database client (for example SQL 2005 Workstation Components
Client Components)
TIP: Make sure that you install the correct version (32-bit or 64-bit) depending on the
version of TM1 server that you are using
For example, if using TM1 server 64-bit, then make sure you install the 64-bit
version of the SQL 2005 client.
Patch to latest service pack

o
8.8
for example SQL 2005 SP4 = SQLServer2005SP4-KB2463332-x64-ENU.exe for 64-bit

version).
Creating an ODBC Data Source for TM1
You need to create an ODBC Data Source pointing to the Financial Analytics Publisher
database to be able to use the database from TM1.
The ODBC Data Source must be named FAP, and must be created on the same
server as the TM1 installation (i.e. the TM1 server).
TIP: In the (unlikely) scenario where your TM1 servers operating system is 64-bit but you have (for
some reason) chosen to install the 32-bit version of the TM1 server software, then in this (unlikely)
scenario then you would need to create a 32-bit ODBC source.
To do this, launch the file C:\Windows\SysWOW64\odbcad32.exe
For more information, see Technote: http://www-01.ibm.com/support/docview.wss?uid=swg21456320
Logon to the TM1 server as the COM+ Administrator account
Start Settings Control Panel
Open Administrative Tools
Open Data Sources (ODBC) and click tab System DSN
Click Add and choose the relevant database driver (for example SQL Native Client)
Click Finish

use
8.9
63
Configure the ODBC connection, for example:

o
Name: FAP
Description: Controller FAP Connector
Server: <SQL Server Name>
User SQL Server authentication
Enter SQL login (for example fastnet) and password
Tick Change the default database to:
Select the FAP trickle publish data mart database (for example
ControllerLive_FAP_data_mart)
Accept all the other default options
Click Test Data Source to confirm
OK.
Installing IBM Cognos TM1 10.1.0 software
NOTE: The following instructions are simple/basic instructions designed to get a system up
and running. The author recommends that readers please refer to the official TM1 10.1.0
documentation (http://public.dhe.ibm.com/software/data/cognos/documentation/docs/en/10.1.0/tm1/tm1_inst.pdf) for full details.
o
Add the Controller COM+ Windows user account (for example <DOMAIN>\Controller_System) to be a
member of the Local Administrators group on the TM1 Server
Logon to the dedicated TM1 server using the COM+ Windows user account (for example
<DOMAIN>\Controller_System), and perform all the following tasks when logged on as that user
account
Ensure that the TM1 servers regional settings (for example English UK) match the regional settings on
the Controller server
Ensure that IIS is installed (see earlier in this document for details on how to do this)
Disable Internet Explorer Enhanced Security Configuration
Install Microsoft Excel (2007 or 2010 32-bit recommended), with latest service pack
Install Microsoft .NET Framework 3.5 SP1 (dotnetfx35setup.exe. (See earlier in document for
details on how/where to download this from).

o
Modify the Web Service Extensions so that ASP.NET v2.0.5077 is set to Allowed
Download and install Microsoft Chart Controls for Microsoft .NET Framework 3.5 (MSChart.exe).
TIP: This is currently available from here: http://www.microsoft.com/engb/download/details.aspx?id=14422

o
Locate the TM1 10.1.0 installation media, and double-click on win32\issetup.exe
Next, I Agree, Next, Next
Inside the Component Selection screen, accept the default options (which will install almost all the
TM1 Server and client options) and click Next
Choose Next, Next to start the installation process.
After the file have finished copying, choose (tick) to launch Cognos Configuration and then click
Finish.
Once inside Cognos Configuration:

o
Inside the section "Local Configuration - Environment - TM1 Application Server" Modify the value
for "TM1 Application Server Gateway URI" so that the 'hostname' is replaced by the real server
name (for example its NetBIOS name).
Repeat the above for "TM1 Application Server Dispatcher URI"
Click "Save"
Click the close icon (cross) at the top-right corner, and choose Yes to start all the services.
Next, locate the Windows services and perform the following tasks:
o
Modify the Windows service IBM Cognos TM1 Admin Server to run under the Controller COM+
Windows user account (for example <Domain>\Controller_system)
Modify the Windows service IBM Cognos TM1 Application Server to run under the Controller
COM+ Windows user account (for example <Domain>\Controller_system)

use
64
8.10 Creating a new TM1 Server Data Location

To be able to run the Financial Analytics Publisher, you need to create a local TM1 Server
on the TM1 application server (admin host server). The TM1 Server manages requests from
TM1 clients by loading shared cubes into memory, managing security, sending data to
spreadsheets, updating cubes on request, and maintaining a log of changes to the
database.
TIP: The following instructions assume the software has been installed in the default location. If not, then please
modify as appropriate. In addition, modify <tm1servername> for the name of your TM1 server.
o
On the TM1 server, create a new folder (to store data) such as
D:\TM1Data\<tm1servername>
Copy the file "C:\Program

Files\Cognos\TM1\Custom\TM1Data\PlanSamp\Tm1s.cfg to the new folder (such as
D:\TM1Data\<tm1servername>\Tm1s.cfg)
TIP: Older versions of TM1 required a TM1s.lic file. This is no longer necessary since TM1 9.5. See TN 1419299.
Click Start Run and type the following (modify folder as necessary) and then press <Enter>:
notepad "D:\TM1Data\<tm1servername>\Tm1s.cfg "
Modify the DataBaseDirectory to the correct value (for example

D:\TM1Data\<tm1servername>\)
Modify the ServerName to the correct value (for example myservername)
Normally you can leave the PortNumber value as the default (12345)
o
However, if you have multiple services started (for example PortNumber=12345) then
you must make each server run under a unique TCP port number
For best results add (or modify the existing) the following setting (inside the [TM1S] section):
o GroupsCreationLimit=1000
TIP: This can be increased (default = 20, maximum = 65535) later if necessary. On a new default
installation of 9.5, you will notice that this line is commented out with a #, so you will have to
remove the # character before the entry.
8.11 Installing a TM1 Server as a Windows Service

To be able to update the TM1 cube with data, you must install a TM1 Server as a Windows
Service. When you install the TM1 Server it automatically installs a TM1 Server Service called
TM1 Admin Server, which is the main Windows service for the TM1 Server. In addition to
this, you must have a separate service installed to be able to write and read data from the
TM1 cube. To be able to update the TM1 cube, both services should have the status Started.
Click Start Run
CMD <Enter>
cd C:\Program Files\Cognos\TM1\bin <Enter>
type the following command, where tm1servername is the name of the TM1 server:
tm1sd.exe -install -n <tm1servername> -z "D:\TM1Data\tm1servername"

use
65
TIP: If the result set returns "TM1 Server / <tm1servername> installed", the service was
created successfully.
From the Start menu, select Control Panel, Administrative Tools, Services
In the Services dialog box, on the Standard tab, double-click on TM1 Server - Planning Sample
Modify this from Automatic to Disabled, then Apply and OK
Right-click on the service TM1 Admin Server and click Start
Double-click on TM1 Server / <tm1servername>
Modify this from Manual to Automatic
Click on Log on Tab
Modify from 'Local System account' to 'This Account'
Enter the COM+ user (for example '<DOMAIN>\Controller_system') and password
Click Apply
Click General tab then Start then OK
8.12 Installing and Configuring the Financial Analytics Publisher Service

You need to install the Financial Analytics Publisher Windows service (IBM Cognos FAP
Service) to be able to retrieve data from the Controller database and send it to TM1 and
the TM1 cube. You configure the Financial Analytics Publisher Service to point to a valid
Financial Analytics Publisher database.
NOTE: We shall assume that you want to install this FAP Service on the main Controller
application server (for example NOT the TM1 server).
Logon to the Controller Application server as an administrator (COM+ User)
Launch a Command Prompt, and change to the directory to where the FAPNTService.exe
file exists. By default this is:
Click Start Run
o
o
CMD
<Enter>
cd C:\Program Files\ibm\Cognos\c10\Server\FAP
Run the installUtil.exe utility to register FAPNTService.exe. By default this is:
C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\installUtil.exe
FAPNTService.exe
In the Set Service Login dialog box, set the following, then click OK:
o
Username: COM+ User (for example <Domain>\Controller_service)
Password: The COM+ users Windows password
Using NOTEPAD, open the file C:\Program Files\

ibm\Cognos\c10\Server\FAP\FAPService.properties
Edit the file to include the correct database, host, database type, user and password:
o
db=<database name> (SQL Server)

or <oracle sid> (Oracle)
TIP: This is the FAP data mart database which hosts the trickle published data (for example
called ControllerLive_FAP_data_mart).
o
host=<dns_to_the_FAP_database server>
Typically this is just the SQL server name, such as myserver
However, if you are using a SQL Server instance called instance1 on a

server called myserver then you would need to use the TCP port number
of the instance, such as: myserver:1434
use

o
66
dbType
For MS SQL, this should be sqlserver
For ORACLE, this should be oracle
user=<username> TIP: For example this is the SQL Login fastnet
passwd=<password> TIP: This would then the password of the user fastnet
TIP: The FAPService.properties file can be edited for an MS SQL Server FAP database, or an Oracle
FAP database connection.
Note: If you are using another JDBC provider, such as one from Microsoft, you must add the following parameters:
sqlserverDbConnectionType=<SQL Server connection type, defaults to JSQLConnect>
sqlserverProvider=<SQL Server provider, defaults to com.jnetdirect.jsql.JSQLDriver>
oracleDbConnectionType=<Oracle connection type, defaults to oracle>
oracleProvider=<Oracle provider, defaults to oracle.jdbc.driver.OracleDriver>
You also need to download a .jar file, and copy it to the directory where the lib folder exists.
From the Start menu, click Control Panel, Administrative Tools, Services
Right-click on IBM Cognos FAP Service, and click Properties.

Click Log on tab. Notice how the service is configured to run under the account which
installed the service. It is possible to change this to the Local System Account. However, the
author recommends configuring it to run under the COM+ User account (for example
<DOMAIN>\Controller_system).
In the Services dialog box, right-click IBM Cognos FAP Service and select Start to start the
Financial Analytics Publisher Service.
8.13 Installing the 32-bit TM1 Client

VITAL: When installing the TM1 Server on a 64-bit server it is necessary to install the 32-bit
TM1 client on the server where the Financial Analytics Publisher service is installed. This is to allow
the Financial Analytics Publisher service to communicate with the TM1 Server (as well as
to allow the user to create the required TM1 local servers). See Technote # 1456320.
This step is only required when the Financial Analytics Publisher service (which we
have installed on the Controller application server see above) and the TM1 application
server reside on different servers.
The TM1 client includes the .dll files that are required for the Financial Analytics Publisher
server and the client to communicate with the TM1 server.
Logon to the Controller application server
Install Microsoft Chart Controls for Microsoft .NET Framework 3.5

o
TIP: At the time of writing, this was available from here:
Double-click on MSChart.exe to install.
http://www.microsoft.com/en-gb/download/details.aspx?id=14422
Browse to the TM1 v10.1.0 32-bit installation media, and double-click on issetup.exe
Click Next, I agree, Next
Assuming you want to install in the default location, click Next then Yes

use
67
Deselect all options EXCEPT install *all* components of TM1 Client Tier, so it looks similar to:
Click Next, Next.
Click Finish.
8.14 Add a Path for the TM1 32-bit Client System Variables
On the Controller application server, right-click on My Computer, and select

Properties
Go to the Advanced (or Advanced system settings) tab
Click Environment Variables
Under System Variables, select Path, and click Edit
Append this with an extra entry at the end, for the path to the TM1\bin directory,
for example:
;C:\Program Files (x86)\ibm\cognos\tm1\bin
IMPORTANT: Do not forget to add the semi-colon (;). This separates all the entries listed in the Path.
For example, your Path may afterwards look similar to:
C:\Program
Files\Support
Tools\;C:\oracle\product\10.2.0\client_1\bin;%SystemRoot%\system32;%SystemRoot%;%SystemRoot%\System32\Wbem;
C:\Program Files\Microsoft SQL Server\80\Tools\Binn\;C:\Program Files\Microsoft SQL Server\90\Tools\binn\;C:\Program Files\Microsoft SQL
Server\90\DTS\Binn\;C:\Program
Files\Microsoft
SQL
Server\90\Tools\Binn\VSShell\Common7\IDE\;C:\Program
Files\Microsoft
Visual
Studio
8\Common7\IDE\PrivateAssemblies\;C:\Program Files (x86)\ibm\cognos\tm1\bin
Click OK to all dialog boxes that follow.
8.15 Install the Financial Analytics Publisher

In our scenario, where we have already installed the FAP client onto the Controller application
server as part of the default install (see earlier section) there is nothing more to do.
However, if the customer prefers to install/run the FAP client on an end users desktop
PC, then see Technote How to install the FAP Client on an end-user's desktop PC:
NOTE: When running either Microsoft SQL Server 2005 or Microsoft SQL Server 2008, the
SQLNCLI.1 SQL Native Provider for Microsoft SQL 2005 is required (SQLOLEDB.1 is no
longer supported).

use
68
8.16 Configure the Financial Analytics Publisher to publish data

Configuring the FAP system to start publishing Controller data is not normally something that
a Technical Consultant would perform when onsite for the initial Controller server installation.
Instead, this is normally done several weeks/months into a Controller implementation project
(after the system has been developed to such a stage that this stage can begin).
For more details on the steps required to configure a FAP publish, see the separate Proven
Practice document Installing FAP for IBM Cognos Controller 8.5 written by a colleague of
the author of this document.

use
69
9 Post-install Optimisations
9.1
Recommended: Proactive Server Reboots
Best practice: configure each server to reboot periodically, to minimise risks from memory leaks etc. Recommend
doing this via scheduled tasks pointing to a batch file e.g. c:\reboot\shutdown.exe /r
9.2
Citrix server: once a week (e.g. every Sunday morning @ 2am)
Application server: once a week
SQL 2005/8 server: typically not necessary, but ideally once a month
Recommended: Split the COM+ application
IMPORTANT: Before making any changes, it is recommended that you test that the Controller functionality works
BEFORE *and* after. By doing this, it will reduce (in the long term) the time taken to troubleshoot any future problems.
This section explains how to split the single COM+ application called IBMCOGNOSCONTROLLER into 2
separate COM+ applications.
Many customers find that they do not need to perform this splitting step
However, other customers may encounter performance issues (such as the entire system not
responding for all users during a consolidation process) unless this section is performed. See
(internal) Technote 1367965 for more information.
TIP:
Splitting IBMCOGNOSCONTROLLER into 2 separate applications ON THE SAME PHYSICAL SERVER helps to
optimize the server to cope with high demands/loads. See Technote #1440369 for more details including printscreens.
[An alternative solution is to have 2 PHYISICALLY SEPARATE servers, and splitting the 2 COM+ applications
over these two physically different application servers (Server#1 hosts IBMCOGNOSCONTROLLER, Server #2
hosts COGNOSVFP). However, in the authors experience, most customers actually benefit more by splitting
the COM+ on a single application server instead].
How to split the COM+ application in two on a single Controller application server:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
Ensure that no users are using Controller (downtime)

Logon to the application server as an administrator
Click on 'Start - Settings - Control Panel - Administrative Tools'
Launch 'Component Services'
Expand the 'top row' (by clicking on the '+' symbols) until you reach the COM+ application called
"IBMCOGNOSCONTROLLER"
Expand this, and expand Roles
Make a note of the name of the group under Roles (for example called CognosUsers)
Make a note of the users listed underneath (typically they will be Everyone and NT AUTHORITY\system)
Right-click on IBMCOGNOSCONTROLLER and choose properties
Click on tab Identity
Make a note of the username (for example DOMAIN\Controller_system)
Ensure that you know the correct password for this user before continuing
Close the screen, and right-click on COM+ Applications and choose 'New Application
In the wizard, choose 'Next' then click 'Create an Empty Application'
By convention, we shall name the application 'COGNOSVFP' and ensure 'server application' is selected
Choose 'This user', and use the same Windows user (also known as the COM+ user or "service account") that we
located earlier:
Click Next
At the next screen, highlight 'CreatorOwner' and choose 'remove'
Then click 'add role' and type in the SAME name as the role that we saw earlier (for example 'CognosUsers') then
click OK.
Click 'Next'
At the next screen, remove any user listed, and then add the entries that we saw earlier in the
IBMCOGNOSCONTROLLER role. TIP: You may need to simply type in System (not NT AUTHORITY\system)
to get system to be recognised (depending on your environment).
Click Next, Finish
Expand the IBMCOGNOSCONTROLLER application, and open Components. Several hundred individual icons
will appear on the right-hand side:
Highlight the 2 icons called frangovfp.cglobvar and frangovfp.main
Right-click and choose move
In the Move components screen, ensure that COGNOSVFP is selected, and click OK:
Expand COGNOSVFP Components
Select both components, and right-click and choose properties

use
70
29. Click on 'Security' tab, and then tick both boxes 'Enforce' and 'CognosUsers'
30. Click OK
31. Reboot the application server. You are now ready to test.
It is particularly important to test consolidations afterwards, since this is the main

function that is affected by the above.
9.3
Optional: Enable Email Functionality
End-users can use the email functionality inside Controller 8 for sending things like reports,
intercompany balances and export files via e-mail. If you know the email server settings, then
you can perform the following:

Launch Controller
Maintain Configuration General
Click on General 3 tab
Fill in the details (e.g. see example below)
NOTE:
You will not be able to save the above changes on a blank database until you first configure some other
settings!
o
e.g. click on Reconcile and set both the balance sheet and P&L to an appropriate value (e.g.
1001 sales)

Inside the official Controller 8 help file, it has references to Outlook. This seems to be a mistake in the help
file. Controller 8 is not able to send emails via MAPI. Instead, it only sends via SMTP

make sure that you have an email address defined for the user (that you have logged in as) in
Maintain/Rights/Users:
you also require a properly configured SMTP server, which trusts SMTP messages sent from the
users/computer(s)

use
71
TESTING: The easiest way to test whether the above works is to go into:

9.4
Transfer Export Structures

Inside the box, ensure that you type in a valid email address (e.g. see below):
Optional: Change Controller Standard Reports to use ISAPI not

CGI technology
IMPORTANT: Before making any changes, please test that standard reports work OK for CGI.
This will ensure that you do not waste extra time troubleshooting if Standard Reports fail to work on ISAPI afterwards.
TIP: ISAPI is a Microsoft technology, optimised for Microsoft websites (IIS). By default, Cognos products use CGI
technology which is compatible with IIS and Apache etc., but not optimised for Microsoft.
For most scenarios, changing from using CGI to ISAPI will provide no noticeable benefit. HOWEVER, there *are* occasions
where it is useful to make this change.
Scenario 1 If deploying Controller via RDP (Microsoft Terminal Services), then sometimes using CGI will
cause standard reports and single-signon to fail. NOTE: The problem does *not* affect deploying Controller
via ICA (Citrix) protocols it *only* affects RDP (Microsoft) Terminal Services protocols. For more information,
see
the
*internal*
KB
article
1026113,
http://support.microsoft.com/default.aspx?scid=kb;en-us;829011.
or
external
Microsoft
article
Scenario 2 If deploying Controller via using a gateway (e.g. DMZ) configuration (i.e. using the t=controller
parameter), then using ISAPI can dramatically reduce the CPU overhead on the gateway webserver. For more
information on the t= parameter, see IBM Technote #1347535 or the (internal only) KB article 1034531.

Launch Cognos Configuration

Locate Environment and then search for Gateway URI
Modify entry to have cognosisapi.dll instead of cognos.cgi at the end
Click save
Restart the Cognos BI service (by clicking on restart icon at top)

use
72
The next steps depend on which operating system you are using:
Windows 2003:
Launch the following:
Notepad.exe c:\program
program files
files\ibm\Cognos\c10\webcontent\default.htm
Modify the entry from cognos.cgi to cognosisapi.d
cognosisapi.dll instead:
Repeat the above for the file c:\program files\

\ibm\cognos\c10\webcontent\index.html
Windows 2008:
TIP:: For more details on these steps, see Technote 1504282 (http://www-01.ibm.com/support/docview.wss?uid=swg21504282).
1) Ensure "Allow unspecified ISAPI modules is selected"
Right-click
click on 'My Computer' and choose 'Manage'. Expand 'Server Manager - Roles - Web Server (IIS)'
Click 'Internet Information Services'. Inside the 'Connections' section, highlight your server (i.e. click on its SERVERNAME)
Double-click
click on ISAPI and CGI restrictions (in the right
right-hand pane)
Under Actions on the right hand screen select "Edit Feature Settings" and make sure ""Allow
Allow unspecified ISAPI modules"
modules is selected.
2) Configure "Module Mapping"
In the left-hand
hand "Connection" pane, highlight/select the virtual directory cgi-bin
Double-click
click on Handler Mappings (in the right
right-hand pane). Click on Add Module Mapping
Enter the values similar to the following (modif

(modify
y the path as appropriate for your version of Controller and where you have installed it):
Request path: cognosisapi.dll
Module: IsapiModule
Executable (optional): C:\Program

Program Files (x86)
(x86)\ibm\cognos\c10\cgi-bin\cognosisapi.dll
Name: ISAPI-cognos
Click OK then (if asked) Yes.
3) Double-check setting for 'Enable 32-Bit

Bit Applications'
If running a 64-bit
bit version of Windows 2008, then (inside IIS administration, under "Application Pools") select your application pool for the cognos
virtual directories
For example, if using the default

ault "DefaultAppPool" then (on the right-hand
right hand side) click "Set Application Pool Defaults" and ensure that ""Enable 32Bit Applications" is set to "True"
4) Modify 'allowPathInfo' setting
Using Windows Explorer, open the cgi-bin

bin folder (d
(default = C:\Program Files\ibm\cognos\c10\cgi-bin)
Launch NOTEPAD.EXE and edit the file web.config.
Add the text allowPathInfo=true near the end of the line. For example, it would change to:
<add name="ISAPI-cognos"
cognos" path="cognosisapi.dll" verb="*" modules="IsapiModule"
modu
scriptProcessor="C:\Program
Program Files (x86)\cognos\c8\cgi(x86)
bin\cognosisapi.dll"
cognosisapi.dll" resourceType="Unspecified" preCondition="bitness32" allowPathInfo="true" />
5) Restart IIS
Click "START - RUN"
Type: CMD
Type: IISRESET
<Enter>
<Enter>
6) Modify "default.htm" and "index.html" inside the /webcontent directory
Launch the following (modify the file location as appropriate): Notepad.exe C:\Program Files (x86)\ibm\cognos\c10
c10\webcontent\default.htm
Modify the entry from cognos.cgi to cogn

cognosisapi.dll instead:
Repeat the above for the file C:\Program

Program Files (x86)
(x86)\ibm\cognos\c10\webcontent\index.html

use

Finally, change the Report Server setting (inside Controller Configuration) to use cognosisapi.dll:

use
73
74
10 Creating a Software Repository Share

10.1 Overview
In previous (Controller 8.x) versions of this best practice guide, to make future client installs
easier the author recommended that you should create and populate a Controller software
repository share, from which to install the software in the future.
This is still a sensible idea for some customers. However, the author has changed his
recommended client installation method from Controller 10.1 onwards, which means that
there is now less need to create this share.
For full details, please see the authors companion document How to install the IBM
Cognos Controller 10.1.1 client - QUICK START guide - Proven
Practice.

use
75
11 Testing on Application Server

11.1 Install Client Software on the Application Server
You will need to:
Disable/Bypass proxy inside Internet Explorer settings
Install CCRLocalClient.MSI (located inside folder \webcontent\ccr)
When asked for WSSUrl & HelpUrl, typically enter values similar to:
WSS Url: http://<servername>/ibmcognos/controllerserver
Help Url: http://<servername>/ibmcognos/ControllerHelp
You are asked for CACHE DIR.
For 95% of customers, simply leave this blank
However, some customers (especially those who redirect their %APPDATA% variable) may
want to change this value. See Technote #1409414.
Ideally (assuming you have a 64-bit operating system) you should modify CCR.EXE to enable
LAA.
For more details, see here: http://www-01.ibm.com/support/docview.wss?uid=swg21579579
For more instructions on how to achieve this, see my companion document How to
install the IBM Cognos Controller 10.1.1 client - QUICK START guide Proven Practice.
11.2 Launch Controller and perform basic testing on application server

itself
The amount of testing that is possible depends on whether you have only blank Controller
databases, or a fully-populated database.
Launch Controller Configuration
In the Explorer window, select COM+ Server
In the right pane, enter the Identity and Users for the application, and click save.
In the Explorer window, select Report Server, and enter the ReportNet server you wish to use
Choose the controller package, and click save (there should be no error)
o
o
There should be no error

Click the check (tick) button (there should be no error)
Assuming that you have installed the local client on the Controller application server (see earlier section) then
launch Controller from the Start Menu icon:

use

Login Test
o
In the database selection page, choose the new database you've created in the previous step
Enter ADM as the user and kbs as the password
If the main application window appears, login is successful

From the Help main menu, select Contents

If the HTML user guide is displayed, the help files are ok
System Information Test

o
From the Help main menu, select System Information
If the information is correct, system information is successful
Forms and Data Loading/Saving Test

o
You may be asked to Optimise the database. If so, go into Single User Mode and
do this
Documentation Test
o
76
From the Maintain menu item, select Account Structure > Define...
Click the New button
Enter 1001 as the Code - edit Field
Enter Sales as the Name - Group edit field
Enter Sales as the Short Name - Group edit field
Click the ... button for Account Type, and select Income as the type
Click Save then close
From the Maintain menu item, select Account Structure > Define...
If the Sales account is available, the data loading and saving is successful
Standard System Reports Test #1a (Regular reports)

o
From the Maintain menu item, select Account Structure > Reports...
Select Codes from the Report Selections group
Select Texts from the Additional Reports group
Click the ... button for the Account edit field in the Account/From Selection group
Click the Sales account, then click OK button (the green check mark)
Click the preview button

If the Report appears in PDF format, the report execution is successful
NB: You may find that the report server fails at this point. Try repeating the same thing (the report server may not
have started yet). Also, you may have to launch Adobe Acrobat reader and accept the license agreement first.
Standard System Reports Test #1b

o
Maintain , Account Structure > Verify...
tick 'check account structure' and click Preview
IMPORTANT: You may now see a screen similar to the following:
You MUST leave the tick box as it is (i.e. ticked/checked), and click yes. This is because the
information between the client and the application server is all sent via HTTP (usually via Internet Explorer settings)
and therefore if you clicked no it will forever block traffic in the future!!!
ALSO: If you see a message Page cannot be displayed during the above testing, then this is normally because you
have forgotten to change the server name from localhost to <servername> - see earlier section entitled Configure
the location of the Cognos Report server
Standard System Reports Test #1c

o
Maintain company structure - reports
tick tree structure and click Preview

use
77
Standard Reports Test #2 (Result Sets Processed by VFPCOM)

o
From the Group menu item, select Reconcile > Intercompany Balances...
In the Report Number edit field, enter 2
Click the Detailed check box for the Report Content item
In the Group edit field, enter 1000
Click the preview button
If the Report appears in PDF format, the report execution is successful
TIP: If this section fails, see IBM Technote #1347488. This will explain how to ensure that msvcr71.dll is
correctly registered, and also REGSVR32 VFPCOM.DLL.
Test Excel Link

o
From the Reports menu item, select Run...
On the Reports and Forms tab, select Report
Select both Show Rows and Show Columns inside the show zero values
Click on the preview button

If a print preview in Excel appears correct, the test of the Excel Link is
successful
11.3 Troubleshooting
One of the most useful tests that you can perform is to test whether your Controller application server
(ControllerProxy Server, a.k.a. WS server) is responding:
In a web browser, type:

http://<servername>/ibmcognos/ControllerServer/CCRWS.asmx
It should respond with a screen with a list of lots of services that are available.

use
78
11.4 General Windows (non-Cognos specific) Performance testing

If time permits, it would be ideal if you could check that the application/SQL servers
demonstrate good I/O network performance (etc.) by performing tests such as the following:
TIP: The author has personally seen many high-performance server environments ruined by using the wrong network
card speed (e.g. auto-detect instead of 100Mb Full Duplex or Gigabit.
File copy test
Copy a file from a remote (WAN) client PC to the front (application) gateway server
o
make sure you have a minimum throughput of 256-500kb per sec
1mb is better
10mb is optimal
Copy a file from each server to each other server

o
Copy a large file (e.g. 100mb+) from the main application server to database (e.g. SQL) server, and
vice versa
make sure you have a minimum throughput of 10mb
Make sure to test both ways from each physical server, as switch ports can be misconfigured for inbound and outbound per port.
(20 when using nic teaming, and 30 with a gigabyte nic)
Check network cards - make sure the server NIC is set correctly (e.g. 100mb FD minimum if supported by
switch)
Check File and printer sharing is set on Maximise throughput for network applications.
Controller will benefit if the NIC is set on gigabit (if supported by switch)
To test if SQL server is overloaded, use perfmon (administrative tools) on the SQL server to check the following
average performance counters:
Memory: Available Bytes
not under 5mb; between 5 and 10mb free is normal (add physical memory)
Memory: Pages/sec
not over 20 (ad physical memory)
Physical Disk: % Disk time
Physical Disk: Avg. Disk Queue Length
Processor: % Processor Time

large level2 cache like 2mb)
not over 80% longer then 10 min. (add or upgrade cpus - preferably with
System: Processor Queue Length
not over 2 PER PROCESSOR. (add or upgrade cpus)
SQL Server Buffer manager: Buffer Cache Hit Ratio*

physical memory)
not over 55% longer then 10 min. (add or change disk setup)
not over 2 longer then 10 min. (add or change disk setup)
not under 90%; the closer to 99 the better. (add
* This performance counter is selectable during SQL server installation.

use
79
12 Install Client Software on Users PC

Logon to the end users PC using an Administrative account, follow the instructions that are
defined inside my companion document How to install the IBM Cognos
Controller 10.1 client - QUICK START guide - Proven Practice.
12.1 Important: Ensure that the customer is given good instructions on

how to install the Controller client
IMPORTANT: It is absolutely VITAL that the person installing Controller provides the customer
with GOOD client installation instructions. Failure to do so will SERIOUSLY increase the effort
required to install the Controller client on users PCs, which (in turn) will SERIOUSLY increase the risk
of mistakes/errors/issues later.
Provide the I.T. department with a copy of How to install the IBM Cognos
Controller 10.1 client - QUICK START guide - Proven Practice and (after
testing Controller on the application server itself first) go through the procedure on several
client PCs to ensure that Controller installs successfully on multiple client PCs, before leaving
site.
Provide the customer with any extra customer-specific notes, as necessary.
13 Basic Testing for each Client PC installation

Ideally, you could launch Controller as the Administrative user (the one that you
installed the software with) first. After the testing, logoff and logon as the normal
end-user and test as him/herself.
Assuming that Controller worked OK on the application server, it is almost certain
that each client PC will be OK, so long as the software is installed as per my best
practice document. Therefore, the following 2 simple tests should be enough:
13.1 Main Controller program

Launch Controller from URL and login. Click on Help About Controller
and then Help System Info and ensure that the Controller version
matches what you expect.
13.2 Excel link
Launch Excel. Click on Help About Controller link and ensure that the
Controller link version matches what you expect.
14 Installing on a Citrix (or Terminal Services) server

14.1 Overview
To achieve this, follow the instructions that are defined inside my companion document How
to install the IBM Cognos Controller 10.1 client - QUICK START guide
- Proven Practice.

use
80
15 Appendices Further Reading

15.1 Potential Additions/Enhancements/Optimisations
The following are things that you could potentially do to your Controller system,
together with some suggestions for further reading (other documentation) that will
help you understand how to accomplish it.
IMPORTANT: Before making any changes, please test that all Controller functionality works BEFORE *and* after. By
doing this, it will reduce (in the long term) the time taken to troubleshoot any future problems.
Enable IIS Compression

o
Useful if deploying Controller client over a WAN (e.g. deploying Controller over the
internet, without using Citrix)
See IBM Technote 1347307 for more details.
Change Security from Native to Cognos 8 and utilise Active Directory or Access
Manager namespace, and/or Single Sign On (SSO)
o See IBM Technotes 1380097, 1380098 & 1380099 for more details.
Deploying ControllerAdmin.MSI (or ControllerClient.MSI) instead of other client files.

o
Typically, the author recommends that you should use CCRLocalClient.MSI
However, see IBM Technote 1371088 for details on what the other client types are
designed for.
Split Directory Install

o Full details to come in future version of this document, but some information is located
inside Technote 1414473.
Distributed Installations
o Full details to come in future version of this document, but some very useful information is
located inside Technote 1367311.
Enabling use of SSL on a Controller Gateway

o
See IBM Technote 1345570.
Deploy ControllerConv.MSI *only* if migrating from Controller 2.x to 8.x

o
This gives you an extra menu item inside Controller itself

Launch Controller
Maintain Special Utilities Convert Reports to New Design
Click Maintain User Single Mode
Click green tick to proceed
This takes approx 1 to 20 minutes (or so)
Maintain Special Utilities Convert Forms to New Design
Click blue play button to proceed
This takes approx 30 minutes or up to an entire day, depending on the size of

the forms!
Configure for Data Mart publishing
See IBM Technote 1347788.

use

01i.installing &amp; Configuring IBM Cognos Controller 10.1.1 Server - Proven Practice

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

01i.installing &amp; Configuring IBM Cognos Controller 10.1.1 Server - Proven Practice

Загружено:

Авторское право:

Доступные форматы

Proven Practice

Installing & Configuring IBM

Installing & Configuring IBM Cognos Controller 10.1.1 server

Copyright and Trademarks

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

IMPORTANT NOTES, TIPS AND WARNINGS ................................................. 8

INITIAL SERVER PREREQUISITES .............................................................. 10

SERVER HARDWARE RECOMMENDATIONS .................................................................... 10

RECOMMENDED SERVER SYSTEM SETTINGS ............................................. 23

CREATE A CONTROLLER SYSTEM WINDOWS DOMAIN USER ............................................... 23

DATABASE PREPARATION .......................................................................... 32

INSTALLATION OF CONTROLLER SERVER .................................................. 38

Installing & Configuring IBM Cognos Controller 10.1.1 server

INSTALL/APPLY REQUIRED INTERIM FIX ...................................................................... 40

CONFIGURATION OF CONTROLLER SERVER .............................................. 41

INSTALL AND CONFIGURE FINANCIAL ANALYTICS PUBLISH (FAP) .......... 59

POST-INSTALL OPTIMISATIONS ................................................................ 69

RECOMMENDED: PROACTIVE SERVER REBOOTS ............................................................ 69

CREATING A SOFTWARE REPOSITORY SHARE ......................................... 74

TESTING ON APPLICATION SERVER ........................................................... 75

INSTALL CLIENT SOFTWARE ON THE APPLICATION SERVER ............................................... 75

INSTALL CLIENT SOFTWARE ON USERS PC ............................................... 79

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

BASIC TESTING FOR EACH CLIENT PC INSTALLATION .............................. 79

MAIN CONTROLLER PROGRAM ................................................................................. 79

INSTALLING ON A CITRIX (OR TERMINAL SERVICES) SERVER ................. 79

APPENDICES FURTHER READING ............................................................ 80

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

In other words, the customer accepts that IBMs recommendation is always to

Exclusions and Exceptions

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

This document is not intended to entirely replace the official standard

ctrl_arch.pdf Architecture and Deployment guide

ctrl_inst.pdf Installation and Configuration guide

qrc_ctrl_inst.pdf Getting Started Installation guide

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

2 Important Notes, Tips and WARNINGS

Do not ignore/skip any sections of this document, unless you

It is perfectly possible to upgrade Controller and get it (initially) working without

In addition, there are will be VITAL information inside red boxes

Many of the authors tips and recommendations refer to IBMs excellent

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

Server name conventions FQDN and NetBIOS

WARNING: To summarise, customers should typically use NetBIOS or FQDN names

throughout their entire configuration/deployment, but not both (a mixture).

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

3 Initial Server Prerequisites

Server hardware recommendations

VMWare / ESX (and other virtual platforms)

Increasingly, customers are choosing to deploy Controller on virtual hardware. Naturally,

Controller is a 32-bit application, but it is compatible to be run on a 64-bit Windows operating

Suitable for PUBLIC (external)

Installing & Configuring IBM Cognos Controller 10.1.1 server

TIP: For more information, see IBM Technote 1374283.

In other words, when using a 64-bit operating system

Windows 2003 Support Tools 32 bit

SOAP Toolkit 32 bit

01i.installing & Configuring IBM Cognos Controller 10.1.1 Server - Proven Practice

01i.installing & Configuring IBM Cognos Controller 10.1.1 Server - Proven Practice