Overview of All System Options

Qorus System Options

Option	Type	Default	Description
alert-fs-full	int	`85`	The percentage above which an alert will be raised due to a full filesystem
alert-smtp-connection	string	- none -	The name of the user connection for the SMTP server for delivering alert emails
alert-smtp-enable	bool	`False`	A flag allowing alert emails to be enabled or disabled at runtime
alert-smtp-from	string	`alert_noreply@$instance`	Source/from email address for alert emails
alert-smtp-interval	int	`60`	The interval in seconds for grouping and delivering alert emails
alert-smtp-to	list of strings	- none -	List of email addresses for delivering alert emails
async_delay	int	`600`	Value in seconds: the amount of time a workflow in OMQ::WM_Recovery mode will wait before trying to recover a step with OMQ::StatAsyncWaiting status
audit	list of strings	- none -	List of string auditing options, for possible values, see Audit Options
auto-error-update	bool	`True`	If True, then adding new error definitions for workflows will automatically create or update workflow-specific or global error defintions (the default behavior); if False, then only new global error definitions will be created automatically and updates are never made automatically; updates can only be made manually when this option is False
auto-recover	bool	`False`	If True, will recover any open session with the same instance key if the server cannot be reached on the URL stored in the `SESSIONS` table
autostart-interfaces	bool	`True`	If True, then workflows, services, and jobs are started automatically when the system is started according to their configuration; if False, then no interfaces are started automatically when the system is started regardless of their configuration
cache-max	int	`100000`	Maximum number of workflow order data instances to cache after a detach.
compat-http-utf8	bool	`False`	If `True` then the any HTTP text messages received will be assumed to be in UTF-8 encoding if no charset= entry is included
compat-strict-bool-eval	bool	`False`	If `True` then the `%strict-bool-eval` parse option will be enabled for all user code
compat-string-numbers	bool	`False`	If `True` then the `"string-numbers"` DBI option will be set on all datasources that support this option
connection-modules	list of strings	- none -	List of user modules defining user-specific connection types
daemon-mode	bool	`True`	If True, will fork into the background after the process has started
db-max-threads	int	`10`	Maximum number of parallel tasks to execute when running special database tasks in parallel; should not be larger than system-pool-maximum
dbparams-file	string	see desc.	The path to the file containing database connection parameters; the default value depends on the Qorus installation location
defines	hash	- none -	Set of parse defines for all user code (workflows, services, and jobs) and also for Connection Definition Files
detach-delay	int	`3600`	Value in seconds: the amount of time workflow order data instances will be cached before deleted.
dsp-error-timeout	int	`120000`	The amount of time in milliseconds for a runtime exception to be raised if a connection cannot be allocated from a system datasource pool
dsp-warning-timeout	int	`5000`	The amount of time in milliseconds for a transient alert to be raised if a connection cannot be allocated from a system datasource pool
flush-status	bool	False	When set to True, emulates the pre-2.0.0 behavior where workflow, step, and segment statuses are immediately flushed to the DB on changes instead of when the workflow order data instance is released (detached)
http-secure-certificate	string	- none -	The certificate file in PEM format for HTTPS listeners
http-secure-private-key	string	- none -	The private key file in PEM format for HTTPS listeners
http-secure-private-key-password	string	- none -	The password for the private key for HTTPS listeners
http-secure-server	list of strings	- none -	The optional interface and required port number for HTTPS listeners
http-server	list of strings	`8001`	The optional interface and required port number for HTTP listeners (list of URLs or hostname:port strings)
instance-key	string	`"qorus-test-instance"`	The unique identifier for an instance of Qorus
job-logfile-template	string	`OMQ-$instance-JOB-$name`	The template for the job log file names - `".log"` will be appended to the name
logdir	string	- none -	The log directory for Qorus
logfile-template	string	`OMQ-$instance`	The template for the system log file name
manage-interfaces	bool	Qore::True "True"	Determines whether or not the system will automatically start and stop workflows, services, and jobs depending on their connection status
max-events	int	`100000`	Maximum number of system events to cache
max-log-files	int	`10`	Number of old log files kept when rotating
max-retries	int	`5`	Number of retries before getting status OMQ::StatError
max-service-threads	int	`200`	Maximum number of threads a Qorus service can start
option-file	string	see desc.	The path to the file containing these system options; the default value depends on the Qorus installation location
rbac-external	list of strings	- none -	The name of a module providing external RBAC facilities to Qorus (for example the argument `"QorusLdapAuth"` will use the `QorusLdapAuth.qm` module shipped with Qorus to provide LDAP integration in Qorus)
rbac-force-user	list of strings	- none -	list of hostnames or IP addresses (IP addresses can contain optional wildcards ‘') and users in the format: host=user,* ex: `localhost=admin,192.168.*=operator`
rbac-security	bool	`False`	Activates RBAC security
recover_delay	int	`60`	Value in seconds: the amount of time a workflow in OMQ::WM_Recovery mode will wait before trying to recover a step with OMQ::StatRetry status
remoteconnections-file	string	see desc.	The path to the file containing remote Qorus server connection information; the default value depends on the Qorus installation location
service-perf-events	bool	False	enables SERVICE_METHOD_PERFORMANCE event emission on all service calls; note that enabling this option can cause service method call performance degredation
socket-min-throughput	integer	20480	the minimum socket throughput in bytes/second below which a warning will be raised for socket-based connection objects
socket-min-throughput-ms	integer	1000	the minimum time in milliseconds a socket transfer must take for it to be eligible for throughput warnings; transfers that take less time than this are ignored
socket-warning-timeout	integer	5000	the socket operation timeout threshold in milliseconds for raising transient alerts against socket-based connection objects
sql-default-blocksize	integer	5000	Size of the regular Session Recovery and workflow Startup and Execution SQL batches
sql-init-blocksize	integer	200	Size of the first workflow Startup and Execution SQL batch for instant workflow instance processing as soon as possible
svc-logfile-template	string	`OMQ-$instance-SVC-$type-$name`	The template for the service log file names - `".log"` will be appended to the name
system-pool-maximum	int	`20`	Maximum number of connections for the system schema DatasourcePool
system-pool-minimum	int	`5`	Minimum number of connections for the system schema DatasourcePool
tibco-daemon	string	- none -	System-default advisory TIBCO daemon parameter (user code must explicitly reference this value for it to take effect)
tibco-network	string	- none -	System-default advisory TIBCO network parameter (user code must explicitly reference this value for it to take effect)
tibco-service	string	- none -	System-default advisory TIBCO service parameter (user code must explicitly reference this value for it to take effect)
tibco-timeout	int	`90000`	Value in ms (90000 = 90 seconds): system-default advisory timeout value for TIBCO messaging (user code must explicitly use this value for it to take effect)
transient-alert-max	int	`1000`	Maximum number of transient alert to cache
verbose	int	5	Set to lower values to restrict the amount of information that is logged to informational log files
wf-logfile-template	string	`OMQ-$instance-$name`	The template for the workflow log file names - `".log"` and `".sqllog"` will be appended to the names for each type of log file
workflow-params	hash of hashes	- none -	Allows for workflow parameters to be set by default for certain workflow types, also allows for the recovery delay and async retry delay to be set per segment on workflow types
workflow-step-perf-events	bool	False	enables WORKFLOW_STEP_PERFORMANCE event emission for all workflow steps; note that enabling this option can cause workflow step performance degredation
info-snapshot	int	0	Maximum number of days for using live data when retrieving workflow order status overview information from the info service ; if a query requires summary data older than this number of days then the materialized view will be used instead of a live query for performance reasons; set to 0 to disable and always use a live query. This option is useful for Qorus installations with a very large number of workflow order instances online where summary queries could take a considerable amount of time. Use schema-tool -s to update the materialized view.

Runtime Read-Only Options

The following options can only be set in the System Options File or on the qorus command-line (they cannot be changed after the system starts); listed in alphabetical order:

Options Related to Performance and Scalability

See details of the following options for how they affect the system's performance and scalability:

Option Details

alert-fs-full

The percentage above which an alert will be raised due to a full filesystem.

Data Type and Default Value

int: 85

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus alert-fs-full=75

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

alert-smtp-connection

The name of the user connection for the SMTP server for delivering alert emails.

Data Type and Default Value

string: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus alert-smtp-connection=alert-smtp

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

alert-smtp-enable

A flag allowing alert emails to be enabled or disabled at runtime.

Data Type and Default Value

bool: False

Since: Qorus 3.0.0

alert-smtp-from

Source/from email address for alert emails.

Data Type and Default Value

string: alert_noreply@$instance

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus alert-smtp-from=my_instance@example.com

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

alert-smtp-interval

The interval in seconds for grouping and delivering alert emails.

Data Type and Default Value

int: 60

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus alert-smtp-interval=120

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

alert-smtp-to

List of email addresses for delivering alert emails.

Data Type and Default Value

list of strings: perso.nosp@m.n1@e.nosp@m.xampl.nosp@m.e.co.nosp@m.m, group.nosp@m.2@ex.nosp@m.ample.nosp@m..com

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus alert-smtp-to=ops@example.com,monitoring@example.com

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

async_delay

Sets the amount of time in seconds a workflow (or workflow thread) running in OMQ::WM_Recovery mode will wait before trying to recover a step with OMQ::StatAsyncWaiting status.

Data Type and Default Value

int: 600 (600 seconds = 10 minutes)

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

audit

Controls System Auditing by setting the list of events to audit in the AUDIT_EVENTS table; see System Auditing for a description of the possible options (corresponding to Audit Options giving a list of possible values). The default when this option is not present is that nothing will be audited.

System auditing impacts database space used and can also impact performance; only enable auditing for events that need tracking to save space in the database and ensure that performance is maximized.

Data Type and Default Value

list of strings: no default value

Note: "*" can also be given as the only value to this option, meaning audit all events

Since: Qorus 2.6.2

auto-error-update

If True, then adding new error definitions for workflows will automatically create or update workflow-specific or global error defintions (the default behavior); if False, then only new global error definitions will be created automatically and updates are never made automatically; updates can only be made manually when this option is False.

Data Type and Default Value

bool: True

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus auto-error-update=False

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.8.1.p7

auto-recover

If set to True, then Qorus Integration Engine will automatically try to recover the last open application session with the same instance key.

This is normally safe to set to True, because Qorus will check the URL saved against the session in the SESSIONS table to see if the server is still responding. If an answer is received, then the server startup will be aborted. This is to avoid the case when an application session is recovered while the server is still active.

If it is possible for the server application to be started on more than one UNIX machine with the same instance key, and it might be possible that the machines cannot reach each other over the network when the server is started, then do not set this option to True, but rather check manually before starting the server that all other instances of Qorus using this application key are shut down.

Data Type and Default Value

bool: False (no automatic session recovery will be initiated at server startup)

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus auto-recover=True

In order to effect a change in the value of this option, it is necessary to restart the server.

autostart-interfaces

If True, then workflows, services, and jobs are started automatically when the system is started according to their configuration; if False, then no interfaces are started automatically when the system is started regardless of their configuration.

Data Type and Default Value

bool: True

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:
```
qorus autostart-interfaces=False 
```
In order to effect a change in the value of this option, it is necessary to restart the server.
To ensure that no interfaces are started in a Qorus instance, set this option and manage-interfaces to false when Qorus is started

Since: Qorus 3.0.2

cache-max

Sets the maximum number of workflow order data instances to cache after a detach with status OMQ::StatReady, OMQ::StatRetry, OMQ::StatAsyncWaiting, OMQ::StatWaiting, OMQ::StatEventWaiting, or OMQ::StatIncomplete.

This option has a direct impact on performance as setting a large number here increases the size of the cache and therefore keeps more data in memory, reducing SQL I/O by reducing the need for the server to query the database for workflow data.

Data Type and Default Value

int: 100000

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus cache-max=10000000

In order to effect a change in the value of this option, it is necessary to restart the server.

compat-http-utf8

If True then any HTTP text messages received will be assumed to be in UTF-8 encoding if no charset= entry is included.

This option can be set for backwards-compatibility with Qorus prior to 2.7.0.p7 but is a violation of RFC 2616 section 3.7.1. When no character encoding is specified in an HTTP message, the message body must be assumed to be in ISO-8859-1 encodiing according to RFC 2616 (see previous link for more information).

Data Type and Default Value

bool: False

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus compat-strict-bool-eval=true

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.7.0.p9

compat-strict-bool-eval

If True then the %strict-bool-eval parse option will be enabled for all user code

This option can be set for backwards-compatibility with Qorus prior to 2.7.0.p3 before the new more intuitive perl- and python-style boolean evaluation behavior was introduced.

Data Type and Default Value

bool: False

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus compat-strict-bool-eval=true

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.7.0.p3

compat-string-numbers

If True then the "string-numbers" DBI option will be set on all datasources that support the option

This option can be set for backwards-compatibility with Qorus prior to 2.7.0.p2 before DBI drivers were updated to support DBI options and when they still returned NUMBER values as strings

Data Type and Default Value

bool: False

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus compat-string-numbers=true

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.7.0.p3

connection-modules

This option sets the set of user modules that provide support for custom user connection types. Each module must define the following public function:

public AbstractIterator sub get_schemes() {}: this must return an AbstractIterator object that iterates a list of OMQ::ConnectionScheme objects that enumerate the connection types handled by the module

Furthermore, the following optional functions are supported:

public softlist sub required_resources() {}: this optional function can return a list of resources required by the module; currently-supported resources:
- "omqservice": the $omqservice service object
public sub set_resources(hash $h) {}: (this must be declared if required_resources() is declared) accepts a hash of the resources required by required_resources()

Data Type and Default Value

list: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus connection-modules=TibcoActiveEnterprise

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

daemon-mode

If this option is set to True then the system will fork into the background after starting.

Data Type and Default Value

bool: True

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus daemon-mode=false

In order to effect a change in the value of this option, it is necessary to restart the server.

db-max-threads

This option sets the count of simultaneously running parallel tasks in Qorus system database.

This option is used when running database tasks in parallel in special cases like session recoveries and populating workflow event queues to get better performance.

The optimal value of this option is dependent of your Qorus system database configuration hardware; in general the recommended value is "# DB server CPUs + 2".

This value may be tuned according to user requirements.

Data Type and Default Value

int: 10

Note: This option should not be greater than the maximum number of sessions in the system DatasourcePool.

Since: Qorus 2.0.3

dbparams-file

This option gives the path to the file containing database connection parameters which will be used by the system.datasource service to provide database connections to known databases within the system.

Data Type and Default Value

string: $OMQ_DIR/etc/dbparams (tar installs) or /etc/qorus/dbparams (LSB installs) (see system datasource (dbparams) File)

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus dbparams-file=/tmp/dbparams

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.8.0

defines

This option sets the parse defines for all user code (workflows, services, and jobs) and also for Connection Definition Files for conditional parsing.

Data Type and Default Value

hash: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus defines=Production=1

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.8.1

detach-delay

This option gives the amount of time in seconds that workflow order data instances will be cached before deleted (see the cache-max option as well).

This option has a direct impact on performance as setting a large number here keeps more data in memory, for a longer time period reducing SQL I/O by reducing the need for the server to query the database for workflow data. This option should be set according to the requirements of the environment and workflows running on Qorus; the default is one hour (3600 seconds) which may not be appropriate for workflows with long-running asynchronous steps.

It is generally safe to use longer values, however a detach-delay value that is too short will reduce the effectiveness of the cache as the data will be automatically purged before it's needed, therefore it's recommended to set this option to a value a little higher than the longest possible execution time for the longest-running workflow.

Data Type and Default Value

int: 3600 (3600 seconds = 1 hour)

dsp-error-timeout

The amount of time in milliseconds for a runtime exception to be raised if a connection cannot be allocated from a system datasource pool.

Data Type and Default Value

int: 120000 (2 minutes)

Since: Qorus 3.0.0

dsp-warning-timeout

The amount of time in milliseconds for a transient alert to be raised if a connection cannot be allocated from a system datasource pool

Data Type and Default Value

int: 5000 (5 seconds)

Since: Qorus 3.0.0

flush-status

This option controls the new aggressive status caching behavior introduced in Qorus 2.0.*; the default is False, meaning do not flush all status changes to the DB; when possible, cache them instead. When set to True, emulates the pre-2.0.* behavior where all workflow, step, and segment statuses are immediately flushed to the DB on changes instead of when the workflow order data instance is released (detached).

Leaving this option with the default, False, has a significant performance benefit, as it allows the system to drastically reduce the amount of SQL I/O. It particularly improves performance with workflows with a large number of array step elements.

Data Type and Default Value

bool: False

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus flush-status=true

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.0.0

http-secure-certificate

This option sets the certificate path (for X.509 certificates in PEM format) for HTTPS listeners. To set the private key, see http-secure-private-key.

See also: http-secure-server.

Data Type and Default Value

string: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus http-secure-certificate=/etc/pki/cert.pem

In order to effect a change in the value of this option, it is necessary to restart the server.

http-secure-private-key

This option sets the private key path (for private key files for X.509 certificated in PEM format) for HTTPS listeners. To set the certificate, see http-secure-certificate.

See also: http-secure-server.

Data Type and Default Value

string: no default value
Note
This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:
```
qorus http-secure-private-key=/etc/pki/key.pem 
```
In order to effect a change in the value of this option, it is necessary to restart the server.

http-secure-private-key-password

This option sets password for the the private key for HTTPS listeners. To set the private key, see http-secure-private-key; to set the certificate, see http-secure-certificate.

See also: http-secure-server.

Since: Qorus 3.0.4.p2

Data Type and Default Value

string: no default value
Note
This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:
```
qorus http-secure-private-key=/etc/pki/key.pem 
```
In order to effect a change in the value of this option, it is necessary to restart the server.

http-secure-server

This option sets the listener addresses for HTTPS listeners (for encrypted connections). To set the X.509 certificate see http-secure-certificate, and to set the private key, see http-secure-private-key

This option takes multiple values separated by commas. If a single port number is given, then the HTTPS listener will listen on all available interfaces on the given port number. Otherwise, to specify a certain network device and IP address, give the IP address and port in the following format:

ip-address:port (i.e. 192.168.20.15:8009)

Data Type and Default Value

list of strings: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus http-secure-server=8009

In order to effect a change in the value of this option, it is necessary to restart the server.

http-server

This option sets the listener addresses for HTTP listeners (for unencrypted connections).

This option takes multiple values separated by commas. If a single port number is given, then the HTTP listener will listen on all available interfaces on the given port number. Otherwise, to specify a certain network device and IP address, give the IP address and port in the following format:

ip-address:port (i.e. 192.168.20.15:8009)

Data Type and Default Value

list of strings: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus.http-server: localhost:8081,192.168.20.4:9010

In order to effect a change in the value of this option, it is necessary to restart the server.

info-snapshot

This option allows the system info service (ie the Operations GUI, oview, etc) to use faster/more efficient queries when retrieving historical summary data for workflow orders or job instances reports, resulting in more responsive summary reports in the GUI and in oview for Qorus installations with very large number of workflow orders in the online schema.

The disadvantage is that data older than info-snapshot days are displayed in the status they had at the time the snapshot was refreshed. For this reason, regular snapshot refreshing is mandatory when this option is enabled in order to provide accurate summary reports.

The snapshot refresh is performed with one of methods described in Snapshot Refresh chapter.

See Workflow and Job Instance Snapshots for more detailed description of this Qorus feature.

Value	Description
`0`	Usage of snapshots is off (default)
Any numeric value greater than 0	Maximum number of days for using live data when retrieving workflow order status overview information from the info service; if a query requires summary data older than this number of days then the materialized view will be used instead of a live query for performance reasons; set to 0 to disable and always use a live query. This option is useful for Qorus installations with a very large number of workflow order instances online where summary queries could take a considerable amount of time. Use schema-tool -s to update the materialized view.

Data Type and Default Value

int: 0

Since: Qorus 2.6.3

instance-key

This option sets the name of the application instance. Each Qorus server should have a unique instance name. The instance name will be saved against each application session and will determine if the Qorus instance can connect to the database or not, or if an open application session in the SESSIONS table needs to be recovered.

If two Qorus server instances are given the same instance key name and are started against the same database at the same time, one of the instances might recover the other instance's session while it is still in progress, leading to data corruption.

Data Type and Default Value

string: "qorus-test-instance"

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus instance-key=dev-1

In order to effect a change in the value of this option, it is necessary to restart the server.

job-logfile-template

This option sets the template for job log file names. The template string can include substitution variables that will be substituted with values related to system execution as described in the following table.

The suffix ".log" is added automatically and unconditionally to the end of the file name after variable substitution has been made.

Job Log File Name Substitution Variables

Variable	Description
`$instance`	Gives the instance name of the Qorus server
`$pid`	Gives the PID of the Qorus server process
`$host`	Gives the hostname where the Qorus server is running
`$id`	Gives the job ID number of the job
`$name`	Gives the name of the job
`$version`	Gives the version of the job

Data Type and Default Value

string: "OMQ-$instance-JOB-$name"

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line, for example:

qorus job-logfile-template=OMQ-test-$instance-$name-$id

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.6.1

logdir

This option sets the path to the system log directory.

Data Type and Default Value

string: "$OMQ_DIR/log" (tar installs) "/var/log/qorus" (LSB installs)

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus logdir=/var/log/qorus/dev-1

In order to effect a change in the value of this option, it is necessary to restart the server.

logfile-template

This option sets the template for system log file names. The template string can include substitution variables that will be substituted with values related to system execution as described in the following table.

The suffix ".log" is added automatically and unconditionally to the end of the file name after variable substitution has been made.

Log File Name Substitution Variables

Variable	Description
`$instance`	Gives the instance name of the Qorus server
`$pid`	Gives the PID of the Qorus server process
`$host`	Gives the hostname where the Qorus server is running

Data Type and Default Value

string: "OMQ-$instance"

The audit log file uses this system option but appends "-AUDIT" to the value (before the ".log" extension is added) when generating the name.

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus logfile-template=OMQ-test-$instance

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.8.0

manage-interfaces

The value of this option determines whether Qorus will start and stop workflows, services, and jobs automatically based on their connection status.

Data Type and Default Value

bool: True

Note: To ensure that no interfaces are started in a Qorus instance, set this option and autostart-interfaces to false when Qorus is started

Since: Qorus 3.0.0

max-async-retries

This option specifies the retry limit for asynchronous steps until the step will automatically receive an OMQ::StatError status.

If an asynchronous step undergoes this many asynchronous retries without getting a OMQ::StatComplete status, then an appropriate error will be logged and the step's status will be updated to OMQ::StatError.

See also: max-retries.

Data Type and Default Value

int: 20

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

max-events

Sets the maximum number of system events to be held in the system event cache.

Data Type and Default Value

int: 100000

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus max-events=10000000

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.0.2

max-log-files

Sets the maximum number of backup log files to keep when rotating log files (as triggered by omq.system.rotate-log-files()).

Data Type and Default Value

int: 10

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus max-log-files=20

In order to effect a change in the value of this option, it is necessary to restart the server.

max-retries

This option specifies the retry limit for workflow steps until the step will automatically receive an OMQ::StatError status.

If a step undergoes this many retries (after a OMQ::StatRetry status) without getting a OMQ::StatComplete status, then an appropriate error will be logged and the step's status will be updated to OMQ::StatError.

See also: max-async-retries.

Data Type and Default Value

int: 20

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

max-service-threads

This option sets the maximum number of threads that can be started by a service and running simultaneously.

This value may be tuned according to user requirements. Data Type and Default Value

int: 200

Since: Qorus 2.7.0.p2

option-file

This option gives the path to the System Options File. It is read-only and can only be set on the command-line when starting the Qorus server, otherwise the system will look in the default location for this file.

Data Type and Default Value

string: "$OMQ_DIR/etc/options" (tar installs) or "/etc/qorus/options" (LSB installs)

Note

This option is read-only after system startup; it can only be set on the command-line; for example:

qorus option-file=/tmp/options-dev-1

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.8.0

rbac-external

This option allows the name of a module providing external RBAC facilities to Qorus to be set.

For example the argument "QorusLdapAuth" will use the QorusLdapAuth.qm module shipped with Qorus to provide LDAP integration to Qorus (see LDAP Authentication and RBAC Integration for more info).

For example:

QorusLdapAuth

Data Type and Default Value

list of strings: no default value

Note

External RBAC providers will normally require additional system options to be set in their own domain in the options file; for example, the "QorusLdapAuth" module requires options to be set in the "ldap" domain; see for more information.
This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:
```
qorus rbac-external=QorusLdapAuth 
```
In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.8.0

rbac-force-user

This option is used to allow unauthenticated connections from a given host or IP address to be made as a certain username.

To set this option, write a host or IP address name followed by an equals sign and the user to connect as. Multiple entries can be given separated by commas as follows:

host=user,ip-address=user

For example:

localhost=admin,192.168.20.19=operator

Note that authenticated connections always use the authentication information included in the message; this option only takes effect with unauthenticated connections.

Data Type and Default Value

hash: no default value

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus rbac-force-user=localhost=admin

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.7.2

rbac-security

This option is used to enable RBAC security in the Qorus server.

Please note that the Qorus server can only start with RBAC security enabled if at least one user has the OMQ::QR_SHUTDOWN permission.

Data Type and Default Value

bool: False

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus rbac-security=true

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.7.2

recover_delay

Sets the amount of time in seconds a workflow (or workflow thread) running in RECOVERY mode will wait before trying to recover a step with RETRY status.

Data Type and Default Value

int: 300 (300 seconds = 5 minutes)

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

remoteconnections-file

This option gives the path to the Qorus system Remote Qorus Instance Configuration File file. It is read-only and can only be set on the command-line when starting the Qorus server, otherwise the system will look in the default location for this file. See Remote Qorus Instance Configuration File for details on the file's default location and syntax.

Data Type and Default Value

string: "$OMQ_DIR/etc/remoteconnections" (tar installs) or "/etc/qorus/remoteconnections" (LSB installs)

Note

This option is read-only after system startup; it can only be set on the command-line; for example:

qorus remoteconnections-file=/tmp/remoteconnections-dev-1

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 2.6.1

service-perf-events

Enables SERVICE_METHOD_PERFORMANCE event emission on all service calls; note that enabling this option can cause service method call performance degredation.

Data Type and Default Value

bool: False

Since: Qorus 3.0.3

socket-min-throughput

The minimum socket throughput in bytes/second below which a warning will be raised for socket-based connection objects.

Data Type and Default Value

integer: 20480

Since: Qorus 3.0.0

Note: This option takes effect only for new connections created after the value is changed.

socket-min-throughput-ms

The minimum time in milliseconds a socket transfer must take for it to be eligible for throughput warnings; transfers that take less time than this are ignored.

Data Type and Default Value

integer: 1000

Since: Qorus 3.0.0

Note: This option takes effect only for new connections created after the value is changed.

socket-warning-timeout

The socket operation timeout threshold in milliseconds for raising transient alerts against socket-based connection objects.

Data Type and Default Value

integer: 5000

Since: Qorus 3.0.0

Note: This option takes effect only for new connections created after the value is changed.

sql-default-blocksize

Size of the regular Session Recovery and workflow Startup and Execution SQL batches

Data Type and Default Value

integer: 5000

Since: Qorus 2.9.1.p1

sql-init-blocksize

Size of the first workflow Startup and Execution SQL batch for instant workflow instance processing as soon as possible. This batch goes before any other sql-default-blocksize

Note: It's logical to have sql-init-blocksize value smaller than sql-default-blocksize. But there is no technical limitation to have any value used in this option.

Data Type and Default Value

integer: 200

Since: Qorus 2.9.1.p1

svc-logfile-template

This option sets the template for service log file names. The template string can include substitution variables that will be substituted with values related to system execution as described in the following table.

The suffix ".log" is added automatically and unconditionally to the end of the file name after variable substitution has been made.

Service Log File Name Substitution Variables

Variable	Description
`$instance`	Gives the instance name of the Qorus server
`$pid`	Gives the PID of the Qorus server process
`$host`	Gives the hostname where the Qorus server is running
`$id`	Gives the ID number of the service
`$name`	Gives the name of the service
`$version`	Gives the version of the service
`$type`	Gives the type of service ("user" or "system")

Data Type and Default Value

string: "OMQ-$instance-SVC-$type-$name"

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line, for example:

qorus svc-logfile-template=OMQ-test-$instance-$type-$name-$id

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.8.0

system-pool-maximum

Sets the maximum number of connections in the system DatasourcePool. The system datasource pool is used internally to communicate with the system schema. Larger installations may consider increasing the number when monitoring the system schema reveals that all of the system connections are active at the same time, meaning that no more connections are available and some threads are waiting on a connection to become free.

Data Type and Default Value

int: 20

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus system-pool-maximum=40

In order to effect a change in the value of this option, it is necessary to restart the server.

system-pool-minimum

Sets the minimum number of connections in the system DatasourcePool. This number of database connection will be opened automatically when the system is started.

Normally it's not necessary to change this option as database connections are opened automatically when needed.

Data Type and Default Value

int: 5

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus system-pool-minimum=2

In order to effect a change in the value of this option, it is necessary to restart the server.

tibco-daemon

Sets the TIBCO daemon IP address and port; this option is used by the system.tibrv-api-gateway service but can also be used by user services and/or workflows if a global TIBCO daemon setting is appropriate to the given environment.

However for more complex environments communicating with multiple TIBCO networks, the system.prop service should be used instead to store configuration information.

See also: tibco-network, tibco-service, and tibco-timeout.

Data Type and Default Value

string: no default value

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

tibco-network

Sets the TIBCO network address; this option is used by the system.tibrv-api-gateway service but can also be used by user services and/or workflows if a global TIBCO network setting is appropriate to the given environment.

However for more complex environments communicating with multiple TIBCO networks, the system.prop service should be used instead to store configuration information.

See tibco-daemon, tibco-service, and tibco-timeout.

Data Type and Default Value

string: no default value

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

tibco-service

Sets the TIBCO service port number; this option is used by the system.tibrv-api-gateway service but can also be used by user services and/or workflows if a global TIBCO daemon setting is appropriate to the given environment.

However for more complex environments communicating with multiple TIBCO networks, the system.prop service should be used instead to store configuration information.

See also: also tibco-daemon, tibco-network, and tibco-timeout.

Data Type and Default Value

string: no default value

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

tibco-timeout

Sets the TIBCO response timeout in milliseconds. This option is not used by any Qorus system code, but can also be used by user services and/or workflows if a global TIBCO daemon setting is appropriate to the given environment.

However for more complex environments communicating with multiple TIBCO networks, the system.prop service should be used instead to store configuration information.

See also: tibco-daemon, tibco-network, and tibco-service.

Data Type and Default Value

int: 90000 (90 seconds)

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

transient-alert-max

Maximum number of transient alert to cache.

Data Type and Default Value

int: 1000

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example:

qorus transient-alert-max=2000

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 3.0.0

verbose

Sets the logging level for the system. Lower numbers equal a higher priority. Messages with negative priority are also output to the terminal device where the Qorus server was started.

The verbose option sets the cutoff for logging messages in log files; any messages with a message priority higher than this option will not be logged at all. Therefore, to get more detailed information in the log files, set this number to a higher value.

See also: Log Levels for valid log levels for this option

Data Type and Default Value

int: 2 (OMQ::LL_DETAIL_1 log only messages)

Note: This option may also be overridden at the workflow execution instance level by setting a workflow option with this name.

wf-logfile-template

This option sets the template for workflow log file names. The template string can include substitution variables that will be substituted with values related to system execution as described in the following table.

The suffix ".log" is added automatically and unconditionally to the end of the file name after variable substitution has been made.

Log File Name Substitution Variables

Variable	Description
`$instance`	Gives the instance name of the Qorus server
`$pid`	Gives the PID of the Qorus server process
`$host`	Gives the hostname where the Qorus server is running
`$id`	Gives the ID number of the workflow
`$name`	Gives the name of the workflow
`$version`	Gives the version of the workflow

Data Type and Default Value

string: "OMQ-$instance-$name"

Note

This option is read-only after system startup; it can only be set in the System Options File or on the command-line; for example

qorus wf-logfile-template=OMQ-test-$instance-$name-$id

In order to effect a change in the value of this option, it is necessary to restart the server.

Since: Qorus 1.8.0

workflow-params

This option allows workflow parameters to be set per workflow type (metadata type identified by a workflow name and version or alternatively by the WORKFLOWID which is the primary key in the WORKFLOWS table). The options set here will take precedence over global system options, but may be overridden by options set at the workflow execution instance level (either when the workflow is started or with the omq.system.set-workflow-option() API).

The data format for this option is a hash of hashes of hashes; the top level key should be the workflow name, hashes assigned to each workflow name should be workflow versions or "*", meaning all versions of this workflow; hashes assigned to the version hashes should be the option hashes where the key gives the option name and the value is the value of the option.

Here is an example of setting the workflow-params option in the options:

qorus.workflow-params: TEST-A:*:recover_delay=15,TEST-A:2.0:async_delay=25

The above example will set recover_delay to 15 seconds for all versions of workflow "TEST-A" and the async_delay to 25 seconds for "TEST-A" version 2.0.

Option hashes can also specify per-segment options of a workflow, as long as the workflow version for the particular option is not a wildcard ("*"). The only per-segment options currently allowed are async (giving the equivalent of async_delay for the segment) and retry (giving the equivalent or recover_delay for the segment). Per segment options keys are specified as follows:

segmentid/option
stepname/option
stepname/stepversion/option

Please note that if a step name is used, the segment will be identified according to the step name; in case that step is an asynchronous or subworkflow step (and therefore a segment boundary), the front-end segment will be identified.

Here is an example of setting the workflow-params option in the System Options File to set segment options:

qorus.workflow-params: TEST-A:2.0:test_step/retry=315,TEST-A:2.0:2/async=360000

The above examples will set the recover_delay value for the segment of workflow "TEST-A" version 2.0 in which test_step is found to 315 seconds (the front-end segment in case it's a segment boundary), and the async_delay option for segment 2 of workflow "TEST-A" version 2.0 to 360000 (100 hours).

Please note that segment options take precedence over workflow execution instance options.

Data Type and Default Value

hash (workflow name) of hashes (workflow versions or "*") of hashes (options): no default value

Since: Qorus 2.0.2

workflow-step-perf-events

Enables WORKFLOW_STEP_PERFORMANCE event emission for all workflow steps; note that enabling this option can cause workflow step performance degredation.

Data Type and Default Value

bool: False

Since: Qorus 3.0.3

Table of Contents

Overview of All System Options

Runtime Read-Only Options

Options Related to Performance and Scalability

Option Details

alert-fs-full

alert-smtp-connection

alert-smtp-enable

alert-smtp-from

alert-smtp-interval

alert-smtp-to

async_delay

audit

auto-error-update

auto-recover

autostart-interfaces

cache-max

compat-http-utf8

compat-strict-bool-eval

compat-string-numbers

connection-modules

daemon-mode

db-max-threads

dbparams-file

defines

detach-delay

dsp-error-timeout

dsp-warning-timeout

flush-status

http-secure-certificate

http-secure-private-key

http-secure-private-key-password

http-secure-server

http-server

info-snapshot

instance-key

job-logfile-template

logdir

logfile-template

manage-interfaces

max-async-retries

max-events

max-log-files

max-retries

max-service-threads

option-file

rbac-external

rbac-force-user

rbac-security

recover_delay

remoteconnections-file

service-perf-events

socket-min-throughput

socket-min-throughput-ms

socket-warning-timeout

sql-default-blocksize

sql-init-blocksize

svc-logfile-template

system-pool-maximum

system-pool-minimum

tibco-daemon

tibco-network

tibco-service

tibco-timeout

transient-alert-max

verbose

wf-logfile-template

workflow-params

workflow-step-perf-events