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:rtshare_operation [2013/04/03 18:56]
cjaeger [Manage Favorites]
rtw_4.5:rtshare_operation [2018/08/04 20:09] (current)
Line 31: Line 31:
 This option provides an easy way to automatically insert a request for a single record. ​ 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. ​+Select **Vistasource -> RTSHARE -> Requests -> Quick Request** to create a subscribe request. ​
  
 The RTSHARE Quick Request dialog box contains the following options: The RTSHARE Quick Request dialog box contains the following options:
Line 95: Line 95:
 The RTSHARE Manage Favorites List dialog box contains the following fields: 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>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>​| +|**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, ​the local host will be used.|+|**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.| |**Record** | Enter a name for the record you want to add or choose from the list of favorites to modify.|
    
Line 105: Line 105:
  
  
-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 [[#​Requesting Data with the RTD Function]] and [[#​Inserting Data with the RTD Function]].+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. ​ Vistasource recommends using the supplied [[#wrapper functions]] RTS_SHARE and RTINSERT_SHARE to simplify the use of the RTD function. ​
Line 114: Line 114:
 ====Wrapper functions==== ====Wrapper functions====
  
-The following wrapper functions are available for inserting and requesting data. 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. +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=== ===Requesting Data===
Line 121: Line 121:
  
 |**FUNCTION**|RTS_SHARE| |**FUNCTION**|RTS_SHARE|
-|**ARGUMENTS** | HostKey+|**ARGUMENTS** | HostnameRecordname
-|**EXAMPLE** | <​code>​=RTS_SHARE("​MYHOST", "MYKEY"​)</​code>​| +|**EXAMPLE** | <​code>​=RTS_SHARE("​MyHost", "MyRec"​)</​code>​| 
-|**DESCRIPTION** | Receives value of MYKEY using the specified RTSHARE server| +|**DESCRIPTION** | Receives value of MyRec using the specified RTSHARE server.
-|**NOTES** | MYKEY is obligatory. If no host is provided, then connection to the local machine is attempted.|+|**NOTES** | Recordname ​is obligatory. If no hostname ​is provided, then connection to the local machine is attempted.|
  
  
 ===Inserting Data=== ===Inserting Data===
  
-The wrapper ​functions ​RTINSERT_SHARE is used to insert data.+The wrapper ​function ​RTINSERT_SHARE is used to insert data.
  
 |**FUNCTION**|RTINSERT_SHARE| |**FUNCTION**|RTINSERT_SHARE|
-|**ARGUMENTS**|Valuehost. key+|**ARGUMENTS**|ContribCellHostname, Recordname
-|**EXAMPLE**|<​code>​=RTINSERT_RTSHARE("a1", "host", "MYKEY"​)</​code>​| +|**EXAMPLE**|<​code>​=RTINSERT_SHARE(a1, "MyHost", "MyRec"​)</​code>​| 
-|**DESCRIPTION**|Shares value of MYKEY in a1 using the specified RTSHARE server.| +|**DESCRIPTION**|Shares ​the cell value of the specified cell for recordname ​ MyRec 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.|+|**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>​
  
-===Requesting Data with the RTD Function===+When using RTSHARE to request data, the RTD function takes the following arguments:
  
-The RTD function uses the following arguments when requesting data: +<​code>​=RTD(ProgId, ​Server, CommandServiceHostnameRecordname</​code>​
-  +
-=RTD(ProgId, ​servercommandhostrecordname])+
    
 The arguments have the following meaning: The arguments have the following meaning:
Line 152: Line 155:
 |Server |Remains null.| ​ |Server |Remains null.| ​
 |Command|“rt”,​ to indicate the subscribe command.| ​ |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|+|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.| ​ |Recordname|The name of the record that is requested.| ​
    
-The following formula ​request ​the value of MyKey on server MyHost:+The following formula ​requests ​the value of MyRec on server MyHost:
  
-''​=rtd ("vistasource.rtdserver",,"​rt","​rtshare","​MyHost","​MyKey")\\ +<​code>​=RTD("Vistasource.RtdServer",,"​rt","​rtshare","​MyHost","​MyRec")</​code> ​\\
-''​+
  
  
  ​===Inserting Data with the RTD Function===  ​===Inserting Data with the RTD Function===
  
-The RTD function ​uses the following argument when inserting data: +The generic syntax for the Microsoft Excel RTD function ​is as follows:
-  +
-=RTD(ProgId,​ server, command, host, recordname])+
    
 +<​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: The arguments have the following meaning:
  
Line 173: Line 181:
 |Server |Remains null.| ​ |Server |Remains null.| ​
 |Command|“rtinsert”,​ to indicate the insert command.| ​ |Command|“rtinsert”,​ to indicate the insert command.| ​
-|Data range|The cell location for the data being inserted.| +|ContribCell|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.| +|Service|The name of the service, rtshare.| 
-|Recordname|The name of the record ​that is requested.| +|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 MyKey on server MyHost ​in cell a1:\\ +The following formula inserts the value of A1 using the recordname MyRec on server MyHost:\\
- +
-'' ​ =rtd ("​vistasource.rtdserver",,"​rtinsert",​ a1,"​rtshare","​MyHost","​MyKey"​) +
-''​+
  
 +<​code>​=RTD("​Vistasource.RtdServer",,"​rtinsert",​ a1,"​rtshare","​MyHost","​MyRec"​)</​code>​\\
  
 ==== Status Window for the RTSHARE Client==== ==== Status Window for the RTSHARE Client====