Install prerequisites and the SDK

1. Install the JDK

The Data Management SDK relies on the Java Development Kit. Version 1.8 is the required minimum. Check your Java installation by launching a command prompt and running the following command:

JAVA

>java -version

You should see output similar to the following:

JAVA

openjdk version "1.8.0_262"
OpenJDK Runtime Environment (AdoptOpenJDK)(build 1.8.0_262-b10)
OpenJDK 64-Bit Server VM (AdoptOpenJDK)(build 25.262-b10, mixed mode)

If instead you see:

'java' is not recognized as an internal or external command, operable program or batch file.
...you should ensure that Java is installed, JAVA_HOME has been set, and JAVA_HOME has been added to your PATH.
A java version less than 1.8, you'll need to upgrade your Java installation to version 1.8.

You can download the latest JDK 1.8 update from AdoptOpenJDK.

2. Install Maven

This step is optional. Many Java IDEs already bundle Maven, but you may want a standalone Maven installation that can be run from the command line.

3. Install an IDE

This guide will cover working with Eclipse and NetBeans, but you may use whichever Java IDE you prefer. Be sure the chosen IDE is installed before continuing this tutorial.

4. Install Data Management

To test your tools, you'll need a working Data Management installation, version 8.0 or later (8.2 recommended).

If you have an existing server installation, you can develop locally and then deploy your tool to the server. You may find this model cumbersome, however.

If you plan to create a new local installation on your workstation, download the Windows installer for Data Management from the Support portal.

You will need a license to run Data Management. You can request a license from Redpoint Support.

5. Install the SDK sample pack

Download the SDK sample pack from the Redpoint Support portal and unzip to your preferred location (for example, c:\dmsdk). We'll refer to this location as %SDK_HOME% throughout this documentation.

The Data Management SDK is distributed with Redpoint Data Management (RPDM). When you install RPDM, a JAR file called something like rpdmsdk-MAJOR_VERSION.MINOR_VERSION-SNAPSHOT-shaded.jar is installed in %RPDM_HOME%\java (for example, C:\Program Files\RedPointDM8\java\rpdmsdk-8.1-SNAPSHOT-shaded.jar). Copy the file rpdmsdk-MAJOR_VERSION.MINOR_VERSION-SNAPSHOT-shaded.jar to %SDK_HOME%\lib (i.e. c:\dmsdk\lib\rpdmsdk-8.1-SNAPSHOT-shaded.jar).

Finally, open the file %SDK_HOME%\pom.xml and search for <systemPath>. Edit the <systemPath>${project.basedir} value to the location and file name of the JAR you copied, for example:<systemPath>${project.basedir}/lib/rpdmsdk-8.1-SNAPSHOT-shaded.jar</systemPath>.

From here, you can read about Working with the SDK samples and Exploring the sample project, or Concepts and terms, Understanding the Tool lifecycle, and Supported tool types.