Install PPM with PostgreSQL (Beta)

You can install PPM with a PostgreSQL database.

In this topic:

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.

• 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 cygwin.com.

Back to top

Install PPM

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

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

2. 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 (applicable to 23.4 and later versions)
   • create_user.sh command (applicable to 23.4 and later versions)

3. (Applicable to 23.4 and later versions, for 23.3 and earlier, skip to step 5)

   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.

4. (Applicable to 23.4 and later versions, for 23.3 and earlier, skip to step 5)

   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.

5. 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

   The required parameters vary between versions.

   Required parameters for 23.4 and later versions

   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.

   Required parameters for 23.3 and earlier versions

   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.
   PG_SYSTEM	Superuser username for the PostgreSQL database.
   PG_SYSTEM_PASSWORD	Superuser password for the PostgreSQL database.
   PPM_DB_USER	User name for the PPM Center database.
   PPM_DB_PASSWORD	Password for the PPM Center database.
   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.

6. 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
   -f, or --filesystem	Installs the PPM file system only.
   -d, or --database	Installs the PPM database only.
   *-a, or --accept_license	Accepts the terms of the License Agreement.
   *-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 the Resource Management Guide.
   -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.
   *-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 the Financial Management Guide.
   *-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 the "Overview of the Autopass Licensing Solution" section in the the System Administration Guide.

7. (Optional) Configure the server.conf parameters in PPM. For details, see the "Server Configuration Parameters" part in the System Administration Guide.

8. In the <PPM_Home>/bin directory, run the kUpdateHtml.sh command to deploy the configurations. For details, see the "kUpdateHtml.sh" command in the System Administration Guide.

9. Install the license file by running the kLicenseInstall.sh command. For details, see the " kLicenseInstall.sh" command in the System Administration Guide.

10. Start the PPM server by running the kStart.sh script. For details, see the kStart.sh command in the System Administration Guide.

Back to top

Limitations

Using PPM with a PostgreSQL database has the following limitations:

• Only the English language is supported.

• The following modules, special commands, and reports are tested. They can work in most scenarios, but may not be fully stable.

  Entity type	Details
  Modules	Demand Management Project Management Program Management Time Management Portfolio Management Resource Management Financial Management User Administration Dashboard
  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 (applicable to 23.4 and later versions)
  Reports	Import Users Requested Detail Report Notification History Report Run License Usage Report Delinquent Time Sheets

  Note: Other modules, special commands, and reports that are not listed above are not verified.

• The following PPM-supplied portlets do not work with PostgreSQL:

  • Project Current Cost Metrics

  • Financial Summary to Financial Data Comparison

  • Financial Comparison

  • Operational Report

Back to top

See also:

• Before you install
• Upgrade PPM - PostgreSQL (Beta)