RemoteAccessServer Thing Shape
The RemoteAccessServer Thing Shape defines properties and services that support the management of Remote Access Server capabilities for each individual remote access server, the Axeda Global Access Server (GAS) or the ThingWorx Global Access Server (GAS).
The following sections explain the properties and services that are defined in the RemoteAccessServer Thing Shape. Click the title of a section to display its content; click the title again to hide the content.
Properties for Remote Access Server Things 
The following table describes the properties provided by the RemoteAccessServer Thing Shape:
Property Name
Description
Base Type
currentNumberOfSessions
Defines the current number of active remote sessions that the Remote Access Server is handling. The aspects for this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
isLogged is set to true, which means that the value is written to the application log file on the ThingWorx Platform.
minimumValue is set to 0 (no sessions).
INTEGER
enabledForRemoteSessions
Specifies whether or not this Remote Access Server can be used to start new remote sessions. The defaultValue is false, which means that it cannot be used to start new remote sessions. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
isLogged is set to true, which means that the value is written to the application log file on the ThingWorx Platform.
BOOLEAN
externalHostName
Specifies the host name or URL for communicating with this Remote Access Server from outside the firewall. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
isReadOnly is set to true, which means that this value cannot be changed in ThingWorx Composer.
STRING
hostName
Specifies the name of the host machine where the Remote Access Server is installed. This host name is used to communicate with the server. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
isReadOnly is set to true, which means that this value cannot be changed in ThingWorx Composer.
STRING
maxSessions
Specifies the maximum number of sessions that this server can host simultaneously. The aspects are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
minimumValue is set to 1 (one session).
isReadOnly is set to true, which means that this value cannot be changed in ThingWorx Composer.
INTEGER
port
Specifies the port to use for connections to this Remote Access Server. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
minimumValue is set to 0 (no HTTP port).
maximumValue is set to 65535 (highest possible port number).
isReadOnly is set to true, which means that this value cannot be changed in ThingWorx Composer.
INTEGER
sslPort
Specifies the port to use for SSL/TLS connections to this Remote Access Server. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
minimumValue is set to 0 (no port).
maximumValue is set to 65535 (highest possible port number).
isReadOnly is set to true, which means that this value cannot be changed in ThingWorx Composer.
INTEGER
online
Specifies whether or not this Remote Access Server is enabled for remote sessions. The defaultValue is false, which means that this server is disabled. The aspects of this property are set as follows:
dataChangeType is set to VALUE, which means that this value is updated every time that it changes.
isPersistent is set to true, which means that the value is stored in the database.
isLogged is set to true, which means that the value is written to the application log file on the ThingWorx Platform.
BOOLEAN
Services of the RemoteAccessServer Thing Shape 
The RemoteAccessServer Thing Shape provides the following services:
Service Name
Description / Parameters
Result
Can Override?
EndSession
Ends the session that matches the specified sessionId, which is required and specifies the unique identifier of the session to be ended.
None
Yes
GetServerHealth
For the ThingWorx Internal Remote Access Server only, returns the state of the server.
The health status of the server (a STRING).
Yes
GetSessionCount
Returns the number of sessions that this server is currently handling.
The number of current sessions (as an INTEGER)
Yes
GetSessions
Returns the sessions that this server is currently handling.
Returns the sessions on this server, as an INFOTABLE, using the RemoteSession Data Shape.
Yes
StartSession
Initiates a remote session for the specified Thing, based on the RemoteSessionParameters that are passed in. This service takes the following parameters:
parameters — Required. The parameters for the remote session that is to be started, as an INFOTABLE, defined using the RemoteSessionParameters Data Shape.
Thing Required. The THINGNAME of the Thing with which to start a remote session. The specified THINGNAME must defined using the RemoteAccessible Thing Shape.
The session ID of the session to be created (as a GUID).
Yes
SetEnabled
Allows setting of the enabledForRemoteSessions property. This service requires the parameter, enabled, as input (a BOOLEAN).
Base type is NOTHING.
Yes
DisableRemoteSessions
Changes the enabledForRemoteSessions property to indicate that this RemoteAccessServer should not be used for new remote sessions.
Base type is NOTHING.
false
EnableRemoteSessions
Updates the enabledForRemoteSessions property to indicate that this RemoteAccessServer should be used for new remote sessions.
Base type is NOTHING.
false
GetCurrentSessionRatio
Returns the ratio of the server's number of current sessions to its maximum number of sessions.
The ratio of current sessions to max sessions, as a NUMBER.
false
Was this helpful?