Service configuration
Click 'Service' in the left-hand menu to access all of these settings.
Service Settings
| Setting name | Description |
|---|---|
| Service address | The address of the IPS Server (either a single server machine, or the load balancer for a cluster) specified as a FQDN, DNS alias, or IP address. This setting is used by the IPS, Planning Space and CX Suite configuration files. |
| Data source | The database that is being used as the IPS common database. |
| Authorized cluster group | The IPS service account must be a member of the specified local security group in order to be able to create or modify an IPS Server cluster. |
| Cluster servers |
List of the IPS Server machines showing: FQDN, primary/secondary server status (primary if the box is ticked), the IPS version installed, and the status of the server. Allowed changes here are:
|
Endpoint settings
| Setting name | Description |
|---|---|
| Web Server: Use ... | One of the three options can be selected: Use https specifies to use HTTPS for the IPS Server, Use http specifies to use HTTP for the IPS Server, or Use SSL offloading specifies to use SSL offloading by the load balancer (then the load balancer must use HTTPS, and all traffic between the load balancer and the IPS servers will be HTTP). For details see Setting up HTTPS (secure HTTP) for IPS Server, SSL offloading. |
| Web Server: Use default port | Tick this box to use the default web port 80, or 443 if 'Use https' is enabled. |
| Web Server: Port | If Use default port is not checked, type in the port number. |
| Management: Monitor port | The server machine port used for monitor functions. Default is 81. Uses only HTTP and no user data is exposed on this port. |
| Cluster: Cluster port | The server machine port used for cluster management communications. Default is 82. |
Application ports
See IPS Server Application ports.
Diagnostics settings
The contents of log files can be configured with the settings in the following table.
Important: For an IPS Server cluser, log files are written separately on each server machine, based on the processes and events which occur only on that machine. There is no merging of log file content between the server machines.
| Setting name | Description |
|---|---|
| Main log level | The level of logging can be set to one of the following options (in order of increasing detail): Error, Warning, Info, Trace. The log file location is set for each server machine with the 'LogFolder' setting, in the 'Servers' screen, 'Advanced' section. |
| Event log level | The level of logging can be set to one of the following options (in order of increasing detail): Error, Warning, Info, Trace. These log messages appear in the Windows Event Viewer for each server machine. |
| Generate memory dump | If this box is checked, when an IPS server machine shuts down unexpectedly then a dump file will be written to the machine hard disk. The dump file location is set for each server machine with the 'DumpFolder' setting, in the 'Servers' screen, 'Advanced' section. |
Service certificate
The service certificate is required to enable secure HTTP (HTTPS) for the IPS Server, and therefore to have encrypted client-server communication for Planning Space and CX Suite applications.
There is no default certificate provided.
For set-up instructions, see Setting up HTTPS (secure HTTP) for IPS Server.
Mail settings
Support address: This should be the email address for local technical support of the Palantir software deployment. A dummy value 'support@company.com' is set as default.
SMTP settings
These are connection settings for an optional SMTP server, so that IPS Server can send automated emails to administrators and users for diagnostic purposes, or as part of workflows configured in Planning Space client applications.
In the 'Server' field, enter the FQDN of the SMTP server, and enter the port number in 'Port'. Check the 'Secure connection (SSL/TLS)' checkbox if the SMTP server requires this.
The SMTP 'Username' must be given in UPN format (i.e., 'user@mycompany.com'). For anonymous SMTP, leave the username and password blank. The value of 'Send from email' will be used as the sender address for automated emails sent by IPS Server to users.
Use the 'Test' button to verify that the SMTP server connection is functional.
A Mail administrator in your organisation will be able to provide a username and password for the SMTP server, or make the necessary modifications to allow the IPS server machines to connect via anonymous SMTP.
Advanced settings
The following table details the settings, default values, and allowed values. You can re-order the settings on the screen by clicking the up/down arrows next to the 'Name' or 'Category' headings
Note: Some setting names do not use spaces. However spaces are inserted for the names in the following table.
Use the 'Edit' button to change a setting value.
Use the red 'Reset' button to change the setting to its default value.
| Setting name | Description | Default Value | Allowed values or range |
|---|---|---|---|
| Category: Connection Pool | |||
| Tenant Max Pool Size | The maximum number of connections allowed for the SQL connection pool. The connections are used by Planning Space application processes to connect to a tenant database in SQL Server; they are taken and released automatically (each application instance may require multiple connections depending on the current activity of users). This setting should not require modification, even for larger-sized clustered deployments, unless a specific issue is identified with queuing and time-out of SQL Server connection requests. This setting is not related to IPS cluster inter-server communication, or Planning Space client-server communication. | 100 | Integer 10 to 32767 |
| Tenant Connection Lifetime | When a connection is returned to the SQL connection pool, its creation time is compared with the current time, and the connection is destroyed if the time difference (in seconds) exceeds the value specified by Tenant Connection Lifetime. A zero value ('0') will cause pooled connections to have the maximum allowed time-out. This setting should not require modification unless a specific issue is identified with queuing and time-out of SQL Server connection requests. This setting is not related to IPS cluster inter-server communication, or Planning Space client-server communication. | 0 | Integer |
| Category: Global | |||
| Display Language | Set the UI display language for Planning Space applications (only applies to Dataflow, Economics, and Financials). Note: this setting overrides any user locale/language preferences on client computers. [DEPRECATED SETTING: NOT TO BE MODIFIED] | en | |
| Category: IntegrationServices | |||
| Enable Windows Authentication | Added in version 16.5 Update 7 If set to True, Windows authentication will be enabled for handling OData API requests. | False | Boolean |
| Category: License Server | |||
| Enable Anonymous License Access | Added in version 16.5 Update 1 If set to True, anonymous requests to the license server will be allowed. If set to False, license requests must contain a valid access token. Anonymous access is not recommended but may be needed for backward compatibility or when legacy applications are in use. | False | Boolean |
| Category: Logging | |||
| Capture Api Traffic | Added in version 16.5 Update 5: If set to True, Web API and OData API requests will be logged in server-based log files. Default setting is 'False'. For Update 16 and later: Default setting is 'True'. | True | Boolean |
| Category: Notification | |||
| Certificate Expiration Notice Period | Starting from the specified number of days before the certificate expiry date, an expiry warning will appear in the IPS Manager. | 180 | 0 to 365 |
| Log Level | Sets the notification log level. | Info | Error, Warning, Info, Trace |
| Notification History | Number of days of notification message history that are stored in the IPS Common database. | 7 | 1 to 30 |
| Subscription Timeout Period | Time period in minutes before closing the session of an inactive client. | 5 | 5 to 30 |
| Category: Proxy | |||
| Use System Default | Specifies whether to use Internet Explorer proxy settings. If set to False (or blank), the Internet Explorer proxy settings will be overridden with the values specified by the IPS 'Proxy' settings, as listed below. | None | Boolean or None |
| Enable Proxy | If set to True then a web proxy will be used. | True | Boolean |
| Custom Proxy Address | The URL address of the proxy. | None | URL |
| Custom Bypass On Local | If set to True, the proxy will be by-passed for local resources. Local resources include the local server (http://localhost, http://loopback, http://127.0.0.1) and a URL without a period (for example http://webserver). | None | Boolean or None |
| Add IPS Server To Global Proxy Bypass List | If set to True, the Planning Space client application will directly access IPS server resources and it will not check the system default proxy settings, or the custom proxy settings. | False | Boolean |
| Category: Request processing | |||
| Session Idle Timeout | Interval in minutes to wait before closing a distributed compute session with no active request. | 5 | 2 to 120 |
| Category: Scheduler | |||
| Job History | Number of days that the output of a completed batch job or server task will be stored in the database. | 7 | Integer 2 to 30 |
| Job History Cleanup Batch Size | Number of job rows to delete in each Job History cleanup batch. | 500 | Integer 100 to 2000 |
| Category: Security | |||
| Allowed Api Key Names | Comma-delimited list of 'usernames' that will be allowed to submit requests to the Planning Space APIs with an API key used as the 'password'. | FeedKey,Account Key | Comma-delimited list or blank |
| Allowed URLs For Cross Origin Requests | Comma-delimited URL whitelist for cross-origin requests to this IPS Server (e.g., used to allow connection from add-in tools such as the PlanningSpace Data Connector for Excel). Include the port number if not 80 or 443. If the 'Use https' or 'Use SSL offloading' setting is enabled, only secure (https) URLs will be valid; if the 'Use http' setting is enabled, only http URLs will be valid. N.B. if the HTTP protocol of the IPS Server is changed then any connected server/service will also have to change protocol. | None | URL with protocol and FQDN, DNS alias or IP address |
| API Key Lifetime | [Added in version 16.5 Update 7] Sets the lifetime in days for a newly-created API key. If blank, the lifetime is unlimited. Note: changing this setting does not affect the expiration date (or unlimited status) of existing API keys. | blank | Number in range 0 to 366 or blank |
| ContentSecurityPolicy | [Added in version 16.5 Update 22] Sets the Content-Security-Policy HTTP response header for when the IPS server responds to static content requests. | default-src 'self' 'unsafe-inline' 'unsafe-eval'; font-src 'self' https://fonts.gstatic.com/; img-src 'self' data:; | |
| Category: Server Monitor | |||
| Enable Server Monitor | [Added in version 16.5 Update 13] If disabled (False) then all back-end data collection, API endpoints, and user interfaces will be stopped. | True | Boolean |
| Monitor History | Number of days of Server Monitor historical data that will be stored in the database. | 30 | Integer 2 to 30 |
| Sampling Interval | Time interval in seconds for sampling the performance monitors to provide data to the Server Monitor web application. | 30 | Integer 5 to 3600 |
| Performance Data Cleanup Batch Size | Number of rows to be deleted in each Performance Data cleanup batch. | 100000 | Integer 25000 to 1000000 |
| Category: Timeouts and Intervals | |||
| Cluster Rejoin Interval | Interval in minutes before a server attempts to rejoin the cluster. | 5 | 2 to 60 |
| Cluster Server Check Failure Threshold | Number of consecutive server check failures before setting a server to status 'Not Responding'. | 3 | Integer 3 to 20 |
| Cluster Server Check Interval | Interval in seconds between checks of the availability of a peer server. | 30 | 5 to 60 |
| Cluster Server Connection Timeout | Period in seconds before an attempt to open a connection to a peer server times out. | 30 | 5 to 60 |
| Cluster Server Operation Timeout | Period in seconds before a service call to a peer server times out. | 600 | 60 to 1200 |
| Data Source Check Failure Threshold | Number of consecutive data source check failures before a server disconnects from the cluster. The server will then attempt to rejoin the cluster after the time period specified by Cluster Rejoin Interval. | 3 | Integer 3 to 20 |
| Data Source Check Interval | Interval in seconds before checking the availability of the IPS common data source (the common database). | 10 | 5 to 60 |
| Launch Code Validity Period | Period in seconds before the auto-generated launch code becomes invalid. | 15 | 10 to 120 |
| Maintenance Mode Wait Period | Period in seconds before a server machine goes into maintenance mode following the Administrator's request. The wait period will begin after the monitor port has been stopped, and must therefore be longer than the health check interval for this server which is set on the load balancer. | 10 | 2 to 120 |
| Shutdown Timeout Period | Timeout period in seconds before the IPS server terminates, after receiving a shutdown request. | 15 | 10 to 60 |
| Tenant Unload Period | Period in seconds before completely unloading a tenant when there is a data source change. | 30 | 10 to 60 |