Kovair DevOps and Boomi Integration Plugin

Boomi Plugin Details

Plugin Version: 1.0

Overview

Boomi is a software company that specializes in integration platform as a service (iPaaS), API management, master data management and data preparation. Boomi was founded in Berwyn, Pennsylvania, and first launched its services in 2007. This plug-in has been designed to manage Boomi environment from Kovair DevOps platform.

Boomi Information:

More information can be found at Boomi. (as on 2022/06/29)

Version Supported:

This plugin was developed and tested against Boomi iPaaS Cloud instance.

Plugin Operation:

1. PackageComponent
This operation packages any boomi component, that will be deployed to Test/Production environment.

Input parameter(s):

Parameter Is Mandatory Help Text

Base Url

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

false

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

Components

true

Select component, which will be packaged.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content.

PackageId

Id of the packaged component, that will be used further to deploy or execute any packaged component.

 

2. DeployComponent

Deploy any packaged component to Test/Production environment in boomi platform.

Input parameter(s):

Parameter Is Mandatory Help Text

Base URL

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

true

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

Environment Type

true

Select environment type accordingly.

Environments

true

Select environment, where package will be deployed.

Package Id

true

Provide package id, which will be deployed.

Deployment Notes

false

Provide deployment notes.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content.

ComponentId

Component id, which is deployed.

 

3. ExecuteComponent

Execute component to test/production environment.

Input parameter(s):

Parameter Is Mandatory Help Text

Base URL

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

false

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

Atoms

true

Select atom accordingly.

Component Id

true

Provide component id, which will be executed.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content

ExecutionRequestId

Request id, after sending execute request of the component.

 

4. GetExecutionStatus

This operatoin inform us, about the status of the initiated execution request.

Input parameter(s):

Parameter Is Mandatory Help Text

Base URL

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

false

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

ExecutionRequestId

true

Provide execution request id, that has been initiated.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content

ExecutionStatus

Execution status of the component.

 

5. MakeEnvironmentReady

This operatoin create new environment, by performing some internal operation by itself.

Input parameter(s):

Parameter Is Mandatory Help Text

Base URL

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

false

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

Clouds

true

Select cloud accrodingly.

Environment Type

true

Select environment type accrodingly.

Environment Name

true

Provide the environment name, which will be created.

Atom Name

true

Provide the atom name, which will be created.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content.

EnvironmentId

Id of the newly created environment.

EnvironmentName

Name of the newly created environment.

AtomId

Id of the newly created atom.

AtomName

Name of the newly created atom.

 

6. SaveComponentScript

This operatoin save script of any component as .xml file in local system.

Input parameter(s):

Parameter Is Mandatory Help Text

Base URL

true

Provide the base URL of Boomi instance.

Account Id

true

Provide the corresponding user’s account id of Boomi.

Username

true

Provide the corresponding user’s username of Boomi.

Password

false

Provide the corresponding user’s password of Boomi.

API Token

false

Provide the API token for authorization.

Authentication Type

true

Select authentication type, need to specify authentication mechanism, Password/API Token.

ComponentId

true

Provide component id to save it’s script.

Destination Directory

true

Provide the directory path, where component script will be saved.

 

Output parameter(s):

Parameter Help Text

Status

Status of the operation.

OutputLog

Response message content.

FileName

Name of component script xml file.

DestinationDirectory

Destination directory, where component script xml will be saved.

 

Pass/Fail Conditions:

Method Status Condition

PackageComponent

Passed

If the value of Status is Success and if OutputLog contains PackageId, Package Version, Component Id, Component Version

PackageComponent

Failed

If the value of Status is not Success and if OutputLog doesn’t contains Package Id, Package Version, Component Id, Component Version

DeployComponent

Passed

If the value of Status is Success and if OutputLog contains following parameters Deployment Id, Deployment Version, Package Id, Package Version, EnvironmentId, Component Id, Component Version

DeployComponent

Failed

If the value of Status is not Success and if OutputLog doesn’t contains any parameters.

ExecuteComponent

Passed

If the value of Status is Success and if OutputLog contains following parameters Component Id, Atom Id, ExecutionRequestId Id

ExecuteComponent

Failed

If the value of Status is not Success and if OutputLog doesn’t contains any parameters.

GetExecutionStatus

Passed

If the value of Status is Success and if OutputLog contains following parameters Execution Status

GetExecutionStatus

Failed

If the value of Status is not Success and if OutputLog doesn’t contains any parameters.

SaveComponentScript

Passed

If the value of Status is Success and if OutputLog contains following text Component script has been saved successfully.

SaveComponentScript

Failed

If the value of Status is not Success and if OutputLog doesn’t contains following text Component script has been saved successfully.

MakeEnvironmentReady

Passed

If the value of Status is Success and if OutputLog contains following parameters Environment Id, Environment Name, Atom Id, Atom Name

MakeEnvironmentReady

Failed

If the value of Status is not Success and if OutputLog doesn’t contains any parameters.

 

Limitations:

  1. This plug-in has been implemented for Process type component only.

Release Details:

Boomi: 1.0
Initial version with basic functionalities.

Contact us:

    Yes, I accept the Privacy Statement and want to receive latest information from Kovair.
    [tracking]