GASRemoteAccessible Thing Shape
The GASRemoteAccessible Thing Shape provides the GAS-specific properties and services to Axeda Agent Things that are accessible by the Global Access Server for remote sessions.
 |
The RemoteAccessible Thing Shape provides all of the properties, events, and services needed for remote sessions with ThingWorx Edge C SDK Agents that implement the ThingWorx Edge Remote Session Edge Extension (RSEE) while continuing to support ThingWorx Edge SDK and EMS tunneling.
|
endpoints Property
The GASRemoteAccessible Thing Shape provides the ability to persist GAS version information with the endpoints property. This property is an INFOTABLE that contains a list of remote interfaces supported by the Thing. When an Axeda Gateway or Connector Agent registers with the eMessage Connector, it sends its configuration for remote sessions. For eMessage Agents, this configuration is the remote interfaces defined in the Agent xgRcon.xml or ERcon.xml configuration file, which is generated by Axeda Builder based on settings in its Remote Sessions Settings dialog boxes. Examples of remote interfaces are an SSH terminal and an Axeda Desktop Viewer.
GAS Pinning Properties
|
Property
|
Description
|
Base Type
|
Default Value
|
||
|
isPinningEnabled
|
A Boolean property that specifies whether pinning is enabled. By default, this property is set to False and pinning is disabled.
|
BOOLEAN
|
False
|
||
|
pinningType
|
A THINGNAME property. The value can be a name of thing which implements GASPinningType ThingShape. Options:
• CountryPinning
• RegionPinning
• ManualPinning
|
THINGNAME
|
CountryPinning
|
||
|
pinnedCountries
|
An infotable that is defined using the GASCountryDS Data Shape. It contains a list of countries that are pinned by user and is used when pinningType is set to CountryPinning.
|
INFOTABLE
|
N/A
|
||
|
pinnedRegions
|
An infotable that is defined using the GASRegionDS Data Shape. It contains a list of regions that are pinned by user and is used when pinningType is set to RegionPinning.
|
INFOTABLE
|
N/A
|
||
|
pinnedGASList
|
An infotable that contains a list of GAS server Thing names. This infotable is used when pinningType is set to ManualPinning
|
INFOTABLE
|
N/A
|
Services
The GASRemoteAccessible Thing Shape provides the following services:
|
Service Name
|
Description
|
Parameters
|
|---|---|---|
|
ConnectToSession
|
Enqueues the connect-to-remote-session egress message to send to the agent.
|
REQUIRED: session parameter, which is of base type INFOTABLE and implements the .RemoteSession Data Shape. The optional property, gasSessionConfig, is also of base type INFOTABLE and implements the the GASSessionConfig Data Shape.
|
|
PinCountry
|
Pins the remote Thing to a country by adding a country value to the pinnedCountries property.
|
country (Required)—A string that contains a valid country name that is defined in the GASCountriesTable Data Table.
|
|
UnpinCountry
|
Unpins the remote Thing from a country by removing the country value from the pinnedCountries property.
|
country (Required)—A string that contains a valid country name that is defined in the GASCountriesTable Data Table.
|
|
PinRegion
|
Pins the remote Thing to a region by adding a region value to the pinnedRegions property.
|
region (Required)—A string that contains a valid region name that is defined in the GASRegionsTable Data Table.
|
|
UnpinRegion
|
Unpins the remote Thing from a region by removing the region value from the pinnedRegions property.
|
region (Required)—A string that contains a valid region name that is defined in the GASRegionsTable Data Table.
|
|
PinGASThing
|
Pins the remote Thing to a specific GAS by adding a GAS Thing name value to the pinnedGASList property.
|
thingName (Required)—A THINGNAME value that contains a valid GAS server name.
|
|
FetchAndAddGASFromCountryToList
|
Pins all GASModel Things with a country value equal to the input by adding their thingName to the pinnedGASList property. For example, if you have multiple GAS servers are pinned to a specific country like the USA, you can use this service to pin all GAS server names to the remote Thing.
|
country (Required)—A string that contains a valid country name that is defined in the GASCountriesTable Data Table.
|
|
FetchAndAddGASFromRegionToList
|
Pins all GASModel Things with a region value equal to the input by adding their thingName to the pinnedGASList property.
|
region (Required)—A string that contains a valid region name that is defined in the GASRegionsTable Data Table.
|