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/04/24 17:32]
cjaeger [Quick Request]
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:​excelvs_ribbon_rev.png?​nolink&​680 |Vistasource Ribbon Menu}} 
-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==== 
- 
-To request data from records in another Excel workbook, two options are available on the Vistasource 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. Alternately,​ enter a new record name to create a new record.| 
-|**Add to Favorites** | To add frequently used server/​record combinations to a list of favorites, supply a server name and record name and click **Add to Favorites**. 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 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 select 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 data for 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** | 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 select 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. Alternately,​ enter a new record name to create a new record.| 
-|**Add to Favorites** | To add frequently used server/​record combinations to a list of favorites, supply a server name and record name and click **Add to Favorites**. 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 server/​record combinations to a list of favorites, select a server name and record name and click **Add to Favorites** in the RTSHARE Quick Request or RTSHARE Insert dialog boxes.  ​ 
- 
-To check which server/​records combinations 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** while in the View Favorites dialog box 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. ​ 
- 
-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 signifies local host. Add or delete record items 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>​Update Record List</​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 item 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, '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 function when used in RTSHARE, see [[#​Requesting Data with the RTD Function]] and [[#​Inserting Data with the RTD Function]]. 
- 
-Vistasource recommends using the supplied [[#wrapper functions]] RTS_SHARE and RTINSERT_SHARE to simplify the use of the RTD function. ​ 
- 
- 
- 
- 
-====Wrapper functions==== 
- 
-The following wrapper functions are available for inserting and requesting data with RTSHARE. Wrapper functions call the RTD function 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** | Hostname, Recordname| 
-|**EXAMPLE** | <​code>​=RTS_SHARE("​MyHost",​ "​MyRec"​)</​code>​| 
-|**DESCRIPTION** | Receives value of MyRec using the specified RTSHARE server.| 
-|**NOTES** | Recordname is obligatory. If no hostname is provided, then connection to the local machine is attempted.| 
- 
- 
-===Inserting Data=== 
- 
-The wrapper function RTINSERT_SHARE is used to insert data. 
- 
-|**FUNCTION**|RTINSERT_SHARE| 
-|**ARGUMENTS**|ContribCell,​ Hostname, Recordname| 
-|**EXAMPLE**|<​code>​=RTINSERT_SHARE(a1,​ "​MyHost",​ "​MyRec"​)</​code>​| 
-|**DESCRIPTION**|Shares the cell value of the specified cell for recordname ​ MyRec using the specified RTSHARE server.| 
-|**NOTES**|ContribCell and Recordname are obligatory. If no Hostname is provided, then connection to the local machine is attempted.| 
- 
- 
-<​note>​When inserting values with RTINSERT_SHARE,​ the output cell may show an initial #N/A, This is intrinsic to how an RTD server works, data is not dropped. As soon as the actual value is available, OK is displayed, indicating that the insert was successful. For more information see: [[http://​msdn.microsoft.com/​en-us/​library/​aa140060(v=office.10).aspx#​odc_xlrtdfaq_whyalwaysna|msdn.microsoft.com]]</​note> ​ 
-===Requesting Data with the RTD Function=== 
- 
-The generic syntax for the Microsoft Excel(r) RTD function is as follows: 
-  
-<​code>​=RTD(ProgId,​ Server, Topic1, [Topic2], ...) </​code>​ 
- 
-When using RTSHARE to request data, the RTD function takes the following arguments: 
- 
-<​code>​=RTD(ProgId,​ Server, Command, Service, Hostname, Recordname) </​code>​ 
-  
-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.| ​ 
-|Service|The name of the service, rtshare.| 
-|Hostname|The RTSHARE server facilitating the request, i.e. the machine name where the RTSHARE server is running. ​ If left blank, localhost will be used. | 
-|Recordname|The name of the record that is requested.| ​ 
-  
-The following formula requests the value of MyRec on server MyHost: 
- 
-<​code>​=RTD("​Vistasource.RtdServer",,"​rt","​rtshare","​MyHost","​MyRec"​)</​code>​ \\ 
- 
- 
- ​===Inserting Data with the RTD Function=== 
- 
-The generic syntax for the Microsoft Excel RTD function is as follows: 
-  
-<​code>​=RTD(ProgId,​ Server, Topic1, [Topic2], ...) </​code>​ 
- 
-When using RTSHARE to insert data, the RTD function takes the following arguments: 
- 
-<​code>​=RTD(ProgId,​ Server, Command, ContribCell,​ Service, Hostname, Recordname) </​code>​ 
- 
- 
-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.| ​ 
-|ContribCell|The cell location for the data being inserted.| 
-|Service|The name of the service, rtshare.| 
-|Hostname|The RTSHARE server facilitating the request, i.e. the machine name where the RTSHARE server is running. If left blank, localhost will be used.| 
-|Recordname|The name of the record of which to insert data.| ​ 
-  
-The following formula inserts the value of A1 using the recordname MyRec on server MyHost:\\ 
- 
-<​code>​=RTD("​Vistasource.RtdServer",,"​rtinsert",​ a1,"​rtshare","​MyHost","​MyRec"​)</​code>​\\ 
- 
-==== 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]]\\ 
- 
-