Integration with AtomSphere API in Boomi

_ November 26, 2023_ TGH Software Solutions Pvt. Ltd.

Integration with AtomSphere API in Boomi

In this blog, we will see how to create a package component and deploy it to an environment using AtomSphere API in Boomi.

What is AtomSphere API?

It is an API in Boomi which automates the packaging, deployment of integration processes and other components. All AtomSphere API calls are authenticated by a user name or API token and an account ID that is associated with an active AtomSphere account. Deploying an AtomSphere API connector does not affect your license count.

In this Use Case, we will create a packaged component and deploy the process called “Shopify GET orders” using the Atomsphere API connector.

Let us begin with the steps by integrating AtomSphere API in Boomi.

Step 1: Log on to the Boomi platform (https://platform.boomi.com/) with the required credentials i.e. Email Address and Password.

Step 2: Once logged into the Boomi platform, we will be able to view the Home page.

Step 3: Now, click on Services followed by Integration. We will see the Build page. Click on New.

Step 4: Once, click on New, we will be able to see three fields i.e. Type, Component Name and Folder.

Select Type as process as we are building a process. Component Name and Folder can be given based on your choice (i.e. which name to be given and where do we want to create the process). Click on Create.

Step 5: We see that the process gets created with a start shape which is configured with AS2 Shared Server by default.

Step 6: Select the start shape and choose No Data. Click ok.

Step 7: Drag and drop the Branch shape onto the process canvas. Number of branches will be 2. Branch 1 will create the package component and branch 2 will deploy the process.

Step 8: Drag and drop the AtomSphere connector onto the process canvas and configure it.

Here, we choose Action as CREATE as we are creating the package component. Click + on connection.

Name the connection and configure the details.

In the WSDL URL, give your account ID instead of ACCOUNT_ID.

To get a Boomi Account ID, go to settings and click on User Information.

Select Account Information on the left and We will find Account ID

Authentication Type will be Password.
Give the name and password of your Boomi account.

Step 9: Now, test the connection.

Click on Next.

We see that the Test connection is successful. Click Finish, Save and Close.

Step 10: Click + on operation and name it.

Click on Import.

Choose the connection which we have configured in AtomSphere API Connection. Click next.

Select Object type as package component. Click next.

We see that the profiles get imported. Click finish, save and close.

Step 11: Drag and drop message shape to add static XML payload containing component ID, notes, packageVersion and shareable.

In component id, we will add the id of the process for which we are going to create the package component.

To get the Component ID, select the process for which the packaged component has to be created. Click on Revision History which is at the right corner as shown below. Copy the ID and add it to the component ID of the XML payload in the message

Navigate to the process which you are building. Click on the message shape and add the data in the message section. Click ok.

Step 12: Drag and drop the map shape onto the process canvas and name it.

Add profiles on both sides. The left side will be the XML profile which we send as a payload in message shape. The right side will be the Packaged Object request profile which we have imported in Atomsphere API. Click on Choose on the left side and add the XML profile.

Choose profile type as XML and click on Create a new profile.

Name it and click on import as shown.

Choose a file from the location where we have saved it.

Once, we choose the file, we can see the file name.

Click next. We see the profile has been loaded. Click on finish.

The Request Profile looks like,

Click save and close. Click on Choose on the right side of the map to add the destination profile.

Select the profile type as XML and Choose the imported Packaged Component Response Profile. Click ok.

We see that both the profiles have been imported.

Step 13: Provide one-to-one mapping. Click Save and close.

Step 14: Now, we will create a Process Property to store the package ID which comes as a response. Click the arrow beside the folder in which we have created the Process and select New Component.

Choose process property.

Add the Component name as a Variable. Click on Create.

Select + to add the property name as shown below.

Add the label as Package Id. Click save and close.

Step 15: Drag and drop set properties shape onto process canvas. Select + to add the property name.

Select process property. Choose the property name as a variable and process the property name as package ID.

Click + on parameters to assign the value as shown.

Step 16: Select type as profile element. Choose Profile type as XML, Profile as the Packaged Component response profile which we have imported while configuring AtomSphere API and elements as package ID.

After configuring the set properties shape, it looks like.

Step 17: Now append the top shape at the end.

Step 18: Arrange all the shapes to branch 1 as shown in the screenshot.

Step 19: Drag and drop message shape to add static XML payload containing Environment Name, PackageId, Notes and listener status.

Here, the environmental value will be Production.
Package ID will be {1} which means we are getting the value from the process property to which Package ID has been assigned in Branch 1.

To assign the value, click on variables.

Select Type as process property. Choose process property as Variable and process property name as package ID. Click ok.

After configuring the message shape, it looks like

Click ok.

Step 20: Drag and drop set properties shape onto the process canvas to set the environment ID in Dynamic Document Property. Select + to set the property name as below.

Choose Document property and give the property name as Env ID. Click ok.

Step 21: Select + on parameters as shown below.

Step 22: Give an ID of the environment to which you want to deploy the process.

To get the ID, go to Manage > Atom Management > Click on the environment.

We can see the environment id on the right side.

Copy the ID and add in the static value of the document property. Click ok.

After configuring the set properties shape, it looks like

Step 23: Drag and drop the AtomSphere connector onto the process canvas and configure it.

Configure the same Action and Connection as mentioned in Step 8.

Step 24: Click + on operation and name it.

Click on Import.

Choose the connection which we have configured in Connection. Click next.

Select the Object type as Deployed Package. Click next.

We see that profiles get imported. Click finish, save and close.

Step 25: Drag and drop Map Shape onto the process canvas and name it. The left side will be the XML profile which we send as a payload in message shape. The right side will be the request profile which we have imported as a Deployed Object Request Profile in atomsphere API. Click on to left side and add the XML profile.

Choose profile type as XML and click on Create a new profile.

Name it and click on import.

Choose a file from the location where we have saved it.

Once, we choose the file, we can see the file name.

Click next. We see the profile has been loaded. Click finish.

Step 26: The request profile looks like this,

Step 27: Click save and close. Click on the right side of the map to add the destination profile.

Select the profile type as XML and select the imported profile. Click ok

We see that both the profiles have been imported.

Step 28: Provide one-to-one mapping for notes, listener and package ID.

Step 29: To set the environment ID, get the ID from the document property which we have configured in the set properties shape. Click on functions.

We can see a few categories in Function i.e. String, Numeric, Date, Look up and so on. Here, we will select Category as properties and function as Get Document Property. Click ok.

Choose Dynamic Document Property from the drop-down as shown.

Here, the Property Type would be Dynamic Document Property and the Property Name would be Env ID. Click ok.

We see that we can retrieve dynamic document Properties in the map. Now, set the property environment id as shown in the screenshot. Click save and close.