Elektron SDK - Java

API Family: Elektron

ESDK Build System

Last update May 2018
Environment Windows, Linux
Prerequisites Download and install the Gradle Build Tool for your system environment

Internet Access - required for Gradle

Introduction

Prior versions of the ESDK (Elektron SDK) for Java utilized the packaged Java Archive (JAR) files and their dependencies . Developers optionally built their applications using the packaged build.xml file and a script (in ANT).  As of ESDK Version 1.2, the package continues to include JAR files, but Maven Central also hosts them.  Additionally in 1.2, the ANT build is replaced by a build system powered by Gradle.   Gradle is a powerful, open-source build automatiion tool that is used to build and execute the ESDK examples.  For a detailed explanation of the ESDK build system, refer to the Migration Guide outlined within either the Elektron Message API or Elektron Transport API documentation packages.

The purpose of this guide is to establish a build environment necessary to build and run the packaged examples within ESDK.

In this guide, we will walk through the steps to:

  • Download the ESDK package
  • Setup the build environment using Gradle

Steps apply to both the Windows and Linux environments.

Download the ESDK

The Elektron Message API (EMA) and Elektron Transport API (ETA) products are included as part of the ESDK package.  To access the package, navigate to the Elektron SDK - Java webpage within the Developer Portal.  Within the Downloads tab, choose the latest version and and uncompress within a directory of your choosing. 

Note: Ensure your installation directory has write privileges as required by Gradle.

Once extracted, the root of your ESDK should look like the following:

Verify the build environment - Gradle

Ensure you have downloaded and installed the Gradle utility within your environment.  Once installed, you are ready to verify your build environment by listing the ESDK packaged examples. Navigate to the ESDK root folder to verify these tests.  For example: Elektron-SDK1.2.0.java.rrg/Java :


EMA Examples

EMA Logging - Enable

Before verifying the build environment, you can optionally enable logging when running EMA examples.  To enable logging, you will need to modify the build.gradle file located within the <ESDK root>/Ema/Examples directory.

Uncomment the lines within the hilighted segment below:

From the root folder, list all EMA examples within the ESDK package using Gradle:

> gradlew Ema:Examples:tasks --all

And an example of the output:

Once Gradle has verified the listings, you are ready to execute any of the available examples within your product of interest.  Refer to the ETA QuickStart and EMA QuickStart guides.


ETA Examples

From the root folder, list all ETA examples within the ESDK package using Gradle:

> gradlew Eta:Applications:tasks --all

And an example of the output: