User Tools

  • Vistasource Document Library

Rtconfig Editor

RTW has configuration options which define the behavior of RTW and the RTW engines. These options are saved in a file called rtconfig, which is located:

In Windows 7, in %USERPROFILE%\AppData\Roaming\Vistasource\RTW\
In Windows XP, in %USERPROFILE%\Application Data\Vistasource\RTW\

To edit these options using the Rtconfig Editor, select Vistasource → Settings → Rtconfig Editor. The editor contains a generic tab as well as tabs representing the installed and licensed engines, e.g. RMDS (RFA), RMDS (SFC), Bloomberg, Netfeed, and WebData.

We strongly recommend that you consult a system administrator before editing any options.

RTW and the RTW Engines

To learn more about editing RTW configuration options for the installed RTW engines, see the appropriate engine-specific help:

The RTW RMDS RFA engine
The RTW RMDS SFCengine
The RTW Bloomberg engine
The RTW Netfeed engine
The RTW WebData engine

RTW and RTSHARE

If RTSHARE is installed, only a few RTW options on the generic tab are relevant. These options apply to the status window for the RTSHARE Client and the option 'No Excel Event.' There is no separate RTSHARE tab. For more information about the RTW options applicable for RTSHARE, see Status Window Options and No Excel Event under Administration of RTSHARE.

Generic Tab

The generic tab on the RTW rtconfig Editor dialog contains generic RTW and general RTW engine configuration options. These options refer to the sections “Generic RT Engine Settings” and “RTW Settings” in the rtconfig file. To manually edit the generic RTW configuration options in the rtconfig file, see 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.

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.

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.

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 configuration options are saved in the rtconfig file. 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 file is located:

In Windows 7, in %USERPROFILE%\AppData\Roaming\Vistasource\RTW\
In Windows XP, in %USERPROFILE%\Application Data\Vistasource\RTW\

When manually editing the parameters in the rtconfig file, empty spaces are not supported. For instance, use Trace:1, not Trace: 1.

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 the engine-specific sections, look for:

  • Generic RT Engine settings
  • RTW settings
  • vsRMDS2 RT Engine Settings (RMDS RFA)
  • vsRMDS RT Engine Settings (RMDS SFC)
  • Bloomberg RT Engine Settings
  • vsnf (Netfeed) RT Engine Settings
  • RTHTTP Engine Settings (WebData)

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.