Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
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.
Contents
INTRODUCTION........................................................................................................ 6
1.1
1.2
1.3
PURPOSE ............................................................................................................ 6
APPLICABILITY ..................................................................................................... 6
EXCLUSIONS AND EXCEPTIONS .................................................................................. 6
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
3.1
3.2
3.3
3.4
3.5
3.6
4.1
4.2
4.3
4.4
4.5
4.6
4.7
4.8
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
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
Suitable for PUBLIC (external)
use
6.5
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
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
9.1
9.2
9.3
9.4
10
10.1
OVERVIEW ........................................................................................................ 74
11
11.1
11.2
11.3
11.4
12
12.1
IMPORTANT: ENSURE THAT THE CUSTOMER IS GIVEN GOOD INSTRUCTIONS ON HOW TO INSTALL THE
CONTROLLER CLIENT........................................................................................................ 79
13
13.1
13.2
14
14.1
OVERVIEW ........................................................................................................ 79
15
15.1
POTENTIAL ADDITIONS/ENHANCEMENTS/OPTIMISATIONS................................................ 80
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
1.2
Applicability
This document is based on installing Controller 10.1.1 RTM (released June
2012)
1.3
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.
TIP: Ignoring the tips may cause the Controller system to be slow, unreliable or have longterm issues.
WARNING: If the information in these boxes is ignored, the Controller system is likely not to work
at all correctly.
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
2.2
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.
10
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
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
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.
11
This document shall include some tips for using 64-bit operating systems wherever you see
the following graphic:
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.
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
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
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):
3.6
12
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:
Tick 'Web Server (IIS) Support' and click 'Add Required Role Services'
Click Next
13
Launch http://servername and ensure that the default website appears successfully before
proceeding to the next stage.
On Windows 2003: The following
o
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
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.
3.7
14
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.
This is *especially* vital for Excel 2007. For more details, see IBM Technote 1394945.
http://www-01.ibm.com/support/docview.wss?uid=swg24034120
15
For Windows 2003 x86, .NET 2.0 SP2 is the file NetFx20SP2_x86.exe (approx 24Mb)
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.
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.
16
=> 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.
2.
3.
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.
3.8
17
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).
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
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
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
18
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.
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.
Launch setup.exe
Underneath "IBM Data Server Client Version 9.7" choose "Install New"
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)
3.9
19
WARNING: Afterwards, you *must* launch Acrobat Reader and accept the license agreement,
otherwise you may have unexpected issues later!
20
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
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
21
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")
Double-click on "Do not forcefully unload the user registry at user logoff"
22
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
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.
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
23
The Controller COM+ application must run under a Domain User account (to allow advanced
Controller functionality to work as intended).
o
o
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
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
c:\windows\Microsoft.NET\Framework64\v2.0.50727
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'
25
In Windows 2003 x64, open IIS Manager (Start > Control Panel > Administrative Tools > Internet
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'
4.3
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
Tick the relevant box (either Allow unspecified CGI modules or Allow unspecified
ISAPI modules) depending on which technology you intend to use.
Click OK.
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
Or C:\Program Files\Ibm\Cognos\c10\cgi-bin\cognosisapi.dll
26
27
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:
Or C:\Program Files\ibm\Cognos\c10\cgi-bin\cognosisapi.dll
4.4
Under 'Process Model', change the setting for 'Idle Time-out (minutes)' from the
default (20) to 60
Increase IIS timeout from default (20 mins) to 60 mins (see below):
28
4.5
29
NOTE: This section *only* required when using Windows 2008 (i.e. not Windows 2003).
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
4.6
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
Inside Control Panel Add/Remove Programs Windows Components, untick the box Internet
Explorer Enhanced Security Configuration.
Click Advanced tab and UNTICK Check for publishers certificate revocation:
4.8
31
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:
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
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
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
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.
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.
5.2
34
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).
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).
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.
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.
5.4
35
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
Create blank SQL database for Controller Cognos 8 BI ContentStore (i.e. report server configuration
data)
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.
36
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.
2.
model required since SQL will occasionally recreate tempdb from a copy of model, e.g.
whenever SQL is restarted
3.
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).
5.5
37
Modify the share and NTFS permissions of it so that the Controller service account user (for example
domain\controller_system) has full control rights
5.6
SQL
server
(e.g.
called
controller_BI_share)
and
share
it
(e.g.
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:
TIP: change *both* the users fastnet and fastnet for the name of your SQL login (e.g. cognos or whatever).
5.7
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:
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.
38
6.1
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.
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.
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
ojdbc14.jar
IBM DB2
DB2 driver
db2jcc.jar
6.4
39
TIP: The following assumes that there is only 1 application server, with all components
I agree, Next
Choose the installation location (default C:\Program Files\ibm\cognos\c10), 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
After the installation has completed, leave the option Start Cognos Configuration deselected and
click the Finish button
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
6.5
You will have to close Component Services and re-launch the tool to see the change
Important: It is VITAL that the patch (IF) is installed without any IBM Cognos-related
services/processes running.
Extract the Interim Fix file (for example Controller 10.1.1 IF1 = up_cntrl_win32_10.1.6235.100_ml.tar.gz)
Follow the directions in the installation wizard, installing in the same location as used before
Afterwards, reboot the application server (to ensure that all files are 100% registered and to allow the
stopped Windows services to start again).
41
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
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
Click the Environment Variables button, and locate the System Variables section
NOTE: Youll have to reboot the server now for this JAVA_HOME variable change to take place
7.3
42
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
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:
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
it
BACKUP_MODIFIED.ccr-
7.5
43
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
7.7
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.
7.8
44
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
Click OK
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
A new dialog will appear. Enter your SQL login name (for example fastnet) in the Name edit
field
Enter a password
Set ControllerContentStore in the Database: drop down in the Defaults section, and Click OK
Click Yes
Select db_owner and db_ddladmin in the Permit in Database Role, and Click OK
In the tree control in the left pane expand (machine name) > Web Sites > Default
Web Site
Click OK
45
Click OK.
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)
In the tree control in the left pane expand (machine name) > Web Sites > Default Web
Site
Enter ibmcognos in the Alias edit field and click the Next button
Keep the default permissions (Read only) and click the Next button, then Finish
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
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
47
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
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.
7.9
48
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
Tick the box next to the Controller entry, and click Next
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.
49
path
(typically
C:\Program
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
50
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
51
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
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
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)
user
in
the
User
edit
field
(e.g.
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
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)
In the tree control in the left pane, expand Cognos Controller Configuration > Web Services
Server > Database Connections
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)
Provider:
SQLNCLI.1
53
TIP:
o
NOTE:
User ID: The user ID used in the Create Controller Database step (e.g. fastnet)
Initial catalog: The name of the database created previously step (e.g. ControllerLive)
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
to http://<servername>/ibmcognos/...
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!
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.
55
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
In other words, modify the line to read: <add fileExtension=".config" allowed="true" />
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
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" />
57
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:
58
Ensure that the "UDL File" is pointing to the relevant database connection (for example: C:\Program
Files\ibm\cognos\c10\Data\default.udl)
Click "Connect"
Because this database is a brand new blank database, the Current Version will be set to zero (0). Therefore,
click Create DB:
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
59
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:
http://www-01.ibm.com/support/docview.wss?uid=swg21505119
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
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
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.
8.3
60
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,
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
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).
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
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.
Name: controller_fap_data_mart
Provider: SQLNCLI.1
Password: <password>
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 "Connect"
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
8.6
62
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:
Tick (enable) the box "Enable tracking of data change details for Audit Trial and
Financial Analytics Publisher"
Click "Close"
8.7
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:
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.
8.8
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.
Click Add and choose the relevant database driver (for example SQL Native Client)
Click Finish
8.9
63
Name: FAP
Select the FAP trickle publish data mart database (for example
ControllerLive_FAP_data_mart)
OK.
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)
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
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).
Inside the Component Selection screen, accept the default options (which will install almost all the
TM1 Server and client options) and click Next
After the file have finished copying, choose (tick) to launch Cognos Configuration and then click
Finish.
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).
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)
64
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>
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>:
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.
CMD <Enter>
type the following command, where tm1servername is the name of the TM1 server:
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
Click Apply
NOTE: We shall assume that you want to install this FAP Service on the main Controller
application server (for example NOT the TM1 server).
Launch a Command Prompt, and change to the directory to where the FAPNTService.exe
file exists. By default this is:
o
o
CMD
<Enter>
cd C:\Program Files\ibm\Cognos\c10\Server\FAP
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
Edit the file to include the correct database, host, database type, user and password:
o
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>
66
dbType
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:
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
In the Services dialog box, right-click IBM Cognos FAP Service and select Start to start the
Financial Analytics Publisher Service.
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.
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
Assuming you want to install in the default location, click Next then Yes
67
Deselect all options EXCEPT install *all* components of TM1 Client Tier, so it looks similar to:
Click Finish.
8.14 Add a Path for the TM1 32-bit Client System Variables
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
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:
http://www-01.ibm.com/support/docview.wss?uid=swg21505119
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).
68
69
9 Post-install Optimisations
9.1
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
SQL 2005/8 server: typically not necessary, but ideally once a month
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.
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.
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)
71
TESTING: The easiest way to test whether the above works is to go into:
9.4
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.
Click save
Restart the Cognos BI service (by clicking on restart icon at top)
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:
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.
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
Module: IsapiModule
Name: ISAPI-cognos
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
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
Type: CMD
Type: IISRESET
<Enter>
<Enter>
Launch the following (modify the file location as appropriate): Notepad.exe C:\Program Files (x86)\ibm\cognos\c10
c10\webcontent\default.htm
73
74
75
When asked for WSSUrl & HelpUrl, typically enter values similar to:
WSS Url: http://<servername>/ibmcognos/controllerserver
Help Url: http://<servername>/ibmcognos/ControllerHelp
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.
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
Assuming that you have installed the local client on the Controller application server (see earlier section) then
launch Controller from the Start Menu icon:
Login Test
o
In the database selection page, choose the new database you've created in the previous step
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 ... button for Account Type, and select Income as the type
From the Maintain menu item, select Account Structure > Define...
If the Sales account is available, the data loading and saving is successful
From the Maintain menu item, select Account Structure > Reports...
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)
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.
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
77
From the Group menu item, select Reconcile > Intercompany Balances...
Click the Detailed check box for the Report Content item
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.
Select both Show Rows and Show Columns inside the show zero values
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:
It should respond with a screen with a list of lots of services that are available.
78
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
1mb is better
10mb is optimal
Copy a large file (e.g. 100mb+) from the main application server to database (e.g. SQL) server, and
vice versa
Make sure to test both ways from each physical server, as switch ports can be misconfigured for inbound and outbound per port.
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:
not under 5mb; between 5 and 10mb free is normal (add physical memory)
Memory: Pages/sec
not over 80% longer then 10 min. (add or upgrade cpus - preferably with
not over 55% longer then 10 min. (add or change disk setup)
not over 2 longer then 10 min. (add or change disk setup)
79
80
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.
Useful if deploying Controller client over a WAN (e.g. deploying Controller over the
internet, without using Citrix)
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.
However, see IBM Technote 1371088 for details on what the other client types are
designed for.
Distributed Installations
o Full details to come in future version of this document, but some very useful information is
located inside Technote 1367311.
Launch Controller