ShowTable of Contents
Prerequisite
Since the Connections 4.0 Metrics component is running on WAS, the Cognos BI need be installed on WAS to be able to achieve SSO between Metrics and Cognos BI.
Connections 4.0 Metrics require Cognos BI 10.1.1 with Fix Pack 1 installed.
Cognos BI need configured to use the same LDAP server as the IBM Connections 4.0 used to achieve the SSO between Metrics and Cognos BI.
Configure Cognos
Configure Cognos BI
Prepare Cognos BI on WAS
If Cognos BI on WAS has not been installed, follow Configuring IBM Cognos Business Intelligence for an Application Server other than Tomcat to configuration Cognos BI for WAS.
Prepare the Cognos server setup package
Follow Installing Cognos Business Intelligence components step 4 to prepare the Cognos server setup package
Apply Metrics Customization to Cognos BI on WAS
Set up the JDBC driver
a.Locate the type 4 JDBC driver provided by your database server product.
b.Copy the JDBC driver to the following location: /CognosSetup/BI-Customization/JDBC
Apply Metrics customization to Cognos BI server
Copy /CognosSetup/BI-Customization/JAR folder files to following location: cognos_bi_install_location/webapps/p2pd/WEB-INF/lib
Copy /CognosSetup/BI-Customization/JDBC folder files to following location: cognos_bi_install_location/webapps/p2pd/WEB-INF/lib
Copy /CognosSetup/BI-Customization/WebContent folder files and folders to following location: cognos_bi_install_location/webcontent
Apply Metrics customization to Cognos BI web.xml file
Open the file cognos_bi_install_location/webapps/p2pd/WEB-INF/web.xml.withCM in a text editor.
After the last servlet-mapping section, and before the element, add the following:
<!--IBM Connection Metrics cognos job service servlet -->
<servlet>
<servlet-name>icmetricsjobservice</servlet-name>
<servlet-class>com.ibm.connections.metrics.cognos.servlet.CognosJobService</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>icmetricsjobservice</servlet-name>
<url-pattern>/icmetricsjobservice</url-pattern>
</servlet-mapping>
<!-- Proxy endpoint -->
<servlet-mapping>
<servlet-name>app-proxy</servlet-name>
<url-pattern>/ajaxProxy/*</url-pattern>
</servlet-mapping>
<security-constraint>
<display-name>AjaxProxyReader</display-name>
<web-resource-collection>
<web-resource-name>AjaxProxy</web-resource-name>
<url-pattern>/ajaxProxy/*</url-pattern>
<http-method>GET</http-method>
<http-method>PUT</http-method>
<http-method>POST</http-method>
<http-method>DELETE</http-method>
</web-resource-collection>
<auth-constraint>
<description>AjaxProxyReaderAuthorization</description>
<role-name>BI User</role-name>
</auth-constraint>
</security-constraint>
Inside the section where contain the Cognos Dispatcher, after the last web-resource-collection section, and before the element, add the following:
<web-resource-collection>
<web-resource-name>Metrics job service</web-resource-name>
<url-pattern>/icmetricsjobservice</url-pattern>
<http-method>GET</http-method>
<http-method>POST</http-method>
</web-resource-collection>
Build and deploy the Cognos application
Follow this Configure IBM Cognos Components to Run Within the Application Serverto build and deploy the Cognos application.
Verify the Cognos BI on WAS
Use following two URLs to veify the Cognos BI:
For Cognos Content Manager:
http://Host_Name:Port/Context_Root/servlet
For Cognos BI dispatcher:
http://Host_Name:Port/Context_Root/servlet/dispatch/ext
where:
Host_Name is the fully qualified host name of the Cognos server; for example, host.example.com.
Port is the port that the Cognos server is listening on.
Context_Root is the context root to which you installed the Cognos server; for example, cognos.
Deploy Metrics component to Cognos BI
Import Metrics report package
Copy the Metrics report package file from /CognosSetup/MetricsPkg/MetricsPkg.zip to following location: cognos_bi_install_location/deployment
In browser, navigate to the dispatcher’s address: http://Host_Name:Port/Context_Root/servlet/dispatch/ext
1. Launch the IBM Cognos Administration menu:
2. Select the Configuration tab and then select Content Administration menu:
3. Click New Import icon:
4. Select the MetricsPkg from the list and click Next button:
5. Change the Name to MetricsPkg and click the Next button:
6. Select the check box besides the IBMConnectionsMetrics from the list of Public foders content, then click the Next button:
7. Select the options as following, and click the Next button
Include Cognos groups and roles
Conflict resolution: Replace existing entries
Include data sources and connections
Conflict resolution: Replace existing entries
8. Select the options as following, and click the Next button
9. Click the Next button:
10. Select the Save and run once option and click Finish button
11. Selec the following options and click Run button:
Time: Now
Report specification upgrade: Upgrade all report specifications to the latest version
Store IDs: Assign new IDs during import
12. Select the check box for View the details of this import after closing this dialog and click OK button:
13. Wait a moment and click the Refresh link to get the latest import status:
14. When the import job finished, you will see following page after click the Refresh link:
15: The status should be Succeeded and the Message indicate Import is complete and 0 object failed. Then click the Close button. This will finish the import Metrics report package process.
Setup cube path
In browser, navigate to the dispatcher’s address: http://Host_Name:Port/Context_Root/servlet/dispatch/ext
1. Launch the IBM Cognos Administration menu:
2. Select the Configuration tab and then click the METRICS_TRX_CUBE item from the list:
3. In Directory > Cogno > METRICS_TRX_CUBE list, click the properties icon on the right side for METRICS_TRX_CUBE:
4. Select the Connection tab:
5. Click the edit icon beside the Connections string
6. In Edit the connections String - IBM Cognos PowerCube page, edit the following, and then click the OK button
For Windows:
Edit the Windows location to following: cognos_cube_path\cube\MetricsTrxCube.mdc
Example: C:\IBM\Cognos\PowerCubes\cube\MetricsTrxCube.mdc
For Aix/Linux:
Edit the Unix or Linux location to following: cognos_cube_path/cube/MetricsTrxCube.mdc
Example: /opt/IBM/Cognos/PowerCube/cube/MetricsTrxCube.mdc
7. Click the OK button again to save the properties:
Configure the Authenitcaiton provider for Cognos BI
Follow Configuring IBM Cognos Components to Use an Authentication Provider to configure the authentication provider.
Note: Please the IBMConnections for the Namespace ID for the new authentication provider for Cognos BI. This authentication provider should be the same as the IBM Connections 4.0 will use.
Configure Cognos Transfomer
If the Cognos Transformer has not been installed, please do following
Install IBM Cognos Transformer to install the Cognos Transformer.
Configure IBM Cognos Transformer Computers to configure the Cognos Transformer.
Installing the database client for Cognos Transformer
Follow Installing the database client for Cognos Transformer to install the database client.
Prepare Java run time if necessary
For UNIX or Linux OS, if there is java run time installed, install the Java 32-bit run time.
Go to www.java.com to download the correct Java 32-bit run time and install it.
Prepare the Cognos server setup package
Follow Installing Cognos Business Intelligence components step 4 to prepare the Cognos server setup package
Configure the Cognos Transformer with Metrics code
Prepare the cognos-setup.properties file by filling in a value for following property:
cognos.transformer.install.path set this property to the path where the Cognos Transformer is installed.
Example:
cognos.transformer.install.path=C:\Cognos\TF
Prepare the following input values:
Value Name |
Description |
Examples |
setupProp |
Path to Cognos setup properties file |
"C:\software\cognos\CognosConfig\cognos-setup.properties" or
“/opt/software/cognos/CognosConfig/cognos-setup.properties” |
cognosSrvLink |
Cognos BI server URL to the context root part |
http://example.company.com:9081/cognos |
cognosCubePath |
Path to where the Cognos cube will be stored. Should be network folder if Cognos BI server is on a different server than Cognos Transformer server |
"C:\cognos\cube" or “/opt/cognos/cube” |
metricsDBType |
Metrics db type (db2, oracle, sqlserver) |
sqlserver |
metricsDBName |
Metrics database name |
METRICS |
metricsDBLocalName |
Transformer server node local metrics database name |
METRICS1 |
metricsDBHost |
Metrics database host name and port |
mydb.company.com:1511 |
metricsDBUser |
Metrics database user name |
METRICSUSER (for Oracle and SQLServer) or LCUSER (for DB2) |
metricsDBPassword |
Metrics db user password |
"password" |
cognosAdminUserName |
Cognos admin user (LDAP user) |
CognosAdminUser |
cognosAdminUserNS |
Cognos namespace for admin user |
IBMConnections |
cognosAdminUserPW |
Cognos admin user password (LDAP user) |
"password" |
Go to the Cognos server setup package folder:
for example:
For AIX or Linux: /opt/CognosSetup
For Windows: C:\CognosSetup
Make sure the Cognos BI server is started and running okay.
For AIX or Linux: Setup the JAVA_HOME environment attribute by running following command:
export JAVA_HOME=
Run following command with input values:
bin/configTransformer.bat|sh -setupProp="" -cognosSrvLink= -cognosCubePath="" -metricsDBType= -metricsDBName= -metricsDBLocalName= -metricsDBHost= -metricsDBUser= -metricsDBPassword="" -cognosAdminUserName= -cognosAdminUserNS= -cognosAdminUserPW="" -update=true
Example:
bin\configTransformer.bat -setupProp="C:\software\cognos\CognosConfig\cognos-setup.properties" -cognosSrvLink=http://example.company.com:9081/cognos -cognosCubePath="C:\cognos\cube" -metricsDBType=sqlserver -metricsDBName=METRICS -metricsDBLocalName=METRICS1 -metricsDBHost=mydb.company.com:1511 -metricsDBUser=METRICSUSER -metricsDBPassword="password" -cognosAdminUserName=CognosAdminUser -cognosAdminUserNS=IBMConnections -cognosAdminUserPW="password" -update=true
Verify the Metrics cube can be build
Go to metrics cube folder: cognos_transformer_install_location/metricsmodel
for example:
For AIX or Linux: /opt/Cognos/Transformer/metricsmodel
For Windows: C:\Program Files (x86)\IBM\Cognos\metricsmodel
Run the build-all.sh|bat script to build cube. And then check the log to verify there is no error:
For AIX or Linux: /opt/Cognos/Transformer/metricsmodel/trxschelog.log
For Windows: My Documents\Transformer\Logs\MetricsTrxCube.log and My Documents\Transformer\Logs\MetricsAuditCube.log
Install IBM Connections 4.0
Follow Installing IBM Connections 4.0 to install the IBM Connections 4.0
Note: on step 15, you may not specify the correct value for Name, Host Name, Server Name, and the validation will fail. It is okay, we will fix this in next step. But please specify the correct value for all other attributes.
Setup SSO between Cognos BI and Connections 4.0
Enabling single sign-on
Enable single sign-on (SSO) on all the instances of Cognos WebSphere Application Server.
To enable SSO on WebSphere Application Server, do the following:
-
Log in to the WebSphere Application Server administration console.
-
Navigate to Security > Global Security.
-
In the Authentication settings section, expand Web and SIP security then select Single sign-on (SSO).
-
In the General Properties section, specify the following configuration values for single sign-on:
Enabled
Selected by default.
Requires SSL
Specify the domain name that you are using for the servers; for example, my.companyname.com.
Interoperability Mode
Select this field if not selected by default.
Web inbound security attribute propagation
Selected by default.
-
Click OK and save to the master configuration.
Exporting the LTPA key
Export a Lightweight Third Party Authentication (LTPA) key from Connections WebSphere Application Server to import into Cognos instances of WebSphere Application Server.
To export the single sign-on key, do the following:
-
Log in to the Connections WebSphere Application Server administration console.
-
Navigate to Security > Global security > Authentication > LTPA.
-
In the Cross-cell single sign-on section, specify a password for the LTPA key.
-
Enter the LTPA key name and directory to which you want to export the key in the Fully qualified key file name field. For example, on Windows, enter C:\my_key_name on Linux, enter /opt/my_key_name.
-
Click Export keys.
-
Click OK and save to the master configuration.
-
Navigate to the directory where you exported the LTPA key.
-
Copy the LTPA key to the file system where you plan to import it.
Importing the LTPA key
Import the LTPA key into Cognos WebSphere Application Server.
Before you begin:
-
Export the LTPA key.
-
Copy the LTPA key from the file system where you exported it to the file system where you plan to import it.
To import the LTPA key, do the following:
-
Log in to the Cognos WebSphere Application Server administration console.
-
Navigate to Security > Global security > Authentication > LTPA.
-
In the Cross-cell single sign-on section, specify the password for the LTPA key.
-
Enter the directory on your file system where you copied the LTPA key in the Fully qualified key file name field.
-
Click Import keys.
-
Click OK and save to the master configuration.
-
Restart both the Connections and Cognos servers. Restart the servers only after you have imported the LTPA key into all the Cognos servers for which you plan to establish SSO.
Verifying single sign-on
You have successfully established SSO between multiple instances of WebSphere Application Server when you can log in to one administration console then access the other administration consoles without having to log in again.
To verify SSO, do the following:
-
Log in to the WebSphere Application Server administration console where you exported the LTPA key.
-
In your browser's address bar, enter the URL for the WebSphere Application Server administration console where you imported the LTPA key.
If the WebSphere Application Server administration console opens without requiring you to log in, you have successfully set up SSO.
Configure IBM Connections 4.0
Make sure the Cognos BI server is started and running okay.
Update the LotusConnections-config.xml with the Cognos service URL and context root:
Procedure
1.Stop WebSphere Application Server.
2.Check out the LotusConnections-config.xml file. The file is stored by default in the following directory:
AIX: /usr/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cell_name/LotusConnections-config
Linux: /opt/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cell_name/LotusConnections-config
Windows: C:\IBM\WebSphere\AppServer\profiles\profile_name\config\cells\cell_name\LotusConnections-config
3.For cognos service, update the web addresses specified in the href and ssl_href properties and the context root specified in hrefPathPrefix property:
where
webserver is the domain name of Cognos BI Server, such as cognos.example.com.
port is the default port number of the Cognos BI application.
application is the context root of the Cognos BI application.
Note:
The href attribute in the LotusConnections-config.xml file is case-sensitive and must specify a fully-qualified domain name.
Example:
4.Save and check in the LotusConnections-config.xml file.
5.Synchronize the nodes.
6.Log on to metrics application to ensure that the report is displayed okay.
Resources
developerWorks IBM Connections product page:
http://www.ibm.com/developerworks/lotus/products/connections/
IBM Connections 4.0 Reviewers Guide:
http://www.ibm.com/developerworks/lotus/documentation/ibmconnectionsrg4/index.html
IBM Connections Forum:
http://www.ibm.com/developerworks/lotus/documentation/ibmconnectionsrg4/index.html
About the authors
Nan Shi is an Advisory Software Engineer working for IBM since 2006. His current role is the Architect for Metrics feature in IBM Connections, before which he worked on Moderation in Connections, Lotus Quickr, Master Data Management, Wepsphere Customer Center. He can be contact at nanshi@cn.ibm.com