AxedaRemoteViewerManager Thing
The AxedaRemoteViewerManager provides the management of the remotely provided Remote Viewer Applications for remote sessions. For the AxedaRemoteViewerManager Thing to exist you must first have imported the Remote Access Extension (RAE) and then the Axeda Compatibility Extension (ACE). .
To use Axeda Desktop Viewer through ThingWorx, configure the externalApplicationServerURL property to point to the base URL for the remote server that hosts the Axeda Desktop Viewers. The file, viewerIndex.json, is expected to exist at that location. This file provides the metadata on the hosted viewers at this location.
Properties
This Thing implements the RemoteSessionViewer Data Shape, which is an infotable that provides the following properties for a remote viewer application, such as Axeda Desktop Viewer:
|
Property Name
|
Base Type
|
Description
|
Example
|
|---|---|---|---|
|
endpointName
|
STRING
|
Contains the name of the remote viewer application
|
Desktop
|
|
externalApplicationServerURL
|
STRING
|
Set this property to be the base URL for the remote server that hosts the remote viewers.
|
|
|
downloadPath
|
STRING
|
The path of the ExternalApplicationServerURL from which to download this viewer.
|
viewers/AxedaDesktopViewer_v68209.exe
|
|
os
|
STRING
|
The operating system supported for this viewer
|
Windows
|
|
default
|
BOOLEAN
|
Should this application be used as the default viewer, even if the serverConfiguration does not match?
|
true
|
|
serverConfiguration
|
JSON
|
Data to be used for configuration matching
|
["protocolVersion":2 "name":"AxedaDesktopServer"]
|
|
clientConfiguration
|
JSON
|
Configuration data to be returned along with the calculated downloadURL
|
{
"version": "6.8.209" "launchCommand": "\"<$DOWNLOAD_TO>\\AxedaDesktopViewer_v68209.exe\" <$HOST>:<$PORT>" } |
Services
The AxedaRemoteViewerManager Thing provides the following services:
• RefreshExternalApplicationCache — Loads the viewerIndex.json from the remote server into the local property cache. No actions are performed if the RemoteViewerManager Thing is disabled.
 |
To protect the system, the maximum size of the viewerIndex.json file that can be loaded from an external server is 50 KB.
|
• GetEndpointViewerConfiguration — Matches the input parameters to a matching viewer and returns a JSON element with the calculated download URL (the externalApplicationServerURL plus relativePath. and any client configuration fields from the matched viewer entry. If nothing matches or configuration data is null, returns the default for endpointName plus clientOS. Otherwise, the service returns an empty JSON element.
This service takes the following parameters:
◦ endpointName (a String)
◦ clientOS (a String)
◦ serverConfiguration (JSON)
The RemoteViewerManager Thing invokes the RefreshExternalApplicationCache service automatically when a Thing starts.
You should define a Timer Thing to invoke the RefreshExternalApplicationCache service once a day.