Add new applications to an existing

Select the options that apply to your environment to generate a customized guide to add one or more new applications to an existing .

Select the operating system for your application server:

Select your registration method:

Select one or more applications to add:

  • Core applications

  • Optional applications (separate license)

  • Supporting applications

Select your installation method:

Select your database server:

Select your application server:

Select your deployment option:

Are you configuring a data warehouse?

To add additional () software packages to an existing , follow these steps:

Overview

 

Shut down the server

Before installing new applications into an existing , you must shut down the server.

  1. Open a command windowshell and enter the following commands:

    cd JazzInstallDir\server
    server.shutdown.bat

    cd JazzInstallDir/server
    ./server.shutdown

Install additional applications by using

Before you begin

  • You have access to the installation files that you used to install .
  • On IBM AIX® platforms, you can use the jar command to extract the package, but you must run the following chmod command to ensure that the Launchpad program has the correct execution permission: chmod -R +x launchpad.sh
  • You must have a supported version of IBM® Installation Manager for your platform. The Web Installer downloads contain Installation Manager. The easiest way to proceed is to get the Web Installer download for your platform.
  • You must have an Installation Manager response file that is tailored for the products to install. The Web Installer downloads contain sample response files for installing each of the available products.
  • You must have the Installation Manager repositories for each of the products to install. These repositories are available in the All Downloads section of the product downloads page.
  • Extract the downloaded .zip file to a temporary directory. To avoid issues, do not use long paths and directories that have spaces in their names. Extract any other Installation Manager repository files that you download into the same directory as the Web Installer.
  • The response files contain an example command-line invocation that uses the -acceptLicense argument. Before attempting a command-line installation, review the license agreement that is included in the /license directory at the top-level of the product download. Use the -acceptLicense argument on the command-line to indicate acceptance of this license agreement.
  • Each response file contains a line that refers to the Installation Manager repository to be used during installation. Edit the repository location attribute to point to the repository.config file in the directory that you extracted the Installation Manager repository files to.
  • Before you can install and run applications on your IBM AIX® system, you must increase the limit of open files:
    1. Start smit.
    2. Go to Security & Users > Users > Change/Show Characteristics of a User.
    3. Enter the User ID under which the is running.
    4. Enter a value of 65536 in the Soft NOFILE descriptors and Hard NOFILE descriptors fields.
    5. Enter a value of 10000 in the Soft NPROC per user and Hard NPROC per user fields.
    6. Log out and log back in to the system.
    7. Before starting the application server, run ulimit -n and ulimit -u to see if the configuration took effect. The output for ulimit -n must be 65536 and the output for ulimit -u must be 10000.
  • Unless you plan to perform a silent installation, a supported browser is required to install the products with a graphical user interface and IBM Installation Manager.
  • The browser must be included in the $PATH environment variable. If the launchpad.sh program for IBM Installation Manager cannot find the browser, an error message will be displayed.
  • Before you can install and run applications on your Linux system, you must increase the limit of open files and user processes:
    1. As a root user add the following lines to the /etc/security/limits.conf file:

      * hard nofile 65536
      * soft nofile 65536
      * hard nproc 10000
      * soft nproc 10000

    2. Also ensure that the nproc value in /etc/security/limits.d/90-nproc.conf (RHEL6) or /etc/security/limits.d/20-nproc.conf (RHEL7) is set to 10000.
    3. After you modify the configuration files, restart the Linux system.
    4. To increase the limits in a running shell, use the following commands:

      ulimit -n 65536
      ulimit -u 10000

      Note: If you use these commands, start the Launchpad program or IBM Installation Manager from the same shell to inherit the modified limits. After these settings are applied, reindex the server to fix any corrupted server indexes by running the Jazz_Install_Dir/server/repotools-jts -reindex repotools command.

  • If Security-Enhanced Linux (SELinux) is enabled, you must disable it or change the security context of the Java Runtime Environment (JRE) to allow text relocation. For more information, see Installing with Security-Enhanced Linux.
  • The installation path names for the applications must not contain spaces. The startup script (Jazz_Install_Dir/server/server.startup) and the repository tools script (Jazz_Install_Dir/server/repotools-app.sh) detect and report this problem.
  • You must have the GTK x32 libraries available in your Linux system to be able to open the Installation Manager link from the Launchpad program. For more information, see this article on jazz.net.
  • When you run the applications, you can modify and write logs and other files to the installation directory. For all users to write to the installation directory, you must manually grant write permissions to it Jazz_Install_Dir.

About this task

There are two ways to download and install applications. The first installation method is a web-based installation that includes a smaller download and connects to the internet during the installation to get the repository files. If you must install the server in an environment without internet access, use the second installation method: download and extract the repository files to a local computer to install the server.

If you do not have User Interface libraries installed on your server or just prefer to use the command-line installation method, you can use an response file to install . This method is also referred to as silent installation.

There are two sample response files provided to install applications:

  • silent-install-server.xml: Use this script to produce an installation of the applications in the C:\tmp\silent-install\JazzTeamServer/tmp/silent-install/JazzTeamServer directory that can be compressed and relocated on the file system, or to other computers with the same operating system and architecture. To use this script, you must have installed on your server.
  • silent-install-server2.xml: Use this script to install the applications in the default installation location. If you do not have , this script will install on your server before continuing with the installation.

In addition to the server sample response files, these additional component sample response files are also included:
  • silent-install-buildsystem.xml: Installs Build System Toolkit
  • silent-install-cc-connector.xml: Installs Rational ClearCase Synchronizer
  • silent-install-client.xml: Installs - Client for Eclipse IDE
  • silent-install-cq-connector.xml: Installs Rational ClearQuest Synchronizer
  • silent-install-jazz-msscci.xml: Installs MS-SCCI provider
  • silent-install-vs-client.xml: Installs - Client for Microsoft Visual Studio
  • silent-install-windows-shell-client.xml: Installs Windows Explorer Shell

Procedure

  1. Open a command window and change to the directory where the installation package you used to install is located.
  2. Enter launchpad to start the Launchpad program.
  3. Note: You must use the same user mode for (Administrator or Non-Administrator) as you previously selected when installing .

  4. In Launchpad left menu select Custom Installation.
  5. In the Custom Installation pane, click Install , the trial license keys, and the applications. This link provides all applications to install including and .
  6. When opens, authenticate to the server by providing your user name and password.
  7. In the Install Packages, select the applications you want to install.
  8. Accept the terms in the license agreement and click Next to continue.
  9. If this is a single-server topology and you are adding applications to an existing package group, ensure the Use the existing package group radio button is selected and then select the package group name from the list.
  10. If this is a distributed topology dedicated to a single application, install the application into a new package group.
  11. Ensure Install with WAS Liberty Profile is selected, click Next.
  12. Clear the checkbox for Install with WAS Liberty Profile and select Install application WAR files
  13. Enter a destination location to copy the application WAR files.
  14. Click Install. When installation completes, click Finish to close .
  1. Open a command prompt and change to the ExtractedDir\im\win32.win32.x86 directory.
  2. Open a command shell and change to the ExtractedDir/im/linux.gtx.x86 directory.
  3. Open a command shell and change to the ExtractedDir/im/linux.gtx.ppc directory.
  4. Open a command shell and change to the ExtractedDir/im/linux.gtx.s390 directory.
  5. Open a command shell and change to the ExtractedDir/im/aix.motif.ppc directory.
  6. To install the applications as an administrator into a shared area, use the installc variant in the following command:

    .\installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

    ./installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

  7. To install the applications into a user-specific location use the userinstc variant in the following command:

    .\userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

    ./userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

  8. By default, the response files are configured for a Liberty server deployment. To modify the response files for a deployment, complete the following steps:
    1. Open silent-install-server.xml and search for user.com.ibm.team.install.jfs.appserver.noappserver.disable and change its value to false.
    2. Search for user.com.ibm.team.install.jfs.appserver.liberty.disable and change its value to true.
    3. Remove the comment from the following section and specify a location to install the web application WAR files:

      <data key='user.JazzFoundationServer.NoAppServer.WebApps.InstallLocation'
      value='C:\tmp\silent-install\JazzTeamServer\server\webapps'/>

      <data key='user.JazzFoundationServer.NoAppServer.WebApps.InstallLocation'
      value='/tmp/silent-install/JazzTeamServer/server/webapps'/>

  9. To remove an application from being installed, search for the application name and comment out or delete the line. For example, if you do not want to install application, search for rtc and delete or comment out the offering line:

    <!--
    <offering id='com.ibm.team.install.jfs.app.rtc'/>
    -->

  10. By default, the jrs offering installs all reporting features. If you want to install a subset of features, add a features parameter and list the features that you want to install separated by commas, for example:

    <offering id='com.ibm.team.install.jfs.app.jrs' features='lqe,dcc'/>

If you are adding a feature to an existing installation, you must use the Modify feature of .

  1. Open and click Modify.
  2. From the available list of installed package groups, select the package group that you want to add a feature to and click Next.
  3. On the Select features to install page, expand and select the features you want to add to the installation. Click Next.
  4. On the Review the summary information page, review your changes and click Modify to start the installation.

Before you begin

  • You must have a supported version of IBM® Installation Manager for your platform. The Web Installer downloads contain Installation Manager. The easiest way to proceed is to get the Web Installer download for your platform.
  • You must have an Installation Manager response file that is tailored for the products to install. The Web Installer downloads contain sample response files for installing each of the available products.
  • You must have the Installation Manager repositories for each of the products to install. These repositories are available in the All Downloads section of the product downloads page.
  • Extract the downloaded .zip file to a temporary directory. To avoid issues, do not use long paths and directories that have spaces in their names. Extract any other Installation Manager repository files that you download into the same directory as the Web Installer.
  • The response files contain an example command-line invocation that uses the -acceptLicense argument. Before attempting a command-line installation, review the license agreement that is included in the /license directory at the top-level of the product download. Use the -acceptLicense argument on the command-line to indicate acceptance of this license agreement.
  • Each response file contains a line that refers to the Installation Manager repository to be used during installation. Edit the repository location attribute to point to the repository.config file in the directory that you extracted the Installation Manager repository files to.
  • By default, the jrs offering installs all reporting features. If you want to install a subset of features, add a features parameter to the .xml file and list the features that you want to install separated by commas, for example:

    <offering id='com.ibm.team.install.jfs.app.jrs' features='lqe,dcc'/>

About this task

If you do not have User Interface libraries installed on your server or just prefer to use the command-line installation method, you can use an response file to install the features. This method is also referred to as silent installation.

There are two sample response files provided to install features:

  • silent-install-server.xml: Use this script to produce an installation of the features in the C:\tmp\silent-install\JazzTeamServer/tmp/silent-install/JazzTeamServer directory that can be compressed and relocated on the file system, or to other computers with the same operating system and architecture. To use this script, you must have installed on your server.
  • silent-install-server2.xml: Use this script to install the features in the default installation location. If you do not have , this script will install on your server before continuing with the installation.

Procedure

  1. Open a command prompt and change to the ExtractedDir\im\win32.win32.x86 directory.
  2. Open a command shell and change to the ExtractedDir/im/linux.gtx.x86 directory.
  3. Open a command shell and change to the ExtractedDir/im/linux.gtx.ppc directory.
  4. Open a command shell and change to the ExtractedDir/im/linux.gtx.s390 directory.
  5. Open a command shell and change to the ExtractedDir/im/aix.motif.ppc directory.
  6. To install the features as an administrator into a shared area, use the installc variant in the following command:

    .\installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

    ./installc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini silent-install.ini

  7. To install the features into a user-specific location use the userinstc variant in the following command:

    .\userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

    ./userinstc -acceptLicense -showVerboseProgress -input silent-install-server2.xml --launcher.ini user-silent-install.ini

  8. By default, the response files are configured for a Liberty server deployment. To modify the response files for a deployment, complete the following steps:
    1. Open silent-install-server.xml and search for user.com.ibm.team.install.jfs.appserver.noappserver.disable and change its value to false.
    2. Search for user.com.ibm.team.install.jfs.appserver.liberty.disable and change its value to true.
    3. Remove the comment from the following section and specify a location to install the web application WAR files:

      <data key='user.JazzFoundationServer.NoAppServer.WebApps.InstallLocation'
      value='C:\tmp\silent-install\JazzTeamServer\server\webapps'/>

      <data key='user.JazzFoundationServer.NoAppServer.WebApps.InstallLocation'
      value='/tmp/silent-install/JazzTeamServer/server/webapps'/>

Adding applications to an existing on IBM i

To add an application to an existing , you will use the QJTS70 LICPGM. For step-by-step instructions for new installations, see Installing and applications on IBM i.

Set up the database

If you are using the included Derby database, no additional setup is necessary. Proceed with the next step.

Note: Although a Derby database is included in the default configuration and requires no installation, this database is limited to 10 users. To enable more users, install a supported enterprise database such as Db2, Oracle, or SQL Server.

To create database tables, see Creating Db2 for z/OS database tables remotely.

By default, IBM Db2i database is setup and configured on your IBM i system. No additional setup is necessary. Proceed with the next step.

The products support IBM Db2 Enterprise Server Edition. For platforms that do not support Enterprise Server Edition, you can use IBM Db2 Workgroup Server Edition. You can obtain a trial download of one these Db2 editions or the free Db2 Express Server edition for deployments of 50 developers or fewer from ibm.com.

Before you begin

This procedure requires that the following prerequisites are met:

  • The databases are not partitioned. Partitioned databases are not supported in this release and must not be used.
  • You have the correct user password. On the UNIX systems, get the password for the Db2 instance owner, which is typically the db2inst1 user.
  • You have reviewed the Db2 documentation to verify that your system meets the requirements and is configured correctly.
  • Db2 is installed and running on a computer to be used as the database server. This computer can be different from the one that runs on.
  • The user in the teamserver.properties file has system administrator authority over the database. For information about preparing a Db2 database with only DBADM authority, see this wiki page.

Procedure

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called CCM with 16K pages and the UTF-8 code set:

    db2 create database CCM using codeset UTF-8 territory en PAGESIZE 16384

database

  1. Open Db2 command window.
  2. Enter this command to create a database for the application called QM with 16K pages and the UTF-8 code set:

    db2 create database QM using codeset UTF-8 territory en PAGESIZE 16384

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called RM with 16K pages and the UTF-8 code set:

    db2 create database RM using codeset UTF-8 territory en PAGESIZE 16384

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called DCC with 16K pages and the UTF-8 code set:

    db2 create database DCC using codeset UTF-8 territory en PAGESIZE 16384

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called LQE with 32K pages and the UTF-8 code set:

    Note: The database requires 32K pages.

    db2 create database LQE using codeset UTF-8 territory en PAGESIZE 32768

    The LQE database must have the MAXAPPLS increased to allow for concurrent connections in to process data if it is not set to AUTOMATIC. Increase the value to 300:

    db2 update db cfg for LQE using maxappls 300

    This means that the lock list must also be increased if it is not set to AUTOMATIC:

    db2 update db cfg FOR LQE using locklist 20000

    The transaction logs will also grow as data is processed in parallel. Increase the LOGFILSIZ to 20000:

    db2 update db cfg for LQE using LOGFILSIZ 20000

    Increase the number of primary and secondary transactions log files:

    db2 update db cfg for LQE using logprimary 25
    db2 update db cfg for LQE using logsecond 100

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called LDX with 32K pages and the UTF-8 code set:

    Note: The database requires 32K pages.

    db2 create database LDX using codeset UTF-8 territory en PAGESIZE 32768

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the Global Configuration application called GC with 16K pages and the UTF-8 code set:

    db2 create database GC using codeset UTF-8 territory en PAGESIZE 16384

database

  1. Open a Db2 command window.
  2. Enter this command to create a database for the application called ENI with 16K pages and the UTF-8 code set:

    db2 create database ENI using codeset UTF-8 territory en PAGESIZE 16384

Data warehouse database

  1. Open a Db2 command window.
  2. Enter this command to create a database for your data warehouse called DW with 32K pages and the UTF-8 code set:

    db2 create database DW using codeset UTF-8 territory en PAGESIZE 32768

    The data warehouse database must have the MAXAPPLS increased to allow for concurrent connections in to process data if it is not set to AUTOMATIC. Increase the value to 300:

    db2 update db cfg for DW using maxappls 300

    This means that the lock list must also be increased if it is not set to AUTOMATIC:

    db2 update db cfg FOR DW using locklist 20000

    The transaction logs will also grow as data is processed in parallel. Increase the LOGFILSIZ to 20000:

    db2 update db cfg for DW using LOGFILSIZ 20000

    Increase the number of primary and secondary transactions log files:

    db2 update db cfg for DW using logprimary 25
    db2 update db cfg for DW using logsecond 200

DBADM authority

If you are creating the database with a user other than the user specified in the teamserver.properties file, you must grant DBADM authority to that user:

db2 connect to database_name
db2 grant dbadm on database to user user_name
db2 disconnect database_name

Verify

If you create all databases on the same database server, verify that the Max number of concurrently active databases is set to a number greater than the number of databases you created. If this value is lower than the number of active databases, you will get the SQL Code 1041 error.

To verify the value and increase the number if necessary, complete these steps:

  1. Open a Db2 command window and enter this command to display the database manager configuration:

    db2 get dbm cfg

  2. Look for the Max number of concurrently active databases line. If this number is lower than the installed databases, increase the number by entering this command:

    db2 update dbm cfg using numdb 32

  3. Stop and start the database manager for these changes to take effect by entering these commands:

    db2stop
    db2start

To create and set up an Oracle database, it is assumed that the user who is preparing the database has database administration authority over the database and that the database, tablespace storage, and appropriate storage configuration is created by a user with system administration authority.

Before you begin

  • The required Java Database Connectivity (JDBC) driver is ojdbc8.jar. For a list of supported database versions and driver versions, see the system requirements link in the Planning checklist section of this document.
  • Restriction: Because of a defect in Oracle JDBC driver 12.1.0.2.0, this version of the driver cannot be used. For details, see repotools -createTables command fails with ORA-01000 on Oracle 12 on the IBM Support portal page.

  • The configuration parameters and tablespace options used in this step are examples and might not entirely apply to your environment. For example, if you cannot use the AUTOEXTEND setting, then the files must be large enough to allow for growth. Or if you cannot use the UNLIMITED size quota for the database user, then make sure to allow enough space for rapid growth.
  • If you install the () applications on the same computer or distributed platforms, you can either create separate databases for each application or you can use the same database for all applications. However, you must create a separate tablespace and a database user who is associated with that tablespace for each application.

    The examples in this step are for one Oracle database with separate tablespaces and database users who are dedicated to each application.

  • The database that you create for the applications must be formatted to use UTF-8 as the character set. By default, Oracle does not create a database with the UTF-8 character set. When you create a new database, ensure that you select AL32UTF8 in the Oracle DB setup.
  • Change the open cursors limit:
    • If you use spfile to start the database, open a SQL *Plus window and enter the following command:

      alter system set open_cursors = 10000 scope=both;

    • If you use pfile to start the database, open a SQL *Plus window and enter the following command:

      alter system set open_cursors = 10000;

  • For the Oracle data warehouse database to work efficiently with the , you must increase the PROCESSES configuration to 3000.

Procedure

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace CCM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and CCM.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE CCM
    DATAFILE 'ORACLE_BASE/oradata/DB/CCM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace CCM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and CCM_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE CCM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/CCM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace ENI with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and ENI.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE ENI
    DATAFILE 'ORACLE_BASE/oradata/DB/ENI.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace ENI_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and ENI_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE ENI_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/ENI_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace QM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and QM.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE QM
    DATAFILE 'ORACLE_BASE/oradata/DB/QM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace QM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and QM_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE QM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/QM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace RM with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and RM.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE RM
    DATAFILE 'ORACLE_BASE/oradata/DB/RM.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace RM_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and RM_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE RM_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/RM_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace DCC with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and DCC.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE DCC
    DATAFILE 'ORACLE_BASE/oradata/DB/DCC.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace DCC_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and DCC_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE DCC_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/DCC_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace LQE with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and LQE.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE LQE
    DATAFILE 'ORACLE_BASE/oradata/DB/LQE.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace LQE_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and LQE_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE LQE_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/LQE_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the application, enter the following command. Replace LDX with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and LDX.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE LDX
    DATAFILE 'ORACLE_BASE/oradata/DB/LDX.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the application, enter the following command. Replace LDX_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and LDX_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE LDX_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/LDX_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the Global Configuration application, enter the following command. Replace GC with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and GC.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE GC
    DATAFILE 'ORACLE_BASE/oradata/DB/GC.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the Global Configuration application, enter the following command. Replace GC_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and GC_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE GC_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/GC_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Create tablespaces for Data Warehouse

  1. Start SQL Plus and log in as SYSTEM or SYSDBA.
  2. To create a tablespace for the common data warehouse, enter the following command. Replace DW with the tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and DW.DBF with the datafile name that you want to create.
  3. CREATE BIGFILE TABLESPACE DW
    DATAFILE 'ORACLE_BASE/oradata/DB/DW.DBF'
    SIZE 1G AUTOEXTEND ON EXTENT MANAGEMENT LOCAL AUTOALLOCATE;

  4. To create a temporary tablespace for the common data warehouse, enter the following command. Replace DW_TEMP with the temporary tablespace name, ORACLE_BASE with the absolute path where Oracle is installed, DB with the name of your Oracle database, and DW_TEMP.DBF with the temporary file name that you want to create.
  5. CREATE TEMPORARY TABLESPACE DW_TEMP
    TEMPFILE 'ORACLE_BASE/oradata/DB/DW_TEMP.DBF'
    SIZE 20M AUTOEXTEND ON EXTENT MANAGEMENT LOCAL UNIFORM SIZE 1M;

Verify

In the Oracle Enterprise Manager Database Control, click Server > Tablespaces and verify that the tablespaces you created are displayed and accessible. Also ensure that the default Oracle tablespace named USERS already exist. If this tablespace does not exist in your Oracle database, create it.

Create an Oracle database user for each new tablespace

After the tablespaces are created, a special Oracle user must be created for each application to use the Oracle database. For multiple Jazz servers that run on one Oracle database, an Oracle database user must be created for each application. The Oracle database user must be able to create database objects in its tablespace (either unlimited or with a space quota) with privileges to create session, table, procedure, and views.

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER CCM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE CCM QUOTA UNLIMITED ON CCM TEMPORARY TABLESPACE CCM_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO CCM_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER ENI_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE ENI QUOTA UNLIMITED ON ENI TEMPORARY TABLESPACE ENI_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO ENI_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER QM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE QM QUOTA UNLIMITED ON QM TEMPORARY TABLESPACE QM_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO QM_DB_USER;

To create a user for application tablespace and to grant the required permissions, enter the following commands:

CREATE USER RM_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE RM QUOTA UNLIMITED ON RM TEMPORARY TABLESPACE RM_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO RM_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER DCC_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE DCC QUOTA UNLIMITED ON DCC TEMPORARY TABLESPACE DCC_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO DCC_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER LQE_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE LQE QUOTA UNLIMITED ON LQE TEMPORARY TABLESPACE LQE_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO LQE_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER LDX_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE LDX QUOTA UNLIMITED ON LDX TEMPORARY TABLESPACE LDX_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO LDX_DB_USER;

To create a user for the application tablespace and to grant the required permissions, enter the following commands:

CREATE USER GC_DB_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE GC QUOTA UNLIMITED ON GC TEMPORARY TABLESPACE GC_TEMP;

GRANT CREATE PROCEDURE, CREATE SESSION, CREATE TABLE, CREATE VIEW TO GC_DB_USER;

To create a user for common data warehouse tablespace and to grant the required permissions, enter the following commands:

CREATE USER DW_USER IDENTIFIED BY Passw0rd DEFAULT TABLESPACE DW QUOTA UNLIMITED ON DW TEMPORARY TABLESPACE DW_TEMP;

GRANT DBA TO DW_USER;

Note: The creation of the data warehouse on Oracle requires more permissions as compared to other databases. When you specify the database user in the connection spec for data warehouse, ensure that the database user has DBA permissions. You can change this permission after the data warehouse is created. For more information, see Completing the installation.

To create the data warehouse without DBA permissions, see this deployment wiki article.

Create an environment variable

In the computer that hosts the applications, create an environment variable named ORACLE_JDBC_DRIVER_FILE and point to the ojdbc8.jar JDBC driver. The location can vary depending on the Oracle product and operating system. You can download the supported Oracle JDBC driver from the Oracle website.

  1. Click Start > Control Panel > System.
  2. Click the Advanced tab, and then click Environment Variables.
  3. In the System variables list, click New.
  4. In the Variable name enter ORACLE_JDBC_DRIVER_FILE, and in the Variable value enter C:\Path_to_JDBC_driver\ojdbc8.jar.
  1. Open a shell window and enter the following environment variable declaration.
  2. export ORACLE_JDBC_DRIVER_FILE =/Path_to_JDBC_driver/ojdbc8.jar

Before you begin

This procedure requires that the following prerequisites are met:

  • The service is started.
  • The Java Database Connectivity (JDBC) driver is installed. See Hardware and software requirements for a supported driver version.
  • The TCP protocol is enabled for SQL Server.
  • The user who creates the database table must be a member in the sysadmin fixed server role, or an owner of the database (dbo).
  • The password you use for the JDBC connection cannot contain the open curly bracket ({) and semicolon (;) characters.
  • Ensure that your server security is in mixed mode. You can verify the mode by checking the server security. It should be set to SQL Server and Windows Authentication Mode.
  • Create an empty directory on your database server to be used as the data warehouse base folder. During the setup wizard, you will be asked to enter this directory.

Procedure

Set up the SQL Server database by using the sqlcmd command line tool, which is provided with the SQL Server installation. You can also use a visual tool, such as SQL Server Studio Management.

Important: If you install applications either on the same computer or distributed platforms, a separate database and a database user who is associated with that database must be created.

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE ccm
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN ccmDBuser
    WITH PASSWORD = 'ccmDBpswd';
    USE ccm;
    exec sp_changedbowner 'ccmDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE ccm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE ccm SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE eni
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN eniDBuser
    WITH PASSWORD = 'eniDBpswd';
    USE eni;
    exec sp_changedbowner 'eniDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE eni COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE eni SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE qm
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN qmDBuser
    WITH PASSWORD = 'qmDBpswd';
    USE qm;
    exec sp_changedbowner 'qmDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE qm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE qm SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE rm
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN rmDBuser
    WITH PASSWORD = 'rmDBpswd';
    USE rm;
    exec sp_changedbowner 'rmDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE rm COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE rm SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE dcc
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN dccDBuser
    WITH PASSWORD = 'dccDBpswd';
    USE dcc;
    exec sp_changedbowner 'dccDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE dcc COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE dcc SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE lqe
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN lqeDBuser
    WITH PASSWORD = 'lqeDBpswd';
    USE lqe;
    exec sp_changedbowner 'lqeDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE lqe COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE lqe SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE ldx
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN ldxDBuser
    WITH PASSWORD = 'ldxDBpswd';
    USE ldx;
    exec sp_changedbowner 'ldxDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE ldx COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE ldx SET READ_COMMITTED_SNAPSHOT ON
    GO

database

  1. Enter the following command to create a database for the application:

    CREATE DATABASE gc
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN gcDBuser
    WITH PASSWORD = 'gcDBpswd';
    USE gc;
    exec sp_changedbowner 'gcDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE gc COLLATE SQL_Latin1_General_CP437_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE gc SET READ_COMMITTED_SNAPSHOT ON
    GO

Data Warehouse database

  1. Enter the following command to create a database for the data warehouse application:

    CREATE DATABASE dw
    GO

  2. Create a user and password and change the ownership of the database by entering these commands:

    CREATE LOGIN dwDBuser
    WITH PASSWORD = 'dwDBpswd';
    USE dw;
    exec sp_changedbowner 'dwDBuser'
    GO

  3. Change the collation of the databases:

    ALTER DATABASE dw COLLATE SQL_Latin1_General_CP1_CS_AS
    GO

  4. Change the row version system for the database:

    Note: Ensure that the connection to the database is open before running this command.

    ALTER DATABASE dw SET READ_COMMITTED_SNAPSHOT ON
    GO

Create an environment variable

In the computer that hosts the applications, create an environment variable named SQLSERVER_JDBC_DRIVER_FILE and point to the JDBC driver. The location of the driver varies depending on your installation.

  1. Click Start > Control Panel > System.
  2. Click the Advanced tab, and then click Environment Variables.
  3. In the System variables list, click New.
  4. In the Variable name enter SQLSERVER_JDBC_DRIVER_FILE, and in the Variable value enter C:\Path_to_JDBC_driver\sqljdbc42.jar.
  1. Open a shell window.
  2. Enter the following environment variable declaration:

    SQLSERVER_JDBC_DRIVER_FILE =.:Path_to_JDBC_driver/sqljdbc42.jar

Set up the by using the Jython script

The clm_was_config.py script configures and sets up security options so that you can run applications in a WebSphere environment.

Before you begin

Ensure you have completed the following tasks:

  • is already installed and running.
  • You have the WebSphere administrative user name and password.
  • Verify or update the level. For a list of supported versions and fix packs, see the Detailed System Requirements page.
  • On UNIX systems, ensure that the Open File Limit value is properly set. For more information, see Planning to install on UNIX and Linux systems.
  • The database is created.

Procedure

  1. If your is installed on a Windows platform, but you are using the Db2 for z/OS database server, open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  2. Search for #createJVMCustomProperty(jvm, "DB2Z_JDBC", db2DriverPath, "") and delete the # sign at the beginning of the line to remove the comment.
  3. Add the file path to location of the Db2z JDBC driver. Note the forward slash. For example:

    createJVMCustomProperty(jvm, "DB2Z_JDBC", "/etc/jazz/server/db2z", "")

  4. To configure the Oracle JDBC driver location open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  5. Search for #createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", oracleDriverPath, "") and delete the # sign at the beginning of the line to remove the comment.
  6. Add the absolute path to location of the Oracle JDBC driver. For example:

    createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", "C:\app\user\product\12.2.0\dbhome_1\jdbc\lib\ojdbc8.jar", "")

    createJVMCustomProperty(jvm, "ORACLE_JDBC_DRIVER_FILE", "/opt/app/user/product/12.2.0/dbhome_1/jdbc/lib/ojdbc8.jar", "")

  7. To configure the SQL Server JDBC driver location open the Jazz_Install_Dir/server/was/clm_was_config.py for editing.
  8. Search for #createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", sqlDriverPath, "") and delete the # sign at the beginning of the line to remove the comment.
  9. Add the absolute path to location of the SQL Server JDBC driver. For example:

    createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", "C:\MSSQL\jdbc\sqljdbc42.jar", "")

    createJVMCustomProperty(jvm, "SQLSERVER_JDBC_DRIVER_FILE", "/opt/mssql/jdbc/sqljdbc42.jar", "")

  10. Save and close the clm_was_config.py file.
  11. Open a command window as administrator and enter the following commands. Replace WAS_Profile_Dir with the directory where profile is installed. For example, C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv01/opt/IBM/WebSphere/AppServer/profiles/AppSrv01:
  12. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the conf directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_was_config.py C:/Jazz_Install_Dir/server/conf

    cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f /opt/Jazz_Install_Dir/server/was/clm_was_config.py /opt/Jazz_Install_Dir/server/conf

  13. For changes to take effect, restart the application server. Replace server1 with the name of your application server:
  14. cd WAS_Profile_Dir\bin
    stopServer.bat server1 -user WAS_USER -password WAS_PASSWORD
    startServer.bat server1

    cd WAS_Profile_Dir/bin
    ./stopServer.sh server1 -user WAS_USER -password WAS_PASSWORD
    ./startServer.sh server1

Manage federated file-based user registry

Before you begin

  • Ensure that is already installed and running.

About this task

uses J2EE container managed authentication for login and system permissions. For application server to work, you must configure a realm with the application server. The file-based user registry is useful for testing or evaluation, because does not support importing users or mapping user roles. For the full application functionality, including viewing system user roles and importing users, supports an LDAP realm.

Configure the federated repositories

  1. In the WebSphere Integrated Solutions Console, click Security > Global security.
  2. Make sure Enable administrative security and Enable application security check boxes are selected.
  3. From the Available realm definitions select Federated repositories and click Configure.
  4. In the Primary administrative user name field, type the administrative ID.
  5. Under Server user identity, make sure Automatically generated server identity is selected. Click OK and then save.
  6. Set Federated repositories as the current realm definition by clicking Set as Current.
  7. Stop and restart the .

Setting up groups and users

To be able to run , you need to define groups and users in the repository and map them to Jazz groups. Before installing any applications, you must create the user groups.

  1. In the WebSphere Integrated Solutions Console, click Users and Groups > Manage Groups.
  2. Click Create and create the following group names:
    • JazzAdmins
    • JazzProjectAdmins
    • JazzUsers
    • JazzGuests
  3. In the Users and Groups section, click Manage Users.
  4. Click Create and enter a name in the User ID field to create a user in the JazzAdmins group.
  5. Click Group Membership and then click Search.
  6. Select JazzAdmins from the Available window and then click Add, to add JazzAdmins to the Mapped To window.
  7. Click Close and in the Create a User page fill in the remaining required fields. Click Create.
  8. Click Create Like and create other users and assign them to the appropriate Jazz group membership.

Set up the

Note: In a distrubuted environment that the is not already setup, you must perform these steps on each application server.

Before you begin

Ensure you have completed the following tasks:

  • is already installed and running.
  • You have the WebSphere administrative user name and password.
  • Verify or update the level. For a list of supported versions and fix packs, see the Detailed System Requirements page.
  • On UNIX systems, ensure that the Open File Limit value is properly set. For more information, see Planning to install on UNIX and Linux systems.
  • The database is created. If you use the default Derby database for evaluation purposes, ensure the location to the database in the teamserver.properties file is an absolute path.

Procedure

  1. Open a browser and login to WebSphere Integrated Solutions Console at https://hostname.example.com:9043/ibm/console/logon.jsp.
  2. The Java 2 Security option must be turned off. If this option is turned on in , the web application will not start.
    1. Click Security > Global security.
    2. Under Java 2 security, clear the check box for Use Java 2 security to restrict application access to local resources.
    3. Ensure that the Enable administrative security and Enable application security check boxes are selected.
  3. To ensure that the LTPA cookies are secure, enable the Requires SSL setting:
    1. Click Security > Global security > Web and SIP security > Single sign-on(SSO).
    2. Click the Requires SSL check box.
    3. Also ensure that Set security cookies to HTTPOnly to help prevent cross-site scripting attacks is selected.
    4. Click OK and Save directly to the master configuration.
  4. Set the Restrict cookies to HTTPS sessions to ensure that the session cookies include the secure field. Enabling this feature restricts the exchange of cookies to HTTPS sessions:
    1. In WebSphere Integrated Solutions Console, click Server > Server Types > WebSphere application servers > server_name > Session management > Enable cookies.
    2. Select the Restrict cookies to HTTPS sessions check box.
  5. Also ensure that the Use available authentication data when an unprotected URI is accessed application server security setting is selected.
    1. Click Security > Global security > Web and SIP security > General settings.
    2. Click the Use available authentication data when an unprotected URI is accessed check box.
    3. Click OK and Save directly to the master configuration.
  6. Add the following session management custom property to avoid SESN0008E error message when a user logs out without terminating the session:
    1. Click Servers > Server Types > WebSphere application servers.
    2. Click server1 and then in the Container Settings section, click Session management.
    3. In the Additional Properties section, click Custom properties.
    4. Click New and enter the following information:
      • Name: InvalidateOnUnauthorizedSessionRequestException
      • Value: true
    5. Click Apply and save directly to the master configuration.
  7. To improve performance of the operating procedures, change the WebContainer thread pool size settings:
    1. Click Servers > Server Types > WebSphere application servers.
    2. Click server1 and then in the Additional Properties section, click Thread pools.
    3. In the Thread pools page, click WebContainer.
    4. Enter 200 in the Minimum Size and Maximum Size fields.
    5. Click OK and save directly to the master configuration.
  8. In version 9.0, the Contexts and Dependency Injection (CDI) 1.2 is enabled by default. If CDI is enabled, it might increase unnecessary performance overhead if the application is not using it. applications do not use CDI and to gain performance, you can disable CDI by setting some Java custom properties and manifest attributes. For detailed instructions, see this IBM Support troubleshooting document.
  9. requires several specific settings on the Java Virtual Machine in which it runs. To set these properties, click Servers > Server Types > WebSphere application servers > server1.
  10. Under Server Infrastructure, click Java and Process Management > Process definition.
  11. Under Additional Properties, click Java Virtual Machine.
  12. In the Generic JVM arguments field, type the following lines:

    -Xmx4g -Xms4g -Xmn1g
    -Xgcpolicy:gencon -Xnocompressedrefs

    -Xmx4g -Xms4g -Xmn1g
    -XX:MaxPermSize=768M -XX:ReservedCodeCacheSize=512M -XX:CodeCacheMinimumFreeSpace=2M

    -Xmx4g -Xms4g -Xmn1g
    -Xgcpolicy:gencon -Xcompressedrefs
    -Xgc:preferredHeapBase=0x100000000

    Tip: If you need more heap size, then you can use the following setting, replacing {N} with the amount of memory to be used and {N/4} with 1/4 of the total memory. For example, if -Xmx is set to 8g, -Xmn should be set to 2g.

    -Xmx{N} -Xms{N} -Xmn{N/4}

    For only: The -Xmn value should be 33% of the -Xms value. For example, if the -Xmx size is 4gb, the -Xmn should be 1365m. The following Deployment wiki document contains useful information about sizing and tuning: Sizing and tuning guide for . For only: If application pages become unresponsive as a result of memory issues, see this technote for troubleshooting.

  13. Click Apply, and then click Save directly to the master configuration.
  14. One of the custom properties you must add is JAZZ_HOME, a system property that specifies where to find certain configuration files. This property uses a URL rather than a simple path, so specify the value as a file-style URL: file:///file_path. Under Java Virtual Machine > Additional Properties, click Custom properties. You must use three forward slashes (///) after file:.

    In a distributed environment, when you are using a separate application server for each web application, you must add these custom properties for each instance of the .

  15. Click New, enter JAZZ_HOME in the Name field, and enter file:///Jazz_Install_Dir/server/conf in the Value field. Substitute Jazz_Install_Dir with the location of installation directory. For example, file:///C:/PROGRA~1/IBM/JazzTeamServer/server/conf if the server is installed in /opt/IBM, enter file:////opt/IBM/JazzTeamServer/server/conf.

    To avoid problems, do not use spaces in file paths. You can use double quotation marks to enclose the path.

  16. Click OK.
  17. Repeat the above steps and add these custom properties:
    • Name: lqe.config.location Value: file:///Jazz_Install_Dir/server/conf/lqe
    • Name: ldx.config.location Value: file:///Jazz_Install_Dir/server/conf/ldx
    • Name: java.awt.headless Value: true
    • Name: org.eclipse.emf.ecore.plugin.EcorePlugin.doNotLoadResourcesPlugin Value: true
    • Name: ORACLE_JDBC_DRIVER_FILE Value: Absolute_path_to_the_JDBC_driver/ojdbc8.jar

      Note: The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about Oracle Java Database Connectivity (JDBC) connections, see Set up the database step.

    • Name: SQLSERVER_JDBC_DRIVER_FILE Value: Absolute_path_to_the_JDBC_driver/sqljdbc42.jar

      Note: The path to the JDBC driver must be an absolute path. Do not use URL path (file:///). For more information about SQL Server JDBC connections, see Set up the database step.

    • Name: log4j.configuration Value: file:///Jazz_Install_Dir/server/conf/startup_log4j.properties

      The settings that the startup_log4j.properties file contains are used at the early stages in the startup process to pass messages to the SystemOut.log file. After the early stages, each Jazz application switches to using the application-specific settings from the Jazz_Install_Dir/server/conf/app_context/log4j.properties file.

  18. Click Save directly to the master configuration.
  19. In the WebSphere Integrated Solutions Console navigation pane, expand Environment and click Shared libraries.
  20. In the Scope list, select Node=MachineNameNode01, Server=server1 and click New.
  21. Enter the shared library name JRS Shared Library, add a description, and set the classpath to: JRS_install_dir/server/conf/rs/\server\conf\rs\WAS_SharedLibrary. For example: C:\Progra~1\IBM\JazzTeamServer\server\conf\rs\WAS_SharedLibrary/opt/IBM/JazzTeamServer/server/conf/rs/WAS_SharedLibrary
  22. Under Class Loading, select the Use an isolated class loader for this shared library check box, click Apply, and then click Save.
  23. For changes to take effect, restart the application server.

Deploy web application (WAR files) by using the Jython script

You can use clm_deploy.py or clm_deploy_distributed.py in a distributed environment to deploy application WAR files.

Before you begin

Ensure that , , and applications are installed prior to running the script.

Complete the following steps to map the security roles to your LDAP groups. Note that the groups must be setup on the LDAP server prior to completing this mapping.

  1. Open the config.py script in a text editor for editing.
  2. Modify the values under RoleMapping to map the security roles to your LDAP groups.
  3. The following example shows the role mapping for the application. Replace the values with the values from your LDAP server. You might need to contact your LDAP Administrator to obtain this information:

    Note: Ensure that the JazzAdmins, JazzUsers, JazzGuests, and JazzProjectAdmins security groups do not have any spaces in their names.

    RoleMapping = {
    'ccm' : {
    'JazzAdmins' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzAdmins,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzUsers' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzUsers,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzGuests' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzGuests,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzProjectAdmins' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzProjectAdmins,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },

    RoleMapping = {
    'qm' : {
    'JazzAdmins' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzAdmins,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzUsers' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzUsers,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzGuests' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzGuests,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },
    'JazzProjectAdmins' : {
    'mappedUser': None,
    'mappedGroup': "cn=JazzProjectAdmins,cn=members,o=ldap.server.com",
    'AllowAccessToEveryone':'No',
    'AllowAccessToAllAuthenticatedUsers':'No'
    },

  4. Save and close the file.

About this task

The clm_deploy.py script installs all application WAR files that are available in the webapps directory into a single node.

The clm_deploy_distributed.py script can be used to install any application WAR files that are available in the webapps directory, if you specify them in your command argument as a comma-separated list.

Note: The web archive applications must have a .war extension.

Procedure

To deploy applications on a single , complete this step:

  1. Open a command window as administrator and enter the following commands. Replace nodeName and server1 with your node name and server name:
  2. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the webapps directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_deploy.py nodeName server1 C:/Jazz_Install_Dir/server/webapps -config C:/Jazz_Install_Dir/server/was

    cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f /opt/Jazz_Install_Dir/server/was/clm_deploy.py nodeName server1 /opt/Jazz_Install_Dir/server/webapps -config /opt/Jazz_Install_Dir/server/was

To deploy applications in a distributed environment, complete this step:

  1. Open a command window as administrator and enter the following commands. Replace nodeName and server1 with your node name and server name. Enter the application names that you want to deploy separated by commas. For example:
  2. Note: On Windows platforms you must use forward slash in the paths for the location of the Jython script and the webapps directory.

    cd WAS_Profile_Dir\bin
    wsadmin.bat -lang jython -user WAS_USER -password WAS_PASSWORD -f C:/Jazz_Install_Dir/server/was/clm_deploy_distributed.py nodeName server1 C:/Jazz_Install_Dir/server/webapps ccm,qm -config C:/Jazz_Install_Dir/server/was

    cd WAS_Profile_Dir/bin
    ./wsadmin.sh -lang jython -user WAS_USER -password WAS_PASSWORD -f /opt/Jazz_Install_Dir/server/was/clm_deploy_distributed.py nodeName server1 /opt/Jazz_Install_Dir/server/webapps ccm,qm -config /opt/Jazz_Install_Dir/server/was

To start the deployed applications, restart the application server. Replace server1 with the name of your application server:

cd WAS_Profile_Dir\bin
stopServer.bat server1 -user WAS_USER -password WAS_PASSWORD
startServer.bat server1

cd WAS_Profile_Dir/bin
./stopServer.sh server1 -user WAS_USER -password WAS_PASSWORD
./startServer.sh server1

Deploy web applications (WAR files)

Note: In a distrubuted environment you must deploy the application .WAR file on the dedicated application server.

Before you begin

  • Make sure is installed and started.
  • You have access to the .WAR files.
  • If is installed in a non-root environment, the user who deploys the applications must have read and write access to the installation directory and all sub-directories.
  • Uninstall default applications (DefaultApplication, ivtApp, and query) if they are installed with the profile. applications do not use these applications and for security and performance reasons they can be removed.

Procedure

  1. Open a browser and login to WebSphere Integrated Solutions Console at https://hostname.example.com:9043/ibm/console/logon.jsp.
  2. Click Applications > New Application > New Enterprise Application.
  3. On the Path to the new application page, select Remote file system and browse for the application.war file. Click Next.

    Depending on the applications that you installed, the following web applications might be available for deployment:

    • ccm.war
    • relm.war
    • iotp.war
    • qm.war
    • rm.war
    • converter.war
    • dcc.war
    • lqe.war
    • ldx.war
    • rs.war
    • gc.war

  4. Select Fast Path, and then click Next.
  5. For the and modules, expand Choose to generate default bindings and mappings, and then select the Generate Default Bindings check box.
  6. On the Map modules to servers page, select the check box next to ldx to specify the target scope on the server for the ldx module.
  7. On the Map modules to servers page, select the check box next to lqe to specify the target scope on the server for the lqe module.
  8. Click Next to accept all default options until you reach the Map context roots for web modules page.
  9. In the Map context roots for web modules, set the following Context Root for applications:
    • to /ccm
    • to /relm
    • to /iotp
    • to /qm
    • to /rm
    • Converter application to /converter
    • to /dcc
    • to /rs
    • to /lqe
    • to /ldx
    • to /gc
  10. Click Finish.
  11. Verify that your application was installed correctly and then click Save directly to the master configuration.

Map security roles to a user or repository group

The following applications must have the same authentication methods for their users and use the same security group mapping as :

  • ccm_war
  • qm_war

Procedure

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. For , click the ccm_war application to open it for editing.
  3. For , click the qm_war application to open it for editing.
  4. In the Detail Properties section, click Security role to user/group mapping.
  5. Select a specific repository group, such as JazzAdmins or JazzUsers, and click Map groups.

    These repository groups are associated with every Jazz implementation and must be mapped to a particular group that contains the authorized users. If you are using LDAP, these groups must be set up on the LDAP server prior to completing this mapping. If you are mapping these repository groups to individual users, select the repository group and click Map Users.

  6. Enter a search string to return your users or group names. Click Search to run the query.
  7. From the list of available users or groups that is returned, select the particular user or group and move it to the Selected column.
  8. Click OK to map the users or groups to the Jazz repository groups.
  9. Save the changes.

Note: If in the future there will be changes to the LDAP configuration level, you must remap the security roles to the user or repository group for and other installed applications.

Update the JAX-RS settings ( 9.x only)

If you are using version 9.x, you must update the JAX-RS settings before you can use the application:

  1. Log in to the administrative console.
  2. Select Servers from the navigation panel and click Server Types.
  3. Under Server Types, select WebSphere application servers.
  4. Click the link for the server that you want to configure. The default server name is server1.
  5. On the Configuration tab, expand the Container Services content list under the Container Settings section and click the Default JAX-RS Settings link.
  6. On this page, you can view the supported JAX-RS providers. From the JAX-RS provider list, select JAX-RS provider version 1.1.
  7. Save the settings and restart the application server.

Configure the application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Click lqe_war to open it and then click Manage Modules.
  3. Click lqe, locate the Class loader order field and select Classes loaded with local class loader first (parent last).
  4. Click OK and save your changes.
  5. Go back to the lqe_war application and click Class loading and update detection.
  6. On the Class loader page, select Classes loaded with local class loader first (parent last).
  7. Click Apply and Save directly to the master configuration.

Configure the application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Click ldx_war to open it and then click Manage Modules.
  3. Click ldx, locate the Class loader order field and select Classes loaded with local class loader first (parent last).
  4. Click OK and save your changes.
  5. Go back to the ldx_war application and click Class loading and update detection.
  6. On the Class loader page, select Classes loaded with local class loader first (parent last).
  7. Click Apply and Save directly to the master configuration.

Configure the application

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. On the Enterprise Applications page, in the list of resources, click rs_war.
  3. On the Configuration page, in the References section, click Shared library references.
  4. Select the rs_war check box and click Reference shared libraries.
  5. In the Available list, select JRS Shared Library and click the right arrow.
  6. Click OK. Click OK again and then click Save.
  7. In the list of resources, click rs_war.
  8. On the Configuration page, under Detail Properties, click Class loading and update detection.
  9. In the Class loader order group, ensure that Classes loaded with local class loader first (parent last) is selected. Click Apply and then click Save.

Start the applications

  1. In WebSphere Integrated Solutions Console click Applications > Application Types > WebSphere enterprise applications.
  2. Select the check box next to the applications you installed, and then click Start:
    • ccm_war
    • relm_war
    • iotp_war
    • qm_war
    • rm_war
    • converter_war
    • dcc_war
    • lqe_war
    • ldx_war
    • rs_war
    • gc_war

    A green arrow should appear that indicates the application is successfully started.

    Note: The Converter application is supported only on Windows and Linux. For installation instructions on other unsupported platforms, see the Delegated Configuration section of Converter Application Configuration and Troubleshooting Guide.

Update the profile

For information about updating the profile, see Configuring the server on IBM i.

Manage users by configuring LDAP

Configure your to use LDAP registry to authenticate users.

Before you begin

If you use LDAP for user management and you enable the option to not use case-sensitive user management, make sure that is also configured to allow user management that is not case sensitive. To configure the login property after you start the server, on the Advanced Properties page of the Administrative web interface, modify the Use case insensitive user ID matching property.

Procedures

  1. Open a web browser and log in to the WebSphere Integrated Solutions Console.
  2. In the left menu, expand Security and then click Global security.
  3. Ensure Enable administrative security and Enable application security check boxes are selected.
  4. Under User account repository, select Standalone LDAP registry from the Available realm definitions list and then click Configure.
  5. In the Primary administrative user name, enter your administrative user ID.
  6. Under Server user identity, ensure that Automatically generated server identity is selected.
  7. Under LDAP server, select a type of LDAP server that you use in your organization. The following LDAP types are available:
    • IBM Tivoli Directory Server
    • Microsoft Active Directory
  8. In the Host field, provide the URL for your LDAP server.
  9. Enter the port number of your LDAP server in the Port field. The default port number is 389.
  10. Enter a base distinguish name (DN) of your directory service.
  11. In the Search timeout field, enter 120 seconds.
  12. Click Test connection to ensure you can successfully connect to your LDAP server, and then click Apply and save the changes.
  13. Under Additional Properties, click Advanced Lightweight Directory Access Protocol (LDAP) user registry settings.
  14. Enter the values for general properties that your LDAP administrator provided to configure .
  15. Click Apply and save the changes and then click OK to go back to the Global Security page.
  16. Set Standalone LDAP registry as the current realm definition by clicking Set as Current.
  17. Stop and restart .
  18. After restarts, validate the changes by logging on to the Integrated Solutions Console.

Copy the ldapUserRegistry.xml file

In a distributed environment when you are setting up a new for your new application, you must copy the ldapUserRegistry.xml file from or any other srerver that is already configured for LDAP and use it in your new server.

Before you begin

If your new server has not been started yet and the JazzInstallDir/server/liberty/servers/clm directory does not exist, open a command prompt and enter the following command to create the server:

cd JazzInstallDir\server
server.startup.bat -create

cd JazzInstallDir/server
./server.startup -create

Procedure

  1. Go to a server that is already configured for LDAP and copy the JazzInstallDir/server/liberty/servers/clm/conf/ldapUserRegistry.xml file.
  2. In the new server, go to the JazzInstallDir/server/liberty/servers/clm/conf directory and paste the ldapUserRegistry.xml file replacing the existing one.
  3. In the new server, go to the JazzInstallDir/server/liberty/servers/clm directory and open the server.xml file for editing.
  4. Comment out the <include location="conf/basicUserRegistry.xml"/> line and uncomment <include location="conf/ldapUserRegistry.xml"/> to enable the LDAP user registry.
  5. Save and close the server.xml file.

Start the server

You can now start the server.

  1. To start the server, open a command windowshell and enter the following commands:
  2. cd Jazz_Install_Dir\server
    server.startup.bat

    cd Jazz_Install_Dir/server
    ./server.startup

Log in to to register the applications

  1. Ensure that is started and running.
  2. Open a browser and log in to the administration page at https://qualified.hostname.com:9443/jts/admin.
  3. Click the Server tab.
  4. In the Configuration section, click Registered Applications.
  5. In the Registered Applications section, click Add.
  6. In the Add Application window, complete the following information about your application:
    • Discovery URL: The Service Contribution Resource (SCR) URL for the application. In general, for the Discovery URL, add /scr to the end of the public URL of the application. For example:
      • For , enter https://qualified.hostname.com:9443/ccm/scr
      • For , enter https://qualified.hostname.com:9443/qm/scr
      • For , enter https://qualified.hostname.com:9443/rm/scr
      • For , enter https://qualified.hostname.com:9443/relm/scr
      • For , enter https://qualified.hostname.com:9443/gc/scr
      • For , enter https://qualified.hostname.com:9443/ldx/scr
      • For , enter https://qualified.hostname.com:9443/dcc/scr
      • For , enter https://qualified.hostname.com:9443/lqe/scr
      • For , enter https://qualified.hostname.com:9443/rs/scr
    • Application Name: After you type the Discovery URL, wait a few moments and will detect the type of application that you are registering and suggests a name. The application name must be unique among all applications that are registered with .
    • Application Type: The application type is also detected by and displayed in the field.
    • Consumer Secret: Type a consumer secret (administrative password) for the application that you are registering. automatically generates a consumer key in the background. Re-type the secret in the Re-type Secret field.
    • Functional User ID: After you type the Discovery URL, the application suggests a functional user ID.

      Type the user ID of the functional user that will perform background tasks. automatically suggests a user ID that you can use, or you can click Browse and search for an existing one. The functional user ID does not have to exist in the external registry; if the user ID does not exist in the repository, it is automatically created.

  7. Note: When Jazz Security Architecture single sign-on (SSO) is enabled in Jazz Team Server, the user interface differs. There is not a Consumer Secret field. After you complete the Application Name and Discovery URL fields, several fields are displayed. If the application also has Jazz Security Architecture SSO enabled, an Authorization Server Credentials section is displayed with the following fields: Authorization Server URL (read-only field), Administrator User ID, and Administrator Password. You must complete the latter two fields. If the application does not have Jazz Security Architecture SSO enabled, then the Consumer Secret and Re-type Secret fields are displayed. You must complete these fields.

  8. Click Finish. Registering an application might take a few moments.
  9. After registration is complete, configure the application. To do so, in the message that confirms that you registered the application, click Application Setup Wizard. This open the Setup Wizard page. You must provide or confirm the database settings and finalize the configuration so that all applications registered with can share project areas. Complete the following steps to set up the applications:
    1. On the Configure Database page for the application, provide or confirm the database connection. Click Test Connection, and then click Next.
    2. On the Finalize Application page, click Finalize Application Setup. Verify that Finalize completes without error. Click Next.
    3. On the Configure Data Warehouse page for the application, confirm the database connection, click Test Connection, and then click Next.
    4. To configure a data source, click Connect to data sources. Additionally, on this page you can import ready-to-use reports and assign a report manager.
    5. On the Summary page, verify that there are no errors.

Register the applications by using the Repotools command

You can use the registerApp repository tools command-line to register an application with an existing . With this method, you must provide a .properties file that contains all the required configuration parameters to register an application including the database connection parameters.

  1. Ensure that is started and running.
  2. Open a command window as an administratior and enter the following commands:

    cd Jazz_Install_Dir\server
    repotools-jts.bat -registerApp repositoryURL=https://hostname.example.com:9443/jts adminUserId=admin adminPassword=**** parametersFile=C:\app.properties

  3. Open a command-line shell and enter the following commands:

    cd /opt/Jazz_Install_Dir/server
    ./repotools-jts.sh -registerApp repositoryURL=https://hostname.example.com:9443/jts adminUserId=admin adminPassword=**** parametersFile=/opt/app.properties

To learn about the registerApp repository tools command, see Repository tools command to register an application.

Configure the

To configure the , see Configuring the connector.

Activate and enable configuration management

For detailed instructions about activating configuration management and enabling project areas including a link to obtain an activation key, see Getting started for application administrators.

Install to use as an MQTT broker for the

Note: Installation of is not supported on Windows platforms.

provides secure, rapid, bidirectional messaging for the Internet of Things (IoT) and mobile environments. is a high performance MQTT broker.

I. Installing the non-Dockerized version of

Procedure

To install a non-Dockerized version of , follow these steps:

  1. Download the required packages for the latest 2.0 from ibm.com.

    Note: An IBMid is required to access these files. If you do not have an IBMid, you will be prompted to create one before you can download .

  2. Follow the instructions in the documentation to install the non-Dockerized (RPM) version.

II. Logging in to the Web UI

About this task

You can use the URL http://server:Port to connect to the Web UI. This task uses https://10.10.2.149:9087/ to connect to the Web UI. To use this URL, your Web UI container must be running on the host with IP address 10.10.2.149.

You must accept a certificate and server certificate before you can start using the Web UI. You must change both of these certificates if you move from a non-production to a production environment.

Procedure

  1. Open a browser and connect to the Web UI by entering the following URL: 10.10.2.149:9087
  2. Accept the Web UI certificate so that you can view the login page.
  3. Log in and accept the server certificate in one of the following ways:
    • If you are using Internet Explorer 11, complete the following steps to log in and accept the server certificate:
      1. At the login prompt, type the default ID and password (admin/admin) and click Log in.
      2. After you are logged in, follow the browser prompts to accept the certificate. The Common configuration and customization tasks section of the Web UI home page is displayed.
    • If you are using Firefox or Google Chrome, complete the following steps to log in and accept the server certificate:
      1. At the login prompt, type the default ID and password (admin/admin) and click Log in. The Cannot connect to the server error is displayed.
      2. Click Click here in the message text. An error page is displayed that indicates that you need to accept the certificate.
      3. Follow the browser prompts to accept the certificate. The About page is displayed in a new browser window.
      4. Return to the Web UI page. If the error is still displayed, refresh the page. The Common configuration and customization tasks section of the Web UI home page is displayed.
      5. Note: To prevent repeatedly having to accept certificates, you can replace the default certificate with your own appropriately signed certificate. For information about specifying your own certificate, see Changing the Web UI security certificate.

III. Configuring

uses organizational configuration objects called hubs to define configuration policies.

Procedure

  1. After logging in to the Web UI by following the procedure in the previous task, create a new hub and then create and assign a connection policy, messaging policy and endpoint.
  2. Create a new connection policy. Provide a name and a description. Enter a client ID and select MQTT for protocol. Under Specify the resources that an MQTT client is permitted to consume, select Allow Clients with Durable Subscriptions and Allow Persistent Messages check boxes.
  3. Go to the Message Policy tab and create a new topic policy. Provide a name and a description for the new topic policy. Enter a client ID and select MQTT for the protocol. In the Topic field enter an asterisk (*) and, under Authority, select both the Publish and Subscribe check boxes. Under Subscriber Settings, ensure that you enter 10000 for the Max Messages value and select Discard Old Messages for the Max Messages Behavior value.
  4. Finally, create a new endpoint. Provide a name and a description. In the Port field, specify the port that the application uses to connect to publish and subscribe to messages. Later, you will add this port to the server.startup file. Select MQTT as the protocol. Set the Max Message Size value to 4096. Under Connection Policies and Messaging Policies, associate the connection policy and messaging policy (topic policy) that you created in the previous steps.

IV. Configuring the MQTT broker URI

After you installed and configured , you must add the MQTT broker URI in the Advanced Properties section of the administrative Web UI:

Procedure

  1. Open a browser and log in to the administrative Web UI where the application is installed. For example, https://hostname.example.com:9443/gc/admin.
  2. Click Application > Advanced Properties.
  3. Search for Global Configurations.
  4. In the com.ibm.team.gc.service.internal.GcApiPropertiesService section, add the MQTT broker URI in the provided field.
  5. Set the Use MQTT for contribution cache property to true.
  6. Scroll up the page and click Save.
  7. Restart the server for the changes to take effect.
  8. You must perform these steps on all GCM instances. Ensure that you use the same MQTT broker URI.

To learn about other configuration settings for multiple GCM instances, see Configuring multiple GCM instances.