Repository tools command to register an application
Use the RegisterApp command to register an application with Jazz® Team Server.
Purpose
The registerApp command is used to register and configure multiple applications with a configured Jazz Team Server. Before using the command, create a properties file that contains the settings for the applications to be registered.Parameters
Attribute | Description | Required | Default |
---|---|---|---|
repositoryURL | The connection URL for the server. | No | https://localhost:9443/jts |
authServerUserId | The administrator user ID to log in to the Jazz Authorization Server if in use. | No | none |
authServerPassword | The administrator user ID password to log in to the Jazz Authorization Server if in use. | No | none |
adminUserId | The administrator user ID to log in to the JAZZ repository. | No | ADMIN |
adminPassword | The administrator user ID password to log in to the JAZZ repository. | No | ADMIN |
credentialsFile | The file containing the administrator user's login credentials. | No | credentials.properties |
certificateFile | The file containing the administrator user's login certificate. | No | none |
smartCard | The alias to login using a smart card, or ? to list available aliases. | No | none |
logFile | Path to the log file. | No | repotools-jts_registerApp.log |
parametersFile | The location of the register application parameters configuration file. The parameters file contains values for the various application registration properties. | Yes | 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 |
.properties sample files
The following samples are for .properties files that can contain the information needed to register the IBM® Engineering Lifecycle Management applications with Jazz Team Server. You can save these app.properties file to your local drive and then reference them in the command argument.
db.vendor
and db.jdbc.location
accordingly. Replace app with the application being used.- Derby
-
app\:configure.database.page\:db.vendor=DERBY app\:configure.database.page\:db.jdbc.location=conf/app/derby/repositoryDB app\:data.warehouse.page\:db.jdbc.location=//localhost\:1527/conf/jts/derby/warehouseDB
- Oracle
-
app\:configure.database.page\:db.vendor=ORACLE app\:configure.database.page\:db.jdbc.location=thin\:appDBuser/{password}@//oracleserver.example.com\:1521/ORCL
- Db2 z
-
app\:configure.database.page\:db.vendor=DB2Z app\:configure.database.page\:db.jdbc.location=//ipAddress:ipPort/location:user\=ccmDBuser;password\={password}; app\:configure.database.page\:db.schemaPrefix=DB2z schema prefix - must be unique for each database in the same DB2z subsystem app\:configure.database.page\:db.db2.dsn.dbname=JAZZDB app\:data.warehouse.page\:db.db2.dsn.dbname=RIDW app\:data.warehouse.page\:db.schemaPrefix=xx app\:data.warehouse.page\:report.user=RTPUSER
- Db2 i
-
app\:configure.database.page\:db.vendor=DB2i app\:configure.database.page\:db.jdbc.location=//hostname;hold statements\=true;metadatasource\=1;user\=ccmDBuser;password\={password}; app\:data.warehouse.page\:report.user=RTPUSER
- J2EE
-
app\:configure.database.page\:db.type=J2EE app\:configure.database.page\:db.j2ee.dataSource=
Do not enter passwords in {password}
. Use the
configure.database.page\:db.jdbc.password
line to enter passwords.
Also note
that for JDBC connections, all applications use db.jdbc.location
and
db.jdbc.password
except for Lifecycle Query Engine and Link Index Provider. For these two applications you must use db.location
and
db.password
.
- Change and Configuration Management application (ccm.properties)
-
register.applications.page\:jts.register.ccm=true register.applications.page\:ccm.application.title=/ccm register.applications.page\:ccm.discovery.url=https\://hostname.example.com\:9443/ccm/scr ccm\:configure.database.page\:db.type=JDBC ccm\:configure.database.page\:db.vendor=DB2 ccm\:configure.database.page\:db.jdbc.location=//localhost\:50000/CCM\:user\=db2admin;password\={password}; ccm\:configure.database.page\:db.jdbc.password= ccm\:data.warehouse.page\:db.jdbc.location=//localhost\:50000/JTS\:user\=db2admin;password\={password}; ccm\:data.warehouse.page\:db.jdbc.password= ccm\:data.warehouse.page\:db.type=JDBC ccm\:data.warehouse.page\:db.vendor=DB2 ccm\:data.warehouse.page\:db.base.folder=Enter an existing base folder for data warehouse ccm\:data.warehouse.page\:report.user=RTPUSER
- Engineering Test Management application (qm.properties)
-
register.applications.page\:jts.register.qm=true register.applications.page\:qm.discovery.url=https\://hostname.example.com\:9443/qm/scr register.applications.page\:qm.application.title=/qm qm\:configure.database.page\:db.vendor=DB2 qm\:configure.database.page\:db.jdbc.location=//localhost\:50000/QM\:user\=db2admin;password\={password}; qm\:configure.database.page\:db.jdbc.password= qm\:configure.database.page\:db.type=JDBC qm\:data.warehouse.page\:db.jdbc.location=//localhost\:50000/JTS\:user\=db2admin;password\={password}; qm\:data.warehouse.page\:db.jdbc.password= qm\:data.warehouse.page\:db.vendor=DB2 qm\:data.warehouse.page\:db.type=JDBC qm\:data.warehouse.page\:db.base.folder=Enter an existing base folder for data warehouse qm\:data.warehouse.page\:report.user=RTPUSER
- Requirements Management application (rm.properties)
-
register.applications.page\:jts.register.rm=true register.applications.page\:rm.application.title=/rm register.applications.page\:rm.discovery.url=https\://hostname.example.com\:9443/rm/scr rm\:configure.database.page\:db.type=JDBC rm\:configure.database.page\:db.vendor=DB2 rm\:configure.database.page\:db.jdbc.location=//localhost\:50000/RM\:user\=db2admin;password\={password}; rm\:configure.database.page\:db.jdbc.password= rm\:data.warehouse.page\:db.jdbc.location=//localhost\:50000/JTS\:user\=db2admin;password\={password}; rm\:data.warehouse.page\:db.jdbc.password= rm\:data.warehouse.page\:db.vendor=DB2 rm\:data.warehouse.page\:db.type=JDBC rm\:data.warehouse.page\:db.base.folder=Enter an existing base folder for data warehouse rm\:data.warehouse.page\:report.user=RTPUSER
- Global Configuration Management application (gc.properties)
-
register.applications.page\:jts.register.gc=true register.applications.page\:gc.application.title=/gc register.applications.page\:gc.discovery.url=https\://hostname.example.com\:9443/gc/scr gc\:configure.database.page\:db.vendor=DB2 gc\:configure.database.page\:db.type=JDBC gc\:configure.database.page\:db.jdbc.location=//localhost\:50000/GC\:user\=db2admin;password\={password}; gc\:configure.database.page\:db.jdbc.password=
- Report Builder application (rs.properties)
-
register.applications.page\:jts.register.rs=true register.applications.page\:rs.application.title=/rs register.applications.page\:rs.discovery.url=https\://hostname.example.com\:9443/rs/scr rs\:com.ibm.team.jrs.setupStep\:db.jdbc.password=
- Link Index Provider application (ldx.properties)
-
register.applications.page\:jts.register.ldx=true register.applications.page\:ldx.application.title=/ldx register.applications.page\:ldx.discovery.url=https\://hostname.example.com\:9443/ldx/scr ldx\:configure.database.page\:db.vendor=DB2 ldx\:configure.database.page\:db.location=//localhost\:50000/LDX\:user\=db2admin;password\={password}; ldx\:configure.database.page\:db.password=
- Data Collection Component application (dcc.properties)
-
register.applications.page\:jts.register.dcc=true register.applications.page\:dcc.application.title=/dcc register.applications.page\:dcc.discovery.url=https\://hostname.example.com\:9443/dcc/scr dcc\:configure.database.page\:db.type=JDBC dcc\:configure.database.page\:db.vendor=DB2 dcc\:configure.database.page\:db.jdbc.location=//localhost\:50000/DCC\:user\=db2admin;password\={password}; dcc\:configure.database.page\:db.jdbc.password= dcc\:data.warehouse.page\:db.jdbc.location=//localhost\:50000/JTS\:user\=db2admin;password\={password}; dcc\:data.warehouse.page\:db.jdbc.password= dcc\:data.warehouse.page\:db.vendor=DB2 dcc\:data.warehouse.page\:db.type=JDBC dcc\:data.warehouse.page\:db.base.folder=Enter an existing base folder for data warehouse dcc\:data.warehouse.page\:report.user=RTPUSER
- Lifecycle Query Engine application (lqe.properties)
-
register.applications.page\:jts.register.lqe=true register.applications.page\:lqe.application.title=/lqe register.applications.page\:lqe.discovery.url=https\://hostname.example.com\:9443/lqe/scr lqe\:configure.trs.page\:trs.add=AddTRS lqe\:configure.database.page\:db.vendor=DB2 lqe\:configure.database.page\:db.location=//localhost\:50000/LQE\:user\=db2admin;password\={password}; lqe\:configure.database.page\:db.password=
- IBM Engineering Lifecycle Optimization Engineering Insights application (relm.properties)
-
register.applications.page\:jts.register.relm=true register.applications.page\:relm.application.title=/relm register.applications.page\:relm.discovery.url=https\://hostname.example.com\:9443/relm/scr relm\:configure.database.page\:db.jdbc.location=//localhost\:50000/RELM\:user\=db2admin;password\={password}; relm\:configure.database.page\:db.jdbc.password= relm\:configure.database.page\:db.vendor=DB2 relm\:configure.database.page\:db.type=JDBC
Example
Open a command prompt and enter this command:
cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -registerApp repositoryURL=https://hostname.example.com:9443/jts adminUserId=admin adminPassword=admin parametersFile=C:\ccm.properties kerberos=true
Open a command line and enter
this command:
cd /opt/IBM/JazzTeamServer/server/ ./repotools-jts.sh -registerApp repositoryURL=https://hostname.example.com:9443/jts adminUserId=admin adminPassword=admin parametersFile=/opt/ccm.properties
Troubleshooting an unsuccessful application registration
- In the Server Administration of Jazz Team Server, click .
- Click the X icon under the Actions column to remove the application. Click OK to confirm.
- Under Communication, click Consumers (Inbound) and make sure there is no consumer key for the application.
- If you are running IBM WebSphere® Application Server, stop the server.
- Go to JazzInstallDir/server/conf/app/derby and delete the repositoryDB folder.
- In the derby folder, extract repositoryDB.zip. Make sure the directory structure is derby/repositoryDB.
- In JazzInstallDir/server/conf/app delete the teamserver.properties file.
- Find the original teamserver-xxxxxxxxxxxxxbackup.properties and rename it to teamserver.properties. There are multiple backup files. The original copy is the oldest one with the largest file size.
- Start the server and redo the registration.