- 8 minutes to read

Release Notes
Configuring Boomi Integrations Monitoring

This guide teaches how to configure the Nodinite Boomi Integrations Monitoring agent.

graph LR subgraph "Nodinite Users" roAdmin(fal:fa-user-crown Administrator) roUser(fal:fa-user User) end subgraph "Configuration options" roGC[fal:fa-gears Agent Configuration] roFile[fal:fa-file-alt Configuration file 'Settings.json'] roMV[fal:fa-display Monitor View] end roAdmin --> |Manage global settings| roGC roGC-->roFile roUser --> roMV roMV --> |Manage specific settings | roGC

Note: Before any monitoring and remote configuration can be performed, you must first install the Nodinite Boomi Integrations Monitoring agent and create a Monitoring Agent Configuration. First-time users start here.

Remote Configuration

As a Nodinite Administrator, click on the 'Configuration' button to open a modal to configure the agent:

RemoteConfiguration
Example of Configuration button available in the Monitoring Agent Configuration administration page

Many specific configurations can also be made directly on the Resource using the Action button if the Monitor View has the use of Remote Actions feature enabled.

You must be a Nodinite Administrator, to Manage the collection of Boomi Integrations to monitor.

Resources per Boomi Integration Account are grouped by Application and then by Category using the value from the Name text field. Read more about Applications here:

Application naming scheme

All resources for one Integration account are pre-fixed by the user-friendly Display Name set in the next step.

Configuring the connection

Remember to click on the Save button to persist changes. It may take some time (depending on the user-defined synchronisation interval) for Nodinite to reflect on changes.

Add Boomi Integration Account

From the Boomi tab, you can manage any number of Boomi Integration Accounts.; Each with its own set of properties.
To monitor and control one or more Boomi Integration Accounts, you must provide some basic connection details.
Remote configuration tab for Monitoring Boomi Integration Resources

Click on Add button to add a Boomi Integration Account to monitor, repeat as needed.

Boomi Integration Account - Empty entry

  • Click the Accordion to expand the connection configuration

Basic configuration details

  • Boomi - Repeat for each Account
    • Enabled When checked, Boomi integration monitoring is enabled. Otherwise, it is disabled
    • Display name - The user friendly name of this configuration
    • Account Id - The Account Id of the Boomi Platform

Remove Boomi Integration Account

Click the Remove button, to remove the configuration for monitoring the Boomi Integration Account with related services/resources.
Example of the remove button
Example of the 'Remove' button. Use to remove the Boomi Integration Account configuration from monitoring

Instead of removing the Boomi Integration Account, you can simply disable Monitoring. This will keep your configuration.

Enable Monitoring

A disabled Monitoring Configuration is clearly marked with a ban sign. Only disabled configurations can be Enabled.
Disabled Boomi Integration Account Configuration
A disabled Boomi Integration Account configuration has a ban sign to indicate that the configuration is no longer being actively monitored

Click the checkbox to re-enable monitoring of Boomi Integration Account related Resources.
Enable Boomi Integration Account Configuration
Boomi Integration Account Monitoring is enabled when the checkbox is checked

Disable Monitoring

You can stop monitoring all of the deployed resources for the Boomi Integration Account without removing the configuration by disabling the selected configuration. An enabled Monitoring Configuration does not have the ban sign. Enabled Boomi Integration Account configurations can be Disabled.
Enable Boomi Integration Account Configuration
Monitored Boomi Integration Account configurations does not have a ban sign

Un-check the checkbox to disable monitoring of Boomi Integration Account related Resources.

Manage monitoring thresholds

From the Thresholds Evaluation tab, you can manage both the global and specific Monitoring thresholds. The latter are easily manageable from within Monitor Views with Boomi Process related Resources.

Manage monitoring thresholds

  • Enable Threshold Evaluation When checked, the process execution time is monitored
  • Warning Time Span - The longest allowed time span for a specific process to be In Process status before a warning arise. (days.hours: minutes: seconds e.g. 7.12: 30: 59)
  • Error Time Span - The longest allowed time span for a specific process to be In Process status before an error arise. (days.hours: minutes: seconds e.g. 7.12: 30: 59)

Specific Processes

You can override the global settings by applying other monitoring thresholds to specific Boomi Processes.

TIP: It is easier to manage individual Boomi Processes from within the Monitor Views and the required fields are autmatically populated for you. Use this global configuration to modify existing entries.

Click the Add button to create a new entry. Add button

An empty record is then added to the list of specific process monitoring thresholds:
Empty process monitoring threshold entry

Click the accordion to expand the entry.

Details tab

You can manage the basics to identify a process from within the Details tab.
Details with empty specific process thresholds

  • Enabled Clear Date Time - When checked, any process errors that occurred before now will be ignored
    • Clear Date Time - Ignore the process errors that occurred before the specified date.(yyyy-MM-ddTHH:mm:ssZ)
  • Name - The Process Name
  • Atom Name - The Atom name in which the process resides
  • Folder Full Path - The Process folder full path in which the process resides

Error-Prone tab

You can manage the monitoring settings for a specific process and apply an error-prone specific evaluation. If the number of errors are higher than the specified threshold within the sliding window, the process is evaluated as being error-prone.

This is an advanced setting and is disabled by default.
Disabled error-prone evaluation

Check the checkbox to enable the specific error-prone evaluation. Enabled error-prone evaluation

  • Error-prone Evaluation - When checked, error-prone processes are monitored according to the specification
  • Maximum number of failed executions - Alert as error-prone if the number of failed process executions within the sliding window is above this threshold
  • Sliding Window (minutes) - Determines how far back in time to perform the evaluation (The 'Window')

Thresholds Evaluation tab

You can manage the monitoring settings for a specific process and apply time-related specific evaluation thresholds. If the number of errors are higher than the specified threshold within the sliding window, the process is evaluated as being error-prone.

This is an advanced setting and is disabled by default.
Disabled error-prone evaluation

Check the checkbox to enable the specific error-prone evaluation. Enabled error-prone evaluation

  • Enable Threshold Evaluation - When checked, the process execution time is monitored
  • Warning Time Span - The longest allowed time span for a specific process to be In Process status before a warning arise. (days.hours: minutes: seconds e.g. 7.12: 30: 59)
  • Error Time Span - The longest allowed time span for a specific process to be In Process status before an error arise. (days.hours: minutes: seconds e.g. 7.12: 30: 59)

Authentication tab

From the Authentication tab, you can enter the basic information to connect with the Boomi Integration platform to monitor:

  • User name - The user name of the Boomi Platform
  • Token Authentication - When checked, Token authentication is used
  • Password / Token - The password or token of the Boomi Platform account

API Usage Limits

There is a limit with the Boomi APIs that you need to honour. These settings impact the time it takes for the Nodinite Boomi Integrations Monitoring agent to detect and report problems with the Boomi Integration platform.

The Nodinite Boomi Integrations Monitoring agent makes use of the Boomi AtomSphere APIs. Unfortunately, there is a limit to the usage of this API. The usage limits are described on the Boomi Atomsphere API user guide

API Usage Limits tab

  • API request rate for Boomi Details - API request rate in minutes for Boomi details.(e.g. Environment, Atom, Process)
  • API request rate for processes execution records - API request rate in minutes for Boomi process execution records.(Important for Boomi Evaluation)

TIP: We believe that you can contact the Boomi support and ask to raise the default of 1,000 times your number of licensed connectors / 24 hours. A developer account does not have the limit at all.

|Environment|Production Account|Test/QA/Dev Account| |---|---|---| |API request rate for Boomi Details|180|5| |API request rate for processes execution records|60|5|
Numbers are in minutes

You may need to have rather high values in a production environment! If you go too low, the monitoring will be suspended for that 24 hour period.

Settings tab

From within the Settings tab, you provide some details that determines the operation behaviour of the Boomi Integrations Monitoring agent.

  • Environment
  • Debug
  • Culture Information

Boomi Settings tab

Environment

Part of the standard features shared with all Monitoring Agents is an option to set the name of the target environment, for example, TEST, QA, PROD.

Debug

Part of the common features shared with all Monitoring Agents, there is an option to set the Debug flag for additional file logging that can be enabled/disabled as needed. Default is unchecked.

Culture Information

The Culture Information setting determines how time-based data from this agent is presented in the Web Client/Web API.

Add Nodinite Boomi Integrations Monitoring Agent Configuration

After the successful installation of the Nodinite Boomi Integrations Monitoring agent you must provide Nodinite with connection details so the Monitoring Service knows there's a new guy in town.

No monitoring or other configuration of the Nodinite Boomi Integrations Monitoring agent can be performed before the steps outlined below has been executed.

Configuration Steps

  1. Add and configure a new Monitoring Agent Configuration

    • Connection information is available in the README.txt file in the installation folder

  2. Use the Remote Configuration feature to configure the agent. Detailed at the beginning of this user guide.

  3. Create one or more self-service enabled Monitor Views that include the selected Resources provided by the Nodinite Boomi Integrations Monitoring agent according to business needs.

  4. Fine-tune specific settings directly on Resources using Remote Actions

Frequently asked questions

Use the troubleshooting guide to find the FAQ and answers to known problems.

ExecutionRecordsRateOfApiRequests depends on your Boomi subscription, developers has virtually no limit. Production environment currently has a very low limit to 1000 / day / connector (!)

Next Step

Add or manage a Monitoring Agent Configuration
Add or manage Monitor View

Install Nodinite Boomi Integrations Monitoring Agent
Update
Monitoring Agents
Applications