Setting up storage in Flow (Using the API)

A store is a location used to store your runtime data from the Boomi Flow platform externally. Runtime data is anything that is used specifically at runtime – states, service invoker logs, user tokens, etc. As of today, Flow supports storing states externally.

Having an external data store, outside the realms of where the Flow platform stores runtime data, gives you even more granular control over your flow runtime data. For example, you can have the data reside on your favorite cloud, or even on-prem, if you like.

An external data store can be used for specific data residency and compliance requirements, giving you the freedom to decide where your runtime data ultimately resides, based on your unique business needs.

What exactly happens when you create a store? Well, when you create a store, what are you doing is providing an HTTPS-accessible endpoint; this endpoint adheres to the Flow External Storage API. The Flow engine, in turn, generates a platform key and receiver key pair values; which are used to sign, verify, encrypt and decrypt messages sent to and from the external storage provider.

The platform key is used by the external storage endpoint to verify that incoming requests are indeed coming from the Boomi Flow platform (authenticity and non-repudiation). The platform key is also used to encrypt any responses that are sent back to the platform.

The receiver key is used by the external storage endpoint to decrypt incoming requests from the Flow platform, and to sign any outgoing responses that are sent back to the platform.

Here is how you can set up a store using the Flow API:

    1. Click API.

      This opens the in-built Flow API editor.
    2. Copy-paste the endpoint api/admin/1/stores in the address bar.
    3. Type the name of your data store, and a public HTTPS endpoint in the editor for Request. This will form the body of our request.
      The code will look something like this:
      {
      "name": "Sales and Marketing (Production)",
      "endpoint": "https://storage.salesandmarketing.com/api/storage/1"
      }
      This is what the screen will look like:
    4. Click POST.

That’s all! The Flow engine will create the store, generate keys, and send you a response back. The response will include the platformKey and receiverKey fields. That is your cue to copy the key-value pairs and store them in a safe place.

NOTE // 

The keys are generated only once per store!

Store yours in a safe location, from where you can retrieve them as needed.


Check out the glossary for a definition of terms and key concepts that appear in the Boomi Flow website, drawing tool, technical documentation, blogs, and marketing communications.

If you want to take a closer look, click on the images to enlarge them. Have a question? Click the Help button on the bottom right-hand corner of this page to ask.