Capital Markets Adapters 10.3.1 | Apama Capital Markets Adapters Documentation 10.3.1 | Reuters RFA Adapter | Transport configuration parameters
 
Transport configuration parameters
The following parameters has to be set in the IAF configuration file ( see the manual "Apama Platform Development Environment - The Integration Adapter Framework" for how to do this):
Name
Parameter Name
REUTERS_RFA_TRANSPORT_NAME
The name of the ReutersRFA adapter transport.
RFA_CONSUMER_THREADCOUNT
This parameter should be set to an optimum value based on the incoming message rate and number of CPUs available on the machine.
Defaults to 4
PUBLISH_DEPTH_FROM
From which the market Depth should be constructed and published Possible valid values: MARKET_PRICE / MARKET_BY_PRICE / MARKET_BY_ORDER
Defaults to MARKET_PRICE
PUBLISH_DEPTH_LEVEL (Optional)
Level of market depth to be published.
Defaults to 5
Note:
Single level depth will be published if PUBLISH_DEPTH_FROM is MARKET_PRICE
RIC_TRANSLATOR_FILE_PATH (Optional)
Absolute file path where RIC translation file exists. Sample file exists in adapter parameter directory (ric-translation.txt. Invalid path leads to ignore the RIC translation.
INCLUDE_FIELDS (Optional)
List of fields to be considered while decoding OMM Message for payload. For this the ACRONYMs from RDM dictionary should be used and separated by comma(","). The asterisk character ("*") can be used to include all fields.
Defaults to None ("").
For Example: QUOTIM_MS,TIMCOR_MS
EXCLUDE_FIELDS (Optional)
List of fields to be ignored while decoding OMM Message for payload. For this the ACRONYMs from RDM dictionary should be used and separated by comma(","). The asterisk character ("*") can be used to exclude all fields.
Defaults to None ("").
Example combinations:
1. Include all fields
INCLUDE_FIELDS="*" and EXCLUDE_FIELDS=""
2. Include QUOTIM_MS & TIMCOR_MS
INCLUDE_FIELDS="QUOTIM_MS,TIMCOR_MS" and EXCLUDE_FIELDS=""
3. Include all fields except QUOTIM_MS & TIMCOR_MS
INCLUDE_FIELDS="*" and EXCLUDE_FIELDS="QUOTIM_MS,TIMCOR_MS"
4. Exclude all fields
INCLUDE_FIELDS="*" and EXCLUDE_FIELDS="*"
Note:
Exclude fields has high precedence than include fields.
REPORT_UPDATES (Optional)
Subset of include fields to be considered to generate update events. For this the ACRONYMs from RDM dictionary should be used and separated by comma(","). The asterisk character ("*") can be used to specify all include fields.
Defaults to None ("") (No updates will be generated on payload changes).
For Example: QUOTIM_MS
RFA_LOGGING_LEVEL (Optional)
A measure of severity for a message, it provides control over which messages to be displayed. RFA Java uses four logging levels:
*SEVERE : Used for catastrophic errors that require immediate attention
*WARNING : Used for serious problems that must be noted
*INFO : Used for normal informational messages; it is the default logging level
*FINE : Used for detailed logging for debug purposes (that is, it provides tracing information
*Default value is 'INFO'
RFA_LOGGING_LOCATION (Optional)
File path where all the logs should be stored.
Default value is RFA_%u.log
RFA_LOGGING_APPEND (Optional)
If this is'true' and given file path exists then appends logs to the file else overwrites them.
Default value is true.
EscapeFields (optional)
This property carries set of fields which need to be validated and apply string escaping if there is any special character. Default values are BCAST_TEXT, SEG_TEXT, TOPIC_CODE, CO_IDS, DSPLY_NAME, DSPLY_NMLL, GN_TXT16_2
MPDepth_RICType (optional)
This is applicable if "PUBLISH_DEPTH_FROM" is MARKET PRICE. Valid values are 'tick' or 'depth'.
Default value is 'tick'
The MARKET PRICE model gets both depth data. This depth can be either top of the book or order book. Client can request for either type by configuring transport properties "Depth.BID.Price", "Depth.ASK.Price" etc. RIC for these two depth types will be different.
For example: ricTranslation.txt has following mapping
^(\w+).L$; tick=\1.L; depth=\1.LO
which means, if subscribed for symbol ABC.L then internally for tick request will translate as ABC.L but for depth request it will be translated as ABC.LO
If interested in top of the book data then configure:
MPDepth_RICType='tick'. RIC will be ABC.L
If interested in depth book data then configure:
MPDepth_RICType='depth'. RIC will be ABC.LO
AllowEmptyDepths
AllowEmptyTicks
Publish empty depths. By default, TICK/DEPTH is not published when there is no FID in the OMM message which matches default FIDs. Still, if you are interested in receiving empty depths then following property will enable it
<property name="AllowEmptyDepths" value="true"/>
<property name="AllowEmptyTicks" value="true"/>
Defaults to false.
LogMessages
There are some messages which will be logged for every request received by the transport. In normal condition this is unnecessary overhead but when there is any problem such messages are required for debugging purpose. You can enable this property using:
<property name="LogMessages" value="true"/>
Defaults to false.
DACS_ApplicationID
Set the value of ApplicationId in LOGIN_REQ. If not set, ApplicationId will default to transport name.