uc.pngInstalling, configuring and deploying the RRDI p2pd.ear file on WAS in a federated environment

Authors: PhilippeChevalier
Build basis: Products, editions, or versions that apply to the content. If no build basis applies to this content, set the build basis to None.

#Introductory paragraph

Configuring the report server

During installation you opted to manually install the report server, configure the WebSphere Application Server instance to host the report server, and build, deploy, and install the enterprise archive (EAR) files.

Here is a high-level list of the configuration tasks

  1. Create and configure a new WebSphere Application Server profile to host the report server on a federated instance.
  2. Setup the Jazz Name Space
  3. Configure the RationalReport profile to host the report server.
  4. Build the report server enterprise archive (EAR) file.
  5. Install the report server enterprise archive (EAR) file.

Create and configure a new WebSphere Application Server federated profile and the report server

The following will describe the creation of a WebSphere node on a Deployment manager instance. Create and configure the server profile for support of the IBM Cognos EAR file.

In this section you will find three topics:

  • Creating the new federated node to host the Reporting server's Application
  • Creating the server instance to support the IBM Cognos EAR file
  • Configure the RationalReport profile to host the report server

Creating the new federated node to host the Reporting Server's application

  1. Navigate to the $WAS_INSTALL/bin/!ProfileManagement directory.

The WAS_HOME by default is usually /opt/IBM/!WebSphere/!AppServer. In the case of this document the value will reflect the WebSphere application server version number used /opt/IBM/!WebSphere/!AppServer855

  1. Start the Profile Management tool using the following command:


This pmt.sh tool will open a GUI interface to create WebSphere profiles.



To create Profiles, use the “Create” button on the right side of the window. You will be sent to the next panel called 'Environment Selection'.


As shown in the figure above, Use the option 'Custom profile', and click 'Next' at the bottom of the window.

The next panel will be the 'Profile Creation Options'.


You will be selecting the profile type, To create a managed node select the 'Advance profile creation' option, and then select next.

This will lead you to the 'Profile Name and Location' panel.


Replace the 'Profile name' and 'Profile directory' fields with the name for the profiles and its location. In this case we will use RationalReport for the profile name and update the profile location to target the $WAS_HOME/profiles/!RationalReport (see the above figure). Click on the 'Next' button at the bottom of the window.

The following panel will be called 'Node and Host Name'. On this panel you will be assigning the node name and the host name for the profile you will be creating.


In this panel we selected to call the node myserver2Node2 and the host name was myserver2.ibm.com. The Node reference *Node2 because on the machine used for this example *Node1 was already used.

Click Next to move to the next panel called 'Federated'. You will need a few details to setup the federated environment

  • The host name of the Deployment Manager (Dmgr)
  • The SOAP port for the Dmgr
  • The WebSphere administrator user name and password

Caution: the Dmgr service must be up and running already, make sure that it is.


In this case the host name was myserver.ibm.com, the SOAP port was 8879 (default) and the user name was wasadmin.

Note: To collect the SOAP port of the Dmgr, log in to the Dmgr console and navigate to the 'System administration → Deployment manager' using the right side panel of the console, select the link. On the Left you will find a link called 'Ports' with a + sign beside it. Select the + sign and this will reveal the ports assigned to the Dmgr.


You may see a check box to 'federate the node later' make sure it is unchecked.

Click on the Next Button.

The new panel will be Security Certificate (Part 1),


Leave the default values and click on the Next Button

The new panel will be Security Certificate (Part 2)


Like the previous Panel leave the default values. The Default keystore password is WebAS.

Click on the 'Next' button.

The Panel will now be called 'Port Value Assignment'. Generally the profile creation will target ports that have not already been assigned on the server. Review the values to find any port conflicts.


Click the Next button.

The last panel will be called 'Profile Creation Summary'. You will find a short summary of the details you selected for the profile creation.


To Complete the task, click on the 'Create' button. You will see a new panel called 'Profile Creation Progress' which will report back the progress of the setup task.


The last panel is the 'Profile Creation Complete' panel,


Select the Finish button and close the Profile Management Window.

To validate that the new profile, or in this case the server node was added to the Dmgr. Log in to the Dmgr console, and on the left Panel of the Console navigate to the 'System administration --> Nodes'. On the Right Panel you will see the new registered node.


It is possible that you find that the status of the node Is not consistent with the other nodes. If this is the case, select the check box beside the myserver2Node2, and click on the Synchronize button at the top of the table view.


The status will become consistent with the other nodes.

It is also possible to review the node up status in the 'System administration --> Node Agents'


  • Creating the server instance to support the IBM Cognos EAR file

You may expect since the server Node was added to the Dmgr, the RationalReport server be already in place. To verify, navigate to the '!WebSphere application servers' link on the left panel of the Dmgr console.


As you see the image above, the RationalReport server was not added. Running the Profile management tool with the option selected in the process above only created a WebSphere node to support new server instances on the myserver2Node2.

It is now time to create the RationalReportServer. Click on the 'New...' button at the top of the table view. The view will change to a panel called 'Create a new application server'. Using the 'Select node' field select the arrow on the right and click on the newly created node 'myserver2node2' and provide a name for the new server. In this case we will use '!RationalReportServer'


Click on the 'Next' button.

This will lead you to a new panel. Select the template for the Application server you are creating.


Use the template 'default', and click on the 'Next' button.

The new panel will be port selection.


To simplify the process this example will use the 'Generate Unique Port' option, and click next.

The last panel is a summary panel.


Review details and click on 'Finish'.

This will return you back to the 'Application servers' table. You will also have an extra message panel at the top of the panel. This is message will be a reminder to save the master configuration. You should also see the new '!RationalReportServer' instance


Click the 'save' link to save the master configuration.

Note: WebSphere application server configuration very often required the master configuration save action. It is recommended that you select the save link as often as possible to avoid losing any configuration points. This document will not repeat this action item, please keep it in mind.

After the master configuration has been saved, return to the '!WebSphere application server' link on the left panel. The newly created server status will be marked as down. We now need to test the server by starting the application and reviewing the SystemOut.log.

To start the server, select the check box beside the RationalReportServer and click on the start button at the top of the table view.


If the start process should be completed with a green arrow in the status column.

To double check the status of this new server you should review the SystemOut.log file. This files will be located in the WAS_HOME/profiles/$PROFILE_NAME/logs/$SERVER_NAME

Example: /opt/IBM/!WebSphere/!AppServer855/profiles/!RationalReport/logs


Generally if you do not see any Java Exception and you see the message “Server RationalReportServer open for Business”.



At this point you have successfully created the WebSphere application node and server instances.

Configure the RationalReport profile to host the report server

Using the Dmgr Console, verify that the RationalReportServer is up and running. Using the left panel of the console navigate to the '!WebSphere application servers' and select the link.


Click the RationalReportServer link and, in the Server Infrastructure section, expand the Java and Process Management node, continue and select the Process Definition link, and click the Java Virtual Machine link.


The bread crumb links should be Application servers > RationalReportServer > Process definition > Java Virtual Machine.

In the configuration tab, Enter inital and maximum JVM heap size. In the field 'Initial heap size' set the value to 256 and the 'Maximum heap size' set the value to 1024.


Click the 'Apply' Button at the bottom of the page. Your page should be back to Application servers > RationalReportServer > Process definition

On the top right side of the page, select the 'Environment Entries' link


In this configuration panel you will be entering three environment variables.


  • PATH=[INSTALLDIR]/cognos/bin:[WebSphere_Install_dir]/java/jre/bin/classic:[WebSphere_Install_dir]/java/jre/bin

  • LD_LIBRARY_PATH=[WebSphere_Install_dir]/java/jre/bin:[INSTALLDIR]/etl/odbc/lib:/usr/local/lib:[INSTALLDIR]/cognos/bin:[DB2_Install_dir]/lib32


Click Apply, and click Save.

If you are using administrative security, expand the Security node on the left sidebar and then disable administrative security by clearing the Enable application security option. Click Apply, and click Save.

Restart the RationalReport profile. by stopping and starting the report server.


Setup the Jazz Name Space, create the jazzns_config.xml file

This task is divided into two sections:

  1. Create the JTS Comsumer key
  2. Modify the RRDI Jazz names space configuration file, jazzns-config.xml

Steps to Creating the JTS consumer key

Open the Jazz administration page at https://$HOSTNAME:$PORT/jts/admin.

Example: https://myserver.ibm.com:9443/jts/admin

Enter the user ID and the password. The user ID must be a member is the JazzAdmins group.

Navigate to the Admin page, click Server (at the upper left).


In the left Panel, select 'Consumer (Inbound)' link.

You should land on the 'OAuth Consumer' page.


In the Consumer Key field, do not enter anything. The key is automatically generated after you provide the necessary information.

Specify the consumer name to be com.ibm.rational.reporting.

Specify a consumer secret and enter it again in the second box.

Select Trusted.


Click Register. The Consumer Key is generated automatically.


Once the Consumer entry in created, navigate the new key and select the pencil in the actions column.

A new window titled 'Edit Consumer Key Properties' will appear, find the 'Select user …' link on the page and select the link. Search and assigned a user from JazzAdmins group. It is suggested to use a functional user. In this example, wasdmin will be used.


Once the selection has been made, click on the 'Add and close' button. You will be back on the 'Edit Consumer Key Properties', find the click the button 'Finish'.

The new record should be visible in the 'Consumer Name' list with the Functional user assigned to it.


Key this information handy, since it will be required for the RRDI Jazz name space configuration file jazzns-config.xml

Steps to Modify the RRDI Jazz names space configuration file, jazzns-config.xml

The jazzns_config.xml file defines the location and the authentication requirements for Jazz name spaces and identifies the RRDI server's URL. It is important to understand what are the Jazz OAuth requirements and the host name and port the jazz Team Server and RRDI server will be using before setting up this files.

To modify the jazzns-confgi.xml file, the application server supporting the Cognos applications must be down if the EAR file has been previously deployed.

Find and navigate to the jazzns-config.xml template file location. You locate this file in the following directory $RRDI_HOME/setup/rrdi/clm/cognos/configuration

Example: /opt/IBM/RRDI206/setup/rrdi/clm/cognos/configuration

Copy the jazzns_config.xml file to the $RRDI_HOME/cognos/configuration directory, using command cp jazzns_config.xml $RRDI_HOME/cognos/configuration move the terminal session work directory to $RRDI_HOME/cognos/configuration.


#> cp jazzns_config.xml /opt/IBM/RRDI206/cognos/configuration

#> cd /opt/IBM/RRDI206/cognos/configuration

The content of the file should expose 4 token that the setup tool uses to Identify the fields that requires modification. Each of these values are associated to the OAuth Consumer key of the Jazz Team Server or the report server URL.

1.[TOKEN_JAZZ_SERVER_URL] = Is the location of the Jazz Team Server targeted for the use of authentication. Format of the string “http://$SERVER:$PORT/jts

Example: https://myserver.ibm.com:9443/jts

Note: Port is optional, depending if your using the one of default HTTP(S) Ports 80 or (443). Make sure that the Jazz Team Server URL includes a fully qualified host name

2.[TOKEN_OAUTH_KEY] = Is the value of the consumer key we defined in the Jazz administration page 'OAuth Consumers'. From the 'Authorized Keys' table use the key in the 'Consumer Key' defined for the 'Consumer Name' com.ibm.rational.reporting we just created in section 'Steps to Creating the JTS consumer key'

3.[TOKEN_OAUTH_SECRET] = Used the secret used when the we defined the consumer key com.ibm.rational.reporting

4.[TOKEN_REPORT_SERVER] = Use the URL for the reporting server. Format of the string http://$SERVER:$PORT/reporting/servlet/dispatch

Example: http://myserver2.ibm.com:9085/reporting/servlet/dispatch

Note: Port is optional depending if your using the one of default HTTP(S) Ports 80 or (443). Make sure that the report server URL includes a fully qualified host name

The following is an example of the jazzns_config.xml template.

<jazz-namespace encrypted="false"> <jazz-server url="[TOKEN_JAZZ_SERVER_URL]" oauth-key="[TOKEN_OAUTH_KEY]" oauth-secret="[TOKEN_OAUTH_SECRET]"/> <report-server url="[TOKEN_REPORT_SERVER]"/> </jazz-namespace>

Using the text editor of your choice open the jazzns_config.xml file, and modify the token with the values required.

Make sure that the values of OAuth key and Oauth secret are the same as the values specified for the consumer name and password entries on the Jazz Team Server.

Set the value of the jazz-namespace 'encrypted' property to false.

Note: The OAuth key values are stored is in plain text when you save the jazzns_config.xml file. The string will be automatically encrypted when the report server starts and the 'encrypted' attribute will be reset to true.

Add an attribute to the jazz-namespace tag setEmailAsUserName="true"

Example Modify:

<jazz-namespace encrypted="false">


<jazz-namespace encrypted="false" setEmailAsUserName="true">

Note: The setEmailAsUserName is used to set the display name on the reporting server's, if the value is set to false the JTS repository User ID will be used. Under some circumstance, particularly with the Insight product using the UID can lead to duplication of User information. Generally and email address is a unique Identifier and is recommended.

Example results:

<jazz-namespace encrypted="false" setEmailAsUserName="true"> <jazz-server url="https://myserver.ibm.com:9443/jts" oauth-key="83d37bfe91934da3ab42bbacf0ddda10" oauth-secret="secret"/> <report-server url="http://myserver2.ibm.com:9085/reporting/servlet/dispatch"/> </jazz-namespace>

Save the changes to the jazzns_config.xml file.

Setup the IBM® Cognos® Configuration tool

Note: The following section modifies manually the cogconfig.sh file. Backing up of the file is recommended.

Modify the conconfig.sh file to support the WebSphere JRE and update the LD_LIBRARY_PATH environment variable

Two edits of the $RRDI_HOME/cognos/bin64/cogconfig.sh file is required. The JAVA_HOME variable will be added using the WebSphere JRE and modification of the LD_LIBRARY_PATH will be required. Choose the Editor of you choice, the following examples will use the vi editor.

Example of Path: /opt/IBM/RRDI206/cognos/bin64/cogconfig.sh

The first Edit The JAVA_HOME variable, navigate to the $RRDI_HOME/cognos/bin64. Right after the initial comment section of the cogconfig.sh add the command “export $WAS_HOME/java/jre”.

Example: export JAVA_HOME=/opt/IBM/WebSphere/AppServer855/java/jre




Related topics: Deployment web home, Deployment web home

External links:

Additional contributors: TWikiUser, TWikiUser

This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Ideas, requests, problems regarding the Deployment wiki? Create a new task in the RTC Deployment wiki project