Runtime parameters reference
The runtime is configured using parameters defined in the engineParameters.xml
file, which is found in the properties/
sub-folder of the runtime installation directory.
This file includes the following configuration elements:
In this file, you can also configure:
-
The repositories storing the deliveries,
-
The Java options added to the runtime startup.
Configuration samples are provided in the properties/samples/ sub-folder of the runtime installation directory.
|
Passwords are encrypted using the encrypt <password> command on the runtime console
|
You can externalize the parameters in the engineParameters.xml file using environment variables.
|
Runtime parameters
The following parameters define the overall behavior of the runtime.
Parameter | Default value | Description | ||
---|---|---|---|---|
|
|
Temporary folder for the Runtime. Used by developers as a workspace, and by the Runtime to store some temporary files. |
||
|
|
Extension of the deliveries. Do not change this value. |
||
|
|
Default fetch value for reading data in databases. This value may be overriden by data flows designers or when configuring deliveries for production. |
||
|
|
Default batch update value for writing data into databases. This value may be overriden by data flows designers or when configuring deliveries for production. |
||
|
|
Default timeout database connections in seconds. |
||
|
|
Default timeout for database queries in seconds. |
||
|
|
Default number of sessions for the reporting part of the runtime. This value may be overriden by the graphical interface. |
||
|
Jython interpreter version used for scripting actions. To use another Jython version, copy the corresponding Jython files (you can download the Jython Standalone library files from the Jython website) to a
|
|||
|
|
Set to true to write the stacktrace to the standard output in case of an error. |
||
|
|
Set to true to write the statistics to the standard output at the end of a session. |
||
|
List of the variables used to compute the session statistics. |
Services
The following parameters configure the runtime services.
Service startup
Parameter | Default value | Description |
---|---|---|
|
|
Start the built-in scheduler. |
|
|
Start the execution engine. |
Services ports
Parameter | Default value | Description |
---|---|---|
|
SOAP and REST host (IP address or host name). You can specify it for specific network configurations. For example, when there are multiple domains, or when address translation generate different IP addresses for the same host. It defaults to localhost when undefined. |
|
|
|
Listening port for the SOAP and REST endpoints. |
Web services parameters
Parameter | Default value | Description |
---|---|---|
|
Optional user for queries to the SOAP server |
|
|
Optional password for queries to the SOAP server |
|
|
Optional unencrypted password for queries to the SOAP server |
|
|
Maximum number of concurrent threads on the SOAP server. If number exceeds this size, sessions are put on hold |
|
|
Optional user for queries to the REST server |
|
|
Optional password for queries to the REST server |
|
|
Optional unencrypted password for queries to the REST server |
|
|
|
Specifies if the input files created during web services invocations should be kept or not. The possible values are: |
|
|
Specifies if the output files created during web services invocations should be kept or not. The possible values are: |
|
|
Specifies if the fault files created during web services invocations should be kept or not. The possible values are: |
Security
Keystores
Attribute | Required? | Description |
---|---|---|
|
Yes |
Path to a Java keystore file, including the file name. Can be an absolute path, or relative to the main runtime directory. |
|
Yes |
Password of the keystore file. |
|
No |
Java keystore type. If undefined, the keystore type is set to the JVM default. This is usually |
Attribute | Required? | Description |
---|---|---|
|
Yes |
User-defined name to refer to this key in other parts of the runtime configuration, or in the command line. |
|
Yes |
Alias of the key as defined inside the keystore. |
|
Yes |
Password of the key entry in the keystore. |
|
No |
Which block cipher mode to use when encrypting or decrypting. |
Services
Parameter | Default value | Description |
---|---|---|
|
Protocol to be used to secure the endpoints. For example, TLSv1.1. |
|
|
Path to the Java keystore containing the certificate used to secure the endpoints. |
|
|
Java keystore type, such as |
|
|
Password of the keystore file. |
|
|
Alias of the key in the keystore. |
|
|
Password of the key. |
|
|
false |
By default, Runtime access restriction can be modified only when the Runtime is secured with HTTPS. |
Encryption
Parameter | Default value | Description |
---|---|---|
|
Name of the key used for all password encryption/decryption operation. This key must be in the keystore defined in the Runtime configuration. This parameter replaces the deprecated |
|
|
Name of the key used for password decryption while running a delivery. This key is used for passwords stored in deliveries. This key overrides |
Logging
In this part, the default values will be those used for the logs in H2 (the internal base). For other logs examples, please refer to the example files that are provided.
Logging configuration
The following parameters define the overall logging behavior of the runtime.
Parameter | Default value | Description | ||
---|---|---|---|---|
|
|
Debug level in the Runtime |
||
|
|
Database used for logging. A corresponding log database configuration must exist under the |
||
|
|
Scan delay of the logs that have been brought back to memory so as to be purged, in milliseconds. |
||
|
|
Default log level for the sessions. A higher value means that more information is logged. Possible values are:
|
||
|
true |
This parameter defines whether child sessions should inherit the log level from their parent session by default. This applies only for child sessions started without a log level defined. See Log level Inheritance for more details. |
||
|
Batch size used when performing purge operations on the log database. When this parameter is not specified the purge operations process all rows at once. Specifying a batch size avoids overloading the database for purge operations. |
Log database properties
The following properties can be set in the log database definition (<log>
node) to configure this database.
Property | Default value | Description |
---|---|---|
|
|
Name of the log database. This name is used in the |
|
|
Set to true to automatically update the tables of the log when needed. |
|
|
Java class used for logging. Do not change this value. |
|
|
Log capture mode:
|
Log database parameters
The following parameters can be set under a log database definition to configure the storage for this log database.
Parameter | Default value | Description |
---|---|---|
|
|
Driver used to communicate with the log database storage. This driver should be in the module specified in the |
|
|
Connection URL to the log database storage. |
|
|
User connecting to the log database storage. |
|
|
User password in clear text. |
|
User password, encrypted. Passwords are encrypted using the |
|
|
Module containing the libraries to communicate with the log database storage (typically a JDBC driver). |
|
|
|
Type used when the data is a character string. |
|
|
Maximum length of the character strings with the type defined above. |
|
|
Type used when the data is a numeric. |
|
|
Type used when the data is textual (CLOB, unlimited text) |
|
|
Type used when the data is binary (BLOB) |
|
logs Database schema name. |
|
|
|
Set to true to prefix index created with the log database schema name. |
|
|
Syntax of the delete commands. The name of the table to delete is added after this string. |
|
|
Type of compression used for the log database (if activated). Possible values: |
|
|
Delivery storage format in the log database. Possible values are |
|
|
Size above which character strings should be stored as CLOB. |
|
|
Size above which CLOBs should be stored as BLOB. The value |
|
|
Specifies the compression of the BLOB. Possible values are |
|
|
SQL query used to retrieve the current timestamp. |
|
|
Inactivity detection period. |
|
|
Inactivity refresh interval. |
|
Clause added after the SQL commands to creates indexes. Use this parameter to specify physical storage parameters such as tablespaces or underlying physical types. |
|
|
Clause added after the SQL commands which creates tables. Use this parameter to specify physical storage parameters such as tablespaces or underlying physical types. |
|
|
True |
Enables the connection pool. The connection pool stores and reuse in memory the opened connection when applicable. |
|
30000 |
Maximum number of milliseconds to wait to establish a connection. The default value is set to 30000 (30 seconds). |
|
600000 |
Amount of time in milliseconds allowed for a connection to sit in the pool before being retired. Set to 0 to disable idle connections retirement. The default value is set to 600000 (10 minutes). |
|
1800000 |
Maximum lifetime of a connection before it is retired from the pool. The default value is set to 1800000 (30 minutes). |
|
0 |
Frequency of the attempts to keep idle connections alive, to prevent database/network timeout, possibly using a connection test. Set this property to 0 to disable that feature. |
|
0 |
Minimum number of idle connections to maintain in the pool. |
|
20 |
Maximum number of idle and in-use connections in the pool. This property must be greater than the Minimum Idle property. The default value is set to 20. |
|
5000 |
Maximum number of milliseconds to wait for a connection test to succeed. The default value is set to 5000 (5 seconds). |
|
SQL query used to test or keep a connection alive. When unset, the Connection.isValid() JDBC method is used. |
Log level
The session log level defines the level of information which is logged inside log database for each session executed by the Runtime.
The higher the value is the higher information are logged.
You can find below the different log level values and what level of details can be consulted, depending on the session status.
Log Level | Running Sessions | Successful Sessions | Sessions with Errors |
---|---|---|---|
|
As child session, inherit log level from parent session, |
||
|
Use default session log level as defined in runtime configuration, |
||
|
Not logged |
Not logged |
Not logged |
|
Full details |
Not logged |
Full details |
|
Full details |
Session Header and Statistics |
Full details |
|
Full details |
Same as |
Full details |
|
Full details |
Same as |
Full details |
|
Full details |
Full details |
Full details |
Log level Inheritance
Child sessions started from a parent session without a specific log level may inherit their parent session’s log level, depending on the defaultChildSessionLogLevelInheritance
runtime property value.
In addition, you can set the following values for a session’s log level to override the inheritance machnism:
-
-2
forces the session to use the runtime’sdefaultSessionLogLevel
, ignoring thedefaultChildSessionLogLevelInheritance
property. -
-3
forces the session to inherit the parent session’s loglevel, ignoring thedefaultChildSessionLogLevelInheritance
property.
Miscellaneous parameters
Parameter | Default value | Description |
---|---|---|
|
|
Defines when Modules are loaded by the runtime:
|