RemoteAccessible Thing Shape

Extensions Reference > Remote Access Extension (RAE) Entity Reference > RAE Thing Shapes > RemoteAccessible Thing Shape

The RemoteAccessible Thing Shape provides properties, events, and services to Axeda remote Things on which the agent is configured for remote access. This Thing Shape also provides the ability to persist server version information.

Properties

This Thing Shape adds the providerName property to any Thing that implements it. This property specifies the RemoteAccessProvider for a Thing and has a base type of THINGNAME. Its aspects include:

• dataChangeType — The setting, VALUE, means that this property is written to when the value changes.

• isPersistent — The setting, true, means that the property value is stored in the database.

• thingShape — The setting, RemoteAccessProvider, means that this Thing Shape inherits the services of the RemoteAccessProvider Thing Shape.

This Thing Shape also provides the ability to persist server version information., with the following properties:

RemoteServerConfiguration Data Shape Properties

Property Name

Base Type

Description

Example

endpointName

STRING

Name of the endpoint (remote interface) for which this server configuration applies

Desktop

serverConfiguration

JSON

Server configuration data

{
"applicationName""AxedaDesktopServer",
"version":"6.8.209",
"protocolVersion":"1",
"os":"Windows"
}

For the initial release of the Remote Access Extension, this property is specific to the Axeda Desktop Server that handles remote sessions for an Axeda eMessage Agent that is running on the same machine.

Events

The RemoteAccessible Thing Shape has two events, SessionCreated and SessionCompleted. The triggering of either event generates an audit entry being logged that contains session information. If you want to search for these events, specify the Audit category, REMOTE_ACCESS.

This Thing Shape provides an Event definition, called SessionUpdated. This event is fired when a session for this Thing is updated. The Data Shape that defines the event is the RemoteSessionEvent Data Shape.

Services

The RemoteAccessible Thing Shape provides the following services that you can run against a Thing that implements this Thing Shape:

Service Name

Description

Parameters

EndSession

Terminates the session associated with the provided identifier.

REQUIRED. sessionId, which is he unique identifier (ID) of the session that is to be terminated. The base type of this parameter is GUID.

GetSession

Retrieves the session that matches the specified ID for this Thing. The result of this service is a remote session that matches the given session ID, returned as an INFOTABLE. The result implements the RemoteSession Data Shape..

REQUIRED. sessionID. which is the unique identifier of the session to retrieve.

GetSessions

Returns all current remote sessions that were started on this RemoteAccessible Thing. It does not return past remote sessions or sessions that have failed. If a remote session has failed, then it was terminated. Terminated sessions are removed from the storage of the RemoteAccess Subsystem The result is an INFOTABLE of the remote sessions for this Thing. The result implements the RemoteSession Data Shape..

None

HandleSessionUpdated

Called when the session for this Thing is updated. The isAllowOverride setting for this service is true.

If a CLOSE_REQUESTED status change is detected for a remote session, this service will call the EndSesssion service. The service on this generic RemoteAccessible Thing Shape calls the service for ThingWorxInternalRemoteAccessProvider sessions only. The Axeda.RemoteAccessible Thing Shape calls this service for GASRemoteAccessProvider and TASRemoteAccessProvider sessions.

REQUIRED. sessionEvent, which contains the session that has been updated. This parameter implements the RemoteSessionEvent Data Shape..

StartSession

Tells the platform to prepare a remote session for this Thing and passes in the parameters for the session that will be started. The result of this service is the unique identifier of the session that is created. The base type of the result is GUID.

REQUIRED. parameters, of base type INFOTABLE, which implements the RemoteSessionParameters Data Shape.

AssignEndpoints

Assigns a remote endpoint to this Thing. Its result is of base type INFOTABLE and implements the RemoteEndpoint Data Shape.

REQUIRED. endpoints of base type INFOTABLE, which implements the RemoteEndpoint Data Shape.

GetRemoteAccessibleEndpoints

Run on a Thing from ThingWorx Composer, this service retrieves the endpoints available on this device. The result is an INFOTABLE from the RemoteEndpoint Data Shape that contains the endpoints for the device.

None

ProcessRemoteServerUpdate

Updates the property row in the INFOTABLE of the Thing Shape, using the endpointName as the key and sets the configuration for the remote server.

REQUIRED: endpointName (a STRING) and serverConfiguration (base type JSON).

GetRemoteServerConfiguration

Retrieves the server configuration for the specified endpoint for this Thing. The result is JSON-formatted.

REQUIRED: endpointName (a STRING)

Event Definitions

The RemoteAccessible Thing Shape contains the following events:

Event	Description
SessionUpdated	This event is fired when a session for this Thing is updated. The event data uses the RemoteSessionEvent Data Shape.
SessionCreated	This event is fired when a session for this Thing is created. This event is recorded in the Audit Subsystem of ThingWorx Platform. The Audit category for this event is RemoteAccess.
SessionCompleted	This event is fired when a session for this Thing is completed. This event is recorded in the Audit Subsystem of ThingWorx Platform. The Audit category for this event is RemoteAccess.