Skip to main content

Configuration Reference

All SDS configuration is provided via environment variables with the KS_SDS_ prefix. For Docker, set these in the environment of the container. For Platform Manager, set these in $KS_HOME/conf/static-data-server.properties

The supplied package for this component contains conf/common.properties.template which contains all applicable configuration for this component along with their default values.

PropertyDefaultDescription
KS_SDS_INSTRUMENT_SOURCES[] (none)External data providers to subscribe to for instruments
KS_SDS_RPC_TIMEOUT5Timeout in seconds for RPC calls to external providers
KS_SDS_INCLUDE_MATURED_BONDSfalseWhether to publish bonds past their maturity date
KS_SDS_INSTRUMENT_EDIT_RESTRICTEDtradeRestrictionFlags.restricted, tradeRestrictionFlags.sanctionedInstrument fields that cannot be modified via the edit API
KS_SDS_INDEX_FIXING_DAYS365Number of days of historical index fixings to load at startup

KS_SDS_INSTRUMENT_SOURCES

Defines the list of external data providers from which SDS subscribes to instruments. This is a JSON array of source configuration objects.

Default: [] (no external providers — instruments must be added manually)

Format:

KS_SDS_INSTRUMENT_SOURCES=[
{
"name": "BBG Data Provider",
"topicSource": "bbg-data-provider",
"topicGroup": ""
},
{
"name": "Treasury Data Provider",
"topicSource": "trsy-data-provider",
"topicGroup": ""
}
]
PropertyDescription
nameHuman-readable label for logging
topicSourceThe topicSource of the provider's InstrumentDto messages
topicGroupThe topicGroup to subscribe to. Empty string ("") subscribes to all groups

KS_SDS_RPC_TIMEOUT

Timeout in seconds for RPC calls made to external data providers (e.g. SearchInstrument, GetInstrument requests forwarded to a provider).

Default: 5

KS_SDS_RPC_TIMEOUT=5

KS_SDS_INCLUDE_MATURED_BONDS

Controls whether bonds whose maturityDate is earlier than the current business date are published to the platform.

Default: false

KS_SDS_INCLUDE_MATURED_BONDS=false

Set to true for back-office or historical workflows that need access to expired instruments.

KS_SDS_INSTRUMENT_EDIT_RESTRICTED

A comma-separated list of instrument field names that cannot be modified via the edit API. Fields in this list will also not be overwritten by source provider updates.

Default: tradeRestrictionFlags.restricted, tradeRestrictionFlags.sanctioned

KS_SDS_INSTRUMENT_EDIT_RESTRICTED=tradeRestrictionFlags.restricted, tradeRestrictionFlags.sanctioned

Add additional fields to prevent accidental overwriting of manually curated data (e.g. profileName, benchmarkInstrumentId).

KS_SDS_INDEX_FIXING_DAYS

The number of days of historical index fixings to load from the database and publish to the platform at startup.

Default: 365

KS_SDS_INDEX_FIXING_DAYS=365

Set to 0 to load all available history (no date limit). This may increase startup time for indices with many years of data.