Applications settings
PAGE CONTENTS
This page describes configuration settings for the PlanningSpace and SUITE cx applications, as they are controlled from IPS Manager.
For settings that can be made at the level of individual client users, IPS Manager controls the default value that clients will inherit, and whether clients are allowed to make changes from the default.
For application settings as they are controlled by Tenant administrators or client users, see the PlanningSpace User Manual.
Important: You must click the 'Save all changes' button at the top of the page to store the settings changes that you have made (the 'Discard changes' button can be used to undo changes if the 'Save all changes' button has not been pressed). Settings which have been changed from their default value appear in bold face. The 'Reset' button for each setting can be used to restore the default value (and click 'Save all changes' to perform the reset).
Overview of applications configuration
The following table summarises the different types of application setting.
| Setting type | Applies to | Can be set by | Location of setting controls | PowerShell cmdlets |
|---|---|---|---|---|
| Service setting | All tenants and all server machines | IPS Administrator | Applications > {APPLICATION} > Advanced | *-ApplicationServiceSetting
|
| Server setting | Server machine (all tenants) | IPS Administrator | Applications > {APPLICATION} > Advanced | *-ApplicationServiceSetting
|
| Tenant setting | Tenant (all server machines) | IPS Administrator | Applications > {APPLICATION} > Advanced | *-ApplicationServiceSetting
|
| Tenant Administrator | Tenant web interface (Settings) PlanningSpace client (Tenant settings) |
(Not applicable) | ||
| Client setting - scope 'Tenant' | Application client for all users in a tenant | IPS Administrator | Applications > {APPLICATION} > Client settings (Scope: Tenant setting) | *-ApplicationClientSetting
|
| Client setting - scope 'User' | Application client | IPS Administrator | Applications > {APPLICATION} > Client settings (Scope: User setting) (Note: IPS Administrator sets the default value for users, and can set the scope so that users cannot modify the value) | *-ApplicationClientSetting
|
| User | Client application software (Note: only if setting is not locked by IPS Administrator) | (Not applicable) |
PowerShell cmdlets are available for IPS Administrators to Get, Set or Reset all types of settings. See IPS PowerShell module (Automation cmdlets).
The 'Server' settings are intended to allow adjustment for different server machine hardware resources, for example if a server machine in a cluster is provisioned with extra resources for use as a 'large job' server. However most of these server-specific settings are located in the IPS Manager 'Servers' screen (see Servers configuration).
Client settings and scope
Each client setting has a scope, that is whether it is a 'User setting' which can be modified by the user of an application client, or it is a 'Tenant setting' which can only be modified by an IPS Administrator and has the same setting for all users in a tenant.
There is a default scope (User or Tenant) for each client setting, which is recorded in the tables below.
For some settings, the scope is changeable by an IPS Administrator. This possibility is marked in the tables below in the 'Scope change?' column, where the values are 'Yes', or blank meaning 'No'.
If a scope is changeable, an IPS administrator can do this:
- in the IPS Manager web user interface: click the 'Edit' button for a setting, and use the buttons to switch between 'Always default to this setting' (for Tenant setting) or 'Allow user to change default setting' (for User setting);
- using the PowerShell cmdlet
Set-ApplicationClientSettingto set the value of 'IsUserScope' to 0 (for Tenant setting) or 1 (for User setting).
Client settings have a 'ConfigFile' attribute, which is recorded in the top row of each table of settings (below). You will need to use this attribute string to get or set client settings using the PowerShell cmdlets, or using the IPS Admin API.
Basic settings (for each application)
Use the 'Basic' tab in the settings screen for each application - which is accessed from the main 'Applications' screen (click 'Applications' in the left-hand menu).
These application settings apply to all tenants and all server machines in a cluster.
Diagnostics settings
These two settings control the level of logging data which is recorded.
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. Default value is Info. 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. Default value is Info. These log messages appear in the Windows Event Viewer for each server machine. |
Application launch link setting
This setting can be used to modify the behaviour of the application's 'Launch' button in the tenant web interface. For example, to do a redirection to Intranet, or a hosted application portal, or launch an ICA or RDP file.
PlanningSpace application settings
Service settings
No settings for PlanningSpace.
Server settings (select the tab for each server machine)
No settings for PlanningSpace.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
| Preview Web Features | General | Enable or disable preview features in the PlanningSpace web application. Preview features may be changed or removed in a future release | False | Boolean |
| Enable Developer Options | General | Enable or disable developer options in the PlanningSpace web application. Developer features may be changed or removed in a future release | False | Boolean |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| HelpPageRelativeUri | Tenant | Relative URI for the user manual | 'PlanningSpace/Help' | path string | |
| EnforceKerberosAuthentication | Tenant | If True, enforce Kerberos authentication between the PlanningSpace client application and the IPS server | False | Boolean |
Dataflow application settings
Service settings
| Service Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| BulkDocumentUpdateBatchSize | Bulk Document Update | Sets the number of documents to be processed as a batch when performing bulk document update operation. | None | Integer |
| Cluster Temp Cleanup Period | Cluster Temp Cleanup | Sets how often the cleanup job should run | 00:01:00 | days:hours:minutes (00:00:00) in the range 00:01:00 to 01:00:00 |
| Cluster Temp Cleanup File Age | Cluster Temp Cleanup | Sets how old a file should be to be removed | 05:00:00 | days:hours:minutes (00:00:00) in the range 00:12:00 to 07:00:00 |
| DeclineWellRequestNodeThreshold | Decline | Sets the threshold for the maximum number of well hierarchy nodes to load per request | 50000 | 1 to 100000 |
| HierarchyRequestNodeCountThreshold | General | Sets the threshold for the number of nodes to preload | 50000 | 1 to 100000 |
| MinFreeDiskSpace | General | Minimum free disk space required in MB | 1024 | |
| IntegrationServicesIsServiceEnabled | IntegrationServices | If True, enable Integration Services | True | Boolean |
| IntegrationServicesMaxDocumentPageSize | IntegrationServices | Determines the maximum number of documents per page when returning data from the Dataflow 'Documents' endpoint ('PlanningSpaceDataflow/Data/V1/Documents'). This setting does not affect the page size for OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). | 2000 | Any 32-bit integer value; recommended range 10 to 5000 |
| IntegrationServicesRemoteErrorsEnabled | IntegrationServices | Set to True to provide more detailed error messages during troubleshooting/testing. It should be set to False during normal operation. | None | |
| ODataWideAndTallTableMaxRowsPerRequest | IntegrationServices | Maximum number of rows per page when requesting 'wide' and 'tall' tables in OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). This setting and several other factors will determine the actual page size used for an API request (see Integration Services (OData) for an explanation of the page size algorithm). Using the 'pagesize' API parameter will override this setting. The recommended value for this setting depends on server resources and typical loading: better API performance (by returning larger pages of data) requires more resource usage (more memory and CPU will be occupied). | 10000 | Any 32-bit integer value; recommended range 1000 to 200000 (but highly dependent on server resources and load level) |
| Cleanup Period | Log Cleanup | Sets how often the cleanup job should run | 00:01:00 | days:hours:minutes (00:00:00) |
| File Mask(s) | Log Cleanup | Sets the list of masks for files to be removed | DataflowDocumentUpdateJob_*.log | List with semicolon ';' as delimiter |
| Remove Files Older Than | Log Cleanup | Sets how old a file should be to be removed | 05:00:00 | days:hours:minutes (00:00:00) |
| Remove Update Operations Logs Older Than | Log Cleanup | Sets how old an update operation log should be to be removed | 14:00:00 | days:hours:minutes (00:00:00) |
| Reconciliation clean up enabled | Reconciliation Cleanup | If True, a cleanup process will run periodically to remove
'soft deleted' reconciliation data from
the tenant database (Setting added in version 16.4 Update 5) |
False | Boolean |
| Reconciliation clean up interval | Reconciliation Cleanup | Sets how often the reconciliation cleanup will
run (Setting added in version 16.4 Update 5) |
21:00:00 | days:hours:minutes in the range 1 day to 1000 days |
| Reconciliation clean up start date and time | Reconciliation Cleanup | Sets when the reconciliation cleanup will start (and repeating
at the specified time interval). The datetime is in UTC (Setting added in version 16.4 Update 5) |
15/02/1987 02:00 | dd/mm/yyyy hh:mm for years in the range 1500 to 3000 |
| Reconciliation clean up timeout | Reconciliation Cleanup | Sets the timeout for the reconciliation cleanup in hours,
i.e., the maximum time that the process will run (Setting added in version 16.4 Update 5) |
8 | 6 to 72 |
| Minimum Reporting Free Memory | Reporting | Sets a threshold (in Mb): report generation will be automatically cancelled if the remaining machine memory is less than this value | 1024 | 512 to 8192 |
| ReportDataSize | Reporting | Sets the threshold for reporting dataset generation in KB (0 = no limit) | 8000 | 0 or positive number |
| RunReportsIndependently | Reporting | If True, Dataflow report generation jobs are processed as
individual reports in independent jobs. If False, all reports are generated
in a single job and using the same dataset (Setting added in version 16.4 Update 5) |
False | Boolean |
| ReservesHierarchyRequestNodeThreshold | Reserves | Sets the threshold for the maximum number of reconciliation hierarchy nodes to load per request | 60000 | 1 to 100000 |
| ReservesReportDataSize | Reserves | Sets the threshold for Reserves Report dataset generation in KB (value 0 = unlimited) | 8000 | 0 or positive number |
| WorkflowHandleRefreshInterval | Workflow | Interval to refresh the Workflow handle to the persistence store | 30 | |
| AutoClearLogs | Workflow | If True, automatically clear instance logs | True | Boolean |
Server settings (select the tab for each server machine)
| Server Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| TemporaryIPSPath | General | Path used by IPS Server to store temporary files | None | File system path |
| MaxDegreeOfParallelism | General | Maximum degree of parallelism. If set to 0, the value (MaxLogicalCores - 1) will be used | 0 | Integer |
| TemporaryFilesFolder | Workflow | Path used by IPS Server to store temporary workflow files | None | File system path |
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
| MaxSpreadsheetImportSize | Documents | Maximum spreadsheet file size allowed for importing, in KB | None | Number |
| Disable Economics | Economics Integration | Disable the connection to Economics | False | Boolean |
| Enable Server Side Load | Loader | Enables server-side loading for the Load from Database tool | True | Boolean |
| ReservesMailSender | Reserves | Sender email address for automated emails | None | Email address string |
| ReservesGasVolumeBoeConversionFactor | Reserves | Gas volume/BOE conversion factor | None | Number |
| ReservesDisplayAutomaticTotals | Reserves | If True, show calculated total columns for reserves product and economic variables | True | Boolean |
| WorkflowMailSender | Workflow | Sender email address for automated email messages | None | Email address string |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| StartPageRelativeUri | Tenant | The relative or absolute URI for the Start Page displayed in the Dataflow dashboard at log on. An absolute URI must be prefixed with 'http' or 'https' | None | URI string | |
| HelpPageRelativeUri | Tenant | The relative URI for the help page used in all areas of the application apart from the 'Administration' area | 'PlanningSpaceDataflow/Help/' | path string | |
| AdminHelpPageRelativeUri | Tenant | The relative URI for the help page used in the 'Administration' area | 'PlanningSpaceDataflow/Help/' | path string | |
| MemoryDumpType | User | Yes | List of formats for the application memory dumps (use commas to separate, with no spaces) | MiniDumpWithPrivateReadWriteMemory, MiniDumpWithDataSegs, MiniDumpWithHandleData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithUnloadedModules | MiniDumpNormal, MiniDumpWithDataSegs, MiniDumpWithFullMemory, MiniDumpWithHandleData, MiniDumpFilterMemory, MiniDumpScanMemory, MiniDumpWithUnloadedModules, MiniDumpWithIndirectlyReferencedMemory, MiniDumpFilterModulePaths, MiniDumpWithProcessThreadData, MiniDumpWithPrivateReadWriteMemory, MiniDumpWithoutOptionalData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithCodeSegs, MiniDumpWithoutAuxiliaryState, MiniDumpWithFullAuxiliaryState, MiniDumpWithPrivateWriteCopyMemory, MiniDumpIgnoreInaccessibleMemory, MiniDumpWithTokenInformation |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| License.IsServerMode | Tenant | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean | |
| License.AllowModeChange | Tenant | This sets whether the application client user can switch between the server and file licensing modes. If True, the client user's License Manager dialog will provide a selection box "License: [From License Server] / [From License File]" | False | Boolean |
Economics application settings
Service settings
| Service Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| CalculationBatchSize | Calculation | The number of projects sent in one message for distributed processing | 100 | 10 to 500 |
| BuildCalculatorMaxParallelism | Calculation | Maximum degree of parallelism for building a non-ringfenced result set calculator | 2 | 1 to 64 |
| CurrencyConversionMaxParallelism | Calculation | Maximum degree of parallelism for currency conversion during result set calculation | 2 | 1 to 64 |
| PreCalculationCheckMaxParallelism | Calculation | Maximum degree of parallelism for pre-calculation checks during result set calculation | 2 | 1 to 64 |
| CalculationMaxParallelism | Calculation | Maximum degree of parallelism for calculation processes during result set calculation | 2 | 1 to 64 |
| CalculationResultSetStrategy | Calculation | BulkInsertion has a higher startup cost but is faster thereafter and is usually more efficient for large result sets. TableValuedParameter can be more efficient for small or medium-sized result sets. The number of projects written to the database in one call is determined by the CalculationBatchSize setting | BulkInsertion | BulkInsertion or TableValuedParameter |
| CalculationResponseSize | Calculation | Sets the number of project calculations after which progress is reported from the IPS distributed processing machine back to the IPS Server | 10 | 1 to CalculationBatchSize |
| IncrementalsCalculationMaxParallelism | Calculation | Maximum degree of parallelism for incrementals calculation process during result set calculation | 2 | 1 to 64 |
| IncrementalsResultsMaxParallelism | Calculation | Maximum degree of parallelism for incrementals calculation process saving the results into the Cluster Shared Temp Folder | 2 | 1 to 64 |
| RingfenceCalculationMaxParallelism | Calculation | Maximum degree of parallelism for ringfence calculation process during result set calculation | 2 | 1 to 64 |
| RingfenceResultsMaxParallelism | Calculation | Maximum degree of parallelism for ringfence calculation process saving the results into the Cluster Shared Temp Folder | 2 | 1 to 64 |
| Cleanup Period | Cluster Cleanup | Sets how often the cleanup job should run | 00:01:00 | 1 to 24 hours in format days:hours:minutes ('00:00:00') |
| Cleanup File Age | Cluster Cleanup | Sets how old a file must be before it is removed by the cleanup job | 02:00:00 | 12 hours to 7 days in format days:hours:minutes ('00:00:00') |
| DocumentSyncBatchSize | Dataflow/Economics Integration | Sets the number of documents to be processed as a batch when performing Dataflow/Economics document synchronization | 10 | 1 to 50 |
| IntegrationServicesIsServiceEnabled | IntegrationServices | If True, enable Integration Services | True | Boolean |
| IntegrationServicesMaxProjectPageSize | IntegrationServices | Determines the maximum number of projects per page when requesting result set data | 1000 | 10 to 10000 |
| IntegrationServicesMaxVariablePageSize | IntegrationServices | Determines the maximum number of variables per page when requesting result set data. This setting does not affect the page size for OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). | 50 | 10 to 10000 |
| IntegrationServicesRemoteErrorsEnabled | IntegrationServices | Set to True to provide more detailed error messages during troubleshooting/testing. It should be set to False during normal operation. | True | Boolean |
| ODataWideAndTallTableMaxRowsPerRequest | IntegrationServices | Maximum number of rows per page when requesting 'wide' and 'tall' tables in OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). This setting and several other factors will determine the actual page size used for an API request (see Integration Services (OData) for an explanation of the page size algorithm). Using the 'pagesize' API parameter will override this setting. The recommended value for this setting depends on server resources and typical loading: better API performance (by returning larger pages of data) requires more resource usage (more memory and CPU will be occupied). | 10000 | Any 32-bit integer value; recommended range 1000 to 200000 (but highly dependent on server resources and load level) |
Server settings (select the tab for each server machine)
No settings for Economics.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
| HierarchyLinkLimit | Dataflow/Economics Integration | The maximum number of Economics hierarchies that each Dataflow version can be linked to | 3 | 1 to 10 |
| MaximumNumberOfResultSetDebuggerProcess | Debugger | The number of result set debuggers that can run at the same time | 2 | 1 to 5 |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| StartPageUri | Tenant | The relative or absolute URI for the start page displayed in the 'Manage Inputs' area of the application at log on. An absolute URI must be prefixed with 'http' or 'https' | None | URI string | |
| HelpPageRelativeUri | Tenant | The relative URI for the help page used in all areas of the application apart from the 'Administration' area | 'PlanningSpaceEconomics/Help/' | path string | |
| AdminHelpPageRelativeUri | Tenant | The relative URI for the help page used in the 'Administration' area | 'PlanningSpaceEconomicss/AdminHelp/' | path string | |
| MemoryDumpType | Tenant | Yes | List of formats for the application memory dumps (use commas to separate, without spaces) | MiniDumpWithPrivateReadWriteMemory, MiniDumpWithDataSegs, MiniDumpWithHandleData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithUnloadedModules | MiniDumpNormal, MiniDumpWithDataSegs, MiniDumpWithFullMemory, MiniDumpWithHandleData, MiniDumpFilterMemory, MiniDumpScanMemory, MiniDumpWithUnloadedModules, MiniDumpWithIndirectlyReferencedMemory, MiniDumpFilterModulePaths, MiniDumpWithProcessThreadData, MiniDumpWithPrivateReadWriteMemory, MiniDumpWithoutOptionalData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithCodeSegs, MiniDumpWithoutAuxiliaryState, MiniDumpWithFullAuxiliaryState, MiniDumpWithPrivateWriteCopyMemory, MiniDumpIgnoreInaccessibleMemory, MiniDumpWithTokenInformation |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default value) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| License.IsServerMode | Tenant | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean | |
| License.AllowModeChange | Tenant | This sets whether the application client user can switch between the server and file licensing modes. If True, the client user's License Manager dialog will provide a selection box "License: [From License Server] / [From License File]" | False | Boolean |
Financials application settings
Service settings
| Service Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| CalculationBatchSize | Calculation | The number of projects sent in one message for distributed processing | 100 | 10 to 500 |
| BuildCalculatorMaxParallelism | Calculation | Maximum degree of parallelism for building a non-ringfenced result set calculator | 2 | 1 to 64 |
| CurrencyConversionMaxParallelism | Calculation | Maximum degree of parallelism for currency conversion during result set calculation | 2 | 1 to 64 |
| PreCalculationCheckMaxParallelism | Calculation | Maximum degree of parallelism for pre-calculation checks during result set calculation | 2 | 1 to 64 |
| CalculationMaxParallelism | Calculation | Maximum degree of parallelism for calculation processes during result set calculation | 2 | 1 to 64 |
| CalculationResultSetStrategy | Calculation | BulkInsertion has a higher startup cost but is faster thereafter and is usually more efficient for large result sets. TableValuedParameter can be more efficient for small or medium-sized result sets. The number of projects written to the database in one call is determined by the CalculationBatchSize setting | BulkInsertion | BulkInsertion or TableValuedParameter |
| CalculationResponseSize | Calculation | Sets the number of project calculations after which progress is reported from the IPS distributed processing machine back to the IPS Server | 10 | 1 to CalculationBatchSize |
| IncrementalsCalculationMaxParallelism | Calculation | Maximum degree of parallelism for incrementals calculation process during result set calculation | 2 | 1 to 64 |
| IncrementalsResultsMaxParallelism | Calculation | Maximum degree of parallelism for incrementals calculation process saving the results into the Cluster Shared Temp Folder | 2 | 1 to 64 |
| RingfenceCalculationMaxParallelism | Calculation | Maximum degree of parallelism for ringfence calculation process during result set calculation | 2 | 1 to 64 |
| RingfenceResultsMaxParallelism | Calculation | Maximum degree of parallelism for ringfence calculation process saving the results into the Cluster Shared Temp Folder | 2 | 1 to 64 |
| Cleanup Period | Cluster Cleanup | Sets how often the cleanup job should run | 00:01:00 | 1 to 24 hours in format days:hours:minutes ('00:00:00') |
| Cleanup File Age | Cluster Cleanup | Sets how old a file must be before it is removed by the cleanup job | 02:00:00 | 12 hours to 7 days in format days:hours:minutes ('00:00:00') |
| DocumentSyncBatchSize | Dataflow/Financials Integration | Sets the number of documents to be processed as a batch when performing Dataflow/Financials document synchronization | 10 | 1 to 50 |
| IntegrationServicesIsServiceEnabled | IntegrationServices | If True, enable Integration Services | True | Boolean |
| IntegrationServicesMaxProjectPageSize | IntegrationServices | Determines the maximum number of projects per page when requesting result set data | 1000 | 10 to 10000 |
| IntegrationServicesMaxVariablePageSize | IntegrationServices | Determines the maximum number of variables per page when requesting result set data. This setting does not affect the page size for OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). | 50 | 10 to 10000 |
| IntegrationServicesRemoteErrorsEnabled | IntegrationServices | Set to True to provide more detailed error messages during troubleshooting/testing. It should be set to False during normal operation. | True | Boolean |
| ODataWideAndTallTableMaxRowsPerRequest | IntegrationServices | Maximum number of rows per page when requesting 'wide' and 'tall' tables in OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). This setting and several other factors will determine the actual page size used for an API request (see Integration Services (OData) for an explanation of the page size algorithm). Using the 'pagesize' API parameter will override this setting. The recommended value for this setting depends on server resources and typical loading: better API performance (by returning larger pages of data) requires more resource usage (more memory and CPU will be occupied). | 10000 | Any 32-bit integer value; recommended range 1000 to 200000 (but highly dependent on server resources and load level) |
Server settings (select the tab for each server machine)
No settings for Financials.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
| HierarchyLinkLimit | Dataflow/Financials Integration | The maximum number of Financials hierarchies that each Dataflow version can be linked to | 3 | 1 to 10 |
| MaximumNumberOfResultSetDebuggerProcess | Debugger | The number of result set debuggers that can run at the same time | 2 | 1 to 5 |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| StartPageUri | Tenant | The relative or absolute URI for the start page displayed in the 'Manage Inputs' area of the application at log on. An absolute URI must be prefixed with 'http' or 'https' | None | URI string | |
| HelpPageRelativeUri | Tenant | The relative URI for the help page used in all areas of the application apart from the 'Administration' area | 'PlanningSpaceFinancials/Help/' | path string | |
| AdminHelpPageRelativeUri | Tenant | The relative URI for the help page used in the 'Administration' area | 'PlanningSpaceFinancials/AdminHelp/' | path string | |
| MemoryDumpType | Tenant | Yes | List of formats for the application memory dumps (use commas to separate, with no spaces) | MiniDumpWithPrivateReadWriteMemory, MiniDumpWithDataSegs, MiniDumpWithHandleData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithUnloadedModules | MiniDumpNormal, MiniDumpWithDataSegs, MiniDumpWithFullMemory, MiniDumpWithHandleData, MiniDumpFilterMemory, MiniDumpScanMemory, MiniDumpWithUnloadedModules, MiniDumpWithIndirectlyReferencedMemory, MiniDumpFilterModulePaths, MiniDumpWithProcessThreadData, MiniDumpWithPrivateReadWriteMemory, MiniDumpWithoutOptionalData, MiniDumpWithFullMemoryInfo, MiniDumpWithThreadInfo, MiniDumpWithCodeSegs, MiniDumpWithoutAuxiliaryState, MiniDumpWithFullAuxiliaryState, MiniDumpWithPrivateWriteCopyMemory, MiniDumpIgnoreInaccessibleMemory, MiniDumpWithTokenInformation |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default value) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| License.IsServerMode | Tenant | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean | |
| License.AllowModeChange | Tenant | This sets whether the application client user can switch between the server and file licensing modes. If True, the client user's License Manager dialog will provide a selection box "License: [From License Server] / [From License File]" | False | Boolean |
Portfolio application settings
Service settings
No settings for Portfolio.
Server settings (select the tab for each server machine)
No settings for Portfolio.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| UserSettingsLocation | Tenant | File system path for the location of the configuration file that will be used by the application. If value is not specified, the standard file system path for the user settings configuration file will be used | None | File system path |
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| ConfigurationFolder | Tenant | System file path for the folder where configuration templates, mapping templates and visualization templates are stored | %UserProfile%\Documents\Palantir\PlanningSpace Portfolio 16.4 | System file path | |
| ConfigurationTemplate | Tenant | Filename of the configuration template that is used to create new PLAN files | %UserProfile%\Documents\Palantir\PlanningSpace Portfolio 16.4\Configuration Templates\ExampleConfigurationTemplate.config | System filename | |
| DefaultStartYear | User | Default start year for PLAN documents | 2015 | ||
| DefaultDuration | User | Default duration (in years) for PLAN documents | 20 | ||
| HelpPageRelativeUri | Tenant | The relative URI for the help page (user manual) | 'PlanningSpacePortfolio/Help/' | path string | |
| License.AllowModeChange | Tenant | This sets whether the application client user can switch between the server and file licensing modes. If True, the client user's License Manager dialog will provide a selection box "License: [From License Server] / [From License File]" | False | Boolean | |
| License.IsServerMode | Tenant | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean | |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default value) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| LpOperationTimeout | User | Optimization will be terminated if it does not complete within this period (in seconds) | 60 | ||
| LpServer | Tenant | URL of the LP optimization server | 'https://solver.palantirsolutions.com' | ||
| MaximumCacheSize | Tenant | Maximum cache size in MB to store variable data | 2000 | ||
| MinimumCacheSize | Tenant | Minimum cache size in MB to store variable data | 1000 | ||
| NumberOfUndoActions | User | Number of 'Undo' actions that will be stored | 20 | Integer | |
| SpotfireExportTemporaryFileSize | User | Size in MB of temporary file for Spotfire export | 20 | ||
| UseSqliteForSnapshotsData | User | If True, save snapshot data in a SQLite file. If False, keep snapshot data in memory | False | Boolean |
PalantirCASH application settings
Service settings
| Service Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| PingSleepTimeInSeconds | Calculation | Delay interval in seconds before polling the database for new calculation jobs | 30 | Recommended maximum 60 |
| ResultSetDataBatchSize | Calculation | Sets the number of records that each batch will contain before insertion to the database | 50000 | Recommended maximum 50000 |
| IsResultSetDataSorted | Calculation | [Deprecated setting - do not use] If True, order the data by ResultSet, Sensitivity Run and Project Ids before insertion to the database | False | Boolean |
| IsParallelRun | Calculation | If True, the calculation should take place using parallel threads | True | Boolean |
| MixedPeriodicitySettings | Calculation | Mixed Periodicity Settings for result set calculations. For example, if the Mixed periodicity should contain first 1 year in Monthly, 2 years in Quarterly, 3 years in Semi-Annually, then set the value as 1:2:3 . StartYear is optional: for example to include a start year of 2010, set the value as 1:2:3:2010 | 1:2:2 | Monthly:Quarterly:Semi-Annually or Monthly:Quarterly:Semi-Annually:StartYear |
| IntegrationServicesIsServiceEnabled | Calculation | If True, enable Integration Services | None | Boolean |
| IntegrationServicesRemoteErrorsEnabled | IntegrationServices | Set to True to provide more detailed error messages during troubleshooting/testing. It should be set to False during normal operation. | True | Boolean |
| ODataWideAndTallTableMaxRowsPerRequest | IntegrationServices | Maximum number of rows per page when requesting 'wide' and 'tall' tables in OData API requests involving the denormalized entity sets (AllVariablesTall, AllScalarVariablesWide and AllPeriodicVariablesWide). This setting and several other factors will determine the actual page size used for an API request (see Integration Services (OData) for an explanation of the page size algorithm). Using the 'pagesize' API parameter will override this setting. The recommended value for this setting depends on server resources and typical loading: better API performance (by returning larger pages of data) requires more resource usage (more memory and CPU will be occupied). | 10000 | Any 32-bit integer value; recommended range 1000 to 200000 (but highly dependent on server resources and load level) |
Server settings (select the tab for each server machine)
No settings for PalantirCASH.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| UserSettingsLocation | Tenant | File system path for the location of the configuration file that will be used by the application. If value is not specified, the standard file system path for the user settings configuration file will be used | None | File system path |
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| ResultSetDataBatchSize | User | Yes | Sets the number of records that each batch will contain before insertion to the database | 50000 | Recommended maximum 50000 |
| IsResultSetDataSorted | User | Yes | [Deprecated setting - do not use] If True, order the data by ResultSet, Sensitivity Run and Project Ids before insertion to the database | False | Boolean |
| IsParallelRun | User | Yes | If True, the calculation should take place using parallel threads | False | Boolean |
| ExEngineWorkingFolder | User | Yes | Sets the folder to store temporary files when regime modules and depreciation methods are being edited. The SUITE cx applications must have read/write access to this folder | %LOCALAPPDATA%\Temp | File system path |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default value) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| License.IsServerMode | User | Yes | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean |
PalantirFINANCIALS application settings
Service settings
| Service Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| PingSleepTimeInSeconds | Calculation | Delay interval in seconds before polling the database for new calculation jobs | 30 | Recommended maximum 60 |
| ResultSetDataBatchSize | Calculation | Sets the number of records that each batch will contain before insertion to the database | 50000 | Recommended maximum 50000 |
| IsResultSetDataSorted | Calculation | [Deprecated setting - do not use] If True, order the data by ResultSet, Sensitivity Run and Project Ids before insertion to the database | False | Boolean |
| IsParallelRun | Calculation | If True, the calculation should take place using parallel threads | True | Boolean |
| MixedPeriodicitySettings | Calculation | Mixed Periodicity Settings for result set calculations. For example, if the Mixed periodicity should contain first 1 year in Monthly, 2 years in Quarterly, 3 years in Semi-Annually, then set the value as 1:2:3 . StartYear is optional: for example to include a start year of 2010, set the value as 1:2:3:2010 | 1:2:2 | Monthly:Quarterly:Semi-Annually or Monthly:Quarterly:Semi-Annually:StartYear |
| IntegrationServicesIsServiceEnabled | IntegrationServices | (REDUNDANT SETTING: No OData API endpoint exists for this application) | ||
| IntegrationServicesIsAtomSupportEnabled | IntegrationServices | (REDUNDANT SETTING: No OData API endpoint exists for this application) | ||
| IntegrationServicesRemoteErrorsEnabled | IntegrationServices | (REDUNDANT SETTING: No OData API endpoint exists for this application) | ||
| ODataWideAndTallTableMaxRowsPerRequest | IntegrationServices | (REDUNDANT SETTING: No OData API endpoint exists for this application) |
Server settings (select the tab for each server machine)
No settings for PalantirFINANCIALS.
Tenant settings (select the tab for each tenant)
| Tenant Setting name | Category | Description | Default value | Allowed values or range |
|---|---|---|---|---|
| MemoryLimitInGB | Cache | Cache memory size limit in GB | 1 | Determined by the server machine RAM |
| LogLevel | Cache | Cache log level setting | Info | Off, Trace, Info, Warning, Error, All |
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| UserSettingsLocation | Tenant | File system path for the location of the configuration file that will be used by the application. If value is not specified, the standard file system path for the user settings configuration file will be used | None | File system path |
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| ResultSetDataBatchSize | User | Yes | Sets the number of records that each batch will contain before insertion to the database | 50000 | Recommended maximum 50000 |
| IsResultSetDataSorted | User | Yes | [Deprecated setting - do not use] If True, order the data by ResultSet, Sensitivity Run and Project Ids before insertion to the database | False | Boolean |
| IsParallelRun | User | Yes | If True, the calculation should take place using parallel threads | False | Boolean |
| ExEngineWorkingFolder | User | Yes | Sets the folder to store temporary files when regime modules and depreciation methods are being edited. The SUITE cx applications must have the read/write access to this folder | %LOCALAPPDATA%\Temp | File system path |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port if not default value) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| License.IsServerMode | User | Yes | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean |
PalantirPLAN application settings
Service settings
No settings for PalantirPLAN.
Server settings (select the tab for each server machine)
No settings for PalantirPLAN.
Tenant settings (select the tab for each tenant)
No settings for PalantirPLAN.
Client settings (select the tab for each tenant)
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| UserSettingsLocation | Tenant | File system path for the location of the configuration file that will be used by the application. If value is not specified, the standard file system path for the user settings configuration file will be used | None | File system path |
| Client Setting name | Default scope |
Scope change? |
Description | Default value | Allowed values |
|---|---|---|---|---|---|
| ConfigurationFolder | Tenant | System file path for the folder where configuration templates, mapping templates and visualization templates are stored | %UserProfile%\Documents\Palantir\PalantirPLAN 16.4 | System file path | |
| ConfigurationTemplate | Tenant | Filemame of the configuration template that is used to create new PLAN files | %UserProfile%\Documents\Palantir\PalantirPLAN 16.4\Configuration Templates\ExampleConfigurationTemplate.config | System filename | |
| DefaultDuration | User | Default duration (in years) for PLAN documents | 20 | ||
| DefaultStartYear | User | Default start year for PLAN documents | 2015 | ||
| HelpPageRelativeUri | Tenant | The relative URI for the help page (user manual) | 'PalantirPLAN/Help/' | path string | |
| License.IsServerMode | User | Yes | This sets the initial behaviour when the client user starts the application. The client user will see in the License Manager dialog either (setting value True) "License Server" controls or (setting value False) "License File" controls | True | Boolean |
| License.ServerAddress | Tenant | Yes | This is the server address which is used as the initial client app setting for the license server (the client user can always change this setting) | URL with address (and web port) of the IPS Server or load balancer and the resource path 'licenseserver/' | URL string |
| License.UserSelections | User | Yes | One or more Licenses which can be automatically acquired so that the tenant user does not need to select a license for the application | None | List of licenses in the form {license ID}/{sequential number}|... |
| LpOperationTimeout | User | Optimization will be terminated if it does not complete within this period (in seconds) | 60 | ||
| LpServer | Tenant | URL of the LP optimization server | 'https://solver.palantirsolutions.com' | ||
| MaximumCacheSize | Tenant | Maximum cache size in MB to store variable data | 2000 | ||
| MinimumCacheSize | Tenant | Minimum cache size in MB to store variable data | 1000 | ||
| NumberOfUndoActions | User | Number of 'Undo' actions that will be stored | 20 | Integer | |
| SpotfireExportTemporaryFileSize | User | Size in MB of temporary file for Spotfire export | 20 | ||
| UseSqliteForSnapshotsData | User | If True, save snapshot data in a SQLite file. If False, keep snapshot data in memory | False | Boolean |