Download Release
April 23, 2019

Jazz Foundation

The foundation of the Collaborative Lifecycle Management solution

Jazz Foundation 3.0.1

Product Release / Trial | June 14, 2011
This is not the most recent version. We recommend Jazz Foundation . This is made available for archival purposes and may contain bugs and/or security vulnerabilities. If you do download this version, it is being provided AS IS, without warranties of any kind, including the implied warranties of merchantability and fitness for a particular purpose. We strongly advise you review the support pages for this version and update the product or take actions recommended therein. Security bulletins contain instructions for the security vulnerability addressed therein, and may require upgrading to a newer version. Link to security vulnerability blog: IBM PSIRT blog.

Jazz Foundation 3.0.1 News

Jazz Foundation 3.0.1 News

Here are some of the more noteworthy items appearing in the Jazz Foundation 3.0.1 release (June 14, 2011) which is now available for download.

Foundation Web UI

External Content viewlet

The External Content viewlet allows users to securely host content from their intranet or some other white-listed source on their dashboard.

External Content Viewlet

Display viewlet settings in read-only mode

Viewlet settings can now be displayed in read-only mode on dashboards that users do not have permission to modify.

Viewlet settings in read-only mode

Swap List Dialog filtering & ordering

The Swap List Dialog widget now allows users to filter entries via text in both the selected and unselected buckets.
Also, users can now specify the order of selected entries in applicable scenarios.

Swap List Dialog

Default personal dashboard

You can now configure your personal default dashboard using the new "Set as default dashboard" button in the dashboard toolbar. Clicking on the Home button in the banner will bring you to your default personal dashboard, and it will always be listed first in menus with a different icon.

Default dashboard

Improved catalog selector in widget catalog

We've improved the design of the catalog selector in the widget catalog to make it easier to use and understand. Applications and friends are now clearly separated, and there's more horizontal real estate so the menu items are no longer cut off.

Catalog selector

Mini Dashboard improvements

The menu at the top of Mini Dashboard now has paste and refresh commands.

Mini Dashboard improvements

Lifecycle Project Administration

The Lifecycle Project Administration (LPA) application is now included in the Rational Workbench for Collaborative Lifecycle Management. LPA provides administrators with the ability to create and manage projects and their members across all of the applications in the CLM Workbench.

LPA projects are created from an XML template that defines the structure of the underlying artifact containers. Administrators have the ability to create or modify these templates as they see fit. Creating an LPA project from a template will often involve automatically creating and linking together multiple project areas in multiple applications. However it is also possible to create an empty LPA project and link in existing artifact containers.

Screenshot of the LPA project creation UI

LPA also allows administrators to manage members across multiple artifact containers:

Screenshot of the LPA member management UI

In a default installation, the The LPA application is available at: https://<server>:<port>/admin/web

Project rules governing process role relationships

Lifecycle projects now have a set of configuration rules that govern the process role relationships that should exist between artifact containers in the lifecycle project. The lifecycle project will have a default set of rules defined by the template that the project is deployed with. The rules can be updated from the lifecycle project editor by downloading the existing rules, updating them, and uploading them to the server. Violations of these rules will be surfaced in the members page. The violations can be resolved by using the new process role editing feature described in more detail below.

Members UI with process role violation

Process role editing in members page

It is now possible to edit a user's process roles in a container from the members page. In order to edit roles, expand the member record to see the details view and click the process roles icon in the actions column. The role editor dialog that appears will save your changes automatically when you finish, and the UI will update to reflect the new state.

Language and process template selection

When creating a new lifecycle project, it is now possible to specify a language that the artifact containers will be created in. It is also possible to specify the project and process templates that will be used when creating each artifact container.

Project Creation UI


New common data warehouse for reporting

In the past, some products based on Jazz Foundation used a data mart (a small, product-focused data warehouse) to store data used for reporting. While this was great for product-specific reports, such as those shipped out of the box, the rich web of linked artifacts shipped with the new releases of RTC, RQM and RRC were begging for an integrated reporting solution provided by Jazz Foundation.

Now, these products share a common data warehouse where linked data from across the domains are stored. You'll first meet this data warehouse in the server setup wizard:

Server Setup Wizard

Management of the data collection jobs which populate the warehouse happens in a user-friendly page in the Admin Web UI:

Data Collection Job Status

The real benefits of having this common data warehouse become apparent when you want to write traceability reports, described in the next section.

Custom reporting with Rational Reporting for Development Intelligence

We're excited to introduce a new report authoring solution based on IBM Cognos technology. Rational Reporting for Development Intelligence (RRDI) provides a web-based authoring and report management portal that you can use to make the most of the data in the warehouse.

Because RRDI has access to the common data warehouse, you can write product-level reports, or traceability reports that span the linked artifacts from all domains in a way that helps you understand your development process.

RRDI is a separate install, which you can find in the "Optional Downloads" section of the downloads page. We encourage you to try it out!

Integration of RRDI reports in the Web UI

Writing reports in the RRDI tool is great, but you want to view those reports in the Web UI, close to your other artifacts, where you are doing your development work. We provide integration in the Reports Web UI, as well as in the dashboard, that lets you do just that. Here's what an RRDI report looks like in the Reports Web UI:

RRDI Report in the Dashboard

And here's a dashboard version of that same report:

RRDI Report in the Dashboard

Team Process

Archiving team areas

Team areas can now be archived from the Team Area Hierarchy section on the Overview tab of the project area editor in the web ui.

Archiving Team Areas

Show archived team areas

The team area hierarchy on the project and team area editor overview tab now has a control to show archived team areas.

Show Archived Team Areas

Archive timelines and iterations

You can now archive timelines and iterations from the timelines tab in the project area editor.

Archive Timelines and Iterations

Show archived timelines in web UI

The Timelines and Permissions tabs of the Project Area editor now allow you to view and configure archived timelines, iterations, and iteration types. Archived items may be filtered from view via a toggle button.

Show Archived on Permissions Tab

Restore archived process artifacts

It is now possible to restore process artifacts from an archived state via the web interface. This support extends to project areas, team areas, timelines, iterations, and iteration types.

Project Areas can be restored from the Archived Project Areas page.

Restore Archived Project Areas

Team Areas can be restored from the Team Area Hierarchy section of the project area editor. And timelines and iterations can be restored from their archived state on the Timelines tab of the project area editor. When an iteration is unarchived, its iteration type will also be unarchived if needed.

Search for specific project areas

It is now possible to search for specific project areas from the Manage Project Areas page in the web UI.

Search For Specific Project Areas

Initialize project area

It is now possible to initialize an uninitialized project area from the Manage Project Areas page in the web UI.

Initialize Project Are

Embeddable role management for lifecycle project administration

We've created an embeddable role management widget which will allow users to manage role assignments from within the Lifecycle Project Administration UI.

Embeddable Role Management for LPA

The Manage Project Areas page contains an explanation of why you might want to use a lifecycle project and a link to navigate to the Lifecycle Project Administration application.

Link to Lifecycle Project Administration

If a project area is an artifact container in a lifecycle project, the project area editor now provides a link to the lifecycle project. Clicking the link opens the lifecycle project in the Lifecycle Project Administration application.

Link to Lifecycle Project

Manage Project Areas scalability improvements

The Manage Project Areas page can now handle more project areas than conveniently fit on a single page.

Manage Project Areas Scalability Improvements

Non-Embedded project area management for applications

Jazz Foundation provides a project area management user interface that applications can use for managing their project areas. Applications can now do a page transition to the interface. Previously, applications had to embed the interface in an iframe.

For more information, see Adoption Item 154003.

API to support team area access control

Team Areas have been changed to function as access control contexts. The IProcessServerService interface has new methods "enableTeamAreaReadAccessContext" and "disableTeamAreaReadAccessContext". These methods accept a Team Area handle to enable or disable as an access control context, and a string identifying the component requesting the action. The method "isTeamAreaReadAccessContextEnabled" has been included to indicate whether a Team Area is enabled as a read access context.

Improved editor support for process sharing

We've changed the base class for Configuration Data editors to support editing in project areas that consume process. For developers of Configuration Data editors, the adoption item is Adoption Item 151809. Many of the editors have already adopted, so users can edit data in project areas that consume process.

Improved Editor Support for Process Sharing

When you navigate to the Project Area Administration page for an application such as Rational Requirements Composer, a link to return to the application now appears at the top of the page. Clicking the link will take you to the home page for the application.

Link to Application From Active Project Areas Page

OSLC Core V2 service provider catalogs

Jazz Foundation now supports the OSLC Core V2 representation for publishing service provider catalogs. Foundation will continue to support the existing OSLC V1 representations as well.

For more information, see Adoption Item 155847.

OSLC V2 Syntax

Describe Your Process

The Process Description tab in the project and team area editors allows you to author a human-readable description of your team's practices. This makes it easy for new team members to learn how your team works and provides live reference material for everyone on the team.

Process Description Tab

Attach Files and Images to Practices

Images and other files can be added to a practice as attachments that can be used in rich text fields.

Attachment support in the Practice editor

Share Process Descriptions and Practices

You can export individual practices or your team's entire process description to share with others.

Export and Import Practices

Refactor Practices

You can reorder practices and move practice elements and categories within the practice tree using either drag and drop or the move dialog.

Move Dialog

Process Description in Multiple Languages

The textual content of a process description can be composed in multiple languages at the same time. A Switch Language action allow selecting language to view or edit the content.

Switch language dialog

Process Description Resource Links

The rich text editor for practices supports Resource Links, which point to related process description elements. Resource links support rich hovers that show an in-place preview of the linked content.

Rich hover

Process Description Viewlet

The Process Description viewlet provides a summary and link to your process description from your team or project dashboard. This viewlet can be found under the Process Authoring category.

Rich hover


Support for application data upgrade

Initial support from Foundation is provided to enable data upgrade of JFS-based applications, like Rational Requirements Composer (RRC), and to transform their resources as needed. The primary use case is in support of RRC; however it is anticipated the services provided can be adopted by other applications in the future. Services and commands are defined and specified for importing the application data to a shared JTS, and for invoking an online transformation of the resource content.

Additional details on the overall flow and requirements can be found in the RRC migration wiki topic. Implementation details and links to the specs are tracked from the parent story work item 149510.

Ulimit checker

The ulimit checker examines the open file limit on Linux/Unix platforms. If the open file limit is set below the recommended value, a warning message is written to the log with instructions on how to fix it. Currently on Linux/Unix platforms, if the open file limit is not set high enough it could cause errors in the application.

Bulk license assignment

This feature allows administrators to reassign multiple users from one license to another in one simple step. This is particularly useful in the case where an administrator needs to move users from a term license to a floating one.

Bulk License Assignment

User self-registration

In order to simplify user administration, Foundation now allows users to "self-register". When this is enabled, users that can authenticate with the external user registry can always successfully log in, even when they do not yet have a contributor record in the repository database. When this happens, we automatically create the record at the moment of first log in, populating it with data from the external registry. See the user self-registration wiki topic for more information.

Server diagnostics framework

We have created a framework for components to contribute diagnostic extensions which can report on the health of the server. A diagnostic extension can run on-demand or periodically in the background, and produces detailed reports for support personnel. See the server diagnostics wiki topic for more information.

Server diagnostics UI

The new Server Diagnostics page in the Admin Web UI lists the various diagnostics for analyzing many aspects of the server to quickly identify problems. You can run diagnostics on-demand and export detailed results. The exported results can be used to provide support and development teams useful server information if a problem on your server needs to be debugged.

Server Diagnostics UI

Setup Wizard improvements

In the Setup Wizard, each application's steps now collapse once completed, the wizard steps now load much faster after application registration is complete, and the Register Applications step no longer allows changes to the Functional User ID field for detected applications. These improvements should greatly improve the stability and speed of the Setup Wizard for full CLM installations.

Setup Wizard Step List Groups

Configure public URI step enhancements

One of the most common enhancement requests we've received has been to automatically suggest (and populate) a Public URI for the Jazz Team Server. The administrator must still confirm the Public URI before continuing, since complex deployments may require a different URI than the one suggested. Additionally, the Public URI step is now able to detect and warn the user if they attempt to change the Public URI.

Lastly, the Public URI step has been removed from the Change and Configuration Management and the Quality Management applications. The Setup Wizard sets these URIs automatically during registration based on the Discovery URL used. We believe these enhancements should simply the setup process and reduce mistakes.

Activate trial license keys during setup

The Jazz Team Server setup wizard now provides a way to activate Client Access License keys requiring manual activation. Previously, this was only possible from the License Key Management page. This feature helps to streamline the setup process by eliminating the need to manage licenses prior to running the setup wizard.

Activate Trial License Keys

Administration Home Page Enhancements

The Manage Applications section of the Jazz Team Server Admin Home page has been updated to include additional links for the Quality Management and Requirements Management applications. These links provide quick access into the individual administrative pages for the applications.

Admin Home Enhancements

New restrictions for deleting consumer keys

The Consumers (Inbound) page in the Admin Web UI has been updated to disallow the deletion of certain consumer keys. Consumer keys created by the server or associated with registered applications can no longer be deleted. This change is to prevent the accidental deletion of keys which are associated with storage areas and/or important services which rely on this key.

Disabled delete consumer action

Added support for OAuth 1.0

The Jazz Team Server is now a fully compliant OAuth 1.0 server, as described by RFC5849. For more information, please see the OAuth 1.0 specification.

Note: While the official specification is now referred to as "1.0", previously the specifications at referred to "1.0" and "1.0a". The 1.0a specification added changes to prevent certain kinds of phishing attacks, and the Jazz Team Server is now fully compliant.

Repotools command to list issued floating licenses

There is a new repotools command to list the issued floating licenses. This is a remote command, meaning that it is executed against a running Jazz Team Server. The syntax for the command is very similar to existing remote commands since it adds no new parameters:

-listIssuedFloatingLicenses --List the issued floating licenses.
   [repositoryURL=https://localhost:9443/jts] --The connection URL for the server.
   [adminUserId=ADMIN] --Admin user id to login to the Jazz repository.
   [adminPassword=*******] --Admin password to login to the Jazz repository.
   [] --The file containing the admin user's login credentials.
   [certificateFile=<none>] --The file containing the admin user's login certificiate.
   [smartCard=<none>] --The alias to login using a smart card, or ? to list available aliases.
   [logFile=repotools-jts_listIssuedFloatingLicenses.log] --Path to the log file.
Here is an example of how the command is used:
repotools-jts -listIssuedFloatingLicenses
Repo Tools
Provisioning using "D:\JazzTeamServer\server\conf\jts\provision_profiles".
  Jazz Foundation - Core Libraries, Version 3.0.1 Beta 3 (RJF-T20110313-1210)

Number of issued floating licenses: 1

License: Developer-Floating
User ID: sarcher
User Name: Simon Archer
Timeout: 114 minutes

Repotools commands and automation scripts to support CLM application migrations

New repotools commands have been added to merge the configuration files when upgrading a CLM application from an earlier version. In 3.0, there was one updateConfigurationFiles reptools command to support RTC upgrade from 2.x to 3.0. This command is now deprecated and is replaced with 4 new repotools commands to cover the different applications and the JTS. These commands should be used while upgrading CCM 2.x, CCM 3.0, QM 2.x and RM 2.x applications. The commands merge the application, JTS and Tomcat configuration files using the information present in the 2.x or 3.0 server. You can use the repotools -help option for more details on the allowable parameters. The 4 new commands are:

  • migration_jts_updateConfigurationFiles
  • migration_ccm_updateConfigurationFiles
  • migration_qm_updateConfigurationFiles
  • migration_rm_updateConfigurationFiles

New scripts have been added to automate some of the migration steps when upgrading a CLM application from an earlier version. In 3.0, there was a separate download on, rtc_migration script to support RTC upgrade from 2.x to 3.0. This is now replaced by 4 new upgrade scripts to cover the different applications and the JTS. These scripts can be used while upgrading CCM 2.x, CCM 3.0, QM 2.x and RM 2.x applications. The scripts can be found in the folder <jazz installation directory>/jazz/server/upgrade. You can use the -help option for details on the allowable parameters. The 4 new scripts are:


By providing additional parameters to specify application and JTS homes, the scripts and commands now also support automation even when the application is on a different machine from the JTS; however, this requires that the remote drive is mounted on the machine in which the command or script is running.

Foundation Services

Iterator and import update APIs

To enable RRC to update its resources during migration (see RRC migration from 2x to 3x) two new APIs are now provided:

Application-specific index and query support

The indexing of each application's resources is now done independently. This allows each application to make queries at its own pace, not being dependent on other applications.

Reduced Jena lock contention

The overall lock contention on the RDF triple store has been improved when multiple users or clients within one application are both reading and writing simultaneously.

Baseline creation in background

The creation of baselines can be time consuming. Before M13, it was done in the same thread as the indexing of other resources. It is now done in background so that it doesn't hold up the indexing of other resources.

JFS diagnostics

To help quickly identify problems related to JFS, some JFS-specific server diagnostics have been added. They include:

  • the consumer key for a storage area no longer exists
  • an index cannot be read/written because of bad file access permission
  • an error occurred in the indexing loop and the indexing loop can not restart
  • an index is ahead of the database
  • the indexing backlog reached some threshold (currently 5000 tasks)
  • a query is taking more than the warning threshold
  • an inappropriate file access mode was used for Jena

JFS Server Diagnostics

Application SDK

Resource history view in JFS Explorer

It is now possible to view the resource history in the JFS Explorer (developer tool included in the SDK). While viewing a resource, you can switch to the History tab to see all revisions of a resource. The revisions are retrieved via Jazz Foundation Storage History API.

Application Migration Framework

The Repository and Jazz Foundation Services components have added support for migrating application data from old to new formats. All of the resources in a storage area can be enumerated, and existing versions of those resources can be overwritten with new content, or replaced by new resources. The Application SDK includes enhancements to make it easy to use the new services from Java programs:

  • The interface and implementation has been enhanced to be able to process the results of enumerating storage areas, or the resources in a storage area (the new value RESOURCE has been added to the QueryType enumeration).
  • The interface defines a mechanism for iterating over all revisions of each resource in a storage area, calling back to an implementation of provided by the application that does the actual migration operation. The IDataMigrationManager interface includes convenience methods to invoke Foundation services to overwrite, create, or delete resources.