Boomi API Usage Test

In Boomi, APIs are a central feature for enabling integrations between various systems, applications, and data sources. Boomi allows users to consume external APIs (i.e., use APIs from other systems) and expose Boomi processes as APIs (i.e., make Boomi processes accessible via API calls). This test reports the number of error and success processes as a result of Boomi's API execution.

Target of the test : Boomi Service

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each Deployment Environment type in the target Boomi Service being monitored.

Configurable parameters for the test
Parameter Description

Test period

How often should the test be executed.

Host

The host for which the test is to be configured.

Port

The port number at which the specified host listens to.

Boomi Platform Base URL

Specify the URL - https://api.boomi.com/ that is used towards user registration for accessing the Boomi console.

Account ID

Specify the user Account ID that is auto-generated while registering the user in Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.

Boomi User Account

Specify the email ID of the user in the Boomi User Account text box that is used towards user registration for accessing the Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.

API Token

Specify the API token value that was generated using the Boomi console. To know how to generate the API token in Boomi console, refer to Creating a new API token in Boomi console in How does eG Enterprise Monitor Boomi AtomSphere?chapter.

Timeout

Specify the duration (in seconds) for which this test should wait for a response from the target Boomi Service. If there is no response from the target beyond the configured duration, the test will timeout. By default, this is set to 120 seconds.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Error count

Indicates the number of error processes in this deployment.

Number

Ideally, the value of this mesaure should be low.

Increased error processes lead to failed API requests, disrupting the intended functionality for users and applications relying on the API.

Success count

Indicates the number of successful processes in this deployment.

Number