Setting up the development environment

As a developer, set up your environment, so you can build, test, and deploy a connector built using the Connector SDK. You only need to set up this environment once, and then you can use it for future connector development.

Download and install the Java Development Kit (JDK)

1. Download and install the JDK version 8 applicable for your computer operating system. You can also download the JDK from Corretto or Zulu.

   tip

   To download the exact version of JDK, check your system settings to identify the device specification. For MacOS, from the Apple icon menu, choose About This Mac:

   • For Apple M1, M2, or M3, you need the ARM64 DMG installer.

   • For Apple Intel, you need the x64 installer.

   Similarly, for Windows, x64 is for 64-bit and x86 is for 32-bit operating systems.

2. Ensure that you update your JAVA_HOME environment variable to point to where the JDK software is installed.

   For example:

   export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-1.8.jdk/Contents/Home
   export PATH=$PATH:$JAVA_HOME

3. If applicable, configure your IDE to reference the location of your JDK. Refer to your IDE documentation for instructions.

Set up your environment

You can set up your environment with the toolkit of your choice. The steps may vary based on your selected toolkit.

important

Boomi highly recommends using Gradle to manage the dependencies. Our Gradle plugin provides the connectorHelloWorldSource task that generates a sample connector code for you to get started. Also, to build a connector that leverages a known OpenAPI specification, you can use our Gradle DSL plugin and get started.

On the other hand, Maven doesn't generate any sample connector code.

Gradle

To set Gradle as the dependency manager, refer to the Gradle installation instructions.

Validate that Gradle is installed and configured correctly by calling gradle -v and confirming the output matches what you expect for your system. If applicable, configure your IDE to reference the location of your Gradle installation. See your third-party documentation for instructions.

Apache Maven

1. To set up Apache Maven as the build tool, refer to the Apache Maven download page and follow the installation instructions.

2. Validate the installation by running mvn -version command in your terminal or command window.

3. Point Maven to the Boomi repository so that it fetches the artifacts.

important

It's important to add the repositories to the settings.xml file, else Maven can't find the necessary artifacts.

Add the Boomi repository URL (https://boomisdk.s3.amazonaws.com/releases) to the settings.xml file of your Maven installation. For example, /yourLocalDrive/apache-maven-3.9.6/conf/settings.xml

To add Boomi repositories to the settings.xml file and to activate that particular profile, follow the instructions as per the Maven documentation.

Next steps

Now that all the required installations are complete, start creating a local project to build a connector.