Index
Copyright Notice
Release Notes
Licensing Howto
Software License
Technical Specifications
Contact Information
About RTW
System Requirements
Licensing
Rtconfig Editor
Interface Preferences
Subscribe
Quote Wizard
Quick Quote
Quote Table
Publish
RTW Functions
Status Window
Show/Hide Status Window
Status Messages
Cell Status Messages
Stop/Restart Engines
Pause/Resume Data
Refresh Data Now
Updates
Rate
Manual Updates Only
Update Rate (n Second Interval)
Update Rate (Custom Interval)
Monitor Watch List
Record Info
RTW RMDS (RFA) Engine
Subscribe (RMDS RFA)
Chain (RMDS RFA)
Publish (RMDS RFA)
Favorites (RMDS RFA)
Modify Favorites (RMDS RFA)
RTW RMDS (SFC) Engine
Subscribe (RMDS SFC)
Chain (RMDS SFC)
Publish (RMDS SFC)
Favorites (RMDS SFC)
Modify Favorites (RMDS SFC)
RTW Bloomberg Engine
Subscribe (Bloomberg)
Chain (Bloomberg)
PARSE_BULK Function
Favorites (Bloomberg)
Modify Favorites (Bloomberg)
RTW RMDS SFC GUIDE
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:
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 http://www.vistasource.com You can also subscribe to our newsletter from this site.
This manual provides information about the installation, setup and configuration as well as the functionalities of Vistasource RTW and the Vistasource RTW RMDS (SFC) engine.
Please consult the Release Notes for a list of new features, fixed and known issues. The Release Notes can be found in the installation directory or by clicking on the button Release Notes in the About Vistasource RTW dialog box.
The following typeface conventions and symbols are used throughout this manual:
The following typeface conventions and symbol are used throughout this manual:
Bold type | Indicates the name of fields, tabs, menus, commands, and buttons. |
→ | Indicates a sequence of actions, such as navigating to a menu option or clicking buttons in a window. |
Italics | Indicates path names for files or identifies placeholders inside square brackets such as [Engine name] |
Text in Courier | Represents text typed into a command window or a code example. |
This manual contains cross-references to chapters and sections that can be accessed with a single click on the referenced chapter and section titles.
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.
This section provides information about how to get started with RTW and the RTW RMDS SFC engine. It covers the following topics:
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 installation of RTW and the RTW RMDS (SFC) 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.
This section describes the installation of the product on Windows XP.
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.
To remove the product, run the Windows XP program removal utility.
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.
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.
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.
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 chapter provides information regarding the following topics:
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 |
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 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:
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:
To use both TIB and SSL infrastructures, additional connections can be specified. See section Connections below for more information.
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.
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.
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):
To edit the selected file, click on the Edit button.
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.
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).
*tibFactory.enableDynamicRTRecordServices: FALSE
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.
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 later in this chapter.
To create an SSL connection, in the Connections panel:
To create a TIB Connection, in the Connections panel:
To remove a previously saved connection, select the connection in the Name pull-down menu and click Remove Connection.
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.
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
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.
Choose the file to log to. The default is log.out:
*vsRMDS*logger*file: c:/temp/vsrmds.log
This section contains several examples for basic SFC setup.
*ipcRoute: triarch_sink p2ps_host
\HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG
registry entry.*enableEntitlements: FALSE
line. To use both SSL and TIB implementations, two connections need to be set up. This can be accomplished in two ways:
Example 1 – Using a Default Connection and then Additional Transport Connections
*ipcRoute: ipcService [hostname…]
*ipcRoute: triarch_sink p2ps_host
Example 2 - Using rmds_transport for all Connections
*ipcRoute: ipcService [hostname…]
*ipcRoute: triarch_sink p2ps_host
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.
Select Vistasource → Settings- > Rtconfig Editor to open the RTW rtconfig Editor dialog box.
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:
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.
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.
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.
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.
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.
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.
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.
In addition, the following functionalities are affected if this option is selected:
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.
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.
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.
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.
The following options apply to the rtconfig file options “rtexcel:SWOption” and “rtexcel:SWDir”.
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.
Logs engine start, warnings and errors. The log file rts.log will only be created if a log directory is specified.
Logs errors only. The log file rts.log will only be created if a log directory is specified.
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.
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.
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.
The status windows displays the first time a real-time request is made.
The status window is not displayed, except when Vistasource → Info → Show/Hide Status Window is selected.
The status window only displays when an error occurs.
The status window is promoted to the foreground when an error is encountered.
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 (SFC) engine options, look for the following sections:
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.
This chapter provides information about working with the RTW RMDS (SFC) engine. It covers the following topics:
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.
RTW offers three menu options that facilitate building an RTD formula for subscribing to data. These options are:
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 | vsRMDS (RMDS SFC) |
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 Microsoft ASK price via the RTW RMDS (SFC) engine with the IDN service:
=RTD("Vistasource.RtdServer",,"rt","vsRMDS","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 later in this chapter 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 (SFC) engine with the IDN service:
=PARSE_DATA(RTD("vistasource.rtdserver",,"rt","vsRMDS","IDN","MSFT.O","ASK","BID"))
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 (SFC) → 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.”
This option provides an easy way to automatically build an RTD formula which subscribes to fields of a single record.
Select Vistasource → RMDS (SFC) → 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 (SFC) 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 further down. |
Engine | The engine name is vsRMDS. |
Service/Record Type | Select the service/record type, e.g. IDN. |
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 (SFC) 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 (SFC) 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 (SFC) Records - Favorites List. |
Click OK to insert the formula in your workbook.
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 (SFC) → Quote Table to display the RTW RMDS (SFC) Quote Table dialog box.
The RTW RMDS (SFC) 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 vsRMDS. |
Service/Record Type | Select the service/record type, e.g. IDN. |
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.
The RTW RMDS (SFC) 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 (SFC) → Chain to display the RTW RMDS (SFC) Chain dialog box.
The RTW RMDS (SFC) 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 vsRMDS. |
Service | Select the service, e.g. IDN, RSF. |
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.
Vistasource RTW offers the ability to publish and contribute market data using the RTW RMDS (SFC) engine.
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:
ProgID | The name of the RTW RTD Server: Vistasource.RtdServer |
Server | Remains null. |
Command | ”rtinsert”, to indicate the publish command. |
Data Range | The cell or cell range containing the value(s) to publish |
Engine | The engine name is vsRMDS. |
Servicename | The name of the data feed/service. |
Recordname | The name of the record to publish. |
Fieldname1,… | The name of the first field, such as BID or ASK. |
FieldnameN | The name of the last field. |
RTW offers a publish dialog that facilitates building an RTD publishing formula.
Select Vistasource → RMDS (SFC) → Publish to display the RTW RMDS (SFC) Publish dialog box.
The RTW RMDS (SFC) Publish dialog box contains the following fields:
Cell Range | Enter 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 Range | Enter 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. |
Engine | The engine name is vsRMDS . |
Form Class Number (TIC only) | Enter the form class number of the insert service, if using a TIB implementation with QFORM data. |
Service | Select the service, e.g. RSF , IDN . |
Record Name | Enter 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 Publish | Enter 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 Field | Remove 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 List | The RTW RMDS (SFC) 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 (SFC) Publish dialog box. |
Add to Favorites | Add 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 (SFC) Records - Favorites List. See Favorites for more information on adding, deleting and updating this list. |
Click OK in the RTW RMDS (SFC) 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 (SFC) engine to the DTS
service.
=RTD("Vistasource.RtdServer",,"rtinsert",C15,"vsRMDS","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 (SFC) engine to the SH
service.
=RTD("Vistasource.RtdServer",,"rtinsert",C15,"vsRMDS","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 (SFC) engine using the PACKAGE_DATA function:
=RTD("vistasource.rtdserver",,"rtinsert",PACKAGE_DATA(D3:D4),"vsRMDS","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),"vsRMDS","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 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.
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.
FUNCTION | RTS |
ARGUMENTS | Engine, service, record, field1, field2, … fieldN |
EXAMPLE | =RTS("vsRMDS","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_SFC |
ARGUMENTS | Service, record, field1, field2, … fieldN |
EXAMPLE | =RTS_SFC("IDN", "MSFT.O", "ASK") |
DESCRIPTION | Subscribe to data using the RTW RMDS (SFC) engine |
NOTES | Service,Record,Field1 are obligatory. The maximum number of fields is 51 (24 for Excel versions prior to 2007). |
FUNCTION | RTINSERT |
ARGUMENTS | Value(s), engine, service, record, field1, field2, … fieldN |
EXAMPLE | =RTINSERT(C15,"vsRMDS","DTS", "MYREC", "BID") |
DESCRIPTION | Publish data usig the specified engine |
NOTES | The maximum number of fields is 51 (23 for Excel versions prior to 2007). |
FUNCTION | RTINSERT_SFC |
ARGUMENTS | Value(s), service, record, field1, field2, … fieldN |
EXAMPLE | =RTINSERT_SFC(C15, "DTS", "MYREC", "BID") |
DESCRIPTION | Publish data using the RTW RMDS (SFC) engine |
NOTES | The maximum number of fields is 51 (23 for Excel versions prior to 2007). |
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)
FUNCTION | PARSE_DATA |
ARGUMENT | An Excel-style string |
EXAMPLE | {=PARSE_DATA(RTS_SFC("IDN","MSFT.O", "BID", "ASK"))} |
DESCRIPTION | Evaluates an Excel-style string |
NOTES | For PARSE_DATA to work properly, the “Decimal separator” in Microsoft Excel needs to be set to “.” (period), and the “Thousands separator” needs to be “,” (comma). To verify these settings, please check Excel Options → Advanced → System Separators. 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. |
FUNCTION | PACKAGE_DATA |
ARGUMENT | Cell range |
EXAMPLE | =RTINSERT_SFC(PACKAGE_DATA(D3:D4), "DTS","MYREC","BID","ASK") |
DESCRIPTION | Converts a range of values to an Excel-style string |
The RTW RMDS (SFC) 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 (SFC) Favorites List dialog box.
The RTW RMDS (SFC) 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 (SFC) group.
The RTW RMDS (SFC) 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:
|
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 List | The RTW RMDS (SFC) 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 (SFC) Favorites List dialog box. |
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.
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.
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 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.
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 (SFC) tab. On these tabs, defaults can be selected for the user interface dialogs such as Quick Quote.
On the Generic tab, you can select the options Build Formulas as Arrays and Don’t show splash screen on startup.
When this option is on, all Quote dialog boxes will create array formulas by default.
Turn this option on to suppress the Vistasource RTW splash screen when you launch Microsoft Excel. The option is off by default.
The RMDS (SFC) tab contains the option Default Service.
Set the default subscribe and publish services for the RTW RMDS (SFC) 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.
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.
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.
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.
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.
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.
This option allows the setting of the rate in which data gets updated. It contains the following settings:
Select Vistasource → Updates → Rate → As Data Changes to have the engine update your data as the values change.
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.
Select Vistasource → Updates → Rate → Custom Interval to define a custom interval between updates. Custom intervals are measured in seconds.
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:
Engine | The engine is vsRMDS. |
Service | Select a service from the Service pull-down menu. |
Number of Live Records | The number of live records is displayed. |
Record Name | The list of records appears in the list box. |
Field Name/Field ID | The 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.
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:
Engine | The engine is vsRMDS. |
Service | Select a service from the Service drop-down menu. |
Record | Type the name of the record (RIC) for which you want to retrieve values in the Record (RIC) entry field. |
Get Record | This 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.