Boomi: Custom Library Component

Have you ever had difficulty maintaining custom/3rd party library jar files in Boomi across multiple atoms and environment? You can now solve this by utilizing the Boomi Custom Library Component.


How To

Here are the quick steps on how to upload and deploy a 3rd party library to your local atom.


Step 1 – Upload a Jar File

  1. Navigate to your account setup
  2. Look for Account Libraries under Development Resources Section
  3. Click on “Upload a File” button to upload a jar file. In this example, we are using Apache Common Lang library.


After uploading the jar, it is recommended to add a description so that we know the purpose of the jar file.




Step 2 – Create Custom Library Component

  1. Click on create new Custom Library Component from process canvas.
  2. In the configuration wizard, define the custom library type (we will be using general in this example).
  3. In the “Included Jar Files” section, search for the library that was¬†uploaded too and add it to the list.
  4. Click “Save and Close” to save the component.




Step 3 – Deploy

  1. Navigate to Deploy > Change the deployment menu to “Custom Libraries”.
  2. Click on “Attachments” tab to attach any atoms/environments (depending on your Boomi licence).
  3. Click on “Deployments” tab to deploy the component.


Step 4 – Restart Atom

Before you can use the library in your integration process, you will need to restart the atom. You can do so via Manage > Atom Management > select an atom > click on Atom information tab > click on “Restart Atom”.



Note: You do not have to do this if you are deploying script or connector related library.


Yep, that’s it. Your custom 3rd party library is deployed and ready to be used. When your integration process is ready for UAT, you will need to repeat the instruction in “Step 2” to attach the custom library component to the UAT environment and deploy.


You mean, it’s that easy? Back in the old days, integration developers would need to¬†login to a server, apply a 3rd party jar file in an atom manually and restart the atom. This could be a hassle process if we have multiple environments and atoms to maintain, for example, development, UAT and Production.