Deploy Rational Reporting for Development Intelligence 2.0.3 to a federated environment

Ali Manji explains how to deploy IBM® Rational® Reporting for Development Intelligence (RRDI) 2.0.3 to a federated IBM® WebSphere® environment. Typically, such an environment involves a WebSphere cell that includes a deployment manager profile and one or more application server profiles.

Ali Manji (amanji@ca.ibm.com), Software Developer, IBM

photo of Ali ManjiAli Manji is a software developer with the Rational Insight team. He has several years of experience with Rational software and in working with many IBM products. You can follow him on Twitter @torontoIBMer.



23 July 2013

This article explains how to deploy IBM® Rational® Reporting for Development Intelligence (RRDI) 2.0.3 to a federated IBM® WebSphere® environment. Typically, such an environment involves a WebSphere cell that includes a deployment manager profile and one or more application server profiles. All are managed by the Deployment Manager, thus "federated."

RRDI managed deployment architecture

The deployment topology of RRDI used in this article consists of a single physical workstation running a 64-bit version of Microsoft® Windows 2008 server, service pack 2, and the RRDI software requirements:

  • A supported application server
  • A supported database server.

For performance or scalability considerations, you can install the database server on a separate workstation. If you choose this, you must install the database vendor's 32-bit client software on the RRDI workstation.

To follow the steps in this article, use IBM® DB2® Enterprise Server Edition and IBM® WebSphere® Application Server Network Deployment.


Software prerequisites

First, set up the single physical workstation server to deploy with the following software:

  • IBM® Installation Manager 1.6.2, 32-bit.
  • DB2 10.1 with fix pack 2, Enterprise Server edition, 64-bit.
    • When installing the DB2 Server, select the option enable operating system security. This creates the operating system groups DB2ADMNS and DB2USERS. Create a reporting user account (rptuser) to run reports and carry out other reporting tasks that require the access provided by the DB2ADMNS group.
  • WebSphere Application Server Network Deployment 8.5.0.2, 64-bit JDK SDK
    • The architecture level of the Java SDK installed with WebSphere Application Server must match with the bit-level of the RRDI architecture that you plan to install. This article assumes a 64-bit installation deployment for RRDI.

Notes:

  • For this article, assume that you have root user access for Linux® or UNIX® or Administrator user privileges for Microsoft® Windows®.
  • This deployment topology houses the DB Server and RRDI on the same physical workstation. If the DB Server is on a separate workstation, then you must install a 32-bit database client on the same workstation as RRDI. The database client must be 32-bit even if the database server installation is 64-bit.

Install RRDI using Installation Manager

If you install RRDI on a workstation running Linux, complete these steps before proceeding.

  1. Start IBM Installation Manager: Start > All Programs > IBM Installation Manager > IBM Installation Manager.
  2. Click Install.
  3. Select the checkbox for IBM Rational Reporting for Development Intelligence then click Next >.
  4. Close any programs currently running. Disable or shut down any running or active antivirus software. Adhere to any applicable validation warnings that you see before you click Next >.
  5. Select the I accept the terms in the license agreements radio button, then click Next >.
  6. On this page of the install wizard:
    1. Update the value of the Installation Directory field, or, accept the default, typically C:\Program Files\ibm\RRDI.
    2. Select 64-bit for the Architecture Selection radio box.
    3. Click Next >.
  7. Select check boxes for any additional language translations that you need, then click Next >
    1. You can optionally select to install the Cognos Samples for Rational Report Server package before you click Next >.
  8. On the Review the summary information page, confirm the installation details.
  9. Click Install.
  10. After the installation completes, under Which program do you want to start? select the None radio box and click Finish.
  11. To close Installation Manager, select File > Exit.

Create a federated WebSphere environment

Create a WebSphere cell that includes a Deployment Manager and a federated application server. The federated Application Server is your target server for this RRDI application.

Use the WebSphere Profile Management Tool (PMT) to the WebSphere cell. If the PMT is not available on your target platform, you will need to consult the WebSphere documentation to determine the command line command to carry out the below steps.

  1. Open the Profile Management Tool. Start > All Programs > IBM WebSphere > IBM WebSphere Application Server V8.5 > Tools > Profile Management Tool.
  2. Click the Create... button.
  3. In the Environment Selection page of the profile creation wizard, select Cell (deployment manager and a federated application server) then click Next >.
  4. Select the Typical profile creation radio button (the default) then click Next >.
  5. The Enable administrative security checkbox is chosen by default. If you accept this default value, create a user name and password to log into the WebSphere Administrative Console with and click Next >.
  6. On the Profile Creation Summary page:
    1. Confirm the details. Note the Profile name and the Node name of the cell's Application Server profile. You will need to reference these values. In Figure 1, they are AppSrv01 and vega8Node01 respectively.
Figure 1. Deployment manager and application server profiles summary
WebSphere profiles with profile and node names
    1. Click Create.
    Uncheck the Launch the First steps console checkbox then click Finish.
  1. To close the Profile Management Tool, select File > Exit.

You now have two WebSphere profiles created.

  • Deployment manager profile, by default called Dmgr01.
  • Federated Application Server by default AppSrv01.

Configure the Application Server for RRDI

RRDI requires the target Application Server to set some configuration variables and settings. Configure these settings using the WebSphere Administrative Console after starting the required WebSphere servers. Throughout the rest of this article, the WebSphere Administrative Console is referred to as Admin Console

  1. To start the WebSphere Deployment Manager server. Start > IBM WebSphere > IBM WebSphere Application Server V8.5 > Profiles > Dmgr01 > Start the deployment manager.
  2. Open a command shell then navigate to: WebSphereInstallDir/profiles/AppSrv01/bin (for example: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\bin) then enter the command startNode.bat
  3. Open the Admin Console. Start > All Programs > IBM WebSphere > IBM WebSphere Application Server V8.5 > > Dmgr01 > Administrative console
  4. Enter the user id and password to log into the Admin Console.
    Note: This is the same user id and password specified in step 5 of the section Create a Federated WebSphere Environment.
  5. On the left menu pane, expand Servers then click All servers.
  6. In the main pane, click the server1 hyperlink.
    Note: If more than one hyperlink is labeled server1, select the one that corresponds to the Node of the Application used earlier and highlighted in Figure 1.
  7. In the Server Infrastructure section, locate and expand the section titled Java and Process Management then click the link for Process definition.
  8. In the Additional Properties section, click on the link titled Java Virtual Machine.
  9. Locate the Maximum heap size field then enter 1024.
  10. Click OK and then click the Savehyperlink.
  11. In the Additional Properties section, click Environment Entries.
  12. Define the COGNOS_DIR environment entry:
    1. Click New... .
    2. In the Name field, enter COGNOS_DIR.
    3. In the Value field, enter RRDIInstallDir/cognos (for example, C:/Program Files/IBM/RRDI/cognos).
      Note: Forward slashes are used regardless of operating system.
    4. Click OK and then click the Save hyperlink.
  13. To define the PATH environment entry:
    1. Click New... .
    2. In the Name field, enter PATH.
    3. In the Value field, enter RRDIInstallDir/cognos/bin64;RRDIInstallDir/cognos/bin (for example, C:/IBM/RRDI/cognos/bin64;C:/IBM/RRDI/cognos/bin).
      Note:
      Forward slashes are used regardless of operating system. For a 32-bit deployment, the value is: RRDIInstallDir/cognos/bin
      the entries are separated by a semi colon (;) on Windows platforms. On Linux and AIX platforms entries are separated by a colon.
    4. Click OK and then click the Save hyperlink.

Create the rptuser user to run reports with

During installation of the DB2 Server, you chose the option to enable operating system security. As a result, DB2 created an operating system group, DB2ADMNS. Users of this group have database administrator privileges.

Create a user account (rptuser) on the operating system. Make rptuser a member of the DB2ADMNS group. This gives RRDI a user account with sufficient privileges to start the database queries required to run RRDI reports and other tasks.

Create the rptuser account:

  1. To launch the Computer Management Windows utility. Start > Administrative Tools > Computer Management.
  2. To create a new user account:
    1. In the left navigation pane, select Computer Management (Local) > System Tools > Local Users and Groups > Users.
    2. Right-click then select New User... .
    3. Enter rptuser in the User name: field.
    4. Enter a password in the Password: field.
    5. Re-enter the password in the Confirm password: field
    6. Select, or deselect, other options appropriate for user management security at your organization.
    7. Click Create.
    8. Click Close.

Grant database administrator privileges to rptuser:

  1. In the main pane, select then right-click the rptuser account.
  2. Select Properties from the pop-up menu.
  3. In the Properties dialog window, select the Member Of tab then click Add... .
  4. In the Enter the object names to select (examples) field enter DB2ADMNS and click the Check Names button and then click OK.
  5. Click OK.
  6. To close the Computer Management utility, select File > Exit.

Run Setup to deploy RRDI to your federated WebSphere server

You will now run RRDI's setup application to deploy RRDI into your federated WebSphere Application Server.

Initialize the Setup application:

  1. Open the Setup application server. Start > All Programs > IBM Rational Reporting > Start the IBM Rational Reporting Setup Server. A command window opens. Wait until you see a message similar to the following before you proceed:

    INFO: Server startup in 29348 ms
  2. Open the Setup application browser interface. Start > All Programs > IBM Rational Reporting > Open the IBM Rational Reporting Setup.

    Note
    if you are on the Linux platform: Open a web browser then enter the Setup Application URI as https://fullyQuallifiedHostName:10443/rrdi/setup (for example, https://fatimazahra.canlab.ibm.com:10443/rrdi/setup).
  3. On the initialization page of the setup application:
    1. Enter https://fullyQualifiedHostName:10443/jts for the RRDI Setup Server URL.

      Note:
      The URL you enter here is different from the URL in step 2 that you used to start the actual Rational Reporting Setup application.
    2. Enter a user name in the User ID: field.
    3. Enter a password in the Password: field.
    4. Re-enter the password in the Retype Password: field.
    5. Check the box that acknowledges that you cannot change the URL without potentially adverse effects.
    6. Click Initialize.

      Note:
      If prompted to allow pop-ups: Allow the pop-up then refresh the browser window.
    7. In the pop-up login window, enter the user id and password used in steps b. and c. then click Log In.
    8. Click Yes when on the pop-up that requests your permission to allow the RRDI setup application to collaborate with the underlying Jazz team server.
  4. To select this scenario, click the link Set up Rational Reporting.

Create the content store database:

  1. On the Configure database Management System page of the Setup application:
    1. Check to see that DB2 is selected for database vendor:
    2. Enter the directory of DB2's JDBC driver in the JDBC driver location field: DB2InstallDir\java (for example, C:\Program Files\IBM\SQLLIB\java).
    3. Click Copy.
    4. Click Next.
  2. On the Configure Content Store database page of the Setup application:
    1. Check the Enable to create the local database box.
    2. Leave the default for database host as localhost.
    3. Leave the default for Port as 50000, unless you installed DB2 to run on a different port value.
    4. Leave the default for database name: as RICM.
    5. In the database administrator: field, enter a DB2 administrator user id.

      Note:
      The default for Windows is db2admin and the default for Linux is db2inst1.
    6. In the Password: field enter the database administrator password.
    7. In the Table space location: field type C:\DB2\NODE0000\RICM. You must create the full directory structure before proceeding.

      Note:
      On Windows, by default, DB2 puts table spaces below C:\DB2\NODE0000
      and on Linux below /home/db2inst1/db2inst1/NODE0000.

      However, the table space directory can be located anywhere on your file system that the DB2 server has read and write privileges. It does not need to be inside DB2's default storage area. The RRDI Setup application reads and writes to the directory you choose.
    8. Click Validate.
    9. After the validation is complete, click Create database.
    10. After the database creation is complete, click Next >.

Create the Reporting Data Warehouse database:

On the Configure Data Warehouse page of the Setup application, in the section Step 1: Configure data warehouse connection properties:

  1. Check the Enable to create the local database box.
  2. Leave the default for database host as localhost.
  3. Leave the default for Port as 50000, unless you installed DB2 to run on a different port value.
  4. Leave the default for database name as RIDW.
  5. For database administrator enter a DB2 administrator user id.

    Note:
    The default for Windows is db2admin and the default for Linux is db2inst1.
  6. In the Password: field, enter the database administrator password.
  7. In the Table space location: field enter C:\DB2\NODE0000\RIDW. You must create the full directory structure before proceeding.

    Note:
    The table space directory you choose can be located anywhere on your file system that the DB2 server has read and write privileges and does not need to be inside DB2's default storage area. This is because the RRDI Setup application reads and writes to this directory.

Under the section Step 2: Reporting user:

  1. Enter rptuser for Report user name and enter the password for rptuser in the Password field.

    Note: You created the rptuser account in the section Create the rptuser user to run reports with.
  2. Click Validate.
  3. After the validation completes, click Create database.
  4. After database creation completes, click Next.

Configure the deployment RRDI to the Federated WebSphere Server:

On the Configure Application Server Profile page of the Setup application:

  1. In the Application server installation directory field, enter the location of your WebSphere installation, for example C:\Program Files\IBM\WebSphere\AppServer.
  2. Check the Use an existing profile box.
  3. Enter Dmgr01 in the Profile name text field.
  4. Click Retrieve next to the Clusters and servers list box.
  5. After populated, select server1 (nodeName) where nodeName is the name of the node of your federated application server.

    Note: In Figure 1. nodeName is vega8Node01.
  6. For Node agent profile name, enter AppSrv01.

    Note:
    This is the same profile name as shown in Figure 1.
  7. Enter the user id and password used to log into the WebSphere Admin Console for the values of Administrative user and the Password fields respectively.
    Note: This is the same user id and password specified in step 5 in the section Create a Federated WebSphere Environment.
Figure 2. Deployment settings to deploy RRDI to a federated Application Server
configure application server properties
  1. On the Step 2: Validate and start the application server profile... page, click the Validate button.
  2. After the validation completes, click Next >.

Build and deploy RRDI to the Federated WebSphere Server:

You can enter details of a Jazz Team Server that you wish to integrate with for the purpose of reporting development activities. The integration is necessary to authenticate users from your Jazz development teams to run and administer reports. The integration with a Jazz Team Server also meets RRDI's licensing requirement.

This article does not include an exploration of this critical integration. That will be the subject of a future article. Because you will not explore the integration with Jazz Team Server in this article:

  1. Check the Enableanonymous access to the reporting server box in the Configure Rational Reporting User Authentication page, then click Next >.
  2. On the Build and Deploy Reporting Components page, click Deploy.
  3. The deployment process can take several minutes. When completed, click Next >.
  4. Click Finish.

Next steps

The deployment of Rational Reporting for Development Intelligence is complete. What comes next?

Next you will want to:

  1. Integrate your RRDI installation with a Jazz Team Server (JTS) to report against your Collaborative Lifecycle Management (CLM) development projects.
  2. Import reports from RRDI into your Jazz Report pages and dashboards to supplement the out-of-the-box Business Intelligence and Reporting Tools (BIRT) reports provided by Jazz.
  3. Set up access permission to determine which users in your JTS can run which reports.

Summary

This article showed, step-by-step, how to create a federated WebSphere environment for deploying Rational Reporting for Development Intelligence.


Acknowledgment

The author thanks Cheng-Yee Lin for his detailed review of this article.

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, Mobile development
ArticleID=937028
ArticleTitle=Deploy Rational Reporting for Development Intelligence 2.0.3 to a federated environment
publish-date=07232013