CA Clarity Project &

CA Clarity Project & Portfolio
Manager
™
Installation Guide
v12.0.0
Second Edition
This documentation and any related computer software help programs (hereinafter referred to as the
“Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at
any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in
part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA
and protected by the copyright laws of the United States and international treaties.
Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the Documentation for
their own internal use, and may make one copy of the related software as reasonably required for back-up and
disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy.
Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for
the Product are permitted to have access to such copies.
The right to print copies of the Documentation and to make a copy of the related software is limited to the period
during which the applicable license for the Product remains in full force and effect. Should the license terminate for
any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the
Documentation have been returned to CA or destroyed.
EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY
APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING
WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY
LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT
LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY
ADVISED OF SUCH LOSS OR DAMAGE.
The use of any product referenced in the Documentation is governed by the end user’s applicable license
agreement.
The manufacturer of this Documentation is CA.
Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the
restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.2277014(b)(3), as applicable, or their successors.
All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.
Copyright © 2008 CA. All rights reserved.
Contact CA
Contact Technical Support
For your convenience, CA provides one site where you can access the
information you need for your Home Office, Small Business, and Enterprise CA
products. At http://ca.com/support, you can access the following:
■
Online and telephone contact information for technical assistance and
customer services
■
Information about user communities and forums
■
Product and documentation downloads
■
CA Support policies and guidelines
■
Other helpful resources appropriate for your product
Provide Feedback
If you have comments or questions about CA product documentation, you can
send a message to techpubs@ca.com.
If you would like to provide feedback about CA product documentation,
complete our short customer survey, which is also available on the CA support
website, found at http://ca.com/support.
Contents
Chapter 1: Installation
9
Before You Start ............................................................................... 9
How to Install CA Clarity PPM .............................................................. 11
How to Upgrade CA Clarity PPM ............................................................ 17
Install into Application Server Clusters ..................................................... 23
System Architecture Diagrams ............................................................. 23
Set Up the Server ............................................................................ 26
Set Up Unix User Accounts ................................................................ 26
Set Windows System Variables ............................................................ 27
Install the Java 2 SDK..................................................................... 27
Install Third-party Software ............................................................... 28
How to Install and Upgrade CA Clarity PPM ................................................. 28
CA Clarity System Administration .............................................................. 31
niku Command—Command-line Interface .................................................. 32
CA Clarity System Administration Installation with BEA WebLogic or IBM WebSphere .......... 34
Install and Upgrade CA Clarity PPM from CA Clarity System Administration ................... 35
Deploy CA Clarity PPM with Generic J2EE ................................................... 41
Test the Application ....................................................................... 41
Reports Install ............................................................................ 42
Verify the Installation ..................................................................... 42
View Log Files Using CA Clarity System Administration ...................................... 43
Multiple Installations on One Server ........................................................... 44
Unix Environments ........................................................................ 44
Windows Environments.................................................................... 44
Verify NSQL Queries .......................................................................... 45
Identify and Manually Upgrade Views .......................................................... 46
Restore Defaults Based on Partitions ....................................................... 47
Add-In Installations ........................................................................... 51
How to Install Add-Ins .................................................................... 51
Download the .iso Image File .............................................................. 51
Extract the .jar File ....................................................................... 52
Stop the Services ......................................................................... 53
Install the Add-In ......................................................................... 55
Start the Services ......................................................................... 55
Apply the Add-In ......................................................................... 57
Contents 5
Chapter 2: System Administration
59
CA Clarity PPM Connectivity ................................................................... 59
General Administration ........................................................................ 60
Open Server Ports ........................................................................ 60
When to Use CA Clarity System Administration ............................................. 62
System Administration Terms.............................................................. 63
Run Health Reports ....................................................................... 65
Log Files ................................................................................. 66
Edit Logger Configuration ................................................................. 67
When to Use the Niku and Nikuadmin Utilities .............................................. 69
Back Up a CA Clarity PPM Installation ...................................................... 70
Restore a CA Clarity PPM Installation ....................................................... 71
Compile and Analyze Existing Oracle Database Objects ...................................... 72
Security...................................................................................... 72
Manage Database Server Passwords ....................................................... 72
Enable Secure Sockets Layer (SSL) in Apache Tomcat ....................................... 74
Lightweight Directory Access Protocol (LDAP) Server Integration ............................. 83
Single Sign-On (SSO) ..................................................................... 90
User Sessions Q&A ........................................................................ 94
Application Servers ........................................................................... 95
Tune Sun HotSpot JVMs ................................................................... 95
Change the J2EE Server from Apache Tomcat to Generic J2EE ............................... 98
Clustering .................................................................................... 99
Scale CA Clarity PPM ...................................................................... 99
Multicast Messaging ....................................................................... 99
Load Balancers and Sticky Sessions ....................................................... 101
Sharing Disks ............................................................................ 102
Distribute Files to Servers in a Cluster ..................................................... 102
Multiple Application or Background Service Instances ...................................... 103
Configure Dedicated Reporting Databases ................................................. 104
Oracle Database Clustering ............................................................... 105
Performance ................................................................................ 106
Analyze the Oracle Database Schema ..................................................... 107
Analyze the Microsoft SQL Server Database Schema ....................................... 109
Enable the Datamart Parallel Option....................................................... 109
Maintain Sufficient Memory ............................................................... 109
Restrict the Microsoft SQL Server Memory Consumption .................................... 110
Ensure Adequate Disk I/O Throughput .................................................... 111
How to Ensure Optimal Database Server File Layout........................................ 112
Document Indexing, Searching, and Storage .................................................. 113
Index Documents ........................................................................ 114
Recreate the Search Index ............................................................... 115
6 Installation Guide
Migrate the Filestore to the Database ..................................................... 115
Datamart ................................................................................... 116
Enable the Datamart Parallel Option for Oracle ............................................. 116
Enable the Datamart Parallel Option for Microsoft SQL Servers .............................. 117
UI Themes .................................................................................. 118
Set the UI Theme ........................................................................ 118
Create Custom UI Themes ................................................................ 118
Customize Theme Stylesheets ............................................................ 123
Change Tab and Section Styles ........................................................... 125
Customize Graphs ....................................................................... 127
Chapter 3: Third-party Software
131
Server Operating Systems ................................................................... 131
Unix Environment Requirements .......................................................... 131
Windows Environment Requirements ...................................................... 132
Server Database Software.................................................................... 133
How to Configure Oracle on Unix .......................................................... 133
How to Configure Microsoft SQL Server .................................................... 138
Server Database Connectivity ................................................................ 139
Configure Database Connectivity to Oracle ................................................ 139
Configure Database Connectivity to Microsoft SQL Server on Windows....................... 141
Application Server Software .................................................................. 142
Install Apache Tomcat.................................................................... 142
Install BEA WebLogic ..................................................................... 143
Install IBM WebSphere ................................................................... 149
Java 2 SDK (J2SE) ........................................................................... 158
Upgrade from Previous JDK Versions ...................................................... 158
Install the Java 2 SDK for Solaris ......................................................... 159
Install the Java 2 SDK for Linux ........................................................... 159
Install the Java 2 SDK for HP-UX .......................................................... 160
Install the Java 2 SDK for IBM AIX ........................................................ 160
Install the Java 2 SDK for Windows ....................................................... 161
How to Install Business Objects Software ..................................................... 162
Install Business Objects on Windows ...................................................... 162
Configure ODBC Connections for SQL Server............................................... 163
Install Business Objects on UNIX.......................................................... 164
Verify the Business Objects Installation ................................................... 165
Configure Business Objects ............................................................... 166
Configure CA Clarity PPM for Business Objects ............................................. 166
Contents 7
Chapter 4: Client Applications
169
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect169
Common Client Application Installation Scenarios .......................................... 169
Install Client Applications from CA Clarity PPM ............................................. 170
Install Client Applications from the CA Clarity PPM Install DVD .............................. 171
Install Client Applications from the File Server ............................................. 171
Types of Client Application Installations ................................................... 172
Download Adobe SVG Viewer ................................................................. 176
Remove Client Applications ................................................................... 176
Chapter 5: Server Properties
177
CA Clarity System Administration Server Properties ............................................ 178
System ..................................................................................... 179
Database Server Properties .................................................................. 182
Application Server Properties ................................................................. 189
Documents and Search ...................................................................... 196
Server Reporting Options .................................................................... 198
Server Security Options ...................................................................... 200
Background ................................................................................. 207
Appendix A: Actuate
211
How to Upgrade CA Clarity PPM with Actuate .................................................. 211
Actuate Report Server ....................................................................... 212
Recompile Custom Reports ............................................................... 213
Upgrade from a Previous Version of Actuate ............................................... 213
Actuate 9.0 on Unix ...................................................................... 213
Actuate 9.0 on Windows .................................................................. 215
Manually Disable RSSE ................................................................... 216
Actuate Server Reporting Options............................................................. 216
Actuate Server Database Connectivity ........................................................ 218
One Actuate, More than one CA Clarity PPM ................................................... 218
Change Report Servers ...................................................................... 219
Index
8 Installation Guide
221
Chapter 1: Installation
This section describes how to upgrade and install CA Clarity PPM on the
Windows or Unix operating systems.
This section contains the following topics:
Before You Start (see page 9)
Set Up the Server (see page 26)
CA Clarity System Administration (see page 31)
Multiple Installations on One Server (see page 44)
Verify NSQL Queries (see page 45)
Identify and Manually Upgrade Views (see page 46)
Add-In Installations (see page 51)
Before You Start
Consider the following critical points when installing or upgrading CA Clarity
PPM:
■
Never install a CA Clarity PPM test or development environment on the
same machine as a production environment.
■
Make sure you follow a recommended upgrade path. Not all CA Clarity PPM
releases have upgrade paths between them.
Note: See the latest Release Notes for more information on the supported
version and on upgrade paths.
■
Before you upgrade CA Clarity PPM, it is recommended that you back up
the existing CA Clarity PPM installation directory and database.
■
It is recommended that you disable any custom triggers that may interfere
with the upgrade or install scripts.
■
One of the most important tasks a system administrator must perform is
planning the installation of the CA Clarity PPM environment. The
configuration planning process must be repeated for the pilot, test, QA,
training, and production environments.
Chapter 1: Installation 9
Before You Start
You can install the CA Clarity Application (app) services on one or more
servers. A group of servers is called a cluster. The needs of your organization
and the amount of CA Clarity PPM functionality you intend to implement are
key factors when designing a cluster. Consult a CA Technology Services
engagement manager to plan the hardware sizing and configuration.
CA Clarity PPM Requirements
A CA Clarity PPM installation includes:
■
J2EE application server(s) to service client requests
■
An Oracle or Microsoft SQL Server database
■
A reports server to execute and view reports
■
Background server(s) for business process execution and scheduled tasks
These are all considered services within a CA Clarity PPM cluster. By default,
all such services are managed. A managed service is one that is started,
stopped, and monitored from the System Administration application (NSA)
using local Beacon services running on each system.
Most of the services can be left unmanaged, if desired. This applies to the
database server, the reports server, and the application server if either BEA
WebLogic or IBM WebSphere are selected. An unmanaged service operates no
differently than a managed one. The only difference is that the Clarity System
Administration application (NSA) cannot control or monitor an unmanaged
service. The most common example of an unmanaged service is the database,
as organizations will often manage all databases within a central DBA group.
These services are described in detail below.
Services Used in CA Clarity PPM
The following services are used in CA Clarity PPM:
app
You can use one or more CA Clarity Application (app) services per cluster.
You may configure multiple instances per server. The app server is always
managed except when using BEA WebLogic or IBM WebSphere.
Application: Application Service
beacon
The Beacon is a basic service used to manage a cluster. You can use one
Beacon service per server in the cluster.
Application: Beacon
10 Installation Guide
Before You Start
bg
You can use one or more CA Clarity Background (bg) services per cluster.
You may configure multiple instances per server. You must manage CA
Clarity Background (bg) services.
Application: Background Service
db
You can use one Database (db) service per cluster. Databases may be
managed or unmanaged.
Application: Oracle or Microsoft SQL Server
nsa
You can use one CA Clarity System Administration (nsa) service per
cluster. These services are always managed except when using BEA
WebLogic or IBM WebSphere.
Application: System Administration Service
reports
You can use one or more Reports (reports) services per cluster. Reports
servers can be managed or unmanaged.
Application: BO XI R2
How to Install CA Clarity PPM
The following high-level steps provide generic guidelines on how to complete
the CA Clarity PPM install process. As applicable, references are provided to
specific sections in this document and to other CA Clarity PPM documents for
additional information on completing a step.
Note: See the Product Architecture Stack (PAS) Guide for more information on
the supported versions of all third-party software.
Use the following installation process to install CA Clarity PPM:
1.
Install the database server (Oracle or MS SQL Server).
2.
Configure the database server (see page 133), including the creation of
the database user account with the access rights required by CA Clarity
PPM.
Chapter 1: Installation 11
Before You Start
3.
Install the following third-party software (see page 131):
a.
Java SDK
b.
Application server (Apache Tomcat, BEA WebLogic, or IBM
WebSphere)
c.
Reporting server (Business Objects), including the appropriate
database client software (Oracle native client or MS SQL ODBC
connection)
4.
Install CA Clarity PPM.
5.
Install optional CA Clarity PPM add-ins (see page 51).
Installation Walkthroughs
The following installation walkthroughs are provided to facilitate the planning
of new CA Clarity PPM installations that use the default Apache Tomcat
application server that ships with CA Clarity PPM.
Install CA Clarity PPM with Apache Tomcat (Single Server)
Perform the following tasks to install CA Clarity PPM in a configuration with all
services running on a single server that uses the Apache Tomcat application
server.
12 Installation Guide
Task
Reference
1. Set up the server and install the thirdparty software.
Set Up the Server (see page 26)
2. From the command console:
How to Install and Upgrade CA
Clarity PPM (see page 28)
■
Extract and execute install.jar.
■
When prompted to select a J2EE
vendor, select Tomcat.
■
When asked to install the System
Administrator locally, select Yes.
Before You Start
Task
Reference
3. Using CA Clarity System Administration:
CA Clarity System
Administration (see page 31)
■
Configure the properties.
■
Add database, reports, background,
and application services.
■
Start the database service.
■
Perform the installation tasks.
■
Start the remaining services and verify
the application is accessible from an
external client machine using the Entry
URL specified in the CA Clarity System
Administration Application Properties.
Do not continue until the given Entry
URL is verified and functioning.
4. From CA Clarity System Administration:
■
Install Reports.
CA Clarity System
Administration (see page 31)
Install CA Clarity PPM with Apache Tomcat (Multiple Servers)
Perform the following tasks to install CA Clarity PPM in a configuration where
services are distributed across multiple servers that use the Apache Tomcat
application server.
Task
Reference
1. Set up all servers and install the appropriate
third-party software on each server. Configure
one server to be the administration server.
"Set Up the Server" (see
page 26)
2. From the administration server:
How to Install and
Upgrade CA Clarity PPM
(see page 28)
■
Extract and execute install.jar.
■
When prompted to select a J2EE vendor,
select Tomcat.
■
When asked to install the System
Administrator locally, select Yes.
3. From command prompt on all other servers:
■
Extract and execute install.jar.
■
When prompted for a J2EE vendor, select
Tomcat.
■
When asked to install CA Clarity System
Administrator locally, select No.
How to Install and
Upgrade CA Clarity PPM
(see page 28)
Chapter 1: Installation 13
Before You Start
Task
Reference
4. Using CA Clarity System Administration:
CA Clarity System
Administration (see
page 31)
■
Configure the properties.
■
Add database, reports, background, and
application services.
■
Start the database service.
■
Perform the installation tasks.
■
Use Distribute XDM to update the XDM
configuration on all servers.
■
Start all remaining services and verify the
application is accessible from an external
client machine using the Entry URL specified
in the CA Clarity System Administration
Application Properties. Do not continue until
the given Entry URL is verified and
functioning.
5. From CA Clarity System Administration:
■
Install Reports.
CA Clarity System
Administration (see
page 31)
Install CA Clarity PPM with Generic J2EE (Single Server)
Perform the following tasks to install CA Clarity PPM in a configuration with all
services running on a single server that uses BEA WebLogic or IBM WebSphere
with the Generic J2EE option.
Task
Reference
1. Set up the server and install the thirdparty software.
Set Up the Server (see
page 26)
2. From administration server’s command
prompt:
How to Install and Upgrade CA
Clarity PPM (see page 28)
■
Extract and execute install.jar.
■
When prompted for a J2EE vendor,
select Generic J2EE.
3. Using the J2EE application server’s
administration console, deploy the CA
Clarity System Administration application
(nsa.ear). The nsa.ear is created in the CA
Clarity PPM home directory when the
install.jar is executed.
14 Installation Guide
Note: See J2EE vendor
documentation.
Before You Start
Task
Reference
4. Using CA Clarity System Administration:
CA Clarity System
Administration (see page 31)
■
Configure the properties.
■
Add database, reports, and/or
background services (no application
service needed).
■
Start the database service.
■
Perform the installation tasks (including
packaging the EAR).
■
Start the remaining services.
Note: See J2EE vendor
5. Using the J2EE application server’s
documentation.
administration console, deploy the CA
Clarity PPM application (niku.ear). The
niku.ear was created in the CA Clarity PPM
home directory. When complete, verify the
application is accessible from an external
client machine using the Entry URL specified
in the CA Clarity System Administration
Application Properties. Do not continue until
the given Entry URL is verified and
functioning.
6. From CA Clarity System Administration:
■
Install Reports.
CA Clarity System
Administration (see page 31)
Install CA Clarity PPM with Generic J2EE (Multiple Servers)
Perform the following tasks to install CA Clarity PPM in a configuration with
services that are distributed across multiple servers that use BEA WebLogic or
IBM WebSphere and the Generic J2EE option.
Task
Reference
1. Set up all servers and install the
appropriate third-party software on each.
Set Up the Server (see page 26)
2. Designate one server to be the
administration server that will run CA
Clarity System Administration and the
J2EE application server’s administration
console.
Chapter 1: Installation 15
Before You Start
Task
Reference
3. From administration server’s command
prompt:
How to Install and Upgrade CA
Clarity PPM (see page 28)
■
Extract and execute install.jar.
■
When prompted to select a J2EE
vendor, select Generic J2EE.
4. From command prompt on all other
servers:
■
Extract and execute install.jar.
■
When prompted, select Generic J2EE
as the J2EE vendor.
How to Install and Upgrade CA
Clarity PPM (see page 28)
Note: See J2EE vendor
5. Using the J2EE application server’s
documentation.
administration console, deploy the CA
Clarity System Administration application
(nsa.ear). The nsa.ear is created in the CA
Clarity PPM home directory during the
install.jar installation.
6. Using CA Clarity System
Administration:
■
Configure properties for all servers.
■
Add Database (db), Reports (reports),
and/or background (bg) services (no
application services are needed).
■
Start the database service.
■
Perform the installation and upgrade
tasks, including packaging the EAR.
■
Start all remaining services.
7. Using the J2EE application server’s
administration console, deploy the CA
Clarity PPM application (niku.ear). The
niku.ear package is created in the CA
Clarity PPM home directory.
When complete, verify the application is
accessible from an external client machine
using the Entry URL specified in the CA
Clarity System Administration Application
Properties. Do not continue until the given
Entry URL is verified and functioning.
16 Installation Guide
CA Clarity System Administration
(see page 31)
Note: See J2EE vendor
documentation.
Before You Start
Task
Reference
8. From CA Clarity System Administration: CA Clarity System Administration
(see page 31)
■ Install Reports
How to Upgrade CA Clarity PPM
The following high-level steps provide generic guidelines on how to complete
the CA Clarity PPM upgrade process.
Note: See the Product Architecture Stack (PAS) Guide for more information on
the supported versions of all third-party software.
Use the following process to upgrade CA Clarity PPM:
1.
Confirm the configurations on the CA Clarity PPM Database Server (see
page 133).
2.
Upgrade the following third-party software (see page 28) (if necessary):
a.
Java SDK
b.
Application server (Apache Tomcat, BEA WebLogic, or IBM
WebSphere)
c.
Reports server (Business Objects)
Note: Actuate iServer can be used for existing customers running
Actuate who choose not to switch to Business Objects.
3.
4.
Upgrade CA Clarity PPM with:
■
Apache Tomcat (Single Server) (see page 18)
■
Apache Tomcat (Multiple Servers) (see page 19)
■
Generic J2EE (Single Server) (see page 21)
■
Generic J2EE (Multiple Servers) (see page 22)
Verify that all installation steps completed successfully.
See the Installation Overview page in CA Clarity System Administration
(NSA).
5.
(Optional) Change report server vendors (see page 219).
This step is for customers running Actuate iServer who want to switch to
Business Objects.
Chapter 1: Installation 17
Before You Start
6.
Review the NSA server admin.log for general errors or custom Studio
Query (NSQL) validation errors (see page 45).
7.
Start all services and verify the application is accessible from an external
client machine using the Entry URL specified in the CA Clarity System
Administration Application Properties.
Do not continue until the given Entry URL is verified and functioning.
8.
From the NSA Install and Upgrade page, install reports.
9.
Upgrade add-ins (see page 51).
10. Identify which views were upgraded automatically and which views need to
be manually upgraded.
Note: See the Studio Developer’s Guide for more information.
11. Configure portlets and portlet pages to expose or hide new functionality
after the install or upgrade.
Note: See the Studio Developer’s Guide for more information on
configuring portlets and pages.
12. Update rights assignments for users, groups or OBS instances with new or
updated security rights introduced in this release of CA Clarity PPM.
Upgrade Walkthroughs
Use the following sample scenarios to plan upgrades of existing CA Clarity PPM
installations.
Upgrade CA Clarity PPM with Apache Tomcat (Single Server)
Perform the following tasks to upgrade CA Clarity PPM installation in a
configuration that uses the Apache Tomcat J2EE application server. In this
example all services are running on a single server.
18 Installation Guide
Task
Reference
1. Stop all services except the database.
CA Clarity System
Administration (see
page 31)
2. Set up the server and upgrade third-party
software.
Set Up the Server (see
page 26)
3. From command prompt extract and execute
install.jar.
How to Install and
Upgrade CA Clarity PPM
(see page 28)
Before You Start
Task
Reference
4. Using CA Clarity System Administration:
CA Clarity System
Administration (see
page 31)
■
Configure the properties.
■
Perform the install and upgrade tasks.
■
Start all remaining services and verify the
application is accessible from an external
client machine using the Entry URL specified
in the CA Clarity System Administration
Application Properties. Do not continue until
the given Entry URL is verified and
functioning.
5. From CA Clarity System Administration:
■
Install Reports.
CA Clarity System
Administration (see
page 31)
Upgrade CA Clarity PPM with Apache Tomcat (Multiple Servers)
Perform the following tasks to upgrade CA Clarity PPM in a configuration that
uses the Apache Tomcat J2EE application server. Services are distributed
across multiple servers.
Task
Reference
1. Stop all services in the cluster (except
managed database services).
CA Clarity System
Administration (see
page 31)
2. Set up all servers and upgrade the appropriate
third-party software on each.
Set Up the Server (see
page 26)
3. From administration server’s command
prompt, extract and execute install.jar.
How to Install and
Upgrade CA Clarity PPM
(see page 28)
Chapter 1: Installation 19
Before You Start
Task
Reference
4. Using CA Clarity System Administration:
CA Clarity System
Administration (see
page 31)
■
Update the properties as needed for each
server in the cluster.
■
Ensure the database is accessible.
■
Perform the install and upgrade tasks.
■
Select Distribute All to update all servers.
Important! The Distribute All process is
normally used when upgrading other servers
in a cluster. However, when upgrading to CA
Clarity PPM from a version prior to 8.1.1, you
must upgrade each server individually in the
cluster. Use the following steps:
a. FTP or otherwise transfer the install.jar to
the other servers in your distributed
installation.
b. Stop the local Beacon service prior to
installing the new package.
c. Perform the install and upgrade tasks using
the install.jar on each server.
d. When you are finished, restart the Beacon
service.
■
When all servers have the upgrade applied,
return to CA Clarity System Administration
and verify that all distributed servers are
available.
■
Start all remaining services and verify the
application is accessible from an external
client machine using the Entry URL specified
in the CA Clarity System Administration
Application Properties. Do not continue until
the given Entry URL is verified and
functioning.
5. From CA Clarity System Administration:
■
20 Installation Guide
Install Reports.
CA Clarity System
Administration (see
page 31)
Before You Start
Upgrade CA Clarity PPM with Generic J2EE (Single Server)
Perform the following tasks to upgrade CA Clarity PPM in a configuration that
uses BEA WebLogic or IBM WebSphere with the Generic J2EE option. All
services are running on a single machine.
Task
Reference
1. Using the J2EE application server’s
administration console, stop the CA Clarity PPM
and CA Clarity System Administration
applications.
See J2EE vendor
documentation.
2. Stop all managed Clarity services except the
database.
CA Clarity System
Administration (see
page 31)
3. Set up the server and upgrade third-party
software.
"Set Up the Server" (see
page 26)
4. From the command prompt, extract and
execute install.jar.
How to Install and
Upgrade CA Clarity PPM
(see page 28)
5. Using the J2EE application server’s
administration console, re-deploy CA Clarity
System Administration application (nsa.ear). The
nsa.ear was created in the CA Clarity PPM home
directory during the install.jar installation.
See J2EE vendor
documentation.
6. Using CA Clarity System Administration:
CA Clarity System
Administration (see
page 31)
■
Configure properties as needed.
■
Perform the installation and upgrade steps
(including packaging the EAR).
■
Start all remaining services.
7. Using the J2EE application server's
administration console, re-deploy the CA Clarity
PPM application (niku.ear). The niku.ear package
is created in the CA Clarity PPM home directory.
When complete, verify the application is
accessible from an external client machine using
the Entry URL specified in the CA Clarity System
Administration Application Properties. Do not
continue until the given Entry URL is verified and
functioning.
See J2EE vendor
documentation.
8. From CA Clarity System Administration:
CA Clarity System
Administration (see
page 31)
■
Install Reports.
Chapter 1: Installation 21
Before You Start
Upgrade CA Clarity PPM with Generic J2EE (Multiple Servers)
Perform the following tasks to upgrade CA Clarity PPM in a configuration that
uses BEA WebLogic or IBM WebSphere with the Generic J2EE option. Services
are distributed across multiple servers.
Task
Reference
1. Using the vendor’s administration console,
stop CA Clarity PPM and CA Clarity System
Administration.
See J2EE vendor
documentation.
2. Stop all managed CA Clarity PPM services
except the database.
CA Clarity System
Administration (see
page 31)
3. Set up all servers and upgrade third-party
software on each.
"Set Up the Server" (see
page 26)
4. From administration server’s command
prompt extract and execute install.jar.
How to Install and
Upgrade <CAPPM (see
page 28)
See J2EE vendor
5. Using the J2EE application server’s
administration console, re-deploy the CA Clarity documentation.
System Administration application (nsa.ear). The
nsa.ear was created in the CA Clarity PPM home
directory during the install.jar installation.
6. Using CA Clarity System Administration:
■
Configure properties for all servers.
■
Perform the installation and upgrade tasks.
■
Select Distribute All to update all servers.
■
Start all other services.
7. Using the J2EE application server’s
administration console, re-deploy the CA Clarity
PPM application (niku.ear). The niku.ear
package is created in the CA Clarity PPM home
directory. When complete, verify the application
is accessible from an external client machine
using the Entry URL specified in the CA Clarity
System Administration Application Properties.
Do not continue until the given Entry URL is
verified and functioning.
See J2EE vendor
documentation.
8. From CA Clarity Administration:
CA Clarity System
Administration (see
page 31)yep
■
22 Installation Guide
CA Clarity System
Administration (see
page 31)
Install Reports.
Before You Start
Install into Application Server Clusters
One feature of BEA WebLogic and IBM WebSphere is their clustering capability.
CA Clarity PPM is deployed as a standard J2EE application and therefore can
participate in these application server clusters.
Clusters are most useful for large installations where several machines are
necessary to sustain adequate throughput for the user base. CA Clarity PPM
needs to know if it is distributed to more than one server. It does not care how
many servers are actively participating in the cluster; this is the responsibility
of the application server.
The CA Clarity PPM installer (install.jar) is executed only on the administration
server. All other application servers in the cluster can be left unmanaged.
To install into an application server cluster
1.
Install two or more J2EE application servers as a cluster.
2.
Install CA Clarity PPM.
3.
When deploying CA Clarity PPM (niku.ear), target the cluster instead of
individual servers.
4.
Start the application. BEA WebLogic or IBM WebSphere take care of
distributing the niku.ear package to all servers in the cluster.
System Architecture Diagrams
To better understand the system architecture possibilities, see the following
scenarios:
Small Architecture with Apache Tomcat
The small architecture with Apache Tomcat is relatively simple system
architecture using three managed servers.
Server A
Tomcat
- CA Clarity System Administration Service
- CA Clarity Application Service
Database
Server
Server B
Business
Objects
- Reports Service
- CA Clarity Background Service
- Database Service
CA Clarity PPM Cluster
Chapter 1: Installation 23
Before You Start
In this example:
One of each of the available services is configured on the servers. The
install.jar has been extracted and executed on all servers. The Beacon service
runs on all servers, including the database server, thus all servers are
managed. You can stop, start, and monitor the services in the CA Clarity PPM
cluster using CA Clarity System Administration.
Medium Architecture with IBM WebSphere
The medium architecture with IBM WebSphere is a larger system architecture
with clustered IBM WebSphere servers.
Server C1
WebSphere
Admin
- CA Clarity PPM
- CA Clarity Background (bg) Service
Server W1
WebSphere
- CA Clarity PPM
Server W2
WebSphere
- CA Clarity PPM
WebSphere Cluster
Server C2
Business
Objects
- Reports Service
- CA Clarity Background (bg) Service
Database
Server
- Database Service
CA Clarity PPM Cluster
In this example:
Server C1 runs the IBM WebSphere Deployment Manager software with CA
Clarity System Administration. C1 runs one of the two CA Clarity Background
(bg) services in the CA Clarity PPM cluster.
Server C2 runs the second CA Clarity Background (bg) and the Reports
services.
Servers W1 and W2 are unmanaged by CA Clarity PPM and are not part of the
CA Clarity PPM cluster. They do not have the install.jar installed and therefore
do not have the Beacon service running on the servers. W1 and W2 are
managed by the IBM WebSphere cluster. CA Clarity PPM (niku.ear) has been
distributed to both servers.
The database server runs the Database service and is unmanaged by CA
Clarity PPM. This is a common configuration since many organizations manage
databases in a DBA group apart from any one application.
24 Installation Guide
Before You Start
Large Architecture with BEA WebLogic
The large architecture with WebLogic is a very large system architecture with
clustered BEA WebLogic and Oracle servers.
Server W1
WebLogic
- CA Clarity PPM
Server W3
WebSphere
- CA Clarity PPM
Server C1
WebLogic
Admin
- CA Clarity System Administration
- CA Clarity Background (bg) Service
Server W2
WebLogic
- CA Clarity PPM
Server W4
WebLogic
- CA Clarity PPM
Server W5
WebLogic
- CA Clarity PPM
WebLogic Cluster
Server C2
- CA Clarity Background (bg) Service
Oracle
Cluster
Server C3
Business
Objects
- Database Service
- Reports Service
- Web Service
CA Clarity PPM Cluster
Chapter 1: Installation 25
Set Up the Server
In this example:
Server C1 runs the BEA WebLogic Admin server with CA Clarity System
Administration. C1 runs one of the two CA Clarity Background (bg) services in
the CA Clarity PPM cluster.
Server C2 runs the second CA Clarity Background (bg) service.
Server C3 runs the Web and the Reports services.
Servers W1 through W5 are unmanaged by CA Clarity PPM and are not part of
the CA Clarity PPM cluster. They do not have the install.jar installed and
therefore do not have the Beacon service running on the servers. W1 through
W5 are managed by the BEA WebLogic cluster. CA Clarity PPM (niku.ear) has
been distributed to all five servers.
The Oracle Cluster runs the Database service and is unmanaged by CA Clarity
PPM.
Set Up the Server
This section describes the operating system settings and third-party software
products that are required before you can install or upgrade CA Clarity PPM.
Set Up Unix User Accounts
All Unix servers in the cluster must have a user account that is dedicated to CA
Clarity PPM. You can give this user any name, however here we refer to the
user as the niku user.
To set up the Unix user account dedicated to CA Clarity PPM
1.
Open the niku.profile file.
2.
Export the JAVA_HOME environment variable in the niku.profile file:
JAVA_HOME=<JDK 1.5 home directory>
export JAVA_HOME
NLS_LANG=AMERICAN_AMERICA.UTF8
export NLS_LANG
26 Installation Guide
Set Up the Server
3.
(Optional but recommended) Add the following to the niku.profile file:
ORACLE_HOME=<Oracle home directory>
export ORACLE_HOME
NIKU_HOME=<clarity home directory>
export NIKU_HOME
PATH=$PATH:$JAVA_HOME/bin:$NIKU_HOME/bin:$ORACLE_HOME/bin
export PATH
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/bin
export LD_LIBRARY_PATH
4.
Save your changes and close the file.
Your changes are saved.
5.
Log out and then log back in again to verify your changes.
Set Windows System Variables
Add or update the following system variables in the Windows System Control
Panel (default values are provided below):
JAVA_HOME
Must point to the directory where the Java SDK is installed.
Default: D:\jdk1.5.0_11
NIKU_HOME
Must point to the directory where CA Clarity PPM is to be installed.
Default: D:\CA Clarity PPM
PATH
Must include the \bin directories within the Java home and CA Clarity PPM
home directories.
Default: %JAVA_HOME%\bin;%NIKU_HOME%\bin;%PATH%
Note: After modifying the system environment, open a new command
prompt (cmd.exe) before installing CA Clarity PPM.
On Windows NT servers with Oracle databases, in the registry key
HKEY_LOCAL_MACHINE/SOFTWARE/ORACLE/HOME0 set:
NLS_LANG ==> "AMERICAN_AMERICA.UTF8"
Install the Java 2 SDK
Depending on your specific environment, install or update the Java 2 SDK
software on all servers by referring to one of the listed sections.
Chapter 1: Installation 27
Set Up the Server
Install Third-party Software
Depending on the services the server will run, install the following third-party
software products:
Service(s)
Required Product
Database
service (db)
Oracle
Clarity System
Administrator
service (nsa),
Clarity
Application
service (app)
Apache Tomcat
Reporting
service
(reports)
Business Objects Report Server
Clarity
Background
service (bg),
Beacon service
Java SDK only
Microsoft SQL Server
BEA WebLogic
IBM WebSphere
How to Install and Upgrade CA Clarity PPM
This section describes how to install and upgrade CA Clarity PPM. Each server
in the cluster may or may not require that the install.jar be installed. If this is:
28 Installation Guide
■
A new installation, install the install.jar file on all servers in the cluster.
■
An upgrade from an earlier version of CA Clarity PPM, install the install.jar
file only on CA Clarity System Administration. During the upgrade process,
CA Clarity System Administration distributes the updated application to
other servers in the cluster.
Set Up the Server
Install the install.jar File
To install the install.jar file
1.
(Upgrades only) Stop all services except the database service:
Note: The database must be running during upgrades.
a.
Log in to CA Clarity System Administration.
The Overview page appears.
b.
Select All Services from the Home menu.
The All Services page appears.
c.
Select the CA Clarity Application (app), the CA Clarity Background
(bg), and reports (if managed) check boxes, and click Stop.
The services are stopped.
d.
Stop CA Clarity System Administration by issuing the following
command from a terminal:
niku stop nsa
The CA Clarity System Administration service is stopped.
2.
Open a command prompt, and go to the directory where the CA Clarity
PPM installer file is to be unpacked. Issue the following command:
mkdir temp
cd temp
3.
Insert the CA Clarity PPM Install DVD into the drive.
4.
From the directory, run the jar command to extract install.jar from the
DVD:
jar -xvf <dvd-drive>/install.jar
5.
Run the installation script:
For Unix:
sh install.sh
For Windows:
install.bat
6.
To complete the command-line installation (or upgrade), follow the
prompts. See the following list for installation property descriptions:
CA Clarity PPM Home Directory
The directory in which CA Clarity PPM is or will be installed. This
directory is created if it does not already exist.
Java SDK Home Directory
The Java SDK home directory (1.5.0_11 or higher).
Chapter 1: Installation 29
Set Up the Server
Beacon Multicast Address and Beacon Multicast Port
The multicast address used by the Beacon and CA Clarity System
Administration for service discovery. Each CA Clarity PPM cluster
should have a unique address and port. Each server in the cluster
must use these same settings.
Beacon Client Port
Defines the server port number used by the Beacon service.
Super User Command Prefix
(Unix only) The optional command prefix utility, such as sudo, to
execute root-level commands. An example situation where you might
implement a root-level command is 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’ super user name.
This may be used alone or with the super user command prefix. For
example, if used with sudo, you must specify the user to which sudo
rights are given here.
J2EE Server Vendor
Specify the J2EE server vendor:
■
Apache Tomcat [default]
■
Generic J2EE
Note: Supported generic J2EE vendors include IBM WebSphere and
BEA WebLogic.
Install Niku System Administration (NSA) Locally
(Apache Tomcat only) Enter one of the following:
■
If you are installing CA Clarity System Administration on this
server, enter "Y".
■
Otherwise, enter "N".
Tomcat Home Directory
(Apache Tomcat only) Defines the Apache Tomcat home directory.
NSA Web Port
(Apache Tomcat only) Defines the Web port number used by CA Clarity
System Administration. This value must be greater than "1024".
Note: At this point the process is not yet complete. Finish the installation or
upgrade using the CA Clarity System Administration application as described in
the following section.
30 Installation Guide
CA Clarity System Administration
CA Clarity System Administration
You will use CA Clarity System Administration to install and configure a CA
Clarity PPM cluster. CA Clarity System Administration communicates with other
servers in the cluster via each server’s Beacon. CA Clarity System
Administration automatically discovers any server that uses the same CA
Clarity System Administration password, multicast address, and multicast port.
The Beacon service must always be running on each server in the cluster. If it
is not running, CA Clarity System Administration cannot manage or monitor it.
This distributed solution allows you to do the following:
■
View and modify remote server properties
■
Stop, start, and check the status of all managed services in the cluster
■
Read remote server log files
■
Run remote server health checks
■
Distribute UI customizations
■
Distribute product upgrades and fix packs
There are three sections in the CA Clarity System Administration menu related
to installing and configuring CA Clarity PPM:
Home
This section displays a general page related to the cluster, servers,
services, and cluster-level health.
Installation
This section provides pages for cluster-wide CA Clarity PPM installation and
upgrade tasks including pre-upgrade database, reports, XDM, and postupgrade files installation).
Note: Pre- and post-upgrade files apply only during an upgrade
installation, and then only when pre- or post-upgrade scripts are present.
Distribution
This section allows you to distribute files to remote managed servers
registered in the CA Clarity PPM cluster.
Chapter 1: Installation 31
CA Clarity System Administration
niku Command—Command-line Interface
Some times you may need to start, stop, or manage services from the
command line, outside CA Clarity System Administration. For example, when
CA Clarity System Administration (nsa) or a Beacon service must be stopped
or started. You can use command-line utilities in scripts to automate a variety
of system administration tasks.
The following describes the command-line utility:
niku start|stop|status|add|clone|remove|deploy|destroy {all|service name} [-info] [-verbose] [-help]
start
Starts all or specified services.
Example:
niku start nsa
niku start nsa bg
stop
Stops all or specified services. You can also use this option at the same
time as the start option to stop and then restart one or more services.
Example:
niku stop beacon
niku stop start beacon
status
Displays the status of all or specified services.
Example:
niku status all
add
Activates all or specified services on a local machine.
clone
Creates copies of the CA Clarity Application (app) and CA Clarity
Background (bg) services on the same server as the original. Ports, service
names, and other properties of the service may be incremented to avoid
collision.
Example:
niku clone app
remove
Deactivates all or specified services on a local machine.
deploy
Disperses settings to servers in the cluster.
32 Installation Guide
CA Clarity System Administration
destroy
Removes and destroys a previously cloned service. Original services
cannot be destroyed.
{all|service name}
Indicates if the task is performed on all services or on a specified service.
The following lists available services:
nsa
CA Clarity System Administration (nsa) service.
db
Database service.
bg
CA Clarity Background service.
reports
Reports service.
-info
Displays informational messages.
-verbose
Displays detailed messages.
-help
Displays command help for all or a specified option.
Example:
niku -help
niku stop -help
Chapter 1: Installation 33
CA Clarity System Administration
CA Clarity System Administration Installation with BEA WebLogic or IBM
WebSphere
When using the Apache Tomcat J2EE application server, CA Clarity System
Administration is automatically installed and started by the installation script.
When using the Generic J2EE, CA Clarity System Administration is not
automatically installed or started when you use the Generic J2EE. The
installation script creates an nsa.ear file to install using the J2EE application
server’s administration console.
Note: See the J2EE vendor documentation for more information.
Note: If you implement a cluster of CA Clarity PPM servers, run CA Clarity
System Administration on the master server. From the master server, use CA
Clarity System Administration to distribute updated items and files to remote
servers.
When CA Clarity System Administration is successfully installed and started, it
can be accessed in the context root, //app.
The default CA Clarity System Administration URL is:
For IBM WebSphere:
http://<hostname>:8090/nsa/app
For BEA WebLogic:
http://<hostname>:7001/nsa/app
Accessing CA Clarity System Administration using Apache Tomcat is different
from accessing through Websphere and Weblogic. The CA Clarity System
Administration runs in its own server and port using the same context as the
normal app (/niku/app). When you use BEA WebLogic and IBM WebSphere, CA
Clarity System Administration runs on the server where you have installed it
and uses a different context (/nsa/app).
34 Installation Guide
CA Clarity System Administration
Install and Upgrade CA Clarity PPM from CA Clarity System Administration
After executing the install.jar for either fresh installations or upgrading an
existing installation, you will use the CA Clarity System Administration
application to finish the install or upgrade, and otherwise configure and
administer your CA Clarity PPM installation. This includes modifying server
properties, adding services, and using the Install and Upgrade wizard to run or
re-run installation tasks. To use CA Clarity System Administration, log in using
the CA Clarity System Administration password you selected.
■
(Apache Tomcat)
http://<hostname>:8090/niku/app
■
(IBM WebSphere)
http://<hostname>:8090/nsa/app
■
(BEA WebLogic)
http://<hostname>:7001/nsa/app
How to Install CA Clarity PPM from CA Clarity System Administration
Use the following process to install CA Clarity PPM from CA Clarity
System Administration
1.
Configure and modify the local CA Clarity application server (see page 36)
and any remote servers in the cluster.
2.
Add services to the cluster (see page 36).
3.
Start the database and reports service (see page 37).
4.
Run the Install and Upgrade wizard.
Chapter 1: Installation 35
CA Clarity System Administration
Configure and Modify the Local CA Clarity Application Server Properties
After logging in to CA Clarity System Administration, modify the properties of
the local CA Clarity System Administration server and any remote servers in
the cluster. Do this on the Server: Properties page. To view this page, click
Servers from the Home menu, and click the Properties icon for the server you
want to modify.
The Servers page lists only servers that can be accessed in the cluster. This
includes the local CA Clarity System Administration application server and any
other servers with active Beacons in the cluster. For CA Clarity System
Administration to discover a server’s Beacon, the server must have the same
multicast address and port, the same NSA password, and the Beacon service
must be started. These values are set when install.jar is executed on each
server. If a server is missing from the list, verify in the properties.xml file on
the server to make sure that the multicast address and port number are
correct and that the Beacon service is running.
Each server in the cluster has its own properties which you must modify
independently (properties are not shared between servers).
Click the Server: Properties page’s tabs to display property pages, which are
organized by category, and to modify the server’s properties.
Add Services to the Cluster
After configuring all server properties, add services to the cluster, as needed.
The All Services page lists registered services already added to the cluster.
You can also view the services installed on individual servers by clicking the
Services tab from the Servers page.
Important! Once you have added the services, do not start them unless
otherwise instructed. You will start all services later in the installation process.
To add services to the cluster from CA Clarity System Administration
1.
Log in to CA Clarity System Administration, and select All Services from
the Home menu.
The All Services page appears. A list of all services registered in the cluster
displays. If this is a new installation, this list is empty.
2.
Click Add.
The Select Services page appears.
3.
Check the box next to the service you want to add, then click Add.
The service is added to the cluster.
36 Installation Guide
CA Clarity System Administration
Unmanaged Services
Unmanaged services are managed by an entity outside the CA Clarity PPM
cluster. The Database (db), Reports (reports), and CA Clarity Application (app)
services can all be left unmanaged. Apache Tomcat-based application services
are always managed. BEA WebLogic and IBM WebSphere services are always
unmanaged. When using an unmanaged service, the CA Clarity PPM cluster
cares only that the service is up and accessible.
A shared database server is typically managed by a company’s database
group. The database group must ensure that the database is running,
accessible over the network, and otherwise correctly configured.
When a service is unmanaged:
■
You will not add it to CA Clarity System Administration.
■
You will not able to start, stop, or otherwise manage it with CA Clarity
System Administration. It will not show up in the service list.
Start the Database Service
Before running the Install and Upgrade wizard, you must ensure that the
Database service is started. If the service is unmanaged, verify that it is
running and available on the network to CA Clarity System Administration. If
the service is managed, start it.
To start the Database service (if managed)
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Check the box next to the Database service and click Start.
A status window appears displaying the service or services you selected.
When the service has started, the window closes and the All Services page
shows the Database service status as "Started".
Pre-upgrade Scripts
During an upgrade, if pre-upgrade scripts exist for the current release you
must execute the pre-upgrade task prior to continuing. These are many
application upgrade scripts that must execute prior to the normal installation
process.
Chapter 1: Installation 37
CA Clarity System Administration
Database Install
The Database step takes up the bulk of the installation. This includes creating
the database schema, installing all of the seed data required by CA Clarity
PPM, and optimization steps such as analyzing the database (Oracle only).
XDM Install (Extensible Data Model)
The XDM step is the equivalent of issuing the "nikuadmin xdm install"
command from the command line. Installing XDM reads the current XDM
metadata and generates new files and resources.
After running this step, you must distribute the XDM to other servers in the
cluster.
To distribute XDM
Log in to CA Clarity System Administration and select Distribute XDM or
Distribute All from the Distribution menu.
Post-Upgrade Scripts
During an upgrade, if post-upgrade scripts exist for the current release, the
Post-Upgrade task must be executed prior to finishing the installation. These
are any application upgrade scripts that must execute after the normal
installation process.
J2EE .ear File Packaging (Generic J2EE only)
This installation task applies only when using the Generic J2EE vendor option.
You can create the J2EE .ear file based on the new or updated files in the CA
Clarity PPM installation. You must package the niku.ear after new CA Clarity
PPM installations or upgrades, service pack installations, or after any other file
changes.
It is not required to repackage the .ear file after properties changes in the CA
Clarity System Administrator. These changes do not qualify as file changes
and the properties are not stored in the .ear file itself. The application .ear file
(niku.ear) is machine-agnostic. This is different from the System Administrator
.ear file (nsa.ear), which is machine-specific and can only be deployed on the
same server where it was packaged. This is because the NSA application must
access and control the CA Clarity PPM home directory on the administration
server.
38 Installation Guide
CA Clarity System Administration
Once the .ear file is packaged, you must install or update the Clarity J2EE
application in the J2EE application server’s administration console using this
new niku.ear (located in the Clarity Home directory on the CA Clarity System
Administration server).
Note: See your J2EE vendor documentation for more information about
updating or installing J2EE applications.
To package the niku.ear from CA Clarity System Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Install and Upgrade from the Installation menu.
The Install and Upgrade page appears.
3.
Click Package Application EAR from the content menu (under Package
Tasks).
The Install and Upgrade: Package EAR page appears.
4.
Click Create Package.
A Status window appears and displays the status until the EAR file is
created in the Clarity home directory:
<clarity home>/niku.ear
Chapter 1: Installation 39
CA Clarity System Administration
Distribute Files
CA Clarity System Administration provides a mechanism to distribute and
replicate any file changes from the System Administration server to other
nodes in the cluster. This is required for new installations, upgrade
installations, fix packs, or after any other file changes.
During distribution, only updated files are distributed to each server. Any
remote files or directories not found on the local CA Clarity application server
are removed. The distribution process replicates the CA Clarity PPM home
directory on the local CA Clarity application server with the CA Clarity PPM
home directories on each remote server.
Modifying server properties in CA Clarity System Administration does not
qualify as a file change, therefore you do not need to repackage the EAR after
changing server properties.
To distribute all updated files to all servers from CA Clarity System
Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Distribute All from the Distribution menu.
The Distribute All page appears.
3.
Select the servers you want to distribute and click Distribute.
A progress line for each server displays. When the process completes, the
progress window closes and the distribution page shows the update
distribution history for each server.
Important! The preceding procedure is normally used when upgrading other
servers in the cluster. However, when upgrading to CA Clarity PPM from a
version prior to 8.1.1, you must upgrade each server individually in the
cluster. Do not use the distribution mechanism. Subsequent upgrades applied
to CA Clarity PPM can follow the normal CA Clarity System Administration
distribution procedure described. If you are upgrading from 8.1.1, you can use
the standard Distribution mechanism.
40 Installation Guide
CA Clarity System Administration
Start All Services from CA Clarity System Administration
To start all remaining managed services from CA Clarity System
Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Select the Check All icon to select all services, and click Start.
The services are started.
Deploy CA Clarity PPM with Generic J2EE
After you install and package CA Clarity PPM (niku.ear), the file must be
installed on the J2EE application server. See your J2EE vendor documentation
for instructions.
When CA Clarity PPM is installed and started, it can be accessed in the context
root
(/niku/app). For example, the default URL when using IBM WebSphere is
http://<hostname>:9080/niku/app.
Unlike CA Clarity System Administration, CA Clarity PPM contains several
standard requirements for the J2EE container, including proper data source
and system properties setup. Prior to installing niku.ear on the J2EE
application server, make sure that the server is configured according to the
third-party software installation instructions.
Test the Application
Before continuing, it is important to verify that the CA Clarity PPM application
is accessible from a browser connecting through the configured Entry URL.
The Entry URL points to the load balancer (for multiple application servers) or
the application server (single-server installs) and is configured in the
Application Properties section.
Open a browser on a client machine other than the server itself, preferably
outside the server’s subnet, using the Entry URL. At this point all services
apart from the Reports Server should be functional, and you should be able to
log in to CA Clarity PPM.
Chapter 1: Installation 41
CA Clarity System Administration
Reports Install
After you verify the CA Clarity PPM application is functioning, the Reports
service can be started (if it is not already running), and the Clarity BO
universe and stock reports can be deployed into it, all from the CA Clarity PPM
administrator application.
Included in the CA Clarity PPM installation is a Business Intelligence
Application Resource (BIAR) file, located under the <clarity>
home>/reporting/bo directory. CA Clarity PPM uses a BIAR file to import the
BO Universe for Clarity and all CA Clarity PPM stock reports into the Business
Objects XI server. This occurs during the Reports Install step, and the process
overwrites the existing Clarity BO Universe and stock reports, if any are
previously installed.
For more information on BIAR files, see the Business Objects user
documentation.
To deploy the Clarity BIAR package to the Business Objects XI from CA
Clarity System Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Install and Upgrade from the Installation menu.
The Install and Upgrade page appears.
3.
Click Reports Install under the Reporting section in the content menu.
The Install and Upgrade: Reports page appears.
4.
Click the Install (or Re-install) button to deploy the BIAR file to the
reporting server.
Verify the Installation
At any point during or after installation, you can run a health check on any of
the servers in the cluster. The health check generates a report for each server
and verifies various aspects of the installation. The resulting page contains a
list of categorized line items, each with an associated status. Examples of line
items are the testing of ports, database parameters, and third party software
product installation.
42 Installation Guide
CA Clarity System Administration
Run a Cluster-level Health Check
You can run a cluster-level health check across all servers from CA Clarity
System Administration’s Overview page. When you do this, a status window
appears and displays a process line for each server in the cluster. When all
processes are complete, the window closes and the Overview page is updated
to display any errors or warnings found during the health check. The Cluster
Health Overview section of the page shows the health overview report,
displaying only those line items with errors or warnings. To see the full report
for a given server, click the error or warning message link.
To run a cluster-level health check across all servers from CA Clarity
System Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Check the box next to each server you want to include in the report, and
click Run Health Check.
The cluster-level health check runs.
View Log Files Using CA Clarity System Administration
CA Clarity System Administration provides a mechanism to view log file
content in the browser for any server in the CA Clarity PPM cluster.
To view log files using CA Clarity System Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Servers from the Home menu.
The Servers page appears.
3.
Select the name of the server for which you want to view log files.
The Server: Properties page appears.
4.
Click the Logs tab.
The Server: Logs page appears.
5.
Do the following, and click Go or click Refresh:
■
Select the desired log file at the Log File field.
■
Select the desired segment size at the Max Size field.
The log files display.
Chapter 1: Installation 43
Multiple Installations on One Server
Multiple Installations on One Server
There may be cases when two installations of CA Clarity PPM must be installed
on the same server. This is not the same as running a second instance of a
service in the same installation. Installing CA Clarity PPM twice on a server
means just that: you are installing it in two different locations, using two
different databases, for two end-user populations. This is never recommended
for production systems; only for pre-production test systems, multiple
sandbox installations, and so on.
Unix Environments
On Unix servers, each CA Clarity PPM installation should be done with a
different Unix user account. This ensures that environments and ownership of
files and processes do not collide between installations. For example, if a Unix
account called "CA Clarity PPM" is created to install the first CA Clarity PPM
instance, a second Unix account called "CA Clarity PPM2" is created to install
and operate the second CA Clarity PPM instance.
Windows Environments
You can have multiple CA Clarity PPM installations on a Windows server, but
you must take extra care to choose unique Service Name values for all CA
Clarity PPM services. This applies to the CA Clarity Application (app), CA
Clarity System Administration (nsa), CA Clarity Background (bg), and Beacon
services. The Service Name property for each will determine the Windows
Service name, and as such must be unique across all CA Clarity PPM
installations on a single box. You can set these Service Name values in CA
Clarity System Administration on the application Service: Properties pages.
If you do not choose unique Service Name properties, one installation on the
machine will overwrite the Windows services for the other.
44 Installation Guide
Verify NSQL Queries
Verify NSQL Queries
During the upgrade process for CA Clarity PPM, the NSQL Validator script is
run automatically to check your queries. The results of the NSQL validator are
written to the admin.log.
You must look for the following information in the log:
■
The name of the query.
■
The ID of the query from CMN_NSQL_QUERIES that failed validation
■
The NSQL text along with the error from the database as to why it failed
validation.
The following is an example of the log output. The parameters shown in bold
provide useful information. The table that follows the example describes these
parameters in detail.
NSQL Log Output Example
Validating 110 NSQL grid/graph queries...
5/10/07 4:57 PM (admin) Invalid NSQL Program Benefits and Costs with id=5070002:
5/10/07 4:57 PM (admin) NSQL Syntax exception: NSQL_SYNTAX_ERROR_DB_ERROR, Info:
[Clarity][Oracle JDBC Driver][Oracle]ORA-00904: "PCV"."BDGT_ROI": invalid identifier
...,
The following table describes some of the parameters from the NSQL
validation:
Parameter
Description
Program Benefits and
Costs
Identifies the name of the query that failed
validation. You can use the name to find the
query in Studio to update it.
id=5070002
Identifies the ID of the query that failed
validation. You can use the ID to search for the
NSQL query in the database and manipulate the
NSQL.
Chapter 1: Installation 45
Identify and Manually Upgrade Views
Parameter
Description
Identifies the error from the database and
NSQL Syntax exception:
NSQL_SYNTAX_ERROR_DB describes why the query failed validation.
_ERROR, Info:
[Clarity][Oracle JDBC
Driver][Oracle]ORA00904:
"PCV"."BDGT_ROI": invalid
identifier
Identify and Manually Upgrade Views
After upgrading CA Clarity PPM, you can use the Views list page in Studio to
manage all system views across all objects and their partitions.
Note: See the Studio Developer's Guide for more information about this list
page.
During upgrade, the system preserves all view configurations. Accordingly, if a
view is configured or if the view’s object is partitioned, the system will not
upgrade that view. You can use the Views page to determine which views were
not upgraded automatically and may require manual upgrading. You can also
use the Last Version column on this page to tell if there has been any changes
to the out-of-the-box views in the specific CA Clarity PPM release to which you
upgraded. For example, if this column displays the value "8.1 Base" for a
particular view, it means that the view was changed in the CA Clarity PPM 8.1
release.
The Upgraded column for each view displays check marks to indicate the view
was upgraded. If a view does not display a check mark, it was not upgraded
because it was configured.
To identify the views that were not upgraded and manually upgrade
them
1.
Select Views from the CA Clarity Studio menu.
The Views list page appears.
2.
46 Installation Guide
Look at the Latest Upgraded Version information at the bottom left of the
list page to identify the last upgrade version that was applied to CA Clarity
PPM. Scroll down to the bottom of the page, if necessary.
Identify and Manually Upgrade Views
3.
Filter the views list by:
Last Version
The CA Clarity PPM version you identified. Enter the version, one at a
time, in the Last Version field.
Partition
Browse and select System as the partition.
4.
Do one of the following to manually upgrade a view:
■
Add the new attributes to the view using Studio.
Note: See the Studio Developer's Guide for more information on how
to add new attributes to a view.
■
Select the check box next to the view and click Restore Defaults. This
resets the view back to the system default and loses any
configurations that you performed on that view. This also updates the
Last Restored column for the view with the current date. As a CA
Clarity PPM administrator, you will need to repeat this step for every
view that was not upgraded. After restoring defaults, add the new
attributes to the views using Studio.
5.
Look at the Personalized column for a particular view. A check mark in the
column indicates that the view was personalized (that is, the user had
changed the filter or list for that view). If the personalized view was
upgraded (manually or by the system), you must publish the view to make
the changes visible to the users with the personalized view.
6.
Select the check box next to the view and click Publish.
This removes all personalizations for the view and also removes the check
mark from the Personalized column for that view.
Restore Defaults Based on Partitions
When you restore defaults for a property, filter, or list view, in a particular
partition model, the attribute settings cascade from the ancestor partitions to
the descendent partitions based on the following rules:
If restoring defaults for a view at the system partition:
■
All views are reset to the out-of the-box system attribute settings.
■
The attribute settings cascade from the system partition to the first
descendent partition that has a configured view.
■
If no descendent view is configured, attribute settings cascade to the
lowest descendent node in the partition model.
Chapter 1: Installation 47
Identify and Manually Upgrade Views
If restoring defaults for a view at a descendent partition:
48 Installation Guide
■
Views are reset based on the first ancestor partition that has a configured
view. If no ancestor partition has a configured view, attributes settings are
applied based on the system partition.
■
The attribute settings cascade from the descendent partition (at which
"restore default" was applied) to the first sub-descendent partition that
has a configured view.
■
If no view is configured at a sub-descendent partition, attribute settings
cascade to the lowest descendent node in the partition model.
Identify and Manually Upgrade Views
We highly recommend that you restore defaults for your views from the topdown in your partition model.
The following diagram shows how out-of-the-box attribute settings are applied
from the system partition level down to the descendent levels in a partition
model:
Chapter 1: Installation 49
Identify and Manually Upgrade Views
The following diagram shows how out-of-the-box attribute settings are applied
from a descendent partition level down to the sub-descendent levels in a
partition model:
50 Installation Guide
Add-In Installations
Add-In Installations
How to Install Add-Ins
This section describes the steps required to install add-ins from a .jar file so
that the content is available to users. You must complete these steps on your
CA Clarity application server. Before installing an add-in, make sure you have
the required CA Clarity PPM version installed.
Important! If you are upgrading from a previous version of CA Clarity PPM,
you must reinstall the add-in that is released for the version of CA Clarity PPM
to which you are upgrading. Before reinstalling the add-in, make sure that you
do the following for all active process instances that are being updated by the
add-in:
■
Cancel the process instance.
■
Delete the process instance.
■
Put the process definition in Draft mode.
Note: See the Administration Guide for more information on how to manage
processes and process instances.
The following process details how to install add-ins on your CA Clarity PPM
server:
1.
Download the .iso image file (see page 51).
2.
Extract the .jar file (see page 52).
3.
Stop the services (see page 53).
4.
Install the add-in (see page 55).
5.
Start the services (see page 55).
6.
(Existing add-in installations only) Apply the add-in.
Download the .iso Image File
All add-ins are delivered as .iso image files. The .iso image file includes a .jar
file. The .jar file contains the files needed to install the add-in. The installer
updates the existing CA Clarity PPM installation with the newly downloaded
files.
To download the .iso image file, go to support.ca.com and download the .iso
image to your machine or an accessible network location.
Chapter 1: Installation 51
Add-In Installations
Mount .iso Image Files Using Unix
On many UNIX platforms, you can use the .iso image file directly through the
DVD emulation provided with some of the platform DVD device drivers. For
Linux systems, you can use the .iso image by mounting it on the .iso file
system driver.
To mount the .iso image file using Unix, open a command prompt and issue a
command similar to the following:
mount -t .iso9660 -o ro,loop,dev filename.iso /mnt/CAcd
This command mounts the .iso image file (filename.iso) at the /mnt/CAcd
mount point, thereby allowing DVD contents to be accessible through the
/mnt/CAcd directory.
Write .iso Image Files to DVDs
The .iso image files are DVD images containing exact binary copies of the
original DVDs. Depending on the platform, you can use these files to create CA
product DVDs, or you can use them in their original format.
You must have a DVD writer and mastering software to recreate CA product
DVDs. Most DVD authoring applications accept a pre-formatted .iso image file
and write the contents of the ISO image to a DVD. This step generates an
exact copy of the CA product DVD.
Note: Refer to the documentation that accompanies your DVD writer for more
information on how to write .iso image files to DVDs.
Note: Neither Windows nor WinZip recognizes the .iso file format. To access
the installation files in Windows, you must create a DVD with the .iso image
file using a DVD Writer, or use a third-party software program like IsoBuster
or Undisker as an .iso image file extractor. If you prefer not to create a DVD,
you can use an .iso extractor program to extract .iso image files to a local file
system.
Extract the .jar File
Once you can access the .iso image file, extract the .jar file to a temporary
directory location on the CA Clarity application server where you will be
completing the installation process.
The .jar file includes the following files:
install.sh
The UNIX installation script.
52 Installation Guide
Add-In Installations
install.bat
The Windows installation script.
install.xml
The Ant installation script.
package
The directory of updated files.
tools
The directory of supporting files.
To extract the .jar file to a temporary directory location
1.
Open a command prompt, and issue the following command:
For Windows:
jar -xvf <filename>
For Unix:
jar -xvf <filename>
These commands extract the contents of the .jar file to the same location
where the .jar file resides.
2.
For a UNIX environment, issue the following command:
chmod +x install.sh
This grants execution privileges for the install script.
Stop the Services
You must stop the CA Clarity Application (app) and CA Clarity Background (bg)
services prior to applying add-ins, and then re-start the services once you
have applied the add-in to CA Clarity PPM. Do this from CA Clarity System
Administration.
The following sections explain how to stop the services in different server
configurations.
Important! If the CA Clarity System Administration (nsa), the Database (db),
the Beacon, and the Reports (reports) services are deployed on the server, do
not stop them.
Chapter 1: Installation 53
Add-In Installations
Stop Services Using Apache Tomcat
Do the following to stop the CA Clarity Application (app) service and CA Clarity
Background (bg) services in a configuration that uses the Apache Tomcat as
your CA Clarity application server.
To stop the services
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Select the CA Clarity Application (app) and the CA Clarity Background (bg)
service check boxes, and click Stop.
The services are stopped.
Stop Services Using BEA WebLogic/IBM WebSphere
Do the following to stop the app and bg services in a configuration that uses
the BEA WebLogic or IBM WebSphere as your CA Clarity application server.
To stop the services
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Select the CA Clarity Application (app) and the CA Clarity Background (bg)
check box, and click Stop.
The services are stopped.
4.
Stop CA Clarity System Administration and applications using the
application server’s administration console.
Note: See the J2EE vendor documentation for details.
54 Installation Guide
Add-In Installations
Install the Add-In
The following procedure installs the updates to objects, reports, and the
database.
Important! Back up your CA Clarity PPM installation prior to installing this
add-in so that you can restore the application to the prior version if necessary.
Once you have installed the add-in, you cannot uninstall it.
To install the add-in
1.
Open a command prompt window at the directory location where you
extracted the .jar files, and issue the following command:
install
2.
Press Enter.
The installation process begins.
3.
Follow the on-screen directions to complete the add-in installation.
Start the Services
You must stop the CA Clarity Application (app) and CA Clarity Background (bg)
services prior to applying the add-in, and then restart them after applying the
add-in. Do this from CA Clarity System Administration.
The following sections explain how to start the services in different server
configurations.
Start Services Using Apache Tomcat (Single Server)
Do the following to start the CA Clarity Application (app) and CA Clarity
Background (bg) services in a configuration that uses the Apache Tomcat as
your CA Clarity application server, where all services are running on a single
server.
To start the services
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Select the CA Clarity Application (app) and the CA Clarity Background (bg)
service check boxes, and click Start.
The services are started.
Chapter 1: Installation 55
Add-In Installations
Start Services Using Apache Tomcat (Multiple Servers)
Do the following to start the CA Clarity Application (app) and CA Clarity
Background (bg) services in a configuration that uses the Apache Tomcat as
your CA Clarity application server, where all services are distributed across
multiple servers.
To start the services
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Click All Services from the Home menu.
The All Services page appears.
3.
Shut down any remote app and bg services.
4.
Click Distribute All from the Distribution menu.
The Distribute All page appears.
5.
Select remote servers and click Distribute and wait until the distribution is
complete.
6.
Select All Services from the Home menu.
The All Services page appears.
7.
Select the CA Clarity Application (app) and CA Clarity Background (bg)
service check boxes, and click Start.
The services are started.
56 Installation Guide
Add-In Installations
Start Services Using BEA WebLogic/IBM WebSphere
Do the following to start the CA Clarity Application (app) and CA Clarity
Background (bg) services in a configuration that uses BEA WebLogic or IBM
WebSphere as your CA Clarity application server.
To start the services
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Install and Upgrade from the Installation menu.
The Install and Upgrade: Database page appears.
3.
Click Package Application Ear from the content menu.
The Install and Upgrade: Package EAR page appears.
4.
Click Create Package.
The application is packaged, which creates the niku.ear.
5.
Using the J2EE application server’s administration console, deploy the
(niku.ear) package.
Apply the Add-In
If you already have the add-in installed and you are upgrading to a current
add-in version, you must choose which new or modified items you want to
apply to the add-in and apply them.
The Add-In Details page in Studio lists all of the items—portlets, pages,
queries, lookups, tabs, and reports—that are included with the add-in. Use this
page to apply these items.
When you upgrade to the current add-in version, only those items that are
new or modified are selected by default. You can select or clear the items that
you want to apply.
New items are those that are new to this add-in version or that you did not
install from a previous version; they are listed with a status of “Not Installed”.
Chapter 1: Installation 57
Add-In Installations
Modified items are those that have been applied to CA Clarity PPM and a
change to the item is included in the current version; they are listed with a
status of “Needs Update”. You can select or clear the items that you want to
apply.
Important! Before applying modified items, make sure your existing items
have not been configured. If they have, you may not want to apply these
items. Applying modified items to existing items overwrites their
configurations.
To apply add-in items
1.
Log in to CA Clarity PPM, and open the Administration Tool.
The Administration Home page appears.
2.
Select Add-Ins from the CA Clarity Studio menu.
The Add-Ins page appears.
3.
Click the name of the add-in from which you want to apply items.
The Add-In Details page appears.
4.
Review each selected item and accept only those changes you want. Only
those items with selected check boxes are updated, click Apply.
Note: If a selected item has dependencies on other items, the
dependencies will also get updated.
A list of updated items displays in the Confirm Add-In Update or Install
page.
5.
Do one of the following:
■
Click Yes to update or install the items.
The add-in items are applied to CA Clarity PPM.
Note: If a user has previously changed an item listed on the Confirm
Add-In Update or Install page, then you will need to publish the item
before users will see the change.
Note: See the Studio Developer's Guide for more information on how
to publish configured items, such as portlets, pages, and views.
■
Click No to cancel the process.
The Add-In Details page appears.
58 Installation Guide
Chapter 2: System Administration
This section contains the following topics:
CA Clarity PPM Connectivity (see page 59)
General Administration (see page 60)
Security (see page 72)
Application Servers (see page 95)
Clustering (see page 99)
Performance (see page 106)
Document Indexing, Searching, and Storage (see page 113)
Datamart (see page 116)
UI Themes (see page 118)
CA Clarity PPM Connectivity
The following system components must work together for CA Clarity PPM to
work correctly:
SQL Server Implementation
Chapter 2: System Administration 59
General Administration
Oracle Implementation
General Administration
Refer to the following topics for information on general CA Clarity PPM
administration.
Open Server Ports
CA Clarity PPM requires several open network ports for client-to-server and
server-to-server communications. Often, ports are closed by default for
security reasons. Any ports you selected during installation or configuration
must be open.
Open the necessary ports using the documentation provided for your operating
system. The following lists the default value, type, and description for each
port used in CA Clarity PPM.
80 or 443
Defines the HTTP or HTTPS port number used by the default CA Clarity
Application (app) service.
Type: Client to the CA Clarity application server
60 Installation Guide
General Administration
8090
(Apache Tomcat application server only) Defines the HTTP port number
used by the default CA Clarity System Administration (nsa) service.
Type: Client to the CA Clarity application server
1433 (SQL) or 1521 (Oracle)
(Database server only) Defines the JDBC port number used to
communicate with the database.
Type: Server to Database Server
23791
(Apache Tomcat application server only) Defines the RMI port number
used by CA Clarity Application (app) service.
Type: Server to CA Clarity application server
23792
(Apache Tomcat application server only) Defines the RMI port number
used by CA Clarity System Administration (nsa) service.
Type: Server to CA Clarity application server
9090
Defines the Multicast port number used by CA Clarity System
Administration (nsa) service.
Type: Server to CA Clarity application server
9091
Defines the RMI port number used by Beacon service.
Type: Server to Server
Ephemeral Ports
All operating systems specify an ephemeral (short-lived) port range by
default. The traditional BSD range is 1024 through 4999 though the IANA
suggests 49152 to 65535. It varies between operating systems, and it is
possible to disable. CA Clarity PPM does not care what the range is, but it
does require a range be enabled. This is primarily for multicasting to
function.
Type: Server to Server
Chapter 2: System Administration 61
General Administration
When to Use CA Clarity System Administration
You can use CA Clarity System Administration to install, upgrade, configure,
monitor, and check the health of a CA Clarity PPM cluster.
Whenever you deploy an install.jar file to a server, a beacon process runs to
automatically discover the CA Clarity application server. This enables remote,
distributed management and allows you to do the following:
■
View and modify remote server properties
■
Stop, start, and check the status of services in the cluster
■
Read remote server log files
■
Run remote server health checks
■
Distribute user interface customizations and product updates such as
patches, fixes, and upgrades
You should always have the Beacon service running on each server in the
cluster; if not, the server will not be accessible to CA Clarity System
Administration.
CA Clarity System Administration has three menus from which to administrate:
Home
Displays a general page related to the cluster, servers, services, and
cluster-level health.
Installation
Provides a wizard for cluster-wide CA Clarity PPM installation and upgrade
tasks.
Distribution
Allows you to distribute the following types of files from the CA Clarity
application server to remote servers.
You can use CA Clarity System Administration to modify properties for the
local CA Clarity server or any remote server.
62 Installation Guide
General Administration
System Administration Terms
Refer to the following terms during CA Clarity PPM installation:
Install
The process of extracting a new install.jar file onto a system that does not
already have CA Clarity PPM installed on it. Installation also includes
setting up properties and services and then executing and installing the
database schema into the cluster, installing the initial XDM configuration,
deploying Reports files to the Reporting server, and creating the search
index collections. The installation process starts when you execute a
command from the command line; everything else is performed using CA
Clarity System Administration. Report installation is a separate task from
the normal installation task and should be done manually.
Upgrade
This involves many of the same tasks as installation with the addition of
distributing the updated files to all servers in the cluster and executing
both pre- and post-upgrade tasks. When you upgrade, however, most of
the installation tasks are executing automatically as part of the install.jar
execution. Pre-upgrade, database upgrade, XDM upgrade, and postupgrade tasks are all executed automatically one after the other when
install.jar is executed. The behavior is identical to service pack installation.
Configure
The ongoing process wherein you manage a CA Clarity PPM cluster. How
you configure the cluster depends upon the size of your user base and
budget, desired performance and cluster availability (for example, failover), and the kind of workload the cluster supports. In an ideal world,
you would configure the cluster once during installation and never
configure it again. However, configuring CA Clarity PPM is an ongoing
process because all of the factors inevitably change over time.
There are two types of configurations:
Properties
An example of configuring properties is to use CA Clarity System
Administration to change the application server’s database password.
However, the following points are important to note about property
changes:
■
Services are not automatically re-deployed after you change a
property.
■
Services are not hot-deployable. After you change a property, you
must stop the service and then restart it to ensure that the
properties take effect. Services are automatically deployed on
startup after either a property change or when generated startup
scripts change.
Chapter 2: System Administration 63
General Administration
Services
Configuring services involves adding services to the cluster from
another server in the cluster, and then starting, stopping, manually
deploying, or removing them.
For example, after you add an CA Clarity Application (app) service to
the cluster from server A, you can later decide to add a new server B
and then move the CA Clarity Application (app) service from server A
to B. This is done by stopping and removing the CA Clarity Application
(app) service on server A, and adding and starting the CA Clarity
Application (app) service from server B.
Troubleshooting
The ongoing task of resolving problems when problems arise. There are
two significant CA Clarity System Administration tools you can use to
troubleshoot:
64 Installation Guide
■
The Health Report
■
Log files
General Administration
Run Health Reports
You can run a health report to validate your CA Clarity PPM installation. Any
errors in this report will most likely reveal the solution to known or
undiscovered problems in the system.
The CA Clarity System Administration’s Overview page contains a health
overview report that covers multiple servers in the cluster. This report shows
only errors or warnings for selected servers.
Each server has its own health report that is accessible from the server’s
Server: Health Report page. Unlike the health overview report, the health
report shows all health check results: success, warning, or error.
Green Status indicator indicates that the item has valid status.
Red Status indicator indicates that the item is not installed, improperly
installed, or the status is unknown because it is a third-party system.
Health check results are updated only when you run the report. The results are
not dynamically updated. You should run the report after any significant
system changes.
To run a health report
1.
Log in to the CA Clarity System Administration, and select Servers from
the Home menu.
The Servers page appears.
2.
Click the desired server.
The Server: Properties page appears.
3.
Click the Health Report tab.
4.
Click Run.
The health report appears.
5.
If the health report was run before, the previous results will first display.
Click Run again to update the health report with the latest data.
Chapter 2: System Administration 65
General Administration
Log Files
You can check log files when installation issues arise, you can check the log
files to find an explanation for the problem. By default, CA Clarity PPM only
writes error messages to the log files.
CA Technical Support may ask you to configure the system to display detailed
debugging messages to help troubleshoot the problem.
You can configure the CA Clarity PPM logs to add more detail or to update or
remove entries. You can have your log file configuration changes take effect
immediately. Otherwise you will need to restart the CA Clarity Application
(app) and CA Clarity Background (bg) services before they take effect.
There are several different logs to choose from:
The primary logs are the niku logs, named after each active CA Clarity PPM
service on the selected server. For example, if you are running an app and bg
service on the selected server, two log files display: app-niku.log and bgniku.log. These log files contain log messages from the app service and bg
service respectively. If you have a second app service running on this server
with id app1, an additional log file, app1-niku.log, displays.
The admin log is another important log on your CA Clarity application server.
This log contains a record of system administrator tasks such as installation,
upgrade, deploying the database, and distributing files.
The system logs contain the console output from any app or bg services
running on the selected server. The console output contains any messages
outside of CA Clarity PPM, for example logged by the VM itself or the
application server (Apache Tomcat). Example system logs are app-system.log
and bg-system.log.
Niku Logs in BEA WebLogic and IBM WebSphere
Since, by default, CA Clarity PPM cannot know in which directory it is running,
CA Clarity PPM cannot write its own app-niku.log file from BEA WebLogic or
IBM WebSphere. All niku logger messages are routed instead to the server’s
own console logs. For IBM WebSphere, this is the SystemOut.log file for any
server wherein CA Clarity PPM is deployed. For BEA WebLogic, the console
output varies based on how the server is started. CA Clarity System
Administration has no access to these log files and cannot view them.
You can choose an alternate logs directory in CA Clarity System
Administration. Given this explicit directory, CA Clarity PPM writes the normal
niku logs as it does when running Apache Tomcat. In order for you to be able
to read these logs from CA Clarity System Administration, you must configure
a CA Clarity PPM home directory to use this logs directory, with a Beacon
service active and participating in the CA Clarity PPM cluster.
66 Installation Guide
General Administration
Turn Off Verbose JGroups Log Messages in IBM WebSphere
On IBM WebSphere, the JGroups library writes log messages every 3-5
seconds in the WebSphere SystemOut.log.
For example:
[8/29/06 15:08:43:825 PST] 0000001d UDP W org.jgroups.protocols.TP handleIncomingMessage discarded
message from different group "CLRTY-SA" (our group is "CLRTY"). Sender was130.200.250.86:64589
The messages are harmless, aside from polluting the log files. CA highly
recommends that you turn off these messages.
To turn off JGroups log messages in IBM WebSphere
1.
Choose Application Servers -> Diagnostic Trace Service -> Restart
WebSphere.
2.
Select org.jgroups.protocols.* (or just org.jgroups.*) and choose a level
error that is above "Warn".
Note: CA recommends choosing Fatal.
3.
Click OK and Save to Master.
4.
Restart IBM WebSphere.
View Log Files from the Command Line
The log files are stored by default in the logs directory under the CA Clarity
PPM home directory. Each server has its own logs directory. You can also
choose an alternate logs directory in CA Clarity System Administration.
You can use a text editor to view the log files. If you have a cluster of CA
Clarity PPM servers, the log files for each server pertain only to that server.
Edit Logger Configuration
The niku log files are the primary log files. Most of what CA Clarity PPM logs
goes to one of these files. This includes not only system errors but information
messages such as debug messages. You can configure which log messages
appear in the niku log files.
Two important Niku log message attributes are category and level. You can
adjust the logger configuration to filter log messages based on category and
level.
■
Category specifies from where in CA Clarity PPM the message was logged.
■
Level specifies the severity of the message.
Chapter 2: System Administration 67
General Administration
CA Clarity PPM reports all messages that fall under the com.niku category with
level error or above (Fatal). You may at times need to add additional
categories with information, or debug levels to clean more information when
troubleshooting a problem.
If you have more than one CA Clarity Background (bg) service running and
have enabled debugging to troubleshoot a CA Clarity Background (bg) service
issue, it is useful to turn off all services except the one configured for
debugging. This ensures all jobs or processes go through this CA Clarity
Background (bg) service and generate the desired debug messages. Restart
the CA Clarity Background (bg) service so that the changes take effect, and
then check the log file (bg-niku.log).
To edit the logger configuration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Servers from the Home menu.
The Servers page appears.
3.
Click the Properties icon for the server you want to edit log information.
The Server: Properties page appears.
4.
Click the Logs tab.
The Server: Logs page appears.
5.
Click the Edit Configuration subtab.
The Edit Configuration Server: Logs page appears.
6.
In the Properties section, complete the following fields:
Detect Log Configuration Changes Automatically
Indicates if log configuration changes take effect immediately. Select
to have changes you make take effect immediately.
Note: This option applies to CA Clarity Background (bg) and CA Clarity
Application (app) services running in Apache Tomcat. IBM WebSphere
and BEA WebLogic cannot detect whether the configuration file has
been updated.
Important! If you select this option, you must restart any affected
services before the change will take effect.
Alternate Logs Directory
Defines the alternate logs directory for this server.
Note: This must be a valid absolute path to a directory on the server.
For example, /niku/logs (Unix) or E:\logs (Windows).
68 Installation Guide
General Administration
7.
In the Categories section, complete the following fields:
Name
Defines the category you wish to add or change. Select from the dropdown. If you know of or are asked to enable a category not listed in
this list, enter the category in the Other Name text field.
Priority
Defines the debug level. The higher the level, the higher the priority.
Values:
■
Fatal. Level 4. Indicates that a critical service is not running.
■
Error. Level 3. Indicates that a problem exists that may restrict
system functions.
■
Warn. Level 2. Indicates that CA Clarity PPM encountered a
problem, but continues to run.
■
Info. Level 1. Informational messages indicate system status (such
as service start) and do not always indicate a problem.
■
Debug. Level 5. Displays detailed information to help you or CA
Technical Support resolve a problem.
■
All. Level 6. Displays all messages.
Additive
Indicates if new messages are appended to the logs. Select this check
box to append messages the logs. If this check box is clear, logs are
occasionally overwritten with new information.
8.
Click Save.
9.
Restart the affected services.
When to Use the Niku and Nikuadmin Utilities
These command-line utilities are reserved for special cases when you need a
command-line interface to CA Clarity PPM. In some cases, this is the only
place where a task may be executed. For example, the XDM configuration
engine is available only through nikuadmin.
For example, use the command line when:
■
You only need to restart the CA Clarity System Administration (nsa)
service or a Beacon service.
■
You need to use scripts to automate tasks available.
■
You do not have access to CA Clarity System Administration.
Chapter 2: System Administration 69
General Administration
Back Up a CA Clarity PPM Installation
Whenever you plan a significant updates to production system, back up the
current system so that you can restore it if necessary. Use the new backup
directory to store the database backup.
To back up CA Clarity PPM
1.
Log in to CA Clarity System Administration, and verify all services are
stopped except the database.
2.
Open a command line on the CA Clarity System Administration application
server, and issue the following command:
nikuadmin backup
3.
To accept the default values, press Enter.
The backup command copies the CA Clarity PPM installation directory into
a backup directory.
Back Up an Oracle Database
To back up an Oracle database
1.
From the database server command line, export the existing database
user by issuing the following command:
exp userid=system/manager user=niku file=nexp.dmp log=exp.log
2.
Copy the .dmp and the init<SID>.ora files to the backup directory that
was created by the nikuadmin command.
Back Up a Microsoft SQL Server Database
Back up the SQL database using the SQL Server Enterprise Manager (see
Microsoft instructions for details).
70 Installation Guide
General Administration
Restore a CA Clarity PPM Installation
When a catastrophe strikes, and all else fails, you may need to restore an
installation to a previously backed-up version. We do not recommend restoring
a CA Clarity PPM installation unless all other options are exhausted.
To restore an earlier version of CA Clarity PPM
1.
From the command line, stop all services.
niku stop all
2.
Restart the database:
niku start db
3.
Restore the database:
(Oracle)
a.
Drop the database user:
sqlplus system/manager
drop user niku cascade;
exit;
b.
Re-create the niku database user.
c.
Import the Oracle.dmp backup file:
imp userid=system/manager fromuser=niku touser=niku file=exp75.dmp log=imp.log
(Microsoft SQL Server)
Note: See the Microsoft documentation for detailed instructions for the
following tasks:
4.
d.
Open the Enterprise Manager application and delete the existing
database.
e.
Re-create the database.
f.
In Enterprise Manager, select the new database and restore it using
the backup file from the backup directory.
Restore CA Clarity PPM using the restore script from the backup directory:
(Windows)
restore.bat
(Unix)
restore.sh
5.
When complete, restart all services:
niku start all
6.
(Optional) Re-install older reports. See the CA Clarity PPM Installation
Guide that corresponds to the version under which you installed reports.
Chapter 2: System Administration 71
Security
Compile and Analyze Existing Oracle Database Objects
Whenever you export and import the database to another server to perform
test upgrades or to reorganize the database on your production server, you
should compile and analyze the database. This ensures that all database
objects are valid.
If database objects are not compiled prior to upgrading the CA Clarity PPM
schema, upgrade failures may occur.
To compile and analyze existing Oracle database objects
Log in to CA Clarity System Administration and issue the following commands:
nikuadmin db compile
nikuadmin db analyze
The database objects are compiled and analyzed.
Security
Refer to following topics for information on how to set up and maintain
security for your CA Clarity PPM system:
Manage Database Server Passwords
A server password allows you access to a single server. If the server is in a
cluster, the server password does not grant access to other servers in the
cluster.
It is recommended that you change server passwords on each server on a
regular basis to minimize the risk of unauthorized access using a server
password. You must restart services after you change certain passwords, such
as the database server password.
You must change server passwords in the following places:
■
On the database server.
Note: See the database documentation for more information.
■
In the CA Clarity PPM properties.
To further protect a server's password file, you can encrypt the password file.
72 Installation Guide
Security
How to Change Database Server Passwords
Use the following process when changing database server passwords:
1.
Change your database server password on the database itself.
Note: See the database documentation for details.
2.
Change the database server password in CA Clarity System Administration
to match the password you entered.
3.
If you are running BEA Weblogic or IBM Websphere as your CA Clarity
application server, do the following:
a.
Change the database password settings on your application server to
match the password you entered.
Note: See the CA Clarity application server documentation for details.
b.
Open a command prompt and issue the following command to upload
CA Clarity System Administration changes to the database:
nikuadmin general upload-config -info
Change Database Server Password in CA Clarity System Administration
To change the database server password in CA Clarity System
Administration
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Stop the CA Clarity Application (app) and CA Clarity Background (bg)
services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select the check boxes next to CA Clarity Application and CA Clarity
Background, and click Stop.
The services are stopped.
3.
Select Servers from the Home menu.
The Servers page appears.
4.
Click the Properties icon for the server you want to change the password.
The Server: Properties page appears.
5.
Select the Database tab from the toolbar.
The database Server: Properties page appears.
6.
In the Internal Connection: Niku section, complete the following fields:
Password
Enter a new password.
Chapter 2: System Administration 73
Security
Confirm Password
Enter the password again.
7.
Click Save.
Your changes are saved.
8.
Restart the CA Clarity Background (bg) and CA Clarity Application (app)
services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select the check boxes next to CA Clarity Background (bg) and CA
Clarity Application (app), and click Start.
The services are restarted.
The database server password is changed.
Enable Secure Sockets Layer (SSL) in Apache Tomcat
The instructions in this section only apply to implementations that use the
Apache Tomcat application server. For other servers, see your vendor’s
documentation.
SSL (Secure Sockets Layer) is a protocol for transmitting data between nodes.
It uses a cryptographic method to protect data from unauthorized access that
is based upon two keys: a public key that is known to everyone and a private
(secret) key known only to the message recipient. When HTTP is used in
conjunction with SSL, it is referred to as "HTTPS".
When SSL is enabled on the application service, all data moving between client
applications (such as a web browser or Open Workbench) are encrypted prior
to sending and decrypted before receiving. Without SSL encryption, an
authorized entity could read the data and steal sensitive information such as
user names and passwords.
74 Installation Guide
Security
How to Create Keystore Files
For testing purposes, use the private key included with CA Clarity PPM. Before
you place your system into production, create a keystore file for your private
key and distribute the file to all application servers.
If you have a keystore file created using a process other than the one outlined
here, you can still use the keystore file with CA Clarity PPM.
Do the following to create a keystore file and distribute it to all application
servers:
1.
Generate a public and private key pair.
2.
Obtain a certified certificate.
3.
Import the reply from the certificate authority and replace your self-signed
certificate with a chain of certificates.
4.
Distribute the file to all application servers.
Create Certificate Signing Requests
For production systems, you should replace the test certificate with a real,
certified certificate. To obtain a certified certificate, create a certificate signing
request (CSR) and send it to a certificate authority who generates a real
certificate that authenticates your public key.
Use the Java command "keytool" to create the CSR. The required Java
parameters are defined in the following procedure.
Note: For complete information on parameters for this Java command, see the
Sun web site.
To create a CSR
1.
On the CA Clarity application server, open a command prompt, and issue
the following command:
keytool -certreq -keystore /<clarity home>/config/.keystore
-keyalg RSA -file CA Clarity PPM.csr
2.
Define the following:
-certreq
This option generates a certificate signing request (CSR).
keystore
Specifies the path and filename of the keystore file. By default the
keystore is named ".keystore" and is located in the <clarity
home>/config/ directory.
Chapter 2: System Administration 75
Security
keyalg
This specifies algorithm to use when generating the key pair (RSA in
this example).
file
This is the name (caclarityppm.csr) of the generated certificate request
file.
3.
Using your web browser, go to your certificate authority’s website, and
provide the contents of the CSR file you generated using the process
specified by your certificate authority.
Your CSR is provided to you by your certificate authority.
4.
Copy the contents of the new certificate into a file on the CA Clarity
application server (for example, caclarityppm.cer).
Note: Your private key remains unaffected.
Install Certificate Signing Requests
Import the reply from the certificate authority and replace your self-signed
certificate with a chain of certificates. At the bottom of the chain is the
certificate issued by the certificate authority that authenticates your public
key. The next certificate in the chain is one that authenticates the certificate
authority's public key.
Use the following procedure to create a keystore file that contains your private
key which is paired with the signed certificate from your certificate authority.
To install the CSR
1.
Open the CA Clarity application server, open a command prompt, and
issue the following command:
keytool -import -keystore /<clarity home>/config/.keystore
-keyalg RSA -file CA Clarity PPM.cer -trustcacerts
Note: You may need to import your certificate authority’s root
intermediate certificate into your keystore file before you import your
certificate. For more information, see your certificate authority
documentation.
76 Installation Guide
2.
Enter the keystore password and press Enter.
3.
Enter "yes".
Security
Distribute the Keystore File to Application Servers
If you have more than one server with application services, you must
distribute the keystore to all of them.
To distribute the keystore
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Stop all services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select all services, and click Stop.
The services are stopped.
3.
Select Distribute All from the Distribution menu.
The Distribute All page appears.
4.
Check the box next to all servers, and click Distribute.
Your changes are saved.
5.
Restart all services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select all services, and click Start.
The services are restarted.
The keystore file is distributed to the servers with application services.
Set the Keystore File Location and Password
Repeat these steps for each server in the cluster.
To set or change the location of the keystore file or the keystore
password
1.
Log into the CA Clarity System Administration.
The Overview page appears.
2.
Click the Properties icon for the server you want to change.
The Server: Properties page appears.
3.
Click the Security tab from the toolbar.
The security Server: Properties page appears.
Chapter 2: System Administration 77
Security
4.
Complete the following fields:
SSL Keystore
Enter the location of the keystore file. If you leave this field empty, the
default value of "<clarity home>/config/.keystore" is used.
SSL Password
Enter the keystore password (the default value is "keystore").
Confirm Password
Enter the keystore password again.
5.
Click Save.
Your changes are saved.
6.
Stop and restart all services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Click the Select All icon to select all services, and click Stop.
The services are stopped.
c.
Click the Select All icon to select all services, and click Start.
The services are restarted.
Create Private Keys
The Java command "keytool" is used to generate a public and private key pair.
The required Java parameters are defined in the following procedure. For
complete information on parameters for this Java command, see the Sun web
site.
If you have a keystore file created using another process, you can also use the
file with CA Clarity PPM.
To create a private key
1.
Open the CA Clarity application server, open a command prompt, and
generate a public and private key pair by issuing the following command:
keytool -genkey -keystore /<clarity home>/config/.keystore
-keyalg RSA -storepass keystore
2.
Define the following:
-genkey
This option generates a keystore if one does not already exist. The
keystore contains the public and dummy public key.
78 Installation Guide
Security
keystore
Specifies the path and filename of the keystore file. By default the
keystore is named ".keystore" and is located in the /<clarity
home>/config/ directory.
keyalg
This specifies algorithm to use when generating the key pair (RSA in
this example).
storepass
The password used to protect the keystore (which must be at least 6
characters). This password is provided to all commands that access
the keystore.
3.
When prompted, enter the appropriate information about your
organization.
4.
Press Enter when prompted to enter the key password (the key password
and the keystore password must be the same).
The private key is created.
Enable SSL for CA Clarity PPM Servers
Complete this procedure for all servers for which you want to enable SSL.
To enable SSL for the CA Clarity PPM server
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Servers from the Home menu.
The Servers page appears.
3.
Select the name of the server you want to configure.
The Server: Properties page appears.
4.
Click the Application tab on the toolbar.
The application Server: Properties page appears.
5.
In the Application Instance section that corresponds to the desired server,
do the following:
HTTP Enabled
Clear the check box.
HTTPS Enabled
Select the check box.
Chapter 2: System Administration 79
Security
HTTPS Port
Enter the port to use for the HTTPS traffic.
HTTPS Entry URL
Enter the HTTPS URL (including the port).
Example:
https://clarity.mycompany.com:8443
6.
Click Save.
Your changes are saved.
7.
Stop and restart the application services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select each service you want to stop, and click Stop.
The services are stopped.
c.
Select each service you want to restart, and click Start.
The services are restarted.
Enable SSL for Password-protected Pages
You can enable SSL for only those pages that contain user passwords. With
this configuration, users are automatically redirected between secure and
insecure pages in the application. This is done by enabling HTTP and HTTPS at
the same time.
With this configuration, both ports on the UNIX operating systems must be
greater than 1024.
To enable SSL for password-protected pages
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Click Servers from the Home menu.
The Servers page appears.
3.
Click the Properties icon for the server that you want to configure.
The Server: Properties page appears.
4.
Click the Application tab on the toolbar.
The application Server: Properties page appears.
5.
80 Installation Guide
In the Application Instance section that corresponds to the desired server,
complete the following fields:
Security
HTTP Enabled
Select the check box.
HTTPS Enabled
Select the check box.
HTTPS Port
Enter the port to use for HTTPS traffic.
Important! For UNIX, the HTTP and HTTPS port numbers must be
greater than 1024.
HTTP Entry URL
Enter the HTTP URL (including port)
Example:
http://clarity.mycompany.com:8080
HTTPS Entry URL
Enter the HTTPS URL (including port).
Example:
https://clarity.mycompany.com:8443
6.
Configure additional servers as needed.
7.
Stop and restart each application service:
a.
Click the Services tab.
The Server: Services page appears.
b.
Select each service you want to stop, and click Stop.
The services are stopped.
c.
Select each service you want to restart, and click Start.
The services are restarted.
Chapter 2: System Administration 81
Security
Configure CA Clarity PPM to Work with SSL Off-loaders
When SSL is enabled on the application service, data moving between client
applications are encrypted prior to sending and decrypted before receiving.
This encryption can cause slower performance.
If an external SSL off-loader such as a load balancer or a reverse proxy is
used, the SSL off-loader encrypts HTTP traffic for CA Clarity PPM and
communicates with the client using HTTPS. This setup can provide
performance improvement but requires some configuration in both the offloader device and in CA Clarity PPM.
If you use an SSL off-loader, make sure that the device has a URL rewriting
function and that the function is enabled.
To configure CA Clarity PPM to work with an SSL off-loader
1.
Log into CA Clarity System Administration.
The Overview page appears.
2.
Click Servers from the Home menu.
The Servers page appears.
3.
Click the Properties icon for the server that you want to configure.
The Server: Properties page appears.
4.
Click the Application tab on the toolbar.
The application Server: Properties page appears.
5.
For each application instance other than the CA Clarity application server
instance, complete the following settings:
HTTP Enabled
Indicates that HTTP will be used to communicate. Select the check
box.
HTTP Entry URL
Indicates the URL to use for traffic between CA Clarity PPM and a
client. When using an SSL off-loader, the off-loader becomes the front
end to CA Clarity PPM similar to the way a load balancer is the front
end in a multiple-server environment. Because the SSL off-loader URL
is secure, enter an HTTPS URL in this field using the following format:
https://<hostname>:CA Portal.
HTTPS Enabled
This check box does not apply when you are using an SSL off-loader.
It should be cleared.
6.
82 Installation Guide
Click Save.
Security
Lightweight Directory Access Protocol (LDAP) Server Integration
If your users use several applications, it can be beneficial to implement a
Lightweight Directory Access Protocol (LDAP) interface to authorize user
access across all the applications. Instead of storing user access information
separately for each application, a central directory server controls access so
that users can have one user name and password for all applications.
The following is supported:
■
LDAP v2 (simple) protocol and uses a small subset of LDAP functionality
including authentication (clear text or SSL), binding, and searching.
■
LDAP v3 control for paged-results as defined in RFC 2696.
If you want to synchronize thousands of users between your directory server
and CA Clarity PPM, users are fetched from the directory server in a batch size
as specified by LDAP configuration settings of CA Clarity PPM.
Session-based cookies carry a token that is used to access session data and is
persisted in the cache for single application environments or in a database for
clustered environments. The user's web browser must accept cookies from the
CA Clarity PPM application, which are session-based, so they are never written
to disk. When the user logs out, session information in the database and cache
that correspond to the cookie are deleted.
When you integrate CA Clarity PPM with an LDAP server, you get the following
benefits:
■
Simplified user name password administration. IT only has to manage one
user name and password pair for a user.
■
Authentication support. IT only has to support one place where users may
have authentication problems.
■
Improved usability. Users only have to remember one user name and
password.
■
Improved user management. User name and email information can be
stored in LDAP.
■
Enhanced security. Using one user name and password makes it easier to
use complex passwords and to change them more often. The likelihood of
choosing a familiar password is reduced when there is only one password
to remember.
Chapter 2: System Administration 83
Security
Additional Notes on LDAP
The LDAP - Synchronize New and Changed Users job synchronizes LDAP
entries. It then stores the last date and time the job ran successfully and
stores information in the MN_DIRECTORY_SERVERS database table. The next
time the background job runs, it synchronizes only recently-created or
changed user entries where the timestamp is greater than the value found in
the CMN_DIRECTORY_SERVERS.LAST_SYNC_DATE property.
CA Clarity PPM does not check whether a user found in a CA Clarity PPM group
or in a search specified in CA Clarity System Administration is active or
inactive in LDAP. CA Clarity PPM checks only whether a user is present in a CA
Clarity PPM group or whether an attribute being searched for is present in CA
Clarity PPM.
Nested CA Clarity PPM groups are not recognized. Before running LDAP
synchronization jobs, ensure that users are associated with CA Clarity PPM
groups that the CA Clarity System Administration search can find. Users in
nested CA Clarity PPM groups will not be checked when the LDAP
synchronization jobs are run.
If a user is deactivated on the LDAP server, the next time the synchronization
job runs, the user is deactivated in CA Clarity PPM. If the user is re-activated
on the LDAP server, the user will not be re-activated in CA Clarity PPM; you
will need to re-activate the resource.
Configure CA Clarity PPM to Work with LDAP
CA Clarity PPM does not recognize nested groups in LDAP. Before running the
LDAP - Synchronize New and Changed Users job or the LDAP - Synchronize
Obsolete Users job, ensure that your users are associated with a group that
the CA Clarity System Administration search can find. Users in groups that are
nested inside the LDAP "CA Clarity PPM" group are not checked when the LDAP
synchronization jobs are run.
Before you implement LDAP, choose a compatible LDAP server.
Note: See the Product Architecture Stack (PAS) Guide for more information on
a compatible LDAP server.
84 Installation Guide
Security
How to Set Up CA Clarity PPM for LDAP Authentication
Important! You must set up CA Clarity PPM for LDAP authentication for each
server running an application service. To successfully complete this procedure,
you must understand how to configure an LDAP server. If you have a cluster of
CA Clarity PPM servers, repeat the following procedure on each server in the
cluster.
1.
Create a resource as the test user you can use to access CA Clarity PPM as
an LDAP user.
Important! This test user must have the same user ID in CA Clarity PPM
as the user’s LDAP sAMAccountName in Microsoft Active Directory or UID
for other LDAP implementations.
2.
Decide how to define the LDAP users who will have access to CA Clarity
PPM.
You can enable group authentication by specifying a group, or by creating
an attribute/value combination on the LDAP, or both. You can define this
setting from the security Server: Properties page in CA Clarity System
Administration.
3.
Define the LDAP server properties (see page 85) in CA Clarity System
Administration.
4.
Set up CA Clarity PPM to authenticate (see page 86) by using information
on the LDAP server when users log in.
5.
Stop and restart all CA Clarity PPM services.
Define the LDAP Server Properties
You can define the LDAP server properties in CA Clarity System
Administration.
To define the LDAP authentication
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Click the Properties icon for the server you want to set up.
The Server: Properties page appears.
3.
Click the Security tab on the Properties toolbar.
The security Server: Properties page appears.
4.
In the LDAP Server section, complete the fields:
URL
Defines the LDAP server URL. If your LDAP server is SSL-enabled, use
the LDAPS protocol in the URL (rather than the default LDAP protocol).
Chapter 2: System Administration 85
Security
Root Context
Defines the LDAP naming context, for example: "ou=People, dc=niku,
dc=com".
Search User
Defines the user name with the appropriate credentials for binding to
the LDAP server.
Password
Defines the password and confirms it in the Confirm Password field.
Search Filter
Defines the search filter string (as defined in RFC 2254).
Date/Time Format
Defines the date and time format used by the LDAP server.
Group Name
Enables group authentication. Enter the group name and at the Group
Identifier field, enter the group ID.
Allow non-LDAP users
Indicates that access to the CA Clarity PPM is allowed using alternate
authentication methods.
5.
Click Save.
6.
Stop and restart all CA Clarity PPM services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Click the All Services icon to select check box next to each service.
7.
Click Start.
8.
Click Save.
Set Up CA Clarity PPM to Authenticate
Use the following procedure to set up CA Clarity PPM to authenticate user
information on the LDAP server when users log in.
To set up CA Clarity PPM to authenticate
1.
Log in to the CA Clarity System Administration.
The Overview page appears.
2.
Select Servers from the Home menu.
The Servers page appears.
86 Installation Guide
Security
3.
Click the Properties icon for the server you want to set up.
The Server: Properties page appears.
4.
Click the Application tab on the Properties toolbar.
The application Server: Properties page appears.
5.
In the Application Server section, select Use LDAP, and click Save.
LDAP Synchronization
The following LDAP synchronization jobs are provided that work together to
synchronize CA Clarity PPM with LDAP:
LDAP - Synchronize New and Changed Users job
This job synchronizes LDAP records with CA Clarity PPM records by
synchronizing the users you add to the LDAP "CA Clarity PPM" group and
making them active on the CA Clarity PPM server. Similarly, if you are
using the search filter option and you change an attribute back to one
used by CA Clarity PPM, the user is activated on the CA Clarity PPM server
the next time this job runs. This job then stores the last date and time the
job ran successfully in the CMN_DIRECTORY_SERVERS database table. The
next time this job runs, it synchronizes only recently-created or changed
user entries where the timestamp is greater than the value found in the
CMN_DIRECTORY_SERVERS.LAST_SYNC_DATE field.
LDAP - Synchronize Obsolete Users job
This job ensures that the users you remove from the LDAP "CA Clarity
PPM" group on the LDAP server or whose record no longer contains the
chosen search attribute are inactivated in the CA Clarity PPM application.
When you run this job, CA Clarity PPM does not check whether a user
found in the LDAP "CA Clarity PPM" group or in the search specified in CA
Clarity System Administration is active or inactive in LDAP. You must
remove the users from the LDAP "CA Clarity PPM" group or remove the
search attribute specified in CA Clarity System Administration from their
record in order for the users to be inactivated in the CA Clarity PPM
application by the LDAP - Synchronize Obsolete Users job.
These synchronization jobs function properly if you have correctly configured
the LDAP Server and LDAP Attribute Mapping sections in CA Clarity System
Administration.
You must select a schedule for each job. We recommend that you run these
jobs nightly.
Note: To synchronize the database with the directory server, delete all rows
from CMN_DIRECTORY_SERVERS database table and run the background job
again. You can also run the job for a specific group so that only the records for
those users are affected.
Chapter 2: System Administration 87
Security
Force the LDAP - Synchronize New and Changed Users job to Perform a Full Synchronization
In some situations, you may want to override the behavior of the LDAP Synchronize New and Changed Users job and force it to perform a full
synchronization.
To force the job to perform full synchronization
1.
Delete the row from CMN_DIRECTORY_SERVERS database table.
2.
Run (or schedule) the job again.
Troubleshoot LDAP
The following discusses some common LDAP issues and ways to address them:
■
To debug the LDAP authentication process, enable debug messages logged
by the security component. If you have more than one background service
in your implementation, stop them all except the one on which you are
enabling debug messages. Restart the background service so that the
changes take effect and check the log file (bg-niku.log).
■
When reviewing the CA Clarity PPM logs for error messages, LDAP-specific
error codes may display.
Note: See the third-party LDAP documentation for descriptions of LDAPspecific error codes.
■
If you cannot log in to CA Clarity PPM using an LDAP user name and
password, consider the following:
–
Are you using an active LDAP account that also exists as an active
account in CA Clarity PPM?
–
Have you enabled the LDAP configuration by selecting the Use LDAP
field on the application Server: Properties page in the CA Clarity
System Administration?
–
Did you enter the correct user ID in the Search User field and the
correct password in the Password field on the security Server:
Properties page in the CA Clarity System Administration?
–
Refer to the log files for more specific messages.
–
Processing time for the LDAP - Synchronize Obsolete Users job and the
LDAP - Synchronize New and Changed Users job depends on the
number of users that are loaded from the directory service into CA
Clarity PPM. Specifically, large numbers can slow processing times.
Common LDAP Synchronization Errors
The following sections identify ways you can find more information about why
LDAP synchronization or authentication is not working as expected.
88 Installation Guide
Security
Check the LDAP Synchronization Logs
Check the LDAP synchronization transaction logs in the following directory:
<clarity home>/logs/ldapsync
Log files related to New and Changed Users jobs are:
■
ldapusers_nm_*.xml: List of users found in the directory server to be
synchronized with CA Clarity PPM.
■
ldapsync_nm_*.xml: List of Success/Error/Warning messages for this sync
job.
Log files related to the LDAP - Synchronize Obsolete Users job are:
■
ldapusers_ia_*.xml: List of users to be inactivated in CA Clarity PPM.
■
ldapsync_ia_*.xml: List of Success/Error/Warning messages for this sync
job.
Enable Debugging Messages
Debugging messages are logged by the security component. If you have more
than one CA Clarity Background (bg) service in your implementation, stop
them all except the one on which you are enabling debug messages. Restart
the CA Clarity Background (bg) service so that the changes take effect and
check the log file (bg-niku.log).
To enable debugging messages
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select Servers from the Home menu.
The Servers page appears.
3.
Click the Logs icon for the server you want to enable debugging messages.
The Server: Logs page appears.
4.
Click the Edit Configuration subtab.
The Edit Configuration Server: Logs page appears.
5.
In the Categories section, click Add.
A new category line item appears.
6.
Enter the following for the new line item:
Name
Enter com.niku.security.
Chapter 2: System Administration 89
Security
Priority
Select Debug from the drop-down.
7.
Click Save.
Debugging messages are enabled.
Configure LDAP and SSL
When an LDAP server is running with the Secure Socket Layer (SSL), you must
configure LDAP and SSL. The CA Clarity PPM administrator must install the
trusted security certificate for the LDAP server on the machine that is running
the CA Clarity Background (bg) services. To do so, use the keytool that ships
with the Java 2 SDK.
Issue the following commands from the command prompt:
keytool -import -v -trustcacerts -alias <alias> -file <certificate file name> -keystore cacerts
Example:
$cd $JAVA_HOME/jre/lib/security
$keytool -import -v -trustcacerts -alias NikuLdapServer -file TrustedRootCert.der -keystore cacerts
Single Sign-On (SSO)
Single sign-on (SSO) is an authentication process that allows users access to
multiple systems using a single username and password. Once the server uses
information that is stored in the LDAP directory to authenticate a user's
identity, it allows access to the requested information according to the user's
access privileges.
You can set up SSO to integrate CA Clarity PPM with the internal portal
application to which the user authenticates. SSO takes away the need for
users to repeatedly enter their username and password when switching from
application to another. The portal application has links (URLs) to other internal
applications, and once invoked, users are not prompted with authentication
dialogs, but are proceeded directly into the application. The portal application
has an SSO plugin that first directs users to log into the portal, then proceeds
them to the appropriate application. This way, users cannot bookmark a page
and then later return to it without first logging in.
90 Installation Guide
Security
SSO provides the following benefits:
■
Username/Password Administration. IT only has to manage one
username/password for a user.
■
Authentication Support. IT only has to support one place where users may
have authentication problems.
■
Usability. Users only have to remember one username and password, and
only have to login once at one place.
■
Security. One username and password makes it easier to use complex
passwords and to change them more often. The chance of a user choosing
a familiar password is reduced when there is only one password to
remember.
To enable the Single Sign-On for one or many of the application
instances
1.
Configure your SSO server and proxy server to point at CA Clarity PPM and
to have it pass an authentication token that contains a valid CA Clarity
PPM> username. The SSO server should be configured so that the entry
URL is:
http://<server>/niku/app?action=npt.overview
2.
Log in to CA Clarity System Administration, and select Servers from the
Home menu.
The Servers page appears.
3.
Click the name of the server you want to set up.
The Server: Properties page appears.
4.
Select the Application tab.
The application Server: Properties page appears.
5.
To use LDAP, in the Application Server section, select Use LDAP.
If LDAP is enabled, non-browser clients will use the same user name and
password.
6.
In the Application Instance section, select Use Single Sign-On and save.
7.
Click the Security tab.
The security Server: Properties page appears.
8.
In the Encryption section, complete the following fields:
SSL Keystore
Defines the path to the keystore file.
Example: <pathtokeystore>/server.keystore).
Chapter 2: System Administration 91
Security
SSL Password
Defines the keystore password. Once entered, confirm at the Confirm
Password field.
9.
In the LDAP Server section, complete the following fields:
URL
Defines the LDAP server URL.
Root Context
Defines the LDAP server naming context, for example: "ou=People,
dc=niku, dc=com".
Search User
Defines the user name with the appropriate credentials for binding to
the LDAP server.
Password
Defines the LDAP server password. Once entered, confirm it again at
the Confirm Password field.
Batch Size
Enables the synchronous operation. Set the batch size using the
following criteria:
■
0. Allows all results received from the server as they are
generated.
■
A non-zero number. Messages blocked until n messages are
received from the server (enumeration proceeds while additional
messages are queued).
■
The default batch size is 1 so that an enumeration of search
results from a synchronous search operation returns messages as
they are received from the server.
■
The default batch size is 1 so that an enumeration of search
results from a synchronous search operation returns messages as
they are received from the server.
Search Filter
Defines the search filter string (as defined in RFC 2254).
Date/Time Format
Defines the date and time format used on the LDAP server.
Group Name
Defines group that is enabled for group authentication.
92 Installation Guide
Security
Group Identifier
If you are using group authentication, defines the group ID for the
group enabled for group authentication.
Allow non-LDAP users
Indicates if non-LDAP users are allowed to access the application using
an alternative authentication method.
10. In the LDAP Attribute Mapping section, complete the following fields:
Username
Defines the attribute for the user name.
First Name
Defines the attribute for the first name.
Last Name
Defines the attribute for the last name.
Full Name
Defines the attribute for the last name.
Email Address
Defines the attribute for the email address.
Modify Time Stamp
Defines the attribute for the modify time stamp.
11. In the Single Sign-on section, complete the following fields:
Token Name
Defines the HTTP cookie that CA Clarity PPM should accept as a valid
authentication token to initiate a user session.
Token Type
Defines the token type. Values are:
■
Cookie. The token is contained in a cookie.
■
Header. The token is contained in the message header.
■
Parameter. The token is provided in a parameter.
Logout URL
Defines the fully-qualified URL that will display when the user logs out
of the CA Clarity PPM.
Authentication Error URL
Defines the fully-qualified URL that will display when the user cannot
be authenticated.
Chapter 2: System Administration 93
Security
12. Click Save.
Your changes are saved.
13. Restart the application, and log in to CA Clarity PPM as an application
administrator.
The System Settings page appears.
Use LDAP with SSO
You can use LDAP with Single Sign-On (SSO). While SSO does not require
LDAP to be enabled, CA recommends using LDAP with SSO for the following
reasons:
■
Non-Browser clients get most of the SSO benefits.
■
With SSO only, user information such as names, email, etc. must still be
managed within CA Clarity PPM. With LDAP, such data is kept in the
directory server.
Use LDAP without SSO
SSO gives little additional benefit over LDAP. Users must enter their username
and password to log into CA Clarity PPM, but every other benefit still applies
with LDAP. The system configuration is much simpler for LDAP alone as there
is no need for a proxy or SSO server, and only one CA Clarity PPM instance is
required.
User Sessions Q&A
How does CA Clarity PPM track user sessions?
A session based cookie carries a token that is used to access the session data
that is persisted in the cache (for a single app environment), or in the
database (for a clustered environment).
What limitations does this place on our environment?
The end user's web browser must accept cookies from the CA Clarity PPM
application. The cookies are session-based, so they are never written to disk.
Are load balancers or clusters influenced by this technique?
Load balancing and clustering work fine with this technique. There are many
companies load balancing and clustering CA Clarity PPM.
94 Installation Guide
Application Servers
Can sessions be hijacked inadvertently or on purpose?
To maliciously steal another user's session, one would have to either snoop
the HTTP traffic to pick out the headers containing the authentication cookie.
This token, however, is valid only while the real user is logged in. Once this
user logs out, session information in the database/cache that corresponds to
the cookie value is deleted.
Application Servers
Refer to the following topics for information on general administration of the
application servers:
Tune Sun HotSpot JVMs
This section applies only to environments with Sun HotSpot JVMs, and does
not apply to any IBM AIX or IBM WebSphere environments.
Proper tuning of the Sun HotSpot JVM is an important task when configuring
and maintaining CA Clarity PPM. While proper tuning is important for the
background service, it is more important for any application services running
in the cluster. This section focuses on the application.
Note: See the documentation for all of these settings online at
http://java.sun.com/docs/hotspot/VMOptions.html.
Many options are available for tuning a HotSpot JVM. At a minimum, CA
recommends using the following:
Maximum Heap
-Xmx<size>m
The maximum heap setting determines the most memory that the local
operating system will ever give to the Java VM. It does not allocate this
much memory immediately on startup, but it may do so as the process
runs. For most CA Clarity PPM installations, this setting for the application
service should be 1536m (1.5GB) or higher. The minimum is about 1024m
(1 GB), even for very small installations.
-Xmx1536 is the maximum memory allowed per jvm in a 32-bit windows
installation. Having a setting larger than this in a Windows environment
can cause problems with starting the app service.
Chapter 2: System Administration 95
Application Servers
Minimum Heap
-Xms<size>m
The minimum heap setting is important to avoid wasted effort by the VM
when expanding the heap as the application is ramped up. You should
specify the minimum heap as close to reality as possible. That means if
(under normal circumstances) the application uses 1.2GB of RAM, you
should set the minimum heap setting to 1200m. You can set the minimum
and maximum heap sizes to be equal. CA recommends this setting. This
results in a simpler task for the VM garbage collector. These settings also
make the JVM process allocate the full maximum heap from the operating
system at startup, which is more consistent. This process requires you to
measure true memory allocation requirements on your server.
Parallel Garbage Collector
-XX:+UseParallelGC
The Parallel Garbage collector is recommended for any servers with two or
more CPUs. It is safe to set on all servers. Any servers with fewer than two
CPUs ignore this setting.
New Ratio
-XX:NewRatio=<size>
The HotSpot VM segregates objects into New and Old Spaces based on the
ages of objects in memory. Short-lived objects tend to stay in the New (or
Eden) Space and are collected before going elsewhere. Longer-lived
objects are migrated to the Old (or Tenured) Space. The New Ratio setting
does not actually define the explicit size of the New Space, but rather a
ratio between the old and the new. A setting of -XX:NewRatio=3 translates
to a ratio of 1 to 3, where the New generation is 1/3 the size of the Old
generation. For applications where there are relatively many short-lived
temporary objects created and destroyed quickly, as in a server-side
application like CA Clarity PPM, a larger-than-average New Space is
required. Otherwise, the New Space is overflowing while the Old Space is
underpopulated.
The default for New Ratio varies from platform to platform. On Solaris
servers NewRatio=2 is already the default. However on Windows servers,
the default is much different and unworkable. To avoid problems in CA
Clarity PPM, regardless of platform, we recommend a New ratio of 1 to 2,
which means XX:NewRatio=2.
96 Installation Guide
Application Servers
Maximum Permanent Size
-XX:MaxPermSize=<size>m
Besides the New and Old Spaces, there is a third space called the
Permanent space. In this space resides permanent objects, primarily Java
class definitions. This space grows not with usage of the application, but
with the size of the application. The more classes loaded in the application,
the greater the permanent size should be.
For CA Clarity PPM, the default setting of 64m has proven too small. In
Apache Tomcat, the default CA Clarity PPM setting for this space is 128m.
For BEA WebLogic or IBM WebSphere installations, you must set this value
manually.
Chapter 2: System Administration 97
Application Servers
Change the J2EE Server from Apache Tomcat to Generic J2EE
CA Clarity PPM supports both the Apache Tomcat application server (default)
as well as a generic J2EE server vendor option. Supported generic vendors
BEA WebLogic and IBM WebSphere. If your company has an existing license or
experience with these vendors, you may want to use them instead of the
Apache Tomcat application server.
Before continuing, verify that the generic server is installed and configured
according to the vendor documentation. You must have the J2EE vendor’s
administration server running on the same server as CA Clarity System
Administration.
To switch from Apache Tomcat application server to the generic J2EE
server
1.
Log into CA Clarity System Administration (running in Apache Tomcat) and
shut down any CA Clarity Application (app) services in the cluster.
Note: Shut down only the app services. You need not stop any other
services.
2.
On the CA Clarity application server, open a command prompt and issue
the following command:
niku stop nsa
The existing nsa service is shut down.
3.
Package the CA Clarity System Administration application (nsa.ear) by
issuing the following command:
nikuadmin package nsa
Note: You must install and run the J2EE vendor’s administrator console on
the same machine as CA Clarity System Administration. The nsa.ear is
pre-configured for that machine only, and cannot be deployed to any other
server.
4.
From the vendor’s administration console, install the nsa.ear according to
the vendor’s documentation. CA Clarity System Administration, when
started, is available on the context /nsa/app.
Example:
http://<servername>:9080/nsa/app (default IBM WebSphere URL)
http://<servername>:7001/nsa/app (default WebLogic URL)
This context differs from that used under Apache Tomcat. With Apache
Tomcat application server, the context is /niku/app. With the Generic J2EE
server option, it is /nsa/app.
5.
98 Installation Guide
Log in to CA Clarity System Administration, and open the application
Server: Properties page.
Clustering
6.
Complete the following fields:
Vendor
Select Generic J2EE.
7.
Click Save.
8.
Continue with the installation instructions, beginning at the System
Administration section.
Note: You do not need to re-execute most of the steps in the Install and
Upgrade Wizard portion of the CA Clarity PPM install. The only required
step is the last Package EAR task, which creates the CA Clarity System
Administration application archive (nsa.ear).
9.
When finished, distribute CA Clarity PPM to all required servers (if using a
cluster) and start it.
Clustering
Refer to the appropriate installation or upgrade information (according to the
platform on which you are installing CA Clarity PPM) for details on how to
design a CA Clarity PPM cluster. The following sections provide further details
on clustering and are intended to be used as a reference.
Scale CA Clarity PPM
Scaling is a simple term used to describe the complex activity of deciding what
services you want and what machines on which you want them to run, all in
the name of performance and reliability.
Even the smallest CA Clarity PPM installations usually have more than one
machine involved. Typically:
■
One for the database and another for everything else, or
■
One machine for CA Clarity PPM, which connects to a data center owned
by a group that externally manages the database.
Medium-to-large CA Clarity PPM installations, depending on performance and
reliability requirements, usually has redundant services running on several
dedicated machines.
Multicast Messaging
CA Clarity PPM uses multicast messaging extensively in a cluster. As
multicasting is often misunderstood, we give a detailed overview here.
Chapter 2: System Administration 99
Clustering
The Beacon is a bootstrapping service running on all CA Clarity PPM-managed
machines in a cluster. The Beacon is used to manage and monitor the CA
Clarity PPM services on each box, as well as to apply patches and upgrades
delivered from the CA Clarity application server.
The Beacon services employ a dynamic discovery mechanism using multicast.
Each beacon sends a discovery message every five seconds telling anyone
listening in the cluster that it exists. CA Clarity System Administration listens
for these Beacon discovery messages, using them to register the active cluster
nodes. When CA Clarity System Administration receives a beacon discovery
message, it verifies the Beacon's password against its own, and if successful
adds it to its list of servers.
CA Clarity System Administration also pings each beacon directly every ten
seconds to determine whether the beacon is alive. This is a TCP (unicast)
message, so one message per registered beacon is sent over the network.
Herein lies the advantage of multicast: a multicast message is sent once over
the network and received multiple times by interested parties. Given that it is
UDP (vs. TCP) it is also a lighter-weight message. The unicast message on the
other hand must be sent out over the network once for each interested party.
Thus, multicasting is perfect for dynamic discovery and monitoring applications
like the Beacon.
The Beacon however is not the only service to use multicasting. In addition to
the Beacons, the cache management services within the application and
background servers broadcast their own messages to maintain cache
consistency. These messages contain no actual data. They only inform remote
servers when resident data is stale and must be reloaded from the database.
We refer to this as flushing the cache. When a cache is flushed on a given
server in a cluster, like what occurs when a user logs out, a message is sent
over the network which all other app and bg services receive, informing them
in turn to flush their own caches of the data in question.
Finally, CA Clarity PPM uses a session monitor thread to keep sessions on
disparate servers from timing out prematurely. This thread broadcasts every
five minutes with a longer message containing active session ids. When a
session is no longer active on one server, it is flushed from all servers. When a
session remains active, it is marked as such on all other servers to keep them
from logging out the user.
All of this means the servers in a CA Clarity PPM cluster must be able to send
and receive multicast messages. In a normal subnet, this is allowed by default.
CA recommends keeping all CA Clarity PPM servers in the same subnet. If
however you are forced to use servers in different locations with different
subnets, you must create a multicast bridge between them.
100 Installation Guide
Clustering
This may seem like a lot of extra UDP traffic. However, when you compare the
amount of data travelling between the database, reporting server, application
servers and clients, the cluster messaging is inconsequential. It is a very, very
small percentage of overall network traffic. Often people hear 'broadcast' and
think their networks are overloaded. The fact is, all network traffic is
broadcast. All TCP (unicast) messages on a subnet touch every node in the
subnet, just like UDP (multicast). The difference is, the TCP messages are two
to three times larger than UDP messages, because TCP messages are
guaranteed to arrive, which requires several handshakes per packet.
Furthermore, these multicast messages in CA Clarity PPM are tiny, minute
compared to the average database request. With multiple application,
background, and reporting servers on a high-performance system we are
making literally hundreds of such database requests per second. Tiny UDP
messages firing per-server every five seconds are nothing in comparison.
Load Balancers and Sticky Sessions
CA Clarity PPM supports any hardware or software load balancer. CA strongly
recommends however that you enable the Sticky Session option on the load
balancer. While CA Clarity PPM is truly stateless and designed to function with
a round-robin or other distribution model, it is most efficient when a user’s
session remains on one server.
This is a memory issue. By adding additional application servers you gain
performance, but sticky sessions are required in a load-balanced environment
regardless of the algorithm used or the number of resources contained on the
server. To further illustrate, if you have five application servers and the load
balancing algorithm spreads a single user session’s individual requests across
all servers, that means each server loads and caches that user session’s data.
Looking at the system as a whole, that means you are using five times the
amount of memory you would be using if sticky sessions were enabled, and
the user session remained on only one of the boxes.
The best situation is for you to configure the load balancer in such a way that
it uses soft sticky sessions. A soft sticky session sends requests from the same
user session to the same box, but if that box is overloaded or another server is
idle, it moves the stickiness from the overloaded box to the idle box. Because
CA Clarity PPM is fully stateless in nature, it fully supports this. Furthermore, if
an overloaded box goes down, those sessions are not lost. Presuming the load
balancer correctly detects the downed server and redirects requests to
another, those user sessions are fully available on the new server.
Chapter 2: System Administration 101
Clustering
Sharing Disks
In a CA Clarity PPM cluster, multiple app and bg services must share the same
disk for search indexing and, unless files are stored in the database, document
storage. This means in CA Clarity System Administration, each server with
application or background services must point the Search Index Directory
property to the same shared disk. Unless you store files in the database, the
File Store Directory property must point to the same shared disk as well.
You can most effectively share disks using a Storage Area Network or Network
Attached Storage solution. Unix NFS or Windows file sharing is also
acceptable.
Distribute Files to Servers in a Cluster
If you update any files on the CA Clarity application server, either by
customizing UI themes, or from a hot fix, patch, or upgrade, you must
distribute those files to all servers in the cluster.
You can also check the status of the distribution by clicking NSA Logs and
choosing nsa-niku.log. When complete, the status window closes and the
parent page appears. The distribution page shows the latest distributed date
and version.
To distribute files to all servers in the cluster
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
From the Distribution menu, select:
Distribute XDM
Distributes updated XDM files.
Distribute Themes
Distributes updated UI theme files.
Distribute All
Distributes all updated files under the CA Clarity PPM home directory.
3.
Choose one or more servers and click Distribute.
The status window opens to show the new distribution job.
102 Installation Guide
Clustering
Multiple Application or Background Service Instances
If you are using big-iron machines with free gigabytes of physical memory, we
recommend running multiple CA Clarity Application (app) and CA Clarity
Background (bg) service instances on those. From CA Clarity PPM’s
perspective, it is no different than running services on two different machines.
This ensures that you can use the full power of a machine, with the benefits of
increased performance and reliability that come from multiple services.
If you are using the Generic J2EE option, you can deploy the CA Clarity PPM
EAR to any additional servers using the vendor’s administration console.
CA Clarity System Administration makes multiple instances easy by providing
a Clone action. This creates a copy of the desired app or bg service with
incremented, available ports and service names to avoid collisions.
Note: See the Administration Guide for more information.
After cloning the services, you can start, stop, and otherwise manage the new
service instance as you would the original.
To clone an app or bg service
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select All Services from the Home menu.
The All Services page appears.
3.
Select the check box for the service type you want to clone, such as the
CA Clarity Application (app) or CA Clarity Background (bg) service type,
and then click Clone.
The services are cloned.
4.
If desired, navigate to the server on which you have created a new service
and modify the cloned settings as needed.
Chapter 2: System Administration 103
Clustering
Configure Dedicated Reporting Databases
If you are able to operate a secondary database against which you wish to
execute reports, you can configure CA Clarity PPM to use it. The important
aspect to using a separate database is making sure it is reasonably
synchronized with your production CA Clarity PPM database. If the reporting
database is too far behind the production database, you may encounter
situations where users or instance data to be included in the report does not
yet exist in the reporting database. Also, note that when configured as shown
below, the reports run solely against the reporting database. This means that
all tables required by the reports, including user and security tables, must be
synchronized. If you intend to synchronize only a subset of the production
database tables, you must ensure that you choose the correct tables to
support the reports you wish to run.
To configure a dedicated database for reporting
1.
Log in to CA Clarity System Administration, and select Servers from the
Home menu.
The Servers page appears.
2.
Click the Properties icon for the server you want to configure.
The Server: Properties page appears.
3.
Click the Database tab on the toolbar.
The database Server: Properties page appears.
4.
In the Internal Connection: Niku section, click New External Connection.
The New External Database Connection page appears.
5.
Complete the appropriate properties for your reporting database:
ID
Defines the ID that is used to identify this connection later.
Service Name
Refers to a valid TNS entry (Oracle) or ODBC entry (SQL Server) on
the reporting server.
6.
Click Save.
Your changes are saved.
7.
Click the Reporting tab on the toolbar.
The reporting Server: Properties page appears.
8.
Select your new external connection from the Database ID drop-down and
click Save.
Your changes are saved.
104 Installation Guide
Clustering
9.
Repeat the preceding steps for all servers in your CA Clarity PPM cluster.
10. Restart all CA Clarity Application (app) and CA Clarity Background (bg)
services in your cluster.
11. On each reporting server in your cluster:
a.
Create a new TNS entry (Oracle) or ODBC entry (SQL Server) with the
appropriate connection properties to point to your dedicated reporting
database server.
b.
Ensure that the name you choose matches the service name for your
external connection in CA Clarity System Administration.
12. Install reports from CA Clarity System Administration.
This step installs the reports, the CA Clarity PPM universe, and other
reporting content on the Business Objects Report Server.
Oracle Database Clustering
CA Clarity PPM supports using an Oracle Cluster to provide higher scalability,
redundancy, and failover than is possible with a single Oracle server.
To use an Oracle Real Application Cluster (RAC)
1.
Export your existing single-server Oracle database from the single node
instance and import it into the cluster (if necessary).
2.
For Oracle 9i customers only, modify your init.ora settings for the cluster
to include the following:
max_commit_propagation_delay=0
This setting is currently required to work around a bug in Oracle 9i
clustering where updates between servers are not synchronized properly.
3.
Log in to CA Clarity System Administration.
The Overview page appears.
4.
Select Servers from the Home menu.
The Servers page appears.
5.
Click the Properties icon for the server for which you want to edit
properties.
The Server: Properties page appears.
6.
Select the Database tab on the toolbar.
The database Server: Properties page appears.
Chapter 2: System Administration 105
Performance
7.
Edit the following properties for the database connection:
Specify URL
Selected
JDBC Url
Fully-qualified Oracle cluster JDBC URL. This URL is a jdbc prefix
followed by the full TNS specification.
The JDBC URL must contain the ServiceName parameter referencing a
TNS entry on the specified Oracle host with the desired RAC
configuration.
For example:
jdbc:CA Clarity
PPM:oracle://racserver:1521;ServiceName=RAC1;BatchPerformanceWorkaround=true;InsensitiveRe
sultSetBufferSize=0;
ServerType=dedicated;supportLinks=true
An alternative is to embed the RAC servers in the URL itself with the
following DataDirect syntax:
jdbc:datadirect:oracle//server1:1521;AlternateServers=
(server2:1521,server3:1521,server4:1521);LoadBalancing=true;BatchPerformanceWorkaround=true;
InsensitiveResultSetBufferSize=0;ServerType=dedicated;
supportLinks=true
For more information, go to the DataDirect web site at datadirect.com
and search for information on using DataDirect Connect for JDBC with
Oracle Real Application Clusters (RAC).
8.
Click Save.
Your changes are saved.
9.
If desired, run a Health Report for each server in CA Clarity System
Administration to validate the database settings.
10. Do the following:
■
If using BEA WebLogic or IBM WebSphere application servers, make
the necessary changes to the connection pool and datasource
definitions using the same JDBC URL and restart all servers.
■
If using Apache Tomcat application server, restart all services in CA
Clarity System Administration.
Performance
Refer to the following topics for details on how to measure and maintain the
desired level of performance:
106 Installation Guide
Performance
Analyze the Oracle Database Schema
When running SQL statements against an Oracle database, the Oracle engine
needs to decide how a query (select/insert/update/delete) should be executed.
It uses what it calls an Optimizer to determine what the execution plan is to
be. There are different optimizer modes that are available. The required mode
for CA Clarity PPM is CHOOSE. This is the Oracle-recommended mode and is
the default value.
Optimizer mode CHOOSE relies on statistics about tables and indexes being
available. It uses those statistics to determine the best path of execution for a
query. Those statistics need to be refreshed under certain circumstances such
as when the schema changed or the data volume changed. The process of
refreshing those statistics is called analyzing the schema.
You can use one of the following methods to analyze the database schema:
■
Use the Oracle Table Analyze job. To schedule this job, your CA Clarity
PPM administrator must have granted you the access right to run this job
or you must be part of the Report and Job Administrator group. In
addition, you must be part of the Job Users group to get access to the
Reports and Jobs page.
It is recommended that you run this job at least once a week during a
period of lower user activity, such as on a weekend night.
■
Use the nikuadmin db analyze command line utility. Generally speaking,
there is no need to use this method over the job. This method performs
the same analyze command that the scheduled job performs. However,
during a CA Clarity PPM hot fix or patch release application, it may be
necessary to analyze the database without having CA Clarity PPM up and
running.
Note: See the Administration Guide for more information on scheduling jobs.
Set CPU Speed to Improve Oracle Performance
The optimizer in Oracle 10g and 11g uses both CPU and reads to determine
the cost of a query. In addition, it uses system load characteristics to attempt
to reduce the overall load. If the CPU speed setting is not set, the optimizer
performs poorly.
To set the CPU speed, run the gather system stats as follows:
execute dbms_stats.gather_system_stats('Start');
-- <some time delay while the database is under a typical workload>
execute dbms_stats.gather_system_stats('Stop');
Chapter 2: System Administration 107
Performance
Additional Oracle Parameters
The following parameters have been shown to have a positive performance
gain when running CA Clarity PPM on Oracle 10g and 11g. These parameters
are meant to be optional “tuning” parameters and should be used as needed
to achieve adequate database performance.
_b_tree_bitmap_plans=FALSE
Set: Oracle init
This is an undocumented Oracle setting that was previously set to TRUE in
Oracle 8. When monitoring execution plans, you may see something similar
to:
0 SELECT STATEMENT
BITMAP CONVERSION (TO ROWIDS)
1
0
2
1
BITMAP AND
BITMAP CONVERSION (FROM ROWIDS)
3
2
4
3
INDEX (RANGE SCAN) OF 'I1' (NON-UNIQUE)
BITMAP CONVERSION (FROM ROWIDS)
5
2
6
5
INDEX (RANGE SCAN) OF 'I2' (NON-UNIQUE)
Changing this setting to FALSE generates faster and more efficient execution
plans:
0 SELECT STATEMENT
1
0
AND-EQUAL
2
1
INDEX (RANGE SCAN) OF 'I1' (NON-UNIQUE)
3
1
INDEX (RANGE SCAN) OF 'I2' (NON-UNIQUE)
CURSOR_SHARING=FORCE
Set: Oracle Init
By setting this to FORCE, Oracle is essentially rewriting the executed queries
to and replacing any literals with bind values. If the queries executed are the
same (though values are different), only one shared query is created and is
shareable and used for all sessions. This turns a hard parse into a soft parse.
A soft parse will lock (or latch) the shared pool less than a hard parse and,
thus, provide a performance gain. Watch the Oracle AWR for excessive query
parsing to determine if this is a setting you should attempt to use.
Oracle defect 4752814
■
Set: Upgrade to Oracle 10.2.0.4 or acquire a one-off patch for an earlier
version.
■
If a patch is acquired, enable in the Oracle init via:
fix_control=”4752814:on”. Contact Oracle directly for further details.
This defect is present in Oracle 10.2.0.1 up to 10.2.0.3. This was fixed in
10.2.0.4.
108 Installation Guide
Performance
A query using a predicate with a VARCHAR2 column and an ANSI CHAR bind
variable can get result in a slow execution plan. It is highly recommended that
you upgrade to 10.2.0.4 to prevent this bug. In the event an upgrade is not
possible, you may be able to get a patch from Oracle for the version you are
running.
Analyze the Microsoft SQL Server Database Schema
Similar to Oracle, Microsoft SQL Server needs table and index statistics in
order to efficiently execute SQL statements. As a SQL Server DBA, you must
create a SQL Server job for updating statistics and re-indexing and run it on a
regular basis.
Enable the Datamart Parallel Option
The datamart extraction is I/O intensive as it needs to detect incremental
changes in the transactional tables and then write them to the Datamart
reporting tables. In a typical customer environment, there is sufficient CPU
power available to launch multiple parallel processes that access the disks in
parallel, thereby minimizing the overall Datamart runtimes.
Maintain Sufficient Memory
As with any other application, it is important to allocate sufficient physical
memory to each server in a CA Clarity PPM cluster. The amount of physical
memory required depends on how the cluster is configured. For example, what
services are running on which server and how large of an implementation
must be supported.
In this matter, there is one important rule to follow. That is, there must be
more physical memory installed in the server than is actually used by CA
Clarity PPM. In other words, do not rely on virtual memory since performance
degrades due to the operating system needing to swap memory with disk,
causing a significant slowdown of the application.
Memory consumption on Unix for each process, or the server overall, can be
checked with commands such as top or prstat.
In Microsoft Windows environments, use the Windows Task Manager. Navigate
to the Process tab to see the memory consumption per process or use the
Performance tab to see the memory configuration and consumption for the
entire server.
Chapter 2: System Administration 109
Performance
To modify the memory allocation for other services such as Business Objects,
Oracle, and Microsoft SQL Server, refer to the respective administration guides
for each product.
Before you alter the respective settings, shut down the service in question and
restart it after you modify the memory settings.
To adjust the amount of memory allocated to the CA Clarity
Application (app) or CA Clarity Background (bg) service
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Select the respective server using Cluster - Servers.
The Server: Properties page appears.
3.
4.
Do one of the following:
■
To adjust the memory on the application server, select the Application
tab on the toolbar.
■
To adjust the memory on the background server, select the
Background tab on the toolbar.
Enter the new memory allocation in the Java VM Parameters field, and
click Save.
The properties are saved.
5.
Select the Services tab.
The Server: Services page appears.
6.
Restart the app and bg services.
Restrict the Microsoft SQL Server Memory Consumption
Over time, Microsoft SQL Server consumes the entire available physical
system memory (and more), which results in operating system-level paging
that significantly slows down the database operations. For this reason, CA
recommends that you restrict the amount of memory required for Microsoft
SQL Server to allocate.
Depending on the version of your operating system, you may be able to
reserve about 200MB of memory for the operating system. Assuming that
Microsoft SQL Server is the only application running, 90% of the remaining
system memory should be allocated to Microsoft SQL Server.
For example: Your system has 2 GB of memory. After the OS memory has
been allocated, you have about 1.8 GB available. 90% of that or ~1.6 GB
should be allocated for Microsoft SQL Server.
110 Installation Guide
Performance
To restrict the amount of memory that Microsoft SQL Server allocates
1.
Open the Microsoft SQL Server Enterprise Manager application and rightclick the server name and select Properties.
2.
Select the Memory tab and use the slider bar to adjust the maximum
setting in the Dynamically Configure SQL Server Memory section to the
computed maximum setting.
3.
To confirm the changes, click OK.
Note: For more information about your Microsoft SQL Server system
configuration, go to Microsoft's TechNet website, and see the “SQL Server
2000 Operations Guide” section
(http://www.microsoft.com/technet/treeview/default.asp?url=/technet/prodtec
hnol/sql/maintain/operate/opsguide/default.asp).
Ensure Adequate Disk I/O Throughput
CA Clarity PPM is a mixed environment wherein users exercise the application
with a wide range of activities that range from:
Online Transactional Processing (OLTP)
Entering time sheets, entering financial transactions, collaborating on
documents, capacity planning to name a few.
Batch processing
Post Transactions to Financials, Datamart Extraction, and Import Financial
Actuals.
Data analysis
Reports, Queries, Graphs and Grids
Most of these activities present a fair amount of read/write load on the
database server. To allow for maximum throughput of those operations, CA
recommends that you configure your database server with a RAID 0+1 disk
configuration. This configuration provides striping of disks as well as the
appropriate failover mechanism in case of disk failures.
Chapter 2: System Administration 111
Performance
How to Ensure Optimal Database Server File Layout
Both Oracle and Microsoft SQL Server perform significantly better when their
table files are separated from the index files. You should also separate the log
files from the other two.
Use the following process to ensure optimal database server file layout:
1.
Place the Oracle table tablespace data files on separate disks (see
page 112) from the index tablespace data files.
2.
Create separate file groups for tables and indexes (see page 112) and
place them on different disks.
3.
Migrate the indexes to a new index file group (see page 112).
Oracle Tablespace Datafiles
Make sure that you place the table tablespace data files on separate disks
from the index tablespace data files. Redo the log and archive log files, which
you must place on yet another set of disks.
SQL Server Tablespace Datafiles
Create separate file groups for tables and indexes and place them on different
disks. Place the transaction logs on yet another set of disks.
Migrate CA Clarity PPM Indexes to New Index File Group
To migrate CA Clarity PPM indexes to a new index file group
1.
Open Microsoft SQL Server Enterprise Manager.
2.
Back up the CA Clarity PPM database.
3.
Right-click on the CA Clarity PPM database and select Properties.
4.
Click the Data Files tab.
5.
Click in to the new row below the CA Clarity PPM_Data file name and enter
the following information:
■
"CA Clarity PPM_Idx" as the file name.
■
The correct second disk location for the file named CA Clarity
PPM_Idx_Data.NDF.
■
A value for Space Allocated (the value should be at least 50% of the
primary data file’s allocation).
■
"IDX" next to Filegroup Name.
The name you enter must not be a Microsoft SQL Server keyword such as
"INDEX".
112 Installation Guide
Document Indexing, Searching, and Storage
Note: Do not change any of the other default settings.
6.
To create the new data file and the new filegroup, when all values are
entered, click OK.
7.
To verify that the data file and filegroup are created, right-click the CA
Clarity PPM database.
8.
Click the Data Files tab and verify that the new data file is created. Verify
that all the values you entered are present and correct.
9.
Click the Filegroups tab and verify that the new filegroup entered exists.
The default filegroup should be "PRIMARY".
10. Connect to the CA Clarity PPM database using SQL Query Analyzer as the
niku db user.
11. Execute the stored procedure CMN_MIGRATE_MSSQL_INDEXES_SP with
the new filegroup as a parameter:
EXECUTE CMN_MIGRATE_MSSQL_INDEXES_SP 'IDX'
When this stored procedures is run, all the indexes from the PRIMARY
filegroup are moved to the IDX filegroup on the second disk.
Executing this stored procedure may take a significant amount of time
depending on the size of the database.
Document Indexing, Searching, and Storage
You can index documents checked in through the Knowledge Store or
Document Manager, make them searchable, and migrate them to the
database.
Chapter 2: System Administration 113
Document Indexing, Searching, and Storage
Index Documents
The following methods are available to index documents:
To configure synchronous and asynchronous indexing
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Click Servers.
The Servers page appears.
3.
Click the Properties icon for the server you want to configure.
The Server: Properties page appears.
4.
Select the Documents and Search tab on the toolbar.
The documents and search Server: Properties page appears.
5.
In the Search Server section, do one of the following:
■
To index documents as they are checked in, leave the Use
Synchronous Indexing check box selected.
■
To index documents as a scheduled job, clear the Use Synchronous
Indexing check box.
This field specifies whether uploaded documents are to be indexed
immediately in-process, or whether they are to be queued for indexing
by the asynchronous background indexer.
6.
Click Save.
7.
Select All Services from the Home menu.
The All Services page appears.
8.
Restart all services; check the box next to each service and click Start.
Note: See the Administration Guide for more information.
114 Installation Guide
Document Indexing, Searching, and Storage
Recreate the Search Index
It is unlikely that you will ever need to recreate the search index during a CA
Clarity PPM installation. You should only recreate it when the instructions
provided with a CA Clarity PPM upgrade, patch, or hotfix release advise you to
recreate the index. Recreating the search index is a lengthy process that
should be run only as an overnight job.
To recreate the search index
Execute the following commands from the command line
nikuadmin search recreate-index-files
nikuadmin search recreate-index-data
Migrate the Filestore to the Database
Migrating the filestore is a lengthy process. You should only run this as an
overnight job. During migration, document links within CA Clarity PPM do not
work. It is recommended that you shut down the CA Clarity application server
until the migration process completes.
To migrate the filestore to the database
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Click the Properties icon for the server to which you want to migrate
filestores.
The Server: Properties page appears.
3.
Click the Documents and Search tab on the toolbar.
The documents and search Server: Properties page appears.
4.
Complete the following:
Store Files in Database
Defines whether to store files in the database. Make sure this check
box is selected. Normally, files are stored in the filestore on disk. In
the case of an upgrade where files are currently stored on disk, this
property must be set prior to the upgrade in order to move existing
files to the database, if such is desired.
5.
Click Save.
Chapter 2: System Administration 115
Datamart
6.
Restart the services:
a.
Select All Services from the Home menu.
The All Services page appears.
7.
b.
Check the box next to the CA Clarity Application (app) and CA Clarity
Background (bg) services.
c.
Click Start.
From the command line, issue the following command:
nikuadmin search migrate
The documents are migrated from the filestore to the database.
8.
Use a text editor to open the admin.log and see that the files were
successfully moved to the database.
Datamart
The Datamart extraction is extremely I/O intensive as it detects incremental
changes in the transactional tables and then writes those changes to the
Datamart reporting tables. In a typical customer environment, there is enough
CPU power to launch multiple parallel processes to access the disks in parallel,
therefore minimizing the overall Datamart runtimes.
Enable the Datamart Parallel Option for Oracle
To enable the Datamart parallel option for Oracle
1.
Log in to CA Clarity System Administration.
The Overview page appears.
2.
Stop all services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select all services by clicking the Select All icon, and click Stop.
The services are stopped.
3.
Add the following configuration parameter to the Oracle database
configuration file named init.ora:
job_queue_processes = [num of processors]
Note: This parameter should not be greater than the number of CPUs
available on the database server. You may not want to enable all CPUs on
the database server to be used for the parallel Datamart extraction if other
non-Datamart processes are expected to run at the same time as the
Datamart extraction.
116 Installation Guide
Datamart
CA recommends that you leave at least one CPU available for nonDatamart processing unless you run the Datamart extraction at night
during a period when no other activity takes place. If you do want to
reserve a processor for other processing, CA recommends a 3:4 ratio. For
example, on an eight-CPU database server, you can dedicate six
processors to the Datamart extraction. On a four-CPU database server,
dedicate three processors. On a two-CPU processor, use both processors,
assuming that there is very little other activity occurring other than the
Datamart extraction.
4.
Grant privileges to the schema owner. Log into SQL*Plus as the user sys
and execute the following SQL statements:
SQL>grant execute dbms_lock to NIKU;
SQL>grant select on v_$parameter to NIKU;
SQL>exit;
5.
Restart all services:
a.
Select All Services from the Home menu.
The All Services page appears.
b.
Select all services by clicking the Select All icon, and click Start.
The services are restarted.
The Datamart parallel option is enabled.
Enable the Datamart Parallel Option for Microsoft SQL Servers
Enabling parallel processing for the Datamart is optional but improves
performance of certain portions of the Datamart by setting them up to run in
parallel.
If the database server has more than one CPU available, then you can use
Microsoft SQL Server Enterprise Manager to start a Microsoft SQL Server Agent
process.
To enable the Datamart Parallel option for a Microsoft SQL server
1.
Use the system administration account to log into Microsoft SQL Server
Enterprise Manager and expand the sub-menu item of Management.
2.
To start the Microsoft SQL Server Agent process, right-click SQL Server
Agent and select Start.
If desired, you can set additional options via the Properties palette.
However, the Datamart does not rely on options contained in the Palette.
Chapter 2: System Administration 117
UI Themes
UI Themes
UI themes determine the look and feel of CA Clarity PPM pages. This section
provides examples of the stock UI themes that ship with CA Clarity PPM.
With UI themes, you can change the color, log in information, branding, and
other aspects of the user interface. You can also create a custom UI theme to
display in CA Clarity PPM.
Set the UI Theme
UI themes are defined in CA Clarity System Administration and are used in CA
Clarity PPM only. As the CA Clarity PPM administrator, you can specify which
themes to use in the application. You can also specify a theme for each
partition in a CA Clarity PPM implementation.
Note: See the Studio Developer's Guide for more information about selecting
and applying UI themes.
Create Custom UI Themes
You can create a custom UI theme by backing up and then replacing the
original CA Clarity PPM UI images in with new ones that are the same
dimensions. It is important that you use the original image file names so that
your customized images automatically display in the CA Clarity PPM UI. You
can also change the cascading style sheets to change the font and other
display characteristics of CA Clarity PPM pages.
The <clarity home>/webroot/ui/themes/ directory contains several
subdirectories of UI themes. Inside each of these subdirectories is a
ThemePreview.gif that shows you how the UI theme files in that directory will
appear.
Note: If you customize the default UI and you have a cluster of CA Clarity PPM
servers, you must distribute the changed files to all servers in the cluster.
To create a custom theme, you should have a good understanding of
cascading style sheets. To create the section headers with rounded edges, you
should also be proficient with a graphic editing tool. If not, you can contact a
CA Technology Services (CATS) engagement manager for assistance.
To create a custom UI theme
1.
On the CA Clarity System Administration application server, create a new
directory where you can save the stock UI theme files. For example:
<clarity home>/webroot/ui/themes/backup
118 Installation Guide
UI Themes
2.
Copy the files in the <clarity home>/webroot/ui/themes/default directory
into the directory you created.
3.
Find an existing UI that most closely matches your desired theme.
Check the ThemePreview.gif file in each <clarity
home>/webroot/ui/themes/ subdirectory for examples of available UI
themes.
4.
Copy the directory that contains the UI theme you prefer into the /default
directory.
Make sure you preserve the existing directory structure including all subdirectories and files in those sub-directories. For example:
copy <clarity home>/webroot/ui/themes/blue-dark
<clarity home>/webroot/ui/themes/default/
5.
Use a graphic editor and change the UI images as desired.
Important! You can create new images also, but your new images must
be the same size and filename as the ones you replace. If not, the
integrity of your new CA Clarity PPM interface is compromised.
6.
Change the cascading style sheet in the <clarity
home>/webroot/ui/themes/default/css directory to change fonts, link
colors, and other attributes:
Note: You can change the CSS styles but not the style names.
UI Item
CSS Styles
Header
.pageHeaderContent{background-color:#fff}
.pageHeaderText{color:#336699}
a.pageHeaderLink:Visited,a.pageHeaderLink:Link{color:#FF
F}
Footer
.pageFooterContent{backgroundcolor:#507298;color:#FFF}
.pageFooterLink{color:#FFF}
Inactive
menu
(disabled
menus)
.menu{}
table.menu td.menuTopLeftCorner {height:10px;fontsize:1px;}
table.menu td.menuLeftBorder {height:1px;font-size:1px;}
table.menu td.menuBottomLeftCorner {height:10px;fontsize:1px;}
table.menu a.menuItem:visited,
a.menuItem:link{width:100%;font-family: Arial, Helvetica,
sans-serif;font-size: 12px;color: #232323;textdecoration:none;}
Chapter 2: System Administration 119
UI Themes
UI Item
CSS Styles
.table.menu td{padding-right:13px;}
table.menu td.menuTopBorder{height:10px;font-size:1px;}
table.menu td.menuBottomBorder{height:10px;fontsize:1px;}
table.menu td.menu {color: #4B4B4B;fontweight:bold;font-family: Arial, Helvetica, sans-serif;fontsize: 13px;width:100%;}
table.menu td.menuDivider{background-image:
url(../images/MenuDivider.gif); background-position: right;
font-size:1px;height:5px;}
table.menu td.menuItemDivider{background-image:
url(../images/MenuItemDivider.gif); background-position:
right; font-size:1px;height:5px;}
Active menu
(enabled
menu items)
.menuOn{background-image:
url(../images/MenuTileSel.gif); background-position: right;}
table.menuOn td.menuTopLeftCorner {height:10px;fontsize:1px;background-image:
url(../images/MenuTopLeftCornerSel.gif); }
table.menuOn td.menuLeftBorder {height:1px;fontsize:1px;background-image:
url(../images/MenuLeftBorderSel.gif); }
table.menuOn td.menuBottomLeftCorner {height:10px;fontsize:1px;background-image:
url(../images/MenuBottomLeftCornerSel.gif); }
table.menuOn a.menuItem:visited,
a.menuItem:link{width:100%;font-family: Arial, Helvetica,
sans-serif; font-size: 12px;color: #232323;textdecoration:none;}
table.menuOn a.menuItem:hover{font-family: Arial,
Helvetica, sans-serif; font-size: 12px;color:#000;textdecoration: underline;}
a.menuItemOn:visited, a.menuItemOn:link {font-family:
Arial, Helvetica, sans-serif;font-weight:bold;font-size:
12px;color: #000 !important;text-decoration:none; width:
100%; }
a.menuItemOn:hover {text-decoration:underline;}
120 Installation Guide
UI Themes
UI Item
CSS Styles
table.menuOn td{padding-right: 13px;}
table.menuOn td.menuTopBorder{height:10px; backgroundimage: url(../images/MenuTopBorderSel.gif);font-size:1px;
background-position: right;width:100%; }
table.menuOn td.menuBottomBorder{height:10px;
background-image:
url(../images/MenuBottomBorderSel.gif);font-size:1px;
background-position: right;width:100%;}
table.menuOn td.menu {color: #4B4B4B; fontweight:bold;font-family: Arial, Helvetica, sans-serif;fontsize: 13px;width:100%;}
table.menuOn td.menuDivider{background-image:
url(../images/MenuDividerSel.gif); background-position:
right; font-size:1px;height:5px;}
table.menuOn td.menuItemDivider{background-image:
url(../images/MenuItemDividerSel.gif); backgroundposition: right;font-size:1px;height:5px;}
7.
Save your changes and close the file.
8.
Display any CA Clarity PPM page to see the results. If the files you
modified are not the currently-selected UI theme, to change themes:
a.
Select UI Themes from the CA Clarity Studio menu.
b.
Select the desired theme and then click Apply.
Change the Login Image
You can replace the image that displays on CA Clarity PPM's Login page with
an GIF image of your choice that is 913 x 508 pixels.
To replace the login image
1.
On the CA Clarity System Administration application server, create a new
directory where you can save the stock login file. For example:
<clarity home>/webroot/ui/themes/backupLogin
2.
Copy the stock login files from the <clarity
home>/webroot/ui/themes/default/images directory into the directory you
created in Step 1.
3.
Name your new login image Login.gif.
4.
Place your new login image in the <clarity
home>/webroot/ui/themes/default/images directory.
5.
Check your work by navigating to the CA Clarity PPM login page.
Chapter 2: System Administration 121
UI Themes
Change the Application Logo Image
The CA Clarity PPM logo (brand image) appears on the top left corner of the
screen when you have CA Clarity PPM open. You can replace the logo with a
different logo that is in GIF format and is 160W x 60H pixels in size.
Important! Do not change the style settings for this image in the
DefaultScreen.css file. It must remain a non-tiling background image that is
aligned at the bottom left.
To change the logo
1.
Log in to CA Clarity System Administration and create a new directory
where you can save the logo file. For example:
<clarity home>/webroot/ui/themes/backupLogo
2.
Copy the logo file from the <clarity
home>/webroot/ui/themes/default/images directory into the directory you
created in Step 1.
For example:
copy c:/<clarity home>/webroot/ui/default/themes/images/brand.gif
c:/<clarity home>/webroot/ui/themes/backupLogo
3.
Name your new logo image brand.gif.
4.
Place your new login image in the <clarity
home>/webroot/ui/themes/default/images directory.
5.
Check your work; display any CA Clarity PPM page.
Change the Background Tiling Image
When CA Clarity PPM pages are scaled to large sizes, the background image is
tiled (repeated) horizontally and vertically to fill the extra space. You can
change this image to one that meets the following specifications:
■
GIF format
■
100W x 80H pixels
■
A watermark or transparent image
To achieve a look that is similar to the default, use a transparent GIF with a
white font.
122 Installation Guide
UI Themes
To replace the background image file
1.
Log in to CA Clarity System Administration and create a new directory
where you can save the CA Clarity PPM logo file. For example:
<clarity home>/webroot/ui/themes/backupBackground
2.
Copy the original background image from the <clarity
home>/webroot/ui/themes/default/images directory into the directory you
created in Step 1.
For example:
copy <clarity home>/webroot/ui/default/themes/BrandTile.gif
<clarity home>/webroot/ui/themes/backupBackground
3.
Name your new background image BrandTile.gif.
4.
Place your new background image in the <clarity
home>/webroot/ui/themes/default/images directory.
5.
Check your work navigate in any CA Clarity PPM page.
Distribute Custom Themes to Servers in the Cluster
To distribute updated UI theme files to servers in the cluster
1.
Log in to CA Clarity System Administration, and click Distribute Themes
from the Distribution menu.
The Distribute Themes page appears.
2.
Select the desired servers and click Distribute.
A status window appears that shows the servers to which files are being
distributed. When all servers are updated, the status window automatically
closes.
Customize Theme Stylesheets
While you can modify the CSS style, do not change the name of the style.
When customizing the UI theme, you can change the content of an image. In
doing so, be sure to maintain the exact dimensions. If not, the balance and
usability of the CA Clarity PPM interface can be compromised.
Important! You can also replace a style that uses a background image with a
background color. Many of the styles use background images that must be
modified. Always retain the names of the image and the dimensions. Do not
change either!
Chapter 2: System Administration 123
UI Themes
The Header
To modify the header, edit the following portion of the CSS file:
Classes:
.pageHeaderContent{background-color:#fff}
.pageHeaderText{color:#336699}
a.pageHeaderLink:Visited,a.pageHeaderLink:Link{color:#336699}
The Footer
To modify the footer, edit the following portion of the CSS file:
Classes:
.pageFooterContent{background-color:#fff;color:#000}
.pageFooterLink{color:#336699}
Modify Active Menus
To modify an active menu, edit the following portion of the CSS file:
.menuOn{background-image: url(../images/MenuTileSel.gif); background-position: right; }
table.menuOn td.menuTopLeftCorner {height:10px;font-size:1px;background-image:
url(../images/MenuTopLeftCornerSel.gif); }
table.menuOn td.menuLeftBorder {height:1px;font-size:1px;background-image:
url(../images/MenuLeftBorderSel.gif); }
table.menuOn td.menuBottomLeftCorner {height:10px;font-size:1px;background-image:
url(../images/MenuBottomLeftCornerSel.gif); }
table.menuOn a.menuItem:visited, a.menuItem:link{width:100%;font-family: Arial, Helvetica, sans-serif; font-size:
12px;color: #232323;text-decoration:none;}
table.menuOn a.menuItem:hover{font-family: Arial, Helvetica, sans-serif; font-size: 12px;color:#000;textdecoration: underline;}
a.menuItemOn:visited, a.menuItemOn:link {font-family: Arial, Helvetica, sans-serif;font-weight:bold;font-size:
12px;color: #000 !important;text-decoration:none; width: 100%; }
a.menuItemOn:hover {text-decoration:underline;}
table.menuOn td{padding-right: 13px;}
table.menuOn td.menuTopBorder{height:10px; background-image: url(../images/MenuTopBorderSel.gif);fontsize:1px; background-position: right;width:100%; }
table.menuOn td.menuBottomBorder{height:10px; background-image:
url(../images/MenuBottomBorderSel.gif);font-size:1px; background-position: right;width:100%; }
table.menuOn td.menu {color: #4B4B4B; font-weight:bold;font-family: Arial, Helvetica, sans-serif;font-size:
13px;width:100%;}
table.menuOn td.menuDivider{background-image: url(../images/MenuDividerSel.gif); background-position: right;
font-size:1px;height:5px;}
table.menuOn td.menuItemDivider{background-image: url(../images/MenuItemDividerSel.gif); backgroundposition: right; font-size:1px;height:5px;}
124 Installation Guide
UI Themes
Modify Inactive Menus
To modify an inactive menu, edit the following portion of the CSS file:
.menu{}
table.menu td.menuTopLeftCorner {height:10px;font-size:1px;}
table.menu td.menuLeftBorder {height:1px;font-size:1px;}
table.menu td.menuBottomLeftCorner {height:10px;font-size:1px;}
table.menu a.menuItem:visited, a.menuItem:link{width:100%;font-family: Arial, Helvetica, sans-serif;font-size:
12px;color: #232323;text-decoration:none;}
table.menu a.menuItem:hover{font-family: Arial, Helvetica, sans-serif;font-size: 12px;color:#000;text-decoration:
underline;}
table.menu td{padding-right:13px;}
table.menu td.menuTopBorder{height:10px;font-size:1px;}
table.menu td.menuBottomBorder{height:10px;font-size:1px;}
table.menu td.menu {color: #4B4B4B;font-weight:bold;font-family: Arial, Helvetica, sans-serif;font-size:
13px;width:100%;}
table.menu td.menuDivider{background-image: url(../images/MenuDivider.gif); background-position: right; fontsize:1px;height:5px;}
table.menu td.menuItemDivider{background-image: url(../images/MenuItemDivider.gif); background-position:
right; font-size:1px;height:5px;}
Change Tab and Section Styles
You can change the appearance of tabs, subtabs, and sections in CA Clarity
PPM. Each tab and section is built using three background images; one for the
left side, one for the middle, one for the right. Fonts and font style are defined
in CSS styles. You can change the font, font size, color, and the URL that
displays when the user selects them.
To change table and submenus
1.
Use a text editor to open the Theme.css file.
2.
Change any of the following tab styles:
Visited links
a.tabLink:Visited,a.tabLink:Link{color:#333}
Hover color
a.tabLink:Hover{color:#000}
Chapter 2: System Administration 125
UI Themes
Selected tab
a.selTabLink:Visited,a.selTabLink:Link{color:#FFF}
.selTabBack{background-image:url(../images/SelTabBack.gif);}
.selTabLeftCap{background-image:url(../images/SelTabLeftCap.gif);}
.selTabRightCap{background-image:url(../images/SelTabRightCap.gif);}
.tabBack{background-image:url(../images/TabBack.gif);}
.tabLeftCap{background-image:url(../images/TabLeftCap.gif);}
.tabRightCap{background-image:url(../images/TabRightCap.gif);
3.
Change any of the following subtab styles:
Tab bar
.subTabBar{background-color:#7C8B77;color:#FFF}
Tab visited link
a.tabLink:Hover{color:#000}
Selected tab
a.subTabLink:Visited,a.subTabLink:Link{color:#FFF}
Tab hover color
a.subTabLink:Hover{color:#000}
Tab selected link
a.subTabLinkSel:Visited,a.subTabLinkSel:Link{color:#FFF;fontweight:bold}
4.
Change any of the following section titles styles:
Bar background color
.sectionTitleBarBack{backgroundimage:url(../images/SectionBarBack.gif);}
Title bar left cap
.sectionTitleBarLeftCap{backgroundimage:url(../images/SectionBarLeftCap.gif);}
Title bar right cap
.sectionTitleBarRightCap{backgroundimage:url(../images/SectionBarRightCap.gif);}
5.
Check your work; display any CA Clarity PPM application page. If the files
you modified are not the currently-selected UI theme, to change themes.
6.
Change any of the following section styles (.sectionBarBack changes the
background color of the entire section; a.button:Visited and
a.button:Link change the background of the buttons):
Section bar background
.sectionBarBack{background-color:#D7DEE1;color:#666}
126 Installation Guide
UI Themes
Section bar button visited link
a.sectionBarBtn:Visited,a.sectionBarBtn:Link{color:#000}
Section bar visited link
a.sectionBarLink:Visited,a.sectionBarLink:Link{color:#000}
Section gradient button color
a.button:Visited,a.button:Link{backgroundimage:url(../images/ButtonGradient.gif)}
7.
Save your changes and close the file.
8.
Check your work and display any CA Clarity PPM page.
Customize Graphs
You can change the look of graph titles and legends.
Chapter 2: System Administration 127
UI Themes
To change graph styles
1.
Use an editor to open the DefaultScreen.css file.
2.
Change any of the graph styles.
The graph title
.graphTitleBox{ fill:#768572; }
The graph content box
.graphContentBox { fill:#ADB5AB; }
The graph legend text color
.graphLegendBox { fill:#D0D0D0; }
The graph text color
.graphText{ fill: #000; }
Graph item text
.graphItem0 { fill:#000000; }
.graphItem1 { fill:#DD0000; }
.graphItem2 { fill:#2F98D3; }
.graphItem3 { fill:#50B238; }
.graphItem4 { fill:#897FC6; }
.graphItem5 { fill:#FFCC00; }
.graphItem6 { fill:#EF8A8A; }
.graphItem7 { fill:#9ACDEA; }
.graphItem8 { fill:#ACDAA0; }
.graphItem9 { fill:#C9C5E5; }
.graphItem10 { fill:#FFE786; }
.graphItem11 { fill:#9F3535; }
.graphItem12 { fill:#4B7F9C; }
.graphItem13 { fill:#5B8B50; }
.graphItem14 { fill:#777294; }
.graphItem15 { fill:#B09735; }
Graph lines
.graphLine0 { stroke:#000000; }
.graphLine1 { stroke:#DD0000; }
.graphLine2 { stroke:#2F98D3; }
128 Installation Guide
UI Themes
.graphLine3 { stroke:#50B238; }
.graphLine4 { stroke:#897FC6; }
.graphLine5 { stroke:#FFCC00; }
.graphLine6 { stroke:#EF8A8A; }
.graphLine7 { stroke:#9ACDEA; }
.graphLine8 { stroke:#ACDAA0; }
.graphLine9 { stroke:#C9C5E5; }
.graphLine10 { stroke:#FFE786; }
.graphLine11 { stroke:#9F3535; }
.graphLine12 { stroke:#4B7F9C; }
.graphLine13 { stroke:#5B8B50; }
.graphLine14 { stroke:#777294; }
.graphLine15 { stroke:#B09735; }
3.
Save your changes and close the file.
4.
Check your work and display any CA Clarity PPM graph.
Chapter 2: System Administration 129
Chapter 3: Third-party Software
This section describes how the operating system, database, and other required
software must be setup on the CA Clarity PPM server and client.
License key information is required to install some of the third party software
products. To locate the license keys, see the LicenseKeyReadMe.txt file in the
Licenses directory of the CA Clarity PPM DVD.
This section contains the following topics:
Server Operating Systems (see page 131)
Server Database Software (see page 133)
Server Database Connectivity (see page 139)
Application Server Software (see page 142)
Java 2 SDK (J2SE) (see page 158)
How to Install Business Objects Software (see page 162)
Server Operating Systems
Refer to the CA Clarity PPM Product Architecture Stack for information about
the operating systems and the versions that are supported by CA Clarity PPM.
Unix Environment Requirements
The Unix environment consists of the following requirements:
Install Required Patches
We recommend that you keep your systems up to date with the latest patches
available. Refer to your vendor’s documentation for more information.
Update Environment Variables for Unix
To update the environment variables
Edit your Unix user’s .profile file and add or modify the following system
variables:
JAVA_HOME
This is necessary for shell scripts to locate the correct Java home
directory.
Example (Solaris platform):
Chapter 3: Third-party Software 131
Server Operating Systems
JAVA_HOME=/<jdk 1.5 home directory>
export JAVA_HOME
The following table lists the default Java home locations for the supported
unix platforms. This location may vary according to how your own software
is installed.
Unix Vendor
Default JAVA_HOME
Sun Solaris
/usr/jdk1.5.0_11
Red Hat Linux
/usr/jdk1.5.0_11
SUSE Enterprise Linux 9
/usr/jdk1.5.0_11
HP-UX
/opt/java14
IBM AIX
/usr/java14
PATH
This is necessary to locate the command line utilities. Add the following
information to the beginning of the existing PATH system variable:
Example (all platforms):
PATH=/<clarity home>/bin:%JAVA_HOME%/bin:$PATH
export PATH
Windows Environment Requirements
The Windows environment consists of the following requirements:
Update Environment Variables for Windows
To update the environment variables, open the Windows System Control Panel
and add or modify the following system variables in the Windows
environment:
JAVA_HOME
JAVA_HOME is not a path variable. It points to the JDK home directory
only. Therefore, only the home directory can be present in the JAVA_HOME
value and it must not contain the ";" character.
Name: JAVA_HOME
Value: <jdk 1.5 home directory>
132 Installation Guide
Server Database Software
PATH
This is necessary to locate the command line utilities. Add the following
information to the beginning of the existing PATH system variable:
Name: PATH
Value: <clarity home>\bin;%JAVA_HOME%\bin;%PATH%
Server Database Software
CA Clarity PPM supports the following database software:
■
Oracle
■
MS SQL Server
How to Configure Oracle on Unix
Configuring Oracle on Unix for CA Clarity PPM consists of the following tasks:
■
Set Oracle prerequisites (see page 134).
■
Address Database Configuration Requirements (see page 134).
■
Create the database (see page 135).
■
Configure an Oracle net service name (see page 137).
■
Create the Database user (see page 137).
Note: The instructions in this section apply to Oracle 9i and higher.
Chapter 3: Third-party Software 133
Server Database Software
Set Oracle Prerequisites
CA Clarity PPM requires the following of the system running Oracle
1.
Oracle 9i or higher is installed and operating on the target systems. CA
does not provide documentation for installing Oracle. For assistance, refer
to Oracle Support documentation.
2.
For proper extended character handling on any system running an Oracle
client or server, the NLS language setting in the OS must be "UTF-8".
On Unix, edit the Unix user profile to add the NLS_LANG variable:
NLS_LANG=AMERICAN_AMERICA.UTF8
EXPORT NLS_LANG
On Windows, change the registry settings as follows:
a.
b.
c.
Start the registry editor:
■
From the Start menu select Run.
■
Enter "regedit" and press Enter.
Go to HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOME0.
Change the value for key NLS_LANG to:
AMERICAN_AMERICA.UcTF8
Database Configuration Requirements
CA Clarity PPM ships with an Oracle database creation template containing all
required configuration parameters. If for any reason you cannot use this
template, make sure to manually set the following parameters for your new
database:
134 Installation Guide
Name
Value
Character Set
UTF8
National Character Set
UTF8
nls_date_format
YYYY-MM-DD HH24:MI:SS
nls_sort
BINARY
nls_comp
BINARY
query_rewrite_enabled
true
Server Database Software
Create the CA Clarity PPM Database
To create the CA Clarity PPM database using the template
1.
Insert the CA Clarity PPM Install DVD into the drive.
2.
Copy the database creation template to the Database Configuration
Assistant template directory. The template on the CA Clarity PPM Install
DVD in the OracleTemplates directory.
(Unix)
cp <dvd drive>/OracleTemplates/Unix/*.* <oracle home>/assistants/dbca/templates
(Windows)
copy <dvd drive>\OracleTemplates\Windows\*.* <oracle_home>\assistants\dbca\templates
3.
Launch the Oracle Database Configuration Assistant:
(Unix)
<oracle_home>/bin/dbca &
(Windows)
Start Menu > Programs > Oracle > Oracle Home > Configuration and
Migration Tools > Database Configuration Assistant
The Oracle Database Configuration Assistant Welcome screen appears.
4.
If a specific Oracle Database Configuration Assistant screen is not listed in
the following table, accept all the default values and click Next.
Note: If you receive the Ora-29807: Specified Operator Does Not Exist
error message, click Ignore to continue.
5.
Use the following information to create the CA Clarity PPM database:
Oracle Database
Configuration
Assistant Screen
Option
Value/Choice
Operations
Create a database
Selected
Database Templates
CA Clarity PPM - Oracle 9i Selected
or
CA Clarity PPM - Oracle
10g
or
CA Clarity PPM - Oracle
11g
Initialization Parameters Typical
Selected
Chapter 3: Third-party Software 135
Server Database Software
Oracle Database
Configuration
Assistant Screen
Option
Initialization Parameters Percentage of physical
memory for Oracle
Value/Choice
If this database is the
only one running on this
machine: 70
If there are additional,
or any non-Oracle
database processes
running on this
machine, adjust
accordingly.
136 Installation Guide
Initialization Parameters Database Type
Multipurpose
Creation Options
Create Database
Selected
Creation Option
Button
Finish
Summary
Button
Ok. The Database
Creation progress
window appears.
Database Configuration
Assistant (new window)
Various Passwords
Use password sys for
user sys and system for
user system. (You can
change this setting at
any time through
SQL*Plus).
Server Database Software
Configure an Oracle Net Service Name
On Windows, the Database Configuration Assistant automatically creates a
service name called "CA Clarity PPM". If this is sufficient, you can skip this
step.
To configure an Oracle Net Service Name
1.
Launch the Oracle Net Configuration Assistant:
(Unix)
<oracle home>/bin/netca &
(Windows)
Start Menu > Programs > Oracle > Oracle Home > Configuration and
Migration Tools > Net Configuration Assistant
2.
Use the following information to create the TNS entry:
Oracle Net
Configuration
Assistant Screen
Option
Value/Choice
Welcome
Local Net Service
Name Configuration
Selected
Net Service Name
Configuration
Service Name
Enter the service name
entered during the Oracle
database installation.
Default: niku
TCP/IP
Host Name
<database server name>
Create the Database User
To create the database user
1.
Connect to the Oracle database as system:
sqlplus system/system
2.
Use the following SQL statements to create an Oracle database user with
proper permissions:
CREATE USER <username> IDENTIFIED BY <password> DEFAULT TABLESPACE <default
tablespace> TEMPORARY TABLESPACE <temporary tablespace>;
GRANT RESOURCE, CREATE SESSION, CONNECT TO <username>;
GRANT UNLIMITED TABLESPACE, QUERY REWRITE TO <username>;
GRANT CREATE TABLE, CREATE VIEW, CREATE TRIGGER TO <username>;
COMMIT
Chapter 3: Third-party Software 137
Server Database Software
How to Configure Microsoft SQL Server
Configuring MS SQL Server for CA Clarity PPM consists of the following tasks:
■
Addressing SQL Server prerequisites (see page 138).
■
Setting database options (see page 138).
SQL Server Prerequisites
CA Clarity PPM requires the following of the system running SQL Server:
■
SQL Server 2005 should be installed and operating on the target systems.
Note: CA does not provide documentation for installing SQL Server. For
assistance, refer to Microsoft Support and documentation.
■
A valid login for use by CA Clarity PPM should exist. This login can be
named anything, with any password. However, you must name the
subsequent database user name tied to this login for the CA Clarity PPM
database niku.
CA Clarity PPM Database Options
Important! CA Clarity PPM does not support mixed collations. If you have
changed the server level default from “SQL_Latin1_General_CP1_CI_AS” to
another collation, you must select “SQL_Latin1_General_CP1_CI_AS” when
creating the database.
You should create the CA Clarity PPM database with the following required
options:
Option
Value / Choice
ARITHABORT
ON
ANSI NULLS
To apply, execute:
QUOTED IDENTIFIER
ALTER DATABASE <database>
SET ARITHABORT ON
ALTER DATABASE <database>
SET ANSI_NULLS ON
ALTER DATABASE <database>
SET QUOTED_IDENTIFIER ON
Compatibility level
90
To apply, execute:
EXEC SP_DBCMPTLEVEL <database>, 90
138 Installation Guide
Server Database Connectivity
Option
Value / Choice
Database user name
niku
The login name can be anything but the database
username must be niku.
Database user roles
db_owner
The database user must have the ability to alter the
Clarity-schema and otherwise own the database.
SQL Server 2005 only
Option
Value/Choice
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.
Server Database Connectivity
This section describes how to install and configure the database client software
to connect to the database server.
Configure Database Connectivity to Oracle
The Oracle client software is required on the server where Business Objects is
installed for communication with the Oracle database.
Note: See the BIEK installation documentation for more information.
To configure the database connectivity to Oracle, you must meet certain
prerequisites and configure an Oracle net listener and an Oracle service name.
Chapter 3: Third-party Software 139
Server Database Connectivity
Prerequisites
For proper extended character handling the NLS language setting in the OS
must be UTF-8.
On Unix, edit the Unix user profile to add the NLS_LANG variable:
NLS_LANG=AMERICAN_AMERICA.UTF8
EXPORT NLS_LANG
On Windows:
a.
Start the registry editor:
■
From the Windows Start menu select Run.
■
Enter "regedit" and press Enter.
b.
Go to HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOME0.
c.
Change the value for key NLS_LANG to:
AMERICAN_AMERICA.UTF8
Configure an Oracle Net Listener Service
During an Oracle installation, the Oracle Net Configuration Assistant is
normally launched automatically to create the default listener. If you already
have a TNS Listener configured on this server, you can skip this procedure.
To configure an Oracle Net Listener service
1.
Launch the Oracle Net Configuration Assistant:
(Unix)
<oracle home>/bin/netca &
(Windows)
Start Menu > Programs > Oracle > Oracle Home > Configuration and
Migration Tools > Net Configuration Assistant
2.
140 Installation Guide
Use the following information to create the TNS Listener:
Screen
Option
Value/Choice
Welcome
Listener Configuration Selected
Listener Configuration,
Listener
Add
Selected
Listener Configuration,
Listener Name
Listener Name
<choose a name>
Server Database Connectivity
Configure an Oracle Net Manager Service Name
To configure an Oracle Net Manager service name
1.
Launch the Oracle Net Manager
(Unix)
<oracle home>/bin/netasst &
(Windows)
Start Menu > Programs > Oracle > Oracle Home >
Configuration and Migration Tools > Net Manager
2.
Use the following information to create the Oracle Net Manager service
name.
Oracle Net Configuration
Assistant Screen
Option
Value/Choice
Net Service Name Wizard
Service Name
clarity
Protocol
Protocol
TCP/IP
Protocol Settings
Host Name
Server IP Address or DNS
Hostname
Protocol Settings
Port
Server Port
Service
Service Name
clarity
Configure Database Connectivity to Microsoft SQL Server on Windows
Note: See Windows Help for more information on creating data source to SQL
server using the administrative tools.
To configure database connectivity to the Microsoft SQL ODBC on
Windows
1.
From the Windows Start menu, select Settings, Control Panel,
Administrative Tools, and then Data Sources (ODBC).
The ODBC Data Source Administrator window appears.
2.
Click the System DSN tab and click Add.
The Create New Data Source window appears.
3.
Select SQL Server as the driver for which you want to set up a data
source, and click Finish.
The Create a New Data Source to SQL Server window appears.
Chapter 3: Third-party Software 141
Application Server Software
4.
Complete the following fields and click Next:
Name
clarity
Description
CA Clarity PPM
Server
Select the name of the database server to which you want to connect
from the drop-down.
The next window in the series appears.
5.
Complete the following and click Next:
How should SQL Server verify the authenticity of the login ID?
Defines whether to verify authenticity during login. Choose With SQL
Server authentication using a login ID and password entered by the
user.
Login ID
<username>
Password
<password>
The next window in the series appears.
6.
Verify the value displayed next to Default Database is the Clarity database.
If not, select Change the Default Database To and select the correct
database from the list.
7.
To complete the installation, follow the instructions on the screen.
Application Server Software
CA Clarity PPM is tightly integrated with the Apache Tomcat application server.
You can select the Generic J2EE option to use BEA WebLogic or IBM
WebSphere. This section provides instructions for installing and configuring
these servers.
Install Apache Tomcat
This section outlines the procedure for installing the Apache Tomcat
application server.
142 Installation Guide
Application Server Software
Install the Apache Tomcat Application Server
You can install the Apache Tomcat application server that ships with CA Clarity
PPM.
To install Tomcat
1.
Insert the CA Clarity PPM Install DVD into the drive.
2.
Copy the file apache-tomcat-5.5.17.zip file to your hard drive. You can
copy it to the root directory or create an application directory (/tomcat).
3.
Extract the .zip file using the following command:
jar xvf <dvd drive>/Tomcat/apache-tomcat-5.5.17.zip
The apache-tomcat-5.5.17 application is created in the folder where you
extracted the files. This folder becomes the Apache Tomcat home
directory.
Install BEA WebLogic
Use the BEA WebLogic documentation to install and maintain BEA WebLogic.
The topics in this section only supplement and contain information that pertain
to CA Clarity PPM implementations. Before you begin, make sure that BEA
WebLogic is installed and operates properly.
Configure BEA WebLogic
This section contains instructions for configuring BEA WebLogic Server 9.2 for
CA Clarity PPM.
System Configuration
CA Clarity PPM requires that the BEA WebLogic classpath property be modified,
and that certain Java system properties be set in the application server's JVM
process. To do this, use one of the following methods:
■
Change the BEA WebLogic startup scripts to modify the classpath and
include the system properties.
■
Configure the node manager to add the system properties as the server
process is launched.
Note: For instructions on these methods, refer to the BEA WebLogic Server
9.2 documentation.
Chapter 3: Third-party Software 143
Application Server Software
BEA WebLogic System Classpath
CA Clarity PPM includes its own branded DataDirect JDBC drivers for Oracle
and Microsoft SQL Server. You must place these .jar files on the BEA WebLogic
system classpath, as described in the BEA WebLogic documentation on
registering JDBC drivers. For example, you can modify the PATCH_CLASSPATH
variable in the setDomainEnv.cmd or setDomainEnv.sh scripts as follows:
Setting
Value
Classpath
<jars_location_on_server_machine>/c-base.jar
<jars_location_on_server_machine>/c-util.jar
<jars_location_on_server_machine>/c-sqlserver.jar
<jars_location_on_server_machine>/c-oracle.jar
<jars_location_on_server_machine>/c-clarity.jar
<jars_location_on_server_machine>/c-spy.jar
Important! See the BEA WebLogic SSL documentation for details on FIPS
140-2 mode of operation and for instructions for installing the BEA
recommended compatible FIPS 140-2 provider.
Required JVM Properties
The required Java virtual machine properties are listed below. These must be
set during BEA WebLogic startup. For example, you may modify the
setDomainEnv.cmd or setDomainEnv.sh script, and set the Heap and PermGen
space arguments in the USER_MEM_ARGS variable.
Important! After setting these properties, restart the server before
continuing.
144 Installation Guide
Property
Value
Purpose
Minimum
Heap Size
-Xms<size in megabytes>m
The minimum amount of
system memory that can
be allocated to this VM
instance. CA recommends
that you use 512 MB for
most installations.
Example: -Xms512m
Application Server Software
Property
Value
Purpose
Maximum
Heap Size
-Xmx<size in megabytes>m
The maximum amount of
system memory that can
be allocated to this VM
instance. For most CA
Clarity PPM installations,
this setting for the
application service should
be 1536m (1.5GB) or
higher.
Example: -Xmx1536m
-Xmx1536 is the
maximum memory
allowed per jvm in a 32bit windows installation.
Having a setting larger
than this in a Windows
environment can cause
problems with starting
the app service.
The Maximum amount of
system memory that is to
The required setting is 128MB
be allocated to this VM
except for the HP JVM, which you
instance for the PermGen
should set to 192MB. This setting is
space.
not applicable for IBM or BEA
JRockit JVMs.
Maximum
Permanent
Generation
Size
-XX:MaxPermSize=128m
File
Encoding
-Dfile.encoding=UTF-8
This file encoding
property for the server
VM must be "UTF-8" to
ensure that any extended
unicode characters
entered or displayed in
CA Clarity PPM are
handled properly as
multi-byte characters.
Prefer
iPv4Stack
-Djava.net.preferIPv4Stack=true
This argument is required
for IBM AIX and Linux
JVMs only to ensure
proper function of
multicast messaging
between CA Clarity PPM
services on one or more
machines.
Chapter 3: Third-party Software 145
Application Server Software
Property
Value
Purpose
Headless
AWT Mode
-Djava.awt.headless=true
This headless AWT
property ensures that the
AWT engine within the
VM is aware that it is a
server-side process.
Otherwise, some actions
within CA Clarity PPM will
throw errors when the
AWT expects a windowing
toolkit to be available.
Configure the JDBC Connection Pool and Datasource
This section describes the steps to configure the JDBC Data Source in the
Admin console for Oracle and SQL Server.
To configure the JDBC Data Source in the Admin console for Oracle
1.
Choose Services -> JDBC -> Data Sources and set the following values:
Field Name
Description
JDBC Data Source Properties
Name
<Data_Source_name>
Example: ClarityOracleDS
JNDI Name
jdbc/NikuDS
Database Type
Oracle
Database Driver
Other
Transaction Properties
Supports Global Transactions
Cleared
Connection Properties
Database Name
<db_name>
Example: niku
Host Name
<db_server_URI>
Port
<db_port_number>
Example: 1521
146 Installation Guide
Database User Name
<db_user>
Password
<db_password>
Application Server Software
Field Name
Description
Driver Class Name
com.ca.clarity.jdbc.oracle.OracleDriver
URL
jdbc:clarity:oracle://<db_server_URI>:
<db_port_number>
JDBC Driver Connection Properties
The following properties are case sensitive.
serverType
dedicated
user
<db_user>
insensitiveResultSetBufferSize
0
supportLinks
true
SID
<db_SID>
batchPerformanceWorkaround
true
2.
Specify the target server(s) for application deployment.
3.
Save and Activate changes.
4.
Change the BEA WebLogic JDBC connection pool properties via the BEA
WebLogic Data Source Properties tab as follows:
Setting
Value
Purpose
Max Capacity
Between 50 and 1000 You can tune this setting according
to the size of your CA Clarity PPM
installation. The default setting of
"15" is not sufficient and must be
changed.
Statement
Cache Size
0
Remove
Infected
Connections
Enabled
Cleared
This setting determines the number
of JDBC prepared statements that
may be cached per connection.
Setting this to a non-zero number
improves performance for small
applications, but wastes resources
when running CA Clarity PPM that
executes a large number of
statements.
Chapter 3: Third-party Software 147
Application Server Software
To configure the JDBC Data Source in the Admin console for SQL
Server
1.
Choose Services -> JDBC -> Data Sources and set the following values:
Setting
Value
JDBC Data Source Properties
Name
<Data_Source_name>
Example: ClaritySQLServerDS
JNDI Name
jdbc/NikuDS
Database Type
SQL Server
Database Driver
Other
Transaction Properties
Supports Global Transactions
Cleared
Connection Properties
148 Installation Guide
databaseName
<db_name>
serverName
<db_server_URI>
2.
Specify the target server(s) for application deployment.
3.
Save and Activate changes.
4.
Change the BEA WebLogic JDBC connection pool via the BEA WebLogic
Data Source Properties tab as follows:
Setting
Value
Purpose
Max Capacity
Between 50 and 1000 You can tune this setting according
to the size of your CA Clarity PPM
installation. The default setting of
"15" is not sufficient and must be
changed.
Statement
Cache Size
0
This setting determines the number
of JDBC prepared statements that
may be cached per connection.
Setting this to a non-zero number
improves performance for small
applications, but wastes resources
when running CA Clarity PPM that
executes a large number of
statements.
Application Server Software
Setting
Value
Remove
Infected
Connections
Enabled
Cleared
Purpose
Deploy the Application to WebLogic
Deploy CA Clarity PPM according to the staging mode and target servers as
instructed in the WLS server deployment configuration (such as staging or no
staging, Admin server or Managed server).
Note: Refer to the WebLogic Server Deployment Guide.
Important! You can only deploy CA Clarity System Administration to the
same machine as the original CA Clarity PPM deployment. It can be the Admin
server or a Managed server.
Install IBM WebSphere
Use the IBM WebSphere documentation to install and maintain IBM
WebSphere. The topics in this section only supplements and contain
information that pertain to CA Clarity PPM implementations. Before you begin,
make sure that IBM WebSphere is installed and operates properly.
Configure IBM WebSphere 6.1
This section outlines the procedures for configuring IBM WebSphere 6.1 to
enable the deployment of CA Clarity PPM. The following configuration process
uses the IBM WebSphere 6.1 Admin console.
Chapter 3: Third-party Software 149
Application Server Software
Configure the JDBC jars classpath
CA Clarity PPM includes its own branded DataDirect JDBC drivers for Oracle
and Microsoft SQL Server. The jar files must be placed on the IBM WebSphere
system classpath, as described below.
1.
Choose AdminConsole -> Environment -> Websphere Variables.
2.
Set the user-defined JDBC DRIVER PATH to
<jars_location_on_server_machine>
Example: ${WAS_LIBS_DIR}/ext.
3.
Make sure that the following jar files are in the directory you specified in
Step 2:
■
c-base.jar
■
c-util.jar
■
c-sqlserver.jar
■
c-oracle.jar
■
c-clarity.jar
■
c-spy.jar
Configure the JVM Properties
This section describes the steps to configure the Java Virtual Machine (JVM)
properties.
1.
Choose AdminConsole -> Application Servers -> server1 -> Java
and Process Management -> Process Definitions -> Java Virtual
Machine.
2.
Set the following properties:
Property
150 Installation Guide
Value
Purpose
Minimum Heap <size in megabytes>
Size
Example: 512
The minimum amount of
system memory that can
be allocated to this VM
instance. CA recommends
that you use 512 MB for
most installations.
Maximum
Heap Size
The maximum amount of
system memory that can
be allocated to this VM
instance. CA recommends
that you use 1536 MB for
most installations.
<size in megabytes>
Example: 1536
Application Server Software
Property
Value
Purpose
Generic JVM
Arguments
-Dfile.encoding=UTF-8
This file encoding property
for the server VM must be
"UTF-8" to ensure that
any extended unicode
characters entered or
displayed in CA Clarity
PPM are handled properly
as multi-byte characters.
-Djava.net.preferIPv4Stack=true This argument is required
for IBM AIX and Linux
JVMs only to ensure
proper function of
multicast messaging
between CA Clarity PPM
services on one or more
machines.
-Ddefault.client.encoding=UTF-8
This file encoding property
for the server VM must be
"UTF-8" to ensure that
any extended unicode
characters entered or
displayed in CA Clarity
PPM are handled properly
as multi-byte characters
-Djava.awt.headless=true
This headless AWT
property ensures that the
AWT engine within the VM
is aware that it is a
server-side process.
Otherwise, some actions
within CA Clarity PPM will
throw errors when the
AWT expects a windowing
toolkit to be available.
Important! Restart the server before continuing.
Configure the JDBC Provider
This section describes the steps to configure the JDBC provider in the Admin
console, for Oracle and SQL Server.
Chapter 3: Third-party Software 151
Application Server Software
Set JDBC Provider Values for Oracle
To configure the JDBC provider in the Admin console for Oracle
1.
Choose AdminConsole -> JDBC -> JDBC Providers and set the
following values:
Setting
Value
Database Type
User-defined
Implementation
Class Name
com.ca.Clarity.jdbcx.oracle.OracleDataSource
Name
<JDBC data provider name>
Example: CA Clarity PPM Oracle JDBCProvider
Description
No specific requirements
Classpath
${User-defined_JDBC_DRIVER_PATH}/c-base.jar
${User-defined_JDBC_DRIVER_PATH}/c-util.jar
${User-defined_JDBC_DRIVER_PATH}/c-oracle.jar
${User-defined_JDBC_DRIVER_PATH}/c-clarity.jar
${User-defined_JDBC_DRIVER_PATH}/c-spy.jar
2.
Click Finish and Save to the master configuration.
Set JDBC Provider Values for SQL Server
To set JDBC provider values
1.
Select AdminConsole -> JDBC -> JDBC Providers and set the following
values:
Setting
Value
Database Type
User-defined
Implementation
Class Name
com.ca.Clarity.jdbcx.sqlserver.SQLServerDataSource
Name
<JDBC data provider name>
Example: Clarity SQLServer JDBCProvider
Description
152 Installation Guide
No specific requirements
Application Server Software
Setting
Value
Classpath
${User-defined_JDBC_DRIVER_PATH}/c-base.jar
${User-defined_JDBC_DRIVER_PATH}/c-util.jar
${User-defined_JDBC_DRIVER_PATH}/c-sqlserver.jar
${User-defined_JDBC_DRIVER_PATH}/c-clarity.jar
${User-defined_JDBC_DRIVER_PATH}/c-spy.jar
2.
Click Finish and save to the master configuration.
3.
Restart the server before continuing.
Configure the JDBC Data Sources
This section describes the steps to configure the JDBC Data Sources.
Set Oracle Database Properties
To Set Oracle Database Properties:
1.
Select AdminConsole -> JDBC -> Data Sources.
2.
Select the scope for the Data Source from the selection list, typically the
server1 Cell, and click New.
3.
Set the following properties:
Setting
Value
Name
<Data Source Name>
Example: ClarityOracleDS
JNDI Name
jdbc/NikuDS
Component-managed
Authentication alias and XA
recovery authentication alias
None
JDBC Provider
<Clarity Oracle JDBC provider>
Data Store Helper Class Name
com.ibm.websphere.rsadapter.GenericData
StoreHelper
Use This Data Source in
Container Managed Persistence
(CMP)
Selected
Chapter 3: Third-party Software 153
Application Server Software
4.
Click Finish and Save to the master configuration.
Important! After configuring the Data Source, restart the server before
proceeding.
Configure the Data Source and Connection Pool Properties
1.
Select AdminConsole -> JDBC -> Data Sources ->
<Data_Source_Name> -> Custom Properties.
2.
Define the following properties. These properties are case sensitive.
Property
Value
Type
serverName
<DB_System_NAME>
String
user
<dbUser>
String
password
<dbUserPassword>
String
enable2Phase
False
Boolean
portNumber
<dbPortNumber>
String
Example: 1521
SID
<oracle_db_SID>
String
insensitiveResultSetBufferSize
0
Integer
batchPerformanceWorkaround
True
Boolean
serverType
dedicated
String
supportLinks
True
Boolean
3.
Save the changes to the master configuration.
4.
Select AdminConsole -> JDBC -> Data Sources -> ClarityOracleDS > WebSphere Application Server Data Source Properties and set the
following:
Statement Cache Size = 0
Note: This setting determines the number of JDBC prepared statements
that may be cached per connection. Setting this to a non-zero number
improves performance for small applications, but it wastes resources when
running applications like CA Clarity PPM that execute a large number of
statements.
5.
154 Installation Guide
Save the changes to the master configuration.
Application Server Software
6.
Select AdminConsole -> JDBC -> Data Sources -> ClarityOracleDS > Connection Pool Properties and set the following:
Max Connections = Between 50 and 1000
Note: You can tune this setting according to the size of your CA Clarity
PPM installation. The default setting of "10" is not sufficient and must be
changed.
7.
Save the changes to the master configuration.
8.
Restart the server before continuing.
Set SQL Server Properties
To Set SQL Server Properties
1.
Select AdminConsole -> JDBC -> Data Sources.
2.
Select the scope for the Data Source from the selection list, typically the
server1 Cell, and click New.
3.
Set the following properties:
Setting
Value
Name
<Data_Source_Name>
Example: ClaritySQLServerDS
JNDI Name
jdbc/NikuDS
Component-managed
Authentication alias and XA
recovery authentication alias
None
JDBC Provider
<Clarity SQLServer JDBC provider>
Data Store Helper Class
Name
com.ibm.websphere.rsadapter.GenericDataSto
reHelper
Use This Data Source in
Container Managed
Persistence (CMP)
Selected
4.
Click Finish and Save to the master configuration.
Note: After configuring the Data Source, restart the server before
proceeding.
Chapter 3: Third-party Software 155
Application Server Software
Configure the Data Source and Connection Pool Properties
This section describes the steps to configure the JDBC Data Source and
Connection pool properties.
1.
Select AdminConsole -> JDBC -> Data Sources ->
<Data_Source_Name> -> Custom Properties.
2.
Define the following properties:
These properties are case sensitive.
Property
Value
Type
serverName
<DB_serverURI>
String
user
<dbUser>
String
password
<dbUserPassword>
String
enable2Phase
False
Boolean
portNumber
<dbPortNumber>
String
Example: 1433
insensitiveResultSetBufferSize
0
Integer
databaseName
<dbName>
String
programName
Clarity
String
3.
Save the changes to the master configuration.
4.
Select AdminConsole -> JDBC -> Data Sources -> ClarityOracleDS > WebSphere Application Server Data Source Properties and set the
following:
Statement Cache Size = 0.
This setting determines the number of JDBC prepared statements that
may be cached per connection. Setting this to a non-zero number
improves performance for small applications, but it wastes resources when
running applications like CA Clarity PPM that execute a large number of
statements.
5.
Save the changes to the master configuration.
6.
Select AdminConsole -> JDBC -> Data Sources -> ClarityOracleDS > Connection Pool Properties and set the following:
Max Connections = Between 50 and 1000.
You can tune this setting according to the size of your CA Clarity PPM
installation. The default setting of "10" is not sufficient and must be
changed.
156 Installation Guide
Application Server Software
7.
Save the changes to the master configuration.
8.
Restart the server.
Deploy CA Clarity PPM to IBM WebSphere
Note: See the directions in the IBM WebSphere documentation for more
information on how to deploy CA Clarity PPM on IBM WebSphere.
The following is an example of a typical CA Clarity PPM deployment using the
Admin console.
1.
Choose AdminConsole -> Enterprise Applications -> Install.
2.
Prepare for application installation as follows:
a.
Choose Remote -> Enter Path to specify the path to the application.
Example: <clarity home>/Runtime/install/niku.ear
3.
b.
Select the "Prompt me only when additional information is required"
option.
c.
Click Next.
Install the new application:
a.
Step 1: Select the installation options and click Next.
b.
Step 2: Map modules to servers as follows:
c.
■
Choose the Clarity Web and select the target, typically the server1
cell.
■
(Actuate customers only) Choose the acweb.war and select the
target, typically the server1 cell.
■
Click Next.
Step 3: Map resource references to resources as follows:
■
Select "None" as the Authentication Method.
■
Choose Module -> Clarity Web -> Browse.
Select <Clarity Oracle DS>
■
(Actuate customers only) Choose Module -> acweb.war ->
Browse.
Select <Clarity Oracle DS>"
■
Select the Clarity Web check box.
■
(Actuate customers only) Select the acweb.war check box.
■
Click Next.
Chapter 3: Third-party Software 157
Java 2 SDK (J2SE)
d.
e.
Step 4: Map virtual hosts for Web modules as follows:
■
Select the Clarity Web check box.
■
(Actuate customers only) Select the acweb.war checkbox.
■
Click Next.
Step 5: Map Summary:
■
Click Finish.
■
Save to the master configuration.
Important!
1.
Restart the server to start CA Clarity PPM while in production mode. You
can use the Admin Console to stop CA Clarity PPM and to redeploy a new
version, but the server must be restarted to start CA Clarity PPM. This is
due to the initialization of the CA Clarity PPM classloader in IBM
WebSphere.
2.
You must deploy CA Clarity System Administration to the same machine as
the original CA Clarity PPM deployment. You must also deploy it to a
separate IBM WebSphere server in production mode due to the same
initialization of the classloader.
Java 2 SDK (J2SE)
Depending on your specific environment, Install or update the Java 2 SDK
software by referring to one of the listed sections:
Upgrade from Previous JDK Versions
When upgrading JDK on all platforms listed below, the new version of the JDK
should be installed next to, or in place of, the old JDK. The JAVA_HOME and/or
PATH environment variables must be updated to point to the new JDK version.
158 Installation Guide
Java 2 SDK (J2SE)
Install the Java 2 SDK for Solaris
To install the J2SE SDK on Solaris systems
1.
Insert the CA Clarity PPM Install DVD into the drive or download the latest
SDK version from your vendor’s website.
2.
Log in to the server as root, and go to the following directory:
cd /usr
3.
Run the following script from the DVD as shown below, or from your
download location.
<dvd drive>/Java/jdk-1_5_0_11-solaris-sparc.sh (32-bit)
<dvd drive>/Java/jdk-1_5_0_11-solaris-sparcv9.sh (64-bit)
4.
Install the 32-bit version followed by the 64-bit version. The 64-bit version
is optional, and allows for greater than 4 BG of physical memory allocation
for any Java process. However the 32-bit version must be installed prior to
the 64-bit version. The JDK is installed by default in the following
directory:
/usr/jdk1.5.0_11
The JDK installation is complete. You are prompted to install the public
JRE.
5.
(Optional and not required by CA Clarity PPM) Click Public JRE and do the
following:
■
Select Don't install this feature now to not install it.
■
Enter the install directory to install it.
Install the Java 2 SDK for Linux
To install the J2SE SDK on Linux systems
1.
Insert the CA Clarity PPM DVD into the drive or download the latest SDK
version from your vendor’s website.
2.
Log in to the server as root.
3.
Go to the following directory:
cd /usr
4.
Run the following script from the DVD as shown below, or from your
download location.
<dvd drive>/Java/jdk-1_5_0_11-linux-i586.bin (32-bit)
5.
The JDK is installed by default in the following directory:
/usr/jdk1.5.0_11
Chapter 3: Third-party Software 159
Java 2 SDK (J2SE)
After the JDK installation is complete, you are prompted to install the public
JRE. The Public JRE install is optional and not required by CA Clarity PPM. If
you do not want to install it, click “Public JRE” and select "Don't install this
feature now". If you choose to install the Public JRE, it will prompt you for an
install directory after the JDK install is completed.
Install the Java 2 SDK for HP-UX
To install the J2SE SDK on HP-UX systems
1.
Insert the CA Clarity PPM DVD into the drive or download the latest SDK
version from your vendor’s website.
2.
Log in to the server as root.
3.
Execute sam (System Administration Manager) and choose Software
Management -> Install Software to Local Host.
4.
When prompted for the source, choose Local DVD or your download
location.
5.
Enter the path to the DVD location as shown below, or to your download
location.
<dvd drive>/Java/jdk15_15004_ia.depot (Itanium)
The JDK is installed by default in the following directory:
/opt/java1.5
After the JDK installation is complete, you are prompted to install the public
JRE. The Public JRE install is optional and not required by CA Clarity PPM. If
you do not want to install it, click “Public JRE” and select "Don't install this
feature now". If you choose to install the Public JRE, it will prompt you for an
install directory after the JDK install is completed.
Install the Java 2 SDK for IBM AIX
To install the Java J2SE SDK on IBM AIX systems
1.
Download the latest Java 5 SDK installp image from IBM. You must accept
the IBM license terms prior to doing so. Transfer the image to the target
server when complete.
2.
Log in to the server as root.
3.
Go to the following directory:
cd /usr
4.
Extract the following SDK tar file from the DVD as shown below, or from
your download location.
tar xvf <download directory>/Java/Java5.sdk.tar (32-bit)
tar xvf <download directory>/Java/Java5_64.sdk.tar (64-bit)
160 Installation Guide
Java 2 SDK (J2SE)
5.
Install the 32-bit version or the 64-bit version using smitty. The 64-bit
version allows for greater than 4 BG of physical memory allocation for any
Java process. The JDK is installed by default in the following directory:
/usr/java5
After the JDK installation is complete, you are prompted to install the public
JRE. The Public JRE install is optional and not required by CA Clarity PPM. If
you do not want to install it, click “Public JRE” and select "Don't install this
feature now". If you choose to install the Public JRE, it will prompt you for an
install directory after the JDK install is completed.
Install the Java 2 SDK for Windows
To install the J2SE SDK on Windows systems
1.
Insert the CA Clarity PPM DVD into the drive or download the latest SDK
version from your vendor’s website.
2.
Run the following script from the DVD as shown below, or from your
download location.
<dvd drive>\Java\jdk-1_5_0_11-windows-i586-p.exe
3.
Follow the instructions on the screen. The JDK is installed by default in the
following directory:
C:\program files\java\jdk1.5.0_11
After the JDK installation is complete, you are prompted to install the public
JRE. The Public JRE install is optional and not required by CA Clarity PPM. If
you do not want to install it, click “Public JRE” and select "Don't install this
feature now". If you choose to install the Public JRE, it will prompt you for an
install directory after the JDK install is completed.
Chapter 3: Third-party Software 161
How to Install Business Objects Software
How to Install Business Objects Software
This section explains how to install and configure Business Objects software on
Windows and UNIX systems. The Business Objects software resides in the CA
Business Intelligence Embedding Kit (BIEK). When you install BIEK, Business
Objects Crystal and Web Intelligence are installed automatically.
Note: See the BIEK documentation for information on the free disk space
required for installation.
Note: If you are changing from Actuate to the Business Objects Report
Server, see Change Report Servers.
The following high-level steps explain how to install and configure Business
Objects on CA Clarity PPM:
1.
Install Business Objects on one of the following platforms:
■
Windows (see page 162)
■
UNIX (see page 164)
2.
Configure the ODBC connections (Windows or Oracle client software only)
(see page 163).
3.
Verify the installation is working (see page 165).
4.
Configure Business Objects (see page 166).
5.
Configure CA Clarity PPM for Business Objects (see page 166).
Install Business Objects on Windows
To install
1.
Copy the cabi-windows.zip file to a directory.
2.
Extract the .zip file to the same directory.
You can delete the .zip file after the extraction if your system is low on
space.
3.
Navigate to <install directory>\Disk1\InstData\VM and start the setup file.
The Business Intelligence by CA installation program appears.
4.
Click OK and complete the information requested in the installation wizard.
Note the following windows in the wizard:
BusinessObjects XI Administrator Password
Enter the administrator password. The password is user-defined. Make
a note of the password you enter. It will be required on the reporting
Server: Properties page in CA Clarity System Administration.
162 Installation Guide
How to Install Business Objects Software
Web Server Configuration
Accept the default ports that appear on this page.
CMS Database Settings
Enter the value niku in each field on the window.
5.
On the Review Settings window, review the installation information and
click Install.
6.
When the installation is complete, restart the system.
Configure ODBC Connections for SQL Server
The following procedure indicates how to configure the ODBC connections on
the server after you have completed the Business Objects installation on
Windows.
Note: There is no ODBC DSN requirement when you are connecting to Oracle.
To configure ODBC connections for SQL Server
1.
Click Control Panel from the Windows Start menu.
2.
Click Administrative Tools.
3.
Click Data Sources (ODBC).
4.
Click the System DSN tab.
5.
Click Add and select SQL Server.
6.
Complete the following fields and click Next:
Name: niku
Server: Your database server name
7.
Select the SQL server authorization option, enter the user ID and
password (niku/<MSSQL database password>), and click Next.
8.
Select the Change Default Database to check box, select niku from the
drop-down list, and click Next.
9.
Click Next again.
10. Click Test ODBC to verify that the connection works.
11. Click Finished.
Chapter 3: Third-party Software 163
How to Install Business Objects Software
Install Business Objects on UNIX
To install Business Objects on UNIX
1.
Open a telnet or a SSH session on a machine running an X-Host (like
Reflection or cygwin) to the server you are installing to.
2.
FTP the cabi-<UNIX flavor>.tar to /<installation directory>/BOinstaller (or
another slice which has the space).
3.
Extract the .tar file to the same directory.
You can delete the .tar file after the extraction if your system is low on
space.
4.
Navigate to /<installation directory>/BOinstaller/Disk1/InstData/VM and
run the setup file using the following command:
sh install.bin -i swing
X-window loads on the host and the installation program appears.
Note: If you cannot run an X-Host, you may need to use the command
line installer. If so, do not include "-i swing" in the command.
5.
Click OK and complete the information requested in the installation wizard.
Note the following windows in the wizard:
BusinessObjects XI Administrator Password
Enter the administrator password. The password is user-defined. Make
a note of the password you enter. It will be required on the reporting
Server: Properties page in CA Clarity System Administration.
Web Server Configuration
Accept the default ports that appear on this page.
CMS Database Settings
Enter the value niku in each field on the window.
6.
On the Review Settings window, review the installation information and
click Install.
Note: The installation process can take over an hour to complete.
164 Installation Guide
How to Install Business Objects Software
7.
Navigate to the Business Objects bobje home directory (for example,
/bo/CommonReporting/bobje) and edit the setup/env.sh file to add the
following Java VM argument to the JAVA_OPTS environment variable:
-Djava.awt.headless=true
This variable ensures that chart graphics can be generated on the UNIX
server and sent to the report viewer DHTML client in the Web browser.
Complete Post-Installation Configuration for UNIX
After Business Objects is installed, perform the following tasks:
■
Ensure that the UNIX user running Business Objects has read permissions
on the Oracle client directory and all files beneath the directory.
■
Ensure that the $ORACLE_HOME/lib32 directory is on the system library
path. In AIX, this variable is LIBPATH. For other UNIX vendors, the
variable is LD_LIBRARY_PATH. This is necessary because Business Objects
runs only 32-bit Oracle Libraries.
To set the library path environment variable
1.
Append the variable to the existing environment using one of the
following expressions:
–
LIBPATH=$LIBPATH:$ORACLE_HOME/lib32 (for AIX)
–
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/lib32
(for all other supported UNIX environments)
2.
Open a new terminal session and verify the path environment variable
includes the Oracle client directory.
3.
Restart all Business Object services.
Verify the Business Objects Installation
You can verify the installation by logging in to Business Objects InfoView. If
the installation is successful, you can log in and browse through the folders in
InfoView.
To verify the installation
1.
Bring up the Business Objects InfoView log on screen using the following
URL:
http://<servername>:8080/businessobjects/enterprise115/desktoplaunch/
InfoView/logon/logon.do
2.
Log in using Administrator as the user ID and the password created during
the Business Objects installation.
Chapter 3: Third-party Software 165
How to Install Business Objects Software
Configure Business Objects
To configure Business Objects for CA Clarity PPM
1.
Bring up the Business Objects log in dialog box using the following URL:
http://<servername>:8080/businessobjects/enterprise115/admin/en/admi
n.cwr
2.
Log in using Administrator as the user ID and the password created during
the Business Objects installation.
3.
Click the Servers link in the left navigation pane.
4.
Make the following changes:
Note: These settings are the recommended settings for a typical Business
Objects environment. The settings may need updating based on your
reporting environment.
Crystal Cache Server
Maximum Cache Size Allowed: 512200 (default=256000)
Minutes before and Idle Connection is Closed: 10 (default=20)
Page Server
Minutes before an Idle Connection is Closed: 10 (default=20)
Minutes before and Idle Report Job is Closed: 20 (default=60)
Report Application Server (RAS)
Number of database records to read when previewing or refreshing a
report: Unlimited (default=20000)
Number of records per batch:1000 (default=100)
Configure CA Clarity PPM for Business Objects
To configure CA Clarity PPM for Business Objects
1.
Log in to CA Clarity System Administration, and click Servers in the Home
menu.
The Servers page appears with a list of servers.
2.
Click the name of the CA Clarity PPM administration server.
The Server: Properties page appears.
3.
Click the Reporting tab.
The reporting Server: Properties page appears.
166 Installation Guide
How to Install Business Objects Software
4.
Complete the following fields on the window:
Vendor
Indicates the vendor for the reporting software. Select Business
Objects.
Values: Business Objects and Actuate.
Default: Business Objects
Home Directory
Indicates the home directory for Business Objects. Provide the path to
the directory where you installed the Business Objects server.
Service URL
Indicates the Web Services URL. Use the following URL:
http://<servername>:8080/dswsbobje/services/session.
CMS
Indicates the server and port number for the Central Management
Server. Use the following format: <servername>:6400.
Database ID
The CA Clarity PPM database ID used to retrieve database information
when executing reports. Select Niku as the ID.
Values: Niku
Web URL
Indicates the base URL where reports will be displayed. Use the
following URL: http://<servername>:8080
5.
Click Save.
6.
Restart the Clarity application (app) and background (bg) services.
Chapter 3: Third-party Software 167
Chapter 4: Client Applications
This section describes how to install and remove client applications. You must
have administrative access rights on the local machine to perform the
procedures in this section.
This section contains the following topics:
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity
PPM Schedule Connect (see page 169)
Download Adobe SVG Viewer (see page 176)
Remove Client Applications (see page 176)
Open Workbench, CA Clarity PPM Microsoft Project
Interface, and CA Clarity PPM Schedule Connect
The following topics provide information on the client applications that are
supported on Windows only.
Common Client Application Installation Scenarios
The following outlines the most common client application installation
scenarios:
Local
Files are installed locally on the user’s client workstation.
Admin
Files are installed on a network drive for client installation.
Client
Most files remain on a network shared drive (a minimum number of files
are installed on the user’s client workstation).
Chapter 4: Client Applications 169
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
Push
A third-party tool, such as Microsoft SMS or IBM Tivoli, is used to
distribute the client application as either a local or client installation.
Scenarios
"Install from the CA Clarity PPM Server"
(see page 170)
Installation Type
Local
Admin
Client
Push
Yes
No
No
No
Yes
Yes
No
No
No
Yes
Yes
"Install from the CA Clarity PPM Install
DVD" (see page 171)
"Install from a File Server" (see page 171) Yes
CA Clarity PPM users must enable the CA Clarity PPM Microsoft Project
Interface macro, MSPAdd2k.mpp, on new and upgraded installations.
Note: See the Using CA Clarity PPM with Open Workbench and Microsoft
Project Guide for more information on setting up Microsoft Project with CA
Clarity PPM Microsoft Project Interface.
Install Client Applications from CA Clarity PPM
You can download and install Open Workbench and then CA Clarity PPM
Microsoft Project Interface from CA Clarity PPM.
To download and install client applications from CA Clarity PPM
1.
Log in to CA Clarity PPM, and select Account Settings from the Personal
menu.
The Account Settings: Personal Information page appears.
2.
Click Software Downloads from the content menu.
The Account Settings: Software Downloads page appears.
3.
Do one of the following:
■
To download Open Workbench, select Open Workbench.
■
To download CA Clarity PPM Microsoft Project Interface, select Clarity
Microsoft Project Interface.
Note: You can save the file to a local drive or start the installation. If you
save the file to disk, continue to the next step in this procedure.
Otherwise, follow the instructions on the screen.
170 Installation Guide
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
4.
To install:
■
Open Workbench, run:
<download drive>:\<downloadpath>\wbsetup.exe
■
CA Clarity PPM Microsoft Project Interface, run:
<download drive>:\<downloadpath>\mspsetup.exe
Install Client Applications from the CA Clarity PPM Install DVD
You can install Open Workbench, CA Clarity PPM Microsoft Project Interface, or
CA Clarity PPM Schedule Connect from the CA Clarity PPM Install DVD.
To install a client application from the CA Clarity PPM Install DVD
1.
Insert the CA Clarity PPM Install DVD into the drive, and do one of the
following:
■
To install Open Workbench:
<dvd drive>:\Clients\OpenWorkbenchandScheduleConnect\owbsetup.exe
■
To install CA Clarity PPM Microsoft Project Interface:
<dvd drive>:\Clients\MSPInterface\mspsetup.exe
■
To install CA Clarity PPM Schedule Connect:
<dvd drive>:\Clients\ScheduleConnect\scheduleconnectsetup.exe
Install Client Applications from the File Server
You can install Open Workbench, CA Clarity PPM Microsoft Project Interface, or
CA Clarity PPM Schedule Connect from the file server by creating a network
installer. The procedure extracts all files and copies them to the network
location.
To remove a file server installation, delete the files from the network drive on
which you installed them.
Keep the following points in mind as the installation progresses:
■
Be sure to install each client into its own empty network directory. Choose
any drive to which you have write access.
■
No registry settings are changed and no programs are registered as
installed on the system.
Chapter 4: Client Applications 171
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
To install a client application from the file server
1.
Insert the CA Clarity PPM Install DVD into the drive, and create a network
installer by running one of the following installation scripts:
■
To install Open Workbench:
<dvd drive>\Clients\OpenWorkbenchandScheduleConnect\wbsetup.exe /a
■
To install CA Clarity PPM Microsoft Project Interface:
<dvd drive>\Clients\MSPInterface\mspsetup.exe /a
■
To install CA Clarity PPM Schedule Connect:
<dvd drive>\Clients\ScheduleConnect\scheduleconnectsetup.exe /a
The files are extracted and copied to the network folder.
2.
Issue the following command:
msiexec /package "Clarity Microsoft Project Interface.msi"/qn INSTALLDIR=p:\yourinstalldir
3.
Follow the instructions on the screen.
4.
Perform the push client application installation.
Types of Client Application Installations
After you install the client applications from the file server, you can install the
client applications from the network drive. The file server installation supports
the following types of installations:
■
Local
■
Client workstation
■
Push
Install Client Applications Locally or from the Client Workstation
To perform a local client application installation or an installation from
the client workstation
1.
Start any of the following installation processes:
■
To install Open Workbench:
\\<fileserver>\clarity\wbsetup.exe
or, if Microsoft Windows Installer 2.0 is installed on the client:
\\<fileserver>\clarity\Open Workbench.msi
■
To install CA Clarity PPM Microsoft Project Interface:
\\<fileserver>\clarity\mspsetup.exe
or, if Microsoft Windows Installer 2.0 is installed on the client:
\\<fileserver>\clarity\Niku MSP Interface.msi
172 Installation Guide
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
■
To install CA Clarity PPM Schedule Connect:
\\<fileserver>\clarity\scheduleconnectsetup.exe
or, if the Microsoft Windows Installer 2.0 is installed on the client:
\\<fileserver>\clarity\Schedule Connect.msi
Note: The MSI installers use Microsoft Windows Installer 2.0. If you do
not have this product already installed on the client workstation, it is
automatically installed. You must reboot the client workstation.
The Custom Setup screen appears.
2.
Specify one of the following installation options:
Note: You can change this option only when running from an
Administrative installation.
■
Install Local
Open Workbench or CA Clarity PPM Microsoft Project Interface is
installed locally on your hard drive.
■
Run from the Network
Open Workbench or CA Clarity PPM Microsoft Project Interface is
installed on the network or on your workstation.
Note: If you run the installation from the CA Clarity PPM Install DVD,
you cannot select Run from the Network.
3.
If you selected Run From the Network, to specify where to install Open
Workbench or CA Clarity PPM Microsoft Project Interface on the local
workstation, then select Data and indicate where the data directory is to
be created.
Note: The data directory is always installed locally for Open Workbench
even if you select Run From the Network.
4.
Do one of the following:
a.
To change the default setting from Install Local to Run From the
Network, issue one of the following command line parameters:
wbsetup.exe /vADDSOURCE=ALL
or,
msiexec /I "Open Workbench.msi" ADDSOURCE=ALL
b.
To force the default value to Install Local, issue one of the following
command line parameters:
wbsetup.exe /vADDLOCAL=ALL
or,
msiexec /I "Open Workbench.msi" ADDLOCAL=ALL
Chapter 4: Client Applications 173
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
c.
To overwrite the default installation directory contained in the setup
file, run one of the following command line parameters:
wbsetup.exe /vINSTALLDIR=C:\DEFAULT\DIR
or,
msiexec /I "Open Workbench.msi" INSTALLDIR=C:\DEFAULT\DIR
The default installation directory is overwritten and a different
installation directory is used.
Perform Push Client Application Installations
You must first install your client applications from a file server before
performing the push client application installation.
Use the command line properties in the following table, or an .MST file, to
modify the .msi setup scripts. You can use an .MST to add or change registry
keys including those listed in the table below. This table lists the registry keys
that you can use to facilitate a push installation or silent install. This is not
intended to be an exhaustive list. The listed registry keys are the primary
items that are most likely to be used during a push installation.
Use the values in this table to set the default values for a push installation.
This global approach is often used in place of the Microsoft Transform (MST)
solution.
For example:
HKEY_CURRENT_USER\Software\Niku\Schedulers\Host="myclarityhost"
174 Installation Guide
Registry Group:
HKEY_CURRENT_USER\Software\Niku\Schedulers
Registry Key
Value
Command Line
Property
LoginName
CA Clarity PPM user name
NIKUUSER
Host
CA Clarity PPM server name
NIKUHOST
ProxyHost
Proxy server name
NIKUPROXY
ProxyLoginName
Proxy server user name
NIKUPROXYUSER
ProxyPassword
Proxy server password
NIKUPROXYPASSWORD
HostPort
CA Clarity PPM port (defaults
to 80 when set to 0)
NIKUPORT
ProxyHostPort
Proxy server port (this field is
left empty when set to "0")
NIKUPROXYPORT
Open Workbench, CA Clarity PPM Microsoft Project Interface, and CA Clarity PPM Schedule Connect
Registry Group:
HKEY_CURRENT_USER\Software\Niku\Schedulers
UseSSL
Use Secure Sockets Layer (0 = NIKUSSL
False, 1 = True)
Create a .MST File
For these registry keys, string entries are left empty by default while dword
entries are 0 by default (except for HostPort, which defaults to 80). You can
set each value via the command line during an installation in the same way
that you can set the INSTALLDIR property.
Example 1
msiexec /I "Open Workbench.msi" NIKUHOST=myserver NIKUPORT=8080
Example 2
This example shows you how to use quotation marks around the string to pass
two properties, NIKUHOST and NIKUPORT.
wbsetup.exe /v"NIKUHOST=myserver NIKUPORT=8080"
When the user logs into CA Clarity PPM from Open Workbench for the first
time, the server and port addresses contain the correct values.
Example 3
To pass a path to a property, consider the following example.
Note: Enter the quotation marks that contain the path and the entire path on
one line.
wbsetup.exe /v"INSTALLDIR=\"d:\My Install Dir\" NIKUHOST=myserver NIKUPORT=8080"
To create a .mst file
1.
Make a copy of Open Workbench.MSI and assign it a unique name.
2.
Open the new file in a tool that can modify msi files, such as Orca.
3.
Modify the file to add or change registry settings and to set global
properties, as necessary.
4.
Use the Microsoft Windows Installer SDK to create the mst file.
Note: See the documentation provided with the Microsoft Windows
Installer SDK for details.
Chapter 4: Client Applications 175
Download Adobe SVG Viewer
Download Adobe SVG Viewer
Use the Adobe SVG Viewer to display graph portlets in CA Clarity PPM. You can
download the SVG Viewer from CA Clarity PPM. Do this from the Account
Settings: Software Downloads page. Alternatively, you can separately install
the SVG Viewer directly from Adobe Systems.
Note: The Adobe SVG Viewer license is held by your company and not by CA.
Note: See the Common Features and Personal Options User Guide for more
information on how to download software from CA Clarity PPM.
Remove Client Applications
You can remove any of the following client applications:
■
Open Workbench
■
CA Clarity PPM Microsoft Project Interface
■
CA Clarity PPM Schedule Connect
■
CA Clarity XML Open Gateway
■
Adobe SVG Viewer
To remove a client application
Use Add or Remove Programs on the Microsoft Windows Control Panel.
Note: Refer to Microsoft Windows online help for assistance.
176 Installation Guide
Chapter 5: Server Properties
Use this section as a reference when manipulating the configurable application
server properties in CA Clarity System Administration. The tables describe all
properties in CA Clarity PPM. They specify which properties must be identical
across all servers and which properties, when altered, require services to be
restarted. You can modify application server properties using the Server:
Properties page in the CA Clarity System Administration, either for the local CA
Clarity application server or a remote server.
The properties are grouped as described in the following sections. Each
properties group is contained on a separate page, each of which can be
accessed from the Server: Properties page’s toolbar.
This section contains the following topics:
CA Clarity System Administration Server Properties (see page 178)
System (see page 179)
Database Server Properties (see page 182)
Application Server Properties (see page 189)
Documents and Search (see page 196)
Server Reporting Options (see page 198)
Server Security Options (see page 200)
Background (see page 207)
Chapter 5: Server Properties 177
CA Clarity System Administration Server Properties
CA Clarity System Administration Server Properties
Use the CA Clarity System Administration Server: Properties page to set up
the server’s CA Clarity System Administration options, such as defining the
server’s multicast address and port. To view this page, click the NSA tab on
the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Field Name
Description
Synchronize
in Cluster?
Multicast Address Multicast address used by nsa Yes
service to discover Beacon
services in cluster. Must be in
the Class D address range,
that is, addresses between
224.0.0.0 and
239.255.255.255. Every
server in a cluster must have
the same address value.
Services
to
Restart
beacon
Default: 230.0.1.1
Multicast Port
Yes
Multicast port used in
conjunction with the multicast
address. Must be a unique
port on a machine.
Bind Address
Optional IP address or name
specifying a local network
interface. This is useful when
more than one network
interface is present, and one
specific interface must be
chosen. You must select a
bind address on a server with
multiple NIC cards.
beacon
No
beacon
No
beacon
Note: When you use IPv6
Link Local addresses, the
zone ID used must be the
same for all addresses in a
cluster of servers.
Beacon Service
Name
178 Installation Guide
The unique name of the
Beacon service. On Windows
systems, this is the name of
the Windows Service.
System
Field Name
Description
Synchronize
in Cluster?
Services
to
Restart
Beacon Port
Controller port used by the
Beacon service on each
server.
No
beacon
System
Use the system Server: Properties page to set up the server’s system options,
such as setting up CA Clarity PPM to support multiple currencies. To view this
page, log in to CA Clarity System Administration, and click the System tab on
the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Java Section
Field Name
Description
Synchronize
in Cluster?
Services to
Restart
Java Home
Directory
The location of the Java
SDK.
No
beacon, app, and
bg
No
beacon, app, and
bg
No
beacon, nsa, app,
and bg
The default values are:
D:\jdk1.5.0_11
(Windows)
/usr/jdk1.5.0_11
(Solaris, Linux)
/opt/java1.5 (HP-UX)
/usr/java1.5 (IBM AIX)
Java VM
The desired Java VM to
use when launching the
application and
background services.
Default: Server
perferIPv5Stac For pure IPv4
k
environments, this
property must be set to
true. For pure IPv6 and
mixed IPv4/IPv6
environments, this
property must be set to
false. The default is true.
Chapter 5: Server Properties 179
System
General Section
Field Name
Description
Synchronize
in Cluster?
Services to
Restart
Multi-currency
Enabled
Determines if support for
multiple currency is
enabled in this CA Clarity
PPM installation. Once
you have enabled multicurrency, and with the
database installed, you
cannot disable multicurrency.
Yes
app
The default value is
"Cleared".
Mail Server Section
Field Name
Description
Synchronize
in Cluster?
Services to
Restart
Hostname
The name of the mail
server host.
No
app and bg
Yes
app and bg
Use
Determines whether the
Authentication username and password
are used to authenticate
to the given mail server.
No
app and bg
User
Mail server username.
For example: "CA Clarity
PPM".
No
app and bg
Password
Mail server user’s
password.
No
app and bg
The default value is
"localhost".
Default Sender The from address to use
Email Address when sending email
messages.
For example:
CA Clarity
PPM@mycorp.com
180 Installation Guide
System
Operating System Users and Groups section (Unix platforms only)
Field Name
Description
Synchronize
in Cluster?
Services to
Restart
User
The application OS user,
referred to in this
document as the niku
user.
No
all except db and
beacon
No
all except db and
beacon
The default value is
"niku".
Group
The OS group associated
with the application OS
user.
The default value is
"staff".
Root User
No
The OS root user. This
user must either be the
root user or a root user
with the rights to switch
to any other OS user, and
db and beacon
initialize network ports
under 1024
(for example, port 80)
The default value is
"root".
Database User The database OS user,
used to install and
manage the database
service.
No
db
No
db
The default value is
"oracle".
Database
Group
The OS group associated
with the database OS
user.
The default value is
"staff".
Chapter 5: Server Properties 181
Database Server Properties
Field Name
Description
Synchronize
in Cluster?
Services to
Restart
Command
Prefix
An optional command to
prefix any command
executed by CA Clarity
PPM requiring special
privileges. For example,
“sudo” can be used to
specify a user other than
root, who has been given
some super-user
privileges on a given
system.
No
None
Database Server Properties
Use the database Server: Properties page to set up the server’s database
options, such as changing the application server’s database password. To view
this page, click the Database tab on the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Database Server Section
Field Name
Description
Synchronize in
Cluster?
Services to
Restart
Vendor
The target database
vendor. Options are:
Yes
app and bg
oracle
mssql
182 Installation Guide
Database Server Properties
Field Name
Description
Synchronize in
Cluster?
Fetch Size
Yes
Gives the JDBC driver
a hint as to the
number of rows that
should be fetched from
the database when
more rows are needed.
The number of rows
specified affects only
result sets created
using this statement. If
the value specified is
zero, then the hint is
ignored.
Services to
Restart
app and bg
The default value is
"60".
Oracle Only
Field Name
Description
Synchronize in
Cluster?
Services to
Restart
Home
Directory
The home installation
directory of the
database server.
No
None
Yes
None
For example:
/oracle/home
(Oracle/Unix)
D:\oracle\ora92
(Oracle/Windows)
Sys Password
The system password
for this database
server. (Oracle 9i only
- used to start and
stop db). Default
value:
change_on_install
Chapter 5: Server Properties 183
Database Server Properties
Field Name
Description
Synchronize in
Cluster?
Large Table
Tablespace
No (CA Clarity
Used during schema
installation to choose a application server
specific tablespace for only)
tables with potentially
large data sets.
Services to
Restart
None
The default value is
"USERS_LARGE".
Small Table
Tablespace
No (CA Clarity
Used during schema
installation to choose a application server
specific tablespace for only)
tables with potentially
small data sets.
None
The default value is
"USERS_SMALL".
Large Index
Tablespace
No (CA Clarity
Used during schema
installation to choose a application server
specific tablespace for only)
indices with potentially
large data sets.
None
The default value is
"INDX_LARGE".
Small Index
Tablespace
No (CA Clarity
Used during schema
installation to choose a application server
specific tablespace for only)
indices with potentially
small data sets.
None
The default value is
"INDX_SMALL".
High-Volatility
Table
Parameters
Used as input
parameters during
schema installation
when creating tables
that are transactional
in nature and change
frequently. (Oracle
only)
The default value is
"PCTFREE 20 PCTUSED
60".
184 Installation Guide
No (CA Clarity
application server
only)
None
Database Server Properties
Field Name
Description
Synchronize in
Cluster?
Services to
Restart
Low-Volatility
Table
Parameters
Used as input
parameters during
schema installation
when creating tables
that are nontransactional in nature
and change
infrequently. (Oracle
only)
No (CA Clarity
application server
only)
None
Description
Synchronize in
Cluster?
Services to
Restart
Unique identifier for
this connection:
Yes
app and bg
The target database
vendor. This field is
editable only for new
database connections.
The standard CA
Clarity PPM database
connection’s vendor is
taken from the vendor
defined for the
database server.
Options are:
Yes
app and bg
Yes
app and bg
The default value is
"PCTFREE 5 PCTUSED
80".
Database Connections
Field Name
Id
Vendor
oracle
mssql
Specify URL
Whether to specify a
different JDBC url than
the default. Required
when an Oracle RAC is
being used.
Chapter 5: Server Properties 185
Database Server Properties
Field Name
Description
Synchronize in
Cluster?
Services to
Restart
JDBC URL
If Specify URL is
Selected, this is the
JDBC URL to access
the database.
Yes
app and bg
Hostname
Yes
The IP address or
hostname of the target
database server.
app and bg
Port
Yes
The JDBC port of the
target database server.
The default values are:
app and bg
This is primarily useful
for connecting to an
Oracle RAC cluster. A
RAC url must contain a
JDBC prefix followed
by the full TNS entry
for the cluster. For
example:
jdbc:oracle:thin:@(DE
SCRIPTION =
(ADDRESS_LIST =
(ADDRESS =
(PROTOCOL = TCP)
(HOST =
NODE1)(PORT =
1521))
(ADDRESS =
(PROTOCOL = TCP)
(HOST =
NODE2)(PORT =
1521))
(LOAD_BALANCE =
yes))
(CONNECT_DATA =
(SERVER =
DEDICATED)
(SERVICE_NAME = CA
Clarity PPM)))
1521 (Oracle)
1433 (MSSQL)
186 Installation Guide
Database Server Properties
Field Name
Description
Synchronize in
Cluster?
Services to
Restart
Instance
Name
(MSSQL only)
The name of the
instance for the target
database. This is an
optional argument,
enabling multiple MS
SQL instances on the
same machine.
Yes
app and bg
The name of the
Yes
service or datasource
for this database
connection. For Oracle,
this equates to the
TNS name. For
Microsoft SQL
(MSSQL), this equates
to the ODBC
datasource name.
app and bg
The JDBC port is
optional if a valid
instance name is
provided instead.
Service Name
To learn more about
creating TNS names,
see "Configure an
Oracle Net Service
Name" (see page 141)
Service ID
(Oracle only)
The service ID of the
desired database on
the target Oracle
database server.
The name of the
Database
Name (MSSQL database on the target
MSSQL database
only)
server.
Yes
app and bg
Yes
app and bg
Chapter 5: Server Properties 187
Database Server Properties
Field Name
188 Installation Guide
Description
Synchronize in
Cluster?
Services to
Restart
Schema Name The name of the
(MSSQL only) database user that
owns the schema on
the target database
server. This is editable
only on new database
connection definitions.
It is always ‘niku’ on
the internal CA Clarity
PPM connection.
Yes
app and bg
Login Name
The name of the login
user for the target
database.
Yes
app and bg
Password
The password of the
login user for the
target database.
Yes
app and bg
Application Server Properties
Application Server Properties
Use the application Server: Properties page to set up the server’s application
options, such as enabling SSL for all CA Clarity PPM pages. To view this page,
click the Application tab on the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Application Server Section
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Vendor
Specifies whether to use the
default Apache Tomcat
application server integration,
or to use the standard J2EE
integration. Certified J2EE
servers include IBM WebSphere
v6.1 or later and BEA WebLogic
v9.2 or later.
Yes
app
No
app
Options are:
Home Directory
(Apache Tomcat
only)
■
Apache Tomcat (default)
■
Generic J2EE
Apache Tomcat installation
directory.
Default value:
apache-tomcat-5.5.17 (Unix)
D:\apache-tomcat-5.5.17
(Windows)
Chapter 5: Server Properties 189
Application Server Properties
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Use LDAP
Determines whether LDAP is
used when authenticating users
at login.
Yes
app
If you select this option and you
restart the app servers, you
cannot maintain users through
the CA Clarity PPM application
nor can you change or maintain
passwords for CA Clarity PPM
users.
Instead, use the LDAP server to
perform CA Clarity PPM user
maintenance. Changes made on
the LDAP server to CA Clarity
PPM users can be imported to
CA Clarity PPM by enabling the
background job named LDAP
Synchronize New and Changed
Users.
The default value is "Cleared".
Load on Startup
Specifies whether the CA Clarity No
PPM application should initialize
when the application server
starts up, or whether to delay
initialization until the first page
hit.
None
The default value is "Selected".
Scheduler Entry
URL
Yes
The full URL used by the
scheduler, such as Open
Workbench and Microsoft
Project, to access the CA Clarity
PPM server. This is required
only when the schedulers must
connect to a URL other than the
regular application entry URL. If
using a port other than 80, the
port must be specified. For
example:
http://app.mycorp.com
http://CAClarityPPM.mycorp.co
m:8080
190 Installation Guide
app
Application Server Properties
Application Instance Section (for CA Clarity Application (app) and CA Clarity System
Administration (nsa) Services)
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Service Name
(Apache Tomcat
only)
The unique name of this
application service. On
Windows, this is the NT service
name.
No
app
RMI Port
(Apache Tomcat
only)
No
The unique port used by the
application service for RMI (Java
Remote Method Invocation).
app
The default value is "23791".
Maximum
Threads
No
The maximum amount of
threads allowed in the HTTP
thread pool available to service
HTTP (or HTTPS) requests from
clients. The default value is 200.
You can change this default
value. This does not affect nonHTTP threads elsewhere in the
application.
app
Java VM
Parameters
(Apache Tomcat
only)
The VM parameters to pass to
No
the Java executable when
launching the service. VM
parameters are passed on the
command line prior to classpath
and program parameters. This
includes memory settings.
app
The default value is "Xmx1024m".
You should add additional JVM
tuning parameters as needed,
depending on your platform. For
HotSpot JVMs, the
recommended parameters are:
-XX:+UseParallelGC and XX:NewRatio=2, in addition to
large enough minimum and
maximum heap settings. See
"HotSpot VM Tuning" (see
page 95)
Chapter 5: Server Properties 191
Application Server Properties
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Program
Parameters
(Apache Tomcat
only)
Yes
The program parameters to
pass to the Java executable
when launching the service.
These parameters appear at the
end of the command line.
app
The default value is "Cleared".
Distributed
This setting determines whether Yes
this application service should
act as a member of a
distributed server farm. Setting
to true ensures that the service
cooperates with other services
in the cluster and operates as a
stateless service, guaranteeing
proper fault tolerance. If more
than one application services
are load-balanced in a cluster,
this must be set to true.
app
The default value is "Cleared".
Cache
Distributed
Session
This setting determines whether Yes
a user’s session information is
persisted to the database or
cached only in the application
server.
app
Select this option only when
instructed to do so by CA Clarity
PPM Support or Technical
Services. If used incorrectly, the
product will not function
correctly.
Run Job
Scheduler
Specify whether to run a Job
Scheduler in this application
instance. Job Scheduler process
instances may be run in any
background or application
servers.
The default value is "Cleared".
192 Installation Guide
No
app
Application Server Properties
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Maximum
Concurrent Jobs
Specifies maximum amount of
jobs to be run at any given
time. Additional jobs above this
amount are queued.
No
app
No
app
Yes
app
No
app
The default value is "10".
Run Process
Engine
Specify whether to run a
Process Engine in this
application instance. Process
Engine instances may be run in
any background or application
servers.
The default value is "Cleared".
Enable HTTP
Port
Specifies whether to enable the
standard insecure HTTP port. If
this field is cleared, then the
secure HTTPS port should be
enabled in its place.
The default value is "Selected".
HTTP Port
(Apache Tomcat
only)
Specifies the HTTP port to use
in Apache Tomcat. This is
required only when the HTTP
port is enabled.
The default value is "80".
HTTP Entry URL
The full URL used to access the Yes
application. This is required only
when the HTTP port is enabled.
In a cluster, this is the URL of
the front-end load balancer. If
using a port other than 80, it
must be specified. For example:
app and bg
http://app.mycorp.com
http://CAClarityPPM.mycorp.co
m:8080
Chapter 5: Server Properties 193
Application Server Properties
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Enable HTTPS
Port
Specifies whether to enable the
secure HTTPS port. If this is
field is cleared, then the HTTP
port should be enabled in its
place. If both the HTTPS and
the HTTP port are enabled, the
application will secure only
password-sensitive pages. If
only the HTTPS port is enabled,
the application will secure all
pages.
Yes
app
No
app
The default value is "Cleared".
HTTPS Port
(Apache Tomcat
only)
Specifies the HTTPS port to use
in Apache Tomcat. This is
required only when the HTTPS
port is enabled.
The default value is "8043".
HTTPS Entry
URL
Yes
The secure HTTPS URL used to
access the application. This is
required only when the HTTPS
port is enabled. In a cluster,
this is the secure URL of the
front-end load balancer. If using
a port other than 443, it must
be specified. For example:
app and bg
https://app.mycorp.com
https://CA Clarity
PPM.mycorp.com:8043
194 Installation Guide
Document Root
(Apache Tomcat
only)
The document root of the
application server. You can
leave this field cleared.
No
app
Bind Address
(Apache Tomcat
only)
No
Optional hostname or address
to which the server socket using
the HTTP port is bound. It is
useful on servers with two or
more network adapters, to bind
different app services to
different adapters. If you leave
this field empty, all network
interfaces are used.
app
Application Server Properties
Field Name
Description
Synchroniz Services
e in
to Restart
Cluster?
Tomcat
Connector Port
No
Used to specify the connector
port for Apache Tomcat. It is
possible to connect various Web
Servers, primarily Apache, to
Tomcat.
app
Tomcat
Connector Bind
Address
No
Used to specify the connector
bind address, if necessary. It is
possible to connect various Web
Servers, primarily Apache, to
Tomcat.
app
Exception Run
Interval
During an exception retry, the
process engine processes the
events raised but not yet
processed. These include object
events (used by condition
evaluation) and user events
(process abort, error retry,
error skip, etc.). This field
allows you to control how often
this occurs (less often, normal,
more often). If you select
Custom, you can set this value
in minutes.
No
app
No
Message Time to A process engine event
Live
message will expire if the
message server does not pick it
up after a set interval. This field
controls that expiration time in
minutes.
app
No
app
Message
A message server is
Receiver Interval "awakened" by incoming
messages. However, you can
also force the message receiver
to check its incoming queue by
setting this field in minutes.
Chapter 5: Server Properties 195
Documents and Search
Documents and Search
Use the documents and search Server: Properties page to set up the server’s
documents and search options, such as determining whether to index
documents as they are checked in or to index documents as a scheduled job.
To view this page, click the Documents and Search tab on the Server:
Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Search Server Section
Field Name
Description
Synchronized
in Cluster?
Use Synchronous Specifies whether uploaded Yes
Indexing
document are to be
indexed immediately inprocess, or whether they
are to be queued for
indexing by the
asynchronous background
indexer.
Services
to Restart
app and bg
The default value is
"Selected".
Store Files in
Database
Yes
Specifies whether to store
files in the database.
Normally, files are stored in
the filestore on disk. In the
case of an upgrade where
files are currently stored on
disk, this property must be
set prior to the upgrade in
order to move existing files
to the database, if such is
desired.
The default value is
"Cleared".
196 Installation Guide
app
Documents and Search
Document Manager Section
Field Name
Description
Synchronized
in Cluster?
Services
to Restart
File Scanning
Executable
Defines the full path to the
executable that scans
documents for viruses. For
example: /CA Clarity
PPM/filescanner.sh.
Yes
app and bg
File Store
Directory Size
Limit
Defines the file storage size Yes
limit for a directory. Setting
the directory size limit does
not affect the size of preexisting folders.
app and bg
File Size Limit
Defines the size limit for
uploaded documents (in
megabytes) to the file
directory. The default limit
is 20 MB. When this size
limit is reached, a new file
directory is created.
Yes
app
Chapter 5: Server Properties 197
Server Reporting Options
Server Reporting Options
Use the reporting Server: Properties page to set up the server’s reporting
options, such as defining new external connections. To view this page, click
the Reporting tab on the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Field Name
Description
Synchronize Services to
d in Cluster? Restart
Vendor
The vendor name of the
reporting tool.
Yes
app and bg
The default value is
Business Objects.
If this value is changed to
another vendor, run the
report installation to
import the reports into the
report server and display
the report definitions for
the new configured report
vendor.
Home Directory
The Business Objects
home installation
directory.
No
app and bg
Service URL
The Business Objects
service URL. This is used
at runtime to access the
reporting service.
Yes
app and bg
Yes
app and bg
The default value is
http://<servername>:808
0/dswsbobje/services/sess
ion.
CMS
Indicates the address for
the Central Management
Server, the administrator
console for Business
Objects.
The default value is
<servername>:6400.
Web URL
198 Installation Guide
Yes
The default value is
http://<servername>:808
0.
app
Server Reporting Options
Field Name
Description
Synchronize Services to
d in Cluster? Restart
User
Indicates a user with an
Administrative role for
Business Objects.
Yes
app and bg
The Business Objects user Yes
password.
app and bg
The default value is
administrator.
Password
For security reasons, on
production systems, do
not leave this field empty.
The password is
determined during the
Business Objects
installation process. You
can modify the password
from the Central
Management Console.
Confirm
Password
Re-enter password.
Yes
app and bg
Database ID
The CA Clarity PPM
database ID used to
retrieve database
information when
executing reports. This ID
corresponds to IDs of
database connections
defined on the database
Server: Properties page.
Yes
app and bg
The default value is Niku.
Chapter 5: Server Properties 199
Server Security Options
Server Security Options
Use the security Server: Properties page to set up the server’s security
options. To view this page, click the Security tab on the Server: Properties
page’s toolbar.
The following table lists the page’s field names and descriptions:
Encryption Section
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
SSL Keystore
Optional path to the certificate
keystore file on this server.
No
app
SSL Password
Password for the certificate
keystore.
No
app
The Java SDK requires that the
keystore and certificate
passwords much match.
FIPS 140-2
Mode Enabled
200 Installation Guide
No
FIPS 140-2 is a standard that
describes U.S. Federal
government requirements for
encrypting sensitive data. If
your application server vendor
is Apache Tomcat, selecting
this check box causes CA
Clarity PPM to use a FIPS 1402 compliant encryption module
for encryption operation used
during server operation.
Examples are using the SSL
protocol and encrypting
passwords, as defined on the
security Server: Properties
page.
app and
bg
Server Security Options
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Encrypt
Passwords
Determines if passwords in the No
CA Clarity PPM properties file
are encrypted.
app and
bg
Choices are:
■
No encryption.
Passwords display in clear
text. This is the default
value.
■
Using System Key. Uses
a hidden internal
hardcoded key to encrypt
passwords; this same key
is used across all CA
Clarity PPM
implementations. If an
attacker learns this key
and the encryption
mechanism, and has
access to the properties
file, the attacker can
decode the passwords.
This option is only useful
when you want to prevent
casual observers from
seeing passwords in the
properties file.
■
Using Custom Key. This
is the most secure option
where passwords are
stored in another file. The
custom key file is only
required when the server
starts and must be
secured by some method
other than CA Clarity PPM.
Chapter 5: Server Properties 201
Server Security Options
LDAP Server Section
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
URL
URL of the LDAP server.
Yes
app and
bg
Yes
app and
bg
Yes
The name of the user that
performs any of the directory
searches (bind operations).
You must enter a user name
that is a fully qualified
distinguished name (FQDN) of
the LDAP user with read rights.
app and
bg
For example:
ldap://localhost:389
If your LDAP server is SSLenabled, use the LDAPS
protocol in the URL (rather
than the default LDAP
protocol).
For example:
ldaps://localhost:489
Root Context
Identifies the root LDAP
naming context. For example:
ou=People,dc=niku,dc=com
Search User
For example:
uid=nikusearch,dc=niku,dc=co
m
202 Installation Guide
Password
Enter the search user’s
password.
Yes
app and
bg
Confirm
Password
Confirm the search user’s
password by entering it again
in this field.
Yes
app and
bg
Server Security Options
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Batch Size
Yes
Identifies the total number of
results that CA Clarity PPM
limits for every search call it
makes with a directory server.
Set the batch size less than or
equal to the same number that
is set for your directory server.
app and
bg
For example, by default, the
Active Directory restricts the
total number of results that
are returned from an LDAP
search to 1000. In this
situation, you should set the
batch size to any number less
than 1000 and greater than 0.
Object Class
Yes
Identifies the LDAP object
class name. Each entry in
LDAP belongs to object classes
that identify the type of data
represented by the entry.
Provide the object class name
that your LDAP server is
configured with. The default
object class provided is
"Person."
app and
bg
Chapter 5: Server Properties 203
Server Security Options
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Search Filter
Yes
Optional LDAP search filter
string. Specifying a value in
this field enables you to define
search criteria and to provide
more efficient and effective
searches. Default value is
(employeetype=niku)
app and
bg
For example:
To select a user whose first
name is “Babs Jensen”, enter:
(cn=Babs Jensen)
To select a user whose first
name is not “Tim Howes”,
enter:
(!(cn(=Tim Howes))
To select entries from LDAP of
type Person and whose last
name is “Jensen” or first name
is like “Ben J*”, enter:
(&(objectClass=Person)
(|sn=Jensen) (cn=Ben J*)))
CA supports the LDAP search
filters as defined in RFC 2254.
These search filters are
represented by Unicode
strings. The following URL
describes RFC 2254 in detail:
http://www.faqs.org/rfcs/rfc22
54.html
Date/Time
Format
Identifies the date and time
format of the vendor’s
directory server.
For example, for Novell
eDirectory and iPlanet, use:
yyyyMMddHHmmss'Z'
For Microsoft Active Directory
use:
yyyyMMddHHmmss'.0Z'
204 Installation Guide
Yes
app and
bg
Server Security Options
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Group Name
Identifies the name of the
group that holds all the LDAP
users that are to be synched
with CA Clarity PPM.
Yes
app and
bg
Yes
Group Identifier Identifies the ID of the group
specified in the Group Name
field, if present. The name of
the attribute that signifies that
an entity is a group.
app and
bg
If specified, authentication and
synchronization of users are
done against all the users that
are found in this group. You
must enter a group name that
is a fully qualified
distinguished name (FQDN) of
the LDAP.
For example:
cn=QA,ou=Engineering,dc=nik
u,dc=com
Different LDAP servers use
different attribute names. For
example, for Novell eDirectory
and iPlanet, use
uniquemember. For Microsoft
Active Directory, use member.
Allow non-LDAP Select this check box to access
users
CA Clarity PPM using alternate
authentication methods.
app
Chapter 5: Server Properties 205
Server Security Options
LDAP Attribute Mapping Section
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Username
User attribute mapping.
Yes
app and
bg
Yes
app and
bg
Yes
app and
bg
Yes
app and
bg
Yes
app and
bg
Yes
app and
bg
For example, for Novell
eDirectory and iPlanet, use
uid.
For Microsoft Active Directory,
use:
sAMAccountName
Important! You must always
map this field must to a unique
LDAP attribute value.
First Name
First Name attribute mapping.
Default value is givenName.
Last Name
Last Name attribute mapping.
The default value is sn.
Full Name
Full Name attribute mapping.
The default value is cn.
Email Address
Email Address attribute
mapping.
The default value is mail.
Modify Time
Stamp
Modify Time Stamp attribute
mapping.
The default value is
modifyTimeStamp.
Single Sign-On Section
206 Installation Guide
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Token Name
The name of the token (HTTP
cookie, HTTP header, or HTTP
parameter) that contains the
username of the user whose
session is to be initialized.
Yes
app
Background
Field Name
Description
Synchronized Services
in Cluster?
to
Restart
Token Type
The type of HTTP token.
Yes
app
Yes
app and
bg
Yes
app
Values are cookie, header, or
parameter.
Logout URL
The URL where you are taken
to when you log out of CA
Clarity PPM.
For example:
http://www.yourbiz.com/exit.h
tml.
Authentication
Error URL
The URL where you are taken
to when authentication errors
occur.
Background
Use the background Server: Properties page to set up the server’s background
options, such as adjusting the memory on the background server. To view this
page, click the Background tab on the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
Field Name
Description
Synchroniz
ed in
Cluster?
Services
to
Restart
Java VM
Parameters
Defines the VM parameters to
pass to the Java executable
when launching the CA Clarity
Background (bg) service. VM
parameters are passed on the
command line prior to classpath
and program parameters. This
includes memory settings.
No
bg
Default: -Xmx512m
Chapter 5: Server Properties 207
Background
Field Name
Description
Synchroniz
ed in
Cluster?
Services
to
Restart
Program
Parameters
Yes
Specifies whether to pass the
program parameters to the Java
executable when launching the
CA Clarity Background (bg)
service. These parameters
appear at the end of the
command line.
bg
Service Name
No
Defines the unique friendly
name of this service instance.
This value is specifically used on
Windows as the NT service
name.
bg
Default: Niku Background
Server.
Run Job
Scheduler
Specifies whether to run a Job
Scheduler in this background
server. Job Scheduler processes
instances may be run in any
background or application
servers.
No
bg
No
app
No
app
Default: Selected
Maximum
Concurrent Jobs
Defines maximum amount of
jobs to be run at any given
time. Additional jobs above this
amount are queued.
Default: 10
Run Process
Engine
Specifies whether to run a
process engine in this
background server. Process
engine instances may be run in
any background or application
servers.
Default: Selected.
208 Installation Guide
Background
Field Name
Description
Synchroniz
ed in
Cluster?
Exception Run
Interval
No
During an exception retry, the
process engine processes the
events raised but not yet
processed. These include object
events (used by condition
evaluation) and user events
(process abort, error retry, error
skip, etc.). This field allows you
to control how often this occurs
(less often, normal, more
often). If you select Custom,
you can set this value in
minutes.
Services
to
Restart
app
Default: Normal
Message Time to Defines the time in minutes the No
process engine's event message
Live (in
will expire if the message server
minutes)
does not pick it up after a set
interval.
app
No
app
Message
Receiver
Interval (in
minutes
Defines the time in minutes you
want the message receiver to
check its incoming queue of
process engine event messages
if the message server is not
already awakened by incoming
messages.
Chapter 5: Server Properties 209
Appendix A: Actuate
This section contains the following topics:
How to Upgrade CA Clarity PPM with Actuate (see page 211)
Actuate Report Server (see page 212)
Actuate Server Reporting Options (see page 216)
Actuate Server Database Connectivity (see page 218)
One Actuate, More than one CA Clarity PPM (see page 218)
Change Report Servers (see page 219)
How to Upgrade CA Clarity PPM with Actuate
The following high-level steps provide generic guidelines on how to complete
the CA Clarity PPM upgrade process if you plan to use Actuate as the report
server. You must download Actuate 9 from CA Support Online
(http://support.ca.com). Actuate is no longer included.
Note: See the Product Architecture Stack for more information on the
supported versions of all third-party software.
Use the following process to upgrade CA Clarity PPM:
1.
Confirm the configurations on the CA Clarity PPM Database Server (see
page 133).
2.
Upgrade the following third-party software (see page 28) (if necessary):
3.
a.
Java SDK
b.
Application server (Apache Tomcat, BEA WebLogic, or IBM
WebSphere)
c.
Upgrade Actuate to version 9 (see page 213).
Upgrade CA Clarity PPM with:
■
Apache Tomcat (Single Server) (see page 18)
■
Apache Tomcat (Multiple Servers) (see page 19)
■
Generic J2EE (Single Server) (see page 21)
■
Generic J2EE (Multiple Servers) (see page 22)
4.
Verify that all installation steps completed successfully using the
Installation Overview page in CA Clarity System Administration.
5.
Review the NSA server admin.log for general errors or custom Studio
Query (NSQL) validation errors (see page 45).
Appendix A: Actuate 211
Actuate Report Server
6.
Identify which views were upgraded automatically and which views need to
be manually upgraded.
Note: See the Studio Developer's Guide for more information.
7.
Configure portlets and portlet pages to expose or hide new functionality
after the install or upgrade.
Note: See the Studio Developer's Guide for more information on
configuring portlets and pages.
8.
Start all services and verify the application is accessible from an external
client machine using the Entry URL specified in the CA Clarity System
Administration Application Properties. Do not continue until the given Entry
URL is verified and functioning.
9.
From the NSA Install and Upgrade screen, install Reports.
10. Upgrade add-ins (see page 51).
11. Update rights assignments for users, groups or OBS instances with new or
updated security rights introduced in this release of CA Clarity PPM.
Actuate Report Server
CA Clarity PPM integrates with Actuate for reporting functionality. Since CA
Clarity 8.1.1, RSSE (Report Server Security Extension) has been used with
Actuate for its single sign on and security solution. This is enabled by selecting
the Web Service Open Security option in Actuate, and it is done automatically
when the CA Clarity PPM application service is started. Actuate uses the Clarity
web service to authenticate users logging in to the Actuate system. This
means that for the Actuate server volume to be up, the CA Clarity PPM
application must be running and accessible. If the CA Clarity PPM app goes
down for some reason, the Actuate volume will be in an unavailable state.
Actuate server volume will regain its state when the CA Clarity PPM app is
restarted.
For Actuate reporting, you must specify Actuate administrator credentials
(User: Administrator, Password: <Actuate administrator password>) in CA
Clarity System Administration. The user identified in the Server:Properties
page on the Reporting tab will have the right to perform operations required
during the reports installation.
This section describes how to set up the Actuate report server.
212 Installation Guide
Actuate Report Server
Recompile Custom Reports
The new version of Actuate iServer software includes a new version of Actuate
eReport Designer Professional. All of the reports have been recompiled using
the new eRD Pro version 9 SP1. This is recommended as well for additional
custom reports, but not required. New and updated custom reports should be
written using version 9 of eRD Pro.
Upgrade from a Previous Version of Actuate
This section provides instructions for upgrading from a previous version of
Actuate to Actuate 9.0 or for performing a fresh install of Actuate 9.0.
For a fresh install, choose a new Actuate home directory. For an upgrade,
choose your existing Actuate home directory. The installation process varies,
depending on the platform:
Windows (see page 215)
UNIX (see page 213)
If you previously installed Actuate into a directory such as /CA Clarity
PPM/actuate8, you may wish to perform a fresh install into a new directory
such as /CA Clarity PPM/actuate9, to avoid any confusion about the Actuate
version.
A third option is to perform a fresh install, but migrate the Actuate
encyclopedia from the previous version of Actuate to Actuate 9.0. To do this:
1.
Install Actuate 9.0 next to your original Actuate installation.
2.
Stop all processes from the previous version of Actuate and Actuate 9.0..
3.
Use acexport -output <exportdir> from your previous Actuate server bin
directory to export the encyclopedia.
4.
Use acimport -input <exportdir> from your Actuate 9.0 server bin
directory to import the old encyclopedia, upgrading if necessary during the
import process.
Note: Refer to your Actuate 9.0 documentation for more information.
Actuate 9.0 on Unix
To work with Actuate 9.0 on Unix, you must complete the following tasks:
■
Install Actuate Server (see page 214)
■
Configure database connectivity (see page 215)
Appendix A: Actuate 213
Actuate Report Server
Install the Actuate iServer on Unix
To install the Actuate 9 iServer on Unix
1.
Download the Actuate 9 software from support.ca.com.
2.
Navigate to a new temporary directory where you wish to extract the
Actuate installation files:
cd /temp
3.
Extract the Actuate tar file:
tar xvf \Actuate\<plaform>-server-9sp1.tar
4.
Execute the Actuate installation script from the temp directory:
sh isinstall.sh
5.
Read the instructions displayed on the screen and respond to the prompts.
For single-server installation, choose the default Stand-alone option when
prompted. For the remainder of the installation, accept the default values
except for the following:
■
Choose an appropriate installation directory. For example:
CA Clarity PPM/actuate9
6.
■
When prompted, enter the location of the Actuate license key provided
in the Licenses directory.
■
Enter an appropriate administrator password.
■
When prompted to use database drivers and clients, enter y and press
Enter. Enter n for all databases except for Oracle. Choose y instead
and enter the Oracle home directory when prompted.
At the end of the installation, when prompted to start the iServer, choose
Yes.
Important! To ensure correct operation for rendering reports into PDF format,
validate the setting for the True Type Fonts directory in the View Service
parameters section of the Actuate iServer Management console. For Windows
installations, make sure the Arial Unicode MS Font is installed in the Fonts
directory.
Note: See the Actuate iServer Administration manual for more information
regarding font usage and installation.
214 Installation Guide
Actuate Report Server
Connect to an Oracle Database
To connect to an Oracle database from Actuate, the Oracle client must be
installed on the Actuate server(s). Follow these instructions to install the
database client. Be sure to modify the .profile to set the NLS_LANG variable
correctly. International characters will not display in Actuate reports otherwise.
Also remember that when connecting to Oracle 10g, you must install the 9i
client. Actuate does not support the Oracle 10g client.
After installing the client, you must add a TNS entry for the Oracle database.
This TNS name is referenced later from CA Clarity System Administration in
the Service Name field on the Database Server: Properties page.
Actuate 9.0 on Windows
To work with Actuate 9.0 on Windows, you must complete the following tasks:
■
Install Actuate Server (see page 215)
■
Configure database connectivity (see page 215)
Install the Actuate iServer on Windows
To install the Actuate iServer on Windows systems
1.
Download the Actuate 9 software from support.ca.com to a temporary
directory.
2.
Run the following installation script from the directory:
\Actuate\win-server-9sp1.zip
3.
Extract the contents of the zip file to a temporary directory:
D:\ temp
4.
Execute the Actuate iServer installer.
D:\temp\ActuateiServer.exe
5.
Follow the installation instructions on the screen. When prompted for the
license file, enter the location of the Actuate license file in the Licenses
directory.
Connect to a Microsoft SQL Server
To connect to a Microsoft SQL Server (MSSQL) database from Actuate, no
additional client installation is required. However, you must configure an ODBC
entry pointing to your MSSQL CA Clarity PPM database. This ODBC name is
referenced later from CA Clarity System Administration in the Service Name
field on the Database Server: Properties page.
Appendix A: Actuate 215
Actuate Server Reporting Options
Manually Disable RSSE
The Actuate server is given the Clarity's Entry URL (specified on the
Application Properties tab) with which it connects to Clarity. If Clarity is
configured with a load balancer, Actuate should connect through that load
balancer (via the Entry URL) to ensure high availability. If for any reason that
URL is no longer accessible to Actuate, it may be necessary to manually
disable the RSSE setting in the Actuate acserverconfig.xml configuration file.
To disable RSSE manually
1.
Stop the Actuate server.
2.
Open the file <actuate home>/iServer/etc/acserverconfig.xml in an editor.
3.
Modify the attribute value EnableRSSEService under
Config/Volumes/Volume to false.
4.
Restart the Actuate server
After manually disabling RSSE, you can log into Actuate as normal. The next
time a CA Clarity PPM application service pointing to this Actuate server is
restarted, it will automatically re-configure RSSE.
Actuate Server Reporting Options
Use the reporting Server: Properties page to set up the server’s reporting
options, such as defining new external connections. To view this page, click
the Reporting tab on the Server: Properties page’s toolbar.
The following table lists the page’s field names and descriptions:
216 Installation Guide
Field Name
Description
Synchronized in
Cluster?
Services to
Restart
Vendor
Indicates the vendor
name of the reporting
tool. If you change the
vendor, you must run
the CA Clarity PPM
Report Re-Install.
Yes
app and bg
Home Directory
Indicates the Actuate
home installation
directory.
No
None
Actuate Server Reporting Options
Field Name
Description
Synchronized in
Cluster?
Service URL
Yes
Indicates the Actuate
service URL. This is used
at runtime to access the
reporting service.
Services to
Restart
app and bg
Default:
http://<servername>:80
00.
Yes
app and bg
Volume Name
Indicates the machine
name where the
reporting server resides.
Web URL
Yes
The default value is
http://<servername>:89
00.
User
Administrator. For
Actuate, this should be
the Administrator user.
Yes
app and bg
Password
Identifies the
Administrator user
password.
Yes
app and bg
Yes
app and bg
app
For security reasons, on
production systems, do
not leave this field
empty. The password is
determined during the
Actuate installation
process.
Confirm
Password
Re-enter password.
Database ID
The CA Clarity PPM
database ID used to
retrieve database
information when
executing reports. This
ID corresponds to IDs of
database connections
defined on the database
Server: Properties page.
Default: Niku.
Appendix A: Actuate 217
Actuate Server Database Connectivity
Actuate Server Database Connectivity
In a CA Clarity PPM installation, only servers running Actuate iServer are
required to have the database client software. Actuate uses the OCI layer for
Oracle and ODBC for MS SQL Server to connect to the database.
Actuate does not support the Oracle 10g client in UNIX. If you are connecting
to a 10g server, you must install the Oracle 9i client on the Actuate server.
One Actuate, More than one CA Clarity PPM
If you are installing and operating one Actuate iServer service but operating
multiple CA Clarity PPM installations, you can point the CA Clarity PPM
machines to the same Actuate iServer. You cannot install and operate Actuate
iServer service twice on the same CA Clarity PPM machine.
By default, an iServer has a single partition and volume where reports and
report output are stored. You can have two CA Clarity PPM applications share
the same volume, or you can add a second partition and volume for the
second CA Clarity PPM application. This allows you to use different report
definitions for the different CA Clarity PPM installations.
You must reference the new volume in CA Clarity System Administration on
the reporting Server: Properties page.
Note: Refer to the Actuate documentation for more information on creating a
second volume in iServer.
218 Installation Guide
Change Report Servers
Change Report Servers
This section explains how to switch between the Business Objects Report
Server and the Actuate Report Server, which was available in previous CA
Clarity PPM releases. The procedure assumes that both report server software
packages are installed.
To change report servers
1.
Log in to CA Clarity System Administration and click Servers from the
Home menu.
The Servers page appears.
2.
Click the name of the CA Clarity PPM administration server.
The Server: Properties page appears.
3.
Click the Reporting tab.
The reporting Server: Properties page appears.
4.
In the Vendor field, select the name of the report server you want use.
The fields in the Report Server section change depending on the vendor
you selected.
5.
Complete the following fields, depending on the report server selected:
Home Directory
Indicates the home directory for the report server.
Service URL
Indicates the Web Services URL.
Use the following URL for Business Objects:
http://<servername>:8080/dswsbobje/services/session.
Use the following URL for Actuate: http://<servername>:8000.
CMS
Indicates the server and port number for the Central Management
Server. Use the following format: <servername>:6400.
Database ID
The CA Clarity PPM database ID used to retrieve database information
when executing reports. Use the following database ID: Niku
Password
Identifies the administrator user password. For security reasons, on
production systems, do not leave this field empty. The password is
determined during the report server software installation process.
Appendix A: Actuate 219
Change Report Servers
Web URL
Indicates the base URL where reports will be displayed.
Use the following URL:
■
For Business Objects: http://<servername>:8080
■
For Actuate: http://<servername>:8900
Volume Name
Indicates the machine name where the Actuate reporting server
resides.
6.
Click Save.
Your changes are saved.
7.
Restart the CA Clarity Application (app) and Background (bg) services.
8.
Click Install and Upgrade from the Installation Menu.
The Install and Upgrade: Database page appears.
9.
Click Reports in the content menu.
The Install and Upgrade: Reports page appears.
10. Click Re-install.
The reports are copied to the report server you selected.
220 Installation Guide
Index
A
Actuate
installing and configuring on Unix • 213
installing and configuring on Windows • 215
installing the server on Unix • 214
application servers
changing from Orion to generic • 100
installing and configuring server software •
145
application services, running multiple • 105
debugging messages, enabling • 91
documents, indexing • 115
G
general administration
command-line utilities • 34
running a health report • 67
viewing log files • 68
H
HP-UX, installing J2SE SDK for • 163
C
I
CA Clarity PPM
how to install • 11
how to upgrade • 17
CA Clarity PPM installation walkthroughs
about • 12
installing with Apache Tomcat (Multiple
Servers) • 13
installing with Apache Tomcat (Single
Server) • 12
installing with Generic J2EE (Multiple
Servers) • 16
installing with Generic J2EE (Single Server)
• 14
CA Clarity System Administration
about • 33
installing with BEA WebLogic or IBM
WebSphere • 36
sharing disks • 104
using to install and upgrade CA Clarity PPM
• 37
certificate signing requests, creating • 77
clusters
about • 101
command-line interface • 34
database clusters • 107
file distribution in • 104
restricting consumption by Microsoft SQL
server • 112
IBM AIX, installing J2SE SDK for • 163
D
database server passwords, managing • 74
Datamart, using the • 118
J
J2SE SDK
installing • 29
installing on HP-UX system • 163
installing on IBM AIX system • 163
installing on Linux • 162
installing on Solaris • 162
installing on Windows system • 162, 163
jobs
LDAP - Synchronize New and Changed
Users job • 85, 86, 89, 90
LDAP - Synchronize Obsolete Users job •
89, 91
K
keystore files
creating CSR • 77
distributing to application servers • 79
how to create • 77
setting the location of • 79
setting the password of • 79
L
LDAP
defining the server properties • 87
enabling authentication of • 86, 87
full synchronization • 90
integrating CA Clarity PPM with • 85
jobs • 89
performing synchronization of • 89
Index 221
running with SSL • 92
synchronization errors in • 90
troubleshooting • 90
using with SSO • 96
using without SSO • 97
load balancers, about • 103
M
multicast • 101
N
Niku and Nikuadmin utilities, determining use
of • 71
NSQL, verifying queries • 47
O
Oracle
analyzing the database schema • 109
running against Oracle databases • 109
SQL
analyzing the database schema • 111
datamart parallel option • 119
SSL
configuring CA Clarity PPM to work with •
84
enabling for CA Clarity PPM servers • 81
enabling for password-protected pages • 82
enabling in Apache Tomcat • 76
SSO
using LDAP with • 96
using LDAP without • 97
sticky sessions, about • 103
Sun Hotspot JVM, tuning • 98
system administration
general administration • 62
performance • 108
terms used in • 65
T
P
third-party software • 30
private key, creating • 80
U
R
Red Hat Linux, updating environment variables
• 133
restoring defaults • 49
Unix
configuring server properties • 38
modifying server properties • 38
setting up user accounts • 28
user sessions, questions and answers for • 97
S
V
scaling, designing CA Clarity PPM • 101
security
opening on server • 62
overview • 74
server database
connectivity • 141
installing and configuring software • 135
server operating systems • 133
server properties
modifying • 38
services
ensuring sufficient memory • 111
starting all • 43
software downloads
installing from CA Clarity PPM • 172
installing from CA Clarity PPM Microsoft
Project Interface • 173
installing from file server • 173
Solaris, installing J2SE SDK for • 162
views
identifying • 48
manually upgrading • 48
222 Installation Guide
W
Windows
installing J2SE SDK for • 164
setting up system variables • 29