Using IBM Rational Insight to get metrics and reports for Rational Quality Manager: Part 1. Configure connections from Rational Insight to Rational Quality Manager

This article series introduces how to get metrics and reports for IBM® Rational® Quality Manager from IBM® Rational® Insight. This, the first article, explains how to configure connections from Rational Insight to Rational Quality Manager, including a live connection to the Rational Quality Manager REST service, and data warehouse connections. This article also introduces the scenario used in later articles.

Share:

Jun Tao (Tony) Cui (cuijunt@cn.ibm.com), Staff Software Engineer, IBM China

Tony Cui photoCui Jun Tao joined IBM in 2006 and has spent the past 4 years in the integration testing, architecting, implementing, and testing cross-brand solutions. Currently, he works for the Federated Integration Test team and focuses on the Rational product service family.


developerWorks Contributing author
        level

Hua Hong Wang (wanghuah@cn.ibm.com), Staff Software Engineer, IBM China

Wang Hong photoHua Hong Wang is a staff software engineer from the IBM China Development Lab. After more than 10 years of software developing and testing, he has rich experience in globalization, automation testing, and integration testing, especially for the cross-brand integration testing. Recently, he is interested in IBM Jazz-based Rational tools that adopt a Collaborative Application Lifecycle Management (C/ALM) approach.



07 September 2010

Also available in Chinese

Introduction to Rational Insight

IBM® Rational® Insight helps you get consistent metrics from across your organization and toolsets, so that you can objectively measure status and progress.

The Rational Insight extract, transform, and load (ETL) process for IBM® Rational® Quality Manager is different from other supported point product data extractions provided in the as-is Data Manager catalog. It uses two kinds of connections to extract the data from the Rational Quality Manager:

  • Live connection
  • Data warehouse connection

This article series has three articles. This, the first article, shows you how to configure both kinds of connections between Rational Insight and Rational Quality Manager. Moreover, with the help of a scenario, you'll learn how to perform the ETL process on the data from Rational Quality Manager and generate a report.


Connection configuration

Both the live and data warehouse connections connect to the REST (Representational State Transfer) service on Rational Quality Manager. The live connection gets live data from Rational Quality Manager via the REST service API, and then shows it in the report. The data warehouse connection retrieves the data from Rational Quality Manager at a regular interval, loads it into the data warehouse, performs a transformation, and then show it in the report.

There are some differences between the two kinds of connections:

  1. The live connection gets live data, while the data warehouse connection gets historical data.
  2. No ETL jobs are needed for the live connection.
  3. The live connection doesn't support dimension and fact.
  4. The data warehouse connection cannot retrieve custom properties from Rational Quality Manager without changing the reporting data model.

The next section introduces how to set up two kinds of connections in detail.


Live connection

There are three steps to configure the connections from Rational Insight to Rational Quality Manager.

  1. Modify rqm.xdc using the XML Data Configuration tool.
  2. Configure ODBC (Open Database Connectivity) on Rational Insight.
  3. Test the connections using the Rational Insight console.

Modify rqm.xdc

The Resource group is a definition of the connection to the data source in the XML Data Configuration tool of Rational Insight. It stores the connection details. This section shows you how to use the resource group to define a connection to Rational Quality Manager.

  1. Run XML Data Configuration on the Rational Insight server.
  2. To open the <insight_root>/dataconfig/configs/live data config/rqm.xdc file, select File > Open Configuration.
  3. Expand XML Data Configuration > Resources > RQM and double click the RQM item. The resource group definition for Rational Quality Manager is displayed.
  4. Enter your Rational Quality Manager connections, including the URL, Authentication type, User name, and Password, as follows (Figure 1).
    • URL type: Generic XML
    • URL: https://your_rqm_server:9443/jazz/secure/service/com.ibm.rqm.integration.service.IIntegrationService/resources/your_RQM_Project
    • Authentication type: Form
    • User name: yourname
    • Password: yourpassword
Figure 1. Rational Quality Manager live connection details.
Input your Rational Quality Manager URL, username and password
  1. Before you save the resource group, you should verify the connection, However, you can't directly verify it by clicking the Test Connection button. You should append a suffix (like /testplan) to the URL to verify the connection, as follows.

    URL: https://your_rqm_server:9443/jazz/secure/service/com.ibm.rqm.integration.service.IIntegrationService/resources/your_RQM_Project/testplan

  2. Click Test Connection and you should get a message indicating that the connection is successful, as shown in Figure 2.
Figure 2. Rational Quality Manager live connection test result.
The Rational Quality Manager live connection is successful
  1. After the test, remove the suffix /testplan and save the rqm.xdc file.

Configure ODBC

Rational Insight only supports ODBC version 2.2.14 or later. Before configuring ODBC, verify the ODBC version using the odbcinst -j command on the Rational Insight server, and then update it if necessary. Next, configure it as follows (Figure 3).

  1. Open the odbcinst.ini file under the directory <insight_installation_directory>/dataconfig/odbc/.
  2. Make sure that the value of the Driver parameter is <insight_installation_directory>/dataconfig/odbc/libratlxml.so.
  3. Open the odbc.ini file in the same directory and modify the value of the Configuration parameter in the RQM Live section, changing it to <insight_installation_directory>/dataconfig/configs/live data config/rqm.xdc.
Figure 3. RQM Live configuration for ODBC.
Configure RQM live ODBC data source
  1. Use the odbcinst -j command to get the path of the ODBC driver configuration file (odbcinst.ini) and the system DSN (Database Source Name) file (odbc.ini). This example uses /usr/local/etc/ as an example.
  2. Add the code shown in Listing 1 to the ODBC driver configuration file (odbcinst.ini).
Listing 1. Lines added to odbcinst.ini
[IBM Rational Insight XML ODBC Driver]

Description          =

Driver        = <insight_installation_directory>/dataconfig/odbc/libratlxml.so 

Setup         = <insight_installation_directory>/dataconfig/odbc/libratlxmlS.so

MaxActiveStatements  = 100

QueuingTimeout       = 100000

DefaultPageSize      = 1000

LibPath       = <insight_installation_directory>/dataconfig/jdbc

Jdbclogpath   = <insight_installation_directory>/dataconfig/jdbc/log
  1. Copy the odbc.ini file under the directory <insight_installation_directory>/dataconfig/odbc/ to the directory where the system DSN file locates.
  2. Test the connection by the using the command isql "RQM Live". If it's connected, the ODBC configuration finishes.

Verify the connection

After you modify the rqm.xdc file and configure ODBC, you need to log on to the Rational Insight console to verify the data source connection.

  1. Log on to the Rational Insight console and navigate to IBM Cognos Administration > Configuration > Data Source Connections.
  2. A list of data source connections is shown. Select the RQM item.
  3. An item named RQM is displayed. Click Set properties > RQM under the Actions panel.
  4. Switch to the Connection tab and make sure that the type is ODBC, as shown in Figure 4.
Figure 4. Rational Quality Manager data source property.
Check your RQM live data source type
  1. Edit the connection string and make sure that the ODBC data source is RQM Live, as shown in Figure 5.
Figure 5. Rational Quality Manager data source connection property.
Check your RQM live data source connection
  1. Select Test the connection. Select an appropriate dispatcher and click Test, as shown in Figure 6.
Figure 6. Test Rational Quality Manager data source connection.
Screen shot for the Rational Quality Manager live data source test
  1. If the result is Succeeded, it shows that the connection is successful, and you can use RQM Live to set up a live connection to the Rational Quality Manager data source via the REST service.

Data warehouse connection to Rational Quality Manager

This connection configuration is similar to the live connection. There are also three steps to configure the connections from Rational Insight to Rational Quality Manager.

  1. Modify rqm.xdc using the XML Data Configuration tool.
  2. Configure ODBC on Rational Insight.
  3. Test the connections using the Rational Insight console.

Modify rqm.xdc

This section uses the resource group to define a connection to Rational Quality Manager.

  1. Open the <insight_root>/dataconfig/configs/Configurations /rqm.xdc file by selecting File > Open Configuration in the XML Data Configuration tool.
  2. Expand XML Data Configuration > Resources > RationalQualityManager > Rational Quality Manager and double-click the RQM item. Then the resource group definition for Rational Quality Manager is displayed.
  3. Enter your Rational Quality Manager connections, including the URL, Authentication type, User name, and Password, as follows.
    1. URL type: Generic XML
    2. URL: https://your_rqm_server:9443/jazz/secure/service/com.ibm.rqm.integration.service.IIntegrationService/resources/your_RQM_Project
    3. Authentication type: Form
    4. User name: yourname
    5. Password: yourpassword
  4. Before you save the resource group, verify the connection. Append a suffix (such as /testplan) to the URL to verify the connection, as follows.

    URL: https://your_rqm_server:9443/jazz/secure/service/com.ibm.rqm.integration.service.IIntegrationService/resources/your_RQM_Project/testplan

  5. Click Test Connection and you should get a message indicating that the connection is successful.
  6. After the test, remove the suffix /testplan and save the rqm.xdc file.

Configure ODBC

Rational Insight only supports ODBC Version 2.2.14 or later. Before you configure ODBC, verify the ODBC version using the odbcinst -j command on the Rational Insight server and update it if necessary.

  1. Open the file odbc.ini in the same directory and modify the value of the Configuration parameter in the RQM section, changing it to: <insight_installation_directory>/dataconfig/configs/Configurations/rqm.xdc, as shown in Figure 7.
Figure 7. Rational Quality Manager data warehouse configuration for ODBC.
Configure RQM data warehouse ODBC data source
  1. Copy the odbc.ini file under the <insight_installation_directory>/dataconfig/odbc/ directory to the directory where the system DSN file locates.
  2. Test the connection by the isql RQM command. If it's connected, the ODBC configuration finishes.

Verify the connection

After you modify the rqm.xdc file and configure ODBC, you need to log on to the Rational Insight console to verify the data source connection.

  1. Log on to the Rational Insight console and navigate to IBM Cognos Administration > Configuration > Data Source Connections.
  2. A list of data source connections is displayed. Select the item labeled RQM (ETL).
  3. An item RQM (ETL) is shown. Click Set properties > RQM (ETL) under the Actions panel.
  4. Switch to the Connection tab and make sure that the type is ODBC, as shown in Figure 8.
Figure 8. Rational Quality Manager data warehouse data source properties
Check your RQM data source type
  1. Edit the connection string and make sure that the ODBC data source is RQM.
  2. Select Test the connection. Select an appropriate dispatcher and click Test.
  3. If the result is Succeeded, it shows that the connection is successful, and you can use RQM to set up a data warehouse connection to the Rational Quality Manager data source.

Scenario used in the other articles in this series

The following scenarios will be used in these articles.

There are two custom properties in the test plan item in Rational Quality Manager: actual start date and actual end date, as shown in Figure 9.

Figure 9. Rational Quality Manager test plan custom properties.
Screen shot for the custom properties

You are going to generate two reports on the test plan. The first is to display the test plan numbers by owner, and the second is to display the test plan numbers by the actual start date. For these two reports, you need two kinds of connections (a data warehouse connection and a live connection, respectively). The data warehouse connection is enough for the first report. However, the actual start date property is not included in the ETL job for the data warehouse connection. To access it, you must use the live connection.

The other articles in this series introduce the end-to-end process to generate the report with the help of this scenario.


What you have learned

This article shows you how to set up the connections from Rational Insight to Rational Quality Manager, and the differences between the connection types. It also introduced a scenario that you will use in the later articles.

Resources

Learn

  • Find out more about Rational Insight:
  • Find out more about Rational Quality Manager:
    • Browse the Rational Quality Manager developerWorks page for links to technical articles and many related resources.
    • Explore the Rational Quality Manager Information Center.
    • Join the Rational Quality Manager forum to ask questions and participate in discussions.
  • Learn about other applications in the IBM Rational Software Delivery Platform, including collaboration tools for parallel development and geographically dispersed teams, plus specialized software for architecture management, asset management, change and release management, integrated requirements management, process and portfolio management, and quality management. You can find product manuals, installation guides, and other documentation in the IBM Rational Online Documentation Center.
  • Visit the Rational software area on developerWorks for technical resources and best practices for Rational Software Delivery Platform products.
  • Explore Rational computer-based, Web-based, and instructor-led online courses. Hone your skills and learn more about Rational tools with these courses, which range from introductory to advanced. The courses on this catalog are available for purchase through computer-based training or Web-based training. Some of the "Getting Started" courses are available free of charge.
  • Subscribe to the IBM developerWorks newsletter, a weekly update on the best of developerWorks tutorials, articles, downloads, community activities, webcasts, and events.

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, DevOps
ArticleID=515090
ArticleTitle=Using IBM Rational Insight to get metrics and reports for Rational Quality Manager: Part 1. Configure connections from Rational Insight to Rational Quality Manager
publish-date=09072010