ThingWorx Edge Java SDK > Installing and Navigating the Directories of the Edge Java SDK
Installing and Navigating the Directories of the Edge Java SDK
To download the latest distribution bundle of the ThingWorx Edge Java SDK, follow these steps:
1. The distribution bundle for ThingWorx Edge Java SDK is available through the PTC Support site, Order or Download Software Updates page, at If you are not already logged in to the PTC Support site, you are prompted to log in before access to this page is granted.
2. On the Order or Download Software Updates page, click the link appropriate to your situation:
Download Software by Sales Order Number — if you are downloading for the first time and have your Sales Order Number (SON).
Order or Download Software Updates — if you have a support agreement with PTC that allows software downloads.
3. Either way, on the Customer Search page, enter your Customer Name and Customer Number and click Next.
4. If you chose to download by SON, enter your SON in the page that appears, and click Submit. Otherwise, continue to the next step.
5. On the PTC Software Download Step 2 page, select the product family, THINGWORX EDGE SDK, as shown here:
6. Click the plus sign to expand Release SDKs.
7. Expand the ThingWorx Edge SDK node to display the options for choosing a release:
8. Depending on whether you want a new or previous release, this step varies:
For a new release, expand the Most Recent Datecode node.
For previous releases, expand the Show all Other Available Datecodes node.
9. Depending on whether you want a new or previous release, this step varies:
Under Most Recent Datecode, locate the distribution zip file, C-SDK-v-v-v-b, where v-v-v is the release number and b is the build number,
Under Show all Other Available Datecodes, expand the Datecode nodes until you see the desired distribution zip file, C-SDK-v-v-v-b.
10. Click the Download now link, HTTPS. If you want to compare checksums, clickView SHA-256 checksum and select to copy the checksum to your computer's clipboard.
11. Select a location for extracting the distribution bundle, and unzip it.
12. To verify the installation, continue to the next section, which briefly describes the contents of the installation..
Directories and Files
The Java SDK installation contains the following directories:
doc — Contains the PDFs of the developer’s guide and release notes. The /html subdirectory contains the HTML files for the javadoc for this SDK.
entities — Contains the export file (ExampleExport.xml) that has the example entities that are referenced by the sample code used in this document.
lib — Contains the JARs listed in the table below. These JAR files are all of the Java Dependencies for applications written using the Java Edge SDK.
samples — Contains the samples project. as well as the Java source files and logback template for the examples used in this document (samples/resources). For example, the SteamSensor source files are located in samples/src/com/thingworx/sdk/steam/.
Contents of the lib Directory
File Name
Sample Applications
Building and running the Simple Thing Client and Simple Client applications requires Gradle. If you do not have Gradle, refer to Setting Up to Run Sample Applications.
The samples directory contains the samples project and the source files for the sample applications referenced in this document:
The samples/src/com/thingworx/sdk/steam subdirectory contains the Steam Sensor example code files ( and that you should examine before attempting your own application. The SteamSensorClient can be compiled and run from the samples directory, using the following command:
../gradle runClient -PmainClass=com.thingworx.sdk.steam.SteamSensorClient
--args="ws://localhost:80/Thingworx/WS xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 1000 1 10
. Its connection settings are in the build.gradle file in the samples directory.
The samples/src/com/thingworx/sdk/simple contains the source file, Snippets from this file are used to illustrate how to implement the basics in the topics listed below. The last topic in this series explains how to modify this source file to run it against your ThingWorx Platform:
1. Connecting an Application to the ThingWorx Platform
2. Reading a Property
3. Writing a Property
4. Invoking a Service
5. Firing Events
6. Running the SimpleClient Application
samples/src/com/thingworx/sdk/simple also contains source files for a file transfer ( example and for a tunneling example ( Snippets from these examples are used in Configuring File Transfers and Tunneling. Before running the file transfer example, review the instructions, in Configuring File Transfers.
samples/src/com/thingworx/sdk/simplething contains the source files for the Simple Thing Client application, and Snippets from these files are used to illustrate how to implement a client that uses binding, creates a service that can be invoked from the server, defines properties using annotations, in the topics listed below. The last topic in this series explains how to modify the source file to run it against your ThingWorx Platform: