Here are the definitions of Refiner’s configuration properties.
Modifying a property
To modify a property, add its new value to the file:
<Framework-root> is the topmost directory of the Deployment Framework.)
The format of a property is a dot-separated property name with an associated value, like this:
The Refiner configuration properties are:
The duration in milliseconds for which Caplin Refiner waits before publishing any changes it has received since the last time it published.
The default value causes Caplin Refiner to immediately publish any new updates as soon as it has finished publishing the previous batch.
batch.timeis negative or not a number, the default value is used.
Run Caplin Refiner initially with the default setting for
batch.time(no batching of updates). If, in your system, the rate at which Caplin Refiner has to publish updates causes performance problems with Caplin Refiner itself or for clients, increase
batch.timeas required to give acceptable performance.
Defines a custom filter comparator.
filter-nameis the name of the custom filter comparator.
You can define multiple custom filter comparators; each
filtering.algorithm.<filter-name>must have a unique
<filter-name>. The property value is the fully qualified class name of the custom filter comparator class.
Default: 1 (< v7.1.4), 5 (>= v7.1.4)
log.file.count= 0, logging is disabled.
log.file.count= 1, log messages are written to
refiner.logand the following cycling rules apply:
log.file.count> 1, log messages are written to
refiner.log.0and the following cycling rules apply:
refiner.log.0is not cycled and grows without limit.
log.file.limit> 0, then the
refiner.log.0and any archived logs are cycled when
log.file.limitbytes in size. Log files are cycled by incrementing their filename suffix (
refiner.log.n) by 1, beginning with the oldest log file. When all files have been renamed, a new
refiner.log.0file is created. If the number of log files now exceeds
log.file.count, then the oldest log file is deleted.
Defines the log level for messages written to the Caplin Refiner log file. The log levels are the standard Java ones:
The maximum size of a Caplin Refiner log file in bytes.
log-file-limit= 0, the current log file is not cycled and grows without limit.
log-file-limit> 0, the current log file is cycled when it exceeds
log-file-limitbytes in size. We recommend that this setting is used in conjunction with
log-file-countset to 2 or greater.
As Transformer receives updates to the records in a container, it creates (via Caplin Refiner) individual container record removal and record insertion messages according to how the updates match the filter and sort criteria. If the resulting number of record insertions is high, this can load the Liberator excessively.
max.update.sizeproperty helps to reduce such loading on the Liberator. It defines the maximum number of container record inserts that Caplin Refiner sends in a single batch period (as defined by batch.time). If the number of updates exceeds
max.update.size, Transformer sends the changes as a single container image instead.
max.update.sizeis negative, 0 or not a number, this feature is turned off and all updates are sent as inserts.
- nodata.records. rerequest.timer
The period in milliseconds between re-requests made by Caplin Refiner for any records that were not previously successfully subscribed to on a supplying DataSource.
nodata.records.rerequest.timeris negative, 0, or not a number, this feature is turned off.
How long in milliseconds Caplin Refiner waits for results before removing the placeholder record.
The placeholder record has a special name that allows the client to display an indicator showing that it’s waiting for data. When the placeholder is removed, the client should remove the indicator.
placeholder.timeoutis negative or not a number, the default value is used.
Defines a custom sort list or custom sort comparator.
sort-nameis the name of the custom sort.
You can define multiple custom sort lists and sort comparators; each
sorting.algorithm.<sort-name>must have a unique
<sort-name>. For custom sort lists, the property value is a list of sort attributes of the form
list: <item1>,<item2>,…in ascending sort order.
For custom sort comparators, the property value is of the form class:
<comparator-class>is the fully qualified class name of the custom comparator class.