CSA: Classic PPM System Administration (On-Premise Only)

ccppmop1593
HID_admin_system
Use
Classic PPM
 System Administration (CSA) to install, upgrade, configure, monitor, and verify the health of a cluster. To ensure that all servers are accessible, verify that the Beacon service is running on each server. The Beacon service enables remote, distributed management and allows you to do the following tasks:
  • View and modify remote server properties
  • Stop, start, and verify 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
Log in to CSA with the password that you created during installation. The following default login URL is for CSA on servers running Apache Tomcat:
http://<hostname>:8090/niku/app
Refer to this information when changing the configurable application server properties in
Classic PPM
 System Administration (CSA). The
Classic PPM
 properties are described, and specify which properties must be identical across all servers and which properties when changed, require services to be restarted. You can modify application server properties either for the local application server or a remote server.
2
Clarity
Server/URL Contexts
  • /niku
    is the main
    Clarity
    application context.
  • /ppm
    is the REST web services context.
  • /pm
    is the context for
    Clarity
    .
  • /reportservice
    is the Jaspersoft report server context.
Classic PPM
 System Administration Server Properties
Use the
Classic PPM
 System Administration server properties page to configure system options such as the server multicast address and port
.
To view this page, click the CSA sub tab on the server properties page.
Field Name
Description
Synchronize in Cluster?
Services to Restart
Multicast Address
The multicast address that the Beacon and
Classic PPM
 System Administration use for service discovery. Each
Classic PPM
 cluster requires a unique IP address. The multicast address must be in the Class address range from 224.0.0.0 through 239.255.255.255. Each server within a cluster must use the same address and port.
Default:
230.0.1.1
We recommend an IP address in the 239.x.x.x subnet.
Yes
beacon
Multicast Port
Multicast port used with the multicast address. Must be a unique port on a machine.
The multicast address that the Beacon and
Classic PPM
 System Administration use for service discovery. Each
Classic PPM
 cluster requires a unique IP address. Each server within a cluster must use the same address and port.
Default value: 9090
Yes
beacon
Bind Address
Apache Tomcat: Optional IP address or name specifying a local network interface. This option is useful when more than one network interface is present and one specific interface must be chosen, or when you have a clustered installation. If there are multiple NICs in the server, specify the IP address of the interface through which multicast traffic is to flow.
When you use IPv6 Link Local addresses, the zone ID used must be the same for all addresses in a cluster of servers.
No
beacon
Auto Start Service
Specifies whether startup is automatic or manual for a Windows application server.
If the check box is selected, startup is automatic. If the check box is cleared, startup is manual (default).
No
beacon
Service User
Specifies the Windows service property, Log on Account.
Possible values:
LocalSystem. The service runs as the standard local system account (default).
.\<username>. The service runs as a local user, where <username> is the local account. The period backslash (.\) syntax is required by Windows to specify a local machine account.
<domain>\<username>. The service runs as a domain user, where <domain> is the domain name, and <username> is the domain user.
No
beacon
Service Password
Defines the password for the user who is specified in the Service User field for Windows. The field is optional and empty by default.
No
beacon
Beacon Service Name
The unique name of the Beacon service. On Windows systems, this is the name of the Windows Service.
No
beacon
Beacon Port
Controller port that is used by the Beacon service on each server.
No
beacon
System Properties
Use the system server properties page to set up the server’s system options, such as setting up
Classic PPM
 to support multiple currencies
.
To view this page, log in to
Classic PPM
 System Administration and click the System sub tab on the server properties page.
Operating System Users and Groups
Field Name
Description
Synchronize in Cluster?
Services to Restart
User
The application operating system (OS) user, referred to in this document as the niku user.
The default value is
niku
.
No
All except db and beacon.
Group
The OS group association with the application OS user.
No
All except db and beacon.
Root User
The OS root user. This user must be defined in one of the following ways:
The root user
A root user with the right to switch to any other OS user and initialize ports under 1024 (for example, port 80).
The default value is
root
.
No
All except db and beacon.
Database User
The database OS user. This name is used to install and manage the database server.
The default value is
oracle
.
No
db
Database Group
The OS group that is associated with the OS user.
No
db
Command Prefix
An optional command to prefix any command
Classic PPM
 executes that requires 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 system.
Java Section
Field Name
Description
Synchronize in Cluster?
Services to Restart
Java Home Directory
The location of the Java JDK.
The default values are:
D:\jdk1.7.0_55 (Windows)
/usr/jdk1.7.0_55 (Linux)
No
beacon, app, and bg
Java VM
The desired Java VM to use when launching the application and background services.
Default:
Server
No
beacon, app, and bg
preferIPv4Stack
For pure IPv4 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.
No
beacon, nsa, app, and bg
General Section
Field Name
Description
Synchronize in Cluster?
Services to Restart
Multi-currency Enabled
Determines if support for multiple currencies is enabled in this
Classic PPM
 installation. Please review the "
Clarity
15.6.1 Changes:
Classic PPM
Administrative Features" section in Change Impact and Upgrade to review how you can enable multi-currency.
The default value is Cleared.
Yes
app
License Types
A
Classic PPM
 contract includes a license naming convention. Select the license naming convention that is used in your contract. The naming convention setting does not change the behavior of the access rights. This setting affects only the labels that appear in the administration licensing portlets. All
Classic PPM
 access rights are associated with a license type value. License Types determine the level of license that is associated with users. Access rights determine the license type that is assigned to each user. If users have access rights for multiple license types, these users are assigned the highest license type.
Yes
app, bg, nsa
Check for configuration changes every (seconds)
Determines how often running services check for changes to common configuration files, for example, properties.xml.
Yes
app, nsa, and bg
Check tenant database health every (seconds)
This setting is not presently used.
N/A
N/A
Mail Server Section
Field Name
Description
Synchronize in Cluster?
Services to Restart
Hostname
The name of the mail server host.
The default value is localhost.
No
app and bg
Default Sender Email Address
The from address to use when sending email messages.
For example:
Classic PPM
@mycorp.com
Yes
app and bg
Use Authentication
Determines whether the username and password are used to authenticate to the given mail server.
No
app and bg
User
Mail server username.
For example:
Classic PPM
.
No
app and bg
Password
Mail server user’s password.
No
app and bg
Do you want
Classic PPM
 generated emails to always come from the same address?
In CSA, you use the Default Sender Email Address field to specify the
from address
to use when sending email messages. If you want all
Classic PPM
 generated emails to always come from the same address, add the alwaysUseDefaultSenderAddress=true attribute to the properties.xml file. See KB article TEC522264.
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.
The default value is
niku
.
No
all except db and beacon
Group
The OS group that is associated with the application OS user.
The default value is
staff
.
No
all except db and beacon
Root User
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
initialize network ports under 1024
(for example, port 80)
The default value is
root
.
No
db and beacon
Database User
The database OS user that is used to install and manage the database service.
The default value is
oracle
.
No
db
Database Group
The OS group that is associated with the database OS user.
The default value is
staff
.
No
db
Command Prefix
An optional command to prefix any command executed by
Classic 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 subtab on the server properties page.
Database Server Section
Field Name
Description
Synchronize in Cluster?
Services to Restart
Vendor
The target database vendor. Options are:
oracle
mssql
postgreSQL
Yes
app and bg
Fetch Size
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 that are specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored.
Default:
60
Yes
app and bg
Oracle Only
Field Name
Description
Synchronize in Cluster?
Services to Restart
Home Directory
The home installation directory of the database server.GENERIC_M
For example:
/oracle/home (Oracle/Unix)
D:\oracle\ora11 (Oracle/Windows)
No
None
Use Multilingual Sorting
(Oracle only) If this field is selected, the sort sequence GENERIC_M is used if no multilingual sort sequence is defined for the user's language in i18n.xml. For example, the German umlaut sorts after the English U rather than after the English Z.
Yes
app and bg
Sys Password
The system password for this database server. (Oracle 11g only - used to start and stop db. Password is required only if the database is managed as a
Classic PPM
 service.)
Default:
change_on_install
Yes
None
Large Table Tablespace
Used during schema installation to select a specific tablespace for tables with potentially large data sets.
Default:
USERS_LARGE
No (
Classic PPM
 application server only)
None
Small Table Tablespace
Used during schema installation to select a specific tablespace for tables with potentially small data sets.
Default:
USERS_SMALL
No (
Classic PPM
 application server only)
None
Large Index Tablespace
Used during schema installation to select a specific tablespace for indices with potentially large data sets.
Default:
INDX_LARGE
No (
Classic PPM
 application server only)
None
Small Index Tablespace
Used during schema installation to select a specific tablespace for indices with potentially small data sets.
Default:
INDX_SMALL
No (
Classic PPM
 application server only)
None
High-Volatility
Table Parameters
Used as input parameters during schema installation when creating tables that are transactional in nature and change frequently. (Oracle only)
Default:
PCTFREE 20 PCTUSED 60
No (
Classic PPM
 application server only)
None
Low-Volatility
Table Parameters
Used as input parameters during schema installation when creating tables that are non-transactional in nature and change infrequently. (Oracle only)
Default:
PCTFREE 5 PCTUSED 80
No (
Classic PPM
 application server only)
None
Database Connections
Field Name
Description
Synchronize in Cluster?
Services to Restart
Id
Unique identifier for this connection:
Yes
app and bg
Vendor
The target database vendor. This field is editable only for new database connections. The standard
Classic PPM
 database connection’s vendor is taken from the vendor that is defined for the database server. Options are:
oracle
mssql
Yes
app and bg
Specify URL
Whether to specify a different JDBC url than the default. Required when an Oracle RAC is being used.
Yes
app and bg
JDBC URL
If Specify URL is Selected, this is the JDBC URL to access the database.
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:@(DESCRIPTION = (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 =
Classic PPM
)))
Yes
app and bg
Hostname
The IP address or hostname of the target database server.
Yes
app and bg
Port
The JDBC port of the target database server. The default values are:
1521 (Oracle)
1433 (MSSQL)
Yes
app and bg
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.
The JDBC port is optional if a valid instance name is provided instead.
Yes
app and bg
Service Name
The name of the 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.
To learn more about creating TNS names, see "Configure an Oracle Net Service Name".
Yes
app and bg
Service ID
(Oracle only)
The service ID of the desired database on the target Oracle database server.
Yes
app and bg
Database Name (MSSQL only)
The name of the database on the target MSSQL database server.
Yes
app and bg
Schema Name (MSSQL only)
The name of the 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
Classic 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
Use the application server properties page to set up the server’s application options, such as enabling SSL for all pages
.
To view this page, click the Application sub tab on the server properties page.
Application Server Section
Field Name
Description
Synchronize in Cluster?
Services to Restart
Vendor
Classic PPM
 supports integration with Apache Tomcat application server only. Integration with Generic J2EE is a legacy option and is not supported.
Yes
app
Home Directory
(Apache Tomcat only)
Apache Tomcat installation directory.
Default value:
apache-tomcat-7 (Unix)
D:\apache-tomcat-7 (Windows)
No
app
Use LDAP
Determines whether LDAP is used when authenticating users at login.
If you select this option and you restart the app servers, you cannot maintain users through the application nor can you change or maintain passwords for
Classic PPM
 users.
Instead, use the LDAP server to perform
Classic PPM
 user maintenance. Changes made on the LDAP server to
Classic PPM
 users can be imported to
Classic PPM
 by enabling the background job that is named LDAP Synchronize New and Changed Users.
The default value is
cleared
.
Yes
app
Disable REST API Access
Allows the enabling or disabling of the API Infrastructure. If you select this option, the API feature is switched off. Users cannot access the APIs and any subsequent API requests receive a "403 Forbidden" status in response. Other applications that use the REST APIs (for example, the Rally Synchronization job or the interactive API Documentation) depend on the REST API status being enabled.
Yes
None
Maximum rows for Export to Excel
Determines the limit for the number of rows that a user can set for Export to Excel using the setting available on the System Options page. Limiting the maximum number of rows available ensures that users cannot overwhelm application resources by exporting unlimited amounts of data.
Yes
app
Global Session Timeout
This setting overrides the Session Timeout setting that appears in the application System Options page. When Global Session Timeout is specified, the Minutes of Inactivity Until Logout system option becomes read only.
Yes
app
Global Tenant Timeout
This setting is not presently used.
N/A
N/A
Load on Startup
Specifies whether the application should initialize when the application server starts up, or whether to delay initialization until the first page hit.
The default value is
selected
.
No
None
Scheduler Entry URL
The full URL used by the scheduler, such as Open Workbench and Microsoft Project, to access the
Classic PPM
 server. This is required only when the schedulers must connect to a URL other than the regular application entry URL. If you are using a port other than 80, the port must be specified. For example:
http://app.mycorp.com
http://asia_app.mycorp.com:8080
Yes
app
CA Productivity Accelerator URL
This field is reserved for future use. Do not modify this field unless instructed to do so by CA Technical Support.
N/A
N/A
SSL Handling
Yes
app
Directories
Field Name
Description
Synchronize in Cluster
Services to Restart
Shared Directory
This field is reserved for future use. Do not modify this field unless instructed to do so by CA Technical Support.
N/A
N/A
Application Instance Section (for
Classic PPM
 Application (app) and
Classic PPM
 System Administration (nsa) Services)
Field Name
Description
Synchronize in Cluster?
Services to Restart
Service Name (Apache Tomcat only)
The unique name of this application service. On Windows, this is the service name.
No
app
Auto Start Service
Specifies whether startup is automatic or manual for a Windows application server.
If the check box is selected, startup is automatic. If the check box is cleared, startup is manual. (default)
No
app
Service User
Specifies the Windows service property, Log on Account.
Possible values:
LocalSystem. The service runs as the standard local system account. (default)
.\<username>. The service runs as a local user, where <username> is the local account. The period backslash (.\) syntax is required by Windows to specify a local machine account.
<domain>\<username>. The service runs as a domain user, where <domain> is the domain name, and <username> is the domain user.
No
app
Service Password
Defines the password for the user who is specified in the Service User field for Windows. The field is optional and empty by default.
No
app
RMI Port (Apache Tomcat only)
The unique port used by the application service for RMI (Java Remote Method Invocation).
No
app
Maximum Threads
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 non-HTTP threads elsewhere in the application.
No
app
Java VM Parameters (Apache Tomcat only)
The VM parameters to pass to 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.
The default value is -Xmx2048m.
You should add additional JVM tuning parameters as needed, depending on your platform.
Best Practice:
For HotSpot JVMs, the recommended parameters are:
-XX:+UseParallelGC and -XX:NewRatio=2, in addition to large enough minimum and maximum heap settings. For more information, search for
HotSpot VM Tuning
.
No
app
Program Parameters (Apache Tomcat only)
The program parameters to pass to the Java executable when launching the service. These parameters appear at the end of the command line.
The default value is
cleared
.
Yes
app
Distributed
This setting determines whether 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.
The default value is
cleared
.
Yes
app
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
.
No
app
Maximum Concurrent Jobs
Specifies the maximum number of jobs to be run at any given time. Additional jobs above this amount are queued.
The default value is 10.
No
app
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.
We recommend that you run the process engine in the background service to prevent performance problems on the application service.
The default value is
cleared
.
No
app
HTTP Enabled
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
.
Yes
app
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.
No
app
HTTP Entry URL
The full URL used to access the 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:
http://app.mycorp.com
http://asia_app.mycorp.com:8080
If you are using Jaspersoft with
Classic PPM
, verify the following requirements for Advanced Reporting to work seamlessly:
  • The value for this field cannot be
    localhost
    .
  • The base URL used to access
    Classic PPM
     is the same as the HTTP Entry URL.
  • If using the default port (that is, no port is specified in the URL), the HTTP Entry URL does not end with a slash (/). See the following example:
    • Clarity
      URL: http://ppm-avg-1420
    • HTTP Entry URL: http://ppm-avg-1420 (without the “/” at the end)
Yes
app and bg
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.
The default value is
cleared
.
Yes
app
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.
No
app
HTTPS Entry URL
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 you are using a port other than 443, it must be specified. For example:
https://app.mycorp.com
https://asia_app.mycorp.com:8043
If you are using Jaspersoft with
Classic PPM
, the value for this field cannot be
localhost
.
Yes
app and bg
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)
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.
No
app
Tomcat Connector Port
Used to specify the connector port for Apache Tomcat. It is possible to connect various Web Servers, primarily Apache, to Tomcat.
No
app
Tomcat Connector Bind Address
Used to specify the connector bind address, if necessary. It is possible to connect various Web Servers, primarily Apache, to Tomcat.
No
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
Message Time to Live
A process engine event message will expire if the message server does not pick it up after a set interval. This field controls that expiration time in minutes.
No
app
Message Receiver Interval
A message server is
awakened
by incoming messages. However, you can also force the message receiver to check its incoming queue by setting this field in minutes.
No
app
Use Single Sign-On
When this option is enabled,
Classic PPM
 delegates login authentication to an external authority. See Single Sign-On (SSO) for details about configuring SSO.
Yes
app
Maximum XML Nodes
Specifies the number of XML nodes that can be imported or exported.
The default value is 150,000.
No
NA
Rest Context
The context for the
Classic PPM
 REST API URL. For example, in the following REST API URL, the rest context is "ppm":
https://samplehost:8080/ppm/rest/v1/projects
The default value is "ppm".
Yes
app
Documents and Search Properties
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
.
If you do not use the database as the document store, select a directory location for the filestore that is outside the directory where
Classic PPM
 is installed. In addition, verify that the index directory is outside the installation directory. If you are upgrading from a version earlier than Service Pack 13.0.1, move the filestore before you begin the upgrade process. For complete information, see
Change Impact and Upgrade
.
To view this page, click the Documents and Search sub tab on the server properties page.
Search Server Section
Field Name
Description
Synchronized in Cluster?
Services to Restart
Use Synchronous Indexing
Specifies whether uploaded document are to be indexed immediately in-process, or whether they are to be queued for indexing by the asynchronous background indexer.
The default value is
selected
.
Yes
app and bg
Store Files in Database
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 before the upgrade to move existing files to the database, if such is desired.
The default value is
cleared
.
Yes
app
Index Directory
Directory where the document store is indexed. Verify that this location is outside the installation directory.
Yes
app and bg
Filestore Directory
Directory location of the filestore. Verify that this location is outside the installation directory.
Yes
app and bg
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: /
Classic PPM
/filescanner.sh.
Yes
app and bg
File Store Directory Size Limit
Defines the file storage size limit for a directory. Setting the directory size limit does not affect the size of pre-existing folders.
Yes
app and bg
File Upload 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
None
Server Reporting Properties
Use the reporting server properties page to set up the Jaspersoft reporting options
.
To view this page, click the Reporting sub tab on the server properties page.
Field Name
Description
Synchronized in Cluster?
Services to Restart
Vendor
The vendor name of the reporting tool (Jaspersoft).
Status
Indicates whether the Jaspersoft server is available
Web URL
The web URL for the Jaspersoft server. For example, http://<jaspersoft-hostname>:8080/<jasperwebcontext>.
Yes
app
Clarity
Data Source JNDI Name
Data Warehouse Data Source JNDI Name
User
The Jaspersoft user name who performs system tasks that require administration access. The default user is ppmjasperadmin. You can change the default user name before you import Jaspersoft Advanced Reporting content. The import creates the user. Do not change the user name after you import the Advanced Reporting content.
Yes
app and bg
Database ID
Not Applicable
Organization Name
Specifies the organization name (tenant) that is created on the Jaspersoft server.
Organization ID
Specifies the organization ID (tenant) that is created on the Jaspersoft server.
Data Warehouse Server Properties
Use the Data Warehouse server properties page to set up the connection details for the Data Warehouse database. To view this page, click the Data Warehouse sub tab on the server properties page.
Field Name
Description
Synchronized in Cluster?
Services to Restart
Vendor
The target database vendor. Options are:
oracle
mssql
postgreSQL
Yes
app and bg
Fetch Size
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.
Default:
240
Yes
app and bg
Sys Password
(Oracle only)
The system password for this database server. (Oracle 11g only - used to start and stop db. Password is required only if the database is managed as a
Classic PPM
 service.)
Default:
Change on install.
Yes
None
Dimension Table Tablespace
(Oracle only)
Used during schema installation to select a specific tablespace for dimension tables for the Data Warehouse schema.
Default:
DWH_PPM_DATA_DIM
No
None
Fact Table Tablespace
(Oracle only)
Used during schema installation to select a specific tablespace for fact tables for the Data Warehouse schema.
Default:
DWH_PPM_DATA_FACT
No
None
Dimension Index Tablespace
(Oracle only)
Used during schema installation to select a specific tablespace for dimension indices for the Data Warehouse schema.
Default:
DWH_PPM_INDX_DIM
No
None
Fact Index Tablespace
(Oracle only)
Used during schema installation to choose a specific tablespace for fact indices for the Data Warehouse schema.
Default:
DWH_PPM_INDX_FACT
No
None
Connection Details
Field Name
Description
Synchronize in Cluster?
Services to Restart
Status
Indicates whether the Server is available.
Specify URL
Whether to specify a different JDBC URL than the default. Required when an Oracle RAC is being used.
Yes
app and bg
Hostname
The IP address or hostname of the target database server.
Yes
app and bg
Port
The JDBC port of the target database server. The default values are:
1521 (Oracle)
1433 (MSSQL)
Yes
app and bg
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.
The JDBC port is optional if a valid instance name is provided instead.
Yes
app and bg
Service Name
The name of the 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.
To learn more about creating TNS names, see "Configure an Oracle Net Service Name".
Yes
app and bg
Service ID
(Oracle only)
The service ID of the desired database on the target Oracle database server.
Yes
app and bg
Database Name
(MSSQL only)
The name of the database on the target MSSQL database server.
Yes
app and bg
Schema Name (MSSQL only)
The name of the 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
Classic 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
Custom Database Link
Indicates whether the database link is custom or the default: PPMDBLINK.
PPM Database Link
The database link to the
Classic PPM
 database, either custom or default (PPMDBLINK).
Data Warehouse Governor Limits
Field Name
Description
Synchronize in Cluster?
Services to Restart
ETL Job Timeout
Indicates the number of minutes that the ETL Job can run without completing before it is stopped.
Default:
600 minutes
Server Security Properties
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 menu.
Encryption Section
Field Name
Description
Synchronized in Cluster?
Services to Restart
SSL Keystore
Optional path to the certificate keystore file on this server.
No
app
SSL Password
Password for the certificate keystore.
The Java JDK requires that the keystore and certificate passwords much match.
No
app
FIPS 140-2 Mode Enabled
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
Classic PPM
 to use a FIPS 140-2 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.
No
app and bg
Encrypt Passwords
Determines if passwords in the
Classic PPM
 properties file are encrypted.
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
Classic 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
Classic PPM
.
No
app and bg
LDAP Server Section
Field Name
Description
Synchronized in Cluster?
Services to Restart
URL
URL of the LDAP server.
For example:
ldap://localhost:389
If your LDAP server is SSL-enabled, use the LDAPS protocol in the URL (rather than the default LDAP protocol).
For example:
ldaps://localhost:489
Yes
app and bg
Root Context
Identifies the root LDAP naming context. For example:
ou=People,dc=niku,dc=com
Yes
app and bg
Search User
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.
For example:
uid=nikusearch,dc=niku,dc=com
Yes
app and bg
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
Batch Size
Identifies the total number of results that
Classic 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.
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.
Yes
app and bg
Object Class
Identifies the LDAP object class name. Each entry in LDAP belongs to object classes that identify the type of data that is represented by the entry. Provide the object class name that your LDAP server is configured with. The default object class that is provided is Person.
Yes
app and bg
Search Filter
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)
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:
Yes
app and bg
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'
Yes
app and bg
Group Name
Identifies the name of the group that holds all the LDAP users that are to be synched with
Classic PPM
.
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=niku,dc=com
Yes
app and bg
Group Identifier
Identifies the ID of the group that is specified in the Group Name field, if present. The name of the attribute that signifies that an entity is a group.
Different LDAP servers use different attribute names. For example, for Novell eDirectory and iPlanet, use uniquemember. For Microsoft Active Directory, use member.
Yes
app and bg
Allow non-LDAP users
Select this check box to access
Classic PPM
 using alternate authentication methods.
app
LDAP Attribute Mapping Section
Field Name
Description
Synchronized in Cluster?
Services to Restart
Username
User attribute mapping.
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.
Yes
app and bg
First Name
First Name attribute mapping.
Default value is givenName.
Yes
app and bg
Last Name
Last Name attribute mapping.
The default value is sn.
Yes
app and bg
Full Name
Full Name attribute mapping.
The default value is cn.
Yes
app and bg
Email Address
Email Address attribute mapping.
The default value is mail.
Yes
app and bg
Modify Time Stamp
Modify Time Stamp attribute mapping.
The default value is modifyTimeStamp.
Yes
app and bg
Single Sign-On Section
Field Name
Description
Synchronized in Cluster?
Services 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
Token Type
The type of HTTP token.
Values are cookie, header, or parameter.
Yes
app
Logout URL
The URL where you are taken to when you log out of
Classic PPM
.
For example: http://www.yourbiz.com/exit.html.
Yes
app and bg
Authentication Error URL
The URL where you are taken to when authentication errors occur.
Yes
app
Background Properties
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 menu.
Field Name
Description
Synchronized in Cluster?
Services to Restart
Java VM Parameters
Defines the VM parameters to pass to the Java executable when launching the
Classic PPM
 Background (bg) service. VM parameters are passed on the command line prior to classpath and program parameters. This includes memory settings.
Default:
-Xmx2048m
No
bg
Program Parameters
Specifies whether to pass the program parameters to the Java executable when launching the
Classic PPM
 Background (bg) service. These parameters appear at the end of the command line.
Yes
bg
Background Instance
Service Name
Defines the unique friendly name of this service instance. This value is used on Windows as the NT service name.
Default:
Classic PPM
 Background Server.
No
bg
Auto Start Service
Specifies whether startup is automatic or manual for a Windows server.
If the check box is selected, startup is automatic. If the check box is cleared, startup is manual. (default)
No
bg
Service User
Specifies the Windows service property, Log on Account.
Possible values:
LocalSystem. The service runs as the standard local system account. (default)
.\<username>. The service runs as a local user, where <username> is the local account. The period backslash (.\) syntax is required by Windows to specify a local machine account.
<domain>\<username>. The service runs as a domain user, where <domain> is the domain name, and <username> is the domain user.
No
bg
Service Password
Defines the password for the user who is specified in the Service User field for Windows. The field is optional and empty by default.
No
bg
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.
Default:
Selected
No
bg
Maximum Concurrent Jobs
Defines the maximum number of jobs to be run at any given time. Additional jobs above this amount are queued.
Default:
10
No
app
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.
We recommend that you run the process engine in the background service to prevent performance problems on the application service.
Default:
Selected.
No
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.
Default:
Normal
No
app
Message Time to Live (in minutes)
Defines the time in minutes the process engine's event message will expire if the message server does not pick it up after a set interval.
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.
No
app