Boomi Custom Library

By in ,
693
Boomi Custom Library

What is a Custom Library?

Often while developing an integration, we might need to use some custom scripting libraries or connect to applications like databases/SAP/ NetSuite Suite Analytics, etc. for which we need to install certain JAR files in Boomi to connect to them. Custom Library is a collection of JAR files that you use to support your Boomi integration processes.

Why do we need a custom library?

Using a Custom Library allows us to create a component in Boomi using which we can manage multiple JAR files.

If you want to connect to SAP using the JCO v2 connector you would need sapidoc3.jar and sapjco3.jar. You can create one custom library and deploy them to any environment in Boomi rather than loading the JAR files in the atom installation directory manually

Sample SAP JCO Connector

The most common use case for Custom Libraries is while connecting to Databases. Boomi has inbuilt JAR files if you are connecting to the following Databases:

  • SQL Server JTDS
  • Oracle
  • MySQL
  • SQL Server (Microsoft)
  • SAP HANA

But if you want to connect to any other database you will have to upload their JAR files. For ex:

Connecting to the snowflake Database you would need the following jar:

Snowflake DB Connector

How to create Custom Library?

Click on Create New component in your Boomi Build tab and select Custom Libraries:

Create custom connector

In Boomi you can set up three categories of Custom libraries:

  1. General: These files get uploaded in the /userlib folder and support multiple functions. Once you have loaded these files the atom needs to be restarted.
  2. Scripting: These are the JAR files that support custom scripting and get added to userlib/scripting directory
  3. Connector: These are the Jar files that support connection. For e.g., Databases, SAPJco2, apex, etc. These jars get added to userlib/<your-connector-type> and you don’t need to restart the atom after loading these as they activate immediately.

Importing JAR Files

Upload the Jar files before creating Custom Library. You can do that by going to Settings> Accounting information > Account Libraries > Upload a file

Managing custom Libraries

How to deploy Custom Libraries

Deployment of Custom Libraries is similar to deploying a Boomi Process. You need to create a packaged component and then deploy the package to any environment you want.

 

Cover Photo by Iñaki del Olmo on Unsplash