Environment Extensions Update

The environment_extensions_update script is used to update the environment extensions for a given environment. The script is intended to run after the release_pipeline script has been ran.

Warning

A word of caution about updating environment extensions. Ensure that partial is set to true. If not, the default action is to reset all environment extensions. Therefore, if you only try to update a few values, then the rest will be set to default.

import boomi_cicd

# The environment_extensions_update.py script updates the environment extensions for the
# environment set within the environment variables json.


# Open environment extensions release json
env_ext_release = boomi_cicd.set_env_release()
environment_id = boomi_cicd.query_environment(boomi_cicd.ENVIRONMENT_NAME)
boomi_cicd.update_environment_extensions(environment_id, env_ext_release)

Required Environment Variables

Environment Variable	Description
BOOMI_ACCOUNT_ID	The Boomi account ID.
BOOMI_ATOM_NAME	The name of the Boomi Atom.
BOOMI_ATOM_NAME_DR	The name of the Boomi Atom.
BOOMI_BASE_URL	The base URL for the Boomi API. https://api.boomi.com/api/rest/v1
BOOMI_PASSWORD	The Boomi password. Atomsphere API Token is recommended
BOOMI_ENV_RELEASE_FILE	The location of the release JSON file to use. The release file contains the environment extensions to be updated.
BOOMI_USERNAME	The Boomi username. Atomsphere API Token is recommended

Release JSON File

The release file contains the environment extensions JSON. Additional information about environment extensions can be found within Boomi’s documention. Below is an example of a environment extensions release file.

{
   "@type" : "EnvironmentExtensions",
   "processProperties" : {
      "@type" : "OverrideProcessProperties",
      "ProcessProperty" : [
         {
            "@type" : "OverrideProcessProperty",
            "ProcessPropertyValue" : [
               {
                  "@type" : "ProcessPropertyValue",
                  "label" : "String",
                  "key" : "new-1355426770730",
                  "encryptedValueSet" : false,
                  "useDefault" : false,
                  "value" : "Partialupdates"
               },
               {
                  "@type" : "ProcessPropertyValue",
                  "label" : "Password",
                  "key" : "new-1355426788553",
                  "value" : "PasswordUpdated",
                  "encryptedValueSet" : false,
                  "useDefault" : false
               }
            ],
            "id" : "24a56789...",
            "name" : "Boomi Test"
         }
      ]
   },
   "environmentId" : "456789ab...",
   "extensionGroupId" : "",
   "id" : "6f678d09...",
   "partial" : true
}