Is Relm Needed For The Jazz Reporting Service

Configure Jazz Reporting Service for instances of Collaborative Lifecycle Management applications

Amarpreet Singh, Team Lead, Accenture
Terminal updated: March sixteen, 2015
Build basis: Rational solution for Collaborative Lifecycle Management 5.0

This page describes a usage or software configuration that may not exist supported past IBM.

Reporting is one of the key features available in the Rational solution for Collaborative Lifecycle Direction (CLM) applications. The reporting feature helps to generate reports using the integrated lifecycle toolset. You tin quickly and easily consolidate data from a multifariousness of data sources across your tools and project areas. Jazz Reporting Service provides a set of ready-to-use reports that you can use to share information virtually your lifecycle management projects. You can integrate the reports with your dashboards by adding widgets from the Jazz Reporting Service catalog.

CLM is a set of seamlessly integrated applications that work together equally 1 platform for managing the complete lifecycle of your evolution projects. The application and lifecycle data that your teams creates collaboratively for their projects is provided to you for reporting in a data warehouse. This article introduces an all new set up of capabilities and reports that permit you to set-upwards dashboards that show y'all the condition of your unabridged project portfolio, aggregating data beyond applications, across projects, and even across various timelines.

This commodity does non focus on how the tool works and how to utilise information technology in terms of theory. It will serve primarily as a build certificate for a WAS contour and JRS installation, and explain the configuration and integration with CLM tools.

The WAS server setup & installation

We can host Jazz Reporting Service on either Apache Tomcat or on WebSphere Application Server. Tomcat is included with Jazz Reporting Service and is configured when you lot install the application. If yous programme to host Jazz Reporting Service on WebSphere Awarding Server, before you can install Jazz Reporting Service and deploy the State of war file, you lot must create a profile and configure the application server.

I am deploying the Jazz Reporting Service on a separate WebSphere Awarding Server. You must create a new contour, 1 for Jazz Reporting Service. One advantage of using divide profiles for reporting and for lifecycle applications is that they can be managed independently.

Installing IBM Installation Manager

Installation Manager v1 1.7.iii or latest version that's available at that time of your installation.

Locate the installation folder for IBM Installation Manager. For example: IBM RationalIBM Installation ManagerIBM Installation Director V1.7.3 agent.installer.win32.win32.x86_64_1.vii.3000.20140521_1925.goose egg
Double-click on Install.exe to kickoff installing Installation Manager V1.7.3 and click Next to start installation.
Click on I have the terms in the License agreements option and click Next.
Install the installation managing director in to a directory so that the path does not contain whatever spaces. For example: "C:IBM"
Select a location for Installation director and click Next.
Click on Install.

Installing WebSphere Awarding Server

IBM WebSphere Application Server must be installed on the same server where your CLM solution is installed.

Note: WAS viii.five is a base of operations installer and viii.5.0.2 is a Fix pack on the top of WAS v8.5. In social club to install WAS v8.5.0.2, we will install WAS eight.5 and Fix Pack 2 together along with the WAS SDK Gear up Pack.

Download the base version and the Fix Pack of the WAS v8.5 from the location establish at "IBM RationalIBM WebSphere Application ServerIBM WebSphere Application Server V8.five"
Start IBM Installation Director. In Installation Director, click File > Preferences and and then select Add together Repository. For the Repository location, browse to the directory where yous extracted the Base WAS 8.5.zippo file and open the repository.config file.
To install the Fix Pack for Websphere Awarding Server using a local repository, unzip the eight.5.0-WS-WAS-FP0000002-part1 and viii.5.0-WS-WAS-FP0000002-part2 .zip files to the one folder and copy "native" file that you will get from "viii.v.0-WS-WAS-FP0000002-part2 .nada" and paste information technology into "8.five.0-WS-WAS-FP0000002-part1" file on your local automobile. Both zip files are merged into single set up pack binder. Indicate the Installation Manager to the repository.config file which exists in this folder. Click OK to finish calculation preferences, and so click Install to start the installation procedure.
Note: When unzipping part2, the Windows operating system might warn you lot that a directory with the same proper noun already exists. Allow the tool to merge the directories; the tool does not overwrite any files.
Add together the repository "viii.5.0.0-WS-WASJavaSDK-WinX64-IFPI19108" (WAS Security Fix) and click OK to finish the adding preferences. Then click Install to outset the installation process.
Click on Install>IBM WebSphere Application Server>Adjacent.
Select the WAS Java SDK fix on the next screen and click next.
Select Create New package group. Modify the default installation directory and provide the installation path every bit "C:IBMWebSphereAppServer". Click Next.

Over again, recall to avoid spaces in the path if at all possible.
To install additional languages, select one or more languages and click Next.
Select the post-obit checkboxes
- IBM WebSphere Awarding Server viii.5.0.2 Full Profile
- IBM 64-bit WebSphere SDK for Java.
Uncheck the following checkboxes
- EJBDeploy tool for pre-EJB three.0 modules
- Sample applications
- Stand-solitary sparse clients, resource adapters and embeddable containers.
Click Next. Provide the disk locations as prompted, then Click on Next and finally on Cease.
Verify the packages that are to be installed and click on Install.
When the installation completes, select None and click Finish.

Install IBM HTTP Server

Download the base version and Set up Pack of the Supplement_8.five from the location found at "IBM RationalIBM WebSphere Awarding ServerIBM WebSphere Application Server V8.five" "
Re-create the following zip files and extract it locally.
E:IBM RationalSupplement_8.5WAS_V85_SUPPL_1_OF_3.cipher
E:IBM RationalSupplement_8.5WAS_V85_SUPPL_2_OF_3.zip
E:IBM RationalSupplement_8.5WAS_V85_SUPPL_3_OF_3.zip
Start IBM Installation Manager. In Installation Manager, click File > Preferences and then select Add together Repository. For the Repository location, browse to the directory where you lot extracted the WAS_V85_SUPPL_1_OF_3.zip file and open the repository.config file.
Select the packages to be installed and click on Adjacent.
- IBM HTTP Server for WebSphere Application Server
- Web Server Plug-ins for IBM WebSphere Application Server
- WebSphere Customization Toolbox.
Take the license understanding and click on Side by side.
Provide installation directory path for each package and click on Next:
- IBM HTTP Server for WebSphere Application Server – Installation Directory: C:IBMHTTPServer
- Spider web Server Plug-ins for IBM WebSphere Application Server – Installation Directory: C:IBMWebSpherePlugins
- WebSphere Customization Toolbox – Installation Directory: C:IBMWebSphereToolbox
Select the following checkboxes and click on Next:
- IBM HTTP Server for WebSphere Application Server 8.5.0.ii
- Select IBM 64-bit WebSphere Runtime Surroundings for Java
- Web Server Plug-ins Configuration Tool
Ensure the radio button Log on as a local organization account is selected. Click on Next.
Provide the locations of the disks as prompted and click on Next > Install.
When the installation completes, select None and click Finish.

Start IBM HTTP Server and IBM HTTP Administration from services console. You lot should exist able to reach the URL http://hostname/ to brand certain HTTP Server is upward and running for.

Creating WAS profiles

Important Notation: This section should be washed for each CLM case. One WAS contour tin support only i CLM instance. A new WAS profile should be created for each CLM instance that needs to be installed.

To create a profile, open up a command prompt.
Change directory into the WAS directory. For example: CD <WASINSATLLDIR>Appserverbin
Execute the following command:
manageprofiles.bat –create -profileName "<Contour Proper name>" -winserviceCheck true"

Installing the Jazz Reporting Service

Download JRS from jazz.net and extract it. (I am using the web installater)
Initiate the launchpad by clicking on Launchpad. Information technology will open up Welcome page. Click Next.
On next folio Select the JRS and Click Next.
Click on Install the Jazz Reporting Service.
On the Installation Director login window pop for jazz.net, supply the login detail and click OK (Note: This is for when performing a web installation merely.)
Select JRS package and click Adjacent. On the validation folio click Next after validating the prerequisites.
On the License page, accept the license past clicking Next. Supply an installation directory path and click Adjacent.
On side by side page select the language and click Adjacent.
Select any required features and click Next.
At present click on Install. In one case installation is complete click on Terminate.

Deploying Jazz Reporting Service on WebSphere Awarding Server

Afterward you finish installing theJazz Reporting Service, the application server that hosts Jazz Team Server and Jazz Reporting Service must be configured. When deploying Jazz Reporting Service on WebSphere Application Server, you must deploy the State of war file. On the application server, the JAZZ_HOME custom property must exist set, and the shared library created.

Procedure

Log in to the WebSphere Application Server administrative panel for the profile into which Jazz Reporting Service will exist deployed. https://localhost:9043/IBM/panel
In the WebSphere Awarding Server administrative panel navigation pane, expand Environs and click Shared libraries.
Click on New under Shared Library Mapping. Enable the bank check box for Form loading (Use an isolated course loader for this shared library).
Click Employ and Save to principal configuration.
In the WebSphere Application Server administrative console navigation pane, aggrandize Applications, then Application Types, and click WebSphere Enterprise Applications.
On the Enterprise Applications page, click Install.
Click Browse and navigate to the post-obit State of war file:
<install path>/jrs/JazzTeamServer/server/tomcat/webapps/rs.state of war
For details about how to choose a path, click the help link to the right.
Click Open then click Next.
In the Preparing for the application installation window, select Fast Path and click Next.
Go along through the setup magician, accepting all the default values. On the terminal page, click Stop and then click Save.
On the Enterprise Applications page, in the list of resources, click rs_war.
On the Configuration folio, in the References department, click Shared library references.
Select the rs_war bank check box and click Reference shared libraries.
In the Available list, select JRS Shared Library and click the right arrow.
Click OK. Click OK again and then click Save.
In the list of resource, click rs_war.
On the Configuration folio, under Item Properties, click Class loading and update detection.
In the Class loader order group, ensure that Classes loaded with local class loader first is selected. Click Utilise and then click Save.
In the listing of resource, select the rs_war check box and click the Start icon.

Installing JDBC drivers with Jazz Reporting Service

We demand to install the JDBC drivers to admission the Collaborative Lifecycle Management applications. We can ascertain information sources that correspond to an SQL and Oracle database (Jazz Reporting Service includes an embedded DB2 driver), specifically the data warehouse that is created past the Rational solution for Collaborative Lifecycle Management applications. Several unlike databases are supported for the data warehouse, such as DB2, Oracle, and Microsoft SQL Server. For Jazz Reporting Service to communicate with the database, the respective Java Database Connectivity (JDBC) driver must be installed with Jazz Reporting Service.

The following Java Database Connectivity (JDBC) drivers are required:

For Oracle 11g: ojdbc6.jar. You tin download the JDBC driver from this link Oracle JDBC Driver .
For Microsoft SQL Server: sqljdbc4.jar. You tin download the JDBC driver from this link Microsoft JDBC Driver 4.0 for SQL Server.

The mechanism that is used to install the JDBC drivers into Jazz Reporting Service depends on the application server that yous are using.

WebSphere Application Server

When Jazz Reporting Service is installed into the WebSphere Application Server; yous must add together the JDBC commuter files to the shared library.

Process

Locate the Jazz Reporting Service installation folder.
Re-create the database vendor'southward commuter into the server/conf/rs/WAS_sharedLibrary folder.
Go to the [WASinstallDir]/profileName/bin folder, end WebSphere Awarding Server and and then restart the server

Running the setup wizard

The setup wizard will run through setting up the database, configuring email settings, configuring the user registry, and registering applications. The wizard will notice and allow you to setup the applications that y'all have just installed. Earlier you begin, be sure that the databases must take been created for each application (JTS & JRS).

About this task: Consummate each footstep in this wizard to configure the Jazz Team Server and the applications which have just installed. Return to the wizard and start over once more for making whatsoever changes after setup is complete.

After the applications are configured, the Public URI cannot be modified

Steps:

Ensure that yous have started the server by post-obit the instructions in the Deploying and starting the server department.
Point a web browser to the following accost: https:// <FQDN of CLM server>/jts/setup Note: Turn off the popup blockers.
When the Jazz Team Server login folio appears, login as an LDAP registered user who has JazzAdmin privileges.
Select the Custom Setup option and click Next.
On the Configure Database page, provide information to fix a connection to the database
On the Enable Email Notification page, select Enable electronic mail notification. If y'all cull to enable notifications, you will need to provide information virtually your electronic mail server and exam the connection to the e-mail server. Click Next after making your selections and testing the connection.
On the Summary folio, you can review the server settings and cull ane of the following options: Click Create Users or Cease to admission the Jazz Squad Server Assistants UI where you can manage the server, users, and licenses.

Registering Jazz Reporting Service as an application

Now that the Jazz Reporting Service application prepare upwards has been completed, you must register the Jazz Reporting Service as an authorized application on the Jazz Team Server. The steps required to register the Jazz Reporting Service depend on how you deployed the awarding. If you programme to use the same JTS as your other lifecycle applications, follow the steps in this topic to annals the Jazz Reporting Service as an authorized application on the JTS server.

If you plan to utilize Jazz Reporting Service with its own Jazz Team Server, you must run the custom setup wizard to configure the Jazz Team Server and register the Jazz Reporting Service. Meet Running the Custom setup in the Rational solution for Collaborative Lifecycle Management documentation.

For the next department, ensure that;

You lot have authoritative access to the Jazz Squad Server application.
You have started the Jazz Squad Server and the Jazz Reporting Service application server.

To configure Jazz Reporting Service as an application on the Jazz Team Server, complete the following steps:

Log in as a JazzAdmin user to the Administration folio of the shared Jazz Team Server where you configured your lifecycle applications. The URL will be something like: https://server:9443/jts/setup
Click Side by side until you get to the Register Applications folio, then click Add.
In the Add Application window, enter the post-obit details for the Jazz Reporting Service application:
Click on Annals Applications
Click Finish.

Configuring the IBM Jazz Reporting Service

As an ambassador with Jazz administrative privileges, or a study manager, you lot can add together and edit Jazz Reporting Service data sources. For example, you can update the countersign that is required to connect to a data source, or specify a new location for a data source as part of balancing workload amidst servers in a distributed environment. Data sources identify the location of the data stores that are used past queries.

Connecting to data sources: An administrator with Jazz authoritative privileges must connect to the information source that was installed as part of the Rational product that uses Jazz Reporting Service. After an administrator or a report manager adds a data source, they must also institute a connection to it.

In a browser window, open the Setup page at https://server:port/rs/setup
Click Connect to information sources.
Optional: To view or edit the data source properties, click Data Sources on the product imprint or in the Connect to data sources pane.

Activating Jazz Reporting Service fix-to-utilise reports

Jazz Reporting Service provides a collection of set-to-use reports for agile tracking and planning, such every bit blocking work items, build wellness, and prioritized defects. Afterward you activate these reports from the Setup page, they are available as widgets that squad members can add to Jazz dashboards. You lot can also import reports that have been provided to you lot in an annal (.null) file. The gear up-to-apply reports from Jazz Reporting Service are Open Social gadgets. On Jazz dashboards, these gadgets are called widgets

In a browser window, open the Setup page at https://server:port/rs/setup
Click Import set up-to-use reports to get the ones from the product, or Import additional reports to become reports from an archive (.zip) file from IBM, Business Partners, or other sources.

Assigning Jazz Reporting Service report managers – As an administrator, you tin can designate other squad members to report managers function . These users are typically administrators or project managers who oversee a gear up of projects and need access to reports about tracking and planning. Written report managers and jazz administrator can import boosted reports, edit reports created by other squad members, and add or edit data sources

In a browser window, open up the Setup page at https://server:port/rs/setup
Click Choose study managers.
Add or remove users, and click OK.

Team members tin can access the reports in the post-obit means:

From the Use page of Jazz Reporting Service
From their dashboards, calculation widgets from the itemize. The dashboards must take a friend relationship with Jazz Reporting Service, and team members must have permission to modify their dashboards.

Include Jazz Reporting Service in your integrated lifecycle toolset

Jazz Reporting Service can interact with other products on the Jazz platform. For this to work, each server must have the other servers on its list of friends. The link between two servers is called a friend link. These friend links are required if you want to include Jazz Reporting Service widgets in your dashboards.

Friend requests from others applications require authorization. When you lot set up friend links, the Consumer tin can request provisional OAuth keys; nonetheless, the keys are not agile until they are authorized by a Jazz Ambassador. To authorize the provisional key that the friend server generates, you must have Jazz Administrator privileges on the friend server.

We demand to establish communication between the Jazz Reporting Service server and other applications to use azz Reporting Service. To do this we need to create Outgoing Friend relationships with each awarding. This advice is required if you want to include Jazz Reporting Service widgets in your dashboards.

For each lifecycle application, create a Friend relationship by completing the following steps:

Log in to the application's Administration folio: https://server:port/application/admin where application can exist rm, ccm, or qm.
Click Server and in the Advice section, click Friends (Outbound).
In the Friends List section, click Add.
In the Add Friend dialog box, enter the following data to define the friend relationship:
Name, Root Services URI and 'OAuth Secret' and Re-type Secret
Select the Trusted check box.
Click Create Friend. If the friend is added successfully, a message indicating that a provisional key was generated is displayed.
Click Next.
In the Authorize Provisional Key dialog box, click Grant access for the provisional key. If the account that you used to log in does not take administrator privileges on the friend server, a login window for the friend server is displayed.
In the Authorize Provisional Central dialog box, click Corroborate. A message is displayed indicating that the conditional key has been marked as Approved.
Click Cease. On the Friends page, the friend relationship is established and the relationship is displayed in the list of friends.
On the Jazz Reporting Service server, accept the friendships by completing the post-obit tasks:
Become to Jazz Team Server on which Jazz Reporting Service is registered. For example: https://server:9943/jts/admin
On the Administration page, click Server.
From the bill of fare on the left side of the page, under Communication, click Consumers (Inbound).
On the OAuth Consumers page, in the Conditional Keys section, where new requests are listed, complete the following steps:
- Consumer Name: To identify the application that uses the consumer key, update the field with the proper name of the application that is requesting admission to this application.
- Trusted: Select this check box if the consumer shares authorization with other trusted consumers.
- Authorized: Change the value from Pending to Approved.
Click Save

Projection area and study widgets access

Once you have installed and configured the Jazz Reporting Service and integrated it with your CLM servers all your users can immediately access the new gear up of reports for their dashboards. To practice so open the dashboard gallery by clicking the Add Widget push and select the new Jazz Reporting Service catalog. Here you can start browsing through the gallery of reports. As you encounter by the thumbnails shown next to each study we provide a mix of tabular array and different kinds of chart reports. In one case you lot found a written report of involvement click on the report name to get to a more detailed clarification.

Once added to the dashboard the report will prompt yous for filtering parameters that allow yous to set up the scope of the report to the projects and development iterations that you are interested in and for which you accept admission. Such selected filters are and then saved with the dashboard and can be changed at any fourth dimension by using the Filter and Edit buttons.

Conclusions

In this article we walked you through the installation and setup of a WAS server and profile as well as the installation of the Jazz Reporting Service and deploying it to a WAS server as independent application. We have covered the complete installation and configuration of JRS on a WAS server scenarios. We have also covered how to include Jazz Reporting Service in your integrated lifecycle toolset and how to use JRS reports. We covered typical usage scenarios of these reports ranging from cross-project status reporting and telescopic direction, to cross-team dependency assay, likewise every bit defect touch on and traceability reporting.

There are more reports bachelor in JRS that provide additional views on condition (such as open up stories for a team in the electric current iteration) as well as cover other CLM domains (such as Change Set Activity or Build success). Nosotros invite you to install the awarding and try them out and to provide u.s. with feedback and requests for additional reports.

References and more information

Installation roadmap: IBM Jazz Reporting Service @ jazz.net
https://jazz.cyberspace/wiki/bin/view/Main/ComplexCALMDeploy "Strength WAS To Honour Host Headers
IBM Rational Focal Bespeak Dashboards for Planning and Execution Add together On homepage @ IBM developerWorks
IBM Rational Engineering Lifecycle Manager @ ibm.com
Report Definition Resources @ IBM developerWorks
Installation roadmap: IBM Jazz Reporting Service @ jazz.net
The Jazz Collaborative ALM Self-hosting dashboard @ jazz.net
Timeline overview in the CLM online help @ jazz.net
https://www.youtube.com/watch?five=8uYTDbIrXG4
https://jazz.cyberspace/downloads/RRDI/releases/v.0?p=allDownloads
https://jazz.net/help-dev/clm/index.jsp?re=one&topic=/com.ibm.team.jp.jrs.install.dr./topics/t_jrs_prereq_appserver.html&scope=zilch
SSL Certificate Authentication
Bater, Robin (2014). Rational Reporting Made Simple: Using Out of the Box Reports @ YouTube.
Radatus, Catherine (2014). Reporting across CLM projects using the Jazz Reporting Service, Part 1,ii,three @ YouTube.