Boomi Atom Web Server Test

The Boomi Atom Web Server is a component in the Boomi Enterprise platform which facilitates communication between the Boomi Atom (runtime engine) and external applications, APIs, and services. This web server acts as an interface for receiving HTTP/HTTPS requests and sending responses to various integration scenarios. This test helps the administrators to track the status of the Boomi Atom Web Server from the Boomi Atom and reports the value of the status code from the Web Server.

Target of the test : Boomi AtomSphere

Agent deploying the test : An internal agent

Outputs of the test : One set of results for the Boomi AtomSphere 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. The default value is NULL.

JMX Remote Port

This parameter appears only if the mode is set to JMX. Here, specify the port at which the JMX listens for requests from remote hosts. Ensure that you specify the same port that you configured in the management.properties file in the <JAVA_HOME>\jre\lib\management folder used by the target application . To know more, refer to Enabling JMX Support for JREtopic in Monitoring Java Application document.

JNDI Name

This parameter appears only if the mode is set to JMX. The JNDIname is a lookup name for connecting to the JMX connector. By default, this is jmxrmi. If you have resgistered the JMX connector in the RMI registery using a different lookup name, then you can change this default value to reflect the same. 

JMX User, JMX Password, and Confirm password

These parameters appear only if the Mode is set to JMX. If JMX requires authentication only (but no security), then ensure that the user and password parameters are configured with the credentials of a user with read-write access to JMX. To know how to create this user, refer to Configuring the eG Agent to Support JMX Authenticationtopic in Monitoring Java Application document. Confirm the password by retyping it in the Confirm Password text box.

Provider

This parameter appears only if the Mode is set to JMX. This test uses a JMX Provider to access the MBean attributes of the target Java application and collect metrics. Specify the package name of this JMX Provider here. By default, this is set to com.sun.jmx.remote.protocol.

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 Service?chapter.

Timeout

Specify the duration (in seconds) for which this test should wait for a response from Boomi AtomSphere. The default value is 120.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Status code

Indicates the status of the Boomi Atom Web Server.

Number

A status code of 200 indicates that the web server can receive requests.