System Registry Settings

Get details about resources consumed by BI server on executing the GetSystemInfo web service operation with the specified fields processInfo and cpuInfo.

Available values:

• 0. Default value. Executing a web service request returns brief information about consumed resources.

• 1. Executing a web service request returns detailed information about consumed resources.

To get details without specifying moniker, the request should contain the allowMetabaseNotFound field that is set to True.

NOTE. When the moniker is specified, detailed information is returned regardless of value of the GetSystemInfoExtended parameter.

It locks access to opened object instances.

Available values:

• 0. Default value. The object is write locked.

• 1. The object is read and write locked, and simultaneous reading from the object is possible with several threads.

It locks the entire session on processing requests. When the lock is enabled, requests to all objects within the session are executed one by one, otherwise they are executed concurrently, or individual locks are used (RWLockSlim).

Available values:

• 0. Default value. Lock is disabled.

• 1. Lock is enabled.

It locks access to opened dashboard instances. When the lock is enabled, read/write requests are executed one by one, otherwise they are executed concurrently. The lock is also enabled for nested objects accessed using the dashboard moniker.

Available values:

• 0. Default value. Lock is disabled.

• 1. Lock is enabled.

It collects time and memory statistics for performance counters.

Available values:

• IsOn. Statistics collection is enabled.

• Memory. Memory spent on any actions is calculated.

• Time. Time spent on any actions is calculated.

• Sql. It collects statistics of executing SQL queries to the repository database.

• Cube. It collects cube execution statistics (building cube matrix according to the received selection).

• Pivot. It collects statistics on working with pivots for building express report tables.

• Sheet. It collects statistics on working with express report data tables.

• Dim. It collects statistics on building dimensions used in various repository objects.

• Rub. It collects statistics on building a time series database (getting series data according to the specified period).

• Laner. It collects statistics on working of the table with the workbook data.

• Report. It collects statistics on regular reports calculations.

• RepSheet. It collects statistics on regular report sheets calculations.

• RepDataIsl. It collects statistics on data areas calculations.

• RepTabIsl. It collects statistics on relational data areas calculations.

• Fore. It collects statistics on work of macros and event handlers in regular reports.

The IsOn checkbox is always specified, otherwise the statistics is not collected. Other checkboxes that indicate, which counters must be used, are listed and separated with commas. Specifying only the IsOn checkbox equals to selecting all checkboxes.

It collects time and memory statistics for performance counters.

Available values:

• 1. Collect statistics only for operations (times of execution, timing, and so on).

• On. Collect all statistics (on requests, on operations, memory/timing). This parameter is outdated, use the SamplingStr parameter instead.

An identifier of a repository, which contains system tables to store collected statistics (creating system tables to collect statistics is executed by means of the PP.Util utility).

Period of inactivity (no requests), after which a session with repository is closed. The period of time is set in seconds in the range [60, 127800]. When the value is set to -1, the timeout period is not limited. Default value is 1800.

Object state save and restore mode at state server. It is used with the StateServer settings group.

Available values:

• Never or 0. Default value. Do not save and do not load object states.

• Yes or 1. Save on change, load on absence in the session.

• Ever. Save on change, load always.

Generate consecutive session and object monikers.

Available values:

• 0. Default value. Generate monikers via GUID.

• Yes or 1. Generate consecutive monikers (for example, S1!M).

It sets a limit for the number of export results stored on the server with each object (for express reports and regular reports).
The default value is 0, but the number of saved results is not limited.

Maximum total size of loaded binary objects within the session. The size is indicated in bytes by default. If B, K or M Latin character is specified after the value, the value size is set in bytes, kilobytes, or megabytes respectively. The default value is 0, and the loaded volume is not limited.

It sets a limit to the number of repository database connections.

Available values:

• 0. Default value. Do not reuse connection, always create a new one.

• <0. Reuse without limit to the number (add a new connection if there are no free connections).

• >0. Reuse with the limit to the number of connections specified in the parameter.

NOTE. The PoolMaxConnections parameter is outdated, it is left for compatibility with previous versions of Prognoz Platform. Use the MaxConnections parameter in the registry subsection [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\PP\BIS\System\Pool].

Processing mode of the GetStatus operation that is used in the web application to check connection status.

Available values:

• 0. Default value. Sending request prolongs the repository session.

• 1. Sending request does not prolong the repository session. If there are not other requests, the session will be interrupted after the timeout is over that is set in the TimeoutSec parameter.

This subsection is used to create parameters that affect operation of BI server application pool.

• MaxConnections. Maximum number of pool connections. Available values:

• -1. Connection pool is enabled.

• 0. Connection pool is disabled.

• Value is greater than zero. Connection pool is enabled, the maximum number of connections is set (by default it is limited to 50 connections).

• Strategy. Algorithm for discarding connections from the pool when it is required to free space for a new connection. Available values:

• LRU. Algorithm of discarding the least recently used connections (LRU algorithm).

• Balance or Default. Discarding based on the ratio number of opened repositories/number of opened database connections.

• UserMaxConnections. Maximum number of connections created with the same credentials. The default value is 0, and the number of connections is unlimited.

• RetryCount. The number of attempts of connection business check. Available value - [1; 1600], by default, there are 160 attempts.

• RetryInterval. Interval between attempts in milliseconds. Available value - [10; 4000], by default, it is 400 milliseconds.

Additional subsections that contain parameters for specific repositories can also be created in the Pool subsection. A created additional subsection must have a unique name. It can be used to create the following parameters:

• Db. Connection parameters for the user in the following format: {user_name}:{repository_identifier}@{database_server};

• UserMaxConnections. Maximum number of connections with the specified repository using the specified account.

NOTE. Connection pool parameters are applied, if the MaxConnections parameter value is greater than zero.

Parameters of connection to state server.

• Type. State server type. Available values:

• MemCached.

• Redis.

To set up state server, make sure to set one of the values depending on the application.

• Host. IP address or DNS name of the state server. Default value: localhost.

• Port. Number of the port that will be used for connection. If the value is -1, the default port is used: 11211 for MemCached and 6379 for Redis.

• ExpireTime. Records storing time in seconds on state server. If the parameter is not set or is equal to 0, records are stored infinitely. It is used for Redis.

To set up authentication on state server, create the Credentials subsection and set the Crs and Crsa parameters. In the parameters specify user credentials to connect to state server in encrypted form. Encrypted values of the parameters can be obtained using the PP.Util utility and the /encrypt_creds parameter.

This subsection stores private key of the security certificate. Parameters of this registry subsection are created at the runtime of PP.Util utility.

• Alg. Encryption algorithm.

• Data. Encrypted private key of the security certificate.

• Id. Security certificate identifier.

• Key. Security certificate GUID.

IMPORTANT. Parameters of this subsection must not be edited manually.

Parameters of objects for statistics collection. In this subsection the user needs to create additional subsections with names matching repository identifier. A parameter can be created in each additional subsection:

• StatKeys. Keys of individual repository objects listed via comma, which will be used to collect information for performance counters.

Work parameters via the OAuth 2.0 or OpenID Connect protocol for user authentication on external servers that support this protocol.

If authentication via external services is used, one should set up connection between the client and the BI server via HTTPS protocol. The "state" parameter is checked by default to protect from potential CSRF attacks on getting authorization code. If connection between the client and the BI server is set up via HTTP protocol, create the StateCheckOff parameter and set it to 1 to disable the check.

To set up interaction with external services inside the OAuth section, create subsections with OAuth/OpenID Connect authentication server names. Each subsection has its own specific parameters. The following parameters of OAuth/OpenID Connect authentication servers are available:

Parameters of work with the list of repositories. Allowed string parameter:

• AccessMode. Indicates whether the Settings button is displayed in the login dialog box and a list of repositories can be created. Available values:

• 0. Default value. The button is not displayed, the existing list of repositories and connection parameters are read-only.

• 1. The button is displayed, creating a list of repositories and changing connection parameters is fully available.

Parameters of SQL queries execution with the use of BI server. These parameters affect BI server work if it is used as a client for access to DBMS.

• Allow. Permission for executing SQL queries via BI servers. Available values:

• 0. Default value. Executing SQL queries is denied.

• 1. Executing SQL queries is allowed.

Parameters for working with development environment objects.

• Disallow. Indicates whether Fore macros are denied using the ForeExec operation. If the value is 1, macros are denied, execution of the ForeExec  operation is checked on BI server side. If the value is 0, or the parameter is missing, execution is checked by the web application with the value of the foreExec parameter in the PP.xml file.

Web form work parameters.

• Port. BI server port, via which web forms work according to the WebSocket protocol. The 9091 port is used by default.

The subsection which stores service user credentials:

• Realm. Credentials scope. As a key value, the identifier of the Database object is displayed, which work involves the specified credentials.

• Crs/Crsa. Encrypted service user credentials.

The subsection, in which end points to remote servers are specified. For each point create a subsection with a unique name, add a parameter for each subsection:

• address. Actual address of a remote BI server.

The subsection contains repository settings. To set up, inside Mbs create a subsection with a unique name, that is, repository identifier. The parameter can also be specified inside the created subsection:

• endpoint. A unique name of the access point specified in the Epts section. The specified end point will be used to address cache data on creating repository cubes. If an empty string is specified as the name, the current BI server is addressed. The specified access point is used for all default repository cubes unless another access point is specified for specific cubes in the Cubes subsection.

Additional subsections with settings can also be created for repository inside each subsection:

• Cubes. The subsection contains settings for specific repository cubes, which are used to address cached data in remote BI servers. To set up, create a subsection with a unique name, in which add the following parameters:

• Keys. Cube keys via comma, without spaces.

• endpoint. A unique name of the access point specified in the Epts subsection.

For example:

[HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Service\Mbs\WAREHOUSE\Cubes\InMemSettings]

Where:

• WAREHOUSE. Repository identifier.

• Cubes. Subsection for setting up specific repository cubes.

• InMemSettings. Subsection for specifying cube keys and unique name of access point.

• UpdCache. The subsection contains settings the determine from where cube cache update starts. To set up, add the following parameter:

• endpoint. A unique name of the access point specified in the Epts subsection.

If the UpdCache subsection is created, the BI server, to which the specified access point corresponds, will be used on executing cache update task in scheduled tasks container.

Data caching mode for cubes, including ADOMD cubes and time series databases.

Available values:

• file. File cache data caching.

• global. Default value. Global cache data caching.

If the CacheType parameter is not contained in the registry, the UseInMem parameter is checked:

• If the UseInMem parameter is contained in the registry, file cache or global cache is used depending on the specified value.

• If the UseInMem parameter is not contained in the registry, global cache is used by default.

Indicates whether the In-Memory mechanism is used for data caching of cubes, including ADOMD cubes and time series databases in file cache.

Available values:

• true. File cache data caching.

• false. Default value. Global cache data caching.

IMPORTANT. The UseInMem paameter is outdated and is used for compatibility with previous versions. To determine a data caching mode, use the CacheType parameter. If the UseInMem and CacheType parameters are set at the same time, the value of the CacheType parameter has a higher priority.

NOTE. The parameter may be set to True if the CacheType parameter is set to file. If the CacheType parameter is set to global, the CacheDims parameter is automatically set to False.

The path to the folder with stored cache files. If the parameter is not set, files are saved to the folder by default:

• Windows. «C:\ProgramData\Foresight\Foresight Analytics Platform\inmem_data\»;

• Linux. /var/tmp/inmem_data.

NOTE. The operating system user who will work with cached data must have read and write permissions for the specified folder.

Disk space limit allocated to store aggregated data cache. Value is given in megabytes. Default parameter is not set. If parameter is set, when the limit exceeds, outdated or unused cache data will be deleted. Minimum disk space size that can be allocated to store aggregated data cache is 1024 MB.

NOTE. If aggregated data cache size exceeds the specified limit, but all aggregated data is currently in use, cache data will be cleared at the next aggregated data cache generation.

It indicates whether aggregated data is stored in cache that can be obtained on aggregation of fixed dimensions. Aggregated data is not stored in cache by default. To enable aggregated data caching, set the parameter to True, as this allows for the data to be quickly loaded and saves time avoiding repeated aggregate calculations on selection change, if source data was not changed. If data volume is too large, the first caching of aggregated data may take a long time and considerably increase the disk space used by cache.

Matrix aggregation operation mode. Matrix aggregation is applied, if on working with cached data the aggregated values are not cached in files, and they are calculated in memory each time.

Available values:

• false. Matrix aggregation is disabled. The mode is not intended to be used in production conditions.

• true. Default value. Matrix aggregation is applied for all aggregation types, except for aggregations that are used for default output in standard cubes. For the default output in standard cubes, aggregated data will be cached and the work will continue with cached values.

• force. Do not use cached aggregated values, force calculate all aggregation types in memory. The mode is not intended to be used in production conditions.

• optimal. Behavior as with the True value, but if there is a possibility to cache calculated aggregated values, caching will be executed and work will continue with data from cache. The characteristic of the mode is aggregation when custom alternative aggregation is set for one or several dimensions, in this case only aggregation by dimensions with own hierarchy of elements is cached and aggregation by dimensions with alternative hierarchy is calculated over results of cached aggregation in separate calculation step.

Matrix aggregation mode application threshold. The parameter is relevant if the MatrixAggr parameter is set to optimal.

During the work, the size of selection (Cartesian product of selected elements) sent for data aggregation production is calculated. If the obtained size is less than the value set in OptimalThreshold, matrix aggregation is applied. If selection size is greater than the OptimalThreshold value, aggregated values will be calculated and cached to file cache.

The default threshold size is 10000. If the OptimalThreshold parameter is set to 0, it will not be taken into account.

Attribute of data preload from cache to memory on the first cube request.

If the parameter is set to True, then on the first request to any cached cube its cache is scanned for full loading into the RAM. As a result, the first cube use will be slow and all the following will be significantly quicker. It can be used to implement data preloading.

The parameter is set to False by default.

NOTE. Preloading is executed till the RAM size or the MemLimitMb parameter value are not exceeded.

It indicates whether a pool of new pages with cached data in memory is used. To use the pool, set the parameter to True. The pool use can considerably speed up the work with high load, but it will also lead to the excessive use of the RAM.

The parameter is set to False by default, the pool of cached data pages is not used.

Indicates whether a dictionary is used in the cross-session cache mode.

The REG_DWORD parameter. Available values:

• 0. Default value. A dictionary is not used in the cross-session cache mode.

• 1. A dictionary is not used in the cross-session cache mode.

Activation of syslog server connection for forwarding security event messages.

The REG_DWORD parameter. Available values:

• 0. Default value. The connection is not used.

• 1. The connection is used.

IP address of syslog server.

String parameter. The IPv4 protocol is available only. The default value: 127.0.0 1.

Port of syslog server for incoming connections.

The REG_DWORD parameter. Default value: 514.

Protocol used for forwarding.

The REG_DWORD parameter. Available values:

• 0. Default value. The UDP protocol.

• 1. The TCP protocol.

Save checksum calculation result of the lpsolve55.dll library for Windows OS or the liblpsolve55.so library for Linux OS.

String type parameter. As a parameter value, set full path to the file with checksum calculation result.

The parameter should be added on local computers of all users.

For details about integration with LPSolve, see the Connecting External Modules to Foresight Analytics Platform section.

Additional debug info in calculations.

The REG_DWORD parameter. Available values:

• 0. Default value. Additional debug info is not displayed.

• 1. Full information about the selection, based on which calculation is executed. The selection is created taking into account filtering and parameter values. The matrix with attribute values is displayed for selected dimension elements.

If data filtering is enabled, full information about is added with the information about calculation mode depending on whether data filtering sources contain a calculation block destination cube. If no, multithreaded calculation will be applied.

• 2. Full information about selection will be added with the matrix with changed values obtained after calculation.

• 3. Full information about selection and the matrix with changed values are added with the information about data aggregation: selection, by which aggregation is executed, aggregation calculation time, aggregation result.

IMPORTANT. The parameter does not affect algorithm calculation speed on executing collection and output of additional debug info.

The parameter should be added on local computers of all users.

For details about getting debug info on calculations see the How to View Debug Information on Calculations? section.

Changing the maximum number of threads, by which parallel iteration calculation will be executed, on calculation of calculation blocks and/or control blocks. The maximum of 8 threads is used by default on multithreaded calculation.

The REG_DWORD parameter. If the specified parameter value is less than the number of processor cores, the number of threads specified in the parameter will be used. If the specified parameter value is greater than the number of processor cores, the number of threads equal to the number of cores will be used.

NOTE. When specifying the parameter take into account the architecture of Intel processor 2019 or later. When calculating iterations, the doubled number of streams is used relative to the specified parameter value.

The parameter should be added on local computers of all users.

For details about multithreaded calculation see the How to Execute Multithreaded Calculation? section.

The use of various versions of attribute element values of version dictionary in calculation formula on pointwise calculation of the entire algorithm and/or a specific formula.

The REG_DWORD parameter. Available values:

• 0. Default value. When calculating an algorithm, element values for each calendar point will be fixed on calculation start date.

• 1. When calculating an algorithm, element values for each calendar point will be rebuilt depending on the current calculation date.

IMPORTANT. The use of the parameter with the 1 value results in decreased performance and slowdown in algorithm calculation.

The parameter should be added on local computers of all users.

For details about calculation formulas see the Setting Up Calculation Formulas section.

NOTE. The parameter can be used only in the desktop application.

Indicates whether recursive queries are used on getting repository object dependencies. It is relevant if a repository is created based on PostgreSQL/Postgres Pro or SQLite DBMS. The parameter is ignored for other DBMS.

Available values:

• 0 or False. Default value. Recursive queries are not used.

• 1 or True. Recursive queries are used to get object dependencies and dependencies of dependent objects and their children.

Access restriction to MDM dictionary elements using key ranges that are used to assign user with roles: vendor, counterpart, customer. A role allows for adding and editing MDM dictionary elements in its own key range and in the next key ranges located in ascending order. Elements with keys from the key range located in descending order will be unable for editing.

For details about access permissions for MDM dictionary elements see the Access Permissions for MDM Dictionary Elements section.

The REG_DWORD parameter. Available values:

• 0. All elements are available. A role is not assigned.

• 1. Available key range of elements from 0 to 1 bln. User role - vendor.

• 2. Available key range of elements from 1 to 1.5 bln. User role - counterpart.

• 3. Available key range of elements from 1.5 to 2 bln. User role - customer.

The parameter should be added on local computers of all users.

NOTE. The parameter can be used only in the desktop application.