Waiting for engine...
Skip to main content

Creating a local project

Create a local connector project to start building a connector.

Before you begin​

Ensure that you've setup your development environment.

About this task​

This task provides an overview of how to create a structured, local connector project (Java project) for your connector.

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.

To create a project with Gradle, you can refer to Gradle's Building Java Applications Sample.

Alternatively, you can use an IDE, for example, IntelliJ IDEA to setup and initialize the project for you:

Open your IDE and define your project:

  1. Your project name. Do not use any spaces.

  2. Confirm the location of your project.

  3. Select Java as the project language.

  4. Select Gradle as your build system. Gradle 7.0 or higher is required.

  5. Point to a Java 8 JDK. If needed, download the appropriate JDK from your preferred vendor.

  6. Select Groovy as the Gradle DSL.

  7. In the Advanced Settings, mention the GroupId and ArtifactId details.

  8. Create the project.

    NewGradleProject
    Example from IntelliJ IDEA

You can download Boomi's sample project to get started. This sample project has a few placeholder files. Specifically, a Java class to represent the core Connector class, and skeleton platform or runtime configuration files.


Building the project​

  1. Boomi recommends that you use the Gradle plugin to manage the dependencies and build your project. The plugin streamlines and simplifies connector development. The Readme.md file in the repo has all the details that you need to configure your build.gradle file.


    Basic structure of the build.gradle file:
    plugins {                    
        id 'com.boomi.connector' version '0.4.3'                        
    }

    connector {
        sdkVersion '<latest-connector-sdk-version>'                                                   
        className 'com.boomi.sample.SampleConnector'
        // If you're building an OpenAPI connector using Gradle DSL plugin, you need not mention this className. 
        // The DSL has an internal Java class that it refers to.
    }

    dependencies {
        api "com.boomi.connsdk:connector-sdk-util"
        api "commons-io:commons-io:2.8.0"
        implementation "com.boomi.util:boomi-util:2.3.8"
        testImplementation "junit:junit:4.12"
    }

  2. After setting up your build.gradle file, ensure that you are in the base directory of the project where the gradlew/gradlew.bat file is located.

  3. To build all the necessary files for your connector, run ./gradlew build command in your terminal window.

  4. The connector archive (*.car) file should be created in the build/distributions directory.

    This task ensures that you've created a local project and can go ahead developing the connector based on the framework you choose.

    createLocalGradleProject

Next steps​

Use the resulting project to start developing a connector:

  • The skeleton project includes the Java package inside which you can start implementing the Connector interfaces.
  • Add the base class to the connector-config.xml file.
  • Configure the connector-descriptor.xml file based on your connector requirements.
  • To learn more about the Connector SDK artifact content and the required components, review the Connector SDK artifacts.
On this Page