Server configuration parameters

This section introduces the server configuration parameters and describes how to configure them.

Overview of server configuration parameters

The server configuration parameter information on a PPM instance comes from the following sources:

Source Description
KNTA_SERVER_PARAM_DEF_NLS table The KNTA_SERVER_PARAM_DEF_NLS table is the definition table. It contains all the server configuration parameters and their default values.
server.conf file

Contains a subset of the server configuration parameters in the KNTA_SERVER_PARAM_DEF_NLS table. If you specify the value for a parameter directly in the server.conf file, either manually or from the Administration Console, then that value supersedes the default value for the parameter in the KNTA_SERVER_PARAM_DEF_NLS table.
KNTA_APPSERVER_PROPERTIES table

Contains the server configuration parameters and values that the PPM Server ultimately uses.

Parameter values in the server.conf file are compared with those in the KNTA_SERVER_PARAM_DEF_NLS table.

  • If a non-default value is specified for a parameter in the server.conf file, then the parameter is assigned that value in the KNTA_APPSERVER_PROPERTIES table.
  • If a parameter exists only in the KNTA_SERVER_PARAM_DEF_NLS table, then the parameter is assigned the default value in the KNTA_APPSERVER_PROPERTIES table.

Back to top

Modify server configuration parameters

You can modify the server configuration parameters either directly in the server.conf file or from the Administration Console.

To edit the server configuration parameters directly in the server.conf file:

  1. Stop the PPM server.

  2. Edit the server configuration parameters in the server.conf file.

    For the descriptions of the configuration parameters in the server.conf file, see Server parameters.

  3. Run the kUpdateHtml.sh script to regenerate the server.conf file and apply your changes. For details, see kUpdateHtml.sh.

  4. Restart the PPM server.

    To view a list of the server configuration parameter values on an active PPM Server, run the Server Configuration report. For details, see Run server reports from the Admin Tools window and Run server reports from the command line .

    If you make a change to the server.conf file that affects more than one node in a cluster, you must:

    • Stop all the nodes in the cluster.

    • Run the kUpdateHtml.sh script on each machine.

    • Start all the nodes in the cluster, one at a time.

Note: We recommend that you not modify the server.conf file directly. Instead, modify the values from the Administration Console unless the parameter is not available in the Administration Console. The Administration Console provides a graphical interface that you can use to change the server configuration parameter values.

For information about how to use Administration Console to modify parameter values, see Modify parameters from Administration Console.

Back to top

Server configuration parameters related to PPM Dashboard

The following table provides descriptions of the PPM Server configuration parameters related to the PPM Dashboard in the PPM standard interface. These parameters, like those parameters listed in Modify server configuration parameters are also located in the server.conf file.

The parameter names listed in the table are shortened versions of the actual names, all of which start with the string com.kintana.core.server.dashboard. For example, the full name of the Favorites-Disabled parameter is com.kintana.core.server.dashboard.Favorites-Disabled.

Parameter Name
(*Required)

Description, Usage

Default, Valid Values, Example

Application-Server

Specifies the application server for the PPM Dashboard.

Default:

JBoss 4.0

BaseURL

PPM Dashboard base URL.

Valid values:

Same value as set for the *BASE_URL parameter

Character-Encoding

Specifies the coding to use for text displayed in the PPM Dashboard.

Default: UTF-8

Chart-Width-
Restriction-Enabled

Setting this to true enables PPM Dashboard chart portlets to maintain their size, even with large numbers of data points. A chart maintains its size as long as the data in the chart is readable. For very large numbers of data points, the chart eventually grows.

Default: true

Valid values:
true, false

DSH - Center Name

PPM Dashboard center name.

Default: PPM

DSH - Org Units Supported

If set to true, enables org units in PPM Dashboard.

Default: true

Valid values:
true, false

DSH - Version

Specifies the PPM Dashboard version.

1

Dashboard-MLU-
Operational

Used with Supported-MLU-Languages, determines whether MLU is enabled in the PPM Dashboard.

Default: false

Valid values:
true, false

Dashboard-Page-
Auto-Refresh-Disabled

Auto-refresh option for the PPM Dashboard.

Default: false

Valid values:
true, false

dashboard.Pivotdata
set-Max-Cells

Determines the maximum number of cells (number of rows * number columns) in the List display mode of a pivot table portlet.

120,000

dashboard.Pivotdata
set-Max-Distinct-Cells

Determines the maximum number of unique aggregations (product of numbers of unique values in each column) in a pivot table.

10,000

dashboard.Pivotdata
set-Max-Distinct-In-
Column

Determines the maximum number of unique values in any column of a pivot table.

50

dashboard.Pivotdata
set-Max-Rows

Determines the maximum number of rows in the List display mode of a pivot table portlet.

25,000

Data-Source

Specifies the data source for the PPM Dashboard.

Default:

java:/ItgDS

Database-Type

Database used by the PPM Dashboard.

Default: oracle

Favorites-Disabled

Used to turn off the PPM Dashboard Favorites option.

Default: false

Valid values:
true, false

Fonts-Directory-
Path

Directory path of the fonts used by PPM Dashboard.

Example:

C:/Fonts/opt/fonts

Footer

Absolute URL path of the PPM Dashboard footer page.

Default: /web/knta/dsh
/DashboardFooter.jsp

Header

Absolute URL path of the PPM Dashboard header page.

Default: /web/knta/dsh
/DashboardHeader.jsp

Layout-Direction

PPM Dashboard layout direction in a web browser. (Because only the
left-to-right (ltr) page layout direction is supported, you can leave the value unspecified.)

  

List-Column-Header-
Size

Number of characters displayed in the column heading of list portlets. If the number of characters in a column heading exceeds this value, the heading is truncated. The default is 20 characters.

Default: 20

Valid values:
Positive integer

Non-SSL-Port

Non-SSL port used by the PPM Dashboard. In order for the PDF export feature to work when the PPM Server is configured to use SSL, the PPM Dashboard must have an HTTP port that can be accessed locally by ICE browser.

Default: N/A

pdf-render-timeout

Specifies the timeout (in seconds) for the export-to-PDF mechanism. This timeout is used while calling ICEbrowser. Should be used only for customers who cannot export to PDF because of database queries that return a large volume of data.

Valid values:
Any integer

openDataSource

Open data source used by the PPM Dashboard.

Default:

PDF-URL

PPM Dashboard URL for PDF files.

Default: N/A

PDF-Unicode-Font-
File-Path

Unicode font file path used by PPM Dashboard.

Default: N/A

Page-Auto-Refresh-Disabled

If set to true, disables the auto-refresh capability in the PPM Dashboard.

Default: false

Valid values:
true, false

Page-PDF-Export-Disabled

If set to true, removes the Export to PDF icon from the PPM Dashboard.

Default: false

Valid values:
true, false

Portlet-Thread- Batch-
Size

Specifies the batch size of threads used to process prefetch portlets simultaneously.

Default: 4

Valid values:
Any positive integer

Printout-Banner-Text

Determines the text to be displayed in the header of printouts (for example, the PDF header banner). If you specify no value, the center name is used.

Valid values:

Any text string

SQL-Debug

If set to true, enables SQL debugging in the PPM Dashboard.

Note: Unless you require detailed PPM Dashboard debug logs for support, keep this parameter set to false.

Default: false

Valid values:
true, false

Smtp-Port

Specifies an SMTP port for the PPM Dashboard.

Note: We recommend that you leave the value for this parameter unspecified.

Default: N/A

Smtp-Server

Specifies an SMTP server for the PPM Dashboard.

Note: We recommend that you leave the value for this parameter unspecified.

Default: N/A

Supported-MLU-
Languages

Specifies the languages supported for the PPM Dashboard. Use commas to separate multiple values.

Default: N/A

Valid values:

All languages supported by the current PPM version

Time-Zone

Specifies the time zone used in the PPM Dashboard.

Note: We recommend that you leave the value for this parameter unspecified.

Valid values:

Use-Full-Screen-
Width

Indicates that the PPM Dashboard page view occupies the full width of the screen.

Default: false

Valid values:
true, false

Web-Server

If the export-to-PDF functionality does not work and PPM is configured with an IIS or Apache Web server, set this value to try to restore the export-to-PDF functionality.

Valid values:

IIS, Apache

Back to top

Convert the server.conf file from Windows mode to UNIX mode

If you use Cygwin 2.8.0 or later on Windows, when you run some scripts such as kStart.sh, you encounter miscellaneous errors such as "Invalid username/password" or "Node cannot be found in server.conf" even when you provide correct information.

In this case, you should convert the server.conf file from Windows mode to UNIX mode by using the dos2unix command:

Copy code 
dos2unix <PPM_HOME>/server.conf
# transfer logging.conf
cd <PPM_HOME>/conf dos2unix *.conf
cd <PPM_HOME>/bin dos2unix *.sh

Back to top

See also: