Install Clarity PPM

ccppmop157
Before you install 
Clarity PPM
, plan the installation and all environment details. Repeat the configuration planning process for the pilot, test, QA, training, and production environments.
 The following resources help you plan your installation or upgrade:
Use the following checklist to assist you with new installations:
This diagram shows the steps for a new installation of CA PPM
This diagram shows the steps for a new installation of CA PPM
SaaS administrators can skip the hardware-related configuration items that do not apply.
 
 
2
 
 
Complete the Pre Install Steps
The following image shows a sample pre-check results page:
The following image shows a sample pre-check results page
Thefollowingimageshowsasampleprecheckresults page
 
As a SaaS administrator, you do not run the manual checkinstall steps; however, you still need to be aware of options available for your fresh installation, see Start Here: Common Steps Before All New Installs and Upgrades.
Complete the CA PPM SaaS Post Install Steps
  • To verify that Clarity PPM is accessible from a browser, connect using the configured 
    Entry URL 
    value for your organization and product instance. The Entry URL is configured for you by CA. If you have multiple application instances, the URL can point to a load balancer. If you have a single-server installation, the URL points to your Clarity PPM application server instance. For example, ondemand.ca.com or https://<server_name>.ondemand.ca.com/niku/nu
  • Change your default password.
  • Install any add-ins that you intend to use with this release. See Add-Ins and Integrations.
  • Identify the Clarity PPM views that require configuration before business users can access them.
  • Configure portlets and pages as appropriate to expose or hide any new functionality available in the new release.
  • Update access rights for users, groups, or OBS instances with new or updated security rights that are introduced in this release. Click 
    Administration
    Resources
     and add most if not all global access rights to the admin user.
Video Series: Installation
The following videos help you install Clarity PPM in on-premise environments: 
 
Preparing Your System for Installation
 

 
Installing the Primary Server
 

 
Installing and Configuring Jaspersoft 7.1 Server
 

 
Pre-Install Requirements
  1. If you are re-installing over a previous fresh install or migrating to a new server, you can backup your installation directory and database. Otherwise, skip this step and perform a new install.
  2. Verify the third-party software that is supported for this release. See 
    Compatibilities
     in the Release Notes (On Premise).
  3. Verify that you have the required license key information to install some third-party software products. See the documentation or readme file on the installation media.
  4. Verify that you have administrator rights for the servers.
  5. Disable any custom database triggers, custom unique restraints, or antivirus scanners that can interfere with the installation scripts.
  6. Spaces in the PATH variable may cause difficulty on a Windows server. You can escape the entries using quotes. Another option is to replace the entries with their short 8.3 file names. For example, to escape the spaces, change the entry ;
    C:\Program Files (x86)\;
     to 
    ;"C:\Program Files (x86)\";
    In this example, the spaces can also be avoided with the short name 
     
    C:\Progra~2\:
     
     
     
     
     
     To determine short file names for a path, see the Microsoft Windows documentation.
  7. Verify you can access the installation media and database images. 
    Clarity PPM
     uses a backup-based database deployment mechanism. Instead of building the database during the installation, a pre-built, fully populated database backup base image is provided on the installation media. The image contains everything that a new installation requires. The installation media contains the following base images:
    • A Microsoft SQL Server base image that is compatible with all supported SQL Server versions.
    • An Oracle base image that is compatible with all supported Oracle versions.
     Mirroring and replication of the 
    Clarity PPM
     database (SQL Server or Oracle) are not supported.
  8. Verify that you do not install a test or development environment on the same server as a production environment.
  9. As a database administrator, follow the Oracle or Microsoft SQL Server documentation to install the database software. Verify that the database software is operational before you configure it for 
    Clarity PPM
    .
Manage Services with CSA
During and after the installation, use CA PPM System Administration (CSA) to stop, start, and monitor the services in the cluster. The Jaspersoft and database servers are unmanaged, a standard practice for most organizations.
 
CSA
 was formerly known as, and is still referred to as, 
NSA
.
 
Clarity PPM
 is comprised of the server services that run on the application server. By default, all services are 
managed
. A managed service is one that is started, stopped, and monitored from CSA using local beacon services running on each system.
Most of the services can be left unmanaged, if desired. An unmanaged service operates the same as a managed service with one difference: The CSA application cannot control or monitor an unmanaged service. The database server, the reports server, and the application server (in some instances) can be unmanaged.
The 
Clarity PPM
 services include:
  •  
    app: 
    The 
    application service
     handles client requests. You can use one or more 
    app 
    services for each cluster. You can configure multiple instances for each server. The app server is always managed.
  •  
    beacon: 
    The 
    beacon service
     is used to manage a cluster. You can use one beacon service for each server in the cluster.
  •  
    bg: 
    You can use one or more 
    background services
     for each cluster. You can configure multiple instances for each server. You are required to manage bg services.
  •  
    db: 
    You can use one Oracle or Microsoft SQL Server 
    database service
     for each cluster. Databases can be managed or unmanaged.
  •  
    nsa: 
    The 
    system administration service 
    is always managed
    .
     You can use one nsa service for each cluster.
Database Backup Images for New Installations
 
Clarity PPM
 uses a backup-based database deployment mechanism. The installation media provides two pre-built, fully populated database backup 
base images
. The base images contain everything that a new installation requires.
Backup images are available for the application and data warehouse databases. If you use Advanced Reporting with Jaspersoft, the data warehouse database is required.
The installation media contains the following images:
  • The Microsoft SQL Server base image, compatible with all supported SQL Server versions.
  • The Oracle base image, compatible with all supported Oracle versions.
Configure a PPM Database with Oracle
Install Oracle. Follow the third-party documentation. We do not recommend the default Oracle feature where it attempts to automatically install and configure a database for you. Create a CA PPM (formerly niku) database, ppm tablespaces, and database user. Then import the database schema from the database backup file on the 
Clarity PPM
 installation media.
Complete the following tasks in the order presented to configure Oracle for use with 
Clarity PPM
.
  1. For extended character handling on an Oracle server, set the NLS language to AL32UTF8.
    1.  
      UNIX
      : Edit the UNIX user profile to add the NLS_LANG variable:
      NLS_LANG=AMERICAN_AMERICA.AL32UTF8 EXPORT NLS_LANG
    2.  
      Windows: 
      Start the registry editor:
      1. From the Start menu, select Run, and enter 
        regedit
        .
      2. Go to 
        HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\<
        Oracle Home
        >
         and change the value for key NLS_LANG to:
        AMERICAN_AMERICA.AL32UTF8
  2. Set the required parameters in the following table for your new database:
    Name
    Value
    Character Set
    AL32UTF8
    National Character Set
    UTF8/AL16UTF16
    nls_date_format
    YYYY-MM-DD HH24:MI:SS
    nls_sort
    BINARY
    nls_comp
    BINARY
    query_rewrite_enabled
    true
    Cursor_sharing
    FORCE
  3. Set the following parameter values to optimize performance when running 
    Clarity PPM
     with Oracle 12.1.0.2:
    1. optimizer_adaptive_features=false 
    2. optimizer_inmemory_aware=false 
    3. optimizer_adaptive_reporting_only=true
  4. Set the following parameter values to optimize performance with Oracle 12.2.0.1:
    1. optimizer_inmemory_aware=false
    2. optimizer_adaptive_reporting_only=true
     Also apply the optional fix for a known performance issue with Oracle. See 
    Post-Install: Optimize Oracle 12c Performance
     near the end of this page.
  5. The following initNIKU.ora file uses Automatic Memory Management (AMM). The following samples are the recommended parameter settings. However, you can adjust the settings according to your environment.
 
Windows
 
*.audit_file_dest='C:\apps\oracle\admin\niku\adump' *.audit_trail='db' *.compatible='12.2.0.1' *.control_files='C:\apps\oracle\oradata\niku\control01.ctl','C:\apps\oracle\oradata\niku\control02.ctl' *.cursor_sharing='FORCE' *.db_block_size=8192 *.db_domain='' *.db_name='niku' *.diagnostic_dest='C:\apps\oracle' *.job_queue_processes=20 *.memory_max_target=16G *.memory_target=12G *.nls_comp='binary' *.nls_date_format='YYYY-MM-DD HH24:MI:SS' *.nls_sort='binary' *.open_cursors=1000 *.processes=1000 *.remote_login_passwordfile='EXCLUSIVE' *.sessions=1000 *.session_cached_cursors=1000 *.sga_max_size=0 *.sort_area_size=0 *.streams_pool_size=512M
 
Linux (Non-Windows)
 
*.compatible='12.1.0.2' *.control_files='/niku/oracle/oradata/niku/control01.ctl','/niku/oracle/oradata/niku/control02.ctl','/niku/oracle/oradata/niku/control03.ctl' *.core_dump_dest='/niku/oracle/admin/niku/cdump' *.cursor_sharing='FORCE' *.db_block_size=8192 *.db_cache_size=16777216 *.db_domain='' *.db_file_multiblock_read_count=16 *.db_name='niku' *.diagnostic_dest='/niku/oracle/admin/niku/udump' *.filesystemio_options='SetAll' *** for non ASM instances. *.job_queue_processes=20 *.memory_max_target=16G *.memory_target=12G *.nls_comp='binary' *.nls_date_format='YYYY-MM-DD HH24:MI:SS' *.nls_sort='binary' *.open_cursors=1000 *.processes=1000 *.remote_login_passwordfile='EXCLUSIVE' *.sessions=1000 *.session_cached_cursors=1000 *.sga_max_size=0 *.sga_target=0 *.sort_area_size=0 *.streams_pool_size=512M *.undo_management='AUTO' *.undo_tablespace='UNDOTBS1' *** The memory target and tablespace sizes can be adjusted depending upon the customer implementation. If customers are using Linux Huge pages, the DBA can disable AMM and use SGA and PGA instead, until Oracle supports AMM and Linux Huge pages. SQLNET.ora parameters: NAMES.DIRECTORY_PATH= (TNSNAMES, EZCONNECT) SQLNET.INBOUND_CONNECT_TIMEOUT = 0
Create the Required Oracle Tablespaces (Sample Script)
To create the required tablespaces for 
Clarity PPM
 to work with Oracle, use the following script and adjust the size as appropriate. The Oracle software and database instance must already be created.
The schema in the backup is NIKU, and the tablespaces are shown in the following example:
  • INDX_LARGE
  • INDX_SMALL
  • USERS_LARGE
  • USERS_SMALL
CREATE TABLESPACE "USERS_LARGE" DATAFILE '<ORACLE_BASE>\ORADATA\<SID>\USERS_LARGE.DBF' SIZE 2G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 10G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "USERS_SMALL" DATAFILE '<ORACLE_BASE>\ORADATA\<SID>\USERS_SMALL.DBF' SIZE 1G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 4G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "INDX_LARGE" DATAFILE '<ORACLE_BASE>\ORADATA\<SID>\INDX_LARGE.DBF' SIZE 2G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 10G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "INDX_SMALL" DATAFILE '<ORACLE_BASE>\ORADATA\<SID>\INDX_SMALL.DBF' SIZE 1G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 4G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO;
 
Example: Creating Tablespaces
 
ORACLE_BASE= c:\apps\oracle SID=NIKU CREATE TABLESPACE "USERS_LARGE" DATAFILE 'C:\APPS\ORACLE\ORADATA\NIKU\USERS_LARGE.DBF' SIZE 2G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 10G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "USERS_SMALL" DATAFILE 'C:\APPS\ORACLE\ORADATA\NIKU\USERS_SMALL.DBF' SIZE 1G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 4G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "INDX_LARGE" DATAFILE 'C:\APPS\ORACLE\ORADATA\NIKU\INDX_LARGE.DBF' SIZE 2G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 10G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO; CREATE TABLESPACE "INDX_SMALL" DATAFILE 'C:\APPS\ORACLE\ORADATA\NIKU\INDX_SMALL.DBF' SIZE 1G REUSE AUTOEXTEND ON NEXT 1G MAXSIZE 4G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO;
Set the 
Clarity PPM
 Database Required Oracle User Privileges
The following sample script shows the required privileges for a CA PPM schema user.
CREATE USER <ppm> IDENTIFIED BY <ppm> DEFAULT TABLESPACE users_large TEMPORARY TABLESPACE TEMP PROFILE DEFAULT; GRANT CREATE SESSION TO <ppm>; GRANT ALTER SESSION TO <ppm>; GRANT CREATE TABLE TO <ppm>; GRANT CREATE TRIGGER TO <ppm>; GRANT CREATE VIEW TO <ppm>; GRANT QUERY REWRITE TO <ppm>; GRANT CREATE PROCEDURE TO <ppm>; GRANT CREATE JOB TO <ppm>;
Import the CA PPM Application Database Backup Image (Oracle)
The Oracle database backup that 
Clarity PPM
 provides contains the complete schema that is needed for a new installation. The schema in the backup is NIKU, and the tablespaces are:
  • INDX_LARGE
  • INDX_SMALL
  • USERS_LARGE
  • USERS_SMALL
If you need a schema or tablespace remapping, use the Datapump options. For complete information about database import operations and the available options for using the Oracle Datapump, search the Oracle website.
 
Follow these steps:
 
  1. On the CA PPM installation media, locate the Oracle database image in the 
    <root>/database
     folder.
  2. Save the database backup to a location on the database server.
  3. Initiate a sqlplus session as the system user and create an import directory:
    1. To log in to sqlplus, enter the following command:
      > sqlplus system/<system_password>
    2. In sqlplus, run the query to create an import directory.
      SQL> create or replace directory import_directory as '<database backup location>';
    3. Exit sqlplus.
  4. To initiate the import, issue the following command:
    > impdp system/<system_password> DIRECTORY=import_directory transform=oid:n DUMPFILE=oracle_base.db SCHEMAS=niku LOGFILE=import.log
    An import.log is generated in the same location as the database backup. Import errors are expected as there are dependencies between the imported items. Once the import has completed, you can recompile the database to resolve invalid objects.
     If you are using different tablespaces than the ones provided in the backup image, provide tablespace remapping parameters. For information about tablespace remapping parameters, see the Oracle documentation for impdp.
  5. To compile invalid objects from the import, log in to sqlplus as the sys user (
    sysdba) 
    and issue the following command:
     
     SQL> @utlrp.sql
     
    The utlrp.sql and utlprp.sql scripts are provided by Oracle to recompile all invalid objects in the database. They are located in the 
    $ORACLE_HOME/rdbms/admin
     directory.
  6. To recompile invalid objects from the CA Clarity PPM Install bin folder, run the following command:
     
     admin db compile
     
Configure Oracle Database Connectivity and Net Service Name
On Windows servers, the Database Configuration Assistant automatically creates the CA PPM service. If the service name is sufficient, you can skip this step.
  1. Verify that the NLS language setting in the operating system is AL32UTF-8.
  2. Configure an Oracle net listener service. During Oracle installation, the Oracle Net Configuration Assistant is typically launched automatically to create the default listener. If necessary, start the Oracle Net Configuration Assistant for UNIX or Windows using the appropriate command:
    •  
      UNIX
      :  
      <oracle home>/bin/netca &
       
    •  
      Windows: 
      Click the
       Start
       Menu, and choose 
      Programs, Oracle,
       Oracle Home, 
      Configuration and Migration Tools, Net Configuration Assistant
       
To create the TNS listener, use the information in the following table:
Oracle Net Configuration Assistant Screen
Option
Value
Welcome
Local Net Service Name Configuration
Selected
Net Service Name Configuration
Service Name
Enter the service name provided during the Oracle database installation.
 
Default:
 niku
TCP/IP
Host Name
<database server name>
 
Notes
:
  • If you already have a configured TNS Listener on the server, you can skip is step.
  • If you are using a third party tool (for example, AuqaData Studio) to connect externally to the Oracle Database, note the following tip from Oracle as a workaround for an existing bug:
In Oracle 12.1, the default value for the SQLNET.ALLOWED_LOGON_VERSION parameter has been updated to 11. This change causes 10.2.0.5 Oracle RAC database creation using DBCA to fail with the following error:
 
 ORA-28040: No matching authentication protocol error in 12.1 Oracle ASM and Oracle Grid Infrastructure environments.
 
Database clients using pre-11g JDBC thin drivers cannot authenticate to 12.1 database servers unless the 
SQLNET.ALLOWED_LOGON_VERSION
 parameter is set to the old default of 8.
 
Workaround
: Set the following parameter values in the 
oracle/network/admin/sqlnet.ora
 file:
  • SQLNET.ALLOWED_LOGON_VERSION_CLIENT=8
  • SQLNET.ALLOWED_LOGON_VERSION_SERVER=8
New! Limited CA Support is Available for Oracle Multitenant
Oracle 12c introduces multitenancy (MT), pluggable database (PDB) capabilities, and new encryption.
Oracle Multitenant architectures for next-generation cloud databases deliver isolation, agility, and scale. A multitenant container database can hold many pluggable databases. An existing database can simply be adopted with no application changes required. Oracle Multitenant fully complements Oracle Real Application Clusters, Oracle Active Data Guard, and other options.
 
Follow these steps
:
  1. As a database administrator, install and configure your Oracle MT enabled database. No support from CA is available or required for these steps:
    1. You can create a container in a test environment for CA PPM 15.3 or higher.
    2. Create your PDB, directory, and permissions.
    3. Query your PDB and resolve any connection issues.
  2. Log in to CSA.
  3. On the 
    Overview
     page, click the link for your CA PPM server instance.
  4. Click the 
    Database
     tab.
  5. Under 
    Internal Connection: Niku
    , CSA shows your PDB status as 
    Unavailable
     until you complete the following configuration steps.
    1. Select the 
      Specify URL
       check box.
      The 
      JDBC URL
       field appears with default values that include an 
      SID
       assignment. For example:
       jdbc:clarity:oracle://my_ppm_server:1818;
       SID=niku;
       BatchPerformanceWorkaround=true;
       InsensitiveResultSetBufferSize=0;
       ServerType=dedicated;
       supportLinks=true 
       
    2. Change 
      SID
       to 
      ServiceName
      .
    3. Set the 
      ServiceName
       parameter to the name of your PDB.
The following image shows a new configuration example:
 
oracle_mt_csa.jpg
 
The following 
JDBC URL
 string shows another example:
jdbc:clarity:oracle://server1:1115; ServiceName=serviceTNS; BatchPerformanceWorkaround=true; InsensitiveResultSetBufferSize=0; ServerType=dedicated; supportLinks=true; AlternateServers=(server2:1115;server3:1115);
LoadBalancing=true
Configure a 
Clarity PPM
 Database with Microsoft SQL Server
Instead of Oracle, you can use Microsoft SQL Server. After you install SQL Server, complete the following tasks to import and configure the database for use with 
Clarity PPM
.
  1. Set up valid login credentials for 
    Clarity PPM
    . This login name and password are the values that you specify in CSA to log in to the database. The login name and password can be any combination. 
  2. Set the Microsoft SQL Server Database Schema name to 
    niku
    .
     
    This name must be the Default Schema for the login user you created on the Microsoft SQL server.
  3. Import the database backup image. On the 
    Clarity PPM
     installation media, locate the MSSQL database image in the 
    <root>/database
     folder.
  4. Save the database backup to a temporary location on the database server.
  5. Use the Restore Database tool in Microsoft SQL Server Management Studio to restore the base image.
    To database: niku
    From device: c:\<
    temporary location you saved the database image to
    > \mssql_base.db
  6. Verify the import. Remove the temporary folder and its contents.
  7. Associate the imported database with your SQL server security user by running the following pl/sql as the sa user:
    USE niku ALTER USER niku WITH LOGIN=<your security user>
  8. To grant the 
    VIEW SERVER STATE
     permission to the 
    <your security user>
     user, use the following command:
    GRANT VIEW SERVER STATE to <your security user>
Review the Imported SQL Server Database Options
Mixed collations settings are not supported. If you change the server-level default from SQL_Latin1_General_CP1_CI_AS to another collation, create a new SQL Server instance with the correct collation SQL_Latin1_General_CP1_CI_AS before creating the 
Clarity PPM
 database.
The import procedure creates the database with the options in the following table. Review these options to verify that they meet your requirements.
Option
Value
ARITHABORT
ANSI NULLS
QUOTED IDENTIFIER
ON
To apply, execute:
ALTER DATABASE <database>
SET ARITHABORT ON
ALTER DATABASE <database>
SET ANSI_NULLS ON
ALTER DATABASE <database>
SET QUOTED_IDENTIFIER ON
Compatibility level
MS SQL 2014: 120
To apply, execute:
EXEC SP_DBCMPTLEVEL <database>, 120
 
MS SQL 2016: 130
To apply, execute:
EXEC SP_DBCMPTLEVEL <database>, 130
 
Database Schema Name
niku
The login name can be anything, but the default schema name for the login user must be 
niku
.
Database user roles
db_owner
The database user must be able to alter the 
Clarity PPM
-schema and otherwise own the database.
READ COMMITTED SNAPSHOT
ON
To apply, execute:
ALTER DATABASE <database>
SET READ_COMMITTED_SNAPSHOT ON
VIEW_SERVER_STATE
Granted to database user. To apply, execute:
GRANT VIEW SERVER STATE to niku
REMOTE QUERY TIMEOUT
sp_configure 'remote query timeout',0
reconfigure with override
 
Configure the Tomcat Application Server
  1. Keep your systems up to date with the latest patches. See your vendor documentation for more information.
  2. Install the appropriate versions of the following software on each server that you plan to include in a cluster. The products that you install on a server depend on the services the server runs.
    Service
    Required Product
    Database service (db)
    Oracle or Microsoft SQL Server
    Clarity System Administrator service (nsa), 
    Clarity PPM
     Application (app) service
    Apache Tomcat
     
    Clarity PPM
     Background service (bg), Beacon service
    AdoptOpenJDK 11.0.3+7
  3. Some third-party library JAR files (currently, jgroups-all.jar and xinclude.jar) are shipped separately from the image. The install.jar image does not contain the third-party files. Any install packages for a previous version of 
    Clarity PPM
     that are included in the install.jar also exclude the JAR files. For each release, the files are bundled into a third-party JAR library file. The file name uses the following format: 
    thirdparty.libs.<release number>.jar 
    (for example, thirdparty.libs.15.3.0.jar). To make the files available, retrieve the thirdparty.libs.<
    release number
    >.jar
     
    file from the installation media. Place the file in a location that is accessible to the installer.
     If you place the JAR file in the installation directory, the installer does not prompt you for the location of the file.
  4. Install Java. All new installations or upgrades require Java. Clarity PPM 15.7 uses AdoptOpenJDK 11.0.3+7. Navigate to the installation media that you downloaded and open the Java folder. 
    1. On Linux, log in to the server as root and go to the cd /usr directory. Extract the OpenJDK11U-jdk_x64_linux_hotspot_11.0.3_7.tar.gz file. By default, Java is installed in /usr/ path.
    2. On Windows, extract the OpenJDK11U-jdk_x64_windows_hotspot_11.0.3_7 file using tools such as Winzip to the Java directory on your system.
  5. Set or update the environment variables (JAVA_HOME and PATH) to point to the new Java.
Configure Java Environment Variables on the Application Server
 
Linux
: To update the environment variables on Linux, edit the user (.profile) file and add or modify the following system variables:
  •  
    JAVA_HOME
    : Shell scripts use this variable to locate the correct Java home directory. For example:
    JAVA_HOME=/<Java home directory>
    export JAVA_HOME
  •  
    PATH: 
    Locates the command-line utilities. Add the following information to the beginning of the existing PATH system variable:
    PATH=/<clarity home>/bin:$JAVA_HOME/bin:$PATH
    export PATH
 
Windows
: To update the environment variables on Windows, open the Control Panel and add or modify the following system variables:
  •  
    JAVA_HOME
    Specifies the Java home directory only, and is not a path variable. Therefore, only
     
    the home directory can be present in the JAVA_HOME value.
    Value: <
    Java home directory
    >
     The JAVA_HOME value cannot contain the semi-colon (;) character. If the value has a trailing backslash (\) at the end, the checkinstall script skips all scripts.
  •  
    PATH
    Locates the command-line utilities. Add the following information to the beginning of the existing PATH system variable:
    Value: <
    clarity home
    >\bin;%JAVA_HOME%\bin;%PATH
Perform the Pre-Install Script Steps
  1. Verify that the database setup is complete.
  2. Install Apache Tomcat on one or more application servers:
    1. Navigate to the installation media that you downloaded and locate the apache-tomcat-8.x.zip file.
    2. Copy the file to the root directory or create an application directory (/tomcat).
    3. Extract the .zip file using the following command: 
      jar xvf <drive>/Tomcat/apache-tomcat-8.x.zip
      The apache-tomcat application is created in the folder where you extracted the files. This folder becomes the Apache Tomcat home directory.
  3. Verify that the appropriate third-party software has been installed on all of the servers that you plan to use in the cluster.
  4. Familiarize yourself with CSA. To complete the configuration after you run the installation script, use CSA. For an Apache Tomcat J2EE application server, the installation script installs and starts CSA automatically.
  5. Every server in a cluster must have the same multicast address value. The nsa service uses the address to discover the Beacon services in the cluster. This value is defined in the Server Properties in CSA.
  6. Designate one server as the administration server.
  7. The HTTP and HTTPS Entry URL fields for the server in CSA cannot be 
    localhost 
    when Jaspersoft is integrated with 
    Clarity PPM
    . When you use Jaspersoft, the URLs must be explicitly entered on the Application subtab of the Properties tab for the 
    Clarity PPM
     server. For example:
    HTTP Entry URL: http://<server name>:<port> HTTPS Entry URL: https://<server name>:<port>
Run the Installation Checker (checkinstall)
Run the Installation Checker (checkinstall) on the designated server for a new installation or upgrade. Although this utility runs automatically at the start and end of installations and upgrades, you can also run it as a standalone utility to verify that your system is ready for the installation.
The utility detects the following:
  • Disk Space
  • Oracle Database Table-Space and Partitioned Tables
  • Duplicate GL Allocation Slices
  • Duplicate/Multiple Idea-to-OBS Associations
  • Seeded Custom Object Code Conflicts
  • Invalid Matrix Rows
  • Other Validations
The Installation Checker can help you assess a new installation or upgrade before you start the actual process. The Installation Checker runs automatically after an upgrade to validate the success or failure of the upgrade process. The utility produces a zipped report archive file that can help you plan an installation or upgrade.
When the Installation checker is invoked as a standalone utility or automatically at the end of an upgrade attempt, a zipped report archive is created. The archive contains the following files:
  • precheck-results.xml and precheck-results.html.
  • postcheck-results.xml and postcheck-results.html. These files are present only if the Installation Checker is invoked through the upgrade process.
  • install.log (if available).
  • checkinstall.log.
  • database output customization files (if present).
  • admin.log from the target directory (if present).
  • install.properties (if present).
  • checkinstall.properties (if present).
  • checkinstall-version.properties.
The archive has a timestamp encoded name (for example, checkinstall-results_2018-04-17_16-48-31.zip). The file is located in the checkinstall/check-logs directory, and if possible, the file is copied into the <target runtime dir>/logs/checkinstall directory.
Each individual check produces one of the result codes in the following table with a diagnostic message.
 
Code
 
 
Description
 
INFO
Indicates that the check was successful and no potential problems were detected. Specific advice can be present to aid in planning the installation or upgrade.
WARNING
Indicates a potential problem. Details are contained in the message. Address the problem before running the installation or upgrade.
ERROR
Indicates a serious installation or upgrade problem. Details are contained in the message. The installation or upgrade process does not continue when one or more error conditions exist.
The following image shows a sample pre-check results page:
 
image2017-7-21 9:7:46.png
 
 
Follow these steps:
 
  1. Extract the 
    Clarity PPM
     installer to the 
    Clarity PPM
     application server.
  2. Open a command prompt and navigate to the checkinstall directory located in the directory to which you extracted the installer.
  3. Invoke the checkinstall command:
    LINUX:
     
    sh checkinstall.sh
     
    Windows:
     
    checkinstall.bat
     You are asked for the Operator Username and Operator Email. This information refers to the user who is upgrading or installing and the email of the user. This information is stored as a record in the installation log.
  4. When you run checkinstall.sh on Linux, an 
    unexpected end of file
     error might occur. As a workaround, convert the script with dos2unix and then run it again.
    dos2unix ./checkinstall.sh dos2unix: converting file ./checkinstall.sh to Unix format ... sh ./checkinstall.sh
    (Optional) You can also use the following perl script to run checkinstall:
    perl -i -pe 'y|\r||d' checkinstall.sh
  5. Verify the results. The results include any warnings and errors, and also indicate customizations made to the application. Review the customizations and make adjustments for the upgrade as necessary.
Video: Checkinstaller Utility
The following video is provided by CA Technologies.
 

 
 To play this video in full-screen mode, click the YouTube logo at the bottom of the video. 
Run the 
Clarity PPM
 Installation Script
If you are installing a cluster, run the installation script on 
each server
 that you plan to include in the cluster. When the installation script finishes, the installation process is not yet complete. Finish the installation tasks and configuration using the 
Clarity PPM
 System Administration application.
 Record the 
Clarity PPM
 System Administration password that is created during the installation. The password is required to log in to 
Clarity PPM
 System Administration and complete the installation.
 During the Apache Tomcat installation, you are asked if you want to install 
Clarity PPM
 System Administration locally. Enter 
true 
for the administration server only. For other servers in the cluster, enter 
false
.
 
Follow these steps:
 
  1. From the command prompt, navigate to the directory where you want to unpack the installer file, and type the following commands:
    mkdir temp cd temp
  2. From the directory, run the JAR command to extract install.jar from the installation media:
    jar -xvf <path of the installation media>/install.jar
  3. Run the installation script using the following commands:
    LINUX:
     
    chmod +x ./install.sh sh ./install.sh
     
    Windows:
     
    install.bat
  4. To complete the command-line installation, follow the on-screen instructions. The workflow and instructions for an installation appear in a single phase at the beginning.
    See the following list for installation property descriptions:
    •  
      Third Parties Libraries Jar Directory
      Specifies the directory where the installer can find the thirdparty.libs.14.1.0.jar file when the file is not in the current directory.
    •  
       
      Clarity PPM
       Home Directory
      Specifies the directory in which to install 
      Clarity PPM
      . This directory is created if it does not exist.
    •  
      JDK Home Directory
      The required AdoptOpenJDK 11.0.3+7 version as specified in the release notes. 
    •  
      Beacon Multicast Address
      The multicast address that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. The multicast address must be in the Class address range between 224.0.0.0 and 239.255.255.255. Each server within a cluster must use the same address and port.
      Default value: 230.0.0.1
      We recommend an IP address in the 239.x.x.x subnet.
    •  
      Beacon Multicast Port
      The port that the Beacon and 
      Clarity PPM
       System Administration use for service discovery. Each 
      Clarity PPM
       cluster requires a unique IP address. Each server within a cluster must use the same address and port.
      Default value: 9090
    •  
      Beacon Client Port
      Defines the server port number that the Beacon service uses.
      Default value: 9091
    •  
      Super User Command Prefix
      (UNIX only) The optional command prefix utility, such as sudo, to execute root-level commands. For example, you can implement a root-level command when choosing a socket port below 1024 because root-level access is required to allocate it.
    •  
      Super User Name
      (UNIX only) The optional replacement for the 
      root superuser
       name. This name can be used alone or with the superuser command prefix. For example, if used with sudo, specify the user to which sudo rights are given here. If you are not using sudo, set this value to the user name of the user installing and running 
      Clarity PPM
      . If you are not running 
      Clarity PPM
       as root, set this value to the user name of the user who runs 
      Clarity PPM
       services.
    •  
      Install 
      Clarity PPM
       System Administration (CSA)
      (Apache Tomcat only) Specifies whether to install 
      Clarity PPM
       System Administration on the current server. Enter one of the following values:
      • If you are installing 
        Clarity PPM
         System Administration on this server, enter 
        true
        .
      • Otherwise, enter 
        false
        .
    •  
      Tomcat 8 Home Directory
      (Apache Tomcat only) Defines the Apache Tomcat 8 home directory.
    •  
      CSA Web Port
      (Apache Tomcat only) Defines the web port number that 
      Clarity PPM
       System Administration uses in a UNIX system. This value must be greater than 1024; otherwise, the service must run as root.
      Default value: 8090
    •  
      Enter password
      (Apache Tomcat only) Specifies the 
      Clarity PPM
       System Administration password.
      Default value: admin
    •  
      Operator User Name
      Specifies the user name of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Operator Email Address
      Specifies the email address of the operator who is running the installation script. This information is kept as a record in the installation log.
    •  
      Acknowledge reviewing Install Guide and Change Impact & Upgrade Guide
      This prompt records a response from installing users that they have read both 
      Installing and Upgrading 
      and 
      Change Impact and Upgrade.
       
Post-Install: Complete the Installation
These steps explain how to complete the 
Clarity PPM
 installation in a configuration running the Apache Tomcat application server.
 
Follow these steps:
 
  1. If not added, deployed, and running, you may need to run the following command to add, deploy, and start the NSA:
    ./service add deploy start nsa
  2. Log into CSA (formerly NSA). For example, log in to http://HOSTNAME:8090/niku/app using the password you created during the installation, and add, deploy, and start the background, and app services. If you specified a CSA port number other than 8090, use that value instead.
  3. In the left navigation panel, click 
    Servers
     and select the local server.
  4. Click each subtab that is listed on the 
    Properties
     tab and complete the fields necessary for your configuration of 
    Clarity PPM
    . Most installations should use multicast messaging. In fact, clustered Jaspersoft environments are required to use multicast. However, limited support is available for using JDBC PING as an alternative. See CSA: Multicast Messaging and the topic below it titled 
    CSA: Configure JDBC PING as an Alternative to Multicast
    .
    1. Set the 
      Bind Address
       to the IP address of the primary NIC on the server. If the server is part of a cluster, ensure that this IP address is on an IP subnet that includes the other servers as members. Set the bind addresses of the other servers to their IP address. Set the bind address for multicast to work properly. If you change the multicast address or the bind-address, you can receive a system error as you navigate away from the subtab page. If you receive an error, log out from CSA, and then log back in and continue the configuration.
    2. To learn more about other fields, see CSA: Clarity PPM System Administration.
  5. Add the application and background services.
    1. Click 
      All Services
      .
    2. Click 
      Add
       to see the available services.
    3. Select the 
      Clarity PPM
       Application and 
      Clarity PPM
       Background services and click 
      Add
      .
    4. Select all the services and click 
      Deploy
      .
    5. Select all the services and click 
      Start
       
  6. Run the admin warmup command:
    admin warmup -url <applnURL> -user <UserID> -password <Password> -verbose
  7. Run the admin warmup command:
    admin warmup -url <applnURL> -user <UserID> -password <Password> -verbose
  8. To verify that 
    Clarity PPM
     is accessible from a browser, connect using the configured 
    Entry URL 
    value. The Entry URL is configured in CSA on the Application subtab. If you have multiple application servers, the Entry URL points to the load balancer. If you have only one server installed, the Entry URL points to the application server. The Entry URL has the following format:
    http://<
    server name
    >:<
    port
    >/niku/nu
    The default user ID and password are admin/admin. If the default HTTP port value of 80 is used, you do not have to specify the <
    port
    > value.
  9. Change your default password.
  10. Install any add-ins that you intend to use with this release. See Add-Ins and Integrations.
  11. Identify the 
    Clarity PPM
     views that require configuration before business users can access them.
  12. Configure portlets and pages as appropriate to expose or hide any new functionality available in the new release.
  13. Update access rights for users, groups, or OBS instances with new or updated security rights that are introduced in this release. Click 
    Administration
    Resources
     and add most if not all global access rights to the admin user.
Post-Install: Verify the Installation
You can run a health check on any server. The health check generates a report for each server that is selected and verifies aspects of the installation. The report contains a list of categorized line items, each with an associated status. Examples of line items include the testing of ports, database parameters, and third-party software product installation.
 
Follow these steps:
 
  1. Log in to 
    Clarity PPM
     System Administration (CSA).
  2. On the Overview page, select the checkbox next to each server that you want to include in the report, and click Run Health Check.
  3. View the log files in CSA for the servers in a cluster:
    1. Click Servers in the left navigation pane.
    2. Click the server name and click Logs.
    3. In the Log File field, select the log file that you want to view and click Go. Limit the amount of data by selecting a value in the Max Size field.
    4. (Optional) To download the file, click Download and specify a target location.
  4. Verify the time settings are identical. For functionality and accuracy of data in 
    Clarity PPM
     and all jobs, including the Load Data Warehouse Job, verify the following:
    1. The server time is the same (preferable, down to the second) on the 
      Clarity PPM
       application server, 
      Clarity PPM
       database server, and Data Warehouse database server.
    2. The timezone, date, and time is the same on the 
      Clarity PPM
       application server and database servers in the same environment. Do not allow any differences.
    This synchronization is necessary because the Load Data Warehouse job imports data based on the last_updated_date field on the object instances. If the date and time on the servers do not match, data may not be loaded into the Data Warehouse. For other jobs, if the date and time do not match, the job may not start. Or, the job may start later than expected, leading to inaccurate data.
  5. Continue configuring your new installation of 
    Clarity PPM
     with CSA. See CSA: Clarity PPM System Administration.
Post-Install: Optimize Oracle 12c Performance
On local installations of Oracle 12c R1 or R2, you might detect a regression issue with Oracle 12c when ORDERED hint is used in structured queries. An Oracle bug in 12c R2 can degrade performance if the optimizer is set to 12.2.0.1.
  • For systems using Oracle 12c R1 (12.1.0.2), no further action is required.
  • For systems using Oracle 12c R2 (12.2.0.1), you can optimize performance by setting the optimizer to 12.1.0.2. We recommend applying this optional local fix.
 
Follow these steps
  1. From a command prompt in Oracle, enter the following lines:
    sqlplus / as sysdba ALTER SYSTEM SET "_fix_control" = '17800514:0'; Exit;
  2. Run the following command:
    ALTER SYSTEM SET OPTIMIZER_FEATURES_ENABLE= '12.1.0.2' SCOPE=BOTH;
  3. Verify that your Oracle 12c R2 initialization file parameters appear similar to the following example:
    *._fix_control='17800514:0' *._optimizer_multi_table_outerjoin=FALSE *.audit_file_dest='/fs0/oracle/12201/12c/admin/niku/adump' *.audit_trail='DB' *.cluster_database=FALSE *.compatible='12.2.0.1' *.control_files='/fs0/oracle/12201/12c/oradata/niku/CONTROL01.CTL','/fs0/oracle/12201/12c/oradata/niku/CONTROL02.CTL' *.cursor_sharing='FORCE' *.db_block_size=8192 *.db_name='niku' *.diagnostic_dest='/fs0/oracle/12201/12c/admin/niku/udump' *.dispatchers='(PROTOCOL=TCP) (SERVICE=nikuXDB)' *.local_listener='LISTENER_NIKU' *.nls_comp='BINARY' *.nls_date_format='YYYY-MM-DD HH24:MI:SS' *.nls_language='AMERICAN' *.nls_sort='BINARY' *.nls_territory='AMERICA' *.open_cursors=1000 *.optimizer_adaptive_plans=false *.optimizer_adaptive_reporting_only=TRUE *.optimizer_adaptive_statistics=FALSE *.optimizer_features_enable='12.2.0.1' *.optimizer_inmemory_aware=FALSE *.pga_aggregate_target=4G *.processes=1000 *.remote_login_passwordfile='EXCLUSIVE' *.session_cached_cursors=1000 *.sessions=1536 *.sga_target=80G *.streams_pool_size=536870912 *.trace_enabled=TRUE *.undo_tablespace='UNDOTBS1'