IANN Lite Product Manual

Contents -
1. Introduction to IANN Monitor Lite
1.1 What is IANN Monitor Lite?
1.2 Who Should Use This Manual
1.3 What This Manual Covers
2. IANN Monitor Lite - Key Monitoring Parameters
2.1. Sterling Integration Application
2.2. Maximo Application Monitoring
2.3. Platform Monitoring
3. IANN Monitor Lite Application:
3.1. Login:
4. Create and Manage Environment:
4.1 Create Environment:
4.2 Manage Environment:
5. Environment Switch:
6. Dashboard:
6.1. Panels:
6.2 Creating a Graphs in IANN Monitor
6.3 Understanding Each Graph Type
6.4 Graph Resize, Drag and Drop
7. Manage Dashboard:
7.1. Calendar Date Selection:
7.2. Auto Refresh:
7.3. Download CSV:
8.Configuring Alerts and Notification Channel:
8.1. Notification Channel:
8.2. Configuring Alerts:
9. Alerts Data:
10. Landing Page:
10.1 Landing Page for VM:
10.2 Landing Page for OpenShift:
11. Default Dashboard:
11.1. Default Dashboard for Sterling Integrator:
11.2 Default Dashboard for Maximo Application:
12. Access Management:
12.1. Access Management – User Creation:
12.2 Access Management – User Management:
12.3 User Roles:
13. Channel Configuration
13.1 Steps to Configure a Channel
13.2. Viewing and Managing Channel Configurations.
14. Dashboard Backup for Seamless Environment Management:
14.1 Download Dashboard:
14.2 Upload Dashboard:
15. Setting Up Teams and Slack Integrations (Email & Webhook):
15.1. Get Email address for a Teams Channel:
15.2. Getting Webhook URL for Slack Channel:

1. Introduction to IANN Monitor Lite

1.1 What is IANN Monitor Lite?

IANN Monitor lite is an integrated monitoring and alerting platform designed for IBM Sterling B2B and IBM Maximo environments. It provides real-time visibility into critical application and infrastructure-level metrics, helping organizations detect and respond to issues before they impact business operations.

Key monitoring capabilities include:

1.    System Health Monitoring

2.    IBM B2B and IBM Maximo Application Metrics

3.    Application Logs

4.    Cloud Logs

IANN Monitor Lite supports both cloud-based and on-premises deployments and is built to improve the efficiency of IBM B2B and IBM Maximo Application platforms by:

1.    Reducing daily manual health check costs by up to 95%

2.    Minimizing system downtime

3.    Enhancing file transfer reliability

4.    Offering centralized monitoring across the platform

5.    Serving as a single tool for end-to-end system visibility

It also provides early problem detection and supports a variety of graphical options to visualize and interpret system data efficiently.

1.2 Who Should Use This Manual

This manual is intended for:            

1.    System Administrators

2.    Monitoring and Support Teams

3.    DevOps and IT Operations

It is designed to help users configure, manage, and operate IANN Monitor effectively.

1.3 What This Manual Covers

This guide provides step-by-step instructions on:

1.    Creating and managing environments for different deployment stages (e.g., dev, QA, prod)

2.    Building dashboards to visualize key performance metrics and status

3.    Defining alert rules and thresholds

4.    Routing alerts to incident management tools like PagerDuty, Email, xMatters, Teams, Slack and ServiceNow

5.    Creating and Managing visualizations for different types of data

6.    Managing user roles and access permissions

7.    Switching between environments with ease

2. IANN Monitor Lite - Key Monitoring Parameters

2.1. Sterling Integration Application

These datapoints are gathered through IANN Monitor’s integration with Sterling Integrator to monitor system activity, performance metrics, and potential anomalies.

2.1.1 Adapter & Mailbox Monitoring

1.    Protocol Server Adapters –Tracks the status of any two adapters

2.    Schedulers –Monitors the state of any two selected schedulers running within Sterling.

2.1.2. Business Process (BP) Monitoring

1.    Mailboxes with unextracted Message- Lists mailboxes with stuck or delayed messages that haven’t been processed yet.

2.    Long Running BP More Than One Min –  Detects BPs that exceed the defined runtime threshold, helping identify bottlenecks

2.1.3. File Processing State Monitoring

1.    Halted BP Count –Shows the number of business processes that have completely stopped due to errors or manual termination.

2.1.4. Environment & System Health

1.    Purge Lock Status –Indicates the current state of system locks that may need purging during maintenance.

2.1.5. Schedulers & Threads

1.    Queue Depth –monitors the queue depth of any two configured queues.

2.1.6. Certificate Monitoring

1.    System Certificates –Tracks the validity period and expiration of system-level certificates.

2.    Certificate Authority (CA) Certificates –Displays details of the Certificate Authority, including trust relationships and expiration.

2.1.7. CM Statistics (Community Manager)

1.    Application References (CM) – Tracks application references defined in the Community Manager.

2.    Trading Partner References –Displays references and mappings related to Trading Partners.

2.1.8. Application and Server Status Monitoring

1.    Application Status Monitoring – Checks the operational health of deployed applications to ensure they are running as expected and responding correctly.

2.    Server Status Monitoring – Monitors the availability and health of servers hosting the applications, ensuring they are online.

2.1.9. Database Health Monitoring

IANN Monitor Lite monitors the following database health parameters for Sterling Integrator.

1.    DB Status: Indicates whether the database is running and accessible.

2.    DB CPU: Shows the CPU utilization of the database server.

3.    DB RAM: Displays the memory usage of the database server.

4.    DB Response Time: Measures the time taken by the database to respond to queries.

5.    Active Sessions: Number of currently active user or application sessions connected to the database.

6.    Inactive Sessions: Number of sessions connected to the database but currently idle.

7.    Total Sessions: Sum of active and inactive sessions in the database.

2.1.10. Log Monitoring

Tracks application or system logs in real time to detect and report only the errors that match predefined configurations or keywords. This ensures focused monitoring by alerting only on relevant issues.

2.2. Maximo Application Monitoring

IANN Monitor tracks Maximo system activity, including user sessions, work orders, asset and inventory data, purchase workflows, automation tasks, custom configurations, reports, and core system properties—offering complete visibility into operational performance and health.

1.    Active Sessions – Tracks the number of users currently logged in to Maximo in real time.

2.    Used App Points – Monitors the total licensing points being consumed by active users and background processes, helping ensure compliance with license limits.

3.    Schedulers Job – Checks the status of Maximo scheduler jobs to ensure they are running as expected and completing on time.

4.    Stopped Escalations – Identifies escalation processes that have stopped or failed, which could delay automated actions or notifications.

5.    Event Listener Status – Monitors the health and activity of Maximo’s event listeners to verify they are capturing and processing events properly.

6.    License Expiration – Tracks the expiration dates of Maximo licenses to prevent unexpected downtime due to expired entitlements.

7.    User Login Tracking – Logs and analyzes user login activity for auditing, security monitoring, and usage trends.

8.    Application Status Monitoring – Checks the operational state of deployed applications to ensure they are running as expected and responding correctly.

9.    Pod Run Time Logs Monitoring –Captures logs generated by running pods to detect errors, warnings, or performance issues in real time by fetching the last 500 lines of pod logs at each configured schedule for any two configured namespaces and their pods.

10.  Database Health Monitoring – DB Status, DB CPU, DB RAM, DB Response Time, Active Sessions, DB Long Running Queries, and DB Locks are being monitored for MAS Application.

2.3. Platform Monitoring

IANN Monitor Lite captures essential system metrics and resource utilization across Linux, Windows, OpenShift, and Kubernetes environments to ensure the health, performance, and availability of infrastructure components

2.3.1. System Stats (Linux & Windows)

1.    CPU – Monitors the CPU usage on the system.

2.    RAM – Tracks memory usage over time.

3.    Disk – Observes disk space and performance.

4.    Network – Measures incoming and outgoing network traffic.

2.3.2. OpenShift Monitoring & Cluster Monitoring

1. Node Metrics – IANN Monitor gathers key metrics of any two configured nodes including:

1.    Node Status – Monitors whether each node is in a ready state.

2.    CPU, RAM – Tracks resource consumption on nodes.

2. Pod Metrics – IANN Monitor captures the latest metrics of pods for a single configured namespace , including:

1.    Pod Count – Tracks the total number of running pods.

2.    Pod Status – Monitors the health and status of each pod.

3.    CPU, RAM – Reports resource usage at the pod level.

4.    Restart Count – Reports the restart count of a pod.

 3. SSL Certificates – Tracks the status and expiration of SSL certificates in the environment.

3. IANN Monitor Lite Application:

The IANN Monitor Lite Application is a comprehensive platform that offers graphical visualizations, real-time alerts, and deep insights across infrastructure, application, and integration layers. It streamlines monitoring, analysis, and management through the following key modules:

1.    Login Page – Secure authentication for user access.

2.    Landing Page – Overview of system, application, and integration health with quick navigation.

3.    Dashboard Creation – Allows users to build custom dashboards to visualize selected metrics.

4.    Dashboard Management – Enables users to manage, edit, or delete existing dashboards.

5.    Default Dashboard – The Default Dashboard comes preloaded with essential metrics and default panels, giving users a quick overview of system performance and key data points right from the start.

6.    Access Management – Controls user roles and permission-based access.

7.    Alerts Page – Displays alerts that are raised across the environment and allows users to pause/resume alerts or mark components under maintenance.

8.    Notification Channel – Supports routing alerts to different channels such as Email, ServiceNow, xMatters, and PagerDuty.

9.    Channel Configurations – Lets users configure environment-specific reporting to collaboration platforms like Microsoft Teams or Slack.

10. Environment Creation – Allows creation and configuration of multiple environments (e.g., Dev, QA, Prod).

11. Weekly Reports –The Weekly Monitoring Report is an automated 7-day summary that highlights system performance, availability, and health across both VM and OpenShift environments. It helps operational teams ensure reliability, detect risks early, and validate infrastructure behavior.

12. Environment Switch – Enables switching between environments for focused analysis and monitoring.

3.1. Login:

Use the username and password from the application.yml file for the first login, then click the Login button to access the application.



When you login for the first time, you’ll see a blank landing page like the one below.

3.1.2 Forgot Password:

The “Forgot Password” feature allows users to securely reset their password if they are unable to remember it. By clicking the “Forgot Password” link, users are directed to a recovery page where they can update their login credentials through a step-by-step verification process.

Steps to Reset Your Password:

1.    Enter User ID and Captcha
Begin by entering your User ID and completing the Captcha, which ensures the request is from a legitimate user and helps prevent automated attacks.

2.    Receive OTP via Email
 Based on the entered User ID, a One-Time Password (OTP) will be sent to the registered email address associated with your account.

3.    Reset Password

a.     Enter your username in the User ID field.

b.    Provide a new password and re-enter it to confirm.

c.     Enter the Captcha as shown.

d.    Input the OTP received via email and submit the form.

4.    Submit and Update Password
Once you click Submit, your password will be updated successfully to the new one.

4. Create and Manage Environment:

4.1 Create Environment:

 

To create a new environment in IANN Monitor, the following fields are mandatory and must be filled out:

  1. Environment
  2. Environment Name
  3. Index Prefix

Make sure to use a valid Index Prefix as defined in the config.ini file or Kubernetes ConfigMap.

Click the +Create button to add the new environment.

Note: The Environment Name field does not support special characters. Only alphanumeric values are allowed.

4.2 Manage Environment:

In the “Manage Environment” section, you will see a list of environments with fields “Name,” “Prefix,” and “Action.” Within the “Action” column, you can perform actions such as editing or deleting the environment as needed.

 

 

5. Environment Switch:

When you click on Environment Switch, a list of environments you’ve created will appear in a pop-up window. From here, you can select the desired environment for your current task.

Once an environment is selected, you will be redirected to its landing page.
 To access dashboards within the selected environment, click on Manage Dashboard. If no dashboards have been created yet, the Manage Dashboard section will appear empty.


6. Dashboard:

To create a new dashboard, click on the Add Dashboard icon as shown in the screenshot.


Enter a title for your dashboard and click Save to complete the creation process.

6.1. Panels:

 

If you want to create a new panel, click on the Icon mentioned in the screenshot. After that row was added successfully.

Initially, each panel shows three icons:

  1. Settings Icon – Allows you to rename the panel title.
  2. Delete Icon – Removes the panel entirely.
  3. Down Arrow – Expands or minimizes the panel

 

Once you expand the panel using the down arrow, you’ll see a ‘+’ (Add Graph) icon like in the screenshot below:

Using the Add Graph option, you can add any type of graph based on your requirements.

When you select Add Graph, you will be directed to the Create Graph page as shown below.

6.2 Creating a Graphs in IANN Monitor

To create a graph in IANN Monitor, follow these steps:

1. Select Index (Index Name)

Choose the Elasticsearch index that serves as the data source for your graph.

2. Choose Graph Type (Graph Type)

Select the type of graph you want to create:

  1. Line
  2. Bar
  3. Gauge
  4. Text
  5. Table

3. Enter Graph Name

Provide a user-defined name for your graph to help identify it easily.

4. Select Units (Applicable only for Line Graphs)

Choose how you want the values to be displayed:

  1. Numeric
  2. Percentage
  3. Bytes

6.2.1 Create Queries

Each query consists of several key steps:

  1. Select Metric Type
     Choose the aggregation method for your data:
  1. Average: Calculates the mean of numeric values for each time bucket.
  2. Sum: Computes the total of all numeric values within each time bucket.
  3. Count: Returns the number of records/documents within each time bucket.

Note: Query creation is not applicable for Table Graphs.

Time-Based Data Bucketing:

To create meaningful time-series graphs, data is grouped into dynamic time buckets using a Date Histogram Aggregation. The bucket size adjusts automatically based on the selected time range to maintain chart readability and performance.

This bucketing applies to Average, Sum, and Count aggregations.

Time Range

Bucket Interval

≤ 12 hours

1 minute / 5 minutes

1 day

5 minutes

< 3 days

10 minutes

< 5 days

25 minutes

< 7 days

70 minutes

≤ 30 days

10 hours

≤ 60 days

13 hours

≤ 180 days

15 hours

≤ 365 days

1 day

> 365 days

2 days

This logic ensures that charts remain readable and performant regardless of the data volume or time span.

  1.  Choose Query Type
     Three query types are supported:
  2. Field-Only Query
    1. Input: Field name
    2. How it works: Data is fetched directly from the specified field and visualized as per the selected graph type.

  1. Filtered Query
  1. Input: Filter field and filter value
  2. How it works: Data is filtered based on the provided condition and then visualized.

  1. GroupBy Query
  1. Input: Enable Group By checkbox and specify the field to group by
  2. How it works: Unique values from the Group By field are used to create multiple visual elements (e.g., lines, bars, gauges).

Note: When Group By is enabled, only one query can be created. Multiple queries are supported only when Group By is not used.

  1. Set Alias Name
     Provide an alias for your query. This name will be displayed on the graph legend, making it easier to identify the data.
  2.  Save the Graph
     Once all the details are configured, click Save Graph to generate and add the graph to your dashboard.

6.3 Understanding Each Graph Type

6.3.1. Graph Type: Line
 A line graph displays data trends over time. It’s ideal for visualizing metrics like CPU usage, memory consumption, or traffic patterns.

When to Use:

  1. To monitor continuous data over time
  2. To compare multiple data lines

  1. To highlight fluctuations and trends

Supports:

  1. Units (Numeric, Percentage, Bytes)
     Defines how the data values are formatted and displayed in the graph.
     (e.g., CPU usage as Percentage, file size in Bytes, or raw numbers as Numeric)
  2. Metrics (Average, Sum, Count)
     Specifies the aggregation method applied to the selected field.
     (e.g., calculate average CPU usage, total disk I/O, or count of events)
  3. Multiple Queries
     Allows adding more than one query to compare or overlay different data points in a single graph.
     (Useful for showing different fields or filters side-by-side)
  4. Group By
     Splits data into multiple visual elements based on the unique values of a selected field.
     (e.g., CPU usage per server, requests per endpoint, etc.)

 

  1. Tooltip (Hover to see detailed values)
     Displays precise data values when you hover over graph elements.
     (Helps users view exact numbers without cluttering the graph)

  1. Legends with Filtering and Sorting

a.     Sorting Options: Legends can now be sorted in three modes:

                                               i.     Ascending: Sort legend items from lowest to highest value.

                                             ii.     Descending: Sort legend items from highest to lowest value.

                                            iii.     Normal: Display legend items in their original order (default).

b.    Quick Filtering:
 You can filter by legend value to instantly locate and highlight a specific data point, helping you analyze exact values more quickly

6.3.2. Graph Type: Gauge

Gauge graphs are used to represent a single metric value against a fixed scale. They are ideal for showing real-time status or capacity usage, such as CPU load or active connections.

When to Use:

  1. To show current system status
  2. To visualize values in a fixed range (e.g., 0–100%)

Behaviour:

  1. For values greater than 0, the status is shown as “Running”
  2. For value 0, the status is displayed as “Stopped”

Supports:

  1. Metrics (Average, Sum, Count)
     Specifies the aggregation method applied to the selected field.
     (e.g., calculate average CPU usage, total disk I/O, or count of events)
  2. Multiple Queries
    Allows adding more than one query to compare or overlay different data points in a single graph.
     (Useful for showing different fields or filters side-by-side)

  1. Group By
     Splits data into multiple visual elements based on the unique values of a selected field.
     (e.g., CPU usage per server, requests per endpoint, etc.)

6.3.3. Graph Type: Bar

Bar graphs display categorical data using rectangular bars. Each bar represents a different data value or category.

Title: Inserting image...

When to Use:

  1. To compare values across different categories
  2. To use with Group By for multiple bars

Supports:

  1. Metrics (Average, Sum, Count)
  2. Group By

  1. Multiple Queries (if Group By is not enabled)
  2. Legends with Filtering and Sorting
  1. Sorting Options: Legends can now be sorted in three modes:

                                               i.     Ascending: Sort legend items from lowest to highest value.

                                             ii.     Descending: Sort legend items from highest to lowest value.

                                            iii.     Normal: Display legend items in their original order (default).

    1. Quick Filtering:
       You can filter by legend value to instantly locate and highlight a specific data point, helping you analyze exact values more quickly.

6.3.4. Graph Type: Text

Text graphs show a single metric as plain text. Useful for showing key values (like today’s count, latest status, or totals).

Picture 638006285, Picture

When to Use:

  1. To display a summary or headline metric
  2. For dashboards with limited space

Supports:

  1. Metrics (Average, Sum, Count)
  2. Group By

  1. Multiple Queries (if Group By is not enabled)

 

6.3.5. Graph Type: Table

The Table graph type presents data in a tabular format, ideal for users who prefer structured and detailed information to display.

When to Use:

Use the Table graph when you want to view data in a structured, row-column format that supports detailed analysis, sorting, filtering, and keyword-based searches. Ideal for log records, alerts, and data comparisons.

Supports:

  1. Tabular Representation: Displays data in a clean, structured table format.
  2. Table Search:

Search Using Column Name: To filter the data in table for a particular column use column Name: keyword to search in Filter By field in query and update the graph.Picture 855650654, PicturePicture 123951438, PictureSearch Using keyword: Directly enter the keyword you want to search for in the “Filter By ” field. It is useful to search all the column values in the table.Title: Inserting image...Title: Inserting image...

Note: Search with special characters other than underscore won’t be possible. 

 

  1. Sorting:

Each column includes up/down arrow icons to sort data in ascending or descending order.

  1. Pagination:

Enables smooth navigation across large datasets when editing.

Title: Inserting image...

Picture 1540839218, Picture

  1. Enable & Disable Columns:

In the Table Graphs section, you can choose which fields you want to show or hide using the Modify Headers option.

If you only want to display certain fields in the table:

  1. Click on Modify Headers.
  2. A list of available fields will appear with checkboxes.
  3. Uncheck the fields you don’t want to display.
  4. Click Save.
  5. The table will now only show the fields that are checked.

Example:
 In the screenshot below, the fields Certificate Expiry Date and Created Date are unchecked. So, these fields won’t appear in the table — only the remaining checked fields like TIMESTAMP, Days, and Name will be visible.

Picture 113715993, Picture

  1. Modify Table Column Position:

In the Table Graphs section, you can rearrange the order of fields using drag and drop functionality in the Modify Headers section.

If you want to change the position of a field:

  1. Click on the Modify Headers button.
  2. Hover your mouse over the field name you want to move.
  3. Click and drag it to the position where you’d like it to appear in the table.
  4. Once you’re happy with the new order, click Save.

Example:
 In the screenshot below, the Name field has been moved to the second position and Days is placed third — just by dragging and dropping them into the desired order.



Title: Inserting image...

  1. Dynamic Field Names:

For table graphs, users have the option to customize or rename field headers according to their preferences.

To do this:

  1. Go to the Edit page of the Table Graph.
  2. You’ll find an option called Modify Headers (as shown in the screenshot below).

Title: Image download failed. - Description: Picture 285328862, Picture

Once you click on Modify Headers, a list of all the current field names in the table will appear (see screenshot below).

To change a field name, simply click on it, type the new name, and then click Save.

  1. The updated field name will now be displayed in the table.
    Example:
     In the screenshot below, the Name field has been moved to the second position and Days is placed third — just by dragging and dropping them into the desired order.


In Panel view, the timestamp position is fixed at the beginning and cannot be changed, ensuring consistent visualization across all panels.

6.4 Graph Resize, Drag and Drop

Graph Resize:

To resize the graph component, use the resize handle located at the bottom-right corner of the panel (as highlighted in the image). The handle is represented by a wrench-like icon. Simply click and drag this icon to adjust the graph’s dimensions according to your preference.

Drag and Drop:
 Hover near the top area of the graph to reveal the drag handle.  hold to move the graph and rearrange its position on the dashboard Panels.

Note: Drag and drop is only possible within the panel.

7. Manage Dashboard:

Manage dashboard is used to view the created dashboards and its graphs.

7.1. Calendar Date Selection:

 

Located at the upper right side of the interface, the calendar feature allows users to retrieve specific data by selecting a date. This is particularly useful for accessing historical data that occurred on a specific day. Users can click on a date within the calendar to choose their desired date, and the system will retrieve data related to that selected date.

7.2. Auto Refresh:

 



The auto-refresh functionality is a convenient feature that automatically updates or refreshes the displayed data at regular intervals. Users have the option to turn this feature on or off based on their preferences.

Auto Refresh Off:

     Users can disable auto-refresh if they prefer to manually refresh the data or if they want to freeze the data at a specific point for analysis.

     Theme Options: We provide both dark and light themes for the interface, with the default theme set to dark. This means that when you initially access the application, it will be in dark mode by default. However, you have the flexibility to switch to the light theme if you prefer a different visual style.

A toggle button allows users to switch between light and dark themes for a more personalized viewing experience.

Title: Inserting image...

Dark Theme:

Light Theme:

7.3. Download CSV:

 

The IANN Monitor application includes a CSV download feature that allows users to export data displayed in graphs for a specified time interval selected in the calendar.

Check out the information below on downloading CSV files:

1.    Select the graph from which you want to download the CSV data, then click the download button located at the top of the graph.

 

 

2.    Check your Downloads folder for the file, then open it to view the data.

8.Configuring Alerts and Notification Channel:

In this we have two features as shown below.

1.    Notification Channel

2.    Configuring Alerts

8.1. Notification Channel:

Used to configure alerts to be delivered to various external systems and communication channels such as PagerDuty, ServiceNow, xMatters, and Email. This ensures timely reporting and incident response across integrated platforms.

When you click on Notification Channel, you will be navigated to a new page that contains two main sections:

  1. Create Notification Channel
  2. Manage Notification Channel

Picture 887539127, Picture

 

8.1.1 Creating a New Notification Channel

To create a new channel:

  1. Click on Create Notification Channel.
  2. Fill in the following details:
    1. Channel Name:
       Enter a name for the notification channel you are configuring.
    2. Channel Type:
       Choose the type of channel from the dropdown list. The available types include:

                                               i.     Email

                                             ii.     ServiceNow (Snow)

                                           iii.     XMatters

                                           iv.     PagerDuty

Channel Type Configuration Details

Email

  1. When Email is selected as the channel type, an additional field for Email Address will appear.
  2. Enter the email address to which alerts should be sent.

Picture 768281150, Picture

ServiceNow (Snow)

  1. When Snow is selected, the following fields will appear:
    1. URL
    2. Username
    3. Password
    4. Severity levels: Critical, Warning, No Data
  2. Fill in the ServiceNow integration details and select which severities should be reported.

Title: Inserting image...

XMatters

  1. When XMatters is selected, the following fields will be displayed:
    1. XMatters URL
    2. XMatters Username
    3. XMatters Password
    4. Severity levels: Critical, Warning, No Data
  2. Provide the XMatters configuration details and select the alert severities to report.

Picture 453589455, Picture

PagerDuty

  1. When PagerDuty is selected, the following fields will appear:
    1. Routing Key
    2. Severity levels: Critical, Warning, No Data
  2. Enter the PagerDuty routing key and select the applicable alert severities.

Picture 717950465, Picture

Additional Settings

  1. Set Reminder:
     Enable this option to configure a time interval for repeated alert reminders.
  2. Default:
     Enable this to set the configured channel as the default for specific alert types.

Once all the required details are provided, click the Create button at the bottom-left corner of the screen to save the channel.

Picture 1241342647, Picture
     

8.1.2 Manage Notification Channel

When you click on the Manage Notification Channel, you will get the list of notification channels below.

 

When you click on Action, it displays Edit and Delete options, which allow you to modify or remove the channel configuration.

8.2. Configuring Alerts:

The Alerts feature enables users to monitor key metrics and receive notifications when thresholds are breached. Users can configure alerts with different severity levels (Critical, Warning, No Data, etc.), set reminder intervals, and route alerts to various channels like Email, PagerDuty, ServiceNow, or xMatters.

Each graph can have multiple alerts, but only the top three are displayed by default. Alerts can be paused, resumed, or edited as needed. Advanced options like Group By Alerts and Dynamic Alerts offer more flexibility and clarity.

This feature ensures timely awareness of system issues, helping teams act quickly and efficiently.

To create or modify alerts on the Graph page:

  1. Navigate to the Alerts tab in graphs inside panels.

Picture 70580777, Picture

  1. Fill in the required information:
    1. Alert Name
    2. Query to which alert to be configured
    3. Evaluation Frequency (in minutes)
    4. Alert Category – either Critical or Warning
    5. Notification Channel – where alerts should be sent
    6. Custom Message (optional) 

Note: Although you can configure multiple alerts, only the top three alerts are visually represented on the graph. To view all configured alerts, click on the Edit option.If a decimal number is used in alert configuration, it will be interpreted as a whole number.

8.2.1 Alert Types

The system categorizes alerts into the following six types:

  1. Critical Alerts
     Triggered when a monitored value crosses a defined threshold, based on the configured condition:
    1. isAbove: Alert is triggered if the value exceeds the threshold.
    2. isBelow: Alert is triggered if the value falls below the threshold.
       This allows accurate detection of abnormal spikes or drops for timely intervention.

Sample Email Notification:

Picture

  1. Warning Alerts
     These act as early indicators of potential issues. A warning alert is raised when a value falls within a configured range:
    1. warningFrom: Lower bound of the warning range
    2. warningTo: Upper bound of the warning range
       If the value lies between these bounds, a warning alert is generated—providing time for proactive action.

Sample Email Notification:

Picture

  1. OK State Alerts
     Indicates that the configured alert is active but none of its triggering conditions (Critical, Warning, No Data) were met. It confirms that:
    1. The alert is correctly configured.
    2. The monitored value is within acceptable limits.
    3. No Notifications will be raised to this type of alerts.

  2. No Data Alerts
     If the “No Data” checkbox is selected during configuration, an alert will be triggered when no data is received during the evaluation period—highlighting gaps in data availability.

Sample Email Notification:Picture

  1. Paused Alerts
    If the Pause toggle is enabled for an alert, it is temporarily disabled. While paused, the alert notification will not trigger—even if its conditions are met. It can be reactivated using the Resume option.
  2. Reminder Alerts
    Reminder alerts serve as follow-up notifications when an issue remains unresolved. They continuously alert users at configured intervals until the condition is cleared—ensuring visibility and timely action on persistent issues.

8.2.2 Alerts for Group By

Alerts involving grouping (e.g., by server or node) are raised under the following conditions:

  1. When the alert’s state changes
  2. When a standard alert transitions to a Group By alert
  3. When new key fields are detected in the alert’s current values

Example:
 If only node1 is down, one alert is triggered.
 Later, if node2 also goes down, an updated alert is raised.
 However, no additional alert is triggered for node1, and no resolved email is sent when node2 comes back up.

8.2.3 Dynamic Alerts

Dynamic alerts enable real-time data insertion into alert messages using placeholders. This enhances message clarity and relevance.

To use dynamic alerts:

 Insert a variable using the @ symbol followed by the field name in your message.

For example:

Message: CPU utilization is high on @server

When the alert is triggered, @server will be automatically replaced with the actual server name (e.g., node1), producing:

Message: CPU utilization is high on node1

Note: Ensure that the placeholder matches the exact field name used in the alert context to ensure proper substitution.

9. Alerts Data:

The Alerts Data Page provides a centralized view of all system or application alerts. It helps users monitor the health and performance of various components in real time.

Key Features:

1.    Alert Summary Bar
 Displays the total count of alerts categorized by severity:

a.     Critical: Indicates serious issues requiring immediate attention.

b.    Warning: Highlights potential issues that may need investigation.

c.     Ok: Represents components functioning within acceptable thresholds.

d.    No Data: Occurs when data is unavailable or not received.

e.     Paused: Alerts that have been temporarily disabled.

2.    Tabular View
 The table lists detailed information for each alert, including:

a.     Alert Name: The name or identifier of the alert.

b.    Timestamp: The last time the alert was triggered or evaluated.

c.     Status: The current state of the alert (e.g., Critical, Ok).

d.    Pause/Resume Control: Allows users to enable or disable individual alerts.

3.    Maintenance Mode
 A single-click option to pause or resume all alerts at once. When all alerts are paused, no notifications will be sent to configured channels.

4.    Filter and Search Options:
 Users can:

a.     Search for alerts by name or status.

b.    Use severity filters to view specific types of alerts.

c.     Customize the display by selecting alert categories of interest.

10. Landing Page:

The Landing Page provides a comprehensive overview of key system components and health indicators. It offers real-time insights across several critical modules, allowing users to monitor the overall state and performance of the system at a glance. The modules displayed include:

The landing page provides a consolidated view of infrastructure health, application uptime, and active alerts across your environment.

  1. Infrastructure Monitoring:

1.1.                 Common Metrics for VMs and OpenShift:

1.1.1.        CPU Usage: Shows current processor usage levels.

1.1.2.        RAM Usage: Indicates memory consumption.

1.1.3.        Disk Usage: Tracks disk space utilization (VM only).

1.1.4.        Network Usage: Monitors network traffic and performance (VM only).

1.2.                 Additional for Virtual Machines (VMs):

1.2.1.        System Status: Displays the real-time operational status of each VM.

1.3.                 Additional for OpenShift:

1.3.1.        Total Nodes: Displays the total number of nodes in the OpenShift cluster based on the configured nodes.

1.3.2.        Active Nodes: Indicates the number of healthy and active nodes from the configured nodes; it does not fetch the total node count or active count for the entire cluster.

  1.  Application Monitoring:

2.1.                 Sterling Integrator (SI):

2.1.1.        SI Uptime: Shows how many days the Sterling Integrator (SI) service has been up and running; in the Lite version, SI Uptime is not monitored and will display as undefined.

2.1.2.        Adapter Status: Displays the status of configured adapters.

2.2.                 Maximo Application Suite (MAS):

2.2.1.        MAS Uptime:Shows since how many days the MAS environment has been up and running; in the Lite version, MAS Uptime is not monitored and will display as undefined.

2.2.2.        MAS Application Versions: Displays the version details of each MAS application.

  1.  Alert Monitoring:

3.1.                 Alert Summary:

3.1.1.        Displays the count of alerts by type (e.g., Critical, Warning, Info).

3.2.                 Alert List:

3.2.1.        Timestamp – When the alert was raised.

3.2.2.        Alert Status – Current state (e.g., Active, Resolved).

3.2.3.        Alert Name – Description or identifier of the alert.

3.2.4.        State – Indicates whether the alert is Paused or Resumed.

 

10.1 Landing Page for VM:

10.1.1 System Status

Displays the current health status of the overall system as a percentage, indicating whether it is operating smoothly or experiencing issues.

10.1.2 RAM

Displays the current memory utilization of the system as a percentage, providing insights into how much RAM is being consumed.

10.1.3 CPU

Shows the current processor usage as a percentage, helping to monitor system performance and detect potential load or bottlenecks.

10.1.4 App Availability

Indicates the number of continuous days the Sterling Integrator (SI) application has been running without interruption, reflecting overall application uptime. In the Lite version of IANN Monitor, this metric is not tracked and will display as undefined.

10.1.5 Alerts Overview

  1. Visualizes all system alerts using a pie chart.

  2. Each color in the chart represents a different alert type.

  3. Hovering over a segment displays the count of alerts for that type.

10.1.6 Disk

Displays disk usage in the form of bar graphs, showing the used storage capacity of available disks.

10.1.7 Network

  1. Network Inbound Traffic: Shows the volume of incoming network traffic, typically measured in bytes/sec.

  2. Network Outbound Traffic: Shows the volume of outgoing network traffic, also measured in bytes/sec.

10.1.8 Alerts List

Provides a detailed list of system alerts, including:

  1. Alert Name: The name or description of the alert.

  2. Timestamp: When the alert was triggered.

  3. Status: Indicates the severity or nature of the alert (e.g., Critical, No-Data).

  4. Resume/Pause: Allows administrators to resume or pause alert tracking as needed.

10.1.9 Adapter Status

  1. Adapter Name: Displays the name or identifier of the adapter.

  2. Status: Shows whether the adapter is Connected or Disconnected. In the Lite version of IANN Monitor, only two configured adapters are monitored.

 

10.2 Landing Page for OpenShift:

The Landing Page provides a real-time overview of critical system metrics through separate, focused modules. Each module highlights a specific aspect of the system’s operational status.

10.2.1 RAM Usage

Shows the current memory utilization as a percentage, offering insights into how much RAM is actively being consumed.

10.2.2 CPU Usage

Displays the current processor usage as a percentage, helping monitor system load and detect potential performance bottlenecks.

10.2.3 App Availability

Indicates the number of continuous days the Sterling Integrator (SI) application has been running without interruption, reflecting overall application uptime. In the Lite version of IANN Monitor, this metric is not tracked and will display as undefined.

10.2.4 System Status:

Provides an overall health indicator or status of the system, indicating whether it is running smoothly or if there are issues.

10.2.5 Alerts Overview

  1. Alerts are visualized using a pie chart, with each color representing a different type of alert.

  2. Hovering a segment displays the count of alerts associated with that type.

10.2.6 Disk Status Module

Displays disk usage percentage using bar graphs, representing the used storage space of each disk relative to its total capacity. In the Lite version of IANN Monitor, this metric is not monitored and will be shown as empty.

10.2.7 Network Status Module

  1. Network Inbound Traffic – Shows the volume of incoming network traffic, measured in MB/sec. In the Lite version of IANN Monitor, this metric is not monitored and will be shown as empty.

  2. Network Outbound Traffic – Shows the volume of outgoing network traffic, measured in MB/sec. In the Lite version of IANN Monitor, this metric is not monitored and will be shown as empty.

10.2.8 Alerts List Module

This module provides a detailed, tabular view of all active alerts:

  1. Alert Name: Displays the name or description of the issue.

  2. Timestamp: Indicates the exact time and date the alert was triggered.

  3. Status: Shows the current status of the alert (e.g., Critical, No-Data).

  4. Resume/Pause: Allows administrators to resume or pause specific alerts as needed.

10.2.9 Adapter Status Module

  1. Adapter Name: Shows the name or identifier of each adapter.

  2. Status: Shows whether the adapter is Connected or Disconnected. In the Lite version of IANN Monitor, only two configured adapters are monitored.

11. Default Dashboard:

The Default Dashboard is a ready-to-use view that displays key system metrics and performance indicators. It includes essential panels to help users quickly monitor system health and performance without any manual setup.

When you click on default dashboard you will get a popup as displayed below.

Need to provide the Dashboard name and select the Notification channel name to which the graphs are to be configured (We can select single or multiple notification channel names) and after clicking ‘create’ the default dashboard is created (takes at least 1min to create).

11.1. Default Dashboard for Sterling Integrator:

         The Default Dashboard for Sterling Integrator includes the following pre-configured panels and graphs, providing a comprehensive overview of system activity and performance.

 

11.1.1. SDE Application Status:

  1. Application Status : Shows if the application is running or stopped.

  2. Server Status : Shows if the server is up or down.

     

11.1.2. Server Metrics:

Server Metrics: It represents metrics of the server.

     

11.1.3. DB Usage:

Purge Count: Under DB Usage, Purge Count is represented with line graph.

     

11.1.4. Pool Info :

Pool Info: It shows the number of available and used connections for any two configured connection pools.

     

11.1.5. Files Processing:

Halted Count : It represents Halted Count in line graph.

 

11.1.6. Adapters:

The status of any 2 configured adapters which are active and inactive for all the different protocols of Sterling integrator.

11.1.7. Schedulers:

This reports Schedulers status of any 2 configured schedulers.

11.1.8. Business Process Reports:

 It shows the details of the BP’s that are running for more than 1 minute.

11.1.9. Queue Depth:

It shows the queue depth of any 2 configured queues.

11.1.10. Community Manager Activity:

It shows trading partner and application partner activity details.

11.1.11. Database Health Check:

DB Status: Graph shows whether the database is up and accessible or down and unreachable.

DB CPU: Graph shows the percentage of CPU resources currently being used by the database.

DB RAM: Graph shows the amount of memory (RAM) currently being used by the database.

DB Response Time: Graph shows the time taken by the database to respond to a query or request.

Active Sessions: Graph shows the number of database sessions that are currently connected and running queries or transactions.

Inactive Sessions: Graph shows the number of database sessions that are connected but idle, not running any active queries.

Total Sessions: Graph shows the sum of active and inactive sessions connected to the database.

11.1.12. Certificate Status:

Table graph shows both CA certificates and System certificates with their name, expiry date, and number of days remaining until expiry.

 

11.1.13. Logs:

 

Logs are generated by Sterling B2B Integrator based on monitoring activity.  

Here we track each component’s activities using the logs provided by Sterling integrator.

11.2 Default Dashboard for Maximo Application:

 The Default Dashboard for Maximo Application includes the following pre-configured panels and graphs, providing a comprehensive overview of system activity and performance.

11.2.1. MAS Application Status:

Shows the application status of MAS.

 

11.2.2. Pod Count:

 It shows the pod count in a configured namespace.

Title: Inserting image...

11.2.3. Node Status and Metrics:

It displays configured Nodes status and metrics which include CPU,RAM.

11.2.4. Namespace Monitoring:

Pod status and metrics monitoring within the given namespace, metrics include CPU,RAM and Restart Count.

11.2.5. Database Health Check:

It displays Database Health Metrics, including DB Status, Response Time, CPU usage, RAM usage, Active Sessions, and Long-Running DB Queries.

 

11.2.6. Application Health:

It displays User Login Tracking details, Active Sessions and schedulers job.

11.2.7. License Expiration:

It displays the details of MAS License Expiration.

11.2.8. Used APP Points:

It displays the Used App Points of MAS Application.

11.2.9. Runtime Logs:

It displays the Runtime Logs of MAS pods.

11.2.10. Auditing Queries:

IANN Monitor tracks Stopped Escalations and Event Listener Status.

11.2.11. SSL Certs Expiration:

It displays SSL Certs details and their Expiration Dates.

Title: Inserting image...

 

12. Access Management:

When you navigate to the Access Management section, you will find two primary options:

  1. Create User

  2. Manage Users

12.1. Access Management – User Creation:

When you click on “Create User”, the system will prompt you to enter the following mandatory details to create a new user:

  1. User ID: A unique identifier assigned to the user.

  2. Password: A secure password for the user account.

  3. First Name: The user’s first name.

  4. Last Name: The user’s last name.

  5. Email: A valid email address for communication and account-related notifications.

  6. Phone: The user’s contact number.

  7. Role: Select a role for the user from the available list.

  8. Status: Set the user’s status (e.g., Active, Inactive).

  9. Environments: Choose one or more environments from the available options.


12.2 Access Management – User Management:

Managing Users

Step 1: Click on “Manage User” to access the user management interface.

In the Manage User section, you can search for and manage existing users using a variety of filters:

  1. User ID: Search by the user’s unique identifier.

  2. First Name: Filter users by their first name.

  3. Last Name: Filter users by their last name.

  4. Email: Search users using their email address.

  5. Role: Filter users based on assigned roles (e.g., SUPER_ADMIN, ADMIN, BUSINESS_ADMIN, BUSINESS_USER).

  6. Status: Filter users by account status (e.g., Active, Inactive).

For both Role and Status, a list of selectable options will be provided, allowing you to choose the appropriate values when managing users.

Note:
 If you leave all fields empty and click “Search User”, the system will display all existing users by default.

User Management Actions

Below the list of users, the following management actions are available:

  1. Edit: Update user details such as name, email, role, or other relevant information.

  2. Delete: Permanently remove the user from the system.

  3. Activate: Enable access for an inactive user, restoring their account privileges.

  4. Deactivate: Restrict access for an active user by marking their status as inactive.

By using these options, you can effectively control and maintain user accounts according to your organizational needs.

12.3 User Roles:

User roles in the IANN Monitor platform determine the level of access and permissions each user has across various modules and environments. These roles help ensure secure, controlled, and role-specific access based on organizational responsibilities.

12.3.1 SUPER_ADMIN

  1. Has unrestricted access to all modules and environments.

  2. When a Super Admin creates another Super Admin, the new user will:

    1. Access Existing Environments: Gain full access to all environments assigned during their creation.

    2. Access Newly Created Environments: Automatically gain access to all environments created after their account is set up, whether added by themselves or by other Super Admins, ensuring uninterrupted administrative access across the platform.

12.3.2 ADMIN

Access Capabilities:

  1. Can create Business Admin (BA) and Business User (BU) accounts with access limited to specific assigned environments.

  2. Access is restricted to only the environments explicitly assigned.

Accessible Modules:

  1. Landing Page

  2. Access Management

  3. Environment Switch

12.3.3 BUSINESS_ADMIN

Access Capabilities:

  1. Can perform edit and delete actions within their assigned environments.

  2. Access is limited to those specific environments.

Accessible Modules:

  1. Landing Page

  2. Create Dashboard

  3. Manage Dashboard

  4. Alerts Data (includes Alerts Page and Notification Channel)

  5. Environment Switch

12.3.4 BUSINESS_USER

Access Capabilities:

  1. Has read-only access within assigned environments.

  2. Access is limited to assigned environments and does not include:

    1. Maintenance Options

    2. Pause & Play functionality for Alerts

Accessible Modules:

  1. Landing Page

  2. Manage Dashboard

  3. Alerts Data (Alerts Page only)

  4. Environment Switch

13. Channel Configuration

The Channel Configuration feature lets you specify which Teams or Slack channels will receive overall environment health updates and critical alerts.

  1. The overall health status of an environment is sent to the configured non-critical alert channel.

  2. Critical alerts are directed to the configured critical alert channel.

This configuration ensures that both critical and non-critical alerts are routed to the appropriate channels for timely visibility and action.

Note: In the IANN Monitor Lite version, only critical alerts are sent.

13.1 Steps to Configure a Channel

Step 1: Navigate to the Channel Configuration page within the IANN Monitor UI.

Step 2: Open the Channel Configuration interface.

Step 3: Select the Application Type – either Teams or Slack.

Step 4: Choose the Channel Type based on your requirement:

Critical – Sends critical alerts for the environment.

Step 5: Configure the Frequency by setting the interval (in minutes or hours) for sending notifications.

Step 6: Provide the appropriate destination based on the selected Application Type:

  1. For Teams, enter the Teams Channel Email ID.

  2. For Slack, enter the Webhook URL.

Step 7: Click Create to save the configured channel.

Note:
 For instructions on obtaining the email address for Microsoft Teams and the webhook URL for Slack, please refer to Section 14 of this Manual.

13.2. Viewing and Managing Channel Configurations.

Step 1: Click on Manage Channel Configuration to view the list of existing channel configurations.

Step 2: In the Actions column,

  1. Click the Edit icon to modify the configuration.

  2. Click the Delete icon to delete a configuration from this section.

 

 

14. Dashboard Backup for Seamless Environment Management:

Managing dashboards across multiple environments is simplified with the Dashboard Backup feature. Rather than recreating dashboards, panels, graphs, queries, and alerts manually, you can now export an existing dashboard and import it into another environment with ease.

14.1 Download Dashboard:

Please follow the below steps to Back Up a Dashboard

Step 1: Go to the Manage Dashboard section.

Step 2: Hover over the dashboard you want to back up.

Step 3: Click the Download icon (as shown in the screenshot below).

Your dashboard file will be downloaded automatically to your system’s Downloads folder.

14.2 Upload Dashboard:

 

Please follow the steps below to upload the Dashboard to a different Environment.

Step 1: Switch to the environment where you want to upload the dashboard.

Step 2: Go to the Manage Dashboard section.

Step 3: Click on the Upload Dashboard button (see screenshot below).

Step 4: In the file selector popup, choose the previously downloaded dashboard file.

Step 5: Click Upload.

That’s it! The dashboard will now be available in the selected environment and will display environment-specific data.

Note: You cannot upload a dashboard to the same environment from which it was exported. Doing so will overwrite the existing dashboard without creating a new one.

 

15. Setting Up Teams and Slack Integrations (Email & Webhook):

15.1. Get Email address for a Teams Channel:

Step 1: In the Microsoft Teams channel that you want to send the email to, click on the three dots in the top right-hand corner and select the “Get Email Address” option from the drop-down menu.

Step 2: In the panel that pops up, click the “Copy” button to save the address to your clipboard.

 

Note: This feature needs to be turned on by your IT admin. Also, sending email to a channel isn’t available if you’re using Teams as part of a Office 365 Government plan.

15.2. Getting Webhook URL for Slack Channel:

Step 1: head over to https://api.slack.com/app, your Slack apps dashboard. It will look something like this:

Step 2: Click on “Create an App”

Step 3: Select “From scratch.” In the next screen, specify a name for your app and click on create.

Step 4: once after creating App, navigate to Incoming Webhooks under features and turn on toggle switch.

Step 5: click on add new webhook to workspace.

Step 6: select to which channel you would like to send notifications and click on allow.

 

 

Step 7: copy the webhook URL.