Install PPM with PostgreSQL

You can install PPM with a PostgreSQL database.

Supported and unsupported features

The section lists the modules, special commands, and reports that are supported and not yet supported when running PPM with a PostgreSQL database.

Supported features

Area	Details
Modules	Demand Management Project Management Program Management Time Management Portfolio Management Resource Management Financial Management Team Management User Administration Dashboard Integration with Jira Integration with OpenText Software Delivery Management PPM for Mobile
Special commands	ksc_comment ksc_create_baseline ksc_create_project ksc_run_sql ksc_set ksc_set_staffing_profile_status ksc_take_snapshot ksc_update_program_status ksc_update_project_status ksc_update_workplan_status ksc_create_baseline_staffing_profile ksc_copy_request ksc_create_workplan ksc_store
Reports	Import Users Request Detail Report Notification History Report Run License Usage Report Time Sheet Summary Report Request Type Detail Report Time Sheet Details Report Work Allocation Details Report Actual Time Summary Report Project Status List Report Project Cost Breakdown Report Delinquent Time Sheet Report Run Field Security Denormalization Report
DMS solution	Only support PPM Center File System

Unsupported features

Area	Details
Modules	Application Portfolio Management Deployment Management Operational Reporting Chatbot MSP Plugin Integration with Quality Center / Application Lifecycle Management Integration with Universal CMDB Integration with Service Manager Integration with CARally Integration with Digital.ai Agility Integration with ServiceNow Integration with Microsoft Azure DevOps
Preconfigured portlets	Project Current Cost Metrics Financial Summary to Financial Data Comparison Financial Comparison Operational Report

Before you install

Before you install PPM with a Postgre SQL database, you must have the following ready:

You have installed a PostgreSQL database. For instructions, see the PostgreSQL documentation.

The PostgreSQL 13.8 and later versions are supported.

Caution: In a server cluster configuration, each cluster must have its own database. Do not share a PostgreSQL database among clusters. However, you can create multiple databases in one PostgreSQL server.
To adapt the PPM function, change the authentication mode of the PostgreSQL server.

Modify the pg_hba.conf file and change the encryption mode of IPv4 connections from trust to md5 or scram-sha-256, as shown below:
Copy code
```
# IPv4 local connections:
host all all 0.0.0.0/0 md5
```
You have installed orafce 3_24_4. For instructions, see https://github.com/orafce/orafce.
(Windows systems only) Make sure you have a UNIX emulator (such as Cygwin) installed. For information about the UNIX emulator and how to install it, see the Cygwin website.

Install PPM

Follow the steps below to install PPM with a PostgreSQL database:

Obtain the installation bundle for PostgreSQL: ppm_<PPM version>_install_pg.zip from the Software Licenses and Downloads Portal.
Extract the ppm_<PPM version>_install_pg.zip package.

The extraction creates the following:
- conf directory
- resources directory
- bundle.zip file
- ppm.env file
- kInstall.sh command
- create_template.sh command
- create_user.sh command
- ppm-<PPM version>-multi-lang.jar file (applicable to 24.2 and later versions)

Operate as a DBA to create a PostgreSQL template database. Later during the PPM installation, configure this template database in the ppm.env file.

Run the create_template.sh command with the following required parameters attached. For example:

sh create_template.sh -h <pg_host> -p <pg_port> -t <your_template_dbname> -s <pg_superuser> -w <pg_superuser_password>

Required parameter	Description
`-h`, or `--host`	The host of the server where the PostgreSQL database is installed.
`-p`, or `--port`	The port of the server where the PostgreSQL database is installed.
`-t`, or `--template`	The name of the template database you create.
`-s`, or `--system`	Superuser username for the PostgreSQL database.
`-w`, or `--password`	Superuser password for the PostgreSQL database.

Operate as a DBA to create a PPM database user. Later during the PPM installation, configure this use in the ppm.env file.

Run the create_user.sh command with the following required parameters attached. For example:

sh create_user.sh -h <pg_host> -p <pg_port> -s <pg_superuser> -w <pg_superuser_password> -u <ppm_db_user> -W <ppm_db_password>

Required parameter	Description
`-h`, or `--host`	The host of the server where the PostgreSQL database is installed.
`-p`, or `--port`	The port of the server where the PostgreSQL database is installed.
`-s`, or `--system`	Superuser username for the PostgreSQL database.
`-w`, or `--password`	Superuser password for the PostgreSQL database.
`-u`, or `--user`	User name for the PPM Center database.
`-W`, or `--user-password`	Password for the PPM Center database.

Do either of the following to configure the required parameters.

Edit parameter values directly in the ppm.env file.
Run the export command to set the value for each parameter. For example,

export PPM_HOME=<path_to_the_folder_where_your_PPM_system_is_to_be_created>

Note: The values set by the export command override the values set in the ppm.env file.

Required parameters

Parameter	Description
PPM_HOME	The folder where your PPM file system is to be installed.
PGHOST	The host of the server where the PostgreSQL database is installed.
PGPORT	The port of the server where the PostgreSQL database is installed.
PPM_DB_NAME	Name of the PostgreSQL database that PPM uses. It is created automatically during the installation progress.
PPM_TEMPLATE_DB	The template database created in step 3.
PPM_DB_USER	The PPM database user created in step 4.
PPM_DB_PASSWORD	The PPM database user password created in step 4.
LOCAL_IP	The IP or hostname of the server where PPM is to be installed.
HTTP_PORT	PPM server HTTP port.
RMI_PORT	PPM server RMI port.
JMS_PORT	PPM server JMS port.

Run the sh kInstall.sh command. You can run this command either in interactive mode or silent mode.

Run kInstall.sh in interactive mode

Run kInstall.sh without any parameter attached and follow the on-screen instructions to provide required information to complete the installation.

For example, you will be asked to accept the terms of License Agreement, and to select the currency and region.

Run kInstall.sh in silent mode

Run kInstall.sh with specific parameters attached, for example:

sh kInstall.sh -a -H 1 -b USD -r Enterprise

Parameter(*Required) Description

Parameter(*Required)	Description
*`-a`, or `--accept-license`	Accepts the terms of the License Agreement.
*`-b` or `--base-currency`	Sets the system base currency. If no value is provided, the default value USD (US dollars) is used. For information on currency codes for other countries, see Financial Management.
`-c`, or `--calendar-name`	Sets the system default regional calendar. If no value is provided, the default value NONE is used. In that case, a new calendar with no holidays is set as the system default regional calendar.
`-d`, or `--database`	Installs the PPM database only.
`-f`, or `--filesystem`	Installs the PPM file system only.
*`-H`, or `--holiday-schedule`	Sets the holiday schedule on which to base the PPM regional calendar. If no value is provided, the default value 1 (US) is used. For information on holiday schedule codes for other countries, see Resource Management.
*`-r`, or `--region-name`	Sets the region for the installation. If no value is provided, the default value Enterprise is used.
`-t`, or `--trial`	Installs a trial license. For details about product license types, see Overview of the Autopass licensing solution.
`-F`, or `--force`	Available in 24.2 and later versions Deletes the database. Required when re-installing PPM. Note: Use this parameter with caution.
`-h`, or `--help`	Available in 24.2 and later versions Displays the description and usage of each parameter.

*-a, or

--accept-license

Accepts the terms of the License Agreement.

*-b or

--base-currency

Sets the system base currency. If no value is provided, the default value USD (US dollars) is used.

For information on currency codes for other countries, see Financial Management.

-c, or

--calendar-name

Sets the system default regional calendar. If no value is provided, the default value NONE is used. In that case, a new calendar with no holidays is set as the system default regional calendar.

-d, or

--database

Installs the PPM database only.

-f, or

--filesystem

Installs the PPM file system only.

*-H, or

--holiday-schedule

Sets the holiday schedule on which to base the PPM regional calendar. If no value is provided, the default value 1 (US) is used.

For information on holiday schedule codes for other countries, see Resource Management.

*-r, or

--region-name

Sets the region for the installation. If no value is provided, the default value Enterprise is used.

-t, or

--trial

Installs a trial license. For details about product license types, see Overview of the Autopass licensing solution.

-F, or

--force

Available in 24.2 and later versions

Deletes the database.

Required when re-installing PPM.

Note:

Use this parameter with caution.

-h, or

--help

Available in 24.2 and later versions

Displays the description and usage of each parameter.

(Optional) Configure the server.conf parameters in PPM. For details, see Server configuration parameters.
In the <PPM_Home>/bin directory, run the kUpdateHtml.sh command to deploy the configurations. For details, see kUpdateHtml.sh.
Install the license file by running the kLicenseInstall.sh command. For details, see Install licenses.
Start the PPM server by running the kStart.sh script. For details, see kStart.sh.