User Tools

  • Vistasource Document Library

This is an old revision of the document!


RMDS (SFC) Engine Configuration

The RTW RMDS (SFC) engine is based on Reuters’s System Foundation Class API (SFC) and can be used to consume and provide Reuters market data information. Some initial configuration of SFC related files may be required depending on your Thomson Reuters Installation. This section provides information regarding the following topics:

Quick Setup

Before starting, make a list of items that depend on your real-time data environment. For example: the data server, server port, available services, RMDS implementation (TIB, SSL, or both). These values are needed before installing:

Connection Item
RMDS Point to Point Server (P2PS) Distributor names, port numbers and IP addresses for the SSL Implementation
RMDS Rendezvous (RTIC) Daemon, network and service parameters for the TIB Implementation

RMDS (SFC) Tab – Rtconfig Editor

This section provides information about editing the RTW RMDS (SFC) engine configuration options using the RTW rtconfig Editor. The options are located under the RMDS (SFC) Tab of the Rtconfig Editor dialog, and correspond to those found in the rtconfig file located in the installation directory.

To manually edit the RTW RMDS (SFC) engine configuration options in the rtconfig file, see Manually Editing the rtconfig File.

To edit the generic RTW configuration options as well as some general engine settings, see Generic Tab - Rtconfig Editor.
We strongly recommend that only system administrators or experienced users make changes to the configuration options.

To edit the RTW RMDS (SFC) rtconfig settings, select Vistasource → Settings → Rtconfig Editor and then select the RMDS (SFC) tab.

After setting the configuration options, click Save to File to save your settings in the rtconfig file. To close the dialog box without making any changes, click Close. If you made changes and click Close without first saving to file, a caution window opens to prevent an unintentional discarding of unsaved changes.

The following options are available on this tab:

Implementation

Refers to the rtconfig file option “rmds_Implementation”, which specifies the default implementation the SFC API will use to connect to your infrastructure. It is part of the default transport (connection), which is specified by Implementation, Services, and the appropriate SFC configuration parameters.

Select one of the following:

  • SSL, if your infrastructure is Triarch or RMDS (P2PS).
  • TIB, if your infrastructure is TIC/SASS2, TIC/SASS3, or RMDS (RTIC). The default is TIB.

To use both TIB and SSL infrastructures, additional connections can be specified. See section Connections below for more information.

Services

Refers to the rtconfig file option “rmds_Services”, and is used to specify a list of services to display in the RMDS (SFC) dialog boxes for subscribing. This comma-separated list refers to the services in the default transport (Connection). The service list will vary depending on your setup.

By default, this option is not set.

If TIC/SASS3 or RTIC has been configured to not dynamically discover services (see section SFC Configuration below), you must list your services here to add them manually.

SFC API Config File

Refers to the rtconfig file option “rmds_Config”, which is use to set the location of the SFC configuration file. Vistasource provides a sample sfcapi.conf in the installation directory. This file contains various settings for the RMDS SSL and TIB infrastructures. Depending on your specific configuration, you may need to merge this sfcapi.conf file with an already existing file on your system.

Type a file name or click on the Browse button to specify the file. If no file is specified here, the RMDS engine will look for a file in the following locations (based on the Reuters SSL library). Note: The SFC Configuration file must be named sslapi.cnf regardless of its location:

  1. In the local directory (.\sslapi.cnf)
  2. If the file is not found in the local directory, \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry.
  3. SSLAPI_CONFIG environment variable.
  4. If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.
    NOTE: Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.

To edit the selected file, click on the Edit button.

We strongly recommend that you consult the SFC manuals for more information regarding the Reuters file sfcapi.conf. The configuration file that Thomson Reuters provides may be called sslapi.cnf. When using the Vistasource sample sfcapi.conf file found in the install directory, you may need to make specific edits depending on your specific setup.

Keep Stale Data

Refers to the rtconfig file option “rmds_KeepStaleData”. When this option is checked on, RTD cells will retain their values even though the RTW RMDS (SFC) engine has been notified that they are no longer valid (that is, they have become stale). The “data stale” message will still be displayed in the status window. When this option is off (the default), cells referring to stale data will display N/A.

Use Four Part Subjects

Refers to the rtconfig file option “rmds_UseFourPartSubjects”. When using a TIB implementation, the default behavior for subscribe is to accept 2-part subject names, for example: MSFT.O (the SFC API automatically maps RICs into 4-part Rendezvous subject names using an internal mapping algorithm).

Select this option, if you want to use 4-part subject names (and do not want to rely on the API's algorithm).

This will not work when using TIC/SASS3 or RTIC with the dynamic service finding option ON. To disable dynamic services, manually edit the sfcapi.conf file by adding the line:
*tibFactory.enableDynamicRTRecordServices: FALSE
When publishing market data (as opposed to contributing), the record name must be a four-part subject name regardless of the setting of this option.

SFC API Logger

Refers to the rtconfig file option “rmds_logger”, which turns on the SFC API logging mechanism. Select this option if you want the API to log according to the logging settings in the sfcapi.conf file. By default, this option is turned off. For more information on the SFC API logging, see SFC Configuration below.

Connections

The fields in this panel refer to the section in the rtconfig file used to set up multiple connections (rmds_transport settings).

For instance, when working in an infrastructure that supports both RMDS SSL and TIB, two connections have to be created, one for each implementation. The creation order is irrelevant. See also the example Simple RMDS (SFC) Installation for both SSL and TIB under SFC Setup Examples.

To create an SSL connection, in the Connections panel:

  1. Choose SSL for the Implementation
  2. Enter a new name for the new connection, e.g. conn1.
  3. Enter the services using a comma-separated list, e.g. IDN_SELECTFEED, DTS
  4. Click Save Connection.

To create a TIB Connection, in the Connections panel:

  1. Choose TIB for the Implementation
  2. Enter a new name for the new connection, e.g. conn2.
  3. Enter the Rendezvous Service, e.g. 7500.
  4. Enter the Rendezvous network interface, e.g. 10.100.1.92
  5. Enter the Rendezvous daemon e.g. tcp:10.100.1.92:7500.
  6. Enter the protocol, e.g. SASS2 or SASS3
  7. Enter the services using a comma-separated list. The Services are used for the Excel User Interface, e.g. RSF, SH.
  8. Click Save Connection.

To remove a previously saved connection, select the connection in the Name pull-down menu and click Remove Connection.

SFC Configuration

The SFC configuration file contains various settings for the RMDS SSL and TIB infrastructures. Vistasource provides a sample configuration file in the installation directory called sfcapi.conf. Depending on your configuration, you may need to merge this sfcapi.conf file with an already existing file on your system.

A few of the parameters are highlighted in this section. For further information regarding all the parameters available, see the Reuters SFC Documentation.

ipcRoute Parameter

The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax:

*ipcRoute: ipcService [hostname…]

For example: *ipcRoute: triarch_sink p2ps_host
The SFC API will look for the SFC Configuration file in the following locations. Note: The SFC Configuration file must be named sslapi.cnf regardless of its location:

  1. In the local directory (.\sslapi.cnf)
  2. If the file is not found in the local directory, \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry.
  3. SSLAPI_CONFIG environment variable.
  4. If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.
    NOTE: Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.

Entitlements

Entitlements are on by default. If you do not have access to the DACS permissioning system, the entitlements setting must be set to FALSE. Change the following line:

#*enableEntitlements: FALSE

to

*enableEntitlements: FALSE

Logging

SFC logging can be controlled using several parameters. If you need to debug and turn on logging, several logging severity levels are available. The list is from lowest to highest: Debug, Info, Notice, Warning, Error, Critical, Alert, Emergency. Events are logged at the specified severity level AND HIGHER. For instance, if Info is specified, all events except Debug are logged. The default is Info.

*logger*selector: *.debug

Tracing provides a way to log extra debug messages. The specified value is an integer bitmask of various levels. In other words, valid values can be created by adding the desired levels.

1 = service level tracing
2 = basic item level tracing
4 = full item level tracing
8 = item image/update data tracing

For example, to turn on service level and full item level tracing, the following value would be used:

*traceLevel: 5

The default is 0, i.e. no tracing.

Tracing only works when the *selector configuration is set to Debug.

Choose the file to log to. The default is log.out:

*vsRMDS*logger*file: c:/temp/vsrmds.log

SFC Setup Examples

This section contains several examples for basic SFC setup.

Simple RMDS (SFC) Configuration for SSL

  1. Define your RMDS implementation and services:
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor.
    2. Select the RMDS (SFC) tab.
    3. Select SSL under Implementation.
    4. Enter a comma-separated list of services in the Service field, e.g. DTS,IDN_SELECTFEED
    5. Click OK.
  2. The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: *ipcRoute: ipcService [hostname…]
    For example: *ipcRoute: triarch_sink p2ps_host
    The SFC API will look for the SFC Configuration file in the following locations. Note: The SFC Configuration file must be named sslapi.cnf regardless of its location:
    1. In the local directory (.\sslapi.cnf)
    2. If the file is not found in the local directory, \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry.
    3. SSLAPI_CONFIG environment variable.
    4. If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.
      NOTE: Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.
  3. By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in C:\var\triarch. To create the local data dictionary in the default directory:
    1. Verify the directory C:\var\triarch exists.
    2. In Windows 7, browse to C:\Program Files(86)\Vistasource\RTW\4.5\ and in Windows XP, browse to C:\Program Files\Vistasource\RTW\4.5\. Copy the files appendix_a and enumtype.def.
    3. Paste the files into C:\var\triarch.

Simple RMDS (SFC) Configuration for TIB

  1. Define your RMDS TIB implementation and services, and location of SFC configuration file:
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor.
    2. Select the RMDS (SFC) tab.
    3. Select TIB under Implementation.
    4. Enter a comma-separated list of services in the Service field. The service list will vary depending on your Reuters installation, e.g. RSF,IDN_RDF.
    5. Browse to the SFC API Config file. Vistasource provides a sample file called sfcapi.conf in the installation directory. Select this file (you will edit it in the next step).
    6. Click OK.
  2. Edit the SFC API Configuration file:
    1. While in the Rtconfig Editor, click the Edit button next to SFC API Config to edit the sfcapi.conf file.
    2. Enter your values for protocol, service, network and daemon according to the values collected before getting started.
    3. Additionally, the entitlements settings may require changes depending on your setup. Entitlements are on by default. If you do not have access to the DACS permissioning system, set this value to FALSE by uncommenting the *enableEntitlements: FALSE line.
    4. Save the sfcapi.conf file.
  3. By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in C:\var\triarch. To create the local data dictionary in the default directory:
    1. Verify the directory C:\var\triarch exists.
    2. In Windows 7, browse to C:\Program Files(86)\Vistasource\RTW\4.5\ and copy the files appendix_a and enumtype.def. In Windows XP, browse to C:\Program Files\Vistasource\RTW\4.5\ and copy the files appendix_a and enumtype.def.
    3. Paste the files into C:\var\triarch.

Simple RMDS (SFC) Installation for both SSL and TIB

To use both SSL and TIB implementations, two connections need to be set up. This can be accomplished in two ways:

  1. Setting up a default connection on the left side of the RMDS (SFC) tab and then adding an additional connection via the Connections panel on the right side (see Example 1 below)
  2. Setting up both connections via the Connection panel on the right side (see Example 2 below).

Example 1 – Using a Default Connection and then Additional Transport Connections

  1. Define your default RMDS implementation and services, e.g. SSL:
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor
    2. Select the RMDS (SFC) tab
    3. Select SSL under Implementation
    4. Enter a comma-separated list of services in the Service field, e.g.:
    5. DTS,IDN_SELECTFEED
    6. Click OK.
  2. Define your additional connection, e.g. TIB:
    1. In the Connection panel, define the following:
      • Enter a new name for the new connection, e.g. conn2.
      • Select TIB under Implementation.
      • Enter the Rendezvous Service, e.g. 7500.
      • Enter the Rendezvous network interface, i.e. 10.100.1.92
      • Enter the Rendezvous daemon, i.e. tcp:10.100.1.92:7500.
      • Enter the protocol, e.g. SASS2 or SASS3.
      • Enter the services. The Services are used for the Excel User Interface, e.g. RSF, SH.
    2. Save the new connection.
  3. Click Save to File to save your selections in the rtconfig file and close the RTW rtconfig Editor.
  4. The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: *ipcRoute: ipcService [hostname…]
    For example: *ipcRoute: triarch_sink p2ps_host
    The SFC API will look for the SFC Configuration file in the following locations. Note: The SFC Configuration file must be named sslapi.cnf regardless of its location:
    1. In the local directory (.\sslapi.cnf)
    2. If the file is not found in the local directory, \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry.
    3. SSLAPI_CONFIG environment variable.
    4. If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.
      NOTE: Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.
  5. By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in C:\var\triarch. To create the local data dictionary in the default directory:
    1. Verify the directory C:\var\triarch exists.
    2. In Windows 7, browse to C:\Program Files(86)\Vistasource\RTW\4.5\ and in Windows XP, browse to C:\Program Files\Vistasource\RTW\4.5\. Copy the files appendix_a and enumtype.def.
    3. Paste the files into C:\var\triarch.

Example 2 - Using rmds_transport for all Connections

  1. Remove any rmds_Implementation and rmds_Service settings.
    By default, implementation and services are not set. However, Vistasource strongly recommends verify these settings in the rtconfig file
    1. In Windows 7, browse to C:\Program Files(86)\Vistasource\RTW\4.5\rtconfig and in Windwos XP, browse to C:\Program Files\Vistasource\RTW\4.5\rtconfig. Open file in a text editor.
    2. Scroll to rmds_Implementation and rmds_Services in the section “vsRMDS RT Engine Settings” and verify that both parameters are commented out.
    3. If you made changes, save the file and close.
  2. Define your SSL Connection:
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor.
    2. Select the RMDS (SFC) tab.
    3. In the Connection panel, on the right side, define the following:
      • Enter a new name for the new connection, e.g. conn1.
      • Select SSL under Implementation
      • Enter the services, e.g. IDN_SELECTFEED, DTS
      • Save the connection by clicking Save to File.
  3. Define your TIB Connection:
    1. In the Connection panel, define the following:
      • Enter a new name for the new connection, e.g. conn2.
      • Select TIB under Implementation.
      • Enter the Rendezvous Service, e.g. 7500.
      • Enter the Rendezvous network interface, i.e. 10.100.1.92
      • Enter the Rendezvous daemon, i.e. tcp:10.100.1.92:7500.
      • Enter the protocol, e.g. SASS2 or SASS3.
      • Enter the services. The Services are used for the Excel User Interface, e.g. RSF, SH.
      • Save the new connection by clicking Save to File.
  4. Click Save to File to save your selections in the rtconfig file and close the RTW rtconfig Editor.
  5. The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: *ipcRoute: ipcService [hostname…]
    For example: *ipcRoute: triarch_sink p2ps_host
    The SFC API will look for the SFC Configuration file in the following locations. Note: The SFC Configuration file must be named sslapi.cnf regardless of its location:
    1. In the local directory (.\sslapi.cnf)
    2. If the file is not found in the local directory,
      \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry
    3. SSLAPI_CONFIG environment variable
    4. If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.
      Note: Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.
  6. By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in C:\var\triarch. To create the local data dictionary in the default directory:
    1. Verify the directory C:\var\triarch exists.
    2. In Windows 7, browse to C:\Program Files(86)\Vistasource\RTW\4.5\ and in Windows XP, browse to C:\Program Files\Vistasource\RTW\4.5\. Copy the files appendix_a and enumtype.def.
    3. Paste the files into C:\var\triarch.

Generic Configuration Options

In addition to the engine-specific RTW RMDS (SFC) settings, some generic RTW and general RTW engine settings can be customized according to your work environment. These configuration options are located on the Generic tab of the RTW rtconfig Editor dialog, and correspond to those found in the rtconfig file, which is located in the installation directory.

When editing configuration options, changes to the RTW Engine settings require a restart of the RTW engine. Changes to the generic RTW options require a restart of Excel.

To manually edit the generic RTW and general RTW engine configuration options in the rtconfig file, see section Manually Editing the rtconfig File.

We strongly recommend that only system administrators or experienced users make changes to the configuration options.

Select Vistasource → Settings- > Rtconfig Editor to open the RTW rtconfig Editor dialog box.

Generic Tab - Rtconfig Editor

The Generic tab refers to the sections “Generic RT Engine Settings” and “RTW Settings” in the rtconfig file.

After setting the configuration options, click Save to File to save your settings in the rtconfig file. To close the dialog box without making any changes, click Close. If you made changes and click Close without first saving to file, a caution window opens to prevent an unintentional discarding of unsaved changes.

The Generic tab contains the following fields and controls for editing RTW and generic RTW engine configuration options:

Trace

Refers to the rtconfig file option “Trace”. Tracing collects a detailed log of engine initialization, all transactions between engine and data distribution system as well as general information. It is typically used to debug network or connection problems. In order to obtain tracing information, select Trace. This option is turned off by default.

Verbose

To collect more detailed information, select Verbose (in addition to Trace).

The trace information is written to a file. Enter the name and directory location of this file in the field Trace File. You can browse for an existing trace file or create a new one.

Turn Trace off, when it is no longer needed, because it significantly slows down the performance of the software.

Engine throttle (in seconds)

Refers to the rtconfig file option “rtFlushInterval”. Setting a specific value (in seconds) defines the interval by which the engine sends updates to RTW. The default value is 0 seconds and implies that the engine should send data as soon as it is available.

Republish Stale Data Interval

Refers to the rtconfig file option “rePublishStaleDataInterval”, which sets the interval after which the engine will republish each field value. Intervals between 1-3600 seconds (1 sec to 1 hour) are permissible. If no new value is received within the specified interval, the current value is published again. By default, this option turned off.

RTINSERT Returns Value

Refers to the rtconfig file option “rtInsertValueEcho”. When set, the published value from a successful publish displays in the formula cell instead of the string OK. By default, this option is turned off, and OK will be returned.

Date/Time as String

Refers to the rtconfig file option “rtDateTimeAsString”, which specifies how date and time fields are handled when subscribing and publishing.

If checked, date and time fields are treated as strings. This option is checked by default.

If unchecked, date and time fields are treated as spreadsheet date and time values.

No Excel Events

Refers to the rtconfig file option “no_excel_events”, which specifies whether RTW listens to certain Excel events. If you add RTW to an installation that also includes other add-ins listening to Excel events, these add-ins may not receive the events that they are waiting for if they are loaded after the RTW add-in is loaded.

If checked, RTW is no longer listening to Microsoft Excel events, thereby allowing other add-ins to properly trap the events. By default, this option is turned off.

If this option is selected, the RTW menu items will not always be enabled or disabled as appropriate, for example when there is no workbook in Microsoft Excel, or when no engines are running.

In addition, the following functionalities are affected if this option is selected:

RTW Wrapper Functions

With the No Excel Events option selected, the RTW wrapper functions no longer automatically calculate when the file is opened, but require a manual calculation to start them. See RTW Functions for more information regarding the wrapper functions.

WorkbookBeforeClose

The WorkbookBeforeClose event is used to prevent the RTW Add-ins from being unloaded when the user exits a work book, but then chooses to cancel the operation. With the No Excel Events option selected, this functionality is no longer available.

WorkbookBeforeSave

The WorkbookBeforeSave event is used to maintain any RTW settings that are saved with a workbook. With the No Excel Events option selected, this functionality is no longer available.

Status Window

Refers to the Generic RT Engine setting “suppress_rt_status”, and the RTW Settings “rtexcel:SWOption”, “rtexcel:SWDir” and “rtexcel:SWPromote”. These settings control what information is logged to the status window and when the status window should be displayed.

Status Window Options

The following options apply to the rtconfig file options “rtexcel:SWOption” and “rtexcel:SWDir”.

Full Debug Mode

Logs engine start, warnings, errors, other status information and debugging information, and generates two files: xll.log and rts.log. By default, these files are created in the default installation directory. You can browse to change the log directory.

Information Mode

Logs engine start, warnings and errors. The log file rts.log will only be created if a log directory is specified.

Errors Only Mode

Logs errors only. The log file rts.log will only be created if a log directory is specified.

Hidden Mode

Status Window is never displayed. If selected, the menu option Vistasource → Info → Show/Hide Status Window is disabled. However, the log file rts.log will still be created if a log directory is defined.

Log Directory

If Full Debug Mode is turned on, two log files are created; xll.log and rts.log. If no log directory is specified, the files are created in the RTW installation directory. To use a different log directory, specify one here.

If Information Mode, Errors Only Mode or Hidden mode is selected, and a log directory is specified, then the log file rts.log will be created.

To specify a directory, enter a directory in the Log Directory field or browse to a directory of your choice.

Status Window Promote Options

The following options refer to the “suppress_rt_status” and “rtexcel:SWpromote” rtconfig settings, which define when the status window is displayed. The default is Show Always.

Show Always

The status windows displays the first time a real-time request is made.

Suppress Always

The status window is not displayed, except when Vistasource → Info → Show/Hide Status Window is selected.

Show on Error Only

The status window only displays when an error occurs.

Promote on Error

The status window is promoted to the foreground when an error is encountered.