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:rtshare_operation [2013/03/26 21:57]
cjaeger [RTW Functions]
rtw_4.5:rtshare_operation [2018/08/04 20:09]
Line 1: Line 1:
-======RTSHARE Operation====== 
- 
-This section provides information about operating RTSHARE, in particular the RTSHARE Client.\\  ​ 
-For administration and [[rtshare_administration#​server_startup|startup]] of RTSHARE, see [[rtshare_administration|RTSHARE Administration]]. ​ 
-  
-The user interface of RTSHARE Client is accessible from the Excel ribbon. 
- 
-{{ :​rtw_4.5:​rtshare_ribbon_excerpt.png?​direct&​ |**Screenshot** 
-}} 
-This section covers the following topics: ​ 
- 
-  * [[#​Requests|Requesting]] Data, using [[#Quick Request]] or [[#Request Table]] 
-  * [[#​Insert|Inserting]] Data 
-  * [[#​Favorites|Favorite]] records and their [[#Manage Favorites|Management]] 
-  * Functions, including [[#RTW Functions]] and [[#Wrapper functions]] 
-  * [[Cell Status Messages]] and the [[status_window|Status Window]]  ​ 
-  * [[pause_resume_data|Pausing,​ resuming]] and [[updates|updating]] the data flow 
-  * [[rtshare_administration#​rtshare_admin_window|Administration Window]] 
-  * [[status_window|Status Window]] 
- 
-====Requests==== 
- 
-For requesting data from records in another Excel workbook, two options are listed under Requests in the Vistasource portion of the Excel ribbon menu. You can either quickly enter a request or create a table with records in the spreadsheet. For more information see: 
- 
-  * [[#Quick Request]] ​ 
-  * [[#Request Table]] 
- 
- 
- 
-====Quick Request==== 
- 
-This option provides an easy way to automatically insert a request for a single record. ​ 
- 
-Select **Vistasource -> RTSHARE -> Requests ->Quick Request** to create a subscribe request. ​ 
- 
-The RTSHARE Quick Request dialog box contains the following options: 
- 
-|**Output Cell** | Enter a cell for the request’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.| 
-|**Server** | Select the RTSHARE server by using one of the following methods: \\ - If a default server is set in [[#​rtshare_interface_preferences|Interface Preferences]],​ the server hostname will automatically fill in. \\ - Enter the server hostname in the server name box. \\ - Click the arrow on the right of the field to display a list of servers previously used, and select a server from the list. \\ - Click **Query Network**, which updates the drop-down list of servers with a list of hosts on the network, and then selelct the server from the drop-down list. | 
-|**Record Name** | Enter the record name. Clicking on the control on the right displays a list of available records. This list comes from the Update Record List and is based on which server is selected. Click **Update Record List** to refresh the list if you change the server.| 
-|**Add to Favorites** | To add frequently used records to a list of favorites, select a record and click **Add to Favorites**. To check which records have been added in previous and current sessions, click **View Favorites** to access the RTSHARE Records - Favorites List.| 
-  
-Click **OK** to insert the request in your workbook. ​ 
- 
-====Request Table==== 
- 
-This option allows you to create a table of RTSHARE requests which reference records in a spreadsheet. ​ 
- 
-Organize your spreadsheet with record names in a single row or column. It is easier to first hightlight the table and then access the Request Table dialog box.  Select **Vistasource -> RTSHARE -> Requests -> Request Table** to display the RTSHARE Request Table dialog box.  
- 
-The RTSHARE Request Table dialog box contains the following options: 
- 
-|**Cell Range** | Either highlight the table before accessing the dialogbox or enter a cell range for the formula’s output. To select a cell range directly in the worksheet without having to type its reference, click on the icon next to the entry field. The range has to contain your row or column of record names and a extra row or column accordingly. For instance: If records names are in row a1...a10, you need to specify a1....b10 for your range.| 
-|**Server** | Select the RTSHARE server by using one of the following methods: \\ - If a default server is set in [[#​rtshare_interface_preferences|Interface Preferences]],​ the server hostname will automatically fill in. \\ - Enter the server hostname in the server name box. \\ - Click the arrow on the right of the field to display a list of servers previously used, and select a server from the list. \\ - Click **Query Network**, which updates the drop-down list of servers with a list of hosts on the network, and then selelct the server from the drop-down list. | 
-|**Record Names in Column**| Choose the orientation of the data in columns. See example in Orientation panel.| 
-|**Record Names in Row**| Choose the orientation of the data in rows. See example in Orientation panel| 
-|**Use Cell Addresses for Rows/​Columns**|Check this option to use the cell references in the formula instead of the record names. This option is turned on by default, and ensures that the formula stays valid if the record names are changed. If this option is turned off, the actual record names will become part of the formula.| 
-  
-Click **OK** to insert the Request Table in your workbook. 
-  
- 
- 
-====Insert==== 
- 
-This option provides an easy way to automatically insert data to a record for sharing with other RTSHARE users. ​ 
- 
-Select **Vistasource -> RTSHARE -> Insert** to share a record. ​ 
- 
-The RTSHARE Insert dialog box contains the following options: 
- 
-|**Output Cell** | This is the location of the insert formula. To select a cell directly in the worksheet without having to type its reference, click on the icon next to the entry field.| 
-|**Data Cell** | This is the location of the data you want to insert. To select a cell directly in the worksheet without having to type its reference, click on the icon next to the entry field| 
-|**Server** |Enter the name of the server or click **Query Network** to see a list of available servers. Clicking on the control on the right displays a history list with your previous choices. The list is stored in a file called rtshare_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:​\''​.| 
-|**Record Name** | Enter the record name. Clicking on the control on the right displays a list of available records. This list comes from the Update Record List and is based on which server is selected. Click **Update Record List** to refresh the list if you change the server.| 
-|**Add to Favorites** | To add frequently used server/​record combinations to a list of favorites, select a record and click the option button. Favorites are saved in the following format: server, record or <​blank>,​record. To check which records have been added in previous and current sessions, click **View Favorites** to access the RTSHARE Records - Favorites List.| 
-  
-Click **OK** to insert the shared data in your workbook. ​ 
- 
-To delete a record, see [[rtshare_administration#​deleting_records|Deleting Records]]. 
- 
- 
-==== Favorites ==== 
- 
- 
-To add frequently used records to a list of favorites, select a record and click **Add to Favorites** in the RTSHARE Quick Request or RTSHARE Insert dialog boxes.  ​ 
- 
-To check which records have been added in previous and current sessions, click **View Favorites** to access the RTSHARE Favorites List. 
-  
-To modify the content of the RTSHARE Favorites List, click **Manage** to display the RTSHARE Manage Favorites List dialog box. To learn more about adding, deleting and modifying the RTSHARE Favorites list see [[#Manage Favorites]]. 
- 
- 
-==== Manage Favorites ==== 
- 
-The RTSHARE Manage Favorites List dialog box allows you to add, delete, and modify your list of favorite records. To access this dialog, click **View Favorites** in the Quick Request or Insert dialog boxes, or select the dialog box launcher in the **Vistasource -> RTSHARE** group and then click on **Manage**. ​ 
- 
-The RTSHARE Manage Favorites List dialog box contains the following fields: 
- 
-|**Favorites List** | Displays all the server/​record combinations you have previously added. A record without a server preceeding has the local host. Add or delete records in this list or modify them by changing the associated fields: \\ <​html><​br/><​ul><​li>​To add a server/​record combination,​ enter the name of the server or click <​b>​Query Network</​b>​ to see a list of available servers and select the server. Next, click <​b>​Get Records</​b>​. All records on the server display. Select the record and click <​b>​Add</​b>​. </​li><​li>​To delete a server/​record combination,​ select the record in the  <​b>​Favorites List</​b>​ and click <​b>​Delete</​b>​.</​li><​li>​To modify a server/​record combination,​ select the record in the <​b>​Favorites List</​b>​. All relevant entry fields will automatically fill in. Make your modifications and click <​b>​Modify</​b>​.</​li></​ul></​html>​| 
-|**Server** | Enter the server name for the records you want to add or choose from the list of favorites to modify. If left blank, the local host will be used.| 
-|**Record** | Enter a name for the record you want to add or choose from the list of favorites to modify.| 
-  
-Click **Close** to return to the RTSHARE Favorites List dialog box. 
- 
-  
-====RTW Functions==== 
- 
- 
-In RTSHARE, the Microsoft (r) Excel RTD function is used for requesting and inserting data. For more information about the syntax of the RTD when used in RTSHARE see [[#​Inserting Requesting Data with the RTD Function]] and [[Inserting Data with the RTD Function]]. 
- 
-Vistasource provides the [#wrapper functions]] RTS_SHARE and RTINSERT_SHARE to simplify the use of the RTD function. ​ 
- 
- 
- 
- ​===Inserting Data=== 
- 
-The RTD function uses the following argument when inserting data: 
-  
-=RTD(ProgId,​ server, command, host, recordname]) 
-  
-The arguments have the following meaning: 
- 
-^Argument^Explanation^ ​ 
-|ProgID|The name of the RTW RTD Server, Vistasource.RtdServer.| 
-|Server |Remains null.| ​ 
-|Command|“rtinsert”,​ to indicate the insert command.| ​ 
-|Data range|The cell location for the data being inserted.| 
-|Host|The RTSHARE server facilitating the request. If left blank, local host will be used, i.e. the machine name where the RTSHARE server is running.| 
-|Recordname|The name of the record that is requested.| ​ 
-  
-The following formula inserts the value of MyKey on server MyHost in cell a1:\\ 
- 
-'' ​ =rtd ("​vistasource.rtdserver",,"​rtinsert",​ a1,"​rtshare","​MyHost","​MyKey"​) 
-''​ 
- 
- 
-====Wrapper functions==== 
- 
-The following wrapper functions are available for inserting and requesting data. Wrapper functions call the RTDfunction 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.  
- 
-===Requesting Data=== 
- 
-The wrapper function RTS_SHARE is used to request data. 
- 
-|**FUNCTION**|RTS_SHARE| 
-|**ARGUMENTS** | Host, Key| 
-|**EXAMPLE** | <​code>​=RTS_SHARE("​MYHOST",​ "​MYKEY"​)</​code>​| 
-|**DESCRIPTION** | Receives value of MYKEY using the specified RTSHARE server| 
-|**NOTES** | MYKEY is obligatory. If no host is provided, then connection to the local machine is attempted.| 
- 
- 
-===Inserting Data=== 
- 
-The wrapper functions RTINSERT_SHARE is used to insert data. 
- 
-|**FUNCTION**|RTINSERT_SHARE| 
-|**ARGUMENTS**|Value,​ host. key| 
-|**EXAMPLE**|<​code>​=RTINSERT_RTSHARE("​a1",​ "​host",​ "​MYKEY"​)</​code>​| 
-|**DESCRIPTION**|Shares value of MYKEY in a1 using the specified RTSHARE server.| 
-|**NOTES**|Cell location and MYKEY are obligatory. If no host is provided, then connection to the local machine is attempted.| 
- 
- 
- 
- 
-===Requesting Data with the RTD Function=== 
- 
-The RTD function uses the following arguments when requesting data: 
-  
-=RTD(ProgId,​ server, command, host, recordname]) 
-  
-The arguments have the following meaning: 
- 
-^Argument^Explanation^ ​ 
-|ProgID|The name of the RTW RTD Server, Vistasource.RtdServer.| 
-|Server |Remains null.| ​ 
-|Command|“rt”,​ to indicate the subscribe command.| ​ 
-|Host|The RTSHARE server facilitating the request. If left blank, local host will be used, i.e. the machine name where the RTSHARE server is running| 
-|Recordname|The name of the record that is requested.| ​ 
-  
-The following formula request the value of MyKey on server MyHost: 
- 
-''​=rtd ("​vistasource.rtdserver",,"​rt","​rtshare","​MyHost","​MyKey"​)\\ 
-''​ 
- 
- 
- ​===Inserting Data=== 
- 
-The RTD function uses the following argument when inserting data: 
-  
-=RTD(ProgId,​ server, command, host, recordname]) 
-  
-The arguments have the following meaning: 
- 
-^Argument^Explanation^ ​ 
-|ProgID|The name of the RTW RTD Server, Vistasource.RtdServer.| 
-|Server |Remains null.| ​ 
-|Command|“rtinsert”,​ to indicate the insert command.| ​ 
-|Data range|The cell location for the data being inserted.| 
-|Host|The RTSHARE server facilitating the request. If left blank, local host will be used, i.e. the machine name where the RTSHARE server is running.| 
-|Recordname|The name of the record that is requested.| ​ 
-  
-The following formula inserts the value of MyKey on server MyHost in cell a1:\\ 
- 
-'' ​ =rtd ("​vistasource.rtdserver",,"​rtinsert",​ a1,"​rtshare","​MyHost","​MyKey"​) 
-''​ 
- 
- 
-==== Status Window for the RTSHARE Client==== 
-  
-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).  To control the display and logging of information,​ see [[rtshare_administration#​Status Window Options]]. ​ 
- 
-To view the messages for a component, click on its button, e.g.: 
- 
-   * [[#RTSHARE Button]] 
-   * [[#RTW Button]] 
- 
- 
-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. For information about error messages, see [[troubleshooting#​rtshare|Troubleshooting]]. 
- 
- 
-<note tip>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 a text editor or email program of your choice.</​note> ​ 
-  ​ 
-===RTSHARE Button=== 
- 
- 
-Click on the RTSHARE button to display the following tabs: Information,​ Warning, Errors. 
- 
-|**Information**| Provides data about RTSHARE, such as version, network status messages, directory paths etc.| 
-|**Warnings**| Lists warnings about files not found or other problems.| 
-|**Errors**| Displays error messages. See [[rtw_4.5:​troubleshooting#​rtshare|Troubleshooting]] for more details about error messages.| 
- 
- 
- 
-===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 component, directory paths etc.| 
-|**Warnings**| Lists warnings about files not found or other problems.| 
-|**Errors**| Displays error messages. See [[rtw_4.5:​troubleshooting#​rtshare|Troubleshooting]] for more details about error messages.| 
- 
-See Also: 
- 
-[[cell_status_messages|Cell Status Messages]]\\ 
-[[pause_resume_data|Pause/​Resume Data]]\\ 
-[[updates|Update Rates]]\\ 
- 
- 
-