Configure Rational Insight to generate reports from Collaborative Lifecycle Management applications

Learn how to configure various components of IBM Rational Insight to integrate them with Rational Collaborative Lifecycle Management (CLM) applications to generate reports during various stages of your projects.

Share:

Murali Dhandapani (muralindia@in.ibm.com), IT Specialist, IBM

author photoMurali Dhandapani is part of the ISL Operations Software Engineering Service team at the IBM Software Labs in India, where he is a technical lead for Rational Jazz products infrastructure, high availability, and disaster recovery deployment. Murali has a master’s degree in computer science and is an IBM Certified IT Specialist in System Management, an IBM Certified Specialist in System p administration, and IBM eServer Certified Systems Expert - pSeries HACMP.


developerWorks Contributing author
        level

Preetam Kulkarni (preetamk@in.ibm.com), IT Specialist, IBM

author photoPreetam Kulkarni is part of the ISL Operations Software Engineering Service team at the IBM Software Labs in India, where he works on Rational ClearCase, build, and software based on Rational Jazz technology. He has a Bachelor of Engineering degree in electronics and communications.



18 May 2012

Prerequisites

This article provides instruction about configuring various components of IBM® Rational Insight, as well as integration with IBM® Rational Team Concert™, Rational® Quality Manager, and Rational® Requirements Composer, which helps to keep track of various stages of Collaborative Lifecycle Management (CLM) by generating the appropriate reports from Rational Insight. It is based on these assumptions:

  • The Rational Insight 1.1 server is already installed and configured, along with the report server.
  • The Rational Collaborative Lifecycle Management setup (see Figure 1) is ready for creating projects.
  • You use IBM® DB2® as your database. The RIDW database is created during the installation of Rational Insight 1.1.

Rational Insight and Collaborative Lifecycle Management setup architecture

The diagram in Figure 1 shows the setup used as the basis for this article.

Flow diagram of the setup

Add the RICALM schema tables to the RIDW database

A RICALM schema (Rational Insight CLM) is required to store the Collaborative Lifecycle Management data warehouse artifacts. Use the Configure Data Warehouse step from the Collaboration Lifecycle Management setup process to create the RICALM schema.

The following steps explain creating the RICALM schema for the RIDW database:

  1. Log in to the CLM server: https://hostname:port number/jts/setup
  2. Click Next and proceed to the Configure DataWarehouse step without making any modifications.
  3. Select DB2 as the Database Vendor and JDBC as the Connection Type.
  4. Update the JDBC password, JDBC location, and Custom Report Database User fields, as shown in Figure 2.
Dialog window for configuring the data warehouse

Note:
Because the RIDW database was created during Rational Insight installation, the database table space folder will be handled by Rational Insight. By default, the path is C:\Documents and Settings\db2admin\databases\RIDW. Therefore, leave Database Table Space Folder blank.

When you create a new data warehouse database for the RIDW2 instance later, after installation of Rational Insight, you must explicitly specify the path in the Database Table Space Folder.

  1. Test the connection and create the table as shown in Figure 3.
Creating tables with the RICALM schema
  1. When the process has finished successfully, RICALM schema tables will be created in DW Database (approximately 71 tables).

Configure the Open Database Connection (ODBC)

Open Database Connection (ODBC) configuration is required on the Rational Insight server for the connectivity of each application. To configure the ODBC for CLM applications, download this file from the CLM server, as shown in Figure 4:

  1. Log in to the CLM server, and go to the Reports section for Jazz Team Server (JTS), Change and Configuration Management (CCM), and Quality Management (QM) to download the respective XDC files. Although this download file name is the same for each of those areas, the contents are the respective application XLM Driver Configuration (XDC) files:

XML_ODBC_Driver_Configuration_Files.zip

Downloads view
  1. Copy the downloaded XDC files to the Rational Insight server in the path that you prefer, as shown in the Figure 5.
Path to XDC files and directory for RTC files

Create a new ODBC connection

A new ODBC data source connection should be created for each application in collaborative lifecycle management for the respective XDC files displayed in Figure 5. Follow these steps to configure them for Rational Team Concert (as an example):

  1. Select Start > Programs >Administrative Tools >ODBC, and then click the System DNS tab.
  2. Click Add, select Rational XML ODBC Driver, and then click Finish (see Figure 6).
Create New Data Source window, with selection
  1. Enter a name for the ODBC connection, and map the corresponding XDC file by entering the complete path of the file in configuration tab (see Figure 7).
configure the XDC file with the data source name
  1. Similarly, create an ODBC data source connection for these other XDC files: build301.xdc, scm301.xdc, workitem3012.xdc, rrc3011.xdc, rqm3011.xdc.

Configure the XML data

Verify the URL connection for the CLM server using XML data configuration by following these connection validation steps:

  1. Select Start > All Programs > IBM Rational Insight > XML Data Configuration
  2. File > Open configuration.
  3. Select any XDC file, for instance workitem3012.xdc, and click Open.
  4. Copy the value of the Relative Path field in one resource of the Resource Group WORKITEM_CCM.
  5. Double-click WORKITEM_CCM, paste the copied content into the Test relative path field, and click Test connection.

The Test Connection status should confirm that the connection is valid, as shown in Figure 8.

validating xdc configuration

Larger view of Figure 8.


Configure report server authentication by using IBM Cognos

By default, the report server is enabled with anonymous access. To restrict the access using IBM Cognos Configuration, you can create a new Namespace by selecting the type of authentication:

  1. Select Start > All Programs > IBM Rational Insight > IBM Cognos > IBM Cognos Configuration.
  2. Expand Security, right-click and select Authentication > New resource > Namespace.
  3. Enter these values:
    • Namespace Name:IBM ISL
    • Type:LDAP
  4. Configure the resource properties according to the LDAP parameters, and save the configuration. This creates IBM ISL as one namespace in authentication.
  5. Right-click on IBM ISL, and test the configuration, as shown in the Figure 9.
Cognos Configuration pop-window confirms testing
  1. Restart WebSphere Application Server.
  2. Log in to the report server using IBM ISL Namespace, and click Launch > IBM Cognos Administration, and then the Security tab.
  3. Click Cognos, find the System Administrators role, and click More.
  4. Click Set Properties and then the Members tab. Remove all members, replace them with the appropriate LDAP group ID, and click OK.
  5. Similarly, for the Query user role remove everyone, and replace it with the appropriate LDAP group ID and click OK. The users added to the Query user role are allowed to access the reports.
  6. Other roles in the Cognos Namespace can also be associated with appropriate LDAP group ids as needed.
  7. Set "Allow anonymous access" to False in IBM Cognos Configuration, and Save the changes, as shown in Figure 10.

Note:
You can also use the Jazz namespace and configure the jazzns_config.xml file for the authentication from Jazz Team Server. See the Configuring the Jazz namespace link in Resources for details. In this setup, we explicitly add users who need access to the reports to the LDAP group associated with the Query user role.

configuration of cognos namespace
  1. Restart WebSphere Application Server.

Configure the ETL catalog by using Cognos Data Manager

Rational Insight includes a catalog to run the jobs for all Rational applications. Thus, you need a database to create a new catalog for running Extract Transform Load (ETL) jobs.

Create a database with an alias of DWCLM using either IBM® DB2® Control Center or DB2 command line, db2cmd. Then follow these steps to create a new catalog:

  1. Select Start > All Programs > IBM Rational Insight > IBM Cognos > IBM Cognos Data Manager.
  2. Click Create a new catalog, enter the Name and other details for the catalog, and click Next.
  3. Use the DWCLM database and the respective database login credentials, and click OK, as shown in the Figure 11.
database configuration for catalog
  1. Click File > Restore Catalog to restore OOTBDMCatalog.ctg from this path:
    C:\Program Files\IBM\Rational Insight\datamgr\insight_catalog.

Figure 12 shows the RationalInsightETL catalog.

ETL catalog directory

By default, Rational Insight 1.1 has an older version of ETL jobs for CLM. You need to deploy the job versions that match the CLM server:

  1. Log in to the CLM server, go to the Reports section, and click Archive Files for Rational Reporting as shown in Figure 13.
  2. Download the Cognos_Report_Server_Archive_Files.zip file, and copy it to the Rational Insight server. Decompress it to find the file Cognos Data Manager Package (CLM).pkg in the folder named Rational Insight Sources.
Reports section Downloads view
  1. Make a backup copy of the existing catalog if you want to preserve it before importing the new package.
  2. Click File > Import Package, and select Cognos Data Manager Package (CLM).pkg.
  3. Select all of the components to import, as shown in Figure 14, and then click Next and Finish.
The Import Package wizard pop-up window

Larger view of Figure 14.

  1. Right-click Jazz Foundation services, click Properties, and then click Connection details.
  2. Select ODBC, and then browse to select CLM_JFS as the Data Source Name that you defined earlier, and click Test Connection.

You will get a "Connection OK" confirmation message, as shown in Figure 15.

Data Manager Connection OK confirmation
  1. Similarly, create connections for other applications (Rational Team Concert Build, SCM, and Work Item, plus Rational Quality Manager and Rational Requirements Composer).
  2. Ensure that Rational Data Warehouse connection details are pointing to the DB2 RIDW database and test the connection.
  3. Save all of the changes.

Schedule the ETL jobs

After configuring the ETL jobs, it is mandatory to run these jobs at regular intervals to get the latest artifacts from the CLM server. This section explains the steps for scheduling an ETL job, using JFS_ODS3.0.1_DeltaLoad job as the example.

  1. In the Cognos Data Manager, click Action, and select Publish Data Movement Task (see Figure 16).
publishing etl job for scheduling

Larger view of Figure 16.

This will prompt for Rational Insight report server authentication, and the successful authentication will publish the job by creating a folder named dataMovementTask in the public folder. You can publish other required jobs similarly.

  1. Click the Schedule icon (calendar-like grid with red cell), and configure the schedule timing.

Figure 17 shows it configured to run once daily at 9:30 PM.

Details of the scheduled job

Larger view of Figure 17.

Tip:
Previously, the schedule jobs failed periodically while using Rational Insight 1.1. See the link in Resources to IBM PM55303: SCHEDULED DMS TASK FAIL PERIODICALLY to resolve the issue and run the jobs successfully.

Resources

Learn

Get products and technologies

Discuss

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Rational software on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Rational
ArticleID=816767
ArticleTitle=Configure Rational Insight to generate reports from Collaborative Lifecycle Management applications
publish-date=05182012