Connector Development FAQ
Getting Started with Connector Development
What is a Boomi Connector?
Connectors are the main component that facilitates integration and contain all the information needed to connect to a data source or application. Boomi allows its customers/partners to build connectors using its Connector SDK.
What is the need for building a new Connector?
Boomi provides 300+ connectors and its customers have already connected more than 1000+ unique endpoints. To facilitate integration to applications that are not supported by existing connectors, you can build your connector according to your requirements. The SDK provides all the tools and libraries required for connector development.
What are the Business benefits of building Connectors?
Connectors help accelerate the integration development and thereby provide you with a faster go-to-market for products/solutions. Reusability and less maintenance are their other key benefits.
What are the Technical advantages of building Connectors?
Connectors facilitate a connection to a system/endpoint easily and securely. They provide an abstraction to the internal details and integrate systems in a faster low-code fashion.
How long does it take to build a connector?
After you enroll in Boomi, there is not a hard and fast timeline to build a connector. Ideally, it may take 2-3 months.
Is there a quick option available to build a Connector, maybe within a month?
You could build Connectors quickly using the Gradle DSL plugin. It is one of the fastest ways to build from an OpenAPI specification and this approach cuts down the development time significantly (~80%) from a custom SDK development approach. Using the OpenAPI Domain Specific Language (DSL) framework allows you to map OpenAPI REST-based language endpoints to a user-friendly integration developer experience.
Where can I find the details of the Gradle DSL plugin? Is there any documentation available?
What kind of support can I expect from Boomi while I build a connector?
Boomi provides the necessary documentation, links, SDK, and libraries to build connectors. If you are a partner, you also get a dedicated Boomi Enterprise Platform Access, Bitbucket Repository and can reach out to a TPP Technical Lead / Manager for any questions during the building process.
How difficult is it to build a Connector?
Generally, a proficient Java developer with good knowledge of REST/SOAP protocols, XML/JSON, API principles, and API Authentication methods can build connectors pretty easily. If you use an OpenAPI Framework, your build time could be up to 80% less.
What are the key components of a Connector?
Connectors are a combination of two components:
-
Connection — The physical connection information; you define the URL of a data source or application, and provide credentials to access it.
-
Operation — The function to call or files to act upon; how to process the data.
Where can I find the detailed documentation on How to build a Connector?
To learn more about building a connector, refer to Developing connector.
Is there any community or a forum for discussions on topics related to Connector Development?
Yes. There is a dedicated community for Connectors on the Boomiverse website:
How do I ensure that the connector I am planning to build is not already present in the Boomi Enterprise Platform?
You can find the list of available connectors in the Boomi connectors catalog. If the connector you're looking for does not appear in the list, consider it unavailable.
Do you allow us to build a Connector that is already present in the Boomi Enterprise Platform?
Yes. Boomi allows multiple connectors for any given application, provided it has some differentiating/advanced feature(s) compared to the currently available connector.
Do I need to buy a Boomi Enterprise Platform license to build a Connector?
No. You can build a connector using a free trial account.
Do you provide us with any tools to build a Connector?
Yes. You can leverage the Boomi Connector SDK to build a Connector.
Do I need to sign any agreement with Boomi to build a Connector?
Yes. As part of the connector development process, you have to accept the SDK usage agreement with Boomi.
What kind of skills are required to build a Connector?
The Connector SDK is written in Java, so a developer requires Java development experience. Developers must have expertise with HTTP, REST, and API Authentication protocols depending on the technology or application you are connecting to. If you are trying to connect to an application that provides an OpenAPI specification, then you would just need some basic OpenAPI specification knowledge in order to use the Gradle DSL plugin.
Do you support REST and/or SOAP-based target services (endpoint APIs) for building Connectors?
Yes. Boomi supports the creation of Connectors based on the REST and SOAP endpoints. Please refer to the latest 3rd party applications (endpoints) documentation before starting Connector development. You can leverage Boomi SOAP Framework to enable easy integration with any SOAP-based web service.
Alternatively, you can also use our technology connectors to integrate to your API endpoints:
Where can I find the Boomi SOAP Framework?
To learn more about SOAP Framework, refer to Boomi SOAP framework.
Do you have any best practice documents for building Connectors?
Yes. Refer to the design considerations and best practices.
What is the difference between Private and Public Connectors?
Private Connectors are those that are visible/available within your Boomi Enterprise Platform account. They are not visible/usable to other Boomi customers. It is private to the account that built it. Where as, Public connectors are those which are available to all Boomi customers regardless of who built them.
Do you allow us to keep the Connector built by us Private and not Public?
Yes. you could either build a Connector for your internal use (PRIVATE) or make it available to others by making it PUBLIC.
Where can I find the latest SDK API Version?
You can find it in the SDK changelog. Boomi recommends you to build a connector with the latest Connector SDK version, but you need not update connectors when the SDK is updated. The API is backward compatible with all Connector SDK releases with the same major API version.
Advanced FAQs
We don't have enough time to build a connector because our customers want to start integrating with our systems using Boomi as soon as possible. Are there any other options?
Yes. Boomi provides Technology Connectors like HTTPS Clients, SOAP Clients, Databases, etc. to customers for using and integrating them.
We have to place our company logo in the connector, will it be possible to do that?
Yes, Partners have to share their company logo while they are submitting their connectors.
Is it mandatory for a connector development project to be a Gradle or Maven project only?
Yes. Currently, the Automated review scan mandates the project to be either built on Maven or Gradle.
Boomi Guidance: Gradle is considered to be an advanced build tool as compared to Maven. Our recommendation to partners is to use Gradle but it all depends on your comfort level and your team's preferences.
Can I implement conditional fields on the connections, operations tab, etc. of a connector?
Yes. You could implement conditional fields to the connections, operations, and Import Wizard pages of a connector. For more details about the implementation, refer to Configuring conditional fields.
What are the files I am supposed to upload to Boomi Enterprise Platform as a part of the Connector building process?
There are two files that you are supposed to upload to Boomi Enterprise Platform.
-
connector-descriptor.xml -
<connector_name>-car.zip
Can I have conditional fields in the Operations Import Wizard?
Yes. Connector SDK supports conditionally visible fields in connection, operations, and import wizards.
Can I have the Content of the field changed based on the selection of another drop-down field in the Operation Import Wizard?
No. SDK does not support dictating the content of the drop-down list based on the value selected in another drop-down list.
How do I publish my connector?
Consider becoming a Boomi Partner.
