User Tools

  • Vistasource Document Library

Scope:

Table of Contents

Download RTW 4.3

Misc.

Demos

Guides

Help

Generic

RMDS(RFA) ENGINE

RMDS (SFC) Engine

BLOOMBERG Engine

NETFEED Engine

WEBDATA Engine

RTW RMDS RFA GUIDE

Preface

Vistasource RTW is an add-in for Microsoft Excel that enables you to obtain, manipulate and publish real-time financial data using multiple data sources.

Currently supported data sources include:

  • Reuters RMDS (vsRMDS SFC or vsRMDS2 RFA engines)
  • Bloomberg (axbloom engine)
  • Marketfeed (vsnf engine)
  • Web-Based data, e.g. Yahoo! (rthttp engine)
  • Pre-recorded data for Playback engine (mktdemo, for testing)
  • Any data source that provides a C or C++ API and for which a custom engine can be built using the Vistasource RTW Toolkit.

For more information regarding the RTW Toolkit, please contact Vistasource at rtwsales@vistasource.com.

RTW can also integrate directly with custom COM-aware applications written in Visual Basic, C++, Java, etc. For more information about the RTW COM Interface, see the Vistasource RTW COM Interface Guide

For news and information about Vistasource Inc. and its line of products, visit our website at www.vistasource.com. You can also subscribe to our newsletter from this site.

Navigation

For demonstration purposes, this guide assumes an installation of Windows XP and Microsoft Excel 2007.

The following conventions are used to illustrate navigation in the RTW interface: Select [tab] → [group] → [option, command, button]

For instance, to display the About dialog box with its version number and contact information, select Vistasource → Help → About.

For users of Microsoft Excel 2002 and 2003, the navigation paths are very similar; however, some very minor differences exist. For instance, to access the About dialog box in Microsoft Excel 2003, you need to select: Vistasource → About RTW.

For demonstration purposes, this manual assumes an installation of Windows XP and Microsoft Excel 2007.

Getting Started

This chapter provides information about how to get started with RTW and the RTW RMDS (RFA) engine. It covers the following topics:

System Requirements

RTW requires Microsoft Windows XP, Vista or Windows 7, and Microsoft Excel 2002 or higher. If using Microsoft Excel 2007, SP2 must be installed. If using Microsoft Excel 2003, SP3 must be installed.

The examples in this manual are based on a Microsoft Windows XP and Microsoft Excel 2007 (SP2) installation.

The installation of RTW and the RTW RMDS (RFA) engine requires approximately 30 MB of disk space.

The RTW installation program places all product files in the installation directory, makes some Registry entries, and places a few ActiveX controls in the system directory %SYSTEMROOT%\system32.

User files such as the personal favorites list will be stored in %USERPROFILE%\Application Data\Vistasource\RTW or C:\ if the Application Data directory does not exist.

Installing

This section describes the installation of the product on Windows XP.

The RTW COM Interface is a part of Vistasource RTW. It does not have a user interface menu option.

Using an .exe file

By default, the product can be downloaded as an .exe file. The .exe file is a self-extracting package. After downloading the .exe file, simply run the executable. Select Yes to continue.

  1. The InstallShield Wizard dialog will appear with a Welcome screen, click Next to continue.
  2. Read the License Agreement, select YES to continue.
  3. Select a destination location for the software. By default the destination folder will be:
    C:\Program Files\Vistasource\RTW\4.3
  4. Click Next to continue.
  5. On the Select Components screen, choose to install Vistasource RTW and the samples as well as the RTW RMDS (RFA) engine for your installation. Click Next to continue.
  6. The installer will install the necessary files according to your choices in step 5 and then display a final screen. This screen will provide the option to review the product release notes.
  7. Click Finish to complete the installation.

Using a .zip file

  1. If you download the .zip file, unzip the archive file and save its content to a user-defined directory.
  2. Browse to the directory where the archive files were extracted and select SETUP.EXE.
  3. The InstallShield Wizard dialog will appear with a Welcome screen, click Next to continue.
  4. Read the License agreement, select YES to continue.
  5. Select a destination location for the software. By default the destination folder will be:
    C:\Program Files\Vistasource\RTW\4.3 Click Next to continue.
  6. On the Select Components screen, choose to install Vistasource RTW and the samples as well as the RTW RMDS (RFA) engine for your installation. Click Next to continue.
  7. The installer will install the necessary files according to your choices in step 6 and then display a final screen. This screen will provide the option to review the product release notes.
  8. Click Finish to complete the installation.

Uninstalling

To remove the product, run the Windows XP program removal utility.

Please make sure that Microsoft Excel is closed, when you run the Uninstall option in the Add/Remove program.

Files that are not installed by the RTW installer will not be removed by it. If such files exist, they will require manual removal from the application directory.

To uninstall using the Windows Add/Remove Programs Utility

To uninstall RTW and the RTW engine(s):

  1. Select Start → Control Panel from the Windows taskbar.
  2. Double-click the Add/Remove Programs icon.
  3. The Add/Remove Program Properties dialog box appears.
  4. Click the Change or Remove Programs tab.
  5. Select RTW.
  6. Click Change/Remove.
  7. Windows prompts you to confirm the removal of this program.
  8. Click Yes.

To uninstall using the RTW Install Wizard

To uninstall RTW and the RTW engine(s):

  1. Select Start → Run from the Windows taskbar.
  2. The Run dialog box appears.
  3. Browse to the directory where the archive file was extracted and select SETUP.EXE.
  4. Click Open.
  5. Select the Remove option in the dialog box that appears and click Next. A dialog box appears requiring the confirmation of the uninstall process. After confirming the option, the uninstall process continues until the program is uninstalled

Licensing

RTW, the RTW engines and the RTW COM Interface are licensed products of Vistasource, Inc. Please refer to license agreement.

For detailed information about setting up licensing, see the Licensing HowTo document.

To purchase licenses, contact your local Vistasource Office or email rtwsales@vistasource.com for more information.

Select Vistasource → Help → About to display the About dialog box for the RTW version number and Vistasource contact information.

LMTools

Select Vistasource → License Management to display the LMTools by Macrovision Corporation dialog box. This tabbed dialog box provides details about your license setup including options to stop and restart the license server. More information on using this tool can be found in the Licensing HowTo document.

Configuration

The RTW RMDS (RFA) engine is based on the data-neutral, thread-aware Robust Foundation API (RFA) C++ Edition and can be used to consume and provide Reuters market data information. Some initial configuration steps are required to use the RTW RMDS (RFA) engine. This chapter includes the following information:

If you are migrating from an existing RFA installation, you may skip to Migration.

Quick Setup

Before starting, make a list of items that depend on your real-time data environment. For example: the data server, server port, connection type, available services, etc. These values are needed before installing:

ConnectionItem
RMDS Point to Point Server (P2PS)Distributor names, port numbers and IP addresses for an SSLED connection
RMDS Rendezvous (RTIC)Daemon, network and service parameters for a SASS3/RV connection

By default, the RTW RMDS (RFA) engine uses the Windows Registry for configuration. An example registry file is provided:

C:\Program Files\Vistasource\RTW\4.3\RFA-example.reg

To initialize the Registry with the example file:

  1. Browse to C:\Program Files\Vistasource\RTW\4.3
  2. Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry.

See RTW RFA Configuration Editor for instructions on how to edit RFA configuration.

RMDS (RFA) Tab – Rtconfig Editor

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

To manually edit the RMDS (RFA) 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 (RFA) rtconfig settings, select Vistasource → Settings → Rtconfig Editor and then select the RMDS (RFA) 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:

Default Session

Refers to the rtconfig file option “rmds2_DefaultSession”. RFA configuration works by specifying Session components, which in turn specify one or more Connection components. A Session is a “configuration context” which the engine uses to connect to RMDS Market Data. A Connection specifies an RMDS connection type such as SSLED or SASS3. If no session is specified in the real-time formula, the engine will use the session specified here as the default RFA session. If no default session is specified, “RTWSession” is used.

The session name must be defined in the RFA configuration as follows:

  • In the Windows Registry:
    [HKEY_LOCAL_MACHINE\Software\Reuters\RFA\<Namespace>\Sessions]
  • In the flat file: \Sessions

For more information about editing the RFA configuration, see RTW RFA Configuration Editor.

These RFA configuration settings depend on your Reuters installation. Vistasource strongly recommends that you consult the Thomson Reuters manual for more information.

User Config Databases

Refers to the rtconfig file option “rmds2_UserConfigDatabases”, which specifies the user-defined RFA configuration database names. Most RFA configuration information must be specified in the “Default” namespace, but Connections and Sessions can also reside in user-defined namespaces. This list is automatically created based on your configuration.

When using the Windows Registry, the user-defined namespaces are found under: [HKEY_LOCAL_MACHINE\Software\Reuters\RFA]. Any namespaces found here (other than the Default) will be listed as User Config Databases.

When using flat files (see next section) instead of the Windows Registry, any namespace other than the Default must have a separate file with a .cfg extension residing in the same directory as the default configuration file. The name of the namespace must match the name of the configuration file. For example, 'namespace1' is the name of the namespace in namespace1.cfg. The list of databases will automatically populate based on the files found.

Use this File Rather than the Registry

Refers to the rtconfig file option “rmds2_UseConfigFile”, which specifies a file containing the RFA configuration settings. By default, the engine looks for configuration information in the Windows Registry.

If you prefer using a flat file, select this option and provide the path to the [config file name] file.

Vistasource provides a sample configuration file called RFA-example.cfg, which is located in the install directory.

Keep Stale Data

Refers to the rtconfig file option “rmds2_KeepStaleData”. When this option is selected, RTD cells will retain their values even though the RTW RMDS (RFA) engine has been notified that the values are no longer valid (i.e. 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.

Advanced

Selecting the Advanced button opens a second, tabbed dialog box called RTW RFA Configuration, which is an interface to the RFA Windows Registry settings or a specified flat file. For more information about the RTW RFA Configuration Editor, see the following section.

RTW RFA Configuration Editor

The RTW RFA Configuration Editor is used to manage RFA namespaces (configuration databases) and their respective components.

Based on your setting for “Use this File Rather Than the Registry”, the RTW RFA Configuration dialog box provides an interface for editing the RFA configuration in either the Windows Registry or a specified flat file.

The RFA Configuration Editor only reads the RFA configuration components and their respective fields. It does not read custom component names or fields. When using a flat file, it also does not read lines that have been commented out.

To launch the editor:

  • In Excel, select Vistasource → Settings → Rtconfig Editor.
  • Select the RMDS(RFA) tab.
  • Click the Advanced button.

The following dialog will display when editing the Windows Registry:

The following dialog will display when editing a flat file:

When using the Windows Registry, you will be prompted to create an RFA default configuration if one does not already exist in the Registry.

The component tabs of the RFA Configuration Editor are as follows:

Each tab has a table of fields and values showing the current configuration for the respective component. Components and their field parameters can be added, removed or modified, and then saved. The way in which modifications are made, however, depends on the configuration mode.

When using the Windows Registry, the Save, Remove and Rename buttons directly and immediately edit the Registry. When using a flat file, the Save, Remove and Rename buttons only make modifications in memory. In this case, the Save to File button must be used to actually write the changes to the file. See below for some specific examples.

To close the RFA Configuration Editor, click Close. If there are any unsaved changes, you will be asked whether you want to save those changes.

Similarly, if there are unsaved changes in a table, and an action on the dialog would cause the table to refresh, you will be asked whether you want to save your changes. Examples of such actions are: changing a component type, changing a component name, or changing a namespace name.

Some of the RFA configuration components are detailed below using the SSLED example setup from the RFA-example.reg and RFA-example.cfg files. For more information about all of the RFA configuration components, please contact Thomson Reuters for the Robust Foundation API, v7, C++ Edition, Configuration Guide.

We strongly recommend that only system administrators or experienced users edit these advanced RMDS RFA configuration options.

Namespace

A namespace in RFA describes a kind of “configuration database.” A namespace can contain various components and settings, which are defined in the tabs below the Namespace field. The default RFA namespace is called “Default.”

When using the Windows Registry, this name corresponds to the Reuters\RFA\Default entry in the Registry.

When using a flat file, the name corresponds to the file specified in the “Use this File Rather than the Registry” setting. You can define new namespaces or edit existing ones. When using flat files, user-defined namespaces correspond to file names on disk (see below for more specific information).

To edit the default namespace:

  1. Verify that ‘Default’ is listed in the Namespace option box.
  2. Modify the individual configuration components by choosing the appropriate tabs and editing the settings.

To add a user-defined namespace:

  1. Enter the new name in the Namespace field.
  2. When using the Windows Registry, click Save Namespace. A new key will be written to the Registry. When using flat files, click Save to File. A new file will be created in the same directory as the Default namespace file, using the name of the namespace and the extension .cfg (e.g. namespace1 corresponds to the file namespace1.cfg).
By saving a new namespace name, you do not create an entire configuration tree. Define the individual configuration components for this new namespace by selecting the tabs and entering the relevant information. For user-defined namespaces, only Connection and Session components can be defined.

To remove an existing namespace and all its configuration components, follow these steps: If you created the namespace in the registry:

  1. Select the namespace in the Namespace option box.
  2. Click Remove Namespace.
    A dialog box opens with a message that all entries for that namespace will be removed from the registry.

If you are using flat files, the corresponding namespace file must be manually deleted:

  1. Navigate to the directory where the default flat file is,
    e.g. C:\Program Files\Vistasource\RTW\4.3
  2. Delete the namespace.cfg file.

Namespace Components

The RTW sample configuration sets up a Default namespace with various components. These components are detailed below using the default RTW session as an example.

A session is a configuration context that the engine uses to connect to RMDS. The default RTW session is called RTWSession and is defined to have an SSLED-type connection.

A minimal configuration must include at least one Session component and one Connection component.

Sessions

On the Sessions tab, you can choose to edit, rename or remove an existing session, or create a new session. A session must have its “connectionList” field set to define one or more connections. Note that the RTWSession uses “Connection_SSLED”

To edit the default session:

  1. Click on the Sessions Tab.
  2. Select RTWSession in the Name pull-down menu.
  3. Edit the session values.
  4. Click Save.

To add additional sessions:

  1. Click on the Sessions Tab.
  2. Type a session name in the Name field.
  3. Click Save.

To rename a session:

  1. Click on the Sessions Tab.
  2. Select a session name in the Name pull-down menu.
  3. Click Rename.
  4. Type the new name in the RTW RFA Rename dialog and click OK.

To remove a session:

  1. Click on the Sessions Tab.
  2. Select a session name in the Name pull-down menu.
  3. Click Remove.
As noted above, when using flat files the Save, Rename and Remove buttons only make changes in memory. Click Save to File to actually write the changes to the file.

Connections

On the Connections tab, you can choose to edit, rename or remove an existing connection, or create a new connection. Connection settings are specific to your environment.

To define these settings:

  1. Click on the Connections Tab.
  2. Select Connection_SSLED in the Name pull-down menu. Note: The Type pull-down menu will show SSLED. Each connection must have a connection type defined.
  3. Enter the port number in the VALUE cell of the portNumber field.
  4. Enter the server name (IP address) in the VALUE cell of the serverList field.
  5. If the DACS username is different from the Windows login name, enter the user name in the VALUE cell of the userName field. Otherwise a user name is not required.
  6. Click Save.

Some connection types have their own logging mechanism. Logging can affect performance, so use these settings for debugging only.

To turn on logging for an SSLED connection:

  1. Select the Connections tab.
  2. Select Connection_SSLED in the Name pull-down menu.
  3. Enter True in the VALUE cell of the logEnabled field.
  4. Enter the path to the log file in the VALUE cell of the logFileName field, e.g. “%TEMP%\ssled.log”
  5. Enter the maximum size for the log file in the VALUE cell of the logFileSize field, e.g. 10000.
  6. Click Save.

To turn logging off:

  1. Select the Connections tab.
  2. Select Connection_SSLED in the Name pull-down menu.
  3. Enter False in the VALUE cell of the logEnabled field.
  4. Click Save.

Adapters

An adapter is an RFA library and configuration context that corresponds to a connection type. As such, there is a fixed list of adapters, one for each connection type. Each adapter type has its own settings with their corresponding default values. Use the Adapters tab to specify settings that are different from the default.

For example, in the RTW sample configuration the setting for downloading the data dictionary (downloadDataDict) has been turned off.

To edit additional settings:

  1. Select the Adapters Tab.
  2. Select SSLED_Adapter in the Name pull-down menu
  3. Edit values as necessary.
  4. Click Save Adapter.
When downloadDataDict is set to false, a local data dictionary needs to exist. The default location is C:\var\triarch. If no local data dictionary is found, create one in the default location:
  1. Create a directory under C:\ called var.
  2. Create a subdirectory under var called triarch.
  3. Browse to C:\Program Files\Vistasource\RTW\4.3\ and copy the files appendix_a and enumtype.def.
  4. Paste the files into C:\var\triarch.

Services

Services refer to the various services provided by your RMDS system. By default, there is no need to set this component because services are obtained dynamically. However, RTW will use the services listed here in dialog boxes where a service entry is required.

In addition, the infrastructureType field of the Service component may be required to specify sector guessing when subscribing with 2-part subject names in a SASS3 connection (for example, FOO.O may need to expand to SH.REC.FOO.O, in which case the infrastructure type would be set to TIC).The sample configuration files have several default services defined: DTS, IDN_RDF, IDN, SH.

To add additional services:

  1. Select the Services Tab
  2. Type the new service name in the Service entry box.
  3. Click Save.

To rename a service:

  1. Click on the Services Tab.
  2. Select a service name in the Name pull-down menu.
  3. Click Rename.
  4. Type the new name in the RTW RFA Rename dialog and click OK.

To remove a service:

  1. Click on the Services Tab.
  2. Select a service name in the Name pull-down menu.
  3. Click Remove.
As noted above, when using flat files the Save, Rename and Remove buttons only make changes in memory. Click Save to File to actually write the changes to the file.

Data Dictionaries

The Data Dictionaries tab is used for specifying data dictionary types. The data dictionary name is used in the Services component option “DataDictList”, and the type is used by the RTW RMDS (RFA) engine to determine which data dictionary to request. In this way, the engine knows which data dictionary type to request for each service.

To view and edit these settings, select the Data Dictionaries Tab.

Control

The Control tab is used for Entitlements and Message Pool configuration. For SSLED connections, it is recommended by Reuters to enable Entitlements at the P2PS level and to set these 3 settings to False:

dacs_CbeEnabled

dacs_SbeEnabled

dacs_enabled

To view and edit these settings, select the Control Tab and click on the Entitlements toggle button.

Logger

The Logger tab is used to specify general RFA and component logging. These settings should only be used for debugging purposes:

windowsLoggerEnabled

fileLoggerEnabled

Publish/Contribute Setup

Depending on the connection type, the RTW RMDS (RFA) engine can either publish or contribute. With the SSLED connection type, only contribute is supported. With the SASS3 connection type, both publish and contribute are supported, but not within the same session.

When using a session with a SASS3 connection type, the RTW RMDS (RFA) engine will decide whether to publish or contribute based on whether the connection has contributorRV or publisherRV set. If both contributorRV and publisherRV are set, then the publish setting will override the contribute setting.

When publishing market data (as opposed to contributing) the record name must be a four-part subject name.

For more information about how to use publishing, see Working with RTW RMDS (RFA).

The following settings for publishing are taken from the Windows Registry and default Text File sample files:

Sample Windows Registry Settings

[HKEY_LOCAL_MACHINE\SOFTWARE\Reuters\RFA\Default\Connections\Connection_RTIC_CONTRIB]
"connectionType"="SASS3"
"subscriberRV_Connection"="Connection_RV5"
"contributorRV_Connection"="Connection_RV5"

[HKEY_LOCAL_MACHINE\SOFTWARE\Reuters\RFA\Default\Connections\Connection_RTIC_PUB]
"ConnectionType"="SASS3"
"PublisherRV_Connection"="Connection_RV5"
"SubscriberRV_Connection"="Connection_RV5"

[HKEY_LOCAL_MACHINE\SOFTWARE\Reuters\RFA\Default\Sessions\SASS3ContribSession]
"connectionList"="Connection_RTIC_CONTRIB"

[HKEY_LOCAL_MACHINE\SOFTWARE\Reuters\RFA\Default\Sessions\SASS3PubSession]
"ConnectionList"="Connection_RTIC_PUB"

Sample Text File Settings:

\Connections\Connection_RTIC_CONTRIB\connectionType = "SASS3"
\Connections\Connection_RTIC_CONTRIB\subscriberRV_Connection = "Connection_RV5"
\Connections\Connection_RTIC_CONTRIB\contributorRV_Connection = "Connection_RV5"

\Connections\Connection_RTIC_PUB\connectionType = "SASS3"
\Connections\Connection_RTIC_PUB\subscriberRV_Connection = "Connection_RV5"
\Connections\Connection_RTIC_PUB\publisherRV_Connection = "Connection_RV5"

\Sessions\SASS3ContribSession\connectionList = "Connection_RTIC_CONTRIB"

\Sessions\SASS3PubSession\connectionList = "Connection_RTIC_PUB"

Configuration Examples

The following sections show different configuration examples using the RFA example flat file (RFA-Example.cfg) and the RFA example registry file (RFA-Example.reg).

SSLED (sinkdist or P2PS) Configuration

  1. Choose whether you want to use the Windows Registry or a flat file. If you are using a flat file, skip to step 2. Otherwise, initialize the Registry with the provided sample file:
    1. Browse to C:\Program Files\Vistasource\RTW\4.3
    2. Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry.
  2. Launch the RTW RMDS (RFA) Configuration Editor.
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor.
    2. Select the RMDS (RFA) tab.
    3. If you are using a flat file, check the “Use this File Rather than the Registry” box and browse to the C:\Program\Files\Vistasource\RTW\4.3\RFA-example.cfg file. If you are using the Registry make sure the box is unselected.
    4. Ensure that the default Session is RTWSession (an SSLED type session) by choosing it in the Default Session pull-down menu
    5. Click on the Advanced button to launch the RTW RMDS (RFA) configuration editor.
  3. View the already-defined SSLED connection, which contains some minimally-required settings. To view this connection:
    1. Click on the Connections Tab.
    2. Select Connection_SSLED in the Name option box.
    3. Note that the Connection Type is set to SSLED, and that the following fields are filled out: PortNumber, ServerList, username.
      Note: A username is only required if the DACS username is different from the Windows login name. Delete this entry if it does not need to be set.
      If necessary, logging options for this connection can be defined here. Logging can affect performance, so use these settings for debugging only. The options are: logEnabled (True/False), logFileName (e.g. “%TEMP%\ssled.log”), logFileSize (e.g. 100000).
  4. Define any adapter settings. Adapter settings are only required if you wish to specify settings different from the default. In the sample configurations, downloading of the Data Dictionary has been turned off. To edit additional settings:
    1. Select the Adapter Tab.
    2. Select SSLED_Adapter in the Name pull-down menu.
    3. Make edits.
    4. Click Save Adapter.
    5. When using flat files, also click Save to File.
      Note: When downloadDataDict is set to false, a local data dictionary is required. The default location is C:\var\triarch. If no local data dictionary is found:
      1. Create the directory C:\var\triarch.
      2. Browse to C:\Program Files\Vistasource\RTW\4.3\ and copy the files appendix_a and enumtype.def.
      3. Paste the files into C:\var\triarch
  5. The sample configurations define several default services: DTS, IDN_RDF, IDN, SH. To add additional services:
    1. Select the Services tab.
    2. Type the Service name into the Name option box
    3. Click Save.
    4. When using flat files, also click Save to File.
      Note: Services are obtained dynamically, but service names are required for the User Interface Dialogs. </note>

SASS3/RV (RTIC and TIC) Configuration

  1. Choose whether you want to use the Windows Registry or a flat file. If you are using a flat file, skip to step 2. Otherwise, initialize the Registry with the provided sample file:
    1. Browse to C:\Program Files\Vistasource\RTW\4.3
    2. Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry.
  2. Launch the RTW RMDS (RFA) Configuration Editor.
    1. In Excel, select Vistasource → Settings → Rtconfig Editor to launch the rtconfig editor.
    2. Select the RMDS (RFA) tab.
    3. If you are using a flat file, check the “Use this File Rather than the Registry” box and browse to the C:\Program Files\Vistasource\RTW\4.3\RFA-example.cfg file. If you are using the Registry, make sure the box is unselected.
    4. Ensure that the default Session is SASS3Session by choosing it in the Default Session pull-down menu.
    5. Click on the Advanced button to launch the RTW RMDS RFA Configuration editor.
  3. View the already-defined SASS3 connection, which has fields specifying an RV connection. To view this connection:
    1. Click on the Connections Tab.
    2. Select Connection_RTIC in the Name option box.
    3. Note the subscriberRV_Connection, publisherRV_Connection and contributorRV_Connection fields, which point to an RV connection
  4. Edit the already-defined RV connection, Connection_RV5. The RV connection needs to specify the values that reflect your environment (see Quick Setup above for more information on these values).
    1. To change the values for Connection_RV5, select Connection_RV5 in the Name option box.
    2. Enter the appropriate values for the daemon, service and network fields.
    3. Click Save.
    4. When using flat files, also click Save to File.
  5. Define any adapter settings. Adapter settings are only required if you wish to specify settings different from the default. Downloading of the Data Dictionary has been turned off in the RFA-example.reg. To edit additional settings:
    1. Select the Adapter Tab.
    2. Select SASS3_Adapter in the Name pull-down menu.
    3. Make edits.
    4. Click Save Adapter.
    5. When using flat files, also click Save to File.
      Note: When downloadDataDict is set to false, a local data dictionary is required. The default location is C:\var\triarch. If no local data dictionary is found:
      1. Create a directory under C:\ called var.
      2. Create a subdirectory under var called triarch.
      3. Browse to C:\Program Files\Vistasource\RTW\4.3\ and copy the files appendix_a and enumtype.def.
      4. Paste the files into C:\var\triarch
  6. The sample registry file has several default services defined: DTS, IDN_RDF, IDN, SH. To add additional services:
    1. Select the Services tab.
    2. Type the Service name into the Name option box
    3. Click Save.
    4. When using flat files, also click Save to File.
      Note: Services are obtained dynamically, but service names are required for the User Interface Dialogs</note>

Generic Configuration Options

In addition to the engine-specific RTW RMDS (RFA) 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
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 are 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.

Manually Editing the rtconfig File

The RTW and RTW engine configuration options are saved in the rtconfig file located in the installation directory. The RTW rtconfig Editor edits this file. Alternatively, the rtconfig file can be manually edited using any text editor such as Notepad or Wordpad.

The options in the rtconfig file can appear in any order; however, the configuration options are grouped into logical sections for ease of use. Each option is commented in detail in the file, explaining the different settings and their actions. For editing RTW and RTW RMDS (RFA) engine options, look for the following sections:

  • Generic RT Engine settings
  • RTW settings
  • vsRMDS2 RT Engine Settings (RMDS RFA)

The other sections in the rtconfig file are not relevant to your installation as they apply to other Vistasource RTW engines. Any line beginning with a pound symbol (#) is interpreted as a comment line. Active options must not be preceded by this symbol. In most cases, editing a configuration option requires modifying pre-defined 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.

Migration

If a configured installation of Thomson Reuters PowerPlus Pro or another RFA client exists on your computer and you wish to migrate to RTW, simply use the existing RFA configuration file for RTW. For example, to migrate from PowerPlus Pro:

  1. Make a copy of the existing RFA configuration file, usually C:\Program Files\Reuters\Common\Config\RFA.RFA-configuration-file.
  2. In Microsoft Excel, select Vistasource → Settings → Rtconfig Editor.
  3. Select the RMDS (RFA) tab.
  4. Select Use this File Rather than the Registry.
  5. Specify the path to your copy of the RFA configuration file (from step 1).
  6. Set the RTW default session to the session you want to use from the RFA configuration file. This is typically called “XtraSession” and can be selected from the “Default Session” list.
  7. Click Save to File.

At this point, your configuration may be ready to use. There are some cases, however, where further edits may be needed.

  1. If there are references to RFA libraries in the RFA configuration file, they may need to be updated to version 7, the RFA version used by RTW 4.3. These are typically specified in the Logger component, under
    AppLogger\defaultMessageFile

    and

    ComponentLoggers\<component name>\messageFile

    Base names (.e.g. RFA6_Adapter) must have the correct RFA prefix (e.g. RFA7_Adapter). Full names (e.g. RFA6_Adapter71.dll) must have both the correct RFA prefix and suffix (e.g. RFA7_Adapter80.dll).

  2. Some PowerPlus Pro-specific settings may need to be converted to the equivalent RTW-specific settings. PowerPlus Pro-specific settings are typically found in the Xtra component. One example of a setting that needs to be converted is the ‘dataFormat’ field. In PPP, it may look like this:
    \Xtra\Services\<service name>\Publication\dataFormat = “Marketfeed”

    In RTW, it must be converted to the following:

    \Services\<service name>\dataFormat = “Marketfeed”

    The above edits can be made either manually or by using the RTW RFA configuration editor. See “RTW RFA Configuration Editor” for more detail.

  3. Verify your PowerPlus Pro configuration file, it may link to other configuration files, in which case you should also copy these files and modify the paths in the configuration file before removing PowerPlus Pro.

If your configuration is not working or additional assistance with migration is needed, please contact support@vistasource.com.

Working with RTW RMDS (RFA)

This chapter provides information about working with the RTW RMDS (RFA) engine. It covers the following topics:

The RTW RMDS (RFA) engine introduces the concept of sessions. Sessions are a way to specify the various types of RMDS connections you may have. Where appropriate, the RMDS (RFA) dialogs will contain a Session field. If the session field is left empty (default), then the default session will be used as specified in the RTW configuration file called rtconfig. If no default session is specified in the rtconfig file, then 'RTWSession' is considered the default session. See Configuration for more information about editing the RMDS (RFA) configuration options.

To subscribe and publish data in Microsoft Excel, RTW provides a COM Server (rts.exe) that works in conjunction with Microsoft Excel’s RTD function (available only in Excel 2002 and higher; see the Microsoft Excel Help for more information on RTD and COM automation). The RTW COM Server can also be used with custom stand-alone applications. For more information about the RTW COM Server and the RTW COM Interface, see the Vistasource RTW COM Interface Guide.

Subscribe

RTW offers three menu options that facilitate building an RTD formula for subscribing to data. These options are:

  • Quote Wizard – Steps through the process of building an RTD formula
  • Quote Table – Creates a table of RTD formulas referencing record and field names in a spreadsheet
  • Quick Quote – Provides an easy way to automatically build a RTD formula

For more details regarding these options, see sections Quote Wizard, Quick Quote and Quote Table below.

The generic syntax for Microsoft Excel RTD is as follows:

=RTD(ProgID, server, topic1, [topic2], …) 

When using RTW to subscribe to data, the RTD function uses the following arguments:

=RTD(ProgId, server, command, engine, servicename, recordname, fieldname1, […, fieldnameN]) 

The arguments have the following meaning:

ProgID The name of the RTW RTD Server: Vistasource.RtdServer
Server This argument remains null.
Command “rt”, to indicate the subscribe command
Engine vsRMDS2
Servicename The name of the service to which you are subscribing.
Recordname The name of the record to subscribe to.
Fieldname1,… The name of the first field, such as BID or ASK.
FieldnameN The name of the last field.

Example of an RTD function for subscribing

The following formula subscribes to the Micro-soft ASK price via the RTW RMDS (RFA) engine with the IDN service:

=RTD("Vistasource.RtdServer",,"rt","vsRMDS2","IDN","MSFT.O", "ASK")

Example of an RTD function for subscribing to multiple fields

To retrieve multiple field values with one formula, the RTD function would need to return an array of data. However, RTD does not support this functionality (see Microsoft KB article 286258). To work around this limitation, the RTW wrapper function PARSE_DATA can be used. This function “parses” the string array of incoming data. The Quote dialogs will automatically use the PARSE_DATA function when creating array formulas. See section RTW Functions for more information about PARSE_DATA and other wrapper functions.

The following formula subscribes to the Microsoft ASK and BID prices in real-time via the RTW RMDS (RFA) engine with the IDN service:

=PARSE_DATA(RTD("vistasource.rtdserver",,"rt","vsRMDS2","IDN","MSFT.O","ASK","BID"))

Quote Wizard

The Quote Wizard steps through the process of building an RTD formula and subscribing to data provided by the data distribution system.

Select Vistasource → RMDS (RFA) → Quote Wizard to start the Quote Wizard.

The Quote Wizard consists of a total of five screens. Each screen details the steps of building a formula, displaying the status of the formula as you build it.

By choosing multiple record and field names, the Quote Wizard also allows you to create, format, and determine the layout of a “quote table.”

Quick Quote

This option provides an easy way to automatically build an RTD formula which subscribes to fields of a single record.

Select Vistasource → RMDS (RFA) → Quick Quote to create a subscribe quote. The Quick Quote dialog box provides an easy way to automatically build a RTD formula which subscribes to fields of a single record.

The RTW RMDS (RFA) Quick Quote dialog box contains the following options:

Cell Range Enter a start or cell range for the formula’s output. To select a cell directly in the worksheet without having to type its reference, click on the icon next to the entry field.
Orientation The orientation must be horizontal.
Build As Array Formula A single RTD array formula can be created which returns values for all the fields of the record. Each record will have its own RTD formula. Turn this option off to create individual formulas for each field. Note: If Build as Array Formula is selected, the wrapper function PARSE_DATA is used. To edit an array formula, select the entire output range, place the cursor in the edit line, edit, and then press Ctrl-Shift-Return. If an attempt is made to edit a single cell in the range, a message box displays indicating that the cell cannot be edited, because it is the output of an array formula. For more information on PARSE_DATA, see section RTW Functions.
Engine The engine name is vsRMDS2.
Service/Record Type Select the service/record type, e.g. IDN.
Session When not using the default session, select a session name from the list. See Configuration for more information about Sessions.
Record Enter the record name. Clicking on the control on the right displays a history list with your previous choices. The list is stored in a file called [Engine name]_history.txt, located in the user’s Application Data directory, %USERPROFILE%\Application Data\Vistasource\RTW, (or C:\ if the application directory does not exist).
Fields to Retrieve Enter the names of the fields you want to subscribe to, then press RETURN or click the Add Field button after each field name to add the field to the list box.
Remove Selected Field To remove fields, select a field and then click on the option button.
Up and Down Arrows To rearrange the order of the fields, click on the field name and move it with the arrows.
Field List The RTW RMDS (RFA) Field List dialog box displays all valid fields for the specified record. Select the required field from the Available Fields list box and click Add. The field name is added to the Selected Fields list box. To remove a field name, select the field and click Remove. Once the required fields are selected, click OK to return to the RTW RMDS (RFA) Quick Quote dialog box.
Add to Favorites To add frequently used records to a list of favorites, select a record and click the option button. To check which records have been added in previous and current sessions, click View Favorites to access the RTW RMDS (RFA) Records - Favorites List.

Click OK to insert the formula in your workbook.

Quote Table

This option allows you to create a table of RTD formulas which reference record and field names in a spreadsheet.

Organize your spreadsheet with record names in a column and field names in an adjacent row. Select Vistasource → RMDS (RFA) → Quote Table to display the RTW RMDS (RFA) Quote Table dialog box.

The RTW RMDS (RFA) Quote Table dialog box contains the following options:

Cell Range Enter the cell range for your table. Cells can be selected directly in the worksheet without having to type their reference by clicking on the icon next to the entry field. The desired range can also be selected before launching the dialog box.
Build As Array Formula A single RTD array formula can be created which returns values for all the fields of the record. Each record will have its own RTD formula. Turn this option off to create individual formulas for each field. Note: If Build as Array Formula is selected, the wrap-per function PARSE_DATA is used. To edit an array formula, select the entire output range, place the cursor in the edit line, edit, and then press Ctrl-Shift-Return. If an attempt is made to edit a single cell in the range, a message box displays indicating that the cell cannot be edited, because it is the output of an array formula. For more information on PARSE_DATA, see section RTW Functions further down.
Engine The engine name is vsRMDS2.
Service/Record Type Select the service/record type, e.g. IDN.
Session When not using the default session, select a session name from the list. See Configuration for more information about Sessions.
Record Name Location The record names can only reside in a column.
Use Cell Addresses for Rows/Columns Check this option to use the cell references in the formula instead of the record and field names. This option is turned on by default, and ensures that the formula stays valid if the record or field names are changed. If this option is turned off, the actual record and field names will become part of the formula.

Click OK to insert the RTD formulas in your workbook.

Chain

The RTW RMDS (RFA) Chain dialog box allows you to subscribe to groups of records of related data. Records linked within the chain are placed in consecutive cells with RTD formulas. By specifying a chain record root, the name of each record in the chain is returned. For a list of valid chains, please refer to the appropriate Reuters Services guide.

To construct a chain of data select Vistasource → RMDS (RFA) → Chain to display the RTW RMDS (RFA) Chain dialog box.

The RTW RMDS (RFA) Chain dialog box contains the following options:

Record Root Enter the name of the record root, e.g. .FTSE, .DJI (both indexes) or .AV.O (active volume list). When using a SASS3 connection, the service name and the sector “LINK” must be specified (e.g. RSF.LINK.^AV.O).
Chain Identifier Enter the type of chain you are building, e.g. Futures, Equity Option, Money 2000. If you know the exact Record Root, you may also specify ‘None.’
Cell Range Enter a start cell or a cell range for your formula’s output. You can select cells directly in the worksheet without having to type their reference by clicking on the icon next to the entry field. In many cases you just need to enter a start cell.
Build As Array Formula By default, an individual RTD formula will be created for each chain record. Turn this option on to create a single RTD array formula which returns values for all the records in the chain.
Note: If Build as Array Formula is selected, the wrapper function PARSE_DATA is used. To edit an array formula, select the entire output range, place the cursor in the edit line, edit, and then press Ctrl-Shift-Return. If an attempt is made to edit a single cell in the range, a message box displays indicating that the cell cannot be edited, because it is the output of an array formula. For more information on PARSE_DATA, see RTW Functions
Engine The engine name is vsRMDS2.
Service Select the service, e.g. IDN, RSF.
Session When not using the default session, select a session name from the list. See Configuration for more information about Sessions.
Chain Direction The chain can only reside in Columns.
Use Cell Addresses for Rows/Columns This option ensures that the chain setup stays valid if you change the record or field names.
Messages As the chain is being built, any messages or errors will display in this area.

Click OK to initiate the construction of the chain.

Publish

Vistasource RTW offers the ability to publish and contribute market data using the RTW RMDS (RFA) engine.

While the terms “publish” and “contribute” are not synonymous (see section Publish/Contribute Setup in Configuration for more information), the term “publish” is used in this document for both concepts (unless otherwise specified).

The Microsoft Excel RTD function is used to publish data. The RTD publish formula will execute when there is any change to the data that it references. If the publish is successful, the cell containing the RTD formula displays OK. If it is unsuccessful, the cell containing the RTD formula displays #VALUE.

The generic syntax for the Microsoft Excel RTD function is as follows:

=RTD(ProgID, server, topic1, [topic2], ...)  - etc…….

When using RTW to publish, the RTD function takes the following arguments:

=RTD(ProgId, server, command, dataRange, engine, servicename, recordname, fieldname1, […, fieldnameN]) 

The arguments have the following meaning:

ProgIDThe name of the RTW RTD Server: Vistasource.RtdServer
ServerRemains null.
Command”rtinsert”, to indicate the publish command.
Data RangeThe cell or cell range containing the value(s) to publish
EngineThe engine name is vsRMDS2.
ServicenameThe name of the data feed/service.
RecordnameThe name of the record to publish.
Fieldname1,…The name of the first field, such as BID or ASK.
FieldnameNThe name of the last field.

RTW offers a publish dialog that facilitates building an RTD publishing formula.

Select Vistasource → RMDS (RFA) → Publish to display the RTW RMDS (RFA) Publish dialog box.

The RTW RMDS (RFA) Publish dialog box contains the following fields:

Cell RangeEnter a start cell for the formula’s output (by default the current cell is selected). To select a cell directly in the worksheet without having to type its reference, click on the icon next to the entry field.
Data RangeEnter the cell reference or range of the data that you want to publish. You can select cells directly in the worksheet without having to type their reference by clicking on the icon next to the entry field.
EngineThe engine name is vsRMDS2.
ServiceSelect the service, e.g. RSF, IDN.
SessionWhen not using the default session, select a session name from the list.
Record NameEnter the record name to which you want to publish, e.g. SH.ANY.MYREC.NaE
Note: When publishing market data (as opposed to contributing) the record name must be a four-part subject name.
Fields to PublishEnter the names of the fields you want to publish. Press RETURN or click the Add Field button after each field name to add the field to the list box.
Remove Selected FieldRemove fields by selecting a field and then clicking on the option button.
Up and Down Arrows (Icons)Rearrange the order of the fields by clicking on one and moving it with the arrows.
Field ListThe RTW RMDS (RFA) Field List dialog box displays all valid fields for the specified record. Select the desired field from the Available Fields list box and click Add. The field name is added to the Selected Fields list box. To remove a field name, select the field and click Remove. After selecting all the fields you want to subscribe, click OK to return the list of fields to the RTW RMDS (RFA) Publish dialog box.
Add to FavoritesAdd frequently used records to a list of favorites by selecting a record and clicking on the Add Favorites button. To check what records have been added in past and current sessions, click View Favorites to access the RTW RMDS (RFA) Records - Favorites List. See Favorites for more information on adding, deleting and updating this list.

Click OK in the RTW RMDS (RFA) Publish dialog box to insert the publish formula in your workbook.

Example of an RTD function for contributing with a two-part subject name

The following formula contributes the value in cell C15 as the BID of MyRec.O via the RTW RMDS (RFA) engine to the DTS service.

=RTD("Vistasource.RtdServer",,"rtinsert",C15,"vsRMDS2","DTS","MyRec.O"," BID")

Example of an RTD function for publishing with a four-part subject name

The following formula publishes the value in cell C15 as the BID of SH.ANY.MyRec.NaE via the RTW RMDS (RFA) engine to the SH service.

=RTD("Vistasource.RtdServer",,"rtinsert",C15,"vsRMDS2","SH","SH.ANY.MyRec.NaE"," BID")

Example of an RTD function for publishing multiple fields

To publish multiple field values with one formula, the RTD function would need to receive an array of data. However, RTD does not support this functionality (see Microsoft KB article 286258). To work around this limitation, the RTW wrapper function PACKAGE_DATA can be used. This function “packages” the range of values to publish as a string. The Publish dialogs will automatically use the PACKAGE_DATA function when publishing a range of fields. See RTW Functions for more information about PACKAGE_DATA and other wrapper functions.

The following formula publishes the values in cells D3 and D4 to the fields BID and ASK in record SH.ANY.MyRec.NaE via the RTW RMDS (RFA) engine using the PACKAGE_DATA function:

=RTD("vistasource.rtdserver",,"rtinsert",PACKAGE_DATA(D3:D4),"vsRMDS2","DTS"," SH.ANY.MyRec.NaE","BID","ASK")

where DTS (Data Transformation System) is the name of the service to which you are publishing.

The PACKAGE_DATA function can also be used to package a range of field names. For example,:

=RTD("vistasource.rtdserver",,"rtinsert",PACKAGE_DATA(D3:D4),"vsRMDS2","DTS","SH.ANY.MyRec.NaE",PACKAGE_DATA(C3:C4)) 

in which case BID would be in C3 and ASK would be in C4, and DTS (Data Transformation System) is the name of the service to which you are publishing.

RTW Functions

RTW specific functions are added to Microsoft Excel upon installation. They can be accessed by selecting Formulas → Insert Functions → Select a Category → Vistasource RTW.

In versions prior to Microsoft Excel 2007, select Insert → Function in the menu bar to display the “Insert Function” dialog box. Select the Vistasource RTW category to display the RTW functions.

Wrapper Functions

The following functions call the RTD function with the required default arguments, plus the given arguments. In this way, redundant arguments are hidden, exposing only the data that is important to you.

FUNCTIONRTS
ARGUMENTS Engine, service, record, field1, field2, … fieldN
EXAMPLE
=RTS("vsRMDS2","IDN", "MSFT.O", "ASK")
DESCRIPTION Subscribe to data using the specified engine
NOTES Engine,Service,Record,Field1 are obligatory. The maximum number of fields is 51 (24 for Excel versions prior to 2007).
FUNCTION RTS_RFA
ARGUMENTS Service, record, field1, field2, … fieldN
EXAMPLE
=RTS_RFA("IDN", "MSFT.O", "ASK")
DESCRIPTION Subscribe to data using the RTW RMDS (RFA) engine
NOTES Service,Record,Field1 are obligatory. The maximum number of fields is 51 (24 for Excel versions prior to 2007).
FUNCTIONRTINSERT
ARGUMENTSValue(s), engine, service, record, field1, field2, … fieldN
EXAMPLE
=RTINSERT(C15,"vsRMDS2","DTS", "MYREC", "BID")
DESCRIPTIONPublish data using the specified engine
NOTESThe maximum number of fields is 51 (23 for Excel versions prior to 2007).
FUNCTIONRTINSERT_RFA
ARGUMENTSValue(s), service, record, field1, field2, … fieldN
EXAMPLE
=RTINSERT_RFA (C15, "DTS", "MYREC", "BID")
DESCRIPTION
NOTESThe maximum number of fields is 51 (23 for Excel versions prior to 2007).

PARSE_DATA and PACKAGE_DATA

The functions PARSE_DATA and PACKAGE_DATA facilitate some of the limitations of RTD when subscribing and publishing multiple fields in the same RTD formula (see Microsoft KB article 286258)

FUNCTIONPARSE_DATA
ARGUMENTAn Excel-style string
EXAMPLE
{=PARSE_DATA(RTS_RFA("IDN","MSFT.O", "BID", "ASK"))}
DESCRIPTIONEvaluates an Excel-style string
NOTES

To edit an array formula, select the entire output range, place the cursor in the edit line, edit, and then press Ctrl-Shift-Return. If an attempt is made to edit a single cell in the range, a message box displays indicating the cell cannot be edited because it is the output of an array formula.

FUNCTIONPACKAGE_DATA
ARGUMENTCell range
EXAMPLE
=RTINSERT_RFA(PACKAGE_DATA(D3:D4), "DTS","MYREC","BID","ASK")
DESCRIPTIONConverts a range of values to an Excel-style string

Favorites

The RTW RMDS (RFA) Records – Favorites List dialog box allows you to manage your favorites list.

This list displays previously added selections of records and fields. To delete a selection, mark the item and click Delete.

To modify an item, click Modify List to access the RTW RMDS (RFA) Favorites List dialog box.

Modify Favorites

The RTW RMDS (RFA) Favorites List dialog box allows you to add, delete, and update your list of favorite records or pages. To access this list, click View Favorites in the Quick Quote or Publish dialog boxes, or select the dialog box launcher in the Vistasource → RMDS (RFA) group.

The RTW RMDS (RFA) Favorites List dialog box contains the following fields:

Favorites List Displays all the records you have previously added. Add or delete records in this list or update them by modifying the associated fields:

  • To add a record, enter the name of the record, select the fields via the entry fields on the right, and click Add.
  • To delete a record, select the record and click Delete.
  • To update a record, select the record in the Favorites List. All relevant entry fields will automatically fill in. Make your modifications and click Update.
Record Enter a name for the record you want to add or choose from the list of favorites to update.
Fields to Retrieve Enter the names of the fields you want to retrieve. Click on the icon next to the entry field to display the list of available fields. Press RETURN or click the Add Field button after each field name to add the field to the list box. To remove a field, select it and click Remove Selected Field.
Up and Down Arrows Rearrange the order of the fields by clicking on one and moving it with the arrows.
Field ListThe RTW RMDS (RFA) Field List dialog box displays all valid fields for the specified record. Select the field you are interested in from the Available Fields list box and click Add. The field name is added to the Selected Fields list box. To remove a field name, select the field and click Remove. After all fields have been created or deleted, click OK to return to the list of fields in the RTW RMDS (RFA) Favorites List dialog box.

Status Messages

The RTW status window displays information such as the version numbers for RTW and its engines, network status messages, status messages from the data distribution system, as well as other relevant status messages. Any invalid field or record names encountered by the service will also cause a message to be posted to the status window. If you are not receiving the expected real-time data in Microsoft Excel, check the status window for relevant messages.

Cell Status Messages

When information about a real-time value is not available, the cell displays #N/A. When an Excel spreadsheet file containing RTD formulas is opened, all real-time values display as #N/A until the data distribution system delivers the initial value and the cells are updated.

Similarly, when editing, copying or cutting/pasting a real-time formula, the cell displays #N/A until the value of the cell changes and the cell is updated. A cell which references a cell with a #N/A status message also displays #N/A.

If a cell displays #VALUE!, the formula is incorrect. For instance, if an invalid field name is entered, the cell displays #VALUE! and the status window displays information from the data distribution system about the incorrect field name. A cell also displays #VALUE! if it references another cell which contains #VALUE! or #N/A or no data.

Show/Hide Status Window

You can show or hide the RTW Status Window by selecting Vistasource → Info → Show/Hide Status Window.

By default, the status window first appears when a real-time RTW request is made. Real-time requests are made with the “rt” and “rtinsert” commands in the RTD function or in the RTW COM server.

The status window will automatically close when no engines are running. An engine will shutdown if it is not handling any more real-time requests.

The debug level and display rules for the RTW Status Window can be changed in the Status Window section of the Generic tab of the Rtconfig Editor. See section Generic Configuration Options in Configuration for detailed information about the different methods of editing the RTW configuration options.

Interface Preferences

The Interface Preferences are used to customize the behavior of the RTW user interface as well as setting default values for the RTW RMDS (RFA) engine dialog boxes.

Select Vistasource → Settings → Interface Preferences to display the RTW Preferences dialog box.

This dialog box contains a generic preference and a RMDS (RFA) tab. On these tabs, defaults can be selected for the user interface dialogs such as Quick Quote.

The preferences are stored in a file which Microsoft Excel reads during startup. The preferences file is called %USERPROFILE%\Application Data\Vistasource\RTW\preferences and can be read in any text editor, such as Notepad or Wordpad.

Generic Tab - Interface Preferences

On the Generic tab, you can select the options Build Formulas as Arrays and Don’t show splash screen on startup.

Build Formulas as Arrays

When this option is on, all Quote dialog boxes will create array formulas by default.

The wrapper function PARSE_DATA is used to work around RTD’s array formula limitation. See RTW Functions for more information.

Don't show splash screen on startup

Turn this option on to suppress the Vistasource RTW splash screen when you launch Microsoft Excel. The option is off by default.

RMDS (RFA) Tab – Interface Preferences

The RMDS (RFA) tab contains the option Default Service.

Default Service

Set the default subscribe and publish services for the RTW RMDS (RFA) engine. The selected subscribe service will automatically be the default service in the Quote dialog boxes. The selected publish service will automatically be the default service in the Publish dialog box.

Stop/Restart Engines

Select Vistasource → Stop/Restart Engines to close the connection to the data distribution system without exiting your spreadsheet. If you choose to stop an engine while the spreadsheet contains active real-time cells, the engine will restart automatically. You can choose to stop and restart a specific engine or all real-time engines.

Pause/Resume Data

Select the RTW Pause Data button to pause the flow of real-time data. You cannot manually update real-time values in this mode. This option lets you work in your spreadsheet without interruption from data updates. When Pause Data is selected, the menu option Refresh Data Now, which initiates a manual update, is not available and the Updates submenu is disabled (grayed out).

Select the RTW Resume Data button to resume the flow of real-time data.

The location of the Pause Data and Resume Data buttons depends on your version of Microsoft Excel. In Microsoft Excel 2007 they are located on the left side of the Vistasource tab of the Excel Ribbon. In versions prior to Microsoft Excel 2007, the buttons are located on a separate command bar under the menu bar.

Updates

Select Vistasource → Updates to display the various update options which let you alter the flow of real-time data without closing the engine. You can pause and resume your data flow, and set the update rate according to your needs. You can choose to have the data updated as it changes, manually update your data, or select various intervals including custom intervals for automatic updates. Internally, this sets the Excel application option RTD.ThrottleInterval.

Manual Updates Only

Select Vistasource → Updates → Manual Updates Only to suspend automatic updates of data. Any cells containing real-time formulas display the value that was current when you chose this option, but the values no longer continue to update automatically. If you want to restart automatic updates, choose one of the other update rate options such as As Data Changes.

By selecting Vistasource → Refresh Data Now you initiate a manual update of the real-time cells.

Refresh Data Now

Select Vistasource → Refresh Data Now to force a manual update when Vistasource → Updates → Manual Updates Only is selected, or when the Update Rate is 5 seconds or more. Otherwise, the option is unavailable (grayed out).

When data is paused by selecting Vistasource → Pause Data, the option Refresh Data Now is not available. Select Vistasource → Resume Data to resume the flow of real-time data once paused.

Rate

This option allows the setting of the rate in which data gets updated. It contains the following settings:

As Data Changes (Default Setting)

Select Vistasource → Updates → Rate → As Data Changes to have the engine update your data as the values change.

Update Rate (n Second Interval)

Select Vistasource → Updates → Rate → n Second Interval to update real-time values at preset intervals. n represents the number of seconds between updates. Available settings are 1, 5, 10, 30, 60 seconds.

Update Rate (Custom Interval)

Select Vistasource → Updates → Rate → Custom Interval to define a custom interval between updates. Custom intervals are measured in seconds.

Monitor Watch List

Select Vistasource → Info → Monitor Watch List to display the RTW Monitor Watch List dialog box. This dialog shows the records and fields you are currently subscribed to.

The RTW Monitor Watch List dialog box contains the following fields:

EngineThe engine is vsRMDS2.
ServiceSelect a service from the Service pull-down menu.
Number of Live RecordsThe number of live records is displayed.
Record NameThe list of records appears in the list box.
Field Name/Field IDThe list of the active fields and their field ID.

Select Close to return to the work sheet.

Items from the Watch List will automatically unsubscribe when you remove the RTD formula. To flush all records, select Vistasource → Stop/Restart Engines.

Record Info

Select Vistasource → Info → Record Info to view the current values of all valid fields (FIDs) for a given record (RIC) from any available DDS (Data Distribution Server) such as RMDS. In case several engines are installed, you can access all available engines from a single Record Information dialog box.

The RTW Record Information dialog box contains the following fields:

EngineThe engine is vsRMDS2.
ServiceSelect a service from the Service drop-down menu.
RecordType the name of the record (RIC) for which you want to retrieve values in the Record (RIC) entry field.
SessionWhen not using the default session, select a session name from the drop-down menu (see Configuration for more information on Sessions).
Get RecordThis button is available when engine, service and record have been specified. Click this button to get the record information.

Select Close to return to the work sheet.