GASModel Thing Template

Extensions Reference > Remote Access Extension (RAE) Entity Reference > RAE Thing Templates > GASModel Thing Template

The GASModel Thing Template represents a ThingWorx Global Access Server (GAS), v.7.x, that can also serve the Axeda Global Access Server, v.6.9.2/v.6.9.3. As of v.7.1,x, the GAS offloads remote sessions for Axeda eMessage agents from ThingWorx Platform.

The GASModel Thing Template is derived from the RemoteThing Thing Template and is not editable. This Thing Template implements the RemoteAccessServer Thing Shape, which provides the properties and services for the Things derived from the GASModel Thing Template.

When GAS registers with an eMessage Connector, the GAS Thing is created. from Thing Template. While this Thing is automatically created, it is not automatically enabled. To enable a GAS, run the enableRemoteSessions service. This service sets the property enabledForRemoteSessions to true. To toggle the property off, run the disableRemoteSessions service.

To reset or clear an invalid token for a GAS, run the ClearToken service of the GAS Thing that is derived from this Thing Template.

The GASModel Thing Template implements the RemoteAccessServer Thing Shape. The RemoteAccessServer Thing Shape provides properties for the GAS configuration as well as services for a GAS Thing.

In addition, the GASModel Thing Template implements the permissions for remote access in ThingWorx and the ConnectionSettings configuration table, which stores the GAS connection settings as defined by the GASModelConnectionSettings Data Shape.

The GASModel Thing Template provides the following properties in addition to the properties it inherits from the RemoteAccessServer Thing Shape. These properties are configuration settings for a Global Access Server instance and are read-only:

Property Name	Description
category	The mode of operation for this Global Access Server. The valid values are: • 0 for standalone • 1 for hosted
directPort	The port for the direct socket connection for non-SSL/TLS communications. When the specified HTTP port is blocked, this port is used. The range of port numbers is from 0 to 65535.
directSslPort	The port for the direct socket connection for SSL/TLS communications When the specified HTTPS port is blocked, this port is used. The range of port numbers is from 0 to 65535.
raServerName	The name assigned to the Global Access Server.
raDescription	The description of this Global Access Server.
alternateHostName	The Alternate User IP address of the GAS to be set for networks with special requirements, but otherwise can be blank. If this address is blank, the user can select either the Internal or External address when the remote session is established. If the Alternate User address is defined, then the user session is always forced to use the specified Alternate User address for remote session.
token	The authentication token for the GAS.
tokenInvalid	Is the authentication token valid? The default value is false.
firstRegistrationDate	The date on which this Global Access Server first registered itself.
latestRegistrationDate	The most recent date on which this GAS registered itself.
timezoneName	The time zone offset for this GAS. The offset is the number of hours ahead of or behind Greenwich Mean Time (GMT). For example, Central Standard Time is 6 hours behind GMT. To use CST, type 6:00 (US) or 6.00 (EU); Katmandu is 5 hours and 45 minutes ahead of GMT, so to use Katmandu, type 5:45 (US) or 5.45 (EU).
version	The version of the GAS. For example, 7.1.0.

The GASModel Thing Template provides the following services in addition to the services it inherits from the RemoteAccessServer Thing Shape:

Service Name	Description
ClearToken	Clear the current value of the authentication token.
StartSession	Starts a remote session on this Global Access Server (GAS). This service checks permissions to the Thing and to this service. If the permissions check passes, a sessionId is generated and the session is initialized. The services builds an infotable using parameters defined by the RemoteSession Data Shape. This service will throw an exception if any error occurs. If successful, the service returns the sessionId, which must be used when running the EndSession service.

Service Name

Description

ClearToken

Clear the current value of the authentication token.

StartSession

Starts a remote session on this Global Access Server (GAS). This service checks permissions to the Thing and to this service. If the permissions check passes, a sessionId is generated and the session is initialized. The services builds an infotable using parameters defined by the RemoteSession Data Shape. This service will throw an exception if any error occurs. If successful, the service returns the sessionId, which must be used when running the EndSession service.

To be consistent with the Axeda Platform, the following query parameters are set for the StartSession service invoked for a remote session with an Axeda eMessage agent:

• device — derived from the serialNumber property of the Thing.

• agend-device — derived from the serialNumber property of the Thing.

• server-id — the name of the GAS.

• launch-option — the value of the launchOption property of the endpointConfig. This property defines how the session is launched.

• connection — the value of the connectionString, which is derived by parsing the connection information provided in the endpointConfig.