RemoteSession Data Shape
The RemoteSession Data Shape defines properties for a remote session. The following table lists and briefly describes the fields defined in this Data Shape. These fields are metadata and not directly used by the implementations. However, they are useful for monitoring and controlling sessions
|
Name
|
Base Type
|
Description
|
||
|---|---|---|---|---|
|
agentDevice
|
THINGNAME
|
Specifies the name of the Thing to which this remote session is connected.
|
||
|
agentIP
|
STRING
|
The IP address of the agent device.
|
||
|
bytesTransferred
|
LONG
|
The number of bytes transferred during the remote session.
|
||
|
createdBy
|
STRING
|
The name of the user who created the session.
|
||
|
createdTime
|
DATETIME
|
The time at which the remote session was created.
|
||
|
endTime
|
DATETIME
|
The time at which the remote session was ended or terminated.
|
||
|
lastActivityTime
|
DATETIME
|
The last time that the ThingWorx Plataform received a status update from either GAS or RAC.
|
||
|
parameters
|
INFOTABLE
|
The parameters provided to the StartSession service when the user started this remote session.
|
||
|
remoteServer
|
THINGNAME
|
The name of the remote access server that is handling this remote session.
|
||
|
sessionId
|
GUID
|
The unique identifier returned from the Remote Access Server for this remote session.
|
||
|
status
|
STRING
|
The status of this session. The status of a remote session transitions through different states during the lifecycle of the remote session. The possible statuses are
• INITIALIZING — State set when the session is first created/persisted in the Remote Access Server.
• CREATED — State set after the session has been created successfully on the Remote Access Server.
• STARTED — State set after the agent has successfully received egress to start the session
• TERMINATED — State set when session is ended. The terminationCause field should be updated.
|
||
|
terminationCause
|
STRING
|
The reason that a remote session was terminated.
|
||
|
userIP
|
STRING
|
The IP address of the user who started this remote session.
|
The RemoteSessionParameters Data Shape defines the ThingWorx Data Table for remote sessions. It provides a CreateSession method that fires a SessionCreated event on the Thing. It also provides a DeleteSession method that fires a SessionCompleted event on the remotely accessible RemoteSession.agentDevice. For both events, a ValueCollection that contains the parameters defined in this Data Shape is built.
Usage
While JSON provides extensibility, the information stored in JSON format is not accessible to mashups. The following conversion methods are provided exclusively to convert to and from providerConfig.JSON. Do not use them for any other JSON-formatted files.
• EndpointJsonToInfoTable
• EndpointInfoTableToJson
• SessionParametersJsonToInfoTable
• SessionParametersInfoTableToJson