8.6.2 Details of the parameters in the system configuration property file (system_config.properties)

This subsection provides the details of the parameters in the system configuration property file (system_config.properties) shown in 8.6.1(5) Specifiable parameters.

Organization of this subsection
(1) engine.initialQueueSize=initial-number-of-elements-used-in-stream-queue
(2) engine.maxQueueSize=maximum-number-of-elements-used-in-stream-queue
(3) engine.watchQueueSize.threshold=threshold-value-for-monitoring- number-of-elements-used-in-stream-queue
(4) logger.console.abnormal.enabled={true|false}
(5) logger.console.enabled={true|false}
(6) mon.process_exp_time=timeout-processing-time
(7) query.decimalMaxPrecision=maximum-precision-of-query-arithmetic-operation
(8) query.decimalRoundingMode={HALF_UP|DOWN}
(9) querygroup.sleepOnOverStore=query-group-execution-sleep-time
(10) querygroup.sleepOnOverStoreRetryCount=number-of-times-to-check-output-stream-queue-for-available-space
(11) rmi.serverPort=port-number-for-SDP-server
(12) stream.freeInputQueueSizeThreshold=threshold-value-for-available-size-to-maximum-size-of-input-stream-queue
(13) stream.freeInputQueueSizeThresholdOutputMessage={true|false}
(14) stream.maxKeepTupleCount=maximum-number-of-tuples-retained-by-timestamp-adjustment-function
(15) stream.timestampAccuracy={{sec|msec|usec},time-adjustment-range|unuse}
(16) stream.timestampMode={Server|DataSource}
(17) stream.timestampPosition=time-data-column-name
(18) stream.tupleLogMode={true|false}
(19) tpl.backupFileCount=maximum-number-of-backup-generations-to-be-retained-for-tuple-log-file
(20) tpl.bufferCount=tupple-log-buffers-count
(21) tpl.bufferSize=maximum-tuple-log-buffer-size
(22) tpl.fileCount=maximum-tuple-log-files-count
(23) tpl.fileSize=maximum-tuple-log-file-size
(24) tpl.outputLevel=tuple-log-output-level
(25) tpl.outputTrigger={BUFFER|NONE}
(26) tpl.useOverwrite={true|false}
(27) trc.api.bufferCount=API-trace-buffers-count
(28) trc.api.bufferSize=maximum-API-trace-buffer-size
(29) trc.api.fileCount=maximum-API-trace-files-count
(30) trc.api.fileSize=maximum-API-trace-file-size
(31) trc.api.ioBufferSize=maximum-API-trace-I/O-buffer-size
(32) trc.api.outputTrigger={BUFFER|NONE}
(33) trc.api.useOverwrite={true|false}

(1) engine.initialQueueSize=initial-number-of-elements-used-in-stream-queue

This parameter specifies as an integer from 1 to 1048576 the initial number of elements used in the stream queue. The default value is 1024.

If you attempt to register more elements in the stream queue than specified here, the stream queue is extended up to the maximum value specified in the engine.maxQueueSize parameter.

Note that the initial number of elements specified here becomes the initial value for each stream queue.

(2) engine.maxQueueSize=maximum-number-of-elements-used-in-stream-queue

This parameter specifies as an integer from 1 to 1048576 the maximum number of elements used in the stream queue. The default is 4096.

Make sure that the maximum number of elements used in the stream queue is no greater than the initial number of elements specified in the engine.initialQueueSize parameter.

Note that the maximum number of elements specified here becomes the maximum value for each stream queue.

(3) engine.watchQueueSize.threshold=threshold-value-for-monitoring- number-of-elements-used-in-stream-queue

This parameter specifies the threshold value (%) for monitoring the number of elements used in the stream queue as an integer from 1 to 99. If this parameter is omitted, the number of elements is not monitored.

If the value obtained from the formula shown below is greater than the value of this parameter, a warning message is output.

Number of elements[Figure] engine.maxQueueSize parameter value x 100

Once this warning message is output, it will not be output again until the next time the number of elements exceeds the threshold value after it dropped below the threshold value.

(4) logger.console.abnormal.enabled={true|false}

This parameter specifies, as true or false, whether the SDP server start processing is to be continued in the event of a failure during log file initialization. This value is not case sensitive. The default value is false.

true
Outputs a message to the console and then starts the SDP server.
false
Shuts down the SDP server.

(5) logger.console.enabled={true|false}

This parameter specifies, as true or false, whether messages issued by the SDP server are to be output to the console. This value is not case sensitive. The default value is false.

true
Outputs messages to both log file and console.
false
Does not output messages to the console.

(6) mon.process_exp_time=timeout-processing-time

This parameter specifies (in milliseconds) the amount of time used for processing before a timeout occurs, as an integer from 1 to 2147483647. The default value is 30000.

If use of the default value results in frequent output of a timeout detection message, specify an appropriate value on the basis of the actual processing time that is needed, as obtained from the API trace information.

(7) query.decimalMaxPrecision=maximum-precision-of-query-arithmetic-operation

This parameter specifies as an integer from 1 to 38 the maximum precision for an arithmetic operation when the result of a query is the DECIMAL type (including the NUMERIC type). The default value is 38.

The following arithmetic operations result in the DECIMAL type:

If the result of an arithmetic operation does not exceed the precision specified in this parameter, precision processing is not processed. If the result of an arithmetic operation exceeds the precision specified in this parameter, the result is rounded to the precision specified in this parameter. You use the query.decimalRoundingMode parameter to specify the rounding operation to be applied.

(8) query.decimalRoundingMode={HALF_UP|DOWN}

This parameter specifies the rounding operation to be performed in the event the precision specified in the query.decimalMaxPrecision parameter is exceeded when the result of a query is the DECIMAL type (including the NUMERIC type). The default value is HALF_UP.

HALF_UP
Rounds off on the basis of the first decimal place to be discarded.
DOWN
Rounds down the digit that immediately precedes the first decimal place to be discarded.

(9) querygroup.sleepOnOverStore=query-group-execution-sleep-time

This parameter specifies as an integer from 1 to 2147483647 the period of time (in milliseconds) that execution of a query group is to be placed in the sleep mode when the SDP server's checking determines that there is no available space in the output stream queue. The default value is 100.

This parameter takes effect if 1 or a greater value is specified in the querygroup.sleepOnOverStoreRetryCount parameter.

You can perform the following operations on a query group that has been placed in the sleep mode by this parameter:

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(10) querygroup.sleepOnOverStoreRetryCount=number-of-times-to-check-output-stream-queue-for-available-space

This parameter specifies as an integer from 0 to 2147483647 the number of times the SDP server is to check the output stream queue for available space before it loads the tuples obtained from query execution to the output stream queue. The default value is 0.

If the value 0 is specified, the SDP server loads the tuples obtained from query execution to the output stream queue without checking the output stream queue for available space.

If 1 or a greater value is specified, the SDP server performs the following processing as many times as specified:

  1. The SDP server checks whether there is room in the output stream queue.
  2. If there is no room in the output stream queue, the SDP server places execution of the query group that uses the output stream queue in the sleep mode. The length of the sleep time is specified in the querygroup.sleepOnOverStore parameter.
    When the sleep period expires, if this processing has not been performed as many times as specified in this parameter, the SDP server returns to step 1.
  3. If there is room in the output stream queue, the SDP server loads the tuples obtained from query execution into the output stream queue.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(11) rmi.serverPort=port-number-for-SDP-server

This parameter specifies a port number for the SDP server, as an integer from 1 to 65535. The default value is 20400.

If the default port number (20400) is being used as a port number in another system, you must specify a different port number. We recommend that you do not use port numbers 1 through 1023 (because they are commonly-used port numbers).

(12) stream.freeInputQueueSizeThreshold=threshold-value-for-available-size-to-maximum-size-of-input-stream-queue

This parameter specifies a threshold value (%) for the available size with respect to the maximum number of elements used in the input stream queue as an integer from 1 to 99 (the engine.maxQueueSize parameter value).

When the condition shown below is satisfied, a SDPClientFreeInputQueueSizeThresholdOverException exception is thrown from the put(StreamTuple tuple) method or the put(ArrayList<StreamTuple> tuple_list) method. In such a case, loading of tuples into the input stream queue has been successful.

This parameter's value[Figure] ((available size of input stream queue[Figure] maximum size of input stream queue) x 100)

If this parameter is omitted, an exception by threshold value checking will not occur.

Note that the engine.watchQueueSize.threshold parameter specifies a threshold value for the usage size compared to the maximum size of input and output stream queues. It is different from the stream.freeInputQueueSizeThreshold parameter. For details, see the engine.watchQueueSize.threshold parameter.

When the sdptplput command is used to load tuples to the input stream queue, this parameter is ignored.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(13) stream.freeInputQueueSizeThresholdOutputMessage={true|false}

This parameter specifies, as true or false, whether a warning message (the KFSP42032-W message) is to be output to the SDP server's message log. This value is not case sensitive. The default value is false.

true
Outputs the warning message.
false
Does not output the warning message.

This parameter takes effect only when the stream.freeInputQueueSizeThreshold parameter is specified.

Note that the warning message is output only when true is specified in this parameter and the following condition is satisfied:

stream.freeInputQueueSizeThreshold parameter value[Figure] ((available size of input stream queue[Figure] maximum size of input stream queue) x 100)

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(14) stream.maxKeepTupleCount=maximum-number-of-tuples-retained-by-timestamp-adjustment-function

This parameter specifies as an integer from 1 to 1048576 the maximum number of tuples that can be retained by the timestamp adjustment function. The default value is 125828.

The number of tuples specified in this parameter is used as the maximum value for the timestamp adjustment function for each input stream.

When the number of tuples exceeds the value specified in this parameter, the query group is shut down.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(15) stream.timestampAccuracy={{sec|msec|usec},time-adjustment-range|unuse}

This parameter specifies the time units and the time adjustment range for the timestamp adjustment function. This value is not case sensitive.

You must specify this parameter when you specify DataSource in the stream.timestampMode parameter. If you specify Server in the stream.timestampMode parameter, this parameter is ignored, but its format is checked.

{sec|msec|usec},time-adjustment-range
Specifies the time units and time adjustment range. There must be no spaces or tabs preceding or following the single-byte comma (,) between the time units (sec, msec, or usec) and the time adjustment range. If you violate this rule, an error results. If you specify sec, msec, or usec as the time units and 0 as the time adjustment range, the time adjustment range is applied only to the reference time.
The meaning of each value is as follows:
sec
Specifies that seconds are to be used as the time units.
msec
Specifies that milliseconds are to be used as the time units.
usec
Specifies that microseconds are to be used as the time units.
time-adjustment-range
Specifies as an integer the range of times to be adjusted for timestamp adjustment. The permitted value range depends on the time units, as shown in the table below.
Time unitsPermitted value range
sec (seconds)Integer from 0 to 59
msec (milliseconds)Integer from 0 to 999
usec (microseconds)Integer from 0 to 999
unuse
Specifies that time adjustment is not to be performed.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(16) stream.timestampMode={Server|DataSource}

This parameter specifies Server or DataSource as the timestamp mode to be used in timestamping tuples. This value is not case sensitive. The default value is Server.

Server
Uses the server mode.
DataSource
Uses the data source mode.
If you specify DataSource, you must specify the stream.timestampAccuracy and stream.timestampPosition parameters.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(17) stream.timestampPosition=time-data-column-name

This parameter specifies the name of the time-data column in tuples. This value is not case sensitive.

If you specify DataSource in the stream.timestampMode parameter, you must also specify this parameter. If you specify Server in the stream.timestampMode parameter, this parameter is ignored, but its format is checked.

The only data type that can be specified as time data is the TIMESTAMP type.

The permitted range of time data is from 1970/01/01 00:00:00.000000000 to 2261/12/31 23:59:59.999999999 in GMT (Greenwich Mean Time). If a specified time is outside this range, an exception occurs when the stream data is sent.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(18) stream.tupleLogMode={true|false}

This parameter specifies whether execution of the sdptplput command is to be enabled. This value is not case sensitive. The default value is false.

true
sdptplput command is to be executed.
false
Execution of the sdptplput command is to be disabled.

If you specify Server in the stream.timestampMode parameter and true in this parameter, an SDPClientException exception will occur if you then send stream data using the put method of the StreamInput interface.

You can specify this parameter in the system configuration property file and the query group property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2):

  1. Query group property file
  2. System configuration property file

(19) tpl.backupFileCount=maximum-number-of-backup-generations-to-be-retained-for-tuple-log-file

This parameter specifies as an integer from 0 to 10 the maximum number of backup generations to be retained for the tuple log file. The default value is 1.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(20) tpl.bufferCount=tupple-log-buffers-count

This parameter specifies the number of tuple log buffers, as an integer from 3 to 512. The default value is 5.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(21) tpl.bufferSize=maximum-tuple-log-buffer-size

This parameter specifies as an integer from 1 to 2048000 the maximum size of a tuple log buffer (in kilobytes). The default value is 1024.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(22) tpl.fileCount=maximum-tuple-log-files-count

This parameter specifies the maximum number of tuple log files, as an integer from 3 to 512. The default value is 3.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(23) tpl.fileSize=maximum-tuple-log-file-size

This parameter specifies the maximum size of a tuple log file (in megabytes), as an integer from 1 to 2048. The default value is 100.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(24) tpl.outputLevel=tuple-log-output-level

This parameter specifies the tuple log output level, as an integer from 1 to 3. The default value is 3.

1
Outputs tuple logs for the tuples that are stored in the stream queue.
2
Outputs tuple logs for the tuples that are discarded due to an out-of-sequence time.
3
Outputs tuple logs for tuples with levels 1 and 2.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(25) tpl.outputTrigger={BUFFER|NONE}

This parameter specifies BUFFER or NONE as the tuple log file output timing. This value is not case sensitive. The default value is BUFFER for input stream queues and NONE for output stream queues.

BUFFER
Outputs tuple logs to a file when the buffer being used to collect the current tuple logs in the target stream becomes full.
NONE
Does not output tuple logs to a file or perform buffering of tuple logs.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(26) tpl.useOverwrite={true|false}

This parameter specifies, as true or false, whether a tuple log buffer is to be overwritten in the event it becomes full. This value is not case sensitive. The default value is true.

true
Overwrites the tuple log buffer.
false
Does not overwrite the tuple log buffer.

You can specify this parameter in the system configuration property file, the query group property file, and the stream property file. If the parameter is duplicated or omitted, the specified value takes effect in the following order (1 > 2 > 3):

  1. Stream property file
  2. Query group property file
  3. System configuration property file

(27) trc.api.bufferCount=API-trace-buffers-count

This parameter specifies the number of API trace buffers, as an integer from 3 to 512. The default value is 3.

(28) trc.api.bufferSize=maximum-API-trace-buffer-size

This parameter specifies the maximum size of an API trace buffer (in kilobytes), as an integer from 1 to 2048000. The default value is 1024.

(29) trc.api.fileCount=maximum-API-trace-files-count

This parameter specifies as an integer from 3 to 512 the maximum number of files to which API trace information is to be output. The default value is 3.

(30) trc.api.fileSize=maximum-API-trace-file-size

This parameter specifies the maximum size of an API trace file (in megabytes), as an integer from 1 to 2048. The default value is 1024.

(31) trc.api.ioBufferSize=maximum-API-trace-I/O-buffer-size

This parameter specifies the maximum size of an API trace I/O buffer (in kilobytes), as an integer from 1 to 2048000. The default value is 2048.

(32) trc.api.outputTrigger={BUFFER|NONE}

This parameter specifies BUFFER or NONE as the timing for output to file of API trace information. This value is not case sensitive. The default value is BUFFER.

BUFFER
Outputs API trace information to a file when the I/O thread buffer becomes full.
NONE
Does not output API trace information to a file or perform buffering of API trace information.

(33) trc.api.useOverwrite={true|false}

This parameter specifies, as true or false, whether the API trace buffer is to be overwritten when the buffer becomes full. This value is not case sensitive. The default value is true.

true
Overwrites the API trace buffer.
false
Does not overwrite the API trace buffer.