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
rtw_4.5:bloomberg_engine_configuration [2013/03/27 19:21]
cjaeger [Bloomberg Engine Configuration]
rtw_4.5:bloomberg_engine_configuration [2013/03/27 19:22]
cjaeger
Line 54: Line 54:
    
  
- 
-====== Generic Configuration Options ====== 
-  
-In addition to the engine-specific RTW Bloomberg 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]]. 
- 
-<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:​006_bloomberg_rtconfig_generictab.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>​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 "​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.  
- 
-<​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 "​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. ​ 
- 
-==== 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** 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. 
- 
-=== 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.