GASRemoteAccessProvider Thing

Extensions Reference > Remote Access Extension (RAE) Entity Reference > RAE Things > GASRemoteAccessProvider Thing

Derived from the GenericThing Thing Template, the GASRemoteAccessProvider Thing represents a Global Access Server that is to be used for remote sessions with Axeda eMessage Agents (Axeda Gateway and Axeda Connector) through the ThingWorx Platform.

This Thing has settings for an Axeda GAS, including a soft limit for the maximum number of Global Access Servers that may be registered with the ThingWorx Platform at any given time. The property is called maxServers. Its minimum value is 1 and default value is 50.

If a GAS attempts to register with the eMessage Connector, before a new GAS Thing is created, the current count of registered Global Access Servers is compared against the value of the maxServers setting. If the current count is greater than, or equal to maxServers, the next registration attempt will fail. This setting is editable and can be modified by the ThingWorx user.

Reducing this value does NOT have any effect on already-created Global Access Servers. Setting this value below 1 will prevent any new GAS from registering.

As of v.2.2.0 of the Axeda Compatibility Package, and v.3.0.0 of the RAE, this Thing is enabled once you import the Remote Access Extension (RAE) into ThingWorx Platform. In addition, if a GAS presents an invalid token to ThingWorx Platform, the ]invalidToken property of the GAS Thing is set to true and the GAS selection algorithm ignores any GAS whose invalidToken property is set to true.

The GASRemoteAccessProvider requires the following RunTime permissions:

• PropertyRead on the selector and maxServers properties

• ServiceInvoke on the GetRemoteAccessibleEndpoints and GetRemoteServerConfiguration services

The GASRemoteAccessProvider has the following properties:

Name	Base Type	Description
selector	THINGNAME	The GAS Selector to use for GAS selection when starting a remote session. The value of this property is preserved over restarts of ThingWorx Platform. Its value is set by running the service of the GASSelectorService Thing Shape.
maxServers	INTEGER	This property specifies the maximum number of Global Access Servers that will handle remote sessions for a ThingWorx Platform. The minimum value is 1, and the default value is 50, which should suffice for most environments. The value of this property is preserved over restarts of ThingWorx Platform.

The GASRemoteAccessProvider Thing provides the following services:

Service	Description	Result Base Type
IsCreateAllowed	Returns true if a new Global Access Server may be created, false if not.	BOOLEAN
EndpointJsonToInfoTable	Converts the JSON-formatted providerConfig of a RemoteEndpoint to an infotable. The required parameter for this service is called providerConfigJson. This parameter is the JSON-formatted providerConfig of the RemoteEndpoint This service creates a GASRemoteEndpointProviderConfig Data Shape, which contains the providerConfig as a ThingWorx infotable.	INFOTABLE
EndpointInfoTableToJson	Converts the providerConfig infotable of a RemoteEndpoint to JSON format. The required parameter for this service is called providerConfigInfoTable. This parameter is the GAS.RemoteEndpointProviderConfig infotable to convert to providerConfig-compatible JSON.	JSON
SessionParametersJsonToInfoTable	Converts JSON-formatted RemoteSessionParameters of the providerConfig to a ThingWorx infotable. The required parameter for this service is called providerConfigJson. This parameter is the JSON-formatted providerConfig of the remote session parameters. This service creates a GAS.SessionParametersProviderConfig Data Shape, which contains the parameters in a ThingWorx infotable.	INFOTABLE
SessionParametersInfoTableToJson	Converts the providerConfig infotable of a RemoteEndpoint to JSON format. The required parameter for this service is called providerConfigInfoTable. This parameter is the GAS.SessionParametersProviderConfig infotable to convert to providerConfig-compatible JSON.	JSON

The runtime permissions that the service to grant permissions for Remote Access grants to this Thing include permissions to run the following services

Service

Description

GetRemoteAccessibleEndpoints

Retrieves the names of the endpoints for device Things that implement the RemoteAccessible Thing Shape and the GASRemoteAccessible Thing Shape.

For a device Thing to be remotely accessible and use the Global Access Server, the Thing must implement both the RemoteAccessible and GASRemoteAccessible Thing Shapes. Note that Axeda agent device Things created from one of the Axeda Thing Templates have these shapes applied automatically, as of v.3.0.0 of the ThingWorx Remote Access Extension (RAE).

GetRemoteServerConfiguration

Returns the JSON serverConfiguration data for the given agentDevice and endpointName. The GASRemoteAccessProvider implementation returns the remoteServerConfiguration data stored in the endpoint property (endpointName) of the given agentDevice.

This service takes two properties: agentDevice, which is the name of the Thing (THINGNAME) and endpointName, which is the name of the remote interface or endpoint of this Thing for remote sessions (a STRING). An example of a remote interface or endpoint is an SSH client.