Administrator Tasks for Remote Access
Remote sessions are supported for both polling devices and continuously connected (AlwaysOn) devices. AlwaysOn devices may be running an Edge application written using a ThingWorx Edge SDK, a ThingWorx Edge MicroServer (EMS), or Lua Script Resource (LSR) behind a WS EMS. Polling devices may be running Axeda eMessage Agents, namely an Axeda Gateway Agent or an Axeda Connector Agent.
Before end users can create remote sessions, a ThingWorx Platform administrator must follow these steps:
 |
If you are a PTC Cloud Services customer using the ThingWorx Axeda Compatibility Package, you do not need to download and install the ThingWorx Remote Access Extension to perform remote sessions. Cloud Services performs this upgrade for you. However, if you are a PTC customer who does not use ACP or subscribe to PTC Cloud Services, you do need to download and install the extension, as explained below.
|
1. If you have not already done so, download the ThingWorx Remote Access Extension (RAE) from the PTC Support site:
a. Go to https://www.ptc.com/en/support/.
b. Scroll down and click the Download Software icon.
c. On the Order or Download Software Updates page, click the Order or Download Software Updates link.
d. On the PTC Software Download page, Step 1, scroll down to and select the link, THINGWORX FOUNDATION.
e. On the Step 2 page, expand the ThingWorx Platform release that you are running, for example, Release 9.3. Then, expand ThingWorx Remote Access Extension.
f. Expand Most Recent Version and select to download Remote Access Extension-v-v-v.zip, where v-v-v represents the latest version, for example, 3-1-3.
2. Log in to ThingWorx Composer and import the ThingWorx Remote Access Extension (RAE), followed by any other extension that may depend on RAE being present first. Two extensions that depend on RAE being present first include the following:
◦ ThingWorx Axeda Compatibility Extension (ACE).
◦ ThingWorx Remote Access and Control Extension, for ThingWorx Asset Advisor
If you need assistance with importing extensions, refer to the detailed steps in the section, Importing Extensions, below.
3. After importing the RAE, navigate to the Subsystems in ThingWorx Composer and ensure that the RemoteAccessSubsystem is installed and running.
4. Import any extension that depends on the RAE, for example, the ThingWorx Apps (ThingWorx Asset Advisor) and the ThingWorx Remote Access and Control Extension for Asset Advisor.
 |
To ensure that your end users and Asset Advisor have the permissions and visibility required to access your devices, follow the instructions in the help center for your version of ThingWorx Apps:
• ThingWorx Apps 8.5 Help Center for version 8.5 of ThingWorx Apps.
• ThingWorx Apps 9.0 Help Center for version 9.0 of ThingWorx Apps.
• ThingWorx Apps 9.1 Help Center for version 9.1 of ThingWorx Apps.
|
5. Configure the appropriate RemoteAccessProvider Thing for the devices:
◦ For devices running the ThingWorx Edge MicroServer (EMS), the Lua Script Resource (LSR), or an Edge SDK application — Select the ThingWorxInternalRemoteAccessProvider Thing.
◦ For Axeda eMessage Agent devices — Select the GASRemoteAccessProvider Thing. For more information, refer to Remote Access for eMessage Agents: GAS Support in the Axeda Compatibility Package Help Center.
6. Ensure that each Thing to be accessed via a remote session implements the RemoteAccessible Thing Shape. For an existing EMS or Edge SDK Thing, you may need to add this Thing Shape. For new EMS and Edge SDK Things, creating the Things with the RemoteThingWithTunnels base template, the RemoteThingWithTunnelsAndFileTransfer Thing Template, or a base template that includes one of these two Thing Templates in its hierarchy assigns the Thing Shape to it automatically. The Thing Templates provided in ACE v.1.2.0 and later of the Axeda Compatibility Package implement a custom Axeda.RemoteAccessble Thing Shape. Any new or existing Axeda Agent device can be represented by a Thing that has a base template set as one of the Thing Templates included in ACE, or a Thing Template that derives from one of the Thing Templates included in ACE will have this Thing Shape automatically after the import of the RAE and ACE extensions.
7. As needed, ensure that endpoints property of a Thing is configured with the desired remote interface, such as SSH, VNC, or Axeda Desktop Viewer. You often do not need to configure endpoints manually for the following reasons:
◦ The Tunnel Configuration for an EMS or Edge SDK Thing provides this configuration. The endpoints property is empty for an EMS or Edge SDK Thing.
◦ The eMessage Agents set the endpoints property when they register with ThingWorx.
8. End users have the following permissions so that they can start a remote session on a RemoteAccessible Thing:
◦ READ on the RemoteAccessible Thing.
◦ PROPERTY READ on the RemoteAccessible Thing.
◦ SERVICE INVOKE on the services for remote sessions, such as StartSession.
To assign end users these permissions, refer to Entity Permissions in the ThingWorx Platform Help Center.
9. To test the ThingWorx Remote Access Client (RAC) with your setup, download the package for your operating system from the ThingWorx Remote Access Client Downloads page and install the client, per the installation process for your operating system. To place additional configuration (such as log4js.json or a config.json), use the appropriate directory for your operating system:
◦ Linux: ~/.config/tw-ra-client.
◦ Windows: %USER_HOME%\AppData\Roaming\tw-ra-client.
◦ Mac OS: ~/Library/Application Support/tw-ra-client.
For more information, see Configuring Data Logging for RAC and Configuring RAC Using a JSON File.
For details about the raClientLinker widget and the RAC, refer to Using the RemoteAccessClientLinker Widget and ThingWorx Remote Access Client (RAC) in this Help Center. For Axeda eMessage Agents, refer to ThingWorx Remote Access Client in the ThingWorx Axeda Compatibility Package Help Center.
Importing Extensions
1. Log in to ThingWorx Composer.
2. From the Import/Export menu of Composer, select Import, as shown here:
3. Under Import Option in the Import window, click the down arrow, and select Extension. The window changes to look like this:
4. Click Browse, and then navigate to the location where you downloaded the ThingWorx Remote Access Extension (RAE) package.
5. Select the RAE archive, and click Open.
6. Once it becomes active in the Import window, click the Import button.
The ThingWorx Platform returns a message, indicating that the import was successful. For more information on what the RAE creates in the ThingWorx Platform, refer to Remote Access Extension (RAE) Entity Reference in the Axeda Compatibility Package Help Center.
Once the RAE import process is complete, the Thing Shapes, Data Shapes, and Things needed for remote access through the ThingWorx Platform are available. You can view them through ThingWorx Composer.
7. If you want to import any other ThingWorx extension that depends on the RAE being installed first, repeat the steps above to import the other extension.
8. Click Close.