Boomi API Executions Test

Boomi API execution refers to the process of running and managing APIs that have been created using the Boomi Integration Platform. When a client makes a request to the API endpoint, Boomi executes the associated integration process. The integration process can include data transformations, business logic, and calls to other services or databases. This test is used to measure the request processing ability of the target Boomi Service.

Target of the test : Boomi Service

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the 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 consolesection 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.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Execution count	Indicates the number of backend processes that were executed.	Number	The detailed diagnosis of this measure lists the Request timestamp, Auth type, Method, Gateway, Status, Account ID, Transaction ID, Deployed Api, Atom id, Atom name, Client remote address, Client subscription, and Client User Agent.
Average response time	Indicates the average response time to process the request.	Milliseconds	The higher response time means that Boomi will have to wait longer for each request to be processed before moving on to the next step in the integration. This results in slower integration performance, as each API call will take more time to return a response. If multiple API calls are part of a workflow, this can lead to a significant delay in processing the entire integration.
Maximum response time	Indicates the maximum response time to process the request.	Milliseconds
Average Backend process time	Indicates the average time taken for the backend process to complete.	Milliseconds	In Boomi, the backend process in API execution refers to the operations that occur after the API receives the request and before the response is sent back to the caller. When the backend process takes longer, the entire integration flow slows down. Every step in the integration workflow that depends on the backend process will be delayed. This can cause a cascade effect, slowing down the entire sequence of operations and ultimately affecting the end-to-end performance of the integration.
Maximum Backend process time	Indicates the maximum time taken for the backend process to complete.	Milliseconds
Average data sent	Indicates the average size of the data that was sent.	Bytes
Maximum data sent	Indicates the maximum size of the data that was sent.	Bytes