User Tools

  • Vistasource Document Library

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
rtw_4.5:rmds_rfa_engine_configuration [2013/03/27 18:09]
cjaeger [Namespace]
rtw_4.5:rmds_rfa_engine_configuration [2018/08/04 20:09] (current)
Line 8: Line 8:
   * [[#RTW RFA Configuration Editor|RFA Configuration Editor]]   * [[#RTW RFA Configuration Editor|RFA Configuration Editor]]
   * [[#​Publish/​Contribute Setup]]   * [[#​Publish/​Contribute Setup]]
-  * [[#Generic Configuration Options]]+  * [[rtw_4.5:​rtconfig_editor#generic_tab|Generic Configuration Options]]
   * [[#​Configuration Examples]]   * [[#​Configuration Examples]]
-  * [[#Manual Configuration]]+  * [[rtw_4.5:​rtconfig_editor#manually_editing_the_rtconfig_file|Manually Editing the rtconfig File]]
   * [[#​Migration]]   * [[#​Migration]]
  
Line 23: Line 23:
 |RMDS Rendezvous (RTIC)|Daemon,​ network and service parameters for a SASS3/RV 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: ​+By default, the RTW RMDS (RFA) engine uses the Windows Registry for configuration. An example registry file is provided ​in the install directory, which is by default C:\Program Files (x86)\Vistasource\RTW\4.5. ​
  
-In Windows 7, see %USERPROFILE%\AppData\Roaming\Vistasource\RTW\RFA-example.reg \\ +To initialize the Registry with the example file: 
-In Windows XP, see %USERPROFILE%\Application Data\Vistasource\RTW\RFA-example.reg \\ +  * In Windows 7, run c:\WINDOWS\SysWOW64\regedit.exe,​ which is the 32-bit Registry Editor, and then do File->​Import of the RFA-example.reg, which is located in the install directory. ​\\ 
 +  ​* ​In Windows XP, browse to the install directory and double-click on the file RFA-example.reg ​to import the sample settings into the Windows Registry. ​\\
  
-To initialize the Registry with the example file, e.g. in Windows 7:  
- 
-  - Browse to //​%USERPROFILE%\AppData\Roaming\Vistasource\RTW\RFA-example.reg // 
-  - Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry. 
  
 See [[#RTW RFA Configuration Editor]] on how to edit RFA configuration. See [[#RTW RFA Configuration Editor]] on how to edit RFA configuration.
Line 76: Line 73:
 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. ​ 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.  +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 Windows 7, in %USERPROFILE%\AppData\Roaming\Vistasource\RTW\  
-<​note>​Vistasource provides a sample configuration file called RFA-example.cfg,​ which is located in the install directory. </​note>​+  * In Windows XP, in  %USERPROFILE%\Application Data\Vistasource\RTW\  ​
  
 ==== Keep Stale Data ==== ==== Keep Stale Data ====
Line 88: Line 85:
 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,​ see [[#​rtw_rfa_configuration_editor|RTW RFA Configuration Editor]] below. ​   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,​ see [[#​rtw_rfa_configuration_editor|RTW RFA Configuration Editor]] below. ​  
  
-In Windows 7:  You must be running Microsoft Excel in elevated (Administrator) mode to edit the RFA configuration file, otherwise the **Advanced** button is greyed out.  +In Windows 7:  You must be running Microsoft Excel in elevated (Administrator) mode to edit the RFA configuration file, otherwise the **Advanced** button is greyed out. For instance, to run Excel 2010 as administrator:​
-For instance, to run Excel 2010 as administrator:​+
   - Go to **Start -> All Programs -> Microsoft Office**.   - Go to **Start -> All Programs -> Microsoft Office**.
   - Right-click on **Microsoft Excel 2010**. ​   - Right-click on **Microsoft Excel 2010**. ​
Line 165: Line 161:
 If you are using flat files, the corresponding namespace file must be manually deleted: If you are using flat files, the corresponding namespace file must be manually deleted:
   - Navigate to the directory where the default flat file is:   - Navigate to the directory where the default flat file is:
-    * In Windows 7, go to %USERPROFILE%\AppData\Roaming\Vistasource\RTW\RFA-example.reg \\ +    * In Windows 7, go to %USERPROFILE%\AppData\Roaming\Vistasource\RTW\namespace.cfg \\ 
-    * In Windows XP, gp to %USERPROFILE%\Application Data\Vistasource\RTW\RFA-example.reg \\ +    * In Windows XP, go to %USERPROFILE%\Application Data\Vistasource\RTW\namespace.cfg \\ 
   - Delete the// namespace.cfg//​ file.   - Delete the// namespace.cfg//​ file.
  
Line 368: Line 364:
 ==== SSLED (sinkdist or P2PS) Configuration ==== ==== SSLED (sinkdist or P2PS) Configuration ====
  
-  - 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+  - 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 ​example registry ​file RFA-example.reg which is located in the install directorye.g. C:\Program Files (x86)\Vistasource\RTW\4.5.  
-    ​In Windows 7browse to //C:\Program Files(x86)\Vistasource\RTW\4.5// and in Windows ​XPbrowse to //C:\Program Files\Vistasource\RTW\4.5//. **Note:** For the remaining stepsWindows 7 is assumed+      * In Windows ​7run c:\WINDOWS\SysWOW64\regedit.exe, which is the 32-bit Registry Editorand then do File->​Import of the RFA-example.reg,​ which is located in the install directory\\ 
-    - Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry.+      * In Windows XP, browse to the install directory and double-click on the file RFA-example.reg to import the sample settings into the Windows Registry. \\  **Note:** For the remaining steps, Windows 7 is assumed.
   - Launch the RTW RMDS (RFA) Configuration Editor. ​   - Launch the RTW RMDS (RFA) Configuration Editor. ​
     - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor.     - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor.
     - Select the **RMDS (RFA)** tab.     - Select the **RMDS (RFA)** tab.
-    - If you are using a flat file, check the "Use this File Rather than the Registry"​ box and browse to the //C:\Program Files(x86)\Vistasource\RTW\4.5\RFA-example.cfg// file. If you are using the Registry make sure the box is unselected. +    - If you are using a flat file, check the "Use this File Rather than the Registry"​ box and browse to %USERPROFILE%\AppData\Roaming\Vistasource\RTW\RFA-example.cfg. If you are using the Registry make sure the box is unselected. 
-    - Ensure that the default Session is RTWSession (an SSLED type session) by choosing it in the **Default Session** pull-down menu +      - Ensure that the default Session is RTWSession (an SSLED type session) by choosing it in the **Default Session** pull-down menu 
-    - Click on the **Advanced** button to launch the RTW RMDS (RFA) configuration editor.+      - Click on the **Advanced** button to launch the RTW RMDS (RFA) configuration editor. If the button is greyed out, see [[#​Advanced]] for details.
   - View the already-defined SSLED connection, which contains some minimally-required settings. To view this connection:   - View the already-defined SSLED connection, which contains some minimally-required settings. To view this connection:
     - Click on the **Connections** Tab.     - Click on the **Connections** Tab.
Line 398: Line 394:
 ==== SASS3/RV (RTIC and TIC) Configuration ==== ==== SASS3/RV (RTIC and TIC) Configuration ====
    
-  - 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+  - 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 ​example registry ​file RFA-example.reg which is located in the install directorye.g. C:\Program Files (x86)\Vistasource\RTW\4.5.  
-    ​In Windows 7browse to //C:\Program Files(x86)\Vistasource\RTW\4.5// and in Windows ​XPbrowse to //C:\Program Files\Vistasource\RTW\4.5//. **Note:** For the remaining stepsWindows 7 is assumed+      * In Windows ​7run c:\WINDOWS\SysWOW64\regedit.exe, which is the 32-bit Registry Editorand then do File->​Import of the RFA-example.reg,​ which is located in the install directory\\ 
-    - Double-click on the file RFA-example.reg to import the sample settings into the Windows Registry.+      * In Windows XP, browse to the install directory and double-click on the file RFA-example.reg to import the sample settings into the Windows Registry. \\  **Note:** For the remaining steps, Windows 7 is assumed.
   - Launch the RTW RMDS (RFA) Configuration Editor. ​   - Launch the RTW RMDS (RFA) Configuration Editor. ​
     - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor.     - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor.
     - Select the **RMDS (RFA)** tab.     - Select the **RMDS (RFA)** tab.
-    - 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.5\RFA-example.cfg// file. If you are using the Registry, make sure the box is unselected.+    - If you are using a flat file, check the "**Use this File Rather than the Registry**"​ box and browse to %USERPROFILE%\AppData\Roaming\Vistasource\RTW\RFA-example.cfg. If you are using the Registry, make sure the box is unselected.
     - Ensure that the default Session is SASS3Session by choosing it in the **Default Session** pull-down menu.     - Ensure that the default Session is SASS3Session by choosing it in the **Default Session** pull-down menu.
-    - Click on the **Advanced** button to launch the RTW RMDS RFA Configuration editor.+    - Click on the **Advanced** button to launch the RTW RMDS RFA Configuration editor. If the button is greyed out, see [[#​Advanced]] for details.
   - View the already-defined SASS3 connection, which has fields specifying an RV connection. ​ To view this connection: ​   - View the already-defined SASS3 connection, which has fields specifying an RV connection. ​ To view this connection: ​
       - Click on the **Connections** Tab.       - Click on the **Connections** Tab.
Line 430: Line 426:
     - Type the Service name into the **Name** option box      - Type the Service name into the **Name** option box 
     - Click **Save**.     - Click **Save**.
-    - 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>​ +    - When using flat files, also click **Save to File**. \\ ** Note:** Services are obtained dynamically,​ but service names are required for the User Interface Dialogs.
- +
- +
-====== 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 environmentThese 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|Manually editing the rtconfig file]]. +
- +
-<note important>​We strongly recommend that only system administrators or experienced users make changes to the configuration options.</​note>​ +
- +
-Select **Vistasource -> Settings -> Rtconfig Editor** to open the RTW rtconfig Editor dialog box.  +
- +
- +
-{{ :​rtw_4.5:​002_rmds_rfa_rtconfig_generic_tab.png?​direct&​ |}} +
-===== 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.  +
- +
-<note warning>​Turn Trace off, when it is no longer needed, because it significantly slows down the performance of the software. </​note>​ +
- +
-==== Engine throttle (in seconds) ==== +
-  +
-Refers to the rtconfig file option  +
-<​code>​rtFlushInterval</​code>​ +
-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  +
-<​code>​rePublishStaleDataInterval</​code>​ +
-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 +
-<​code>​rtInsertValueEcho</​code>​  +
-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 +
-<​code>​rtDateTimeAsString</​code>​ +
-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  +
-<​code>​no_excel_events</​code>​ +
-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.  +
- +
-<​note>​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.</​note>​ +
- +
-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  +
-<​code>​suppress_rt_status</​code>​ +
-and the RTW Settings  +
-<​code>​rtexcel:​SWOption</​code><​code>​rtexcel:​SWDir</​code><​code>​rtexcel:​SWPromote</​code>​  +
-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. In Windows XP, this file is located in the installation directory, and in Windows 7 in //​C:​\Users\[user name]\AppData\Roaming\Vistasource\RTW//​. The RTW rtconfig Editor edits this file. Alternatively,​ the rtconfig file can be manually edited using any text editor such as Notepad or Wordpad.  +
- +
-<​note>​When manually editing the parameters in the rtconfig file, empty spaces are not supported. For instance, use Trace:1, not Trace: 1.</​note>​ +
- +
-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.  +
- +
-<​note>​Changes to the RTW Engine settings require a restart of the RTW engine. Changes to the Generic RTW options require a restart of Excel.</​note> ​+