Custom connectors: documenting your connector

Blog Post created by john_george Employee on Nov 15, 2017

The Connector SDK and its companion Javadoc enable the development of custom connectors that leverage the AtomSphere Connector API. After you develop, debug, test, package, and add a release candidate version of your connector, you request Dell Boomi to review the connector version. During the review process:


  • Dell Boomi checks the submitted version’s connector code to ensure it does not contain any viruses or other malevolent items. You may also be asked to submit source code for the sole purposes of a security review.
  • Dell Boomi checks the connector name to ensure it easily identifies your connector and does not include version numbers.
  • Dell Boomi may require you to demonstrate usage of your connector.


Dell Boomi also requires that you document your connector and submit your connector documentation for review. 


To assist you with documenting your connector, we have created a Microsoft Word template that you can download from the Connector SDK Distribution file. Follow the instructions in the template, save the Microsoft Word file, and submit your connector documentation for review, just like you do for your connector code.


Note: As a further convenience, we have attached the template (Connector_Documentation_Template.docx) in this article. 


Thank you for your participation. If you have any questions and/or feedback to help improve the connector documentation template, please let us know.


Additional Resources