IBM Support

How to install Controller Web

How To


Summary

Customer is installing IBM Cognos Controller server. How can they install/configure the Controller Web portion?

Objective

Customer would like to install and configure the IBM Cognos Controller 'Controller Web' feature.

Environment

Controller Web was first introduced in Controller 10.3.0.

Controller Web changed significantly from version 10.4.0 onwards, because it now has two separate services:

image-20181217143830-1

  • Controller Web ("Controller Web")
  • Controller Web UI ("Controller Web Frontend")

Steps

The steps vary depending on what version of Controller you are trying to install.

    

    Controller 10.3.0

    IMPORTANT: Controller Web is not supported when using Oracle.

    Official IBM knowledgecenter instructions here: https://www.ibm.com/support/knowledgecenter/en/SS9S6B_10.3.0/com.ibm.swg.ba.cognos.ctrl_inst.10.3.0.doc/t_contrweb_configure.html

    • Alternatively, customers can use the IBM Support 'best practice' guidelines, which are inside the document "10.3.0 Installing & Configuring IBM Cognos Controller 10.3.0 server - Support Proven Practice" which is available from separate IBM Technote #1608353.

    Controller 10.3.1

    IMPORTANT: Controller Web is not supported when using Oracle.

    Official IBM knowledgecenter instructions here: https://www.ibm.com/support/knowledgecenter/en/SS9S6B_10.3.1/com.ibm.swg.ba.cognos.ctrl_inst.10.3.1.doc/t_contrweb_configure.html

    • Alternatively, customers can use the IBM Support 'best practice' guidelines, which are inside the document "Installing & Configuring IBM Cognos Controller 10.3.1 server - Support Proven Practice" which is available from separate IBM Technote #1608353.

    Controller 10.4.0/10.4.1/10.4.2

    IMPORTANT: Controller Web is not supported when using Oracle.

    Official IBM knowledgecenter instructions here: https://www.ibm.com/support/knowledgecenter/en/SS9S6B_10.4.0/com.ibm.swg.ba.cognos.ctrl_inst.10.4.0.doc/t_contrweb_configure.html

    • Alternatively, customers can use the IBM Support 'best practice' guidelines, which are below:

    Steps for Controller 10.4.0/10.4.1/10.4.2:

    The following steps assume:

    • The simplest configuration (where both the "Controller Web" and "Controller Web Frontend" services reside on the same server = the main Controller application server).
    • Controller server has been installed in the default location. If you have installed it in a different folder, you will need to modify the values below
    • Your Controller application server's FQDN name is:    myserver.companyname.com
    • You are not using Single Sign On (Windows authentication for IIS). If you are using SSO, see appendix at the end of this Technote

    1. During the installation of Controller server, make sure that you have chosen both "Controller Web" and "Controller Web Frontend":

    image-20181217144710-1

    PART ONE - Configuring the backend

    2. Browse to the following folder:  C:\Program Files\IBM\cognos\ccr_64\fcmweb\wlp\etc\ 

    • Open the following file inside NOTEPAD:          server.env
    • Modify the setting as follows:       JAVA_HOME=C:/Program Files/IBM/cognos/ccr_64/fcmweb/jre

    5. Synchronize Controller Web with the current/existing ‘database connection’ UDL files by performing the following:

    • Right-click on the ‘Start’ menu, and choose ‘Command Prompt (Admin)
    • Type a command similar to:    cd C:\Program Files\IBM\cognos\ccr_64\fcmweb
    • Type the following command :    SyncDBConf.bat ..\Data wlp\usr\shared\config\datasources

    You should get a success message similar to:

    image-20181217145953-1

    6. Browse to this folder:      C:\Program Files\IBM\cognos\ccr_64\fcmweb\wlp\usr\servers\fcm.web

    • Open the following file inside NOTEPAD:     com.ibm.cognos.fcm.web.properties
    • Search for the following line:       ccrwsUrl=@CCRWS_PATH@/ccrws.asmx
    • Modify it to be something similar to:        ccrwsUrl=http://myserver.companyname.com/ibmcognos/controllerserver/ccrws.asmx

    • Search for the following line:        loginMode=@LOGIN_MODE@
    • Modify it to read:        loginMode=NATIVE
    • Save changes

    ++++++++++++++++++++++++++++++++++++++++++++++++

    NOTE: The above example assumes using 'native' authentication.

    • If using Cognos 'CAM' authentication, then (after finishing the steps in this Technote) you need to perform all the steps inside separate IBM Technote #305259.

    ++++++++++++++++++++++++++++++++++++++++++++++++

    -----------------------------------------

    Optional step: In very rare cases, it is necessary to increase the memory settings of Controller Web:

    7. Browse to this folder:          C:\Program Files\IBM\cognos\ccr_64\fcmweb\wlp\etc\

    • Open the following file inside NOTEPAD:    jvm.options
    • Modify the following values from their defaults:

    -Xms2g
    -Xmx4g

    ------------------------------------

    8. Start (or restart) the Windows service:     IBM Cognos Controller Web

    PART TWO - Configuring the frontend

    9. Browse to this folder:      C:\Program Files\IBM\cognos\ccr_64\frontend

    • Open the following file inside NOTEPAD:    config.js

    • Inside the section 'Proxies - target - host', locate the following line:       "host": "{hostname}",
    • Modify it to be something similar to:        "host": "myserver.companyname.com",
      • IMPORTANT: This must be the FQDN version!

    • Inside the section 'expressJs', locate the following line:       "host": "{publicInterface}", //interface used by Controller Web UI Service
    • Modify it to be something similar to:        "host": "myserver.companyname.com", //interface used by Controller Web UI Service

    For example:

    image-20181217161414-1

    • Save changes

    10. If your application server is based on Windows 2019 (or later) then you must perform some extra steps (including making a change to the file "install_service.bat")

    • For full details, see separate IBM Technote #0884802.

    11. Start the service:   IBM Cognos Controller Web UI

    12. Test by connecting to the website using the correct nomenclature

    (The URL has changed from version 10.4.0 onwards).

    ==================================

    Appendix

    If you are using Single Sign On (SSO), then:

    • By default, your IIS website's 'controllerserver' virtual directory will be using Windows authentication
      • This causes Controller Web to fail to be able to connect
    • The solution is to modify the IIS website's controllerserver virtual directory to use anonymous authentication
      • TIP: For more details, see separate IBM Technote #1125087.

    ==================================

    [{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS9S6B","label":"IBM Cognos Controller"},"Component":"Controller Web","Platform":[{"code":"PF033","label":"Windows"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

    Document Information

    Modified date:
    10 September 2020

    UID

    ibm10791535