User Tools

  • Vistasource Document Library

Differences

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

Link to this comparison view

rtw_4.5:rmds_sfc_engine_configuration [2013/06/05 18:03]
cjaeger [Data Dictionaries]
rtw_4.5:rmds_sfc_engine_configuration [2018/08/04 20:08]
Line 1: Line 1:
-====== RMDS (SFC) Engine Configuration====== 
- 
- 
-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 section provides information regarding the following topics: 
- 
-  * [[#Quick Setup]] 
-  * [[#RMDS (SFC) Tab – Rtconfig Editor]] 
-  * [[#SFC Configuration]] 
-  * [[#SFC Setup Examples]] 
-  * [[rtw_4.5:​rtconfig_editor#​generic_tab|Generic Configuration Options]] 
-  * [[rtw_4.5:​rtconfig_editor#​manually_editing_the_rtconfig_file|Manually Editing the rtconfig File]] 
- 
-===== Quick Setup ===== 
- 
-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 | 
-  
- 
- 
-===== RMDS (SFC) Tab – Rtconfig Editor ===== 
-  
-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]]. 
- 
-<​note>​To edit the generic RTW configuration options as well as some general engine settings, see [[#Generic Tab - Rtconfig Editor]]. </​note>​ 
- 
-<note warning>​We strongly recommend that only system administrators or experienced users make changes to the configuration options.</​note>​ 
- 
-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. ​ 
- 
- 
-{{ :​rtw_4.5:​003_rmds_sfc_rtconfig_tab.png?​direct&​ |}} 
- 
-The following options are available on this tab:  
- 
-==== Implementation ==== 
- 
-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: 
- 
-  * SSL, if your infrastructure is Triarch or RMDS (P2PS). ​ 
-  * TIB, if your infrastructure is TIC/SASS2, TIC/SASS3, or RMDS (RTIC). The default is TIB.  
- 
-To use both TIB and SSL infrastructures,​ additional connections can be specified. See section [[#​Connections]] below for more information. ​ 
- 
-==== Services ==== 
- 
-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. ​ 
- 
-<​note>​By default, this option is not set.</​note>​ 
- 
-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. ​ 
- 
-==== SFC API Config File ==== 
- 
-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). ​ **Note**: The SFC Configuration file must be named sslapi.cnf regardless of its location: 
-    - In the local directory (.\sslapi.cnf) 
-    - If the file is not found in the local directory, ​ ''​\HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG''​ registry entry. 
-    - SSLAPI_CONFIG environment variable. \\ 
-    - If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.\\ **NOTE:** Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion. 
- 
-To edit the selected file, click on the **Edit** button.  ​ 
- 
-<​note>​We strongly recommend that you consult the SFC manuals for more information regarding the Reuters file sfcapi.conf. The configuration file that Thomson Reuters provides may be called sslapi.cnf. When using the Vistasource sample sfcapi.conf file found in the install directory, you may need to make specific edits depending on your specific setup. </​note>​ 
- 
-==== Keep Stale Data ==== 
- 
-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. 
- 
-==== Use Four Part Subjects ==== 
-  
-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). 
- 
-<​note>​This will not work when using TIC/SASS3 or RTIC with the dynamic ​ service finding option ON. To disable dynamic services, manually edit the sfcapi.conf file by adding the line: \\ ''​*tibFactory.enableDynamicRTRecordServices:​ FALSE''​ </​note>​ 
- 
-<​note>​When publishing market data (as opposed to contributing),​ the record name must be a four-part subject name regardless of the setting of this option.</​note>​ 
- 
- 
-====SFC API Logger ==== 
- 
-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. ​ 
- 
- 
-==== Connections ==== 
-  
-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]]. ​ 
- 
-To create an SSL connection, in the **Connections** panel: 
- 
-  - Choose **SSL** for the Implementation 
-  - Enter a new name for the new connection, e.g. conn1. 
-  - Enter the services using a comma-separated list, e.g. IDN_SELECTFEED,​ DTS 
-  - Click **Save Connection**. ​ 
- 
-To create a TIB Connection, in the **Connections** panel: 
- 
-  - Choose **TIB** for the Implementation 
-  - Enter a new name for the new connection, e.g. conn2. 
-  - Enter the Rendezvous Service, e.g. 7500.  
-  - Enter the Rendezvous network interface, e.g. 10.100.1.92 
-  - Enter the Rendezvous daemon e.g. tcp:​10.100.1.92:​7500. 
-  - Enter the protocol, e.g. SASS2 or SASS3 
-  - Enter the services using a comma-separated list. The Services are used for the Excel User Interface, e.g. RSF, SH. 
-  - Click **Save Connection**. 
- 
-To remove a previously saved connection, select the connection in the **Name** pull-down menu and click **Remove Connection**. 
- 
-  ​ 
-===== SFC Configuration ===== 
-  
- 
-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. ​ 
- 
-==== ipcRoute Parameter==== 
-The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: \\ \\ *ipcRoute: ipcService [hostname...] \\ \\ For example: ''​*ipcRoute:​ triarch_sink p2ps_host'' ​ \\ The SFC API will look for the SFC Configuration file in the following locations. \\  **Note**: The SFC Configuration file must be named sslapi.cnf regardless of its location: 
-    - In the local directory (.\sslapi.cnf) 
-    - If the file is not found in the local directory, ​ ''​\HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG''​ registry entry. 
-    - SSLAPI_CONFIG environment variable. \\ 
-    - If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.\\ ​ **NOTE:** Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion. 
- 
-==== Data Dictionaries ==== 
- 
-By default, the data dictionaries are downloaded from the network. 
- 
-The default setting for this in sfcapi.cnf (sslapi.cnf) is: 
- 
- 
-''#​*fidDbLocation : network'' ​     ​ 
- 
- 
-However, the files can also be located on your machine. \\ 
-In order to set their location, use the following sfcapi.cnf (sslapi.cnf) parameters: ​ 
- 
- 
-''​*fidDbLocation : file''​\\ 
-''​*fid_file_path : <file path>/​appendix_a''​\\ 
-''​*enum_file_path : <file path>/​enumtype.def''​\\ 
-==== Entitlements ==== 
- 
-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''​ 
- 
- 
-==== Logging ==== 
-  
-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. 
- 
-<​note>​Tracing only works when the *selector configuration is set to Debug.</​note>​ 
- 
-Choose the file to log to. The default is log.out: 
- 
-''​*vsRMDS*logger*file:​ c:/​temp/​vsrmds.log''​ 
- 
-  
-===== SFC Setup Examples ===== 
- 
-This section contains several examples for basic SFC setup. ​ 
- 
- 
-==== Simple RMDS (SFC) Configuration for SSL ==== 
- 
-  - Define your RMDS implementation and services: ​ 
-    - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor. 
-    - Select the RMDS (SFC) tab. 
-    - Select SSL under Implementation. 
-    - Enter a comma-separated list of services in the Service field, e.g. DTS,​IDN_SELECTFEED 
-    - Click **OK**. 
-  - The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: *ipcRoute: ipcService [hostname...] \\ For example: ''​*ipcRoute:​ triarch_sink p2ps_host'' ​ \\ The SFC API will look for the SFC Configuration file in the following locations. **Note**: The SFC Configuration file must be named sslapi.cnf regardless of its location: 
-    - In the local directory (.\sslapi.cnf) 
-    - If the file is not found in the local directory, ​ ''​\HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG''​ registry entry. 
-    - SSLAPI_CONFIG environment variable. \\ 
-    - If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.\\ ​ **NOTE:** Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.\\ ​ 
-  - By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in //​C:​\var\triarch//​. To create the local data dictionary in the default directory: ​ 
-    - Verify the directory //​C:​\var\triarch//​ exists. 
-    - In Windows 7, browse to //​C:​\Program Files(86)\Vistasource\RTW\4.5\//​ and in Windows XP, browse to //​C:​\Program Files\Vistasource\RTW\4.5\//​. Copy the files appendix_a and enumtype.def. 
-    - Paste the files into //​C:​\var\triarch//​. 
- 
-==== Simple RMDS (SFC) Configuration for TIB ==== 
- 
-  - Define your RMDS TIB implementation and services, and location of SFC configuration file: 
-    - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor. 
-    - Select the **RMDS (SFC)** tab. 
-    - Select **TIB** under Implementation. 
-    - Enter a comma-separated list of services in the Service field. The service list will vary depending on your Reuters installation,​ e.g. RSF,​IDN_RDF. 
-    - Browse to the SFC API Config file. Vistasource provides a sample file called sfcapi.conf in the installation directory. Select this file (you will edit it in the next step). ​ 
-    - Click **OK**. 
-  - Edit the SFC API Configuration file: 
-    - While in the Rtconfig Editor, click the **Edit** button next to SFC API Config to edit the sfcapi.conf file.  
-    - Enter your values for protocol, service, network and daemon according to the values collected before getting started. ​ 
-    - Additionally,​ the entitlements settings may require changes depending on your setup. Entitlements are on by default. If you do not have access to the DACS permissioning system, set this value to FALSE by uncommenting the ''​*enableEntitlements:​ FALSE''​ line.  ​ 
-    - Save the sfcapi.conf file. 
-  - By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in //​C:​\var\triarch//​. To create the local data dictionary in the default directory: ​ 
-    - Verify the directory //​C:​\var\triarch//​ exists. ​ 
-    - In Windows 7, browse to //​C:​\Program Files(86)\Vistasource\RTW\4.5\//​ and copy the files appendix_a and enumtype.def. In Windows XP, browse to //​C:​\Program Files\Vistasource\RTW\4.5\//​ and copy the files appendix_a and enumtype.def. 
-    - Paste the files into //​C:​\var\triarch//​. 
- 
-==== Simple RMDS (SFC) Installation for both SSL and TIB ==== 
- 
- 
-{{ :​rtw_4.5:​003_rmds_sfc_rtconfig_tab.png?​direct&​ |}} 
- 
-To use both SSL and TIB implementations,​ two connections need to be set up. This can be accomplished in two ways:  
- 
-  - Setting up a default connection on the left side of the RMDS (SFC) tab and then adding an additional connection via the Connections panel on the right side (see Example 1 below) 
-  - Setting up both connections via the Connection panel on the right side (see Example 2 below). 
- 
-**Example 1 – Using a Default Connection and then Additional Transport Connections** ​ 
- 
-  - Define your default RMDS implementation and services, e.g. SSL:  
-    - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor 
-    - Select the** RMDS (SFC)** tab 
-    - Select **SSL** under **Implementation** 
-    - Enter a comma-separated list of services in the **Service** field, e.g.: 
-    - DTS,​IDN_SELECTFEED 
-    - Click **OK**. 
-  - Define your additional connection, e.g. TIB: 
-    - In the Connection panel, define the following: ​ 
-      * Enter a new name for the new connection, e.g. conn2. 
-      * Select **TIB** under **Implementation**. 
-      * Enter the Rendezvous Service, e.g. 7500.  
-      * Enter the Rendezvous network interface, i.e. 10.100.1.92 
-      * Enter the Rendezvous daemon, i.e. tcp:​10.100.1.92:​7500. 
-      * Enter the protocol, e.g. SASS2 or SASS3. 
-      * Enter the services. The Services are used for the Excel User Interface, e.g. RSF, SH. 
-    - Save the new connection. 
-  - Click **Save to File** to save your selections in the rtconfig file and close the RTW rtconfig Editor. 
-  - The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: *ipcRoute: ipcService [hostname...] \\ For example: ''​*ipcRoute:​ triarch_sink p2ps_host'' ​ \\ The SFC API will look for the SFC Configuration file in the following locations. **Note**: The SFC Configuration file must be named sslapi.cnf regardless of its location: 
-    - In the local directory (.\sslapi.cnf) 
-    - If the file is not found in the local directory, ​ ''​\HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG''​ registry entry. 
-    - SSLAPI_CONFIG environment variable. \\ 
-    - If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines.\\ **NOTE:** Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion.\\ ​ 
-   - By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in //​C:​\var\triarch//​. To create the local data dictionary in the default directory: ​ 
-    - Verify the directory //​C:​\var\triarch//​ exists. ​ 
-    -  In Windows 7, browse to //​C:​\Program Files(86)\Vistasource\RTW\4.5\//​ and in Windows XP, browse to //​C:​\Program Files\Vistasource\RTW\4.5\//​. Copy the files appendix_a and enumtype.def. 
-    - Paste the files into //​C:​\var\triarch//​. 
- 
-**Example 2  - Using rmds_transport for all Connections** 
- 
-  - Remove any rmds_Implementation and rmds_Service settings. \\  By default, implementation and services are not set. However, Vistasource strongly recommends verify these settings in the rtconfig file 
-    - In Windows 7, browse to //​C:​\Program Files(86)\Vistasource\RTW\4.5\rtconfig//​ and in Windwos XP, browse to //​C:​\Program Files\Vistasource\RTW\4.5\rtconfig//​. Open file in a text editor. 
-    - Scroll to rmds_Implementation and rmds_Services in the section "​vsRMDS RT Engine Settings"​ and verify that both parameters are commented out. 
-    - If you made changes, save the file and close. 
-  - Define your SSL Connection: 
-      - In Excel, select **Vistasource -> Settings -> Rtconfig Editor** to launch the rtconfig editor. 
-      - Select the **RMDS (SFC)** tab. 
-      - In the Connection panel, on the right side, define the following: ​ 
-        * Enter a new name for the new connection, e.g. conn1. 
-        * Select **SSL** under **Implementation** 
-        * Enter the services, e.g. IDN_SELECTFEED,​ DTS 
-        * Save the connection by clicking **Save to File**. 
-  - Define your TIB Connection: 
-    - In the Connection panel, define the following: ​ 
-      * Enter a new name for the new connection, e.g. conn2. 
-      * Select **TIB** under **Implementation**. 
-      * Enter the Rendezvous Service, e.g. 7500.  
-      * Enter the Rendezvous network interface, i.e. 10.100.1.92 
-      * Enter the Rendezvous daemon, i.e. tcp:​10.100.1.92:​7500. 
-      * Enter the protocol, e.g. SASS2 or SASS3. 
-      * Enter the services. The Services are used for the Excel User Interface, e.g. RSF, SH. 
-      * Save the new connection by clicking **Save to File**. ​ 
-  - Click **Save to File** to save your selections in the rtconfig file and close the RTW rtconfig Editor. 
-  - The *ipcRoute parameter is required in the SFC Configuration file. This parameter has the following syntax: ​ ''​*ipcRoute:​ ipcService [hostname...]'' ​ \\ For example: ​ ''​*ipcRoute:​ triarch_sink p2ps_host''​ \\  The SFC API will look for the SFC Configuration file in the following locations. **Note**: The SFC Configuration file must be named sslapi.cnf regardless of its location: \\  ​ 
-       - In the local directory (.\sslapi.cnf) 
-       - If the file is not found in the local directory, \\  \HKEY_LOCAL_MACHINE\Software\Reuters\SSL\SSLAPI_CONFIG registry entry 
-       - SSLAPI_CONFIG environment variable 
-       - If no sslapi.cnf file exists, the ipcroute file will be located per SSL 4.0 guidelines. \\  **Note:** Since the SFC Configuration file takes priority over the legacy ipcroute file, Reuters recommends using the ipcroute parameter instead of the ipcroute file to avoid confusion. \\    
-  - By default, Data Dictionary files will be downloaded from the network. If local Data Dictionary files are preferred, verify the location of the local data dictionary files. By default, the RTW RMDS (SFC) engine looks in //​C:​\var\triarch//​. To create the local data dictionary in the default directory: ​ 
-      - Verify the directory //​C:​\var\triarch//​ exists. ​ 
-      -  In Windows 7, browse to //​C:​\Program Files(86)\Vistasource\RTW\4.5\//​ and in Windows XP, browse to //​C:​\Program Files\Vistasource\RTW\4.5\//​. Copy the files appendix_a and enumtype.def. 
-      - Paste the files into //​C:​\var\triarch//​. 
-