RemoteAccessClient Thing Template
The RemoteAccessClient Thing Template provides properties and services to Things that are accessible by remote sessions from the Remote Access Client (RAC). This Thing implements the Gateway Thing Shape.
The following table describes the services provided:
|
Service Name
|
Description
|
||
|---|---|---|---|
|
GetSession
|
Retrieves the session with the specified GUID. The result is returned as an infotable, containing the session parameters.
|
||
|
EndSession
|
Terminates the session with the specified GUID. This parameters for this service are the GUID (sessionID of the remote session and the name of the Thing) (thingName).
|
||
|
GetRemoteAccessibleEndpoints
|
Retrieves the remote session endpoints for the specified Thing that implements the RemoteAccessible Thing Shape. The parameter for this service is the name of the Thing (remoteAccessible) whose endpoints you want to retrieve.
|
||
|
GetNamedPropertyValuesForThing
|
Retrieves the property values for a Thing. The parameters for this service are the name of the Thing whose properties you want to retrieve (thingName) and the names of the properties you want to retrieve (propertyNames). The property names must be passed in as an infotablel.
|
||
|
GetConfigurationTableForThing
|
Retrieve the configuration table for a Thing. The parameters for this service are the name of the Thing whose configuration table you want to retrieve (thingName) and the name of the table to retrieve (tableName).
|
||
|
GetTunnelStatusForThing
|
Retrieves the tunnel status for a Thing. The parameter for this service is the name of the Thing whose tunnel status you want to retrieve (thingName).
|
||
|
ClientPresent
|
Alert that the client is installed locally. The parameter for this services is thee correlation id given to the client when launched (clientId).
|
||
|
UpdateSession
|
Used by the RAC to periodically (every 20 seconds) refresh the lastActivityTime, this service calls the UpdateSession(remoteSession) service of the Remote Access Subsystem to refresh the bytesTransferred for any sessions that meet the following conditions:
• The bytesTransferred tracked by the client is greater than zero.
• The bytesTransferred tracked by the client changed since the last session update.
• The session status is not TERMINATED.
If the UpdateSession call fails due to the session no longer existing, the session status is forced to the TERMINATED status. This effectively stops the refresh bytesTransferred processing.
The parameter for this service is the remote session (remoteSession), specified as an infotable (RemoteSession Data Shape).
|
||
|
GetEndpointViewerConfiguration
|
Returns the viewer configuration for the Thing's endpoint and client operating system. The parameters for this service are the name of the Thing whose viewer configuration you want to retrieve (thingName), the name of the endpoint (endpointName), and the client operating system (clientOS).
|
 |
The lastActivityTime property of a Thing is updated with each GAS status update and with status updates from the Remote Access Client (RAC). Any update from either GAS or RAC will result in the lastActivityTime property being updated and the session will not time out. "Inactivity" to the ThingWorx Platform means only that the platform has not received a status update from either RAC or GAS. Inactivity does not mean that there are no bytes being transferred.
|