Repository tools command to prepare an ELM application for Jazz Security Architecture single sign-on

Edit online

Use the prepareJsaSsoMigration command to prepare a Jazz® Team Server or IBM Engineering Lifecycle Management (ELM) application for Jazz Security Architecture single sign-on (SSO) authentication.

Before you begin

Important:
  • Before you run the command, you must upgrade Jazz Team Server and any applications that will be enabled for Jazz Security Architecture SSO to version 6.0 or later. The upgrade must be complete and verified.
  • This command applies to ELM applications that have repotools command scripts: Jazz Team Server, Change and Configuration Management, Data Collection Component, Global Configuration Management, Quality Management, IBM Engineering Lifecycle Optimization - Engineering Insights, and Requirements Management.
  • The server must be running when you run the command.

The prepareJsaSsoMigration command is one of two repository tools commands that enables existing ELM product deployments to use Jazz Security Architecture SSO for ELM deployments. This command must be run before the migrateToJsaSso command. Both commands must be run on the Jazz Team Server if any applications that are registered with the server are enabled for Jazz Security Architecture SSO. Not all applications must be enabled at the same time. However, the login experience is not a single sign-on process until all ELM applications that are registered with the Jazz Team Server are enabled.

Purpose

You run the prepareJsaSsoMigration command while the Jazz Team Server and ELM applications are running to prepare them for Jazz Security Architecture SSO authentication. The command generates a data file that is needed by the migrateToJsaSso command.

Parameters

Attribute Description Required Default
toFile Path to the data file that is needed by the migrateToJsaSso command. No application-ssoMigrationData.json

where application is jts, ccm, dcc, gc, qm, relm, or rm
repositoryURL Connection URL for the server. No https://localhost:9443/application

where application is jts, ccm, dcc, gc, qm, relm, or rm
adminUserId Administrator user ID to log in to the Jazz repository. No
Note: This parameter is required if the default ADMIN user was disabled during the setup.
 ADMIN
adminPassword Administrator password to log in to the Jazz repository. No
Note: This parameter is required if the default ADMIN user was disabled during the setup.
 ADMIN
credentialsFile File that contains the administrator user's login credentials. No credentials.properties
certificateFile File that contains the administrator user's login certificate. No none
smartCard Alias to log in using a smart card, or ? to list available aliases. No none
kerberos Authenticate with Windows user credentials using Kerberos/SPNEGO by setting to true. Or authenticate with Windows Integrated Authentication by setting to windows. No None
logFile Path to the log file. No repotools-application_prepareJsaSsoMigration.log

where application is jts, ccm, dcc, gc, qm, relm, or rm

Example

The following example is for Jazz Team Server. To use this command for a different ELM application, use the repotools script that is associated with that application. Table 1 describes each repotools script and the associated ELM application that it manages. The scripts are in the JazzInstallDir/server directory.

Table 1. repotools scripts
Script ELM application
repotools-ccm Change and Configuration Management
repotools-dcc Data Collection Component
repotools-gc Global Configuration Management
repotools-qm Quality Management
repotools-relm IBM Engineering Lifecycle Optimization - Engineering Insights
repotools-rm Requirements Management

For Windows operating system Open a command prompt and enter this command:

cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -prepareJsaSsoMigration repositoryURL=https://hostname.example.com:9443/jts kerberos=true

For Unix operating systems Open a command line and enter this command:

cd opt/IBM/JazzTeamServer/server
./repotools-jts.sh -prepareJsaSsoMigration repositoryURL=https://hostname.example.com:9443/jts