Customizing the Jazz Team Server and Engineering Lifecycle Management properties files for Db2 on z/OS

Edit online

You can edit and configure the teamserver.properties files so that the server on z/OS can connect to DB2®. The Jazz® Team Server (JTS) and most of the other IBM® Engineering Lifecycle Management (ELM) applications each have teamserver.properties files that contain server properties. The Lifecycle Query Engine (LQE) and Link Index Provider (LDX) have dbconnection.properties files that can be preconfigured. The Jazz Reporting Service (JRS) does not use Db2 on z/OS.

About this task

This topic describes how to configure the properties files. You can also input this configuration information into the Jazz Team Server setup wizard after starting the server.
Note: The Lifecycle Query Engine (LQE) and Link Index Provider (LDX) have dbconnection.properties files that can be preconfigured. The Jazz Reporting Service (JRS) does not use Db2 on z/OS.
Locate the configuration directories for each application that you are planning to deploy that uses teamserver.properties:
  • Jazz Team Server (JTS) - @confPath@/jts
  • Change and Configuration Management (CCM) - @confPath@/ccm
  • Quality Management (QM) - @confPath@/qm
  • Requirements Management (RM) - @confPath@/rm
  • Data Collection Component (DCC) - @confPath@/dcc
  • Global Configuration (GC) - @confPath@/gc
  • IBM Engineering Lifecycle Optimization - Engineering Insights (ENI) - @confPath@/relm

On z/OS, the @confPath@ is the path value that was used when customizing the server using the BLZCP* sample jobs, such as /etc/jazz702. On systems other than z/OS, @confPath@ is the installation path for the configuration directory, such as /opt/IBM/JazzTeamServer/server/conf on Linux®.

By default, the teamserver.properties files in those directories are configured to use a Derby repository and data warehouse for reporting. Edit each teamserver.properties file to use Db2 for z/OS according to the instructions in this topic.

Use the -DIS DDF command for your Db2 for z/OS subsystem to display some of the values you need to supply. For example, you can retrieve the location, ipaddr, and port (tcpport) from the following display: 
DSNL080I  -DBC1 DSNLTDDF DISPLAY DDF REPORT FOLLOWS:            
DSNL081I STATUS=STARTD                                          
DSNL082I LOCATION           LUNAME            GENERICLU         
DSNL083I DBC1               NET1.DBC1LU       -NONE             
DSNL084I TCPPORT=5050  SECPORT=5052     RESPORT=5051  IPNAME=-NONE 
DSNL085I IPADDR=9.30.243.101                                  
DSNL086I SQL    DOMAIN=TVT6012.svl.ibm.com                      
DSNL105I CURRENT DDF OPTIONS ARE:                               
DSNL106I PKGREL = COMMIT                                        
DSNL106I SESSIDLE = 001440                                      
DSNL099I DSNLTDDF DISPLAY DDF REPORT COMPLETE
Modify each teamserver.properties file to match the database configuration you created in previous steps, and also to match your Db2 z/OS configuration. Edit the following properties according to your configuration:
  • ipAddress,
  • ipPort
  • location
  • user
  • password
  • dbname
  • schemaprefix
Notes:
  • There can be up to ten repositories: one repository for JTS, one repository for each installed component that has a database (CCM, QM, RM, LQE, DCC, GC, LDX, ENI), and one repository for the data warehouse.
  • Each of these repositories must have a unique database name and schema prefix (if they are in a single Db2 z/OS subsystem).
  • Each properties file will point to the same data warehouse configuration.

To configure the server or application to use Db2 for z/OS, edit each of the teamserver.properties files in the configuration directories for the Jazz Team Server or other installed ELM application. For example, @confPath@/jts/teamserver.properties and @confPath@/ccm/teamserver.properties files and locate the following lines. This example is for CCM:

# JDBC Repository DB location, specifying this property disables 
# system-based selection of default location 
# NOTE THAT EVERY APPLICATION INSTANCE AND JAZZ TEAM SERVER 
# REQUIRES ITS OWN UNIQUE DATABASE
com.ibm.team.repository.db.vendor = DERBY 
com.ibm.team.repository.db.jdbc.location=conf/ccm/derby/repositoryDB

# JDBC Data Warehouse DB location, specifying this property disables 
# system-based selection of default location
com.ibm.team.datawarehouse.db.vendor=derby_net
com.ibm.team.datawarehouse.db.jdbc.location=//localhost:1527/conf/jts/derby/warehouseDB
Add a # in column one to comment out the following properties for both the com.ibm.team.repository and com.ibm.team.datawarehouse properties like this: 
# JDBC Repository DB location, specifying this property disables 
# system-based selection of default location
# NOTE THAT EVERY APPLICATION INSTANCE AND JAZZ TEAM SERVER REQUIRES ITS 
# OWN UNIQUE DATABASE
#com.ibm.team.repository.db.vendor = DERBY
#com.ibm.team.repository.db.jdbc.location=conf/ccm/derby/repositoryDB

# JDBC Data Warehouse DB location, specifying this property disables 
# system-based selection of default location
#com.ibm.team.datawarehouse.db.vendor=derby_net
#com.ibm.team.datawarehouse.db.jdbc.location=//localhost:1527/conf/jts/derby/warehouseDB
Uncomment the lines shown in the examples and edit to match the database configuration you created in previous steps, and also to match your Db2 configuration.

Edit the location, user, password, and dbname properties according to your configuration.

Specifically, edit the following lines in each teamserver.properties file for that repository:
  1. Ensure this line is uncommented: 
    com.ibm.team.repository.db.vendor = db2z
  2. In the following line: 
    com.ibm.team.repository.db.jdbc.location=//ipAddress:ipPort/
location:user=jazzDBuser;password={password};
    replace:
    • ipAddress with your ipaddr.
    • ipPort with your tcpport.
    • location with the value listed in the DDF report under LOCATION.
    • jazzDBuser with the user ID you created, which has appropriate access to the Db2 database.
      Note: Do not modify password={password}.
  3. In the following line: 
    com.ibm.team.repository.db.jdbc.password=jazzDBpswd
    replace jazzDBpswd with the password for your Db2 z/OS user.
  4. In the following line: 
    com.ibm.team.repository.db.db2.dsn.dbname=JAZZDB
    replace JAZZDB with the name of the database you created for this component.
  5. In the following line: 
    #com.ibm.team.repository.db.schemaPrefix=xx
    you must remove the # and replace xx with a unique prefix for each database in the same Db2 z/OS subsystem.
    Note: To create several Jazz databases in the same Db2 subsystem, you must differentiate the table owners for the Jazz tables. To do so, the Jazz Team Server uses the com.ibm.team.repository.db.schemaPrefix directive to add a prefix to the Jazz Db2 objects so that they are unique within a Db2 subsystem. The prefix set in com.ibm.team.repository.db.schemaPrefix is added to the owner prefix along with an underscore. For example, the CREATOR will be modified to JTS702_REPOSITORY, in a given database when com.ibm.team.repository.db.schemaPrefix=JTS702. Ensure a unique reference using CREATOR and TABLE name.

Update the teamserver.properties files for references to the data warehouse on Db2 z/OS.

Specifically, edit the following lines:
  1. Comment out the following properties related to Derby data warehouse configuration (the third property might not be listed):
    # com.ibm.team.datawarehouse.db.vendor=DERBY
# com.ibm.team.datawarehouse.db.jdbc.location=conf/jts/derby/warehouseDB
# com.ibm.team.datawarehouse.db.net.port=1527
  2. Uncomment the following properties and make similar updates as for the repository. 
    #com.ibm.team.datawarehouse.db.vendor = db2z
#com.ibm.team.datawarehouse.db.jdbc.location=//ipAddress:ipPort/location:user=jazzDBuser;password={password};
#com.ibm.team.datawarehouse.db.jdbc.password=jazzDBpswd
# The database user for whom proper permissions will be granted
#com.ibm.team.datawarehouse.report.user = RPTUSER
#com.ibm.team.datawarehouse.db.db2.dsn.dbname=DW702
#com.ibm.team.datawarehouse.db.schemaPrefix=DW702X
    You must add the following property, if it does not exist, to specify a prefix of your choice for the data warehouse tables:
    com.ibm.team.datawarehouse.db.schemaPrefix=DW702X
  3. In com.ibm.team.datawarehouse.report.user = RPTUSER, enter the report user for whom the proper permission will be granted. The default is RPTUSER.
    Note: If you use the setup wizard, proper permission will be granted to the report user. If you want to manually grant permissions, this user must be able to do SELECT on the database to view a report.
    Specifically, when you run the repository tools –createWarehouse or initialize the data warehouse using the setup wizard, RPTUSER is being granted permission to select from the tables, using statements such as:
        GRANT SELECT ON DW702.VW_RQST_HISTORY TO $REP_USER;
Finally, replace all instances of @workPath@ with the path that you selected for @workPath@ if they are not already modified. The @workPath@ replacement should have been done when you ran the BLZCP* jobs. For example, these properties:
  • com.ibm.team.fulltext.indexLocation=@workPath@/workitemindex
  • com.ibm.team.repository.tmpdir=@workPath@/contentservice
  • com.ibm.team.scm.tmpdir=@workPath@/contentservice
  • com.ibm.team.scm.vcs.tmpdir=@workPath@/versionedcontentservice
If you choose to deploy the LQE or LDX applications, you can configure the connection data or provide the data as part of the Jazz Team Server setup wizard. Alternatively, to preconfigure the applications, create a file named dbconnection.properties in the configuration directories for the applications. The format of the file is similar to the teamserver.properties file, but includes only the following lines: 
# DB2z Configuration. Please configure the following properties
db.vendor=DB2Z
db.location=//@hostname@:@port@/@location@:user=@username@;password={password};
db.password=@password@
db.name=@dbname@
db.schema.prefix=@schema@
Substitute the variables that have the @ symbols on each side of the variable, such as db.name=LQE702. The database tables are created when the server is started for the LQE and LDX applications, not by repository tools commands.
Tip: The Jazz database contains LOB (large object) columns in its tables. The LOB columns are associated with a buffer pool that is created by Db2 during table creation. The default buffer pool for a LOB tablespace is defined in zparm TBSBPLOB. You can set the value to a 16K buffer pool if you do not want 8K page sizes. For additional information, see Alternatives in defining LOBs in the IBM Redbooks® publication LOBS with DB2 for z/OS: Stronger and Faster.