Configuring BIRT Analytics FastDB
BIRT Analytics FastDB engine, also known as the dubnium engine, is a web-based, Extract, Transform, and Load (ETL) service that reads most data sources. On a Windows system, the default location and name of the dubnium executable file is:
<BIRTAnalytics Installation folder>\FastDB\dubnium.exe
On a Linux system, the default location and name of the dubnium executable file is:
<BIRTAnalytics Installation folder>/FastDB/dubnium
FastDB runs by default when BIRT Analytics starts. On a Windows system, FastDB typically runs as a Windows service, named BIRT Analytics - FastDB. FastDB reads configuration parameters from the file engine_configuration.ini. On a Windows system, the location of engine_configuration.ini is:
<BIRTAnalytics Installation folder>\data\FastDB
On a Linux system, the location of engine_configuration.ini is:
<BIRTAnalytics Installation folder>/data/FastDB
The configuration file contains only parameters that require a non-default value. As shown in Listing 2‑9, parameters are grouped by the functionality they affect. To set a value for a parameter, place the parameter name, an equal sign, and the value on a single line in the appropriate group. Listing 2‑9 shows the engine_configuration.ini code for BIRT Analytics FastDB installed in C:\BIRTAnalytics on a Windows system.
Listing 2‑9 engine_configuration.ini initial contents
[engine]
license = C:\BIRTAnalytics\data\FastDB\dubnium.lic
repository = C:\BIRTAnalytics\data\FastDB\databases
exchange_path = C:\BIRTAnalytics\data\FastDB\exchange
 
[log]
path = C:\BIRTAnalytics\log\engine.log
verbosity = 6
dbfibrillator_path = C:\BIRTAnalytics\log\dbfibrillator.log
 
[server]
admin_file_path = C:\BIRTAnalytics\data\FastDB\admin.sqlite
port = 8105
threads = 2
 
[memory]
maxmemorysystem = 4914
maxmemorythread = 2457
Table 2‑3 lists and describes the parameters that have a generic effect. These parameters have no default value. To set values for these parameters, place them at the beginning of the configuration file.
Table 2‑3 BIRT Analytics FastDB overall parameters 
Parameter
Description
Default value
batch
The name of a batch file to run
 
password
The password for the user that runs the batch file
 
user
The user that runs the batch file
 
working
The folder to use as the context for the batch file
 
Table 2‑4 lists and describes the parameters that configure the FastDB engine. To set values for these parameters, place them in the [engine] section of the configuration file.
Table 2‑4 BIRT Analytics FastDB engine configuration parameters
Parameter
Description
Default value
autocleanup
Whether to perform automatic clean-up of the FastDB repository cache. Set to 0 to disable automatic cache clean-up.
1
autolinkjumps
The number of jumps to accept before creating a new link automatically.
1
autoregeneratederived
Whether to perform automatic regeneration of derived columns. Set to 0 to disable automatic regeneration.
1
cxcachepagesize
The internal crosstab cache size. Do not change this value.
100000
cache_path
The path that contains the repository cache. The value is relative to the repository path.
cache
defaultpagesize
The default page size, which is the number of values returned in a request of discrete values of a column. This parameter takes effect only if the discreteValuesPageSize parameter in the BIRT Analytics web application clientsetting.xml file is changed accordingly.
100
defaultprecision
The default number of digits to display after the decimal point for numeric values.
2
exchange_path
The path to the folder containing import and export files.
<BIRTAnalytics Installation folder>\data\FastDB\exchange
firstdiscretethreshold
Number of rows after which to change strategy in first discrete operation.
1024
license
The path and name of the BIRT Analytics license file.
<BIRTAnalytics Installation folder>\data\FastDB\dubnium.lic
locale
The system wide locale. The locale determines the language used for error messages, date and time formats, and numeric symbols for thousands separator and decimal point. The locale format uses the standard Java convention of a two-letter language code, an underscore (_) character, and a two-letter country code. If translated messages are not available for the specified value, FastDB uses US English messages.
en_US
max_cache_size
The maximum size of the repository cache, in megabytes (MB). A value of 0 denotes no limit to the cache size.
0
max_dichotomous_columns
The maximum number of dichotomous columns to create from discrete values.
16
maximumprecision
The maximum number of digits to display after the decimal point for numeric values.
8
max_pivot_values
The maximum number of discrete values in a crosstab column to use as a pivot column.
1024
nonlinked_aggregated
Whether to aggregate crosstabs non-linked record values in a row. Set to 1 to aggregate values.
0
repository
The engine repository path.
<BIRTAnalytics Installation folder>\data\FastDB\databases
Table 2‑5 lists and describes the parameters that configure the FastDB logs. To set values for these parameters, place them in the [log] section of the configuration file.
Table 2‑5 BIRT Analytics FastDB log configuration parameters
Parameter
Description
Default value
communication
Whether to log the request and response communications with the server. Set to 1 to enable communication logging.
0
dbfibrillator_path
The path and name of the dbfibrillator server log file. The dbfibrillator server monitors the FastDB engine restarts the engine after a failure.
<BIRTAnalytics Installation folder>\log\dbfibrillator.log
expressions
Whether to log the syntax trees of expressions. Set to 1 to enable expression logging.
0
path
The path and name of the log file.
<BIRTAnalytics Installation folder>\log\engine.log
verbosity
An integer value denoting the level of detail to log. A smaller value logs less information. Valid values are 6 for INFORMATIONAL level and 7 for DEBUG level.
6
Table 2‑6 lists and describes the parameters that configure the FastDB memory usage. To set values for these parameters, place them in the [memory] section of the configuration file.
Table 2‑6 BIRT Analytics FastDB memory configuration parameters 
Parameter
Description
Default value
buffer_size_datasources
Datasources buffer size in kilobytes (KB).
8192
maxmemorysystem
Maximum system memory in megabytes (MB). Estimate the maximum value using the following formula:
[Server memory] - ([OS memory] * 2
4096
maxmemorythread
Maximum thread memory in megabytes. Each engine request uses a separate thread. Total memory usage for threads cannot exceed maxmemorysystem. Set the value for maxmemorythread according to the number of predicted concurrent requests.
2048
memorylogenabled
Whether to enable memory logging. This parameter takes effect only when log verbosity is at DEBUG level. Set to 0 to disable memory logging even at DEBUG log verbosity.
1
Table 2‑6 lists and describes the parameters that configure the FastDB remote data provider. To set values for these parameters, place them in the [rdp] section of the configuration file.
Table 2‑7 BIRT Analytics FastDB remote data provider (RDP) configuration parameters
Parameter
Description
Default value
ca_cert
A public transport layer security (TLS) certificate authority (CA) file.
 
connect_timeout
The connection time-out to the RDP server in seconds.
30
password
The password for the account specified by the username parameter.
 
proxy_addr
The IP address of the proxy server.
 
proxy_exceptions
A comma-separated list of hosts that do not use a proxy.
 
proxy_password
The password for the account specified by the proxy_username parameter.
 
proxy_port
The port on which to access the proxy server.
8080
proxy_type
The proxy type. One of the following values:
*HTTP
*HTTP_1_0
*SOCKS4
*SOCKS5
*SOCKS4A
*SOCKS5_HOSTNAME
HTTP
proxy_username
The name of the account used to access the proxy server.
 
ssl_verify
Whether to verify the transport layer security (TLS) certificate against a certificate authority (CA). Set to 1 to use a CA.
0
timeout
Execution time-out in seconds.
60
use_proxy
Whether to use a proxy server to connect to the RDP source. Set to 1 to use a proxy.
0
username
The account name for RDP server authentication.
 
Table 2‑8 lists and describes the parameters that configure the FastDB server. To set values for these parameters, place them in the [server] section of the configuration file.
Table 2‑8 BIRT Analytics FastDB server configuration parameters 
Parameter
Description
Default value
admin_file_path
Authentication and security file path. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
admin.sqlite
cert_country
Server certificate data: the country as a Java standard two-character code.
US
cert_email
Server certificate data: the contact e‑mail address. For example, administrator@yourdomain.com.
 
certificate
Server public certificate. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
server.pem
cert_locality
Server certificate data: the locality, which is a city or town. For example, New York or Barcelona.
 
cert_organization
Server certificate data: organization or company name. For example, OpenText.
 
cert_service_names
Server certificate separated service names. For example, yourcompany.com,192.168.0.55.
 
cert_state
Server certificate data: the state.For example, Texas.
 
connectiontimeout
Time-out of the connection to the engine, in milliseconds. FastDB closes the connection if no activity occurs in this period of time. A value of 0 denotes that the connection never times out.
0
daemon_pidfile
For internal use. Do not change this value.
dubnium.pid
dh_filename
Diffie-Hellman parameters file. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
dhparams.pem
enable_daemon
For internal use. Do not change this value.
0
enable_dbfibrillator
Whether to enable automatic restart in case of failure or a crash. Set to 0 to disable automatic restart.
1
enable_insecure_port
Start a listener on the non-secure, standard port, specified by the port parameter on the system specified by the ip parameter. Set to 0 to disable this port.
1
enable_secure_port
Start a listener on the secure, TLS port, specified by the secure_port parameter on the system specified by the ip parameter. Set to 1 to enable this port.
0
ip
Listener IP address. This system uses the ports specified by the port and secure_port parameters.
0.0.0.0
maxrequestlen
Maximum length of the request XML accepted by the FastDB engine. A request is a selection or domain specified by the user.
65535
port
Listener port for non-secure connections on the system specified by the ip parameter.
8105
private_key
Server private key. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
server.key
private_key_password
Password for server private key.
 
rand_filename
Random number file used for TLS calculations. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
ssl.rnd
root_ca_certificate
Root certificate authority (CA) public certificate. The default location for the file is:
<BIRTAnalytics Installation folder>\data\FastDB
cacert.pem.
secure_port
Listener port for secure connections on the system specified by the ip parameter.
8106
ssl_mode
Certificate mode for transport layer security (TLS). The following values are valid:
*simple to use a self-signed certificate
*complete to use a root certificate authority (CA)
simple
threads
Maximum threads per FastDB server.
5
winsvc_pass
Windows service registration password. Set a value to use a specific user rather than the default Local System account.
 
winsvc_user
Windows service registration user name. Set a value to use a specific user rather than the default Local System account.