The configuration options documented in this section provide fundamental configuration capabilities for the module.

`pipeline-logflags`

Type: String Array
Default: None

Set the logging flags for a dynamic pipeline

`modules-conf-dir`

Type: String Array
Default: None

Config dir

`modules-dir`

Type: String Array
Default: None

`config-file`

Short option: –f
Type: String
Default: transformer.conf

Main config file

`application-root`

Short option: –r
Type: String
Default: None

Application Root

`application-name`

Short option: –n
Type: String
Default: transformer

Application Name

`runtime-user`

Type: String
Default: None

The user to run as

`event-log`

Type: String
Default: %a.log

Event Log filename

`preprocessor-binary`

Type: String
Default: None

This option should refer to the full path to a binary or script that can preprocess configuration files prior to them being parsed by the datasource libraries.

Depending upon your choice of preprocessor, this allows variables to be substituted, extended logical conditions to be validated and generally reducing the configuration management requirements.

The preprocessor should take as its first argument the name of the file to process, and output a rewritten configuration file to standard out.

This feature has been extensively tested using the GNU M4 macro processor.

`http-download-command`

Type: String
Default: wget -nv -O -

HTTP config file download command

`quiet-config`

Short option: –q
Type: Boolean
Default: FALSE

This is now the default

`verbose-config`

Short option: –v
Type: Boolean
Default: FALSE

Report all messages for config files being loaded

`ignore-missing-config-files`

Short option: –i
Type: Boolean
Default: FALSE

Do not fail if configuration files do not exist

`enable-threaded-callbacks`

Type: Boolean
Default: FALSE

Release 4.4 of the Caplin Platform introduced a major new feature and an important pre-requisite for components that sit within the platform.

Prior to 4.4, all DataSource messages were serviced on a single thread and callbacks could be guaranteed to occur only on a single thread. With 4.4, multiple threads service DataSource messages, with the result that callbacks can occur on more than one thread and that more than one callback may be in progress at any point in time.

In order to maintain source compatibility with products built using older versions of DSDK, all callbacks into the application will occur on the thread that called ds_loop(), this naturally introduces a synchronisation point and will impact performance.

Enabling this option will remove the synchronisation point and performance will be increased, however the application must be threadsafe.

`syslog-facility`

Type: Integer
Default: 176
Acceptable Values:

Name	Value	Desc
auth	32
authpriv	80
cron	72
daemon	24
ftp	88
kern	0
lpr	48
mail	16
news	56
security	32
syslog	40
user	8
uucp	64
local0	128
local1	136
local2	144
local3	152
local4	160
local5	168
local6	176
local7	184

Syslog Facility

`event-module`

Type: Integer
Default: 4
Acceptable Values:

Name	Value	Desc
epoll	1	Use the epoll event manager (Linux only)
devpoll	2	Use the /dev/poll event manager (Solaris only)
poll	4	Use the poll event manager (Unix only)
select	8	Use the select event manager (not recommended)
iocomp	16	Use the IO completion event manager (Windows only)

This option defines the default event manager used by DataSource threads. It's not recommended to change the default; DSDK will automatically find the best event manager to use on a given platform.

`debug-level`

Type: String
Deprecated: Yes
Default: INFO

Use log-level

`disable-threadname-logging`

Type: Boolean
Default: FALSE

Disable logging of thread names

`daemon-enable`

Short option: –d
Type: Boolean
Default: FALSE

Daemon mode enable

`pid-filename`

Type: String
Default: %r/var/%a.pid

Filename for the pid file

`active-request-timeout`

Type: Floating Point Value
Deprecated: Yes
Default: 10.000000

Use service-request-timeout instead

`license-file`

Type: String
Default: license-%a.conf

License file

`rmi-registry-port`

Type: Integer
Default: -1

Port for the RMI registry

`rmi-client-port`

Type: Integer
Default: -1

Port for the RMI registry

`rmi-server-hostname`

Type: String
Default: None

RMI server host name

`stringpool-hashtable-size`

Type: Integer
Default: 100000

Size of hashtable for stringpool

`help`

Short option: –h
Type: Boolean
Default: FALSE

Display Help Options

`fields-file`

Type: String
Deprecated: Yes
Default: None

Please use include-file instead

`transformer-active`

Type: Boolean
Deprecated: Yes
Default: FALSE

The Transformer is always an active datasource

`rtas-active`

Type: Boolean
Deprecated: Yes
Default: FALSE

The Transformer is always an active datasource

`server-type`

Type: String
Default: transformer

Server type (used for monitoring)

`add-module`

Type: Function
Default: None

Module to load

`dont-remove-modules-at-exit`

Type: Boolean
Deprecated: Yes
Default: FALSE

Modules are no longer unloaded on exit

`memory-file`

Type: String
Default: None

File to dump memory contents to

`write-cache-period`

Type: Floating Point Value
Default: -1.000000

Interval to write the cache file at (seconds)

`memory-hash-size`

Type: Integer
Default: 16384

Size of Memory hashtable

`add-purge`

Type: Function
Default: None

Add a purging event

`object-remove-last-listeners`

Type: Boolean
Deprecated: Yes
Default: FALSE

Removing objects after last subscriber unsubscribes is now the default

`default-object-status-stale`

Type: Boolean
Default: FALSE

Set if the default object status of all objects should be stale

`permission-hash-size`

Type: Integer
Default: 65536

Size of the type 2 hash table

`record-max-cache`

Type: Integer
Default: 10

Max size of type 3 record data

`type2-hash-size`

Type: Integer
Default: 65536

Size of the type 2 hash table

`news-max-headlines`

Type: Integer
Default: -1

Max number of news headlines to cache

`news-purge-time`

Type: Integer
Default: -1

News Purge Time

`news-purge-days`

Type: Floating Point Value
Default: 0.000000

Days of News to store

Configuration group `add-newsconfig`

Start a news config group

`symbol`

Type: String
Default: None

News symbol

`purge-days`

Type: Floating Point Value
Default: 0.000000

Days of news to store

`max-headlines`

Type: Integer
Default: -1

Max number of headlines

`heartbeat-symbol`

Type: String
Default: None

Symbol for the heartbeat

`heartbeat-symbol-time`

Type: Floating Point Value
Default: 30.000000

Time between symbol heartbeats

`peerdown-time`

Type: Floating Point Value
Default: 60.000000

Time to clean up after peer down

`disable-peer-status`

Type: Boolean
Default: FALSE

Disable status messages following transition of peer states

`stats-time`

Type: Floating Point Value
Default: 10.000000

Time between collating statistics

`buf-elem-len`

Type: Integer
Default: 4096

Length of a buffer element

`buf-cache-size`

Type: Integer
Default: 16

Size of buffer cache

`shell-interface`

Type: String
Default: None

Shell Listen Interface

`shell-port`

Type: Integer
Default: 16000

Shell Listen Port

`shell-enable`

Type: Boolean
Default: FALSE

Enable Transformer Shell

`symboluser-hashsize`

Type: Integer
Default: 63

Size of hashtable for symboluser details

`map-limited-status-to-ok`

Type: Boolean
Default: FALSE

Forward a LIMITED status as an OK status

`contrib-return`

Type: Boolean
Default: FALSE

Return contributions to the owning datasource

pipeline-logflags

modules-conf-dir

modules-dir

config-file

application-root

application-name

runtime-user

event-log

preprocessor-binary

http-download-command

quiet-config

verbose-config

ignore-missing-config-files

enable-threaded-callbacks

syslog-facility

event-module

debug-level

disable-threadname-logging

daemon-enable

pid-filename

active-request-timeout

license-file

rmi-registry-port

rmi-client-port

rmi-server-hostname

stringpool-hashtable-size

help

fields-file

transformer-active

rtas-active

server-type

add-module

dont-remove-modules-at-exit

memory-file

write-cache-period

memory-hash-size

add-purge

object-remove-last-listeners

default-object-status-stale

permission-hash-size

record-max-cache

type2-hash-size

news-max-headlines

news-purge-time

news-purge-days

Configuration group add-newsconfig

symbol

purge-days

max-headlines

heartbeat-symbol

heartbeat-symbol-time

peerdown-time

disable-peer-status

stats-time

buf-elem-len

buf-cache-size

shell-interface

shell-port

shell-enable

symboluser-hashsize

map-limited-status-to-ok

contrib-return

`pipeline-logflags`

`modules-conf-dir`

`modules-dir`

`config-file`

`application-root`

`application-name`

`runtime-user`

`event-log`

`preprocessor-binary`

`http-download-command`

`quiet-config`

`verbose-config`

`ignore-missing-config-files`

`enable-threaded-callbacks`

`syslog-facility`

`event-module`

`debug-level`

`disable-threadname-logging`

`daemon-enable`

`pid-filename`

`active-request-timeout`

`license-file`

`rmi-registry-port`

`rmi-client-port`

`rmi-server-hostname`

`stringpool-hashtable-size`

`help`

`fields-file`

`transformer-active`

`rtas-active`

`server-type`

`add-module`

`dont-remove-modules-at-exit`

`memory-file`

`write-cache-period`

`memory-hash-size`

`add-purge`

`object-remove-last-listeners`

`default-object-status-stale`

`permission-hash-size`

`record-max-cache`

`type2-hash-size`

`news-max-headlines`

`news-purge-time`

`news-purge-days`

Configuration group `add-newsconfig`

`symbol`

`purge-days`

`max-headlines`

`heartbeat-symbol`

`heartbeat-symbol-time`

`peerdown-time`

`disable-peer-status`

`stats-time`

`buf-elem-len`

`buf-cache-size`

`shell-interface`

`shell-port`

`shell-enable`

`symboluser-hashsize`

`map-limited-status-to-ok`

`contrib-return`