All Articles

Boomi Cloud Atom Migration

This article covers how to use the Cloud Atom Migration process that is within the Boomi process library. As a company learns of new requirements, it can make sense for them to move from a local atom to a Boomi Cloud Atom or from one Boomi Cloud Atom to another.

A quick overview of the steps that are involved within programmatically migrating your Cloud Atom.

  1. Before you execute the process, get important ids involved with the Cloud Atom being migrated. Boomi Support will be the best way to get the Cloud Ids, if you are uncertain.
  2. Execute the process to create a new Cloud Atom. The account must have additional cloud attachments available.
  3. Attach the Cloud Atom to the environment of the original Cloud Atom This step will automatically deploy all processes to the new Cloud Atom. The license count will be doubled at this point and you will need to contact Boomi Support to get additional licenses for the migration.
  4. Sync the Process Schedules.
  5. Sync the Process Status and turn all of the processes off on the original Cloud Atom.
  6. Sync the Listener Status. The listeners will remain active on the original Cloud Atom.
  7. Sync the Process Properties (i.e. persisted dynamic process properties, last successful run date).
  8. Sync the Atom Counters.

Once the process has been executed, if there are any errors, all changes will be rolled back and the list of errors can be found at the Return Document shape in Process Reporting. If the process is successful, then the next steps would be to:

  1. Migrate the new URLs, user names, and passwords to any endpoints connecting to the Cloud Atom’s shared web server.
  2. Ensure the new Cloud Atom is functioning as expected.
  3. Delete the original Cloud Atom .The original Cloud Atom will have ‘-DEPRECIATED’ appended to the name.

The process does not migrate all settings and information.

  • Atom Queues: Since queues are generally short-lived, the queues should finish executing but no new data will be added unless they are used to decouple listeners, which remain active on the original Cloud Atom.
  • Share Web Server Settings: The AtomSphere API for shared web server settings only migrated a limited amount of information for Cloud Atoms. User names and passwords for basic authentication will be to be recreated since they can not be moved.
  • Environment Extensions Passwords: All environment extensions will be transferred to the new Cloud Atom except for any fields that are encrypted. These will need to be repopulated after the Cloud Atom is created.

Getting Started

Preparing your Boomi Account for the Atom Migration

The new Cloud Atom will temporarily increase your account’s cloud attachment count and your license count. Please contact Boomi Support or your Boomi Account Representative if you are unsure of the effect of the new Cloud Atom will be on your Boomi account. This change should only be temporary because once you have confirmed that the migration was successful, the original Cloud Atom can be deleted and your license count will return to the original count. If needed, contact Boomi Support or your Boomi Account Representative to ensure that your account has additional cloud attachments available (this can be for both public and private Cloud Atoms). Also, if needed, contact Boomi Support or your Boomi Account Representative for temporary license counts because the additional Cloud Atom will resulting in the license count being double ( number of connectors x number of atoms).

Atom Id and Cloud Id

The process will require your Atom Id, source Cloud Id, and destination Cloud Id. The Atom Id can be easily located by going into Atom Management -> click the Cloud Atom -> Atom Information -> Atom Id.

Locate Atom Id

Figure 1. Locate Atom Id.

You will also need to obtain the source and destination Cloud Id. If you are moving from one Boomi Public Cloud Atom to another, then Boomi Support or your Boomi Account Representative will be able to provide those two ids for you because they are not readily available through the Boomi Platform UI. If your account manages a private Cloud Atom, then speak with your admin to obtain this information.

Once you have this information, you will need to populate the Cloud Atom Migration process property within the folder.

Locate Process Properties

Figure 2. Cloud Atom Migration Process Property.

Set Process Properties

Figure 3. Populate Cloud Atom Migration Process Property.

The three fields need to be populated with the information obtained above (Source Cloud Atom Id, Source Cloud Id, and Destination Cloud Id). This data will be populated within the message shape that is at the beginning of the process.

Connector Setup

The processes uses a HTTP Connector to connect to Boomi AtomSphere API because a few of the endpoints are not available through the SOAP based AtomSphere API connector. The connector is labeled Atomsphere API.

AtomSphere API HTTP Connector

Figure 4. Atomsphere API HTTP Connector.

AtomSphere API credentials can be obtained by clicking Settings at the top -> User Information -> AtomSphere API Tokens -> New. The token is associated with the user who is creating it and they must also have privileges for AtomSphere API. Boomi recommends that the user be assigned the Boomi Admin role to ensure that the user is able to do everything that is involved with this migration. Boomi also recommends using tokens over the user’s password, since the tokens can be easily revoked if needed.

AtomSphere API Token

Figure 5. AtomSphere API Token Creation.

Next, populate the AtomSphere API HTTP Connector with the token that was just created. The user name will be BOOMI_TOKEN. and the password will be the token that was just created.

HTTP Client Base Auth

Figure 6. HTTP Client Base Auth Credentials.

Once those are complete, the process can be deployed to any Atom within your account and manually executed. The process takes a few minutes to execute depending on the volume of processes on the Cloud Atom. Once the process is complete, check the process reporting to confirm that the process executed successfully. Next, repopulate all encrypted fields in the environment extensions. Only non-encrypted fields are transferred when a new Atom is added to an environment. Also, the listeners will still be active on the original Cloud Atom. This will provide time for the endpoints using the web services server to be migrated to the new Cloud Atom. Once, the new Cloud Atom has been confirmed that it is working as expected, the original Cloud Atom can be deleted under Atom Information.

Delete Cloud Atom

Figure 7. Delete original Cloud Atom.

Article originally posted at Boomi Community.

Published Jun 5, 2021

Developing a better world.© All rights reserved.