User Tools

  • Vistasource Document Library

Scope:

General

Overview
RTW
RTSHARE
RTW COM Interface
Copyright Notice
Release Notes
Software License Terms
Technical Specifications
Contact Information
Index


Getting Started

System Requirements
Installation
Obtain a Product Key
Troubleshooting


RTW

Overview
Rtconfig Editor
 • Generic Tab
Interface Preferences
Subscribe
Publish
RTW Functions
Status Window
 • Show/Hide
Cell Status Messages
Updates
Stop/Restart Engines
Pause/Resume Data
Monitor Watch List
Record Info

RMDS (RFA) ENGINE

Overview
Configuration
Operation

RMDS (SFC) ENGINE

Overview
Configuration
Operation

BLOOMBERG Engine

Overview
Configuration
Operation

NETFEED Engine

Overview
Configuration
Operation

WEBDATA Engine

Overview
Configuration
Operation


RTW COM Interface

Utilization
Commands for RTW
Commands for RTSHARE


RTSHARE (Beta)

Overview
Installation
Administration
Operation
Troubleshooting

Bloomberg Engine Operation

This section covers the following topics:

To subscribe and publish data in Microsoft Excel, RTW provides a COM Server (rts) 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 RTW COM Interface.

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

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 The name of the engine, axbloom.
Servicename The name of the service to which you are subscribing. For Bloomberg, this references the record type, e.g. TICKERX.
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 Bloomberg engine with the TICKERX record type:

=RTD("Vistasource.RtdServer",,"rt","axbloom","TICKERX","MSFT US Equity", "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 Bloomberg engine with the TICKERX record type:

=PARSE_DATA(RTD("vistasource.rtdserver",,"rt","axbloom","TICKERX","MSFT US Equity","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 → Bloomberg→ 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 → Bloomberg→ 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 Bloomberg 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 axbloom.
Record Type Select the record type, e.g. TICKERX.
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. Note: In Windows 7, this history file is located in %USERPROFILE%\AppData\Roaming\Vistasource\RTW. In Windows XP, the file is located in %USERPROFILE%\Application Data\Vistasource\RTW. If the AppData or Application directory does not exist the file is located in C:\.
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 Bloomberg 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 Bloomberg 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 Bloomberg 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 → Bloomberg → Quote Table to display the RTW Bloomberg Quote Table dialog box.

The RTW Bloomberg 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 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 axbloom.
Record Type Select the record type, e.g. TICKERX.
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 Bloomberg 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 → Bloomberg → Chain to display the RTW Bloomberg Chain dialog box.

The RTW Bloomberg Chain dialog box contains the following options:

Record Name Enter the name of the record root, e.g. MSFT.US
Market Sector Select the appropriate Market Sector for the record. For instance, for MSFT US, choose Equity.
Chain Field The following choices are available:

  • Futures Chain [FUT_CHAIN].
  • Option Chain by Unique Bloomberg Identifier [OPT_CHAIN_ID_BB_UNIQUE].
  • Option Chain [OPT_CHAIN].
  • Warrant Chain [WARRANT_CHAIN]
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 axbloom.
Record Type Select the record type, e.g. TICKERX.
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.

Click OK to initiate the construction of the chain.

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 type, record, field1, field2, … fieldN
EXAMPLE
=RTS("axbloom","TICKERX", "MSFT US Equity", "ASK")
DESCRIPTION Subscribe to data using the specified engine
NOTES Engine, Service/Record type, Record, Field1 are obligatory. The maximum number of fields is 51 (24 for Excel versions prior to 2007).
FUNCTION RTS_BLOOM
ARGUMENTS Service/record type, record, field1, field2, … fieldN
EXAMPLE
=RTS_BLOOM("TICKERX", "MSFT US Equity", "ASK")
DESCRIPTION Subscribe to data using the RTW Bloomberg engine
NOTES Service,Record,Field1 are obligatory. The maximum number of fields is 51 (24 for Excel versions prior to 2007).

PARSE_DATA, PACKAGE_DATA and PARSE_BULK

The function PARSE_DATA facilitates some of the limitations of RTD when subscribing to multiple fields in the same RTD formula (see Microsoft KB article 286258)

FUNCTION PARSE_DATA
ARGUMENTAn Excel-style string
EXAMPLE
{=PARSE_DATA(RTS_BLOOM("TICKERX","MSFT US Equity", "BID", "ASK"))}
DESCRIPTIONEvaluates an Excel-style string
NOTESFor 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.

The PACKAGE_DATA function can be used together with the PARSE_DATA function to pass an array of field names to the RTD function.

EXAMPLE
=PARSE_DATA(RTS_BLOOM("TICKERX", "MSFT US Equity", PACKAGE_DATA(A1:A2)))
DESCRIPTIONIn this case, A1 contains BID and A2 contains ASK

The PARSE_BULK function allows parsing bulk data from the Bloomberg data distribution system that is retrieved via an RTD function. In Bloomberg, the bulk format data type is used to return multi-element or multi-dimensional data.

FUNCTIONPARSE_BULK
ARGUMENTAn Excel-style string
EXAMPLE
{=PARSE_BULK(RTD("vistasource.rtdserver",,"rt","axbloom","TICKERX","UKX Index","INDX_MEMBERS"))}
DESCRIPTIONIn conjunction with an RTD array formula displays bulk data in a user-friendly format instead of as one string in a cell.
NOTESTo 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.

Favorites

The RTW Bloomberg 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 Bloomberg Favorites List dialog box.

Modify Favorites

The RTW Bloomberg 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 dialog box, or select the dialog box launcher in the Vistasource → Bloomberg group.

The RTW Bloomberg 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 Bloomberg 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 Bloomberg Favorites List dialog box.

Status Window Overview

The RTW Status Window displays messages about the RTW server, RTSHARE and any installed engine(s). The information is divided into the product components (RTW, RTSHARE or engine(s) ) and message types (errors, warnings, etc).

The top buttons of the window represent the components that have messages available. The RTW button represents the RTW server and is always displayed. When an engine is started or RTSHARE is used, a button for that component will be added to the toolbar. To view the messages for a component, click on its button.

For each component, there are tabs categorizing the different types of messages that the server or engine might send to the Status Window. For example, the tabs for the RTW component are: Information, Warnings, and Errors. Each engine and RTSHARE has its own message types. To switch between message types, click on the appropriate tab.

The Status Window will automatically switch to a component when either 1) initialization of the component has occurred or 2) an error occurred for that component.

If necessary, you can copy lines in any of the tabs to the clipboard. To select lines, either left-click on one or more lines in the tab, or right-click in the tab and choose Select All from the menu (alternatively, Ctrl+A will select all lines and Ctrl+D will unselect all lines). To copy the selected lines, type Ctrl+C or use the right-click menu and choose Copy. Once copied, the lines are ready to be pasted into your favorite editor or email program.

RTW Button

Click on the RTW button to display the following tabs: Information, Warning, Errors.

Information Provides data about RTW , such as version, network status messages, type of engine, directory paths etc.
Warnings Lists warnings about files not found or other problems
Errors Displays error messages

Bloomberg Button

Click on the Bloomberg button to display the following tabs: General, Requests, Status.

General Provides licensing and connection information
Requests Displays information about record requests
Status Displays status information

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 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 Bloomberg engine dialog boxes.

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

This dialog box contains a generic preference and a Bloomberg 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 RTW will read when it starts.
In Windows 7, the preferences file is in %USERPROFILE%\AppData\Roaming\Vistasource\RTW\preferences.
In Windows XP, the preferences file is in %USERPROFILE%\Application Data\Vistasource\RTW\preferences. In both operation systems, this file 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.

Bloomberg Tab – Interface Preferences

The Bloomberg tab contains the following options.

Default Service

Sets the default subscribe service for the RTW Bloomberg engine. The selected subscribe service will automatically be the default service in the Quote dialog boxes. For Bloomberg, it would be the record type, such as TICKERX.

Mnemonics/Description

Sets the field name display option for dialog boxes. Choose Mnemonics first to show short field names first, e.g. ASK (Ask Price). Choose Description first to show long field names first, e.g. Ask Price (ASK).

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 axbloom.
ServiceSelect a service from the Service pull-down menu. For Bloomberg, this references the record type, e.g. TICKERX.
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 Bloomberg. 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 axbloom.
ServiceSelect a service from the Service drop-down menu. For Bloomberg, this references the record type, e.g. TICKERX.
RecordType the name of the record (RIC) for which you want to retrieve values in the Record (RIC) entry field.
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.