Automate the configuration of Microsoft's Internet Information Service to support IBM Cognos Analytics

News

Abstract

This tool automates Cognos Analytics 11 and IIS Web Server configuration steps described in the IBM Documentation – Configuring IIS with Cognos Analytics:

(https://www.ibm.com/docs/en/cognos-analytics/11.0.0?topic=cmiis-configuring-iis-in-cognos-analytics-1104-later-versions)

(https://www.ibm.com/docs/en/cognos-analytics/11.1.0?topic=services-configuring-iis-in-cognos-analytics)

(https://www.ibm.com/docs/en/cognos-analytics/11.2.0?topic=services-configuring-iis-in-cognos-analytics)

These steps work for Cognos Analytics 11.0.x, Cognos Analytics and 11.1.x and Cognos Analytics 11.2.x versions.

Content

**As of Cognos Analytics 11.1.2, the Cognos Analytics 11 and IIS configuration batch file is now available in the software. It is in the 'analytics\cgi-bin\templates\IIS' directory**

If you are using Cognos Analytics 11.1.1 and lower version of Cognos Analytics 11 use link to the CA_IIS_Config_v2(03.29.19).zip to download configuration batch file

If you have a pre-existing Cognos Analytics virtual directory, we recommend removing current configuration before you run this script. You can properly remove it by following the instructions found at this link: https://www.ibm.com/support/pages/node/301009

NOTE: This batch file uses Microsoft's Internet Information Service's appcmd command-line tool to perform the configuration and needs to run with administrator privileges. If there are any concerns on using this command or privilege level, then stop now and follow the manual steps to configure IIS.

The batch file attached at the end of this document automates the steps in creating the application pool, alias, SSO, server farm and rewrite rules in IIS needed for Cognos Analytics. Pre-requisites before you run this tool:

IBM Cognos Analytics 11.0.4 gateway or higher installed
Supported version of Microsoft Internet Information Services (IIS) installed with the following features:
- World Wide Web Services > Application Development Features > ISAPI Extensions and ISAPI Filters
- World Wide Web Services > Security > Request Filtering and Windows Authentication
Application Request Routing for IIS installed

Supported IIS versions, for IBM Cognos Analytics, can be found on the IBM Cognos Analytics 11.x.x supported software Environment page.

Application Request Routing can be found at: https://www.iis.net/downloads/microsoft/application-request-routing

Setting Variables

Before you run the tool, you must enter the location of the CA gateway installation and required variables. (See variables defined)

1. Download the CA_IIS_config.zip file to your Cognos Analytics Gateway Server.
2. Extract the CA_IIS_config.bat file to a folder.
3. Open CA_IIS_config.bat in a text editor.
4. The variables, which need to be modified, are at the top of the file.

Note! Modify only the variables mentioned in the following table.

Variable Name	Description	Default Setting
Set web_site	This variable is the pre-existing website name, where your alias is created.	Default Web Site
Set app_pool	Name of the Application Pool that Cognos Analytics uses.	ICAPool
Set alias	This variable is the alias name in which Cognos Analytics is accessed from. NOTE: Setting an alias name that exists in IIS overwrites the existing entries in that alias with the new settings. It is suggested to use an alias name that does not exist.	ibmcognos
Set ca_path	Sets the location of the Cognos Analytics gateway folder. The tool performs then a quick validation to see whether Cognos Analytics is installed in the location specified. It also checks to see whether the gateway tier is installed. NOTE: The script continues with its execution even if there is an error.	C:\Program Files\ibm\cognos\analytics
Set disp.protocol	The disp.protocol sets the reverse proxy URL to the proper protocol for one or more dispatchers. Can be set to http or https	http
Set disp[x].name set disp[x].port	This section is where all application dispatchers in entered. (Do not list "Content Manager Only" servers). Set disp[x].name is where you would put the fully qualified dispatcher name ex. Set disp[1].name=server1.mycompany.com Set disp[x].port is where you would put the dispatcher port number. ex. Set disp[1].port=9300 For Example: Set disp[1].name=server1_name Set disp[1].port=9300 Set disp[2].name=server2_name Set disp[2].port=9400 Set disp[3].name=server3_name Set disp[3].port=9500
Set enable_SSO	To enable single sign-on capabilities in IIS, set it to True. False to disable. NOTE: This setting performs only the configuration based on the steps in Configuring IIS with Cognos Analytics. You need to perform the steps in the Enable single sign-on between Active Directory Server and IBM Cognos components section to fully enable SSO.	False
Set web_farm_name	If there are two or more dispatchers listed in the set ca_disp variable. You can use the name as is or type in a new one. If only 1 dispatcher is listed, then do not change the name.	ca_servers

Back up IIS before you run the configuration tool

Before you run this tool, we recommend you consider to back up your current IIS configuration. Refer to Microsoft's IIS documentation on how to do the backup.

Some information on this topic can be found at:

https://docs.microsoft.com/en-us/iis/web-hosting/web-server-for-shared-hosting/create-a-backup-with-appcmd

https://docs.microsoft.com/en-us/iis/get-started/getting-started-with-iis/getting-started-with-appcmdexe

Steps to run the configuration tool

Run CA_IIS.config.bat by:
- Command prompt with administration privileges
- Windows explorer with "Run as Administrator" option selected
A command window opens with the list of variables that you configured. If they are incorrect, then exit and reopen the bat file to correct the issue. If everything is correct, then press 'y' to continue.

Configuration is now complete. To verify, open IIS manager and check under your website for the alias name you used in the tool.

Enable SSO after you disabled it in the tool

If SSO was disabled while you run the tool, you can enable it again in IIS Manager. During the execution of the tool, SSO is configured but is then disabled. To enable it, perform the following:

1. Open IIS Manager.
2. Expand the web site and alias that was created.
3. Single click the bi folder.
4. Click URL Rewrite.
5. Find SSO Login, we expect it to be grayed out. Single click it and on the right action panel, click Enable Rule.
6. Find Legacy SSO, we expect it to be grayed out. Single click it and on the right action panel, click Enable Rule.

Script last tested against Cognos Analytics 11.1.1. This single script configures 11.0.x and 11.1.1 versions

CA_IIS_Config_v2(03.29.19).zip

[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSTSF6","label":"IBM Cognos Analytics"},"ARM Category":[{"code":"a8m50000000Cl3zAAC","label":"Administration"}],"ARM Case Number":"","Platform":[{"code":"PF033","label":"Windows"}],"Version":"All Versions"}]

Tips