# Welcome

Welcome to the IT-Conductor Knowledge Base, an extensive resource for those who use the IT-Conductor platform to monitor, manage, and orchestrate enterprise IT through intelligent automation.

Browse our library to find instructions and best practices to Automate, Monitor, Manage, and Orchestrate systems using IT-Conductor. We regularly update our knowledge base to ensure you have access to the latest features and their respective documentation.

You will also find documentation for different [cloud migration scenarios](/user-guide/automation/migration) that may be useful if you are considering moving your environment to the cloud.

### Contact Us

If you can't find what you're looking for, our Support Team is always available to answer your questions and provide additional guidance.

* [General Inquiries](https://www.itconductor.com/contact-us)
* [Submit a Support Ticket](/references/support)

### Additional Information

* [Frequently Asked Questions](https://www.itconductor.com/it-conductor-faq)
* [Visit Our Blog](https://www.itconductor.com/blog)
* [Upcoming Events](https://www.itconductor.com/events)
* [Past Events](https://www.itconductor.com/past-events)
* [Other Resources](https://www.itconductor.com/resources)


# Architecture

IT-Conductor is a fully managed service orchestration and automation platform for remote agentless monitoring, performance management, and SAP/IT operations. It provides a cloud-based service without the need to install any monitoring infrastructure, except for a locally installed Gateway.

<figure><img src="/files/5fbxQPf2fYlcnbISqFcw" alt=""><figcaption><p>Figure 1: IT-Conductor Patented Agentless Platform High-level Architecture</p></figcaption></figure>

IT-Conductor enables each customer (tenant) to deploy multiple gateways, providing scalability for their monitoring needs. This includes support for multi-location setups such as on-premises and public cloud environments. Moreover, network segmentation, such as production and non-production environments, can be easily configured. Lastly, IT-Conductor handles automatic resilience configuration, ensuring primary and failover setups are managed seamlessly.


# API Server

API Server enables on-premises local access to IT-Conductor API interface.

{% hint style="info" %}
**Note:**

* IT-Conductor Gateway serves as a proxy between the local caller and IT-Conductor Service in the cloud.
* At this time only posting the notifications is enabled, but we are planning to expand it in the future based on end-user feedback.
  {% endhint %}


# Sizing

Sizing is a crucial aspect of the IT infrastructure planning process, which involves determining the appropriate resources needed for optimal performance and scalability. In the context of IT-Conductor, sizing refers to understanding the requirements of your environment, such as the number of systems, databases, and applications to be monitored, to ensure that the solution is properly sized to meet your specific needs.

The sizing guide provided below offers valuable insights and recommendations to help you accurately assess and allocate the necessary resources for a successful implementation.

### T-Shirt Sizing Technique

This sizing technique uses t-shirt sizes (XS, S, M, L, XL) under the assumption that having an estimate is better than none. It can be useful for the budget planning phase even when figures may not be clear, assumptions can be made, and validation can occur later.

<figure><img src="/files/CErpVv7AvituDdtZiI93" alt=""><figcaption><p>Figure 1: T-Shirt Sizing Technique</p></figcaption></figure>

Now, think of these t-shirt sizes as hardware requirements where XS requires the least amount of power/memory/etc. and XL requires the most.

<figure><img src="/files/mGsg0zJNyJ3BBRwkAWw9" alt=""><figcaption><p>Figure 2: T-Shirt-to-Hardware Sizing Equivalent</p></figcaption></figure>

### IT-Conductor Sizing Table

To make things much easier, we developed the IT-Conductor Sizing Table based on the T-Shirt Sizing principle to guide you in your sizing exercise.

<table><thead><tr><th width="144">T-Shirt Size</th><th width="163">CPU (Core)</th><th width="197">Memory (Gb)</th><th>Landscape (System)</th></tr></thead><tbody><tr><td>XS</td><td>4</td><td>4</td><td>&#x3C;=25</td></tr><tr><td>S</td><td>4</td><td>8</td><td>&#x3C;=50</td></tr><tr><td>M</td><td>4</td><td>12</td><td>&#x3C;=75</td></tr><tr><td>L</td><td>8</td><td>16</td><td>&#x3C;=100</td></tr><tr><td>XL</td><td>8</td><td>32</td><td>>100</td></tr></tbody></table>

IT-Conductor production Gateway should have a standby/failover Gateway VM of the same size to ensure service resiliency and meet IT-Conductor Service Level Agreement requirements.

{% hint style="info" %}
**Note:** The rule of thumb is 25 systems per 4CPU 4GB. Then add 4GB memory for the next 25 systems. CPU is not usually a constraint.
{% endhint %}


# Dashboard Overview

A monitoring dashboard is a customizable visual interface that displays metric data essential for monitoring system health and performance. Its main purpose is to provide real-time insights, enabling proactive identification of issues that require attention. Dashboards also support continuous improvement by highlighting areas for optimization and enhancement.

In automation scenarios, dashboards play a critical role by allowing users to initiate automation requests through intuitive wizards or service catalog tiles. Users can also monitor the progress of these tasks and access detailed execution logs—all within the same interface.

{% hint style="info" %}
**Note:** Dashboards are customizable. Contact [IT-Conductor Support Team](/references/support) to help you with your dashboard customization requirements.
{% endhint %}

### Default Dashboard

The Default Dashboard is automatically displayed upon logging in to IT-Conductor. It features a set of pre-configured panels, including the Operational Alerts panel, the Alerts panel, and the service grid. Each panel is equipped with an auto-refresh function that updates data every 60 seconds by default. A reload button is also available for manual refresh when needed.

<figure><img src="/files/TP5WAKW4T4nPJ4ApNePT" alt=""><figcaption><p>Figure 1: Default Dashboard</p></figcaption></figure>

### Administrator Dashboard

The Administrator Dashboard provides a comprehensive view of all configured sites, gateways, and monitored systems. The left side of the screen displays the action panels, while the right side features the service grid, providing a structured, color-coded view of systems that makes it easy to identify system health at a glance.

<figure><img src="/files/7yIRT1DUUI5EDEfCvnrr" alt=""><figcaption><p>Figure 2a: Administrator's Dashboard</p></figcaption></figure>

Within this dashboard, administrators have the flexibility to add, modify, or remove systems; view system logs and status; manage user accounts; and schedule or activate maintenance mode as needed.

<figure><img src="/files/Z4ZYFeNd3o4zlOlRRTqe" alt=""><figcaption><p>Figure 2b: Action Panels in Administrator's Dashboard</p></figcaption></figure>

With administrator privileges, you gain access to the following features:

<table><thead><tr><th width="236.5">Systems/Servers</th><th>Description</th></tr></thead><tbody><tr><td><strong>Sites</strong></td><td>Functionalities that allow defining the group of systems</td></tr><tr><td><strong>Gateways</strong></td><td>Remote connections that will enable IT-Conductor to communicate with your on-premise or cloud systems</td></tr><tr><td><strong>SAP Systems</strong></td><td>NetWeaver systems that you can add for monitoring</td></tr><tr><td><strong>SAP Java Systems</strong></td><td>Standard NetWeaver Java systems that can be added for monitoring, including support for advanced PI/PO environment monitoring</td></tr><tr><td><strong>SAP Host Agents</strong></td><td>The foundational layer of SAP monitoring, which IT-Conductor builds upon to provide an additional layer of advanced visibility and control</td></tr><tr><td><strong>SAP HANA Systems</strong></td><td>SAP HANA systems to be monitored, allowing you to track resource usage and overall performance</td></tr><tr><td><strong>Oracle Instances</strong></td><td>Oracle databases to be monitored via Java Database Connectivity (JDBC) for performance, availability, and resource usage tracking</td></tr><tr><td><strong>SAP ASE Servers</strong></td><td>Sybase servers to be monitored, including the thread pools, devices, and database alerts</td></tr><tr><td><strong>Microsoft SQL Servers</strong></td><td>MS SQL Servers that can be monitored to display key metrics such as active transactions, timeouts, and linked server status</td></tr><tr><td><strong>MaxDB Instances</strong></td><td>SAP databases that require monitoring to ensure the availability and performance of production databases</td></tr><tr><td><strong>Linux/Unix Systems</strong></td><td>Linux systems to be monitored via SSH</td></tr><tr><td><strong>Windows Systems</strong></td><td>Windows servers that need to be monitored such as performance and operational statistics of the system</td></tr><tr><td><strong>BusinessObjects Systems</strong></td><td>BOBJ systems to be analyzed and monitored including several BODS components such as repositories, RFC servers, batch jobs, etc.</td></tr></tbody></table>

### CIO Dashboard

The CIO Dashboard is a high-level management dashboard designed to display key operational metrics. It provides an at-a-glance overview of the overall health of the system landscape, including the operational alerts and recovery actions triggered for the last 24 hours.

<figure><img src="/files/KKax2JZTDvy1C8wYmXnh" alt=""><figcaption><p>Figure 3: CIO Dashboard</p></figcaption></figure>

### Tenant Health Dashboard

The Tenant Health Dashboard provides a consolidated snapshot of tenant-wide operational health within IT-Conductor. It displays critical information such as operational alerts, open issues, failed recovery actions, and more. Designed for administrators, service managers, and support teams, this dashboard enables users to quickly identify issues, review ticket updates, and take immediate action when necessary.

<figure><img src="/files/a9FxZKEKjlDCsjOpChEC" alt=""><figcaption><p>Figure 4: Tenant Health Dashboard</p></figcaption></figure>

Here are some of the action panels available on the Tenant Health Dashboard, each designed to highlight critical system activities, alert conditions, and areas that may require attention:

* **Operational Alerts per Role (24h)** - displays a breakdown of active alerts for the last 24 hours, categorized by system role (e.g., Demonstration, Development, Production).
* **Operational Alerts per Service (7 day)** - displays alerts grouped by monitored service, providing quick insight into which services are experiencing issues for the last 7 days.
* **Open Issues** - lists all unresolved operational issues currently affecting monitored systems and/or services.
* **Failed Recovery Actions** - lists all automated recovery attempts that were triggered but failed, indicating areas requiring manual intervention.
* **No Values Alerts** - identifies metrics or checks that are not returning data, which may signal data collection issues.
* **Disconnected Systems** - flags systems that are not currently communicating with IT-Conductor and may be offline or unreachable.
* **Disconnected Gateways** - flags gateway(s) that are not connected, which directly impact data collection, monitoring, and execution of automated workflows.
* **Systems in Maintenance Mode** - lists systems that are temporarily excluded from monitoring due to scheduled maintenance or manual suspension.
* **SAP Transports** - displays recent IT-Conductor core transport available in a system, which is used to enable advanced monitoring features.
* **Updated Tickets** - displays recently updated support tickets, helping teams track ongoing or escalated issues.

### Help Desk Dashboard

The Help Desk Dashboard provides a centralized view of support ticket activity, helping teams manage and respond to incidents efficiently. It includes panels for viewing incidents by status and category, a ticket search function, and a breakdown of tickets by status (i.e., Assigned, Waiting for Response, Resolved, and Rejected).

<figure><img src="/files/5lNX07icMg5hcATsORPu" alt=""><figcaption><p>Figure 5: Help Desk Dashboard</p></figcaption></figure>

### SAP Basis Dashboard

The SAP Basis Dashboard is a role-based dashboard customized for SAP Basis administrators, providing focused visibility into specific systems they manage for monitoring, troubleshooting, and operational tasks.

<figure><img src="/files/leLXnTFvoTVRFWT4h5NV" alt=""><figcaption><p>Figure 6: Custom SAP Basis Dashboard</p></figcaption></figure>

Here are some of the configurable action panels that support SAP Basis administrators:

* **Availability Panel** - displays the availability status of high-priority systems, enabling quick detection of any disruptions. Administrators can easily drill down into individual systems for further investigation.
* **Operational Alerts** - captures alerts generated within the last 24 hours across all monitored systems, helping identify recent issues that may require attention.
* **Performance Overview** - highlights key performance metrics for a selected system, such as Front-end Response Time, Dialog Users Logged In, and Dialog Response Time, providing valuable insight into system behavior.

### Other Available Dashboards

* [SAP HANA Overview Dashboard](/user-guide/monitoring/database/sap-hana-system/overview-dashboard)
* [SAP ABAP Overview Dashboard](/user-guide/monitoring/sap/netweaver/abap-system/overview-dashboard)
* [SAP Automated User Unlock Dashboard](/user-guide/automation/sap-user-unlock-and-password-reset#dashboard)
* [SAP Start/Stop Automation Dashboard](/user-guide/automation/start-stop#dashboard)
* [SAP Transport Request Dashboard](/user-guide/automation/sap-transport#sap-transport-request-dashboard)
* [SAP on Azure Migration Dashboard](/user-guide/automation/migration/oracle-to-ase#sap-on-azure-migration-dashboard)
* [SAP SLT Dashboard](/user-guide/monitoring/sap/netweaver/abap-system/slt-and-rfc-connection-monitoring#sap-slt-dashboard)
* [System Refresh/Copy Dashboard](/user-guide/automation/e2e-system-refresh#system-refresh-copy-dashboard)

### Service Grid

The Service Grid is a feature in IT-Conductor that provides a structured, expandable view of monitored systems and services. Monitoring involves analyzing large volumes of data and metrics, and diagnosing issues can be complex. The Service Grid helps simplify this process by allowing users to drill down into different service levels, making it easier to locate relevant data for troubleshooting and root cause analysis. It displays both real-time and historical metrics collected from monitored systems, enabling comprehensive visibility into system health and performance over time.

![Figure 7: Service Grid](/files/LiIJkTohC4PxzMRV4m8N)

### Video

{% embed url="<https://vimeo.com/251236679>" %}


# Monitoring Concepts

IT-Conductor Monitoring is built around two concepts: Threshold and Override.

### **Threshold** <a href="#monitoringconcepts-threshold" id="monitoringconcepts-threshold"></a>

A threshold defines what to monitor, specifying one or more objects and their associated attributes that contain the monitored values. These thresholds are auto-generated by IT-Conductor from templates when you create an SAP instance. Users with the necessary permissions can also create additional thresholds as needed.

For complex scenarios, feel free to reach out for assistance from [IT-Conductor Support Team](/references/support).

### **Override** <a href="#monitoringconcepts-override" id="monitoringconcepts-override"></a>

Override defines the methodology for monitoring, encompassing threshold values that trigger status changes and alert generation. It includes search criteria used to match a specific monitored object. When a threshold tries to determine what values to use, it selects a single override with the most precise criteria that match the monitored object based on the proximity of the criteria class to the object class and criteria size.

{% hint style="info" %}
**Note:** Overrides are created by users for existing thresholds.
{% endhint %}

See [Creating Threshold Overrides](/user-guide/notifications/threshold-overrides) for more details.

### Alerts and Notifications <a href="#monitoringconcepts-alertsandnotifications" id="monitoringconcepts-alertsandnotifications"></a>

![Figure 1: IT-Conductor Alerts and Notifications Flow Chart](https://service.itconductor.com/iconShow?iconName=Help.monitoring.alerting.notification)


# Application Performance Management

Application Performance Management (APM) refers to the practice of monitoring and analyzing the overall health of software applications. It involves capturing various metrics, such as response times, resource utilization, and error rates, to gain insights into application performance and identify areas for optimization.

IT-Conductor APM is delivered as a full-service model covering configuration monitoring and performance analysis. By leveraging the power of the hosted service offering, IT-Conductor significantly reduces deployment complexities and ongoing maintenance, allowing full spectrum availability and performance management in a matter of hours even for highly intricate and large-scale environments.

By securely deploying a small IT-Conductor Gateway (proxy agent) within your network and leveraging best-practice application templates, automated and effective application monitoring and management become remarkably streamlined.

### Complete SAP Ecosystem Monitoring <a href="#servicehealthmonitoring-video" id="servicehealthmonitoring-video"></a>

IT-Conductor seamlessly manages the whole SAP technology stack – from Front-End Services down to Cloud/Virtualization infrastructure: SAP NW (ABAP & Java), BusinessObjects, Hadoop, DBMS (HANA, Oracle, ASE, MaxDB, DB2), SAP Host Agent, Linux, VMWare, Azure, and AWS.

In-depth Application Management for major SAP Ecosystem Components: IT-Conductor is not a superficial tool – it is an in-depth end-to-end management platform – it goes as deep as customers need for any of the ecosystem elements.

<figure><img src="/files/ujqrTcQXrFMkE0EL6vvr" alt=""><figcaption><p>Figure 1: 360-degree View of Application Environment</p></figcaption></figure>

See [SAP Application Monitoring](/user-guide/monitoring/sap) for more information.

### Video <a href="#servicehealthmonitoring-video" id="servicehealthmonitoring-video"></a>

{% embed url="<https://youtu.be/0ltwly9YrnE>" %}


# Availability Monitoring

Availability Monitoring determines the operational status of an application, service, or infrastructure component. It is a vital aspect when monitoring systems and applications. However, availability information alone is not useful without the service context and its relationship to Service Level Objectives (SLO).

SLO defines the desired availability (i.e., percentage over time) and how it should be measured (i.e., sampling interval and calculation window).

![Figure 1: Availability Monitoring Chart in IT-Conductor](/files/ucTaKFnCAdI4cDydIIIX)

### Service Availability Monitoring of SAP Landscapes

The availability of services can be very different from component availability.

<figure><img src="/files/rBAqiS2pxNJhpBgn0tdG" alt=""><figcaption><p>Figure 2: Availability and Performance Monitoring</p></figcaption></figure>

In the context of monitoring SAP, you must understand that the application is just a portion of an entire system landscape.

For example, consider SAP ERP, an SAP application, which may appear to have uninterrupted availability for end-users. However, one or more of its underlying infrastructure components, such as application servers, message servers, enqueue servers, and database servers, can experience intermittent downtime.

If the architecture is deployed with the appropriate high-availability (HA) configuration, where infrastructure components will have redundancies to ensure all the single points of failure are covered, then the service may be 100% available while the redundant components can be less than 100%. With proper service monitoring, these can be properly distinguished and managed accordingly.

#### Multi-Component Service Availability Monitoring

IT-Conductor can monitor the availability of user-defined services and the supporting infrastructure components with more flexibility. Using the platform's parallel processing engine, service availability monitoring would be simplified by depicting a correlation of the individual components of the operating system in such a way that you can easily see at a glance if a service is available or not, in relation to the other dependent components as well.

<figure><img src="/files/NCLDpdb9XDYBnMiqqzjt" alt=""><figcaption><p>Figure 3: Multi-Component Service Availability Monitoring in IT-Conductor</p></figcaption></figure>


# Performance Intelligence

The ability to monitor and analyze events from yesterday, last week, or last month, within the same time frame or reference point, presents a noteworthy challenge. Achieving this requires a synchronized data series.

IT-Conductor monitors the performance of services, applications, and IT infrastructure through a predefined and custom set of Key Performance Indicators (KPIs). These time dimensions not only support active service level management but also enable retrospective troubleshooting by facilitating correlation, comparisons, and historical snapshots.

### Performance Monitoring in SAP Landscapes

In the context of monitoring the performance of SAP systems, IT-Conductor helps enhance performance management in the following areas:

* End-user experience services can track specific sets of key performance indicators for a custom set of metrics, such as user, transactions, locations, dialog vs HTTP, etc.
* Service discovery of application-aware components and relationships
* Composite services assembled from other services and monitors
* Easily configure target availability, response times, and notifications if the goals are not met.
* Drill down into services to discover the root cause.

Performance Monitoring also involves the measurement of performance against a customized set of key performance indicators (KPIs) over a period of time. This requires synchronized data series. However, response time is a misleading indicator of performance. To put it into perspective, a system may have a 0.5-second response time, but there may still be constant complaints from users with bad response times.

The better way would be to create groups of transactions, by any combination of these attributes such as TCODE, USER, TASK TYPE, APP SERVER, USER TERMINAL, etc. They may represent business processes, such as Sales-Order-to-Cash, and service level objectives may be set up for average response times across orders (VA01, VA02, VA03), delivery (VL01N, VL02N, VL03N), shipping (VT01N, VT02N, VT03N), and billing (VF01, VF02, VF03). Then aggregate their KPIs where the default would still be dialog response time but it could be database response time, network GUI time, etc. Monitor and manage them automatically against service-level objectives and trigger actions based on policy-based exceptions such as alerts and notifications. All that along with other application, database, and system metrics as well as events so that correlation can be used if needed during performance analysis.

There's a multitude of data to analyze. It would be difficult to diagnose when issues occur. In the context of troubleshooting, correlation plays a huge part in finding out the root cause of the problem.

IT-Conductor makes it easier for you to associate this information through the expandable service grid levels.

![Figure 5: Expandable Service Grid Levels by Component](/files/U6CiiWd74cxKMEO42rlS)


# Service Level Management

Traditional Service Level Reports are static and provide retrospective insights, offering limited utility for troubleshooting and proactive management. IT-Conductor bridges this gap by providing a highly adaptable service definition with dependencies, such as servers and resource utilization, which directly impact service performance.

IT-Conductor enhances service level management in the following areas:

* End-user experience services can track specific sets of key performance indicators for a custom set of metrics, such as user, transactions, locations, dialog vs. HTTP, etc.
* Service discovery of application-aware components and relationships
* Composite services assembled from other services and monitors
* Easily configure target availability, response times, and notifications if the goals are not met
* Drill down into services to discover the root cause

### Multi-Dimensional Workload and Transaction Analysis

IT-Conductor intelligently views performance by dynamically cross-referencing and altering analytical dimensions based on the preferences of performance analysts or the context of time-synchronized service data. This flexibility enables in-depth point-in-time and trend analysis across several technical components and application instruments.

<figure><img src="/files/69s0mdULGCxE6sZKUlRx" alt=""><figcaption><p>Figure 1: Time-Synchronized Troubleshooting</p></figcaption></figure>

This approach combines the Availability monitoring of applications and infrastructure components, together with performance KPIs, events from source system alerts, and threshold exceptions.

* Service disruptions trigger alerts and notifications can lead directly to the point of time when the Availability was detected, further allowing the drill down to locate potential root causes of incidents and events.
* IT-Conductor uses advanced troubleshooting context which automatically time synchronizes various service health components in order to assist in the root-cause determination.
* IT-Conductor templates simplify the correlation between complex application components and how they relate as well as impact overall performance and availability.
* This method has proven effective in reducing analysis time which in turn enhances the overall IT service quality.

### Dynamic Service Level Management

IT-Conductor provides integrated Service Level Management (SLM) on top of the application and system monitoring. The following are its key features:

* Dashboards support operational service level monitoring and compliance.
* Service Level Agreement & Operational Level Agreement proactively managed for compliance
* Automated and flexible report generation and delivery
* Service desk integration with notifications to ITSM platforms that support web services API, and charts built into email notifications which can be further drilled down.

<figure><img src="/files/6M9edXULQ64yAJcyevAJ" alt=""><figcaption><p>Figure 2: Dynamic Service Level Management</p></figcaption></figure>


# Synthetic Transaction Management

IT-Conductor can improve the application availability and performance monitoring by integrating test transactions and reports in a coordinated manner across the application landscape.

* Test critical processes on a frequent basis to ensure the availability and performance of service levels for them are constantly monitored.
* When possible, simulate end-user experience from various points of entry to the service or application using robots or scripts that can be triggered centrally but executed remotely.
* Baseline performance during different time periods got trend analysis and exception-based alerting.
* Transaction-level monitoring
* Integration with Performance Load Testing

<figure><img src="/files/FAvw25Ct1r6QDHbktnJU" alt=""><figcaption><p>Figure 1: Synthetic Transaction Management</p></figcaption></figure>


# Alerts Management

Most monitoring solutions treat alerts as raw events without much context or relationship.

<figure><img src="/files/HtpKP37mynxHPD5cHTwi" alt=""><figcaption><p>Figure 1: Root Cause Analysis</p></figcaption></figure>

IT-Conductor manages alerts more effectively by using policy-based exceptions where alerts can be filtered, time-synchronized, and automatically recovered, including targeted notification to the right analyst reducing mean time to repair (MTTR).

![Figure 6: Alert Management in IT-Conductor](/files/lwr6m9i52wGvGtWy1S12)

Alerts are configured in IT-Conductor using the concept of [thresholds and overrides](/overview/monitoring-concepts).

See [Creating Threshold Overrides](/user-guide/notifications/threshold-overrides) for more information.

After setting up the IT-Conductor Gateway and configuring the required parameters for the monitored systems, the platform will start receiving different metrics. Using thresholds and overrides, IT-Conductor can send out alert notifications via e-mail, provided that the user has subscribed to receive notifications for that specific service.


# Reporting & Analytics

With the wealth of data being received from monitored systems, IT-Conductor is purpose-built to present real-time metrics within the Service Grid.

In Figure 1 below, you can observe how the Service Grid can be expanded right down to the most granular component in your system landscape. This streamlined approach simplifies troubleshooting, eliminating the need for constant system logins, script execution, or manual commands to access the required metrics.

![Figure 1: Sample Real-time Tablespaces Utilization](/files/u36CtbSaSQirg0y6n2aX)

Moreover, you can preview the historical chart when you click directly from the Service Grid.

![Figure 2: Preview Historical Chart from Service Grid](/files/GhJ7ukbK57qSqCu6CFAG)

![Figure 3: Sample Historical Chart (Tablespace Size)](/files/R2X26aFgQZiTrw37KVrJ)

These charts can be customized depending on how the user wants to consume the information.

### Available Reports in IT-Conductor

Here are some of the reports that you can generate on the platform:

<figure><img src="/files/bIsm0uzun9ddWC4GogPk" alt=""><figcaption><p>Figure 4: Service Performance Overview</p></figcaption></figure>

<figure><img src="/files/auXtzI9jKOhmGaWASEmC" alt=""><figcaption><p>Figure 5: CCMS Alerts</p></figcaption></figure>

<figure><img src="/files/U4JRASOhH7ptOoDW516O" alt=""><figcaption><p>Figure 6: Shortdumps CCMS Alert Counts</p></figcaption></figure>

<figure><img src="/files/oUthJJ2NHmIcGDFwq4JN" alt=""><figcaption><p>Figure 7: Failed Batch Jobs</p></figcaption></figure>

<figure><img src="/files/id2plEOTQ8dLVoSV8wo9" alt=""><figcaption><p>Figure 8: Aborted Background Jobs</p></figcaption></figure>

![Figure 9: Used % Overview](/files/ED1XjJD3FBkfNOKEej8m)


# Infrastructure Monitoring

Infrastructure monitoring is the process of continuously collecting and analyzing the performance, availability, and health of an organization's IT infrastructure components. It systematically monitors servers, networks, databases, applications, and interconnected systems to detect, diagnose, and address any issues affecting their functionality. By utilizing specialized tools and methodologies, infrastructure monitoring ensures real-time visibility into the operational aspects of the infrastructure, enabling proactive management, timely troubleshooting, and optimization of resources to maintain seamless operations.

### Types of Infrastructure Monitoring <a href="#types-of-infrastructure-monitoring" id="types-of-infrastructure-monitoring"></a>

There are two types of infrastructure monitoring: agent-based monitoring and agentless monitoring. Understanding the advantages and disadvantages of each type is crucial in selecting the most suitable approach to an organization's specific requirements, infrastructure complexity, and operational objectives.

#### **Agent-based Monitoring** <a href="#agent-based-monitoring" id="agent-based-monitoring"></a>

Agent-based monitoring involves the utilization of software agents to collect data from various components of an infrastructure. These agents are dedicated components responsible for collecting, processing, and reporting data to a central monitoring platform.

One significant advantage of agent-based monitoring is its ability to continue collecting data even if the network connection between the monitored system and the monitoring platform is interrupted or lost. In such cases, these agents can buffer the collected data and transmit it to the monitoring platform once the network connection is re-established, ensuring data integrity and continuity of monitoring operations.

#### Agentless Monitoring <a href="#agentless-monitoring" id="agentless-monitoring"></a>

Agentless monitoring involves gathering performance metrics from infrastructure components without installing additional software agents on the devices being monitored. This method relies on established technologies such as Simple Network Management Protocol (SNMP), Windows Management Instrumentation (WMI), and Hypertext Transfer Protocol (HTTP) to access and collect relevant data from the monitored systems. Furthermore, agentless monitoring operates with minimal intrusion and overhead on the monitored systems, reducing resource consumption and potential conflicts within the infrastructure.

As an agentless monitoring solution, IT-Conductor excels in its ability to monitor, manage, and orchestrate applications and their associated infrastructure components within a single interface.

See [Unified Monitoring](/overview/monitoring-concepts/unified-monitoring) for more information.

### Infrastructure Components <a href="#infrastructure-components" id="infrastructure-components"></a>

Modern IT infrastructure comprises several interdependent components, each playing a crucial role in ensuring the smooth operation of an organization's technological ecosystem. These components encompass a wide array of hardware, software, and networking elements, collectively forming the backbone of an organization's IT environment. Understanding these components is essential for comprehensive infrastructure monitoring.

#### Servers <a href="#servers" id="servers"></a>

Servers act as the core computing systems within an infrastructure, hosting applications and their data. The most common types of servers used in enterprise environments are file servers, application servers, web servers, and database servers, each with specific functions essential for managing business operations.

Monitoring server health involves a comprehensive assessment of their availability and performance. This ensures that these systems operate optimally, providing uninterrupted service to users while mitigating potential bottlenecks or system failures that could lead to costly downtime. The most common server performance metrics that need to be monitored are the following:

* **CPU Utilization** - refers to how much of the CPU resource capacity is used by all the running services and applications on a server. It is often represented in percentages (%).

<figure><img src="/files/tY7XifiPp68oUjMfmO2k" alt=""><figcaption><p>Figure 1: CPU Utilization Chart in IT-Conductor</p></figcaption></figure>

* **Memory Utilization** - refers to how much of the memory resource capacity is utilized by all the running services and applications in a server. It is often represented in percentages (%).

<figure><img src="/files/Dcj6toxM3ryMhQOVk88l" alt=""><figcaption><p>Figure 2: Memory Utilization Chart in IT-Conductor</p></figcaption></figure>

* **Disk Utilization** - refers to how much of the disk resource capacity is used.

<figure><img src="/files/piNE3swD5xbGy5jFF6Dc" alt=""><figcaption><p>Figure 3: Disk Utilization Chart in IT-Conductor</p></figcaption></figure>

Here are some of the server types that can be monitored using IT-Conductor:

* [Windows System Monitoring](/user-guide/monitoring/infrastructure/os/windows-system)
* [Linux System Monitoring](/user-guide/monitoring/infrastructure/os/unix-linux-system)
* [SAP J2EE Server Monitoring](/user-guide/monitoring/sap/netweaver/j2ee-system)
* [Microsoft SQL Server Monitoring](/user-guide/monitoring/database/microsoft-sql-server)
* [Centralized Syslog Monitoring](/user-guide/monitoring/general/central-syslog-server)

#### Database <a href="#database" id="database"></a>

Databases store and manage critical organizational data. They encompass a wide array of information, ranging from structured data, which fits neatly into predefined categories, to unstructured data, which includes content like documents, images, and multimedia files.

Monitoring databases involves a meticulous process to ensure their optimal performance and reliability. This includes tracking various key metrics such as the following:

* **Response Time** - refers to the duration a database system takes to respond to a specific query or transaction request initiated by a user or an application.
* **Database Throughput** - refers to the rate at which a database system processes and handles data transactions over a specified period.
* **Query Performance** - refers to the efficiency and speed with which a database system executes and responds to queries initiated by users or applications.

Here are some of the database types that can be monitored using IT-Conductor:

* [SAP HANA Monitoring](/user-guide/monitoring/database/sap-hana-system)
* [SAP ASE Database Monitoring](/user-guide/monitoring/database/sap-ase)
* [SAP MaxDB Monitoring](/user-guide/monitoring/database/sap-maxdb)
* [IBM DB2 Monitoring](/user-guide/monitoring/database/ibm-db2)
* [Oracle Database Monitoring](/user-guide/monitoring/database/oracle)
* [Microsoft SQL Server Monitoring](/user-guide/monitoring/database/microsoft-sql-server)

#### Applications <a href="#applications" id="applications"></a>

Applications are the diverse array of software programs or services designed to perform specific tasks or functions. They encompass a wide spectrum, ranging from readily available software solutions to custom-developed applications developed to meet specific business needs and workflows.

Monitoring applications involves tracking various performance metrics such as the following:

* **Application Availability** - indicates whether an application is in UP or DOWN state; measures the uptime and downtime.
* **Average Response Time** - refers to the average response time over a specified period.
* **Peak Response Time** - refers to the longest recorded response time within a specified period.
* **Error Rate** - refers to the percentage of the number of requests that result in an error over a specified period.
* **Timeout** - refers to the time the application is idle or not responding to requests.
* **Retries** - facilitates the ability of applications to handle transient failures.
* **Jitters** - inserts variation in time when a request or any remote call is initiated.

In the case of intricate applications like managing an SAP landscape, a multifaceted approach to monitoring becomes indispensable.

See [Application Performance Management](/overview/monitoring-concepts/application-performance-management) for more information.

#### Network <a href="#network" id="network"></a>

Network components like routers, switches, and firewalls collectively create the essential connectivity framework that enables seamless communication and efficient data transfer across various devices and systems.

Monitoring network infrastructure involves continuous evaluation and analysis of various network performance metrics such as the following:

* **Network Availability** - refers to the state or condition of a network being operational and accessible for users or devices to transmit and receive data without interruption or downtime.
* **Network Bandwidth** - refers to the maximum data transfer rate or capacity of a network communication channel, representing the amount of data that can be transmitted over a specified period.
* **Network Throughput** - refers to the actual rate of successful data transmission over a specified period.
* **Network Latency** - refers to the time delay that occurs when data packets travel from one point to another within a network.

#### Cloud Components <a href="#cloud-components" id="cloud-components"></a>

Cloud infrastructure consists of various components that collectively provide computing resources and services. Some key components include:

* **Compute** - includes virtual machines (VMs), containers, and serverless computing services that enable the execution of applications and workloads.
* **Storage** - refers to the resources used to store data such as object storage, block storage, and file storage services (e.g., Amazon S3, Azure Blob Storage, Google Cloud Storage).
* **Networking** - refers to the components that manage the connectivity between various resources and services. It includes virtual networks, load balancers, content delivery networks (CDNs), and services (e.g., Amazon Virtual Private Cloud (VPC), Azure Virtual Network, Google Cloud Load Balancing).

Cloud monitoring helps track the performance, availability, and health of cloud resources, allowing administrators to optimize usage and identify issues proactively.

Here are some of the public cloud environments you can monitor using IT-Conductor:

* [AWS Monitoring](/user-guide/monitoring/cloud/aws)
* [Microsoft Azure Monitoring](/user-guide/monitoring/cloud/microsoft-azure)


# Unified Monitoring

Unified Monitoring is a comprehensive monitoring approach that consolidates data from various sources, such as servers, network devices, applications, and databases, allowing IT teams to monitor their entire IT environment from a single platform. This holistic approach to monitoring provides real-time visibility into the availability and performance of applications and infrastructure resources, enabling organizations to identify issues quickly and respond proactively.

### Data Collection and Sources <a href="#data-collection-and-sources" id="data-collection-and-sources"></a>

IT-Conductor can collect data from various resources including:

* **Applications** - such as application response times, error rates, and resource consumption
* **Databases** - such as query performance, connections, and storage utilization
* **Cloud Services** - such as cloud resource utilization, performance, and cloud costs
* **Servers** - such as CPU utilization, memory utilization, and disk space either on-premises or in the cloud
* **Middleware** - such as message processing times and integration systems (e.g., MuleSoft and SAP PO)
* **Storage Systems** - such as storage performance, capacity, and utilization
* **Network Devices** - such as network traffic, latency, and error rates
* **Security Devices** - such as security events and threat detection
* **End User Devices** - such as printer status, request age, and request count
* **Web Applications** - such as web application performance, page load times, and user interactions

### Data Visualization <a href="#data-visualization" id="data-visualization"></a>

Monitoring becomes effortless by transforming raw data into visually intuitive representations such as graphs, charts, and dashboards. Data visualization distills complex datasets into easily understandable visuals, enhancing the accessibility of information. Trends, patterns, and anomalies become evident, empowering users to identify performance bottlenecks and draw actionable insights quickly.

#### Service Grid <a href="#service-grid" id="service-grid"></a>

IT-Conductor simplifies monitoring and troubleshooting through its signature Service Grid, facilitating the seamless association of information on a single pane of glass. This unified view provides a comprehensive snapshot of all your resources, and their relationship in delivering a service, altogether allowing you to observe your entire ecosystem at a glance including service level impacts.

The IT-Conductor Service Grid includes a feature that enables you to display services in warning and higher states. By clicking this button, any components or metrics exceeding defined thresholds will be highlighted across your system landscape. Regardless of the depth of the breached metric, this feature saves you the time of expanding multiple branches or drilling down through several layers of hierarchy before pinpointing the root cause of the problem impacting the overall service health.

<figure><img src="/files/U6cRn59TculSq8LFCBxS" alt=""><figcaption><p>Figure 1: IT-Conductor Service Grid</p></figcaption></figure>

The IT-Conductor Service Grid is designed with expandability in mind, allowing you to explore every component in your ecosystem. You can easily toggle the triangular arrow (►) icon as you drill down to your desired component or make use of the decrease/increase grid depth (**<<** **>>**) icon to expand multiple branches at once.

#### Health Explorer <a href="#health-explorer" id="health-explorer"></a>

Identifying the root cause of a problem in enterprise environments often involves analyzing the health status, connections, and dependencies between various system components. In this context, correlation plays a significant role in highlighting interactions between different systems and applications, demonstrating how changes in one area can impact others. This multifaceted understanding is crucial for efficient troubleshooting.

The IT-Conductor Health Explorer facilitates the troubleshooting and detecting the root cause of a problem in your system landscape with just a click of a button. It allows navigating through various time intervals and correlating data from different system components to highlight areas causing problems or potential issues. Automating a timeline story of what happened and when, as well as what the causes and effects on services is a significant part of the RCA process.

<figure><img src="/files/DmaogHruqJWSCQLvSR0t" alt=""><figcaption><p>Figure 2: IT-Conductor Health Explorer</p></figcaption></figure>

#### Graphs and Charts <a href="#graphs-and-charts" id="graphs-and-charts"></a>

Each monitored system or component has its corresponding monitored metrics. Each metric corresponds to a set of contextualized data points, providing a graphical representation of a metric over a period of time.

You can easily view graphs and charts from the same view in the IT-Conductor Service Grid.

<figure><img src="/files/jH3cwCubrXGzYj2zpj1v" alt=""><figcaption><p>Figure 3: Graphs and Charts in IT-Conductor Service Grid</p></figcaption></figure>

{% hint style="info" %}
**Note:** Contexts can be related or correlated if the data is time-synchronized. If services are comprised of several components, then the data collected from those components should be available in the same time series. See [Service Performance Management](/overview/monitoring-concepts/application-performance-management/service-performance-management) for more information.
{% endhint %}

#### Dashboards <a href="#dashboards" id="dashboards"></a>

Monitoring an enterprise environment involves a variety of priorities among different teams. What one team deems as critical may not align with the priorities of another, leading to different sets of monitoring focus. In this context, it’s important to emphasize a tailored approach, aligning your monitoring efforts with your team’s specific objectives and ensuring that you concentrate on what truly matters to your unique requirements.

With IT-Conductor Dashboards, you gain the ability to create a customized view that caters precisely to your team's priorities, streamlining the monitoring process and ensuring that you remain focused on the aspects of your ecosystem that are most vital for your objectives. An additional benefit is to turn any dashboard into a report and automate its delivery to recipients providing scheduled snapshots of what users are interested in.

See [Dashboard Overview](/overview/dashboard) for more information.

<figure><img src="/files/p8DiKgaNzAzH2Gy7GVvg" alt=""><figcaption><p>Figure 4: S/4HANA Dashboard in IT-Conductor</p></figcaption></figure>

### Reporting <a href="#reporting" id="reporting"></a>

Analyzing data for trends and anomalies, and generating reports for historical analysis is a critical aspect of monitoring and management of applications and infrastructure resources. This practice serves as the compass for understanding the evolving landscape of IT, aiding in the early identification of deviations and facilitating strategic planning based on past performance.

Here are the reporting features of IT-Conductor:

* **Data Aggregation:** Historical data is aggregated over specific time intervals (e.g., daily, weekly, or monthly) to create summarized datasets.
* **Report Templates:** Report templates are designed to specify the format, structure, and content of the reports. They may include tables, charts, graphs, heat maps, and texts.
* **Narrative Context:** Reports often include descriptions that provide contexts to the data presented.
* **Automation:** Reports can be scheduled to be generated and distributed on a regular basis.
* **Archiving and Accessibility:** Historical reports are archived for reference and compliance purposes. They should be easily accessible to authorized users for future analysis.

See [Reporting](/user-guide/reporting) for more information.

### Alerting and Notification <a href="#alerting-and-notification" id="alerting-and-notification"></a>

In Unified Monitoring, configuring and triggering alerts is a vital component of proactive IT management.

Here's an overview of how IT-Conductor can be used for alerting and notifications:

#### Configuration of Alerts <a href="#configuration-of-alerts" id="configuration-of-alerts"></a>

* **Alert Creation:** IT teams define specific conditions or thresholds that, when met or exceeded, should trigger an alert. These conditions could be based on various metrics such as CPU usage, memory consumption, response times, error rates, or any other key performance indicators.
* **Severity Levels:** Alerts are often categorized into different severity levels, such as critical, warning, or informational. This helps prioritize responses based on the urgency of the issue.
* **Escalation Policies:** Teams establish escalation policies that dictate the sequence of actions to take when an alert is triggered. For instance, if the issue remains unresolved after a certain period, the alert might be escalated to a higher level of support.

#### Triggering Alerts <a href="#triggering-alerts" id="triggering-alerts"></a>

* **Continuous Monitoring:** IT-Conductor continuously monitors the configured metrics and conditions in real-time. If a metric exceeds the configured threshold or condition, the system triggers an alert.
* **Event Correlation:** Event correlation techniques are used to reduce alert noise. It analyzes multiple metrics and conditions to identify the root cause of a problem and trigger alerts based on the underlying issue, not just individual symptoms.
* **Scheduling:** You have the option to define the effective start time for generating alerts based on thresholds.

#### Sending Notifications <a href="#sending-notifications" id="sending-notifications"></a>

* **Notification Channels:** IT teams configure notification channels, such as email, SMS, instant messaging, or integration with incident management platforms (e.g. Microsoft Teams Channel, Slack Channel, ITSM ticket desk, etc.) - covered in the Integration section below, to receive alerts.
* **Recipient Groups:** Notifications can be sent to predefined recipient groups, ensuring that the right individuals or teams are alerted based on the nature and severity of the issue.
* **Scheduled Maintenance:** IT-Conductor includes features for scheduled maintenance, allowing IT teams to temporarily suppress alerts during planned maintenance windows to avoid unnecessary notifications.
* **Alert History:** IT-Conductor maintains an alert history, which includes the details of all triggered alerts and their resolutions. This helps IT teams track the incident lifecycle and identify recurring issues.

See [Alerts Management](/overview/monitoring-concepts/application-performance-management/alerts-management) and [Notifications](/user-guide/notifications) for more information.

### Integration with Other IT Tools <a href="#integration-with-other-it-tools" id="integration-with-other-it-tools"></a>

IT-Conductor integrates with other IT tools to create a seamless and efficient IT management ecosystem. This further optimizes operations and enhances overall productivity.

#### Incident Management & Response Tools <a href="#incident-management-and-response-tools" id="incident-management-and-response-tools"></a>

IT-Conductor can be integrated with incident management platforms, such as Jira Service Desk, Derdack EA, and PagerDuty. When an alert is triggered due to an issue or anomaly, IT-Conductor can automatically create an incident ticket and/or trigger a notification message in the incident management system. This integration streamlines the incident resolution process by ensuring that every detected problem is appropriately logged and tracked in the incident management system.

Explore the following pages to learn more about this integration feature of IT-Conductor:

* [Jira Service Desk Integration](/user-guide/notifications/integration-providers/jira-service-desk)
* [Derdack EA Integration](/user-guide/notifications/integration-providers/derdack-ea)
* [PagerDuty Integration](/user-guide/notifications/integration-providers/pagerduty)

#### Collaboration Tools <a href="#collaboration-tools" id="collaboration-tools"></a>

IT-Conductor can be integrated with collaboration tools, such as Microsoft Teams and Slack. By integrating monitoring with collaboration tools, teams gain the capability to maintain vigilant real-time monitoring and take preemptive action on issues, ultimately fostering a collaborative and adaptable workspace.

Explore the following pages to learn more about this integration feature of IT-Conductor:

* [Microsoft Teams Integration](/user-guide/notifications/integration-providers/microsoft-teams)
* [Slack Integration](/user-guide/notifications/integration-providers/slack)

#### Automation Tools <a href="#automation-tools" id="automation-tools"></a>

The concept of automation in IT-Conductor is built around the utilization of Terraform and Ansible playbooks. These automation tools are seamlessly integrated within the [Process Composer](/overview/automation-concepts/definition-of-terms) in IT-Conductor, developed to cater to different automation scenarios.

<figure><img src="/files/arwGFLCDZjvPXiiJ4GDg" alt=""><figcaption><p>Figure 5: IT-Conductor Process Composer</p></figcaption></figure>

Terraform, known for its infrastructure as code (IaC) capabilities, enables the systematic provisioning and management of cloud resources and infrastructure components. Through IT-Conductor's integration with Terraform, these operations become automated and highly reproducible, ensuring consistency and reliability in complex IT environments.

Ansible, on the other hand, brings its automation prowess to configuration management, orchestration, and application deployment. The utilization of Ansible playbooks within the [Process Definitions](/overview/automation-concepts/definition-of-terms) allows for the efficient execution of tasks, from software updates and configurations to complex workflows, all orchestrated with precision and minimal manual intervention.

This dynamic integration of Terraform and Ansible within the Process Definitions empowers IT-Conductor users to streamline routine and intricate automation tasks. It significantly reduces manual effort, enhances accuracy, and accelerates the execution of critical operations across diverse scenarios, ultimately contributing to the agility and efficiency of IT management.

See [Automation Concepts](/overview/automation-concepts) for more information.


# Automation Concepts

Automation solutions have emerged as a crucial driver of success for organizations, providing several benefits such as increased efficiency, improved accuracy, and reduced operational costs. However, implementing automation solutions can be a complex process that requires careful planning to ensure successful integration with existing systems and workflows.

At IT-Conductor, we recognize the complexities of implementing automation solutions. For this reason, we take a tailored approach for each of our customers, working closely with you to fully understand your unique business needs and objectives. This partnership allows us to gain a deeper understanding of your specific requirements, design and develop automation solutions that align with your goals as an organization, enhance your IT operations, and ultimately lead to improved performance.

### IT-Conductor Automation in a Nutshell <a href="#it-conductor-automation-in-a-nutshell" id="it-conductor-automation-in-a-nutshell"></a>

IT-Conductor’s approach to automation is centered around the concept known as the 4Ps of Automation. This strategic framework helps us deliver tailored solutions, ensuring you reap the full benefits of automation in your operations. The 4Ps of Automation consist of the following stages:

<figure><img src="/files/EgY49JuDG18vR4dzQarA" alt=""><figcaption><p>Figure 1: IT-Conductor's 4Ps of Automation</p></figcaption></figure>

#### Plan <a href="#plan" id="plan"></a>

First, we gather information about your specific requirements, establish well-defined objectives, and devise a plan to address them efficiently and effectively. This planning process may involve identifying processes for automation, prioritizing them based on potential impact and feasibility, and outlining a clear roadmap to achieve the desired outcomes.

#### Practice <a href="#practice" id="practice"></a>

By conducting rigorous testing and continuous refinement, we validate the functionality, accuracy, and efficiency of our automation solutions. This iterative process allows us to address any issues that may arise during the Proof of Concept (PoC) phase, ensuring a seamless transition to full-scale implementation.

#### Perform <a href="#perform" id="perform"></a>

At this stage, the automation PoC is implemented in the production environment, marking the beginning of the full-scale implementation. This also includes configuring systems for monitoring, allowing you to address potential issues that may arise.

#### Perfect <a href="#perfect" id="perfect"></a>

As we strive to keep you at the forefront of technological advancements, we develop and deliver regular updates to ensure our automation solutions are still relevant and effective. [Staying up-to-date with new releases](https://www.itconductor.com/company) is important, as it enables you to identify areas where further enhancements can be made. By fostering a culture of innovation and continuous improvement, we enable your organization to maintain a competitive advantage and adapt to the evolving demands of the market.

### SAP/IT Operations Workflow Automation

IT-Conductor leverages a massively parallel processing engine to efficiently manage and automate complex IT processes across diverse open platforms and applications. A striking demonstration of this capability is its seamless integration with SAP Job scheduling and monitoring, and [SAP Basis Automation](/overview/automation-concepts/sap-basis-automation). IT-Conductor enables organizations to extend this functionality to achieve comprehensive IT workflow automation through the creation and execution of runbooks.

<figure><img src="/files/Q46SpPfL5OxJuourBsZe" alt=""><figcaption><p>Figure 1: Automated Admin Scripts &#x26; Jobs</p></figcaption></figure>

IT-Conductor is equipped with a built-in scheduler and [Process Composer](/overview/automation-concepts/definition-of-terms) that can orchestrate a wide range of application native activities such as handling SAP jobs, executing database SQL queries and stored procedures, running Linux/UNIX shell commands and scripts, and interacting with web-services APIs, etc.

<figure><img src="/files/BCJNup2RqSWKGTHaSofX" alt=""><figcaption><p>Figure 2: Process Composer</p></figcaption></figure>

Common usage scenarios include:

* **Centralized Automation and Task Scheduling:** IT-Conductor offers centralized automation capabilities, effectively replacing local schedulers like crontab, enabling streamlined task management across the entire SAP/IT landscape.
* **Scaling Mass Operations:** Easily execute mass IT operations such as system startup and shutdown on multiple servers or instances simultaneously.
* **Housekeeping and Maintenance Jobs:** Simplify and optimize housekeeping jobs in SAP, databases, and operating systems, ensuring high performance and longevity of critical systems.
* **Seamless System Refresh Post-Copy Automation (PCA):** When combined with [SID-Refresh™](/user-guide/sid-refresh), IT-Conductor facilitates an automated and reliable system refresh process, reducing downtime and eliminating potential errors.

### Self-healing Automated Recovery

IT-Conductor executes policy-based recovery and remediation actions by leveraging automation. When an alert is detected due to a policy violation, the system initiates an automated recovery action, ensuring service continuity and proactively resolving the issue. A smart alert management rule can be set up to automatically close the alert if the original condition that triggered the alert no longer exists and the status has returned to normal.

Monitored thresholds within IT-Conductor can trigger auto-recovery actions using known fixes for common issues. You also have the flexibility to configure a notification that informs the responsible person to perform the required actions. This dynamic approach to automated recovery and alert management minimizes service disruptions and promotes swift issue resolution, optimizing overall system reliability and performance.

<figure><img src="/files/kEKDvOsivSct74NpSYlm" alt=""><figcaption><p>Figure 3: Self-Healing Automated Recovery</p></figcaption></figure>

Recovery actions offer extensive customization options, allowing you to tailor specific application commands, databases, or shell scripts to meet each customer's and application's unique requirements.

Common usage scenarios include:

* [DB archive log backup when the archive filesystem reaches the set threshold.](/user-guide/automation/age-based-hana-backup)
* [Restarting printer queue when the monitored printer status goes offline.](/user-guide/automation/os-printer-queue-restart)
* [Restart SAP qRFC queues when queues are stuck or when errors occur.](/user-guide/automation/inbound-outbound-queue-restart)

### Digitized Complex IT Processes

IT-Conductor incorporates a built-in scheduler and [Process Composer](/overview/automation-concepts/definition-of-terms) that can orchestrate application native activities such as SAP jobs, database SQL and stored procedures, Linux/UNIX shell commands and scripts, web-services APIs, etc.

With a clear focus on optimizing SAP/IT processes, IT-Conductor achieves the following key objectives:

* **Digitizing IT Processes:** IT-Conductor streamlines the documentation and automation of simple and complex IT processes. By capturing core IT workflows in runbooks, the platform ensures a comprehensive repository of documented procedures that can be easily referenced and automated.
* **Efficient Workflow Capture:** In complex and non-linear IT environments, workflows are the most effective way to capture intricate processes and dependencies accurately. IT-Conductor's [Process Composer](/overview/automation-concepts/definition-of-terms) empowers users to map out complex workflows visually, simplifying the understanding and management of critical tasks.
* **Ensuring Repeatable Workflows:** With a focus on consistency and reliability, IT-Conductor ensures that workflows are designed for repeatability. By standardizing the execution of tasks and actions, the platform minimizes errors and ensures predictable outcomes across different iterations.
* **Monitoring and Management at Task Level:** IT-Conductor provides granular monitoring and management capabilities to the individual task level within a workflow. This level of oversight allows IT teams to identify bottlenecks, track progress, and promptly address any issues that may arise during the automation process.

<figure><img src="/files/7ZcXYL9SY1i6waRUVnAb" alt=""><figcaption><p>Figure 4: Digitized Complex IT Processes</p></figcaption></figure>

Explore the [User's Guide](/user-guide/automation) for more information.


# Definition of Terms

<table><thead><tr><th width="232">Term</th><th>Decription</th></tr></thead><tbody><tr><td>Process Composer</td><td>It is an integral component within IT-Conductor that enables the automation capabilities of the platform. It provides the interface to design and develop automation workflows by leveraging a drag-and-drop functionality where users can define the sequence of actions, dependencies, and conditional logic, all within a visually intuitive environment.</td></tr><tr><td>Process Definition</td><td><p>It is a template used for orchestrating various activities. It acts as a workflow automation framework that can be manually triggered to run or scheduled to automatically execute at a desired date and time.</p><p>It is composed of one or more activities that are woven together to create an automated workflow.</p></td></tr><tr><td>Activity</td><td><p>It is a component of a process definition that contains the actual task or operation. It contains various types of scripts, such as SQL, shell, Terraform, or Ansible scripts, which are executed to perform certain actions or manipulate data.</p><p>Each activity can also contain subprocesses that are also composed of one or more activities.</p></td></tr><tr><td>Subprocess</td><td>It refers to a smaller process that is part of a larger process. Each subprocess is composed of one or more activities, which contribute to the completion of the main process definition.</td></tr></tbody></table>


# Infrastructure as Code

Infrastructure as Code (IaC) is the practice of provisioning and managing infrastructure resources using code. It is an integral component of DevOps methodology, facilitating the seamless orchestration of applications and their underlying infrastructure such as servers, virtual machines, databases, and networks.

Explore the following pages for more information:

* [Project Structure and Organization](/overview/automation-concepts/infrastructure-as-code/project-structure-and-organization)
* [Setting Up IaC Environment](/overview/automation-concepts/infrastructure-as-code/setting-up-iac-environment)
* [Infrastructure Provisioning](/overview/automation-concepts/infrastructure-as-code/infrastructure-provisioning)
* [Configuration Management](/overview/automation-concepts/infrastructure-as-code/configuration-management)


# Project Structure and Organization

When handling projects, it's important to establish a well-organized directory structure to effectively manage your project and potential complexities. It's recommended to maintain distinct directories for various purposes and ensure a uniform format, style, and code structure.

### Directory Structure <a href="#directory-structure" id="directory-structure"></a>

The recommended directory structure for any IaC project includes separating code, configuration, and documentation into organized folders. By following an organized directory structure, you make it easier for team members to locate and manage specific elements of your IaC project, maintain consistency, and collaborate effectively. It also facilitates version control and ensures that your project remains clear, maintainable, and scalable.

* **Root Directory:** The root directory of your IaC project typically contains high-level configuration files and important project-wide documentation. It may include files like "main.tf" (for Terraform) or "site.yml" (for Ansible) as the entry point for your IaC code.
* **Code Directory:** This is where you store the actual IaC code. You should create subdirectories for different components or environments. For example, you may have subdirectories like "networking," "servers," or "dev," "staging," and "production" if you're managing different environments.
* **Configuration Directory:** This directory is meant for configuration files that are separate from the IaC code. These can include environment-specific configurations, application settings, or any other data that needs to be kept separate from the code logic. Store configuration files that are separate from your IaC code in this directory.
* **Documentation Directory:** It's a good practice to have a dedicated folder for documentation. This directory should contain files explaining the project's purpose, architecture, and usage, along with any user or developer guides.
* **Modules/Scripts Directory:** If your IaC project is sufficiently complex, you may want to have a directory specifically for reusable modules, scripts, or functions. These can be shared and included in your code as needed.
* **Variables Directory:** Store variable definitions in a dedicated directory. This can help keep variables separate from the code logic and make it easier to manage and change configurations.
* **Tests Directory:** If your IaC project includes automated tests (highly recommended), place your test files or scripts in this directory. This helps ensure code reliability.
* **Infrastructure State Directory:** Some IaC tools maintain state files that track the current state of deployed resources. Keep these files in a separate directory to prevent accidental modifications.
* **Secrets Directory (Optional):** For security and separation of concerns, you may consider having a separate directory for managing secrets and sensitive data. Ensure strict access controls on this folder.
* **Logs and Reports Directory (Optional):** If your IaC project generates logs or reports, you can have a directory for storing these files.
* **Bin or Scripts Directory (Optional):** If you have utility scripts or binaries that assist in the IaC process, place them in this directory.

{% hint style="info" %}
**Note:** An IaC project typically undergoes multiple iterations to align with a company's specific project requirements, and its initial definition may not be entirely accurate.
{% endhint %}

### Naming Conventions <a href="#naming-conventions" id="naming-conventions"></a>

Establishing clear and consistent naming conventions for resources, files, and directories within your IaC project is crucial for enhancing project maintainability.

Here are some key considerations:

* **Resource Naming Conventions:** Resources like servers, databases, and networking components should have names that reflect their purpose and attributes. For example, use meaningful names like “web-server” or “database-prod” to make the resource context more evident.
* **File Naming Conventions:** Maintain a consistent approach to naming your IaC files. For example, if you’re using Terraform, use a prefix like “main.tf” for your primary configuration file, and then use descriptive file names for additional modules or configurations, such as “networking.tf” or “security-groups.tf”.
* **Consistency Across Environments:** Maintain consistency in naming across different environments (e.g., development, staging, production) to avoid confusion. For example, if you use “app-server-dev”, use “app-server-staging” and “app-server-prod” for similar resources in other environments.
* **Version Control Branch and Tag Naming:** When managing your IaC project in version control (e.g., Git), consider naming branches and tags with descriptive names that indicate the purpose of a branch or release version. For example, use “feature/add-ssl” or “v1.2-release”.
* **Use of Hyphens or Underscores:** Choose either hyphens or underscores for separating words in names. Stick with one style throughout your project for consistency. For example, either only use hyphens as in “web-server” or underscores as in “web\_server”.
* **Avoid Special Characters and Spaces:** Steer clear of special characters, spaces, and other non-alphanumeric characters in names, as they can lead to compatibility issues or confusion.

### Repository Layout <a href="#repository-layout" id="repository-layout"></a>

Organizing your IaC code within your version control repository is essential for maintaining an efficient version control repository for your IaC project, making collaboration, version management, and project tracking smoother and more effective.

Here's a guide on how your IaC code should be structured within a version control repository, including best practices for branches and folders:

#### **Branches**

* **Master/Main Branch:** The primary branch (often named "master" or "main") should contain the production-ready code. It should be stable and protected, allowing only approved changes to be merged into it.
* **Feature Branches:** For each new feature, enhancement, or bug fix, create a dedicated feature branch. Use clear and descriptive names, such as "feature/add-load-balancer" or "bugfix/fix-database-connection."
* **Environment-Specific Branches:** Maintain branches for different environments, such as "staging" or "development." These branches can be used for environment-specific configurations.
* **Release Branches:** When preparing for a new release, create a release branch (e.g., "release/v1.0"). Only bug fixes and essential changes should be merged into release branches.
* **Hotfix Branches:** For critical issues in production, create hotfix branches (e.g., "hotfix/ssl-certificate-expiry") to address and deploy immediate fixes.

#### **Folder**

* **Code Folder:** Organize your IaC code within a dedicated folder to keep it separate from other project assets.
* **Modules Folder:** If you use reusable modules, create a "modules" folder to store them.
* **Variables Folder:** Keep variable definitions in a "variables" folder for clarity.
* **Tests Folder:** Store your test files or scripts in a "tests" folder to ensure that your code is thoroughly tested.
* **Documentation Folder:** Include a folder for documentation. This is where you can store architecture diagrams, user guides, and other project documentation.

{% hint style="info" %}
**Note:** Unlike a directory, which can store files, subdirectories, and other directories, a folder can only store files.
{% endhint %}

#### **Versioning**

* **Semantic Versioning:** Adhere to semantic versioning principles for your IaC code to clearly communicate the impact of changes. Versions typically follow the format “X.Y.Z”, where:
  * X is a major version
  * Y is a minor version
  * Z is a patch version
* **Tags for Releases:** Tag releases with version numbers (e.g., "v1.0.0") to make it easy to reference specific releases in the future.
* **Commit Messages:** Write informative and concise commit messages. Describe the purpose of the change, its impact, and any relevant details. Follow a consistent style guide for commit messages.
* **Pull Request Reviews:** Require code reviews for all pull requests. This ensures that changes are thoroughly examined and conform to project standards.


# Setting Up IaC Environment

Establishing a well-configured infrastructure as Code (IaC) environment is the foundational step toward leveraging the full potential of IaC practices.

### Pre-requisite Requirements <a href="#pre-requisite-requirements" id="pre-requisite-requirements"></a>

It’s important to ensure your environment meets certain prerequisites which often include:

* **Version Control System:** Set up a version control system (VCS) to manage your IaC code. The VCS (e.g., Git) will be used for collaboration, versioning, and tracking changes.
* **IaC Tool:** Choose and install an IaC tool that aligns with your infrastructure needs. Popular choices include Terraform and Ansible. Make sure the tool is installed and configured properly.
* **Cloud or Infrastructure Platform Access:** Ensure you have access to your chosen cloud or infrastructure platform. This includes account credentials, access keys, and permissions to provision resources.
* **Development Environment:** Set up a development environment where you will write, test, and maintain your IaC code. This environment may include a code editor, integrated development environment (IDE), or code repositories.
* **Dependencies and Libraries:** Install any required dependencies and libraries related to your IaC tool. This may include specific plugins, extensions, or modules necessary for your project.
* **Access to Secret Management Tools:** If your project involves handling sensitive information, ensure access to secret management tools or mechanisms to securely store and retrieve secrets.

### Installation and Configuration <a href="#installation-and-configuration" id="installation-and-configuration"></a>

Once you’ve satisfied the pre-requisite requirements, proceed with the installation and configuration of your IaC environment. This typically includes the following steps:

1. **Install IaC Tool:** Depending on the tool you’re using, follow the installation instructions provided by the vendor.
   * See [Terraform Installation Guide](https://developer.hashicorp.com/terraform/downloads) for instructions on how to install Terraform.
   * See [Ansible Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/index.html) for instructions on how to install Ansible.
2. **Configure and Authenticate IaC Tool:** Configure your IaC tool to authenticate with your cloud provider or infrastructure platform. This involves setting up access keys, authentication tokens, or certificates as required.
3. **Initialize IaC Project:** Initialize a new IaC project or work with an existing one by running commands like `terraform init` or `ansible-galaxy init` to prepare the project's structure and download necessary modules or dependencies.
4. **Set Up Version Control:** Initialize a Git repository for your IaC project and connect it to your version control system. Use Git to track changes, collaborate with team members, and manage version history.

### Environment Variables <a href="#environment-variables" id="environment-variables"></a>

IaC tools often rely on environment variables for configuration.

Here’s a brief overview of common variables:

* **AWS\_ACCESS\_KEY\_ID / AWS\_SECRET\_ACCESS\_KEY:** For AWS-based IaC, these variables provide access to AWS services. See [Environment variables to configure the AWS for CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) for more information.
* **TF\_VAR\_name:** Terraform allows you to set variables using the `TF_VAR_name` prefix. For example, "TF\_VAR\_db\_password" sets the "db\_password" variable. See [Terraform Environment Variables](https://developer.hashicorp.com/terraform/cli/config/environment-variables) for more information.
* **ANSIBLE\_VAULT\_PASSWORD\_FILE:** Used with Ansible for decrypting vault-encrypted files. See [Ansible Environment Variables](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#environment-variables) for more information.
* **Other Tool-specific Variables:** Depending on the IaC tool you use, additional tool-specific environment variables may be required. Refer to the tool's documentation for guidance.


# Infrastructure Provisioning

Infrastructure Provisioning is a fundamental aspect of IaC where the defined infrastructure is created, deployed, and managed as code. Rather than relying on manual and error-prone processes, IaC empowers teams to automate infrastructure provisioning through code, ensuring a highly systematic and repeatable approach.

By embracing Infrastructure Provisioning as a core tenet of IaC, organizations can unlock the advantages of agility, cost-efficiency, and reliability in managing their digital infrastructure. This approach transforms infrastructure management from a manual, error-prone process into a streamlined, automated, and agile practice, aligning it with the principles and practices that have revolutionized software development.

### Creating Infrastructure Resources <a href="#creating-infrastructure-resources" id="creating-infrastructure-resources"></a>

The core of infrastructure provisioning is defining the resources you need for your project, such as VMs, databases, networks, and more. In your IaC code, you describe the desired state of these resources, specifying their attributes, relationships, and configurations.

We leverage Terraform scripts for cloud resource provisioning at IT-Conductor. Specifically, we've crafted a VM-centric Terraform script, which not only provisions virtual machines but also handles the generation and utilization of necessary resources for these VMs. This versatile script has the ability to connect already existing resources like networks, subnets, keys, and security groups or generate them on the fly for provisioning the VM.

The script accepts a JSON configuration file that houses resource information as its input. Below is an example of a simple configuration file designed for provisioning an Azure VM.

```
{
  "infrastructure": {
    "region": "westus",
    "resource_group": { 
      "is_existing": "false",
      "name": "itc-rg"
    },
    "vnets": {
      "management": {
        "is_existing": "true",
        "arm_id":"/subscriptions/XXXXXXXXXXXX/resourceGroups/XXXXXXXXX/providers/Microsoft.Network/virtualNetworks/XXXXXXX",
        "address_space": "10.200.0.0/16",
        "subnet_mgmt": {
          "is_existing": "false",
          "name": "single-vm-test-subnet",
          "prefix": "10.200.10.0/24",
          "nsg": {
            "is_existing": "false",
            "name": "nsg-mgmt-single-vm-test",
            "allowed_ips": [
              "0.0.0.0/0"
            ]
          }
        }
      }
    }
  },
  "vms": [
    {
      "name": "vm1",
      "os": {
        "publisher": "suse",
        "offer": "sles-sap-12-sp5",
        "sku": "gen1"
      },
      "size": "STANDARD_B1s",
      "disk_type": "StandardSSD_LRS",
      "authentication": {
        "type": "key",
        "username": "itcuser"
      }
    }
  ],
  "sshkey": {
    "path_to_public_key": "~/.ssh/id_rsa.pub",
    "path_to_private_key": "~/.ssh/id_rsa"
  }
}
```

In the configuration file, all the fields are self-explanatory. The field `is_existing` signifies that the resource already exists. If this value is true, it is used by the script to connect to the VM being provisioned. Otherwise, this resource also gets created from the script itself. Also, the keys are stored in ITC as data files and downloaded to the IT-Conductor Gateway temporarily during the provisioning of the VM.

Explore the following scenarios illustrating resource provisioning during migrations:

* [Oracle to AWS Migration](/user-guide/automation/migration/oracle-to-aws)
* [Oracle to ASE Migration](/user-guide/automation/migration/oracle-to-ase)
* [SAP on MSSQL to AWS Migration](/user-guide/automation/migration/sap-on-mssql-to-aws)
* [S/4HANA to Cloud Migration](/user-guide/automation/migration/s4hana-to-cloud)

### Resource Dependencies and Order <a href="#resource-dependencies-and-order" id="resource-dependencies-and-order"></a>

Some IaC tools handle resource dependency management intelligently, deploying resources in a way that adheres to the dependencies and relationships among defined resources. Familiarize yourself with your chosen tool's behavior in this regard.

* In Terraform, you can utilize `depends_on`and `count` parameters to control the creation order. This meta-argument handles hidden resource or module dependencies that Terraform cannot automatically infer.

{% hint style="info" %}
**Note:** You only need to explicitly declare a dependency when a resource or module relies on the behavior of another resource without utilizing any data from that resource in its parameters.
{% endhint %}

* In Ansible, you can structure your playbooks to execute tasks in the desired sequence. By structuring your playbooks effectively, you can enforce a logical order of operations, execute configurations, and maintain the overall flow of your automation, ensuring that your infrastructure and applications are configured, deployed, and managed in a well-defined and organized manner.


# Configuration Management

Configuration management is a pivotal aspect of Infrastructure as Code (IaC) that ensures your infrastructure is consistently configured and maintained to meet your desired state.

### Managing Configuration Files <a href="#managing-configuration-files" id="managing-configuration-files"></a>

In IaC, configuration management involves the systematic handling of configuration files, which are vital in specifying how your infrastructure components should be set up. These configuration files typically define parameters, settings, and options for resources.

* **Version Control:** Configuration files should be stored in version control systems. This not only provides a historical record of changes but also enables you to roll back to previous configurations if issues arise.
* **Template Usage:** Many IaC tools support template engines to dynamically generate configuration files. This allows for the reuse of configuration blocks and simplifies the management of large-scale infrastructure.
* **Parameterization:** Configuration files often incorporate variables, allowing you to customize settings for different environments or scenarios. Parameters can be defined and managed within your IaC code.

### Parameterization and Variables <a href="#parameterization-and-variables" id="parameterization-and-variables"></a>

Parameterization is a key feature of configuration management in IaC. It allows you to customize configurations for different environments or deployments without modifying the core code. Variable usage and management are fundamental to this process, enabling you to:

* **Define Variables:** Create variables within your IaC code to represent dynamic values such as instance counts, IP addresses, or endpoint URLs.
* **Utilize Variables in Configuration Files:** Incorporate variables into your configuration files, allowing you to parameterize settings and achieve flexibility.
* **Centralize Variable Management:** Consider centralizing the management of variables to maintain consistency across your infrastructure and ease the process of making global changes.

### Secrets Management <a href="#secrets-management" id="secrets-management"></a>

Handling sensitive information securely within your Infrastructure as Code (IaC) code is crucial to maintaining the integrity and security of your infrastructure.

Here are some best practices to follow:

* **Do Not Hard-code Secrets:** Avoid hard-coding sensitive information, such as passwords or API keys, directly into your IaC code. Hard-coded secrets are a significant security risk, as they are easily visible in your code.
* **Store Secrets in Environment Variables:** Store sensitive data as environment variables or secret store references. IaC tools usually provide a way to fetch secrets securely from environment variables or secret stores during runtime.
* **Rotate Secrets Regularly:** Implement a secret rotation policy, ensuring that passwords and keys are periodically updated. This minimizes the risk associated with long-lived secrets.
* **Implement Access Controls:** Set strict access controls on who can read and modify secrets. Limit access to only those who need the secrets for their tasks.
* **Encrypt Sensitive Data:** Encrypt secrets when storing them in your version control system. Use encryption mechanisms to protect sensitive files before committing them.
* **Use Secret Management Tools:** Leverage secret management tools such as HashiCorp Vault, AWS Secrets Manager, or dedicated secret management modules in your IaC tool to securely store and access sensitive data. These tools offer encryption, access controls, and rotation policies.


# SAP Basis Automation

SAP Business Application Software Integrated Solution (SAP Basis) lays the foundation for SAP applications. It is an extensive set of middleware programs and tools that are specifically designed to ensure seamless interoperability of SAP applications across various systems and databases.

Automation plays a crucial role in SAP Basis operations especially with SAP landscapes becoming more complex as an organization grows.

### What SAP Basis tasks can be automated?

Any task that is repetitive can be automated. In SAP Basis, some of these tasks include the following:

* [SAP User Unlock and Password Reset](/user-guide/automation/sap-user-unlock-and-password-reset)
* [SAP Inbound/Outbound Queue Restart](/user-guide/automation/inbound-outbound-queue-restart)
* [SAP Batch Job Restart on Error](/user-guide/automation/sap-batch-job-restart-on-error)
* [OS Printer Queue Restart](/user-guide/automation/os-printer-queue-restart)
* [OS File System Cleanup](/user-guide/automation/os-file-system-cleanup)
* [OS Linux Pacemaker Cluster Error Management](/user-guide/automation/os-linux-pacemaker-cluster-error-management)
* [Age-based HANA Backup](/user-guide/automation/age-based-hana-backup)
* [Start/Stop Snoozing](/user-guide/automation/start-stop)
* [SAP Transport Request](/user-guide/automation/sap-transport)
* [SAP System Refresh](/user-guide/automation/e2e-system-refresh)

By automating these processes, organizations can reduce manual errors, accelerate task execution, and free up Basis administrators to focus on more strategic activities.

### Workflow Automation

IT-Conductor utilizes a massively parallel processing engine to automate and orchestrate complex IT processes across open platforms and applications.

As a best practice, combine as many of the following elements of automation to increase the operational efficiency of managing enterprise application service levels:

1. 360-degree view of the Application Environment
2. Availability and Performance Monitoring
3. Root Cause Analysis
4. Time-synchronized Troubleshooting Context
5. Service Impact Awareness
6. Automated Admin Scripts and Jobs
7. Self-healing Automated Recovery
8. Digitized Complex IT Processes
9. Synthetic Transaction Management
10. Dynamic Service Level Management

<figure><img src="/files/mIhGjHVHZ0cYtqRQhOUA" alt=""><figcaption><p>Figure 1: 10 Ways to Smart Automation</p></figcaption></figure>

See [Ten Ways to Smart Application Performance Management](https://www.itconductor.com/ten-ways-to-smart-application-performance-management) for more details.

### Video

{% embed url="<https://www.youtube.com/watch?v=bgv3rzf_6Ew>" %}


# Automated Migration

Automation solutions have emerged as a crucial driver of success for organizations, providing several benefits such as increased efficiency, improved accuracy, and reduced operational costs. However, implementing automation solutions can be a complex process that requires careful planning to ensure successful integration with existing systems and workflows.

At IT-Conductor, we recognize the complexities of implementing automation solutions. For this reason, we take a tailored approach for each of our customers, working closely with you to fully understand your unique business needs and objectives. This partnership allows us to gain a deeper understanding of your specific requirements, design and develop automation solutions that align with your goals as an organization, enhance your IT operations, and ultimately lead to improved performance.

### IT-Conductor Migration Process

Migration covers multiple aspects of automation, from the source application discovery to the deployment of the application components in the target environment. While the 4Ps of Automation can still be applied, a more fitting framework for this context is the [5Ds of IT-Conductor’s Cloud Migration Strategy](https://www.itconductor.com/blog/what-is-cloud-migration).

<figure><img src="/files/1gyKzvp0bQnSrB7RE2Hl" alt=""><figcaption><p>Figure 2: 5Ds of IT-Conductor’s Cloud Migration Strategy</p></figcaption></figure>

#### Discover

Understanding the source application environment could mean discovering multiple related applications, how they integrate with each other, and even taking into consideration the security controls that support various application connections and end-users accessing your systems.

[Application discovery ](https://www.itconductor.com/blog/the-role-of-application-discovery-in-cloud-migration)in IT-Conductor leverages a multi-layer approach to automatically discover deep dependency chains among components.

#### Distill

The process of [generating baselines](https://www.itconductor.com/blog/generating-cloud-baselines) is important for accurately measuring the performance and resource usage of applications before and after the migration.

The common performance baselines you need to capture are the resource utilization metrics such as CPU/Memory, storage, and network. In IT-Conductor, you can capture those metrics from the service grid.

#### Design

[Designing a tailored migration plan ](https://www.itconductor.com/blog/designing-your-target-cloud-infrastructure)should align with the organization's business objectives and requirements. This includes defining the target architecture, selecting the appropriate cloud platform, and designing the [process definition](/overview/automation-concepts/definition-of-terms), or the provisioning template to be used for the actual migration.

#### Develop

This stage bridges the design and the deployment of application components in your target environment. We begin by creating a deployment plan, [developing the migration workflow](https://www.itconductor.com/blog/building-a-cloud-infrastructure-automated-migration), and testing their usability before provisioning the necessary resources in the actual migration.

#### Deploy

During this stage, the focus is on executing the migration plan, from provisioning resources to moving the various application components to the target environment. The [deployment process](https://www.itconductor.com/blog/deploy-applications-to-the-cloud) also involves testing and validation of the migrated components to guarantee functionality, performance, and security in the new environment.

### Migration Scenarios

The IT-Conductor migration process is versatile and can be applied to seamlessly move any SAP/IT system from on-premises environments to various private or public clouds.

To provide you with a better understanding of its capabilities, here are some illustrative migration scenarios that highlight its effectiveness and adaptability:

* [Oracle to AWS Migration](/user-guide/automation/migration/oracle-to-aws)
* [Oracle to ASE Migration](/user-guide/automation/migration/oracle-to-ase)
* [SAP on MSSQL to AWS Migration](/user-guide/automation/migration/sap-on-mssql-to-aws)
* [S/4HANA to Cloud Migration](/user-guide/automation/migration/s4hana-to-cloud)


# Onboarding

There is a wide variety of systems, databases, and applications that can be monitored by IT-Conductor.

Each system has its own layer of security and unique user requirements that must be met prior to onboarding said system on IT-Conductor.

### **Preparation/Prerequisites** <a href="#preparation-prerequisites" id="preparation-prerequisites"></a>

* IT-Conductor tenant registration including organization, sites, users (administrator, non-administration), and Single Sign-On (SSO). Register [here](https://service.itconductor.com/register).
* VM Provisioning of the IT-Conductor Gateway
  * 4 vCPU, 16 GB RAM, 30 GB Disk space
  * OS: SUSE SLES/RHEL
* [Gateway Installation](/user-guide/setup/gateway-setup)
* Network
  * The IT-Conductor Gateway VM should have outbound internet access.
  * The IT-Conductor Gateway VM should be in the same network as the systems to be monitored, and the firewall should be open between the IT-Conductor VM and the systems to be monitored.
  * See [Gateway Network Setup](/user-guide/setup/gateway-setup/network) for more information.

### **Setup** <a href="#setup" id="setup"></a>

* Add Monitoring System
* Initial Configuration

| Category            | Component                     | Security                                                                                                                                                                    | SAP Transport                                                                 | Configuration                                                                                                                                                            |
| ------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Application         | SAP ABAP                      | [Security Role Import](/user-guide/monitoring/sap/netweaver/abap-system/security-role-import)                                                                               | [Transports](/user-guide/monitoring/sap/netweaver/abap-system/sap-transports) | [SAP ABAP System](/user-guide/monitoring/sap/netweaver/abap-system#configure-sap-abap-system-monitoring-in-it-conductor)                                                 |
| Application         | SAP J2EE/JAVA                 | Import the role file in SAP J2EE Identity Management. See [Security Role Import](/user-guide/monitoring/sap/netweaver/abap-system/security-role-import).                    | [Transports](/user-guide/monitoring/sap/netweaver/abap-system/sap-transports) | [SAP J2EE System](/user-guide/monitoring/sap/netweaver/j2ee-system)                                                                                                      |
| Database            | SAP HANA                      | See IT-Conductor SAP HANA Authorization Requirements in [SAP HANA System](/user-guide/monitoring/database/sap-hana-system).                                                 | N/A                                                                           | See How to Configure SAP HANA System for Monitoring section in [SAP HANA System](/user-guide/monitoring/database/sap-hana-system).                                       |
| Database            | SAP ASE                       | Create a dedicated ASE monitoring user with the "mon\_role" role.                                                                                                           | N/A                                                                           | See [Configure SAP ASE Database for Monitoring](/user-guide/monitoring/database/sap-ase#configure-sap-ase-database-for-monitoring)                                       |
| Database            | MaxDB                         | Login to the SQLcl with your SYSDBA/DBADNMIN.                                                                                                                               | N/A                                                                           | See [Configure SAP MaxDB Monitoring in IT-Conductor](/user-guide/monitoring/database/sap-maxdb#configure-sap-maxdb-monitoring-in-it-conductor)                           |
| Database            | Oracle                        | Create Oracle user with the "create\_session" and "oem\_monitoring" roles.                                                                                                  | N/A                                                                           | See [Configure Oracle Database Monitoring in IT-Conductor](/user-guide/monitoring/database/oracle#configure-oracle-database-monitoring)                                  |
| OS                  | Linux                         | See the Accounts Requirements section in [Unix/Linux System Monitoring](/user-guide/monitoring/infrastructure/os/unix-linux-system).                                        | N/A                                                                           | See [Configure Unix/Linux System Monitoring in IT-Conductor](/user-guide/monitoring/infrastructure/os/unix-linux-system#configure-unix-linux-monitoring-in-it-conductor) |
| OS                  | Windows                       | See IT-Conductor WinRM Adapter Configuration section in [WinRM Adapter Configuration](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration). | N/A                                                                           | [Windows Server Configuration](/user-guide/monitoring/infrastructure/os/windows-system)                                                                                  |
| OS                  | SAP HostAgent                 | See Account Requirements section in [SAP Host Agent Monitoring](/user-guide/monitoring/sap/host-agent).                                                                     | N/A                                                                           | [SAP Host Agent Monitoring](/user-guide/monitoring/sap/host-agent)                                                                                                       |
| Infrastructure      | Azure                         | See How to Add IT-Conductor as an App in Azure Subscription section in [Microsoft Azure Monitoring](/user-guide/monitoring/cloud/microsoft-azure).                          | N/A                                                                           | See How to Configure Azure Connections in IT-Conductor section in [Microsoft Azure Monitoring](/user-guide/monitoring/cloud/microsoft-azure)                             |
| Infrastructure      | AWS                           | N/A                                                                                                                                                                         | N/A                                                                           | [AWS Monitoring](/user-guide/monitoring/cloud/aws)                                                                                                                       |
| Automation Scenario | SAP Transport Automation      | [Create Robot User](/user-guide/account-administration/create-robot-users)                                                                                                  | N/A                                                                           | [SAP Transport Automation](/user-guide/automation/sap-transport)                                                                                                         |
| Automation Scenario | End-to-End SAP System Refresh | N/A                                                                                                                                                                         | N/A                                                                           | [E2E System Refresh Automation](/user-guide/automation/e2e-system-refresh)                                                                                               |
| Automation Scenario | Start/Stop Automation         | N/A                                                                                                                                                                         | N/A                                                                           | [Start/Stop Automation](/user-guide/automation/start-stop)                                                                                                               |

### **Deployment** <a href="#deployment" id="deployment"></a>

#### **Additional Configurations** <a href="#additional-configurations" id="additional-configurations"></a>

* [Configure Warning and Critical Thresholds](/user-guide/notifications/threshold-overrides)
* [Configure Subscriptions for Alerts](/user-guide/notifications/alerts)
* [Configure Subscriptions for Notifications](/user-guide/notifications/custom-smtp-notification-providers)

#### **Custom Dashboards** <a href="#custom-dashboards" id="custom-dashboards"></a>

* [Create Custom Dashboards](/overview/dashboard)
* [Configure Standard and Custom Reports](/user-guide/reporting/creating-reports)

#### **Report** <a href="#report" id="report"></a>

* [Report Configuration](/user-guide/reporting)

#### **Automation Configuration** <a href="#automation-configuration" id="automation-configuration"></a>

* [E2E System Refresh Automation](/user-guide/automation/e2e-system-refresh)
* [Create Robot User](/user-guide/account-administration/create-robot-users)


# Setup


# Gateway Setup


# Gateway Network Setup

IT-Conductor Gateway is a reverse proxy and requires specific port configurations and network access.

<figure><img src="/files/1449BrJWEL6xrTbz8iyR" alt=""><figcaption><p>Figure 1: Gateway Network Setup</p></figcaption></figure>

{% hint style="warning" %}
**Important**

IT-Conductor Gateway does not require the incoming connections to be enabled aside for the following exceptions:

* SSH (Port 22) access to the host from the tenant's internal network for gateway configuration and troubleshooting.
* Remote Gateway Configuration (port 8080). Not recommended, instead, use SSH and the command line interface. (Optional)
* API Server (Port 8889) for local IT-Conductor Alert API (Optional)
* IT-Conductor RSyslog Server (Port 514 UDP or TCP) (Optional)
  {% endhint %}

### IT-Conductor Cloud

The gateway is using HTTPS port 443 to communicate with IT-Conductor cloud services hosted on the public network as DNS name: [**agents.itconductor.com**](http://agents.itconductor.com/)

Ensure that firewall rules and routing are properly configured. You can test access from the gateway SSH session by executing the following command:

```
curl -I https://agents.itconductor.com/status
```

If all is working properly the following output should be produced:

```
HTTP/2 200
date: <Day of the Week>, <Day> <Month> <Year> <Time>
content-security-policy: default-src 'self' http://docs.itconductor.com ; script-src 'self' 'unsafe-inline' 'unsafe-eval' http://docs.itconductor.com ; style-src 'self' http://docs.itconductor.com  data: 'unsafe-inline' *.google.com *.googleapis.com; connect-src 'self' blob: https://*.google.com; form-action 'self' http://docs.itconductor.com ; frame-ancestors 'self' http://docs.itconductor.com ; img-src 'self' *.itconductor.com *.gstatic.com http://translate.google.com  blob: data: 'self' 'unsafe-inline'; font-src 'self' fonts.gstatic.com fonts.googleapis.com blob: https://*.google.com data: 'unsafe-inline'; report-uri /cspReportViolation;
x-xss-protection: 1
x-frame-options: SAMEORIGIN
x-content-type-options: nosniff
strict-transport-security: max-age=31536000
content-type: text/html
cache-control: no-store
content-length: 0
```

### On-Premise Applications

In addition to connecting to IT-Conductor cloud services on the public network, the gateway needs to be able to access systems and applications on the private network. The routing to application-specific hosts may require configuration in the gateway host routing settings.

Depending on the application type, the firewall must have the appropriate hosts, protocols, and ports enabled for incoming connection to the respective application from the IT-Conductor gateway.

#### SAP NetWeaver (ABAP)

| Name            | Port Range | Rule           |
| --------------- | ---------- | -------------- |
| SAP Dispatcher  | 3200-3299  | 3&#x32;*\<NN>* |
| Gateway         | 3300-3399  | 3&#x33;*\<NN>* |
| Secured Gateway | 4800-4899  | 4&#x38;*\<NN>* |
| Message Server  | 3600-3699  | 3&#x36;*\<NN>* |

#### SAP J2EE

| Name             | Port Range  | Rule                 |
| ---------------- | ----------- | -------------------- |
| P4 (JMX)         | 50004-59904 | &#x35;*\<NN>*&#x30;4 |
| P4S (JMX Secure) | 50006-59906 | &#x35;*\<NN>*&#x30;6 |
| HTTP             | 50000-59900 | &#x35;*\<NN>00*      |
| HTTPS            | 50001-59901 | &#x35;*\<NN>01*      |
|                  |             |                      |

#### SAP HANA

| Name                   | Port Range  | Rule                 |
| ---------------------- | ----------- | -------------------- |
| SQL (SystemDB)         | 30013-39913 | &#x33;*\<NN>*&#x31;3 |
| SQL (Tenant DB Single) | 30015-39915 | &#x33;*\<NN>*&#x31;5 |
| SQL (Tenant DB Multi)  | 30041-39998 | 3<*NN*>41\[+3]       |

#### Host Agent

| Name        | Port Range  | Rule                 |
| ----------- | ----------- | -------------------- |
| HTTP        | 50013-59913 | &#x35;*\<NN>*&#x31;3 |
| HTTPS       | 50014-59914 | &#x35;*\<NN>*&#x31;4 |
| DB/OS HTTP  | 1128        | -                    |
| DB/OS HTTPS | 1129        | -                    |

### Other Systems and Applications <a href="#sap-businessobjects" id="sap-businessobjects"></a>

For other systems and applications, see port configurations below:

<table><thead><tr><th width="256">Name</th><th>Port</th></tr></thead><tbody><tr><td>Cloud-based Applications and Platforms</td><td><ul><li>HTTPS: 443</li></ul></td></tr><tr><td>SAP BusinessObjects</td><td><ul><li>Default: 6410 (SIA (Server Intelligence Agent) port)</li><li>Default: 6400 (Central Management Server (CMS) port)</li><li>For distributed clustered environments with multiple CMS, unique ports are assigned to each CMS and SIA node, normally 640&#x3C;n> and 641&#x3C;n>, respectively.</li></ul></td></tr><tr><td>SAP BusinessObjects DataServices</td><td><ul><li>Default: 6405 (REST API)</li></ul></td></tr><tr><td>SAP Cloud Connector</td><td><ul><li>Default: 8443 (REST API)</li></ul></td></tr><tr><td>SAP DB</td><td><ul><li>Default: 7210 (Unencrypted over TCP)</li><li>Default: 7260 (Unencrypted over SAP NI)</li><li>Default: 7270 (TLS over SAP NI)</li></ul></td></tr><tr><td>SAP ASE</td><td><ul><li>Default: 4901</li><li>JDBC client ports are configurable. Please consult your DBA.</li></ul></td></tr><tr><td>InterSystems IRIS</td><td><ul><li>Default: 1972 (JDBC)</li><li>JDBC client ports are configurable. Please consult your DBA.</li></ul></td></tr><tr><td>Microsoft SQL Server</td><td><ul><li>Default: 1433</li><li>JDBC client ports are configurable. Please consult your DBA.</li></ul></td></tr><tr><td>Oracle (DBMS)</td><td><ul><li>Default: 1521</li><li>JDBC client ports are configurable. Please consult your DBA.</li></ul></td></tr><tr><td>Linux</td><td><ul><li>SSH: 22</li></ul></td></tr><tr><td>Windows</td><td><ul><li>WinRM/HTTP: 5985</li><li>WinRM/HTTPS: 5986</li></ul></td></tr><tr><td>CIFS (aka SMB, Windows File Server protocol)</td><td><ul><li>TCP: 445</li></ul></td></tr><tr><td>Veeam Backup Server</td><td><ul><li>Default: 9419 (REST API)</li></ul></td></tr><tr><td>Syslog Server</td><td><ul><li>TCP and UDP (Incoming): 514</li></ul></td></tr></tbody></table>


# IT-Conductor Gateway Setup on Windows

The IT-Conductor Gateway enables communication between the customer's site network and the IT-Conductor cloud platform. It must be connected successfully before any private customer systems can be monitored by IT-Conductor.

### Installation Instructions

1. In IT-Conductor, navigate to **Support → Downloads →** [**Gateway Downloads**](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=55792548)**.**

![Figure 1: Gateway Installation Media Downloads](/files/Ql0SCOV7gOFywgHojuT0)

2. Download **itcgtwx64.net.45.msi.**

{% hint style="info" %}
**Note:** This requires Windows Server 2008 R2 and later with .NET 4.5 or later.
{% endhint %}

3. Run the downloaded **itcgtwx64.net.45.msi** file and click **Next**.

![Figure 2: IT-Conductor Agent Setup Wizard](https://service.itconductor.com/iconShow?iconName=Help.agent.install.windows.1)

4. Accept the End User License Agreement and click **Next**.

![Figure 3: End User License Agreement](https://service.itconductor.com/iconShow?iconName=Help.agent.install.windows.2)

5. Choose the setup type that best suits your needs.

![Figure 4: Choose Setup Type](https://service.itconductor.com/iconShow?iconName=Help.agent.install.windows.3)

{% hint style="info" %}
**Note:** You can only select the installation folder if "Custom" is chosen.
{% endhint %}

6. When the installation is complete, tick the **"Launch Agent Configuration when Setup exits"** checkbox and click **Finish.**

![Figure 5: Completed the IT-Conductor Agent Setup Wizard](https://service.itconductor.com/iconShow?iconName=Help.agent.install.windows.4)

7. The Gateway Configuration window will open. You can also start it at any time from Program Menu under "IT-Conductor\Agent\\".
8. In the **Connection** tab, fill in the following fields:

* **Account ID** - This is the Service Account ID.
* **API Key** - The API Key for the Service Account will be generated when the Service Account is created.

To obtain the Service Account ID and API Key in IT-Conductor, navigate to **Management → Security → Service Accounts**.

<figure><img src="/files/sjofknARZndXPjP70XtE" alt=""><figcaption><p>Figure 6: IT-Conductor Service Accounts</p></figcaption></figure>

Then, select the account to display the configuration details, as shown in Figure 7.

<figure><img src="/files/kQ4gv8Td3DNgDH3qnnbM" alt=""><figcaption><p>Figure 7: IT-Conductor Service Account Properties</p></figcaption></figure>

* **Agent ID** - This is the ID for one of the Gateways created by your administrator earlier.

To obtain the Gateway ID in IT-Conductor, navigate to **Management → Resources → Gateways**.

![Figure 8: IT-Conductor Remote Gateways](/files/ErWuWd7s4hrd4Ale9YHl)

9. Click **Test** to verify the configuration.

![Figure 9: Test Connection](/files/XPfuGsYXODdQLoG0nWp6)

10. Switch to the **Service** tab and fill in the following fields:

* **Java Home** - Choose the folder containing "Java 8x64 Runtime Environment" or click **Install/Update** to download the latest JRE from the IT-Conductor platform to the agent folder and set Java Home accordingly.

![Figure 10: IT-Conductor (Not Responding)](/files/MD3zqSQVdJ6aLJ4J4I6g)

We recommend using the latest JRE supported by IT-Conductor by using the **Install** button.

{% hint style="info" %}
**Note:**

* For 1st-time installations, the **Install** button will appear. Else, the **Update** button will show.
* Clicking **Install** will download the JRE from Oracle, so it may take a few minutes (depending on Internet connection speed).
* It is normal to see the status "IT-Conductor (Not Responding)" while this download and installation occurs.
  {% endhint %}

Once the Installation of JRE is successful, the Java Home will be automatically updated.

![Figure 11: Installation Successful](/files/lO7MQQxEJicDDcQ5a81T)

* **Java Heap Size** - if needed, increase the Java maximum heap size. 500m is the minimum but at least 1000m is recommended.

11. Click **Update Gateway** to download the latest version of the Gateway.
12. When all is completed, click **Save** and start the Gateway service.
13. Close the configuration window.

### Firewall Configuration (Optional)

If the machine you are installing the Gateway has a Windows Firewall turned on and it is configured to block all outgoing connections by default, you will need to add an exception to allow the IT-Conductor Gateway to connect to the IT-Conductor Cloud Service:

1. Open Control Panel Windows Firewall configuration.
2. Click **Allow an app or feature through Windows Firewall**.
3. Click **Allow another app.**
4. Next to the **Path** field, click **Browse** and select **c:\Program Files\IT-Conductor\Agent\bin\ITCAgent.exe**.
5. Click **Network Types** to select the networks.
6. Click **Add**. Then click **OK** to complete the configuration.


# IT-Conductor Gateway Setup on Linux

The IT-Conductor Gateway enables communication between the customer's site network and the IT-Conductor cloud platform. It must be connected successfully before any private customer systems can be monitored by IT-Conductor.

### Installation Instructions

1. Log in to the provisioned Gateway VM.
2. Configure TIME\_WAIT socket recycling, if applicable. Edit "/etc/sysctl.conf" and add the following entries before saving:

```
net.ipv4.tcp_fin_timeout = 20
net.ipv4.tcp_tw_reuse = 1
net.core.somaxconn = 65535
```

3. Reload the settings using the command below:

```
# sudo sysctl -p
```

4. In IT-Conductor, navigate to **Support → Downloads →** [**Gateway Downloads**](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=55792548)**.**

<figure><img src="/files/FrwVe4buVH2UV5waLuPE" alt=""><figcaption><p>Figure 1: Gateway Installation Media Downloads</p></figcaption></figure>

5. Download "itconductor-gateway-x-xx.xxx" to a local directory.

{% tabs %}
{% tab title="Linux" %}
• Install the RPM package. You should see the following output:

```
# sudo rpm -U itconductor-gateway-x-xx.x86_64.rpm
Registering Service ...
Configuring Service Startup ...
IT-Conductor Gateway installed successfully
```

{% endtab %}

{% tab title="Ubuntu" %}

* Install the DEB package. You can use dpkg or apt command:

```
$ sudo dpkg -i itconductor-gateway-6-81.deb
Registering Service ...
Configuring Service Startup ...
IT-Conductor Gateway installed successfully
```

or

```
$ sudo apt -i itconductor-gateway-6-71.deb
Registering Service ...
Configuring Service Startup ...
IT-Conductor Gateway installed successfully
```

{% endtab %}
{% endtabs %}

6. Configure Gateway parameters:

```
# /opt/itconductor/gwconfig
IT-Conductor Gateway Configuration build: xxxxxxxxxxxx
Gateway ID [GATEWAYID]: xxxxxx
Account ID [ACCOUNTID]: xxxxxx
API Key [APIKEY]: xxxxxx
Proxy [false]:
Configuration saved
```

* **Account ID** - This is the Service Account ID.
* **API Key** - The API Key for the Service Account will be generated when the Service Account is created.

To obtain the Service Account ID and API Key in IT-Conductor, navigate to **Management → Security → Service Accounts**.

<figure><img src="/files/sjofknARZndXPjP70XtE" alt=""><figcaption><p>Figure 2: IT-Conductor Service Accounts</p></figcaption></figure>

Then, select the account to display the configuration details, as shown in Figure 3.

<figure><img src="/files/kQ4gv8Td3DNgDH3qnnbM" alt=""><figcaption><p>Figure 3: IT-Conductor Service Account Properties</p></figcaption></figure>

* **Gateway ID** - This is the ID for one of the Gateways created by your administrator earlier.

To obtain the Gateway ID in IT-Conductor, navigate to **Management → Resources → Gateways**.

![Figure 4: IT-Conductor Remote Gateways](/files/ErWuWd7s4hrd4Ale9YHl)

If the proxy is used for connecting to the internet, while running gwconfig utility choose Proxy=true:

<pre><code><strong># /opt/itconductor/gwconfig
</strong>IT-Conductor Gateway Configuration build: xxxxxxxxxxxx
Gateway ID [GATEWAYID]: xxxxxx
Account ID [ACCOUNTID]: xxxxxx
API Key [APIKEY]: xxxxxx
Proxy [false]: true
Proxy Host []: xxxxx
Proxy Port []: 8080
Configuration saved
</code></pre>

7. Configure JRE. To verify that the default Java installation is Java 8 x64 JRE, run the command below:

{% tabs %}
{% tab title="Linux" %}

```
# java -version
```

{% endtab %}

{% tab title="Ubuntu" %}

```
$ java -version
$ sudo apt install openjdk-8-jre-headless
```

![Figure 6: Ubuntu Java Version](/files/sKmknFgR5ZXA740hZH5u)

After installation, run the following commands:

```
$java -version
openjdk version "1.8.0_312"
OpenJDK Runtime Environment (build 1.8.0_312-8u312-b07-0ubuntu1-b07)
OpenJDK 64-Bit Server VM (build 25.312-b07, mixed mode)
```

{% endtab %}
{% endtabs %}

You can [download](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=7047366675618408) a *tar* version of OpenJDK JRE from the IT-Conductor site or, for the latest version, from [Adoptium](https://adoptium.net/temurin/releases/?version=8) website.

* Extract the file to the "/opt/itconductor/" directory.
* Edit the "/opt/itconductor/conf/startup" file and replace the value to "java\_path=./\<JRE Directory>/bin/java".

8. Optionally configure Gateway custom **Gateway Maximum Heap Size -** the default size is calculated as: \<system available memory> - 500MB.

* Edit the "/opt/itconductor/conf/startup" file, and replace the **xmx** value with "xmx=4000m". This limits the heap size to 4000 MB.

9. Test the IT-Conductor cloud connectivity using the command below:

```
# /opt/itconductor/gwupdate
IT-Conductor Gateway build: xxxxxxxxxx
Starting update...
Gateway.jar is up to date
```

Normally, the update either downloads the latest version of Gateway.jar or reports that it is up to date. If no connection can be established to the cloud service, an error message will be displayed.

10. To start the gateway, use:

```
# sudo systemctl start itconductor-gateway
```

11. To stop the gateway, use:

```
# sudo systemctl stop itconductor-gateway
```

### Video

{% embed url="<https://www.youtube.com/watch?v=wTHlSldJE68>" %}


# IT-Conductor Gateway Setup on AWS

The IT-Conductor Gateway enables communication between the customer's site network and the IT-Conductor cloud platform. It must be connected successfully before any private customer systems can be monitored by IT-Conductor.

### Installation Instructions <a href="#it-conductorgatewaysetupforaws-installationinstructions" id="it-conductorgatewaysetupforaws-installationinstructions"></a>

IT-Conductor supplies pre-configured AWS AMI published on AWS Marketplace as a free product.

1\. In AWS Console, launch EC2 service, go to AMI Catalog, and search for "IT-Conductor" in AWS Marketplace AMIs.

![Figure 1: Amazon Machine Image (AMI)](/files/NKJt2GoUo4NyeMlt9CrZ)

2\. Select the IT-Conductor Gateway, click **Launch Instance with AMI,** and proceed to choose the Instance type. Depending on the number of monitored systems, choose "starting from Medium to 2XL" (burstable (t) or general purpose (m) is recommended), then proceed to **Configure Instance Details**.

3\. In **Network Settings**, select or create a Security Group with the following rules:

**Inbound Rules** - allow access to port 8080 and ssh for Gateway configuration

<figure><img src="/files/LMLtmTccvWzbF15ZV87p" alt=""><figcaption><p>Figure 2: Security Group Inbound Rules</p></figcaption></figure>

Adjust destination CIDR according to your VPC setup, you will need to be able to access Gateway EC2 Instance with a web browser or a terminal (ssh)

**Outbound Rules** - allow access to

* Public internet and specifically hosts "agents.itconductor.com" (or the IP/SIDR resolved from that DNS name)
* Applications running on EC2 Instances in the VPC that you intend to monitor and manage with IT-Conductor

<figure><img src="/files/kmLQO5x5m3g9Fd0VdCfq" alt=""><figcaption><p>Figure 3: Security Group Outbound Rules</p></figcaption></figure>

applications. Adjust destination SIDR according to your VPC setup, and add additional rules for accessing applications within VPC based on the specific protocol used if required.

4\. Launch the instance and wait until the instance state changes to "Running". It may take several minutes to fully initialize.

5\. On a machine that has been allowed to connect to the EC2 Instance, open a web browser and navigate to the URL:

```
http://<instance IP address>:8080
```

if no web browser connection can be established to the instance, log on locally via ssh2 and follow configuration instructions:

{% content-ref url="/pages/ufM13lgmGUcsiBq8DUqk" %}
[IT-Conductor Gateway Setup on Linux](/user-guide/setup/gateway-setup/it-conductor-gateway-setup-for-linux)
{% endcontent-ref %}

If the security group is properly configured the following web form should display:

<figure><img src="/files/fDOtdNvAd3jePsbFq2tT" alt=""><figcaption><p>Figure 4: Gateway Configuration Prompt</p></figcaption></figure>

Fill in the values and click **Save**. After saving, the configuration screen can be accessed later with Account ID/API Key as user/password if any changes need to be made.

* **Gateway ID** - use the ID for the Gateway created by your administrator earlier. To obtain the Gateway ID, navigate to **Management → Resources → Gateways**.

![Figure 5: IT-Conductor Remote Gateways](/files/WVzPe5aSW2pG6ZfweAfM)

* **Account ID** - set the Service Account ID.
* **API Key** - set the API Key for the Service Account. The key is generated when the Service Account is created.

To obtain the Service Account ID and API Key, navigate to **Management > Security > Service Accounts**.

![Figure 6: IT-Conductor Service Accounts](/files/OGhd7JvF94CfkZfCzm8Q)

Click on one of the accounts to display the details:

![Figure 7: Modify Service Account Wizard](/files/euiAz9j77vAFCRvXzTo0)

Use ID and API Key for Account ID and API Key respectively.

* **Proxy, Host & Port** - check the Proxy box is proxy required for internet access, also fill in the host and port as required. For DMZ setup when the proxy is required for accessing both the Internet and VPC resources contact IT-Conductor support for additional instructions.

6\. Wait for several minutes until the Gateway uptime and heartbeat are updated.

<figure><img src="/files/PFx73kuKg6lkiv5PZW8c" alt=""><figcaption><p>Figure 8: Gateway Status</p></figcaption></figure>

You can also click on ![](/files/3SXlNMwWxiHcqzkNv3p7) to see the Gateway log.

<figure><img src="/files/ADIW3W3C6FRZIXbcNiBT" alt=""><figcaption><p>Figure 9: Demo Gateway Log</p></figcaption></figure>


# IT-Conductor Gateway Setup on Azure

The IT-Conductor Gateway enables communication between the customer's site network and the IT-Conductor cloud platform. It must be connected successfully before any private customer systems can be monitored by IT-Conductor.

### Installation Instructions

IT-Conductor supplies pre-configured Azure VM Image published on Azure Marketplace as a free product.

1. Visit [Azure Portal](https://portal.azure.com/) and enter your login credentials.
2. Navigate to **Marketplace** and search for "IT-Conductor Gateway".

<figure><img src="/files/vXn8S5HsOqSawBhliTJH" alt=""><figcaption><p>Figure 1: Azure VM Image</p></figcaption></figure>

3. Locate **IT-Conductor Gateway** in the search results, click **Create,** and select **Gateway on Ubuntu Linux** in the dropdown. You will be redirected to the **Create a virtual machine** page.
4. In the **Basics** section, select relevant **Subscription** and **Resource group**, **Region,** and **Availability Options**. Then select the **Size** of the VM depending on the number of systems to be monitored.

{% hint style="info" %}
**Note:** VM must have at least two vCPUs and 2GB of RAM.
{% endhint %}

![Figure 2a: Create a Virtual Machine (Basics Screen)](/files/Wu6yEwEuqkkfl5mU13CE)

5. In the **Networking** section, select **Virtual Network**, **Subnet,** and **Public IP** if needed.

{% hint style="info" %}
**Note:** IT-Conductor doesn't require the VM to have a public IP, but it needs to be able to access public networks.
{% endhint %}

![Figure 2b: Create a Virtual Machine (Networking Screen)](/files/J28q299ta0tdjAuYK5Kg)

6. Review other sections relevant to your particular requirements. Then click **Review + create** to proceed in creating the VM.

![Figure 2c: Create a Virtual Machine (Review + Create Screen)](/files/i9KZjEofbPYc6MMvNV5f)

7. On a machine that has been allowed to connect to the VM, open a web browser and navigate to the URL:

```
http://<instance IP address>:8080
```

If no web browser connection can be established to the instance, log on locally via SSH2 and follow the configuration instructions in [IT-Conductor Gateway Setup on Linux](/user-guide/setup/gateway-setup/it-conductor-gateway-setup-for-linux).

If the security group is properly configured, the **IT-Conductor Gateway Configuration** web form should be displayed.

<figure><img src="/files/NXxrLuuZqMqRV1B85CZT" alt=""><figcaption><p>Figure 3: IT-Conductor Gateway Configuration Web Form</p></figcaption></figure>

Fill out the fields and click **Save**. After saving, the configuration screen can be accessed later with Account ID/API Key as user/password if any changes need to be made.

* **Gateway ID**: Use the ID for the Gateway created by your administrator.

To obtain the Gateway ID, navigate to **Management → Resources → Gateways**.

![Figure 4: IT-Conductor Gateways Actions Panel Page](/files/WVzPe5aSW2pG6ZfweAfM)

* **Account ID**: Set the Service Account ID.
* **API Key**: Set the API Key for the Service Account. The key is generated when the Service Account is created.

To obtain the Service Account ID and API Key, navigate to **Management > Security > Service Accounts**.

![Figure 5: IT-Conductor Service Accounts](/files/OGhd7JvF94CfkZfCzm8Q)

Select the account to display the configuration details, as shown in Figure 6.

<figure><img src="/files/dDMfc3lBS7MhxHsAWgYH" alt=""><figcaption><p>Figure 6: Service Account Configuration Page</p></figcaption></figure>

Use **ID** and **API Key** for **Account ID** and **API Key,** respectively.

* **Proxy, Host & Port:** If a Proxy is required for internet access, check the proxy box and fill in the host and port as required. For DMZ setup, when the proxy is required to access the Internet and VPC resources, contact [IT-Conductor Support](/references/support) for additional instructions.

8. Navigate back to **Management → Resources → Gateways**. Wait for several minutes until the Gateway uptime and heartbeat are updated.

![Figure 7: IT-Conductor Gateways Actions Panel Page](/files/PFx73kuKg6lkiv5PZW8c)

Alternatively, click ![](/files/3SXlNMwWxiHcqzkNv3p7) to see the Gateway log.

<figure><img src="/files/ADIW3W3C6FRZIXbcNiBT" alt=""><figcaption><p>Figure 8: Demo Gateway Log</p></figcaption></figure>


# IT-Conductor Gateway Setup for SAP Secure Network Communications (SNC)

Secure Network Communication (SNC) is a software layer in the SAP System architecture that provides an interface to an external security product. SAP Systems offers basic security measures like SAP authorization and user authentication based on passwords. With SNC, you can include protection by an external security product. SNC provides application-level, end-to-end security, and secures all communications between two SNC-protected components. SNC protection only applies to connections that use SAP protocols such as dialog, RFC, or CPIC protocols.

### Installation Instructions <a href="#it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-prepareit-conductorgateway" id="it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-prepareit-conductorgateway"></a>

#### Set SNC Environment Variables <a href="#it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-setsncenvironmentvariables" id="it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-setsncenvironmentvariables"></a>

On Windows:

1. Open the System Properties dialog and change the directory to "/opt/itconductor/conf".

{% hint style="info" %}
**Note:** If SNC is already configured on the machine and the SECUDIR system environment variable is set, skip this step.
{% endhint %}

2. Edit file startu&#x70;**.** Add SECUDIR lines as shown below:

```
java_path=./jdk1.8.0_171/jre/bin/java
SECUDIR=/opt/itconductor/conf
export SECUDIR
```

{% hint style="info" %}
**Note:** If SNC is already configured on the machine and SECUDIR uses the value of the existing environment variable.
{% endhint %}

#### Install SAP Cryptographic Library <a href="#it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-installsapcryptographiclibrary" id="it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-installsapcryptographiclibrary"></a>

1. Download the SAP Cryptographic Library ("SAPCRYPTOLIB.SAR" file) from the SAP Service Marketplace.

![Figure 1: SAP Cryptographic Library](/files/ZlHYwK17hsGOMF1OBIpY)

2. Extract and copy the library and the command-line tool to a local directory.

![Figure 2: Extracting SAP Cryptographic Library](/files/YOqOENnBTSctc8UgaP1X)

|              | Windows       | Linux/Unix   |
| ------------ | ------------- | ------------ |
| Library      | sapcrypto.dll | sapcrypto.so |
| Command Line | sapgenpse.exe | sapgenpse    |

![Figure 3: Command to Check SECUDIR Set](/files/V4WRHmCWZWVya0hhaVRe)

{% hint style="info" %}
**Note:** Make sure the SECUDIR environment variable is set. You can set it for the current session on Linux and make sure the value is the same as in the previous steps.
{% endhint %}

### Configure SNC PSE <a href="#it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-configuresncpse" id="it-conductorgatewaysetupforsapsecurenetworkcommunications-snc-configuresncpse"></a>

1. Obtain the SNC Distinguished Name (DN) for the IT-Conductor Gateway from your security team. (e.g., CN=IT-Conductor, OU=IT, O=ACME, C=US)
2. Decide on PSE Name. It could be "itconductor" or any valid name.
3. Create a local Personal Security Environment (PSE).

* To create the SNC PSE for IT-Conductor, use the command line tool sapgenpse.
* Run the following command to create a PSE in the directory corresponding to the SECUDIR environment variable:

```
sapgenpse get_pse  -p <PSE_Name> <DN>
```

{% tabs %}
{% tab title="Windows" %}

```
sapgenpse.exe get_pse -p itconductor "CN=IT-Conductor, OU=IT, O=ACME, C=US"
```

{% endtab %}

{% tab title="Linux" %}

```
./sapgenpse get_pse -p itconductor "CN=IT-Conductor, OU=IT, O=ACME, C=US"
```

{% endtab %}
{% endtabs %}

![Figure 4: Creating Personal Security Environment](/files/fpFAKm4rws7DDey4p3RI)

{% hint style="info" %}
**Note:** The SNC DN "CN=IT-Conductor, OU=IT, O=ACME, C=US" is used for the optional "SNC Client Name" field in the IT-Conductor SAP Account.
{% endhint %}

* Exchange public-key certificates by export and import. IT-Conductor and SAP Systems must identify each other to communicate using SNC.

1. Export the public-key certificate corresponding to the above created local PSE (used by the IT-Conductor) as the following:

```
sapgenpse export_own_cert -v -o <output_file> -p <PSE_name>
```

{% tabs %}
{% tab title="Windows" %}

```
sapgenpse.exe export_own_cert -v -o itconductor_pse.crt -p itconductor
```

{% endtab %}

{% tab title="Linux" %}

```
./sapgenpse export_own_cert -v -o itconductor_pse.crt -p itconductor
```

{% endtab %}
{% endtabs %}

![Figure 5: Exporting Public-Key Certificate](/files/PITGifb0tjZ8h010MxgS)

2. For each SAP System, IT-Conductor will be connecting using SNC. Repeat the following steps:

a. Import the created client certificate into the SAP System using the trust manager (transaction code STRUST).

b. Export the server certificate from the SAP Server using the trust manager (transaction code STRUST).

{% hint style="info" %}
**Note:** If a server certificate does not exist, create a server certificate. For more information, contact your SAP Administrator.
{% endhint %}

![Figure 6: Export Server Certificate](/files/Izwv5yZGwIVOOFIAHl1V)

c. Import the SAP Server certificate into the IT-Conductor PSE using the following command:

```
sapgenpse maintain_pk -v [-a <cert_file>] -p <PSE_name>
```

{% tabs %}
{% tab title="Windows" %}

```
sapgenpse.exe maintain_pk -v -a C:\tmp\sap_system_XYZ.crt -p itconductor
```

{% endtab %}

{% tab title="Linux" %}

```
./sapgenpse maintain_pk -v -a /tmp/sap_system_XYZ.crt -p itconductor
```

{% endtab %}
{% endtabs %}

![Figure 7: Import SAP Server Certificate](/files/HXLRVgv97alwEvT1T4qs)

d. Update SNC name for IT-Conductor SAP accounts using Transaction code SU01.

Make sure to prefix the DN for each SAP Account you plan to use in IT-Conductor with "p:" as p:CN=IT-Conductor, OU=IT, O=ACME, C=US.

![Figure 8: Updating SNC Name](/files/7kVzwkncD7f9hc3E37Zf)

3. Grant SNC permissions to the operating system. The Gateway service running as SAP System requires active credentials at run-time to access its PSE. You can use the seclogin to open the PSE and create the required credentials.

```
sapgenpse seclogin [-p <PSE_name>] [-O <user_ID>]
```

The following command line grants SNC permissions for the user SYSTEM to access the file sap\_plugin\_pse.

{% tabs %}
{% tab title="Windows" %}
The user name is **SYSTEM,** as the gateway runs under the Local System Account.

```
sapgenpse.exe seclogin -p itconductor -O SYSTEM
```

{% endtab %}

{% tab title="Linux" %}
The user name is **root,** as the gateway runs under the root account.

```
./sapgenpse seclogin -p itconductor -O root
```

{% endtab %}
{% endtabs %}

![Figure 9: Granting SNC Permissions](/files/PufmjGL9FvjzHcGgF6tP)


# IT-Conductor Gateway Restart Guide

A gateway restart may be required during maintenance, troubleshooting, or after configuration changes. You can restart the IT-Conductor Gateway using one of the following methods.

#### Method 1: Restart from the Management UI <a href="#method-1-restart-from-the-management-ui" id="method-1-restart-from-the-management-ui"></a>

1. On the main menu go to Management → Resources → Gateways.

<figure><img src="/files/9QpUrpFEpgOhjizDwl7P" alt=""><figcaption><p>Figure 1: Gateways Option in Main Menu</p></figcaption></figure>

2. Click the <img src="/files/Gm734IvPYJ8vNwkQBSZ1" alt="" data-size="line"> icon next to the gateway you wish to restart and click the **Request Restart** <img src="/files/9FJiRAbyU9bHORDiEBmJ" alt="" data-size="original"> button.

<figure><img src="/files/eNeXp2rX5xpapJ5UcejC" alt=""><figcaption><p>Figure 2: Request Restart Option 1</p></figcaption></figure>

3. The same button is also available by clicking on the gateway’s name → **Request Restart**

<figure><img src="/files/S7uA5yI2TWVHTBnojKIj" alt=""><figcaption><p>Figure 3: Request Restart Option 2</p></figcaption></figure>

4. Wait a few minutes for the restart to complete.
5. Verify the gateway status by clicking on **Gateway's Name** → **Gateway Heartbeat** and enlarging the pop-up chart.

<figure><img src="/files/bCmDH6M5eoZmy6YekI3O" alt=""><figcaption><p>Figure 4a: Gateway Heartbeat</p></figcaption></figure>

<figure><img src="/files/nEtcDEDe5MfSu22uYOQy" alt=""><figcaption><p>Figure 4b: Gateway Heartbeat Regulated</p></figcaption></figure>

#### Method 2: Restart using commands (Linux Only) <a href="#method-2-restart-using-commands-linux-only" id="method-2-restart-using-commands-linux-only"></a>

* Run the following commands on the gateway host:

```
sudo systemctl stop itconductor-gateway
sudo systemctl start itconductor-gateway
```

* Run the following command to display the gateway’s state after restarting.

```
sudo systemctl status itconductor-gateway
```

#### Method 3: From the Configuration Utility (Windows Only)

1. Navigate to the directory where the JRE Gateway is installed.
2. Open the Configuration Utility.
3. Click the **Stop** icon to stop the gateway.
4. Once the gateway has stopped, click the **Start** icon to restart it.

<figure><img src="/files/gfsBv9e07uLIRZb05Esy" alt=""><figcaption><p>Figure 5: Gateway Stop Start Option in the Configuration Utility (Windows)</p></figcaption></figure>


# API Server Setup

### Configure API Server <a href="#sapj2eesystem-howtoconfigureremotemonitoringofsapj2ee" id="sapj2eesystem-howtoconfigureremotemonitoringofsapj2ee"></a>

API Server enables on-premises local access to the IT-Conductor API interface. The Gateway(s) must be configured to act as an API Server.

1. In the IT-Conductor main menu, navigate to **Dashboards → Administrator.**

![Figure 1: IT-Conductor Dashboard Menu](/files/zZ3m1OVNUgXN0yuGTjcs)

2. Click the **Gateway** you want to configure to show the metric object menu. Then, click **Modify.**

![Figure 2: Sample Gateway to Modify](/files/MUQAKl2xtE4INayFoBhM)

<img src="/files/XWXCGq1UkkkGn2ZXK0pD" alt="Figure 3: Modify Option" width="112">

3. Check the **API Server** checkbox and specify the API Server Port value. Then, click the **Save** icon.

{% hint style="info" %}
**Note:** Ensure the port is available for listening and is not blocked by the local firewall.
{% endhint %}

![Figure 4: API Server and API Server Port Modification](/files/odAf9nUpkO1qX3PqXi8Y)

Within several minutes, the Gateway will start the API server.

### Usage <a href="#apiserversetup-usage" id="apiserversetup-usage"></a>

The IT-Conductor Gateway on Windows includes a client program that can interact with the API server.

The "ITCAPIClient.exe" program can be in the Gateway installation folder "C:\Program Files\IT-Conductor\Agent\bin" and copied to another folder or another Windows computer. There are no external dependencies except Windows .Net Framework 4.5.

The program usages are as follows:

```
C:\Program Files\IT-Conductor\Agent\bin>ITCAPIClient.exe
Usage: -server <host>:<port> -class <Class> <options>
        Options:
        When -class Notify specified:
                [-ACTIVITY_QueueId <Person ID>|<Group ID>|<Role ID>]
                [-NOTIFY_TargetClass Person|Group|Role|Customer] : ignored if ACTIVITY_QueueId is specified
                [-NOTIFY_TargetAttrName PERSON_LoginName|OBJECT_Name] : ignored if ACTIVITY_QueueId is specified
                [-NOTIFY_TargetAttrValue <Person Login>|<Group Name>|<Role Name>] : ignored if ACTIVITY_QueueId is specified
                -NOTIFY_Subject <subject>
                -NOTIFY_MessageLong <message>
        When -class <other> specified:
                Not documented
```

The sample below will create an IT-Conductor Notification for the IT-Conductor user identified by e-mail "<admin@itconductor.com>". The Notification will send e-mail(s) based on the person's notification schedule.

```
ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Person -NOTIFY_TargetAttrName PERSON_LoginName -NOTIFY_TargetAttrValue admin@itconductor.com -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"
```

The sample below will create an IT-Conductor notification for the IT-Conductor group BasisAdmins. The Notification will send e-mail(s) to all group members based on their notification schedules.

```
ITCAPIClient ozraid01:8881 -class Notify -NOTIFY_TargetClass Group -NOTIFY_TargetAttrName OBJECT_Name -NOTIFY_TargetAttrValue BasisAdmins -NOTIFY_Subject "Test Message" -NOTIFY_MessageLong "This is a test message sent via API Server"
```

The IT-Conductor Gateway on Linux does not include a client program however, it is possible to use wget similarly:

```
wget http://<host>:<port>/<Class>?<options>
Options:
        When Class Notify specified:
                [ACTIVITY_QueueId=<Person ID>|<Group ID>|<Role ID>&]
                [NOTIFY_TargetClass=Person|Group|Role|Customer&] : ignored if ACTIVITY_QueueId is specified
                [NOTIFY_TargetAttrName=PERSON_LoginName|OBJECT_Name&] : ignored if ACTIVITY_QueueId is specified
                [NOTIFY_TargetAttrValue=<Person Login>|<Group Name>|<Role Name>&] : ignored if ACTIVITY_QueueId is specified
                NOTIFY_Subject=<subject>&
                NOTIFY_MessageLong=<message>&
        When other classes specified:
                Not documented
```

For example:

```
wget http://ozraid01:8881/Notify?NOTIFY_TargetClass=Person&NOTIFY_TargetAttrName=PERSON_LoginName&NOTIFY_TargetAttrValue=admin@itconductor.com&NOTIFY_Subject=Test Message&NOTIFY_MessageLong=This is a test message sent via API Server
```

This notation can also be used from any web browser for testing purposes.


# MSP Tenant Setup

Managed Service Providers (MSPs) typically manage several customers of their own. It requires the capability to silo all systems data into separate organizations representing the customers. Also, it is a requirement that customer (organization) specific users don't have access to any data belonging to other customers (organizations).

IT-Conductor supports such configurations via the use of Organizations.

### Manage Organizations <a href="#msptenantsetup-managingorganizations" id="msptenantsetup-managingorganizations"></a>

1. In the IT-Conductor main menu, navigate to **Management → Resources → Organizations.**

![Figure 1: IT-Conductor Management Menu Options](/files/clzlrp8avHPhkhesiSas)

2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create a new organization.

![Figure 2: Create New Organization Icon](/files/Mu1OLSIpqzsORG1p7Sry)

3. Provide the tenant information in the **Create Tenant Organization** wizard and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

![Figure 3: Create Tenant Organization Wizard](/files/1lNXvfER7G3RmfE2d5xu)

Please ensure that the selected e-mail domain represents an actual customer e-mail domain.

* The e-mail domain is unique across the entire IT-Conductor space
* Invitations for customer/organization users are restricted to e-mails under that domain
* After creating the organization, tenant admins could no longer change the domain

You can assign a custom default dashboard for individual organizations

{% hint style="info" %}
**Note:** Do Not Disturb is only honored when a notification targets the Organization. It is not honored when notifying individual users within the organization directly or as part of a role or a group.
{% endhint %}

### Create Organization Objects <a href="#msptenantsetup-creatingorganizationobjects" id="msptenantsetup-creatingorganizationobjects"></a>

#### **Gateways**

Select the **Organization** drop-down in the wizard prompt when creating a new Gateway.

![Figure 4: Create New Gateway Wizard](/files/fHOo17ySj6mbMm2H0Odi)

#### **Monitored Systems**

When defining monitored systems, select the **Organization** dropdown in the wizard prompt.

![Figure 5: Create New SAP System Wizard](/files/5OnbQUwHj5oJ5f7xd6ui)

The application tree will show up under the Organizations container when properly configured.

#### Invite Organization Users <a href="#msptenantsetup-invitingorganizationusers" id="msptenantsetup-invitingorganizationusers"></a>

1. To invite a user, click the ***Organization Name*** in the Service Grid. Then, click **Users**.

![Figure 6: IT-Conductor Service Grid View](/files/X9cAVHpSBQwdmlHJZut9)

2. Click the **Invite** icon.

![Figure 7: Invitation Icon](/files/zK8UuaWAqBrZwCzVHgEt)

3. Fill in the necessary information and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the process. The invitation will be sent to the user and is Organization-specific. When the user goes through with the registration, they will be associated with the organization and inherit organizational roles.

![Figure 8: Invite a User to Register in IT-Conductor Wizard](/files/NBQKyK1WwKWf4aHsLedQ)


# SSO Setup

IT-Conductor supports SAML 2.0-based Single Sign-on.

### Understanding SAML Configuration

In SAML terms, there are two parties:

* **Identity Provider** that supplies the user authentication and is your trusted enterprise credentials - Okta, Microsoft ADFS (Azure or on-prem), Google Workspace, AWS IAM Identity Center, etc.
* **Service Provider** - In this case, it is IT-Conductor that supports SSO with Identity Provider, so you don't need to maintain/remember a separate set of credentials.

### Configure Identity Provider

To configure Identity Provider, you will need the following IT-Conductor SAML information:

* **Entity ID**: <https://service.itconductor.com>
* **Assertion Consumer Service URL**: <https://service.itconductor.com/saml/acs>
* **Relay State URL**: <https://service.itconductor.com/home>
* **Logout URL**: <https://service.itconductor.com/saml/logout>

Depending on what type of Identity Provider you are configuring, use the links below. Otherwise, use vendor instructions and the information above.

* [Configuring Azure ADFS](/user-guide/setup/sso-setup/azure-adfs-identity-provider)
* [Configuring Octa](https://www.okta.com/integrations/it-conductor/)

When the Identity Provider configuration is complete, either export Identity (Federation) Metadata XML and/or copy the following attributes:

* Identity Provider Identifier
* Login URL
* Logout URL
* Certificate (Base64)

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Management → Security → SSO Identity Providers.**

<figure><img src="/files/ntLIYYX5l2mwXMrUlfp0" alt=""><figcaption><p>Figure 1: SSO Identity Providers Actions Panel (Empty List)</p></figcaption></figure>

3. If you have previously exported Identity Metadata XML, click ![](/files/2lEs4tLDnOVmhMN8FjuG) and import the file. This will create the new Identity Provide definition.
4. Alternatively, you can click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create a new Identity Provider definition.

<figure><img src="/files/CDkbUHDNQmnSyshrqGqv" alt=""><figcaption><p>Figure 2: Create SAML Identity Provider Wizard</p></figcaption></figure>

5. Copy previously saved values to **Identity Provider Info** attributes as the following:

* **Name** - Unique Name - internal to IT-Conductor
* **Description** - Internally identifying information
* **Issuer** - Identity Provider Identifier
* **SSO URL** - Login URL
* **SLO URL** - Logout URL
* **Certificate** - exported base64 certificate

**Service Provider Info** attributes allow you to customize the mapping between Identity Provider and IT-Conductor, normally you don't need to do anything as default mappings should work. Otherwise, contact the IT-Conductor Support Team for assistance.

6. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> again to insert the Identity Provider.
7. Verify if the identity provider was added to the SSO Identity Providers actions panel.

<figure><img src="/files/kXKZUVYC7dctB4Ua5fZZ" alt=""><figcaption><p>Figure 3: SSO Identity Providers Actions Panel (Updated List)</p></figcaption></figure>

You can now use the SSO to log into IT-Conductor from your Identity Provider.

### How to update the SSO certificate in IT-Conductor

1. On the main menu, navigate to the **Management -> Security -> SSO Identity providers**.

{% hint style="info" %}
**Note:** Make sure you have an administrator role; otherwise, you won’t see this option.
{% endhint %}

<figure><img src="/files/mPQsgcTYnw29QBiOSAGT" alt=""><figcaption><p>Figure 4: SSO Identity Providers Option - Main Menu</p></figcaption></figure>

2. Click on the existing certificate entry

<figure><img src="/files/Kn4O0meKoASc8TM7xOBH" alt=""><figcaption><p>Figure 5: SSO Identity Providers</p></figcaption></figure>

3. Open the new certificate in a plain text editor and copy the text.
4. Paste and replace the contents of the new certificate in the **Certificate** box

<figure><img src="/files/kXLKJKejRT8lSqGQ9FpQ" alt=""><figcaption><p>Figure 6: Update Certificate Wizard Screen</p></figcaption></figure>

{% hint style="info" %}
**Note:** Make sure that the certificate is pasted as a continuous, valid block and avoid accidental extra line breaks from editors like Notepad.
{% endhint %}

5. Click on the save <img src="/files/7y7XLw4Pq9rZ6qwlkvIp" alt="" data-size="line"> icon
6. To authenticate that the certificate has been updated, open a private/incognito browser session and perform a full SSO login through your normal portal entry point to verify the new certificate flow works end-to-end with IT Conductor. Then confirm successful access after SAML authentication and check logs if available to ensure the login token and certificate validation succeed.


# Azure ADFS Identity Provider

Azure ADFS SAML 2.0 Configuration

### Create Azure AD Enterprise Application

{% hint style="info" %}
**Note:** Make sure that the Azure domain is an exact match to the e-mail domain used to register a tenant in IT-Conductor. Users with mismatched email domains will not be able to auto-provision in IT-Conductor
{% endhint %}

In the Azure Portal, navigate to **Azure Active Directory → Enterprise Applications → New Application.**

Don't try to locate an existing one but click **+ Create your application**.

<figure><img src="/files/ZdimiE6bXYXiSwxF8xhD" alt=""><figcaption><p>Figure 1: Create Your Own Application Wizard</p></figcaption></figure>

<figure><img src="/files/t1TiDk7ZKdCstsEet3uc" alt=""><figcaption><p>Figure 2: Application Setup</p></figcaption></figure>

1. Assign users and groups
2. Click **Get Started** in "Set up single sign on".

<figure><img src="/files/lphE43zpacySY8mSxP4v" alt=""><figcaption><p>Figure 3: IT-Conductor SSO Configuration</p></figcaption></figure>

Click on **SAML** to configure.

<figure><img src="/files/uzjcgkJfpCCKdJ7iFZDY" alt=""><figcaption><p>Figure 4: SAML Configuration</p></figcaption></figure>

Fill in the fields as described on the [SSO Setup](/user-guide/setup/sso-setup):

<figure><img src="/files/G5EBNM8Ytj017BVwi7zy" alt=""><figcaption><p>Figure 5: SAML Configuration with actual values</p></figcaption></figure>

Click **Federation Metadata XML Download** to export the metadata to a file.

Import the metadata into IT-Conductor to create an Identity Provider definition as described in [SSO Setup](/user-guide/setup/sso-setup).

Click **Test** to validate SSO Configuration.


# Azure Active Directory (AAD) App Gallery

Azure ADFS SSO with Gallery IT-Conductor Application

### Create Azure AD Enterprise Application

Visit [Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/aad.it-conductor?tab=Overview) to start using IT-Conductor AAD SSO:

{% hint style="info" %}
Make sure that the Azure domain is an exact match to the e-mail domain used to register a tenant in IT-Conductor. Users with mismatched email domains will not be able to auto-provision in IT-Conductor.
{% endhint %}

In the Azure portal, navigate to **Azure Active Directory** → **Enterprise Applications > New Application.**

Search for IT-Conductor and click on the application link.

<figure><img src="/files/3oiZo0H2nHJes6EJQVw4" alt=""><figcaption><p>Figure 1: Browse Azure AD Gallery</p></figcaption></figure>

After Adding the application it will show up in the installed application list.

<figure><img src="/files/g5vsphlBlqnKnz1ig6AS" alt=""><figcaption><p>Figure 2: Enterprise Applications in Azure Portal</p></figcaption></figure>

Click on the application to finish the configuration.

<figure><img src="/files/d2Op8i1Pjpi076PNRiP1" alt=""><figcaption><p>Figure 3: IT-Conductor Overview in Azure Portal</p></figcaption></figure>

* Click on **Assign users and groups** to configure SSO application access.
* Click on **Set up single sign-on.**

<figure><img src="/files/bnj6WSfBgqD5LbqgwGQY" alt=""><figcaption><p>Figure 4: Set up SSO wil SAML</p></figcaption></figure>

Click **Federation Metadata XML Download** to export the metadata to a file

an Import the metadata into IT-Conductor to create an Identity Provider definition as described in [SSO Setup](/user-guide/setup/sso-setup).

Click **Test** to validate SSO Configuration.


# Monitoring


# General


# Maintenance Mode

Maintenance Mode (MM) suspends monitoring for all components when applied to a monitored system. It is propagated down the service tree, implying that when a Site enters MM, all its associated applications also enter MM. Similarly, when any element in the service tree enters MM, all its child elements are likewise placed in MM. Placing monitored systems in MM is primarily intended to facilitate planned outages.

* Placing the IT-Conductor Gateway (GW) in MM triggers the suspension of monitoring for all systems assigned and handled by that specific GW.
* When Threshold Overrides are put in MM, they are effectively disabled.
* When Schedules are put in MM, all schedules are suspended.
* When Object Templates are put in MM, template triggering is suspended.
* When User, Group, or Role is put in MM, notifications are not sent to recipients.

{% hint style="info" %}
**Note:** The calculation of system availability omits the time interval during which the system is in MM, ensuring no impact on SLO/SLA attainment.
{% endhint %}

### Enable Maintenance Mode <a href="#maintenancemode-initiatingmaintenancemode" id="maintenancemode-initiatingmaintenancemode"></a>

There are several ways to enable MM for an object:

#### **Manual**

If an object supports MM, you should see an MM tool icon or find a "Maintenance On" object menu item. Initiating MM manually is logged in the audit trail and persists until the object is removed from MM, either manually or automatically.

#### **Scheduled**

Systems can be assigned a Maintenance Schedule. When the schedule is activated, the system enters MM. Similarly, when the schedule is deactivated, the system exits MM.

{% hint style="warning" %}
**Warning:** When the Maintenance Schedule is assigned, any manual or derived MM is ignored and overwritten.
{% endhint %}

**Event-based**

Service tree elements can be linked to Maintenance Events to have them placed in MM and taken out of MM on schedule.

To set this up, click on the service "Events" tool or select the "Events" object menu item. This opens a list of assigned events.

To create a new event, maximize the popup and click on the "Maintenance Event" icon. This will trigger a wizard, guiding you through the creation process and prompting input for the start and end times.

At any point, you have the option to delete or terminate the ongoing event, effectively removing the object from MM.


# Manual Maintenance

### Set a Single System Into Maintenance Mode

1. Navigate to the IT-Conductor Service Grid, expand the container groups (i.e., SAP Systems), and find the system (i.e., specific SID) to update.
2. Click the context menu icon (i.e., SAP logo) for that system.
3. Click **Maintenance On**.

<figure><img src="/files/z9f9h4Rq2q5d8rAd9qFT" alt=""><figcaption><p>Figure 1: Maintenance On for a Single System</p></figcaption></figure>

### Set Multiple Systems Into Maintenance Mode

1. Navigate to the IT-Conductor Service Grid and find the container group (i.e. SAP Systems) to update.
2. Click the context menu icon (i.e., SAP logo) for that container group.
3. Click **Maintenance On**.

<figure><img src="/files/FVYUGcyBzHxa68nqFT0R" alt=""><figcaption><p>Figure 2: Maintenance On for Multiple Systems</p></figcaption></figure>

### Remove Maintenance Mode Setting

1. Navigate to the IT-Conductor Service Grid.
2. Click the **Show Services in Maintenance Mode** icon.

<figure><img src="/files/ri3UIFU8UgcssZZUplf3" alt=""><figcaption><p>Figure 3: Show Services in Maintenance Mode Icon</p></figcaption></figure>

3\. Find the system or container group to update. Then click on the context menu (i.e., SAP logo) for that system or group of systems.

4\. Click **Maintenance Off**.

<figure><img src="/files/tK2kLAqw0xgE7vJh1WPn" alt=""><figcaption><p>Figure 4: Maintenance Off for a Single System</p></figcaption></figure>

<figure><img src="/files/VQPR8oFKPWzWPr25deFk" alt=""><figcaption><p>Figure 5: Maintenance Off for Multiple Systems</p></figcaption></figure>


# Scheduled Maintenance

### Schedule a Single System Into Maintenance Mode

1. Navigate to the IT-Conductor Service Grid, expand the container groups (i.e., SAP Systems), and find the system (i.e., specific SID) to update.
2. Click on the context menu icon (i.e. SAP logo) for that group.
3. Click **Event Schedule**.

<figure><img src="/files/VA2GTGes0rpfwSKxmaKY" alt=""><figcaption><p>Figure 1: Event Schedule for a Single System</p></figcaption></figure>

4. In the Scheduled Maintenance Events pop-up window, click the **Maximize** icon.

<figure><img src="/files/PNxZYn71Niyi0CMMxmjC" alt=""><figcaption><p>Figure 2: Scheduled Maintenance Events</p></figcaption></figure>

5. Click the **Create new maintenance event** icon.

<figure><img src="/files/TniR3yJNLh8iJ4WDEUjD" alt=""><figcaption><p>Figure 3: Create New Maintenance Event</p></figcaption></figure>

6. Fill out the fields, especially the Start and End Dates and Times. Then click **Finish**.

<figure><img src="/files/neIH5ra9Q3m4QhlLFTeC" alt=""><figcaption><p>Figure 4: New Maintenance Event</p></figcaption></figure>

7. The newly created event schedule will be in "Waiting" status until it gets triggered.
8. Once it gets triggered and the set schedule date and time have passed, the status will change to "Succeeded".

<figure><img src="/files/orr5EW3VbjI9NSW6e7yU" alt=""><figcaption><p>Figure 5: Event Schedule in Succeeded Status</p></figcaption></figure>

{% hint style="warning" %}
**Warning:** If there’s a maintenance schedule applied to this system, the maintenance mode button will not show up. See the [Create a maintenance schedule](#create-a-maintenance-schedule) section to learn how to troubleshoot.
{% endhint %}

### Schedule Multiple Systems Into Maintenance Mode

1. Navigate to the Service Grid and find the container group (i.e., SAP Systems) to update.
2. Click on the context menu icon (i.e., SAP logo) for that group.
3. Click **Event Schedule**.

<figure><img src="/files/siWTY0LXRcOVRcDsDrVB" alt=""><figcaption><p>Figure 6: Event Schedule for Multiple Systems</p></figcaption></figure>

4. Repeat Steps 4-6 above. Also, expect the same for Steps 7-8.
5. To view all systems currently in maintenance mode at a glance, click the ![](/files/WEBc156ZZdVgnIupsbjz) icon.

<figure><img src="/files/7A1gZmdOXizZXzP8Rahb" alt=""><figcaption><p>Figure 7: Show Services in Maintenance Mode</p></figcaption></figure>

<figure><img src="/files/PtzxmW7gkdX8crFXcoxw" alt=""><figcaption><p>Figure 8: Hide Services in Maintenance Mode</p></figcaption></figure>

### Create a Maintenance Schedule

Use this when your organization has a recurring maintenance window, and you need to automatically place a system into maintenance mode on a defined schedule. For example, the first Friday of each month from 10:00 PM to 12:00 AM.

1. On the main menu, go to **Maintenance → Automation → Schedules.**
2. Click on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> button to create a new one.

<figure><img src="/files/lrUjWiuMWwzPU8x9dyZC" alt=""><figcaption><p>Figure 9: List of Existing Schedules</p></figcaption></figure>

3. Fill in the following fields in the wizard
   1. **Name** - refers to an identifier for the schedule
   2. **Description** - refers to a brief explanation of the schedule’s use
   3. **Work days** – Use this option to schedule maintenance for a specific date only (one-time occurrence). See Figure 10a.
   4. **Time window** - refers to the specific times during which the event will take place. See Figure 10b.
      1. Click on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> button to add a new row
      2. Enter the start and end time
      3. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save
   5. **Formulae** - Select a formula to define a schedule based on a specific pattern (e.g., the first Friday of each month or the 10th day every two months). You can add multiple rows to further refine the schedule. For more examples on how to utilize this feature, check our [video tutorial.](https://www.youtube.com/watch?v=O3OxqAKBuMM\&t=40s) See Figure 10c.
      1. Click on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> button to add a new row
      2. Enter the start and end time
      3. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save
4. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save the schedule.

<figure><img src="/files/KuboguO0GU7W8hALkanh" alt=""><figcaption><p>Figure 10a: Create a New Schedule - Work Days Field</p></figcaption></figure>

<figure><img src="/files/QGFYIPkemWZewiJVS3Oj" alt=""><figcaption><p>Figure 10b: Create a New Schedule - Time Window Field</p></figcaption></figure>

<figure><img src="/files/9jAc0yXwIT9Wb04B7q95" alt=""><figcaption><p>figure 10c: Create a New Schedule - Formulae Field</p></figcaption></figure>

{% hint style="info" %}
**Note:** For more accurate and predictable scheduling, use either **Work Days** with **Time Window** *or* **Formulae** with **Time Window**.
{% endhint %}

5. Navigate to the system you wish to add the maintenance schedule to.
6. Click **Properties.**

<figure><img src="/files/5AfGzHpAVsQOcepM1GQB" alt=""><figcaption><p>Figure 11: System Properties</p></figcaption></figure>

8. On **Maintenance Schedule**, select the created schedule from the menu.

<figure><img src="/files/UPlCI1AvqVDBReuJV5gH" alt=""><figcaption><p>Figure 12: Assign a Maintenance Schedule</p></figcaption></figure>

9. Click save ![](/files/7y7XLw4Pq9rZ6qwlkvIp). The same schedule can be reused to automatically place other systems in maintenance mode, provided they follow the same frequency.

{% hint style="warning" %}
**Warning:** When a maintenance schedule is assigned, it overrides any manual or inherited maintenance mode.

To place the system in maintenance mode outside the schedule, temporarily remove the schedule from the system’s properties. The manual maintenance option will then be available again. You can place the schedule back on anytime.
{% endhint %}


# Central Syslog Server Monitoring

The central syslog server monitoring architecture leverages IT-Conductor gateways already deployed to on-premises/in-cloud environments and enables consolidated collection, monitoring, management, notification, and auditing of Syslog messages.

In IT-Conductor, "Site" constructs multiple syslog servers. The messages they capture can be dedicated to geographically or organizationally separated environments with separate monitoring and notification policies (e.g., QA/Development vs. Production, etc.).

### **Configure Central Syslog Server Monitoring in IT-Conductor**

To configure the central syslog server monitoring in IT-Conductor, follow the instructions below.

#### Set Up Clients to Report to the Central Syslog Server <a href="#set-up-clients-to-report-to-the-central-syslog-server" id="set-up-clients-to-report-to-the-central-syslog-server"></a>

You can configure various computing and network nodes to report syslog messages to the central syslog server.

**Instructions for Linux Servers**

1\. Login with a privileged account (or sudo) and edit the syslog configuration file `/etc/rsyslog.d/remote.conf` (SLES) or `/etc/rsyslog.conf` (RHEL).

2\. Uncomment the relevant line (TCP or UDP) and replace `remote-host` with the address of the central syslog server.

UDP Example:

```
# Remote Logging using UDP
# remote host is: name/ip:port, e.g. 192.168.0.1:514, port optional
*.* @it-conductor-gateway-host
```

TCP Example:

```
# Remote Logging using TCP for reliable delivery
# remote host is: name/ip:port, e.g. 192.168.0.1:514, port optional
*.* @@it-conductor-gateway-host
```

3\. Save the file.

4\. Restart the `rsyslog` service.

```
> sudo systemctl restart rsyslog.service
```

5\. Verify the syslog forwarding is functioning:

```
> logger "hello world"
```

The log message `hello world` should now appear in the central syslog server registered in IT-Conductor.

#### Add Central Syslog Server <a href="#add-a-central-syslog-server" id="add-a-central-syslog-server"></a>

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Central Syslog Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/2lYrfHJMQSJxIyH4EsN3" alt=""><figcaption><p>Figure 1: Central Syslog Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New Syslog Server** button to start adding a syslog server for monitoring.

<figure><img src="/files/AsrZYYWS4Llcg9bhnQk6" alt=""><figcaption><p>Figure 2: Central Syslog Servers Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New Syslog Server** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the syslog server.

<figure><img src="/files/sVR8tQj7rA0Zm3E3fEsS" alt=""><figcaption><p>Figure 3: New Syslog Server Wizard</p></figcaption></figure>

* **Name** - refers to the name given to the new syslog server.
* **Description** - refers to any relevant information about the syslog server being added.
* **Role** - refers to the environment where the syslog server will be used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Protocol** - refers to the communication protocol (UDP by default) that will be used to access the syslog server.
* **Port Number** - refers to the port number (Port 514 by default) that will be used to access the syslog server being added.

{% hint style="warning" %}
**Important:** Do not attempt to create a syslog server on the same gateway with the same port number. You will encounter a duplicate error.
{% endhint %}

6. Verify if the system was added to the Central Syslog Servers actions panel page and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252FGx0Q4OSu3wOOo5O8ZbQC%252Flog.gif%3Falt=media%26token=55a3b985-c68a-4120-a285-2afac310a988\&width=42\&dpr=4\&quality=100\&sign=c722a48497f25a2090f362f749f70677b04e8ad6a14fbfe2efcbe21458940d70) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

7. Navigate to the main menu and verify if the system was added to the service grid under the **Syslog Central** nod&#x65;**.**

### Monitor Central Syslog Server in IT-Conductor

To view the statuses and logs of all configured syslog servers, locate the **Syslog Central** node in the service grid.

<figure><img src="/files/HycEGI2eTWC4WONzfyHX" alt=""><figcaption><p>Figure 4: Syslog Central View in Service Grid</p></figcaption></figure>

#### Alerts

To show all recently generated syslog alerts in chronological order, click **Alerts,** and a pop-up list of syslog alerts will be displayed.

<figure><img src="/files/VDP4nCu6JSazkvCAWeZq" alt=""><figcaption><p>Figure 5: Syslog Alerts</p></figcaption></figure>

#### Syslog Search

To open the **Syslog Messages Search** page, click **Syslog Search**. Enter query and/or filter any conditions of your liking, and all syslog messages that match the conditions will be listed.

<figure><img src="/files/zr9b6y11gdMSdM7NWuGc" alt=""><figcaption><p>Figure 6: Syslog Messages Search Page</p></figcaption></figure>

You can search by multiple columns, and all unrestricted values support Regex expressions so that relevant messages can be found quickly. While time-search is not supported, sorting by time and filtering by other fields lets you quickly and efficiently locate issues and understand the sequences of events.

#### Monitoring

IT-Conductor makes it easy to monitor specific messages and alerts when they occur. To open a list of defined monitors, click **Monitoring**.

1. You can create new monitors from scratch by clicking on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> icon or from a template by clicking on the ![](/files/km9zxQTQuwYwwmZu1YAb) icon. For this example, we'll create using templates.

<figure><img src="/files/3paZy2sKeeuegffoWEVw" alt=""><figcaption><p>Figure 7: Create a new Syslog Monitor</p></figcaption></figure>

2. Click on one of the pre-made templates.

<figure><img src="/files/8b961X7SenBKdE0ahjby" alt=""><figcaption><p>Figure 8: Syslog Monitoring Templates</p></figcaption></figure>

3. Fill out all the necessary information, including the following:
   * **Name -** refers to the name given for the monitor being added.
   * **Description** - refers to any relevant information about the monitor being added.
   * **Graph Style** - refers to the type of visual display of information (bars, lines).
   * **Priority** - refers to the state in which the monitor will send an alert. The template automatically fills this option.
   * **Facility** - Refers to the object that the override will monitor. The template automatically fills this option.
4. Click on the ![](/files/JFaVDQ1C5adzDpMhMes6) icon to save.

<figure><img src="/files/JXnOHXHYUvMI70NRxgFW" alt=""><figcaption><p>Figure 9: Creating a New Syslog Monitor from a Template</p></figcaption></figure>

5. Navigate to the service grid and verify if the monitor was added under the **Syslog Central** node.

<figure><img src="/files/zvbA0XNbgB87NLNQwIXV" alt=""><figcaption><p>Figure 10: Newly Added Monitor under Syslog Central Node</p></figcaption></figure>

To access a historical view of the monitor's metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line">, and a pop-up chart will be displayed.

<figure><img src="/files/BExVCqnZGszlyhY6NcXh" alt=""><figcaption><p>Figure 11: Syslog Monitor chart</p></figcaption></figure>

In the chart, the data points are interactive, and clicking on them will pop up a list of syslog messages for the interval:

<figure><img src="/files/zjr5cclemSJpAscyrGxq" alt=""><figcaption><p>Figure 12: Syslog Monitor Interval</p></figcaption></figure>

You can navigate intervals back and forth using the **<** and **>** controls.

In the chart, if a <img src="/files/i9wb1hkJXCGxPK7Jn0dG" alt="" data-size="line"> icon shows at the bottom, this indicates that alerts were generated for the interval. Click that icon to view the list of alerts.

The default monitoring overrides are preconfigured, generating an alert for each instance of a matching syslog message. However, more fine-tuned/complex scenarios can be configured as required. The override facility is the same as any other IT-Conductor monitor and can trigger customized alerts or recovery actions.

{% hint style="info" %}
**Note:** See [Creating Threshold Overrides](/user-guide/notifications/threshold-overrides) for more information.
{% endhint %}

#### Notifications

The notification mechanism is the standard [IT-Conductor subscription-based approach](/user-guide/notifications/subscriptions). Individuals or groups of individuals can subscribe to specific monitors, sites, etc., and based on the subscription, the relevant alert will be sent to the configured e-mail addresses or phone numbers.

### Video

{% embed url="<https://youtu.be/cJvZMKqkaRE>" %}


# Frequently Asked Questions

<details>

<summary>1. What is the purpose of central syslog monitoring in IT-Conductor?</summary>

Central syslog monitoring provides an additional layer of visibility by collecting operating system and application log messages from multiple systems into one place. It is typically used to monitor error, warning, and security-related events that may not be covered by standard application or infrastructure monitoring tools.

</details>

<details>

<summary>2. Do we need a dedicated system for central syslog monitoring, or is it enabled on each server?</summary>

The IT-Conductor Gateway acts as the central syslog server (listener). Individual systems (clients) are configured to forward their syslog messages to the gateway. As long as the gateway is reachable, a single gateway can collect logs from multiple systems.

</details>

<details>

<summary>3. Do we need to install any additional software?</summary>

No. No additional software is required. The gateway already includes the syslog listener capability. Client systems only need a configuration change in their syslog daemon to forward messages to the gateway.

</details>

<details>

<summary>4. Do we need to provide OS usernames or passwords for syslog monitoring?</summary>

No. Syslog does not use authentication. Logs are sent by the publishing application (e.g. operating system, database, app server, etc.) directly to the syslog listener using standard syslog protocols. IT-Conductor receives and processes these messages without requiring OS credentials.

</details>

<details>

<summary>5. Which protocol and ports are used for syslog communication?</summary>

Syslog typically uses UDP port 514 by default, though TCP can also be configured if required. UDP is often preferred for performance and lower overhead.

</details>

<details>

<summary>6. Do we need to open port 514 to the internet?</summary>

No. Port 514 only needs to be open inbound on the gateway within the internal network. The gateway listens for syslog messages from internal systems only. Internet exposure is not required and is not recommended.

</details>

<details>

<summary>7. What types of systems and logs can be monitored?</summary>

Any system that supports syslog can send messages, including Linux servers, SAP systems, HANA, and Pacemaker clusters. This includes kernel logs, security events, and cluster-related messages such as failovers or fencing events.

</details>

<details>

<summary>8. Can we filter logs by system, severity, or message type?</summary>

Yes. IT-Conductor allows you to filter syslog messages by source host, severity, message content, and frequency. You can create monitors that trigger alerts only for specific conditions, such as critical cluster or security events.

</details>

<details>

<summary>9. How are syslog alerts handled in IT-Conductor?</summary>

Syslog alerts are treated the same as other IT-Conductor alerts. Once a monitor condition is met, an alert is generated and can follow the same notification and escalation rules as SAP or database alerts.

</details>

<details>

<summary>10. Is syslog monitoring included in our existing IT-Conductor license?</summary>

No. Syslog monitoring is licensed as a separate app because it can generate a large volume of data. Licensing includes a central syslog server subscription and a per-node charge for each sending system.

</details>

<details>

<summary>11. Is there any disk usage on the gateway or client systems?</summary>

No. The syslog server does not store data locally on the gateway. Messages are received and immediately forwarded to the IT-Conductor cloud. Client systems continue using their standard OS logging behavior.

</details>

<details>

<summary>12. Can we test syslog monitoring in QA before using it in Production?</summary>

Yes. You can configure separate central syslog servers for QA and Production, allowing you to validate the setup and filtering rules before enabling it in production.

</details>

<details>

<summary>13. Is there a trial period available?</summary>

Yes. Syslog monitoring is available as a three-month free trial from the date of configuration. Charges apply only if you choose to continue using the service after the trial period.

</details>


# URL Monitoring

URL monitoring plays a critical role in ensuring the availability and performance of web services and applications across different geographic locations. This functionality enables users to specify which URLs to monitor and designate monitoring locations worldwide. It also ensures comprehensive visibility into the accessibility and responsiveness of critical online resources, facilitating proactive maintenance and enhancing user experience.

### Configure URL Monitoring in IT-Conductor

To configure URL monitoring in IT-Conductor, follow the instructions below.

#### Add New URL for Monitoring

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **URL Monitoring Locations** actions panel and click the title to access the complete list.

<figure><img src="/files/lgxIA5LriZxfsLLZpqLi" alt=""><figcaption><p>Figure 1: URL Monitoring Locations Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New URL Monitoring** button to start adding a URL.

<figure><img src="/files/9sHpzaD8ZXsjFCF92ggG" alt=""><figcaption><p>Figure 2: URL Monitoring Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New URL Monitoring** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the URL.

<figure><img src="/files/YNCSGnpPOlGE5XyGBPEy" alt=""><figcaption><p>Figure 3: New URL Monitoring Wizard (New URL Monitoring Location Screen)</p></figcaption></figure>

* **Name** - refers to an identifier for the URL being added.
* **Description** - refers to any relevant information about the URL being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the URL will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Scheme -** specifies the protocol used for the URL (e.g., HTTP or HTTPS).
* **Host** - refers to the host of the URL being added.
* **Port** - refers to the port number used to access the URL being added.
* **Connection Timeout** - refers to the maximum time allowed to establish a connection before timing out. By default, this is set to 300 seconds.
* **Enforce Certificate** - if checked, it determines whether the monitoring should enforce SSL certificate validation for HTTPS URLs.

6. A new URL Monitoring location will be added to the actions panel. The status will remain on **Ready** until an HTTP probe is added.
7. Click on the new URL name, and then click on the <img src="/files/QSlzYc0CinIwLKddQ14d" alt="" data-size="line">**HTTP Probes**. Alternatively, you can click ![](/files/fUFoqKAkqY7trCoqgKCi) and then <img src="/files/QSlzYc0CinIwLKddQ14d" alt="" data-size="line">**Probes.**

<figure><img src="/files/S07Nav2LDYhwLhhBorSA" alt=""><figcaption><p>Figure 4: Newly Added URL Monitoring in the Actions Panel Page</p></figcaption></figure>

8. Click <img src="/files/Pkom6DC8C00Qbyr2tuUL" alt="" data-size="line"> **Create HTTP Probe** to create a new HTTP probe.

<figure><img src="/files/0cSss71UJmP6z86uIvrj" alt=""><figcaption><p>Figure 5: Probes Actions Panel Page</p></figcaption></figure>

9. Fill out all the necessary information in the **Create HTTP Availability Probe** wizard. Once completed, click the **Finish** button to create the probe.

<figure><img src="/files/j2pzEFtoUlMnIOEtlvlL" alt=""><figcaption><p>Figure 6: Create HTTP Availability Probe Wizard</p></figcaption></figure>

* **Name** - refers to a descriptive name for the probe.
* **Description** - refers to any relevant information about the probe being added.
* **Owner** - refers to the user who's adding the new probe.
* **Application** - refers to the name given to the URL in the previous step.
* **Schedule** - sets the frequency or timing for executing the monitoring. You may choose from one of the schedules previously created in IT-Conductor. See [How to Define Operating Schedules](/user-guide/reporting/scheduling-reports#reportscheduling-definingandoperatingschedules) for details.
* **Planned Start Time** - refers to the scheduled start time for the monitoring task.
* **Time Windows Begin** - refers to the beginning of the time window during which the monitoring can be executed.
* **Time Windows End** - refers to the end of the time window during which the monitoring can be executed.
* **Repeat** - specifies that the task should be repeated or executed only once if checked.
* **Repeat Interval** - refers to the time interval between repeated executions of the monitoring task. By default, this is set to 15 minutes.
* **HTTP Method** - determines the HTTP method for the request (Get, Post, Delete, Head, Put).
* **URL** - refers to the URL of the web service or application to be monitored.
* **Preserve Query** - when enabled, this option ensures that the full query string in the specified URL is retained during the probe request.
* **MIME Type** - defines the expected MIME type of the response from the URL.
* **Allowed Status** - specifies the HTTP status codes considered acceptable for a successful response. By default, this is set to 401.
* **Follow Redirect** - determines that the monitoring should follow HTTP redirects if checked.
* **Parse Results** - determines whether to parse and analyze the content of the response.

10. Wait for the HTTP Probe status to turn to **Waiting.**

<figure><img src="/files/OMgFCgQvSlEOHpquhnX8" alt=""><figcaption><p>Figure 7: Newly Added HTTP Probe</p></figcaption></figure>

11. Navigate back to the URL Monitoring Actions Panel Page. The created Monitoring Location should be in the **In-Progress** state.
12. Navigate to the service grid and verify if the URL and probe were added under the **URL Monitoring** node. Alternatively, you can click ![](/files/fUFoqKAkqY7trCoqgKCi) and then <img src="/files/WOH52qv87oq1KFHMAvZV" alt="" data-size="line"> **Grid** to navigate to the URL Monitoring service grid.

<figure><img src="/files/YRcSAacZYTLNFrOx0iaP" alt=""><figcaption><p>Figure 8: Newly Added URL In Progress</p></figcaption></figure>

{% hint style="info" %}
**Note:** Please allow 5-15 minutes for the new URL and probe to show in the service grid.
{% endhint %}

### Monitor URL Locations in IT-Conductor

To view the availability, response time, and status code metrics of a monitored URL, locate the **URL Monitoring** node in the service grid.

<figure><img src="/files/4mj4QKp4nOLXqmO9vHZn" alt=""><figcaption><p>Figure 9: URL Monitoring Node View in the Service Grid</p></figcaption></figure>

#### **URL Monitoring Key Metrics**

* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Missing Account** - refers to the absence of a required user account or resource within the URL location.

#### **HTTP Probe Key Metrics**

* **Availability** - refers to the operational state and accessibility of the HTTP probe.
* **Response Time** - refers to the duration (in msec) taken for the webserver to respond to the request.
* **Status Code** - indicates the HTTP status code returned by the server, providing information on the success or failure of the request.

{% hint style="info" %}
**Note:** All metrics will not show data when the URL is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/92bKTOoHg3S8OJ5GoZ6c" alt=""><figcaption><p>Figure 10: Availability Chart in Service Grid</p></figcaption></figure>

### Video

{% embed url="<https://youtu.be/FqkOkV7ARXY?si=ejAKBZIA4Vx_PKhR>" %}


# TCP/IP Probe-based Monitoring

TCP/IP probe-based monitoring has become essential for maintaining reliable, high-performing application environments in today's complex IT landscapes. This monitoring approach works by actively sending test packets (probes) to network endpoints and services to verify connectivity, measure response times, and detect failures in real-time.

The importance of this monitoring strategy stems from several critical factors. Modern applications are increasingly distributed across hybrid cloud environments, microservices architectures, and global networks, making passive observation insufficient. TCP/IP probes provide proactive verification that services are not just running, but actually reachable and responsive from the user's perspective.

IT-Conductor TCP/IP Probes are organized into “Servers” that are defined to run on selected Gateways. When configured, the probes associated with the Server are executed by attempting to establish a TCP/IP connection from the Gateway host to the probe target host/port. The availability and connection time metrics are collected and monitored.

### Configure TCP/IP Probes in IT-Conductor <a href="#how-to-configure-tcp-ip-probes-in-it-conductor" id="how-to-configure-tcp-ip-probes-in-it-conductor"></a>

To configure TCP/IP probe monitoring in IT-Conductor, follow the instructions below.

#### Add New TCP/IP Probe <a href="#add-new-tcp-ip-probe" id="add-new-tcp-ip-probe"></a>

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the TCP Probe Servers actions panel and click the title to access the complete list.

<figure><img src="/files/duKgQe1IlZGjPcaIA4gD" alt=""><figcaption><p>Figure 1: TCP Probe Servers Panel in the Administrator's Dashboard</p></figcaption></figure>

4. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create a new Server Probe

<figure><img src="/files/7cpU9YglGaVSSfOQimrm" alt=""><figcaption><p>Figure 2: Add a new TCP Probe Servers</p></figcaption></figure>

5. Fill out all the necessary information in the **Create TCP/IP Probe Server** wizard.

<figure><img src="/files/NCnS11MTQcCtP6xB7N7j" alt=""><figcaption><p>Figure 3: Create TCP/IP Probe Server wizard</p></figcaption></figure>

* **Description** - refers to any relevant information about the server probe being added.
* **Organization (Optional)** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Owner** - refers to the owner of the server probe that’s being created. It automatically takes the username of the person in charge of the configuration.
* **Role -** refers to the environment where the server probe will be used.
* **Site (Optional)** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Shared account** - if checked, it uses a centrally stored credential set so multiple probes or monitors can reuse the same connection account instead of defining one locally.
* **Network interface -** refers to the local adapter/IP on the monitoring host, which is used to initiate the probe’s network connection.
* **Connect timeout** - The maximum time the probe waits for a TCP connection to be established before marking the check as failed. By default, it is set to 2000 ms.

6. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save. After a few minutes, the new server probe will show up on the list.

<figure><img src="/files/01ndMH2rRjZkHaVzzcw4" alt=""><figcaption><p>Figure 4: New TCP/IP Probe Servers</p></figcaption></figure>

7. To administer the new probe, click on the grid icon <img src="/files/WOH52qv87oq1KFHMAvZV" alt="" data-size="line">. This will redirect you to the grid location of the probe server.
8. Click **Probes.**

<figure><img src="/files/2p3P3eS4CtpzwZdhF5s0" alt=""><figcaption><p>Figure 5: Probe Server View in the Service Grid</p></figcaption></figure>

9. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create a new probe.

<figure><img src="/files/hal5iDcs9SoVtLIIo98Q" alt=""><figcaption><p>Figure 6: Create a new TCP/IP Port Probe</p></figcaption></figure>

10. Fill out all the necessary information in the **Create TCP/IP Port Probe** wizard.

* **Name** - refers to an identifier for the probe being added.
* **Description** - refers to any relevant information about the probe being added.
* **Owner** - refers to the owner of the server probe that’s being created. It automatically takes the username of the person in charge of the configuration.
* **Schedule (optional)** - refers to the assign scheduled. For probe schedules, please use the options below.
* **Time Windows Begin** - defines the start of the allowed time range for probe execution (Optional if you’re already assigning a schedule to the probe). Click on the clock icon to select a start time.
* **Time Windows End** - defines the end of the allowed time range for probe execution (Optional if you’re already assigning a schedule to the probe). Click on the clock icon to select an end time.
* **Repeat interval** - refers to the interval between consecutive executions when repeat is enabled. By default, this is set to 5 minutes.
* **Host** - refers to the host of the probe being added.
* **Port** - refers to the port number used to access the probe being added.
* **Timeout** - refers to the maximum time allowed to establish a connection before timing out. By default, this is set to 5000 msecs.
* **Actual host** - refers to the resolved hostname the probe ultimately connected to.
* **Actual IPv4** - refers to the final IPv4 address used for the connection after DNS resolution.

<figure><img src="/files/7sqK8iVaKFikCtRNfOvM" alt=""><figcaption><p>Figure 7: Create TCP/IP Port Probe Wizard</p></figcaption></figure>

11. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save.

The probe will be automatically added to the probe server grid.

<figure><img src="/files/CO4ag8h0oOaKgEfMD68c" alt=""><figcaption><p>Figure 8: TCP/IP Port Probe in the Service Grid</p></figcaption></figure>

### Monitor Server Probes in IT-Conductor <a href="#monitor-server-probes-in-it-conductor" id="monitor-server-probes-in-it-conductor"></a>

The availability monitor is created automatically when the probe is added. Expand the chart to view the metric in more detail and define or adjust the override for more specific probe monitoring.

<figure><img src="/files/bOmTfahrzytqp7iLob9W" alt=""><figcaption><p>Figure 9: Availability Metric of a TCP/IP Probe</p></figcaption></figure>

<figure><img src="/files/vk04F5V8gXjUwNsx3QuH" alt=""><figcaption><p>Figure 10: Threshold Overrides and Alerts</p></figcaption></figure>

When the availability threshold is breached, alerts are generated automatically. To learn more about configuring overrides and alerts in IT-Conductor, check our [Threshold Overrides](https://docs.itconductor.com/user-guide/notifications/threshold-overrides) and [Alerts ](https://docs.itconductor.com/user-guide/notifications/alerts#configure-alerts-in-it-conductor)wiki. To notify specific people or teams, add [subscriptions ](https://docs.itconductor.com/user-guide/notifications/subscriptions)at the appropriate level.


# Cloud Monitoring


# AWS Monitoring

Amazon Web Services (AWS) is a cloud computing platform that provides extensive services, including computing power, storage options, machine learning capabilities, and Internet of Things (IoT) services. AWS enables organizations to build, deploy, and manage applications through Amazon's global network of data centers, providing unmatched flexibility, scalability, and security to meet diverse IT and development needs.

To ensure optimal performance and reliability of cloud-based applications, monitoring AWS resources is vital. IT-Conductor provides an all-in-one solution that simplifies monitoring the availability and performance of AWS resources, enhancing operational efficiency.

### Configure AWS for Monitoring

1. Navigate to **Dashboards → Administration**.

<figure><img src="/files/XluXKKSyNvZqbPiARcB0" alt=""><figcaption><p>Figure 1: Administrator Menu Option in IT-Conductor</p></figcaption></figure>

2. Click **AWS Regions.**

<figure><img src="/files/QnJTpcQgnQMtWjJNle61" alt=""><figcaption><p>Figure 2: AWS Regions Panel in IT-Conductor</p></figcaption></figure>

3. Click the **"+"** or the **"Create New AWS Region"** icon.

<figure><img src="/files/RBJRQIblp5X1CDo7yZNF" alt=""><figcaption><p>Figure 3: Creating New AWS Region in IT-Conductor</p></figcaption></figure>

4. Input the following information in the New AWS Region Wizard.

* **Description** - refers to the short description of the AWS region to be created.
* **Organization -** represents the customer in a [Managed Service Providers (MSPs) setup](/user-guide/setup/msp-tenant-setup). Select "NONE" if not applicable.
* **Role** - refers to the system roles such as "Development", "Quality Assurance", "Production", etc.
* **Site** - refers to the organizationally separated environments within an organization, allowing for separate monitoring and notification policies.
* **Gateway** - refers to the configured and working IT-Conductor Gateway.
* **Region -** refers to the region of the AWS instances.
* **Account** - refers to the AWS IAM user.

<figure><img src="/files/HBthbL2HO4vg13rWtEx5" alt=""><figcaption><p>Figure 4a: New AWS Region Wizard in IT-Conductor</p></figcaption></figure>

5. Click the **"+"** or the **"Create new Amazon Web Services"** icon to proceed and input the following information:

* **Description -** refers to the short description of the user.
* **Application** - refers to the name of the AWS region.
* **Person** - refers to the owner or contact person of the account.
* **Access Key** - refers to the access key associated with the AWS IAM Account.
* **Secret Key** - refers to the secret key associated with the AWS IAM Account.

<figure><img src="/files/bv1Y8RanxOlcNrBfCJ7q" alt=""><figcaption><p>Figure 4b: New AWS Region Wizard in IT-Conductor</p></figcaption></figure>

6. Click the **"+"** or the **"Create new AWS API Account"** icon to start setting up the AWS instance. This may take a few minutes to complete.

{% hint style="info" %}
**Note:** For new customers, please refer to the [IT-Conductor Gateway Setup for AWS](/user-guide/setup/gateway-setup/aws) when setting up IT-Conductor Gateway. For existing customers, setting up a new one is optional.
{% endhint %}

### Related Information

* [IT-Conductor AWS Monitoring, Management & Automation](https://www.itconductor.com/aws-monitoring-management-automation)
* [IT-Conductor Achieves AWS Migration & Modernization Competency Status](https://www.itconductor.com/blog/it-conductor-achieves-aws-migration-and-modernization-competency-status)


# Microsoft Azure Monitoring

Microsoft Azure is a cloud computing platform and service that provides a wide range of solutions, such as virtual machines, databases, AI and machine learning tools, and IoT services. Azure allows organizations to build, deploy, and manage applications through Microsoft-managed data centers, offering flexibility, scalability, and security for various IT and development needs.

Monitoring Azure resources helps maintain the optimal performance and reliability of cloud-based applications and services. IT-Conductor provides an out-of-the-box solution to monitor the availability and performance of Azure resources.

### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

Before configuring an Azure resource for monitoring in IT-Conductor, register IT-Conductor in Azure subscription by following the steps below.

#### Register IT-Conductor as an App in Azure Subscription

1. Visit [Azure Portal](https://portal.azure.com/) and enter your login credentials.
2. On the left panel, navigate to **Microsoft Entra ID** **→ Tenant Properties**.
3. Copy and note the **Tenant ID**: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

<figure><img src="/files/FVtwCs9i8bARN8SXNT6f" alt=""><figcaption><p>Figure 1: Tenant Properties in Azure Portal</p></figcaption></figure>

4. Search **App Registrations** on the search bar and click on **New Registration**.

<figure><img src="/files/8jvo4MJ4grsXYIBTaNZ4" alt=""><figcaption><p>Figure 2: App Registrations in Azure Portal</p></figcaption></figure>

5. Fill out all the necessary information as shown in Figures 3a and 3b. Once completed, click **Register** to add the system.

<figure><img src="/files/kNnsRVDElOn67CA6CVWO" alt=""><figcaption><p>Figure 3a: Register an Application in Azure Portal</p></figcaption></figure>

* **Name -** refers to the name of the application that will be added (i.e., IT-Conductor)
* **Supported Account Types** - determines who will have access to the application. Select one of the options that best suits your organization's needs.

<figure><img src="/files/soFN2rxqZs6KywdUmOfo" alt=""><figcaption><p>Figure 3b: Register an Application in Azure Portal</p></figcaption></figure>

* **Redirect URL (Optional) -** add a URL value to authenticate upon accessing the application.

6. On the newly created app, copy and note the IT-Conductor **Application (client) ID.**

<figure><img src="/files/tKTRWdBaIP0dumCHBAIQ" alt=""><figcaption><p>Figure 4: Application Properties in Azure Portal</p></figcaption></figure>

7. Navigate to **Certificates & Secrets** and select the **Client Secrets** ta&#x62;**.** Then click **New Client Secret.**

<figure><img src="/files/55JYHO07LXKIhKHa3Hg1" alt=""><figcaption><p>Figure 5: Client Secrets in Azure Portal</p></figcaption></figure>

8. Fill out all the necessary information in the **Add a Client Secret** screen. Once completed, click **Add** to add the system.

<figure><img src="/files/i81dwgKZgxq3hZ1UXdUq" alt=""><figcaption><p>Figure 6: Add a Client Secret in Azure Portal</p></figcaption></figure>

* **Description** - refers to any relevant information about the secret password.
* **Expires** - refers to the expiration date for the secret password.

9. Copy and note the **Value** and **Secret ID** for the newly created secret.

<figure><img src="/files/nyOTsnGP8aRygTEPQ8OW" alt=""><figcaption><p>Figure 7: Value and Secret ID of Newly Created Secret in Azure Portal</p></figcaption></figure>

{% hint style="warning" %}
**Important:** Copy the value immediately; otherwise, it will show as encrypted when accessed later.
{% endhint %}

10. Navigate to **All Services -> Subscriptions.** Click on any of the existing subscriptions. Copy and note the **Subscription ID**: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

<figure><img src="/files/VCoBIRJot36BxaHRUGCR" alt=""><figcaption><p>Figure 8: All Services in Azure Portal</p></figcaption></figure>

{% hint style="info" %}
**Note:** If you don't have any subscriptions, you must create one.
{% endhint %}

11. On the selected subscription's side menu, navigate to **Access Control (IAM) -> Role Assignments -> Add -> Role Assignments.**

<figure><img src="/files/PzXuldbCN8K3ujhXJJrY" alt=""><figcaption><p>Figure 9: Role Assignments in Azure Portal</p></figcaption></figure>

12. Navigate to the **Role** tab and add the required roles for Azure Monitoring in IT-Conductor.

* **Virtual Machine Contributor** - gives rights to read, start/stop, etc. for VMs.
* **Monitoring Reader** - gives access to monitoring data.

13. Navigate to the **Members** tab and select **Azure AD User/User, Group, or Service Principal** in the **Assign Access To** field. Then click **Select Members** and select the previously created **IT-Conductor** app in the **Members** field.

<figure><img src="/files/V3UMSOtgTdcZ9JpqwL8C" alt=""><figcaption><p>Figure 10: Add Role Assignment in Azure Portal</p></figcaption></figure>

{% hint style="info" %}
**Note:**

* IT-Conductor won't appear in the list of users initially. You have to type in the Select field before it does.
* Additional roles may be required as we progress the development of features for IT-Conductor.
  {% endhint %}

### Configure Azure Monitoring in IT-Conductor

To configure Azure monitoring in IT-Conductor, follow the instructions below.

#### Add a New Azure Connection in IT-Conductor

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Azure Tenants** actions panel and click the title to access the complete list.

<figure><img src="/files/yY7ZuJ3qALmQvKtmCnTz" alt=""><figcaption><p>Figure 11: Administrator's Dashboard in IT-Conductor</p></figcaption></figure>

4. Click the **New Azure Tenant** button to create a new connection.

<figure><img src="/files/l1S8r7KlfsG9APNaIOyu" alt=""><figcaption><p>Figure 12: Azure Tenant Actions Panel Page</p></figcaption></figure>

5. Fill in the following fields and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

   <figure><img src="/files/CbWQi2IQwgcCumL2zKiw" alt=""><figcaption><p>Figure 13a: New Azure Tenant Wizard (New Azure Tenant Screen)</p></figcaption></figure>

   * **Name -** refers to a descriptive name for the new Azure connection.
   * **Description** - refers to any relevant information about the system being added.
   * **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
   * **Role -** refers to the environment where the system will be used.
   * **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
   * **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
   * **Tenant ID** - refers to the alphanumeric code copied from the **Tenant ID** in Azure Portal. See [Pre-requisites](#prerequisites) for more details.
   * **Subscription ID** - refers to the alphanumeric code copied from the **Subscription ID** in Azure Portal. See [Pre-requisites](#prerequisites) for more details.
6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/3lDJIf1Jeh8EwZv5x2L2" alt=""><figcaption><p>Figure 13b: New Azure Tenant Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the Azure connection added.
* **Person** - refers to the name of the user who is adding the connection.
* **Client ID -** refers to the alphanumeric code copied from the Client Secret's **Secret ID** in Azure Portal. See [Pre-requisites](#prerequisites) for more details.
* **Client Key -** refers to the alphanumeric code copied from the Client Secret's **Value** in Azure Portal. See [Pre-requisites](#prerequisites) for more details.

7. Verify if the Azure connection was added to the **Azure Tenants** actions panel and check its status.

<figure><img src="/files/bghWqiYguraEjBJItiyL" alt=""><figcaption><p>Figure 14: Newly Added Azure Connection in Azure Tenant Actions Panel Page</p></figcaption></figure>

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **Azure Tenants** node.

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor Azure Resources in IT-Conductor <a href="#monitor-unix-linux-system-in-it-conductor" id="monitor-unix-linux-system-in-it-conductor"></a>

To view the availability and performance metrics of an Azure resource, locate the **Azure Tenant** node in the service grid.

<figure><img src="/files/AM9mktpRD0dQszDibTp6" alt=""><figcaption><p>Figure 15: Azure Resources in Service Grid</p></figcaption></figure>

**Azure Tenant Key Metrics**

* **Availability** - refers to the operational state and accessibility of the Azure Tenant.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the Azure Tenant.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the Azure Tenant.

To view more information about the Azure resource, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line">.

<figure><img src="/files/FiiZPs6mUnQzLAg20X0C" alt=""><figcaption><p>Figure 16: Azure Resource Information View in Service Grid</p></figcaption></figure>

To view the available automation actions, click <img src="/files/CFY4hc7DOkvhPP85GFYR" alt="" data-size="line">.

<figure><img src="/files/K3krGCDIco6B0bYPNda4" alt=""><figcaption><p>Figure 17: Azure Resource Group Actions Menu in Service Grid</p></figcaption></figure>

To view the status of each action executed, click Commands and you will be redirected to the **Resource Batch Commands** page.

<figure><img src="/files/HFsCEB5Ovehgwp8e89sT" alt=""><figcaption><p>Figure 18: Resource Batch Commands Actions Panel Page</p></figcaption></figure>

{% hint style="info" %}
**Note:** The Start/Stop/Deallocate actions can be automated in several ways: On-demand, Scheduled, Process Integration, or Recovery Actions.
{% endhint %}


# Database Monitoring


# IBM DB2 Database Monitoring

IBM DB2 is a robust relational database management system designed to handle large volumes of data with high performance and reliability. It supports various workloads, from transactional processing to analytics, making it a versatile solution for organizations across industries. With advanced features like data compression and workload management, IBM DB2 is trusted to handle mission-critical applications.

Monitoring IBM DB2 enables database administrators to maintain optimal performance by tracking key metrics such as lock waits, timeouts, and resource utilization. This facilitates the prevention of potential issues before they escalate, reducing downtime and improving overall stability.

{% hint style="info" %}
**Note:** IBM DB2 metric collection is integrated with SAP systems and falls under the scope of [SAP Monitoring](/user-guide/monitoring/sap). This ensures seamless integration and alignment with SAP performance management, covering DB2 health, resource utilization, and operational efficiency.
{% endhint %}

### Monitor IBM DB2 Database in IT-Conductor

To view the availability and performance metrics of an IBM DB2 database, locate and expand the **SAP systems** node until you find the **DB2 Universal Database** node in the service grid.

<figure><img src="/files/gKwIeVmQhRuG9fbeecYK" alt=""><figcaption><p>Figure 1: DB2 Universal Database Node View in Service Grid</p></figcaption></figure>

#### IBM DB2 Database Key Metrics

* **Overall Buffer Quality** - refers to the effectiveness of the buffer pool in reducing disk I/O by keeping frequently accessed data in memory.
* **Catalog Cache Quality** - refers to the efficiency of the catalog cache, which stores metadata about database objects like tables and indexes.
* **Deadlocks** - occur when two or more transactions are waiting on each other to release locks, resulting in a standoff where none can proceed. When a deadlock is detected, one of the transactions must be rolled back to resolve the issue.
* **Exclusive Lock Escalations** - occur when a large number of row-level locks held by a transaction are escalated to a table-level exclusive lock.
* **Lock Escalations** - refer to the process of converting multiple fine-grained locks into a higher-level lock to conserve system resources.
* **Lock Timeouts** - occur when a transaction waits for a lock for too long and is forced to stop waiting.
* **Package Cache Quality** - refers to the effectiveness of the package cache in reducing the need for recompilation and improving query performance by storing frequently executed SQL statements.
* **Backup Errors** - refer to any issues that occur during the process of backing up the database.

{% hint style="info" %}
**Note:** All metrics will not show data when a server is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/lrZYlA5yhyZoCHyk9V1u" alt=""><figcaption><p>Figure 2: Overall Buffer Quality Chart in Service Grid</p></figcaption></figure>

#### Tablespaces

To view the Tablespaces metrics, expand the **Tablespaces** node and locate the specific tablespace.

* Click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> to view the historical chart for **Used Space** and **Status**.
* Click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line"> to view the tablespace attributes.

<figure><img src="/files/TJYcskqg6ld6wFUZEayH" alt=""><figcaption><p>Figure 3: Tablespaces Node View in Service Grid</p></figcaption></figure>

To view an overview chart of the used space of all tablespaces, click **Used Space Overview**.

<figure><img src="/files/eFGtddIwvCUS9WRjr338" alt=""><figcaption><p>Figure 4: Used Space Overview Chart</p></figcaption></figure>

#### Server Metrics

To view the server metrics where the database is hosted, locate and expand the server node.

<figure><img src="/files/91mINehjyxIk2SkhMLyM" alt=""><figcaption><p>Figure 5: Server Node in Service Grid</p></figcaption></figure>

See [OS Monitoring](/user-guide/monitoring/infrastructure/os) for more details.


# Microsoft SQL Server Monitoring

Microsoft SQL (MSSQL) server is a relational database management system that efficiently stores, retrieves, and manages data. It is widely used across industries for its scalability and integration capabilities. It often serves as the backend database for enterprise applications such as SAP, where it plays a crucial role in handling vast amounts of business data and supporting mission-critical processes.

Monitoring the MSSQL server helps analyze the database server's usage, performance, and metrics to optimize application performance. Getting historical data is critical to measuring and analyzing performance trends to take quick actions and perform database tuning to improve operations.

### Prerequisites

Before configuring a Microsoft SQL server for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new MSSQL monitoring account.
2. Grant the user the "sysadmin" role.

If you are unable to grant "sysadmin" permissions to the account, please grant the following permissions:

* Member of the "db\_datareader" role on the msdb system database
* Member of "SQLAgentReader" role on the msdb system database
* "VIEW ANY DEFINITION" server permission
* "ALTER TRACE" server permission (if you want to enable trace data)
* "VIEW SERVER STATE" and "VIEW DATABASE STATE" database permissions on all databases
* Member of the "db\_owner" role on the "tempdb" database
* "EXECUTE" on xp\_readerrorlog

{% hint style="info" %}
**Note:**

* Perform these steps on the MSSQL server.
* Access to additional commands may be required if a custom configuration is involved.
  {% endhint %}

### Configure Microsoft SQL Server Monitoring in IT-Conductor <a href="#configure-mssql-server-monitoring-in-itconductor" id="configure-mssql-server-monitoring-in-itconductor"></a>

To configure Microsoft SQL server monitoring in IT-Conductor, follow the instructions below.

#### Add New Microsoft SQL Server

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Microsoft SQL Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/f0goJcjngm5xrhJgWLvn" alt=""><figcaption><p>Figure 1: Microsoft SQL Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New SQL Server** button to start adding a new server for monitoring.

<figure><img src="/files/JOR2D8gk2BszOOqMac1Y" alt=""><figcaption><p>Figure 2: SQL Servers Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New SQL Server** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the server.

<figure><img src="/files/9sxWKbofyfJvvdepwV3t" alt=""><figcaption><p>Figure 3a: New SQL Server Wizard (New SQL Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the server being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the server will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Host** - refers to the computer or server where the MSSQL Server instance is running.
* **Port** - refers to the port number through which the server communicates with IT-Conductor. This is typically set to 1433.
* **Encrypt** - enables encryption of data exchanged between the server and IT-Conductor.
* **SSL Protocol** - specifies the version of the SSL protocol used to secure the connection between the server and IT-Conductor.
* **Trust Certificate** - enables establishing a trust or secure connection between the server and IT-Conductor.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/CImAhOQXgx1xfzY7zFlF" alt=""><figcaption><p>Figure 3b: New SQL Server Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the server being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Re-type Password** - refers to the same password provided in the **Password** field.

7\. Verify if the system was added to the **Microsoft SQL Servers** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8\. Navigate to the service grid and verify if the system was added under the **SQL Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor **Microsoft SQL Server in IT-Conductor**

To view the availability and performance metrics of a SQL server, locate the **SQL Servers** node in the service grid.

<figure><img src="/files/12McVGieXKgvCgJJDNVN" alt=""><figcaption><p>Figure 4: SQL Servers View in Service Grid</p></figcaption></figure>

#### **Microsoft SQL Server Key Metrics**

* **Availability** - refers to the operational state and accessibility of the SQL server.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of server downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the SQL server.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the SQL server.

{% hint style="info" %}
**Note:** All metrics will not show data when a server is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/sLz2u36z5GBNEP0XMDJN" alt=""><figcaption><p>Figure 5: Availability Chart in Service Grid</p></figcaption></figure>

#### **Agent**

To check whether the MSSQL Agent is enabled or disabled, expand the **Agent** node.

![Figure 6: Agent Jobs View in Service Grid](/files/DECrDxxYBBMtfNUumCiO)

You may receive notifications for failed jobs to avoid missing backups or critical tasks and identify which step failed.

#### **Backup**

To identify backup files that may contain errors, expand the **Backup** node and locate the **Errors** node.

![Figure 7: Backup View in Service Grid](/files/6zirEwjLsuNDANJCahqx)

These errors are primarily due to a problem with the database while the backup is running.

#### **Databases**

To view the status and active connections of each database, expand the **Databases** node. You may further expand the **DB Files** node to view the used spaces and statuses of the database files.

<figure><img src="/files/eynHo06U556ncR6PspsC" alt=""><figcaption><p>Figure 8: Databases View in Service Grid</p></figcaption></figure>

#### **Error Log**

To view the error logs in the SQL server, expand the **Error Log** node. Then click the **Errors** node. You will be redirected to the Error Log Explorer, as shown in Figure 9. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to further examine the error logs in detail.

<figure><img src="/files/8xvzYG2prqOn7kV9XdnB" alt=""><figcaption><p>Figure 9: SQL Server Error Log Explorer</p></figcaption></figure>

#### **Linked Servers**

To view the status of the linked server, expand the **Linked Server** node. Then click on the arrow to see the individual **Availability** statuses of the linked servers.

![Figure 10: Linked Servers View in Service Grid](/files/Ynn48xN0WBLJ7KXPiXH6)

#### **System Performance**

To view real-time metrics regarding the system performance of the MSSQL server, expand the **System Performance** node.

<figure><img src="/files/p54kALkoZbfvM80FHNJl" alt=""><figcaption><p>Figure 11: System Performance View in Service Grid</p></figcaption></figure>

* **Active Transactions** - refers to the number of transactions currently being processed by the SQL server. Monitoring this metric helps administrators understand the workload on the server and identify potential bottlenecks.
* **Batch Requests Rate** - indicates the rate at which the SQL Server processes batch requests. It reflects the server's overall workload and helps assess its performance.
* **Free Memory** - represents the available memory on the SQL Server that is not currently being used. Monitoring free memory helps optimize server performance and identify memory-related issues.
* **Lock Timeouts** - occur when a transaction attempts to acquire a lock on a resource but cannot do so within a specified time period. Monitoring lock timeouts helps identify contention issues and optimize database performance.
* **Lock Wait Time** - measures the amount of time a transaction spends waiting for another transaction to release a lock. Monitoring lock wait time helps identify potential performance bottlenecks and optimize query execution.
* **Log Cache Hit Ratio** - measures the efficiency of the SQL Server's transaction log cache by indicating the percentage of log records found in the cache. A high hit ratio indicates efficient cache usage.
* **Log Used** - represents the percentage of the transaction log that is currently being used. Monitoring log usage helps manage log file growth and ensure sufficient transaction logging space.
* **Processes Blocked** - indicates the number of processes currently blocked by other processes and unable to proceed. Monitoring this metric helps identify and resolve blocking issues impacting database performance.
* **SQL Compilations** - refer to the number of times SQL Server compiles a Transact-SQL statement into an execution plan. Monitoring SQL compilations helps optimize query performance and identify inefficient queries.
* **SQL Re-Compilations** - indicates the number of times SQL Server recompiles a previously compiled execution plan. Monitoring re-compilations helps identify query performance issues and optimize query execution.
* **Update Conflict Ratio** - measures the percentage of update operations that encounter conflicts, such as deadlock or blocking. Monitoring this metric helps identify and resolve concurrency issues in the database.
* **User Connections** - represent the number of user connections established with the SQL Server. Monitoring user connections helps manage server resources and ensure optimal performance for connected users.
* **SQL Statement Elapsed Time** - measures the total time to execute an SQL statement, including parsing, compilation, execution, and fetching results. Monitoring statement elapsed time helps identify performance-intensive queries and optimize their execution.

### Video

{% embed url="<https://youtu.be/cZ-yO1HpsAU?si=W2x2x-evlenmdt0H>" %}


# Oracle Database Monitoring

Oracle Database is a database management system developed by Oracle Corporation. It provides high performance, scalability, and security for enterprise-level data management. Oracle supports a wide range of applications, from transactional processing to data warehousing, ensuring reliable and efficient data handling.

Monitoring the Oracle database helps maintain its performance, reliability, and security by providing real-time insights into database activities and resource utilization. IT-Conductor helps track its performance based on the collected metrics, alerts, availability, and overall system health.

### Prerequisites

Before configuring an Oracle database for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new Oracle monitoring account.
2. Grant the user the "CREATE SESSION" and "OEM\_MONITOR" roles and the "SELECT ON V$DIAG\_ALERT\_EXT" privileges.

{% hint style="info" %}
**Note:**

* Perform these steps on the Oracle database.
* Automation users may have varying requirements based on the nature of the automation activities.
  {% endhint %}

### Configure Oracle Database Monitoring in IT-Conductor

To configure Oracle database monitoring in IT-Conductor, follow the instructions below.

#### Add New Oracle Instance

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Oracle Instances** actions panel and click the title to access the complete list.

<figure><img src="/files/Qe9iVIXiw7gYZ9uVDBYl" alt=""><figcaption><p>Figure 1: Oracle Instances Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New Oracle Instance** button to start adding a new instance for monitoring.

<figure><img src="/files/7d7RwzVns146smmaAogG" alt=""><figcaption><p>Figure 2: Oracle Instances Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New Oracle Instance** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the instance.

<figure><img src="/files/oK2tm73FNcaipt1rve3b" alt=""><figcaption><p>Figure 3a: New Oracle Instance Wizard (New Oracle Instance Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the instance being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the database will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Instance Host** - refers to the server or system where the database instance runs.
* **Instance Port** - refers to the port number through which the server communicates with IT-Conductor. This is typically set to 1521.
* **Read Timeout** - refers to the duration for which a connection or operation will wait for a response before timing out.
* **TimeZone as Region** - enables synchronization of date-and-time-related functions and operations within the database with the IT-Conductor timezone.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/nwBBzzkiSv6vnB7SRTmq" alt=""><figcaption><p>Figure 3b: New Oracle Instance Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the instance being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **User Password** - refers to the password of the previously created user.
* **Re-type Password** - refers to the same password provided in the **Password** field.

![Figure 4: Oracle Instance Account Information](/files/aFiN7caAqnfnJCJbQAKh)

7. Verify if the system was added to the **Oracle Instances** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **Oracle Databases** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### **Monitor Oracle Database in IT-Conductor**

To view the availability and performance metrics of an Oracle database, locate the **Oracle Databases** node in the service grid.

<figure><img src="/files/hnYFnLYcyDvTSUn80rom" alt=""><figcaption><p>Figure 5: Oracle Databases View in Service Grid</p></figcaption></figure>

#### Oracle Database Key Metrics

* **Availability** - refers to the operational state and accessibility of the Oracle database.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of server downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the Oracle database.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the Oracle database.

{% hint style="info" %}
**Note:** All metrics will not show data when a server is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line">and a pop-up chart will be displayed.

<figure><img src="/files/QEqAu284BFrwF2iNkYAk" alt=""><figcaption><p>Figure 6: Oracle Database Heartbeat Chart in Service Grid</p></figcaption></figure>

#### Alerts

To display the active alerts generated by a specific database, expand the **Alerts** node by clicking <img src="/files/lmWNoNHAlYyGAcGpOP3L" alt="" data-size="line">.

<figure><img src="/files/dBGNoNumUUHygvwidMEL" alt=""><figcaption><p>Figure 7: Oracle Database Alerts in Service Grid</p></figcaption></figure>

Alternatively, click **Alerts**, and you will be redirected to a page, as shown in Figure 8.

<figure><img src="/files/jUZduV0UFWB9wzdlxQoS" alt=""><figcaption><p>Figure 8: Alerts Node View in Service Grid</p></figcaption></figure>

{% hint style="info" %}
**Note:** The same navigation principles apply to other metrics.
{% endhint %}

#### Performance

To view the performance metrics of a specific database, expand or click the **Performance** node.

<figure><img src="/files/gauOomRtRui7nK6emy3m" alt=""><figcaption><p>Figure 9: Oracle Database Performance Node View in Service Grid</p></figcaption></figure>

* **Top 5 Objects By Wait** - refers to the top five database objects that contribute the most to wait events, helping administrators pinpoint performance bottlenecks and prioritize optimization efforts.
* **Top 5 SQL Statements** - refers to the top five SQL statements that consume the most resources or cause the highest wait times, enabling administrators to optimize query performance and improve overall database efficiency.
* **Buffer Cache Hit Ratio** - refers to the percentage of requests for data that are satisfied by blocks already in the buffer cache. A higher ratio indicates efficient memory use and reduced disk I/O, while a lower ratio may suggest memory pressure or inefficient cache usage.
* **Dictionary Cache Hit Ratio** - refers to the percentage of requests for data dictionary information that are satisfied by blocks in the dictionary cache. A high ratio indicates efficient access to dictionary data, while a low ratio may indicate contention or inadequate cache size.
* **Disk Sort Memory Ratio** - refers to the ratio of memory used for disk sorting operations compared to the total memory available. A high ratio suggests excessive disk sorting, which impacts performance due to increased I/O operations.
* **Dispatcher Workload Busy Ratio** - refers to the percentage of time dispatchers spend processing client requests. Monitoring this ratio helps assess dispatcher workload and resource utilization.
* **Latch Hit Ratio** - refers to the percentage of latch requests that are satisfied without waiting. A high ratio indicates efficient latch usage, while a low ratio may suggest latch contention or resource contention.
* **Library Cache Hit Ratio** - refers to the percentage of SQL statements found in the library cache, avoiding the need for hard parsing. A high ratio indicates efficient reuse of SQL statements and reduced parsing overhead.
* **Log Switches** - refers to the number of times the database switches from one redo log file group to another. Monitoring log switches helps assess database activity and transaction throughput.
* **Rollback Segment Waits Ratio** - refers to the ratio of transactions waiting for rollback segment resources compared to the total number of transactions. A high ratio may indicate contention for rollback segments, potentially impacting database performance.
* **Top Wait Time** - refers to the wait event with the highest cumulative wait time, helping administrators prioritize performance tuning efforts and address critical bottlenecks.
* **Library Cache** - refers to the shared area in the SGA of an Oracle database that stores parsed SQL statements, execution plans, and PL/SQL code.
* **PGA** - stands for Program Global Area; refers to the memory region in an Oracle database that stores data and control information for individual server processes.
* **Resource Limits** - refer to the constraints imposed on database users or profiles to control their usage of system resources such as CPU, memory, and I/O.
* **SGA** - stands for System Global Area; refers to the shared memory region in an Oracle database that contains data and control information for the entire database instance.

#### **Space** <a href="#program-global-area-pga" id="program-global-area-pga"></a>

To view the space usage of a specific database, expand or click the **Space** node.

<figure><img src="/files/QxVMqmrWXEaVQbfoUjwF" alt=""><figcaption><p>Figure 10: Oracle Database Space Node View in Service Grid</p></figcaption></figure>

* **Used Space %** - indicates the percentage of allocated space utilized by the database and its tablespaces.
* **Used Space Total** - indicates the total amount of allocated space utilized by the database.
* **Schemas** - refer to the logical containers for database objects, such as tables, views, and procedures.
* **Tablespaces** - refer to the logical storage containers that hold data files associated with the database objects.

#### Health Explorer <a href="#program-global-area-pga" id="program-global-area-pga"></a>

To view a more detailed analysis of metrics and time-synchronized data of a specific database, click **Health** from the Oracle database node view.

<figure><img src="/files/hSbq2d0M65aFkTxKYORm" alt=""><figcaption><p>Figure 11: Oracle Database Node View in Service Grid</p></figcaption></figure>

You will be redirected to the **Health Explorer** page. From here, you can view one or more synchronized metrics over time, which is helpful when troubleshooting issues.

<figure><img src="/files/J9nq1Dx9Hi0KHHfuNh91" alt=""><figcaption><p>Figure 12a: Oracle Database Health Explorer (Availability)</p></figcaption></figure>

![Figure 12b: Oracle Database Health Explorer (Buffer Cache Hit Ratio)](/files/ZVtlo314nfE3LTzvbBvL)

![Figure 12c: Oracle Database Health Explorer (Top 5 SQL Statements)](/files/9RxsdKp4KJU4SXOl6CfB)

![Figure 12d: Oracle Database Health Explorer (Library Cache Hit Ratio)](/files/8ipmWP0vRuGR9SJVx0jh)

#### **SQL Jobs** <a href="#sql-jobs" id="sql-jobs"></a>

To view all SQL jobs, click **SQL Jobs** from the database node view, and you will be redirected to the SQL Jobs actions panel page. To create a new SQL job, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">.

<figure><img src="/files/Ak3wYGA2Sz8xUV2mg0dr" alt=""><figcaption><p>Figure 13: Oracle Database SQL Jobs Actions Panel Page</p></figcaption></figure>

You will be redirected to the **Create Synchronous SQL Script** configuration page. Fill out all the necessary information, then click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save the script.

<figure><img src="/files/9DLgbma0IOyGu1FONWfq" alt=""><figcaption><p>Figure 14: Create Synchronous SQL Script Configuration Page</p></figcaption></figure>

* **Name** - refers to a descriptive name for the job.
* **Description** - refers to any relevant information about the job being added.
* **Owner** - refers to the user who's adding the new job.
* **Status** - refers to the SQL job status. At this stage of the process, this is set to **Initial.**
* **Work Queue** - specifies the queue or list where the job is managed and processed. This field contains the name of the Oracle Database.
* **Schedule** - sets the frequency or timing for executing the job. You may choose from one of the schedules previously created in IT-Conductor. See [How to Define Operating Schedules](/user-guide/reporting/scheduling-reports#reportscheduling-definingandoperatingschedules) for more details.
* **Planned Start Time** - refers to the scheduled start time for the SQL job.
* **Time Windows Begin** - refers to the beginning of the time window during which the SQL job can be executed.
* **Time Windows End** - refers to the end of the time window during which the SQL job can be executed.
* **Repeat** - if checked, it specifies that the job should be repeated or executed only once.
* **Completion Monitoring** - if checked, it enables tracking and reporting on the completion status of the SQL job.
* **Deliver Log** - if checked, it determines if the log or output of the SQL job should be sent or delivered to specified recipients.
* **SQL** - refers to the SQL query or script to be executed as part of the job.
* **Echo** - if checked, it controls whether the executed SQL query or script is echoed back in the job output.
* **Preserve Formatting** - if checked, it specifies whether it maintains the original formatting of the SQL query or script in the job output.
* **Wrapped** - if checked, it indicates if long lines of SQL output should be wrapped or truncated to fit within specified constraints.
* **Query Timeout** - refers to the maximum duration (in seconds) allowed for the execution of the SQL query before it is terminated. By default, this is set to 180 seconds.

To view all the available SQL jobs actions, click ![](/files/8P0PVQddBEO9LwWgMCwG).

<figure><img src="/files/BNUSARxhszkEnSEypeLl" alt=""><figcaption><p>Figure 15: Oracle Database SQL Jobs Actions Menu</p></figcaption></figure>

To view the execution logs of a specific SQL job, click **Execution Log** from the actions menu.

<figure><img src="/files/BOiDJeUjYeA1wVMGYgNM" alt=""><figcaption><p>Figure 16: Test SQL Execution Log</p></figcaption></figure>

### Video <a href="#itcoracledatabasemonitoring-step-by-stepguide" id="itcoracledatabasemonitoring-step-by-stepguide"></a>

{% embed url="<https://vimeo.com/253681170>" %}


# SAP HANA System Monitoring

SAP High-performance Analytic Appliance (HANA) is an advanced, multi-model database that uses in-memory storage for high-speed data processing and complex analytics within a single platform. By leveraging its column-oriented architecture, SAP HANA can handle large data volumes with minimal latency.

Monitoring an SAP HANA system on IT-Conductor is crucial for ensuring optimal performance, availability, and reliability of your database environment. Effective monitoring involves setting up user roles and authorizations and enabling specific monitoring permissions. IT-Conductor provides real-time performance insights, proactive alerts, and automated health checks, allowing for swift issue resolution and improved operational efficiency.

### Prerequisites

Before configuring an SAP HANA system for monitoring in IT-Conductor, follow the instructions below.

#### SAP HANA Authorizations Requirements

* Create a monitoring user in each HANA database, including SYSTEMDB, that you intend to monitor by executing the following SQL script.

```
CREATE USER <Monitoring user> PASSWORD <Monitoring User Password> no force_first_password_change;
ALTER USER <Monitoring user> DISABLE PASSWORD LIFETIME;
GRANT MONITORING to <Monitoring user>
```

{% hint style="info" %}
**Note:**

* The "no force\_first\_password\_change" option states that the password does not need to be changed when logging in for the first time.
* The "DISABLE PASSWORD LIFETIME" command exempts the user from changing the password according to the "maximum\_password\_lifetime" parameter.
  {% endhint %}

![Figure 1: Sample Monitoring User](/files/AolYC5YdqlBFhI26XznA)

* To verify the user has a lifetime password, run the following script. The result should show an empty 'PASSWORD\_CHANGE\_TIME' value, as shown in the image below.

```
SELECT USER_NAME, PASSWORD_CHANGE_TIME FROM USERS WHERE USER_NAME = '<user>';
```

![Figure 2: Sample NULL Result](/files/iQ4ToVVFVg8GENmQk25A)

{% hint style="info" %}
**Note:** For MDC (multi-tenant database containers), create the monitoring user in the SYSTEMDB database and ensure each tenant database is individually registered in IT-Conductor.
{% endhint %}

* Execute the following script to list SQL port numbers for SYSTEMDB and Tenant DBs used in registering.

```
 SELECT * FROM sys_databases.m_services
 WHERE sql_port <> 0;
```

![Figure 3: Sample Port Number List](/files/g3ONOfSHHSWISxXBK5Jq)

### Configure SAP HANA System for Monitoring in IT-Conductor

To configure an SAP HANA System for monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP HANA System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **HANA Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/0lXXpxALYI5hCsTHO0qT" alt=""><figcaption><p>Figure 4: HANA Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New HANA System** button to start adding a new system for monitoring.

<figure><img src="/files/ViMOWp1hBBVWyzXOhBTX" alt=""><figcaption><p>Figure 5: HANA Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New HANA System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">to add the system.

<figure><img src="/files/4SzcdIfSwxyUuSwlaAh1" alt=""><figcaption><p>Figure 6: New HANA System Wizard (New HANA SID Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more detail&#x73;**.**

**DB Connection Properties**

* **SID -** refers to a unique identifier for an SAP HANA system used in configuration and monitoring.
* **System Number -** refers to a specific identifier for a SAP HANA instance used to distinguish it within the system.
* **Host** - refers to the host of the system being added.
* **Port** - refers to the port number used to access the system being added. By default, the port is set to 315. You must override it if it is different, especially in a multi-tenant database container.
* **Tenant Database -** refers to the HANA Tenant SID for the HANA System. If connecting to the SYSTEMDB, enter "SYSTEMDB" in this field.
* **SSL/TLS -** refers to the protocols that encrypt data between the SAP HANA system and clients to secure communications.
* **Compress -** when checked, it reduces to reduce the size of data being transmitted
* **Reconnect -** when checked, it attempts to re-establish a lost connection to the SAP HANA system automatically.
* **Read Only -** when checked, it activates a mode that allows monitoring operations without modifying any data or configuration in the SAP HANA system.
* **Ignore Topology -** refers to the option to disregard the physical or logical layout of the HANA system in monitoring operations.
* **Site Type -** refers to classifying the system's role within a landscape, such as production or development.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/brBqA7fB5VEf4kWa3Fvz" alt=""><figcaption><p>Figure 7: New HANA System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the user created aligned with the [Account Requirements](#sap-hana-authorizations-requirements).
* **Password** - refers to the password of the previously created user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **HANA Systems** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress**.
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **HANA Systems** node.

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitoring a SAP HANA System in IT-Conductor

Important features such as availability, alerts, and services are integrated into IT-Conductor for detailed monitoring.

<figure><img src="/files/f6hUJqZklvenr2bOJpyq" alt=""><figcaption><p>Figure 8: HANA Systems View in Service Grid</p></figcaption></figure>

**HANA System Key Metrics**

* **Availability** - refers to the operational state and accessibility of the HANA System.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the HANA system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the SAP HANA system.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed. You can also click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line"> to show more information about the SAP HANA system.

<figure><img src="/files/Heje82UndvVPxXKXUGTD" alt=""><figcaption><p>Figure 9: SAP HANA System Overview &#x26; Availability Chart in Service Grid</p></figcaption></figure>

### SAP HANA Scale-Out Monitoring

SAP HANA Scale-out means combining multiple independent nodes in one system. The remotely configured SAP HANA systems in IT-Conductor are monitored by distributing the tenant databases across multiple nodes.

IT-Conductor monitors multiple databases, such as system databases and tenant databases. They are observed as separate elements, but each tenant is monitored like other primary tenant databases. Furthermore, IT-Conductor offers a drill-down feature for further analysis, correlated alerts, operational status, and performance metrics across applications/DB/OS. The platform also provides time-correlated information about how the monitored system functions and performs.

#### **Alerts**

Performing regular checks on the status, performance, and resource usage is part of the continuous internal monitoring of a system. When configurable threshold values are exceeded, it issues alerts. Alerts can be monitored in individual tenant databases. When the alerts are triggered, they can potentially impact the system’s overall health. You can access them by clicking <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line">.

<figure><img src="/files/7sf9m1STufAUusI4HDLg" alt=""><figcaption><p>Figure 10: SAP HANA Alerts Count in Service Grid</p></figcaption></figure>

#### **Backup**

Refers to a saved copy of the database's data and logs that can be used to restore the system in case of failure or data loss. Through IT-Conductor, you can monitor the age of the complete data backup and the log backup to ensure they are up-to-date for recovery purposes by clicking <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line">.

<figure><img src="/files/k6Hw9LBRNTK56wxg4vXb" alt=""><figcaption><p>Figure 11: SAP HANA Backup Age Chart in Service Grid</p></figcaption></figure>

#### Jobs

Jobs refer to scheduled tasks or processes such as backups, data loads, or system updates. Using IT-Conductor, you can monitor the runtime of these jobs to ensure they are completed successfully and within expected time frames.

<figure><img src="/files/32tAqFJKC6kXH5rMOxhm" alt=""><figcaption><p>Figure 12: SAP HANA Jobs Runtime Chart in Service Grid</p></figcaption></figure>

#### Hosts

Hosts refer to physical or virtual machines that host SAP HANA instances and related services. IT-Conductor enables monitoring of host metrics such as memory usage, CPU utilization, disk performance, and status of HANA instances to ensure optimal performance and availability of the SAP HANA system.

<figure><img src="/files/0K3xP5fkhdBe1vfIFY0X" alt=""><figcaption><p>Figure 13: SAP HANA Hosts Metrics</p></figcaption></figure>

IT-Conductor also supports Linux monitoring. Providing the SSH parameters will add the nodes to the monitoring platform. IT-Conductor automatically discovers Linux servers to monitor File Systems (if any) and important system metrics such as the CPU and memory utilization to know how much memory is used. See [Unix/Linux Monitoring Documentation](/user-guide/monitoring/infrastructure/os/unix-linux-system) for more details.

<figure><img src="/files/SDWX9m0CaREmEQcewuRK" alt=""><figcaption><p>Figure 14: Monitoring Linux Systems in SAP HANA Hosts</p></figcaption></figure>

#### Licensing

The permissions and usage rights granted to operate the SAP HANA software under specific terms. With IT-Conductor, you can monitor the system for license validity and detect any license-related lockdowns to ensure continuous and compliant system operation.

<figure><img src="/files/jq4z80r0FrOOjwyON5KX" alt=""><figcaption><p>Figure 15: SAP HANA Licensing Information in Service Grid</p></figcaption></figure>

#### Savepoints

Savepoints are periodic snapshots of the database that capture changes and ensure data persistence. IT-Conductor allows you to monitor the duration of these savepoints to verify that they are completed efficiently and without performance impact.

<figure><img src="/files/DjKZE2orIieowoZ5iVrB" alt=""><figcaption><p>Figure 16: SAP HANA Savepoint Duration in Service Grid</p></figcaption></figure>

#### Services

Monitor all available services that SAP provides, including memory consumption. Services are mapped automatically after configuration, and IT-Conductor tracks the status in real-time.

<figure><img src="/files/6hBKgfdpnieprrT4822q" alt=""><figcaption><p>Figure 17: SAP HANA Services in Service Grid</p></figcaption></figure>

#### SQL Statement**s**

In addition to the performance metrics overview, IT-Conductor can also give comprehensive information about SQL statements with just a click on the graph. SQL statements give a high-level overview of the database’s workload.

<figure><img src="/files/XAqPxebLFtzwUBLSMrsy" alt=""><figcaption><p>Figure 18: SAP HANA SQL Statements Metrics in Service Grid</p></figcaption></figure>

### SAP HANA Overview Dashboard

The HANA System Overview Dashboard is a pre-configured dashboard for your HANA systems that you may access from the Service Grid.

<figure><img src="/files/2evrtbByirjpnFe5JiWZ" alt=""><figcaption><p>Figure 19: SAP HANA Overview Option in Service Grid</p></figcaption></figure>

It displays vital system information such as database availability, alerts summary, memory, disk consumption, CPU utilization, the most recent successful backup, savepoint duration, indexserver threads, and I/O ratio.

The charts are dynamic, giving you a detailed view of each performance metric when you click them. This allows you to visually correlate data for troubleshooting or analysis while seeing multiple comprehensive metrics on a single dashboard.

HANA Overview dashboards will allow quick recovery actions to prevent and reduce maintenance windows that may cause interruptions or bottlenecks in your daily operations.

<figure><img src="/files/KBXQGoyHdjISgnypp2I2" alt=""><figcaption><p>Figure 20a: SAP HANA Overview Dashboard</p></figcaption></figure>

<figure><img src="/files/2suwzmuIXDZVdaMMvLQQ" alt=""><figcaption><p>Figure 20b: SAP HANA Overview Dashboard (Continuation)</p></figcaption></figure>

<figure><img src="/files/sU1pbe16C2sn0R2xIXlG" alt=""><figcaption><p>Figure 20c: SAP HANA Overview Dashboard (Continuation)</p></figcaption></figure>

**Overview Dashboard Key Metrics**

* **System Availability** - indicates the operational status and uptime of the SAP HANA system.
* **Memory** - tracks the usage of system memory, including used, free, and allocated memory.
* **Alerts Summary** - provides an overview of all system alerts, showing their count, type, and severity.
* **Savepoint Duration** - measures the time to complete periodic savepoints for data persistence.
* **IndexServer Threads** - monitors the active and idle threads in the IndexServer, reflecting processing load and efficiency.
* **Backups** - displays the status, frequency, and age of database and log backups.
* **CPU** - shows the CPU utilization, indicating how much processing power is used.
* **Disks** - measures disk usage, including available space and performance metrics.
* **I/O** - tracks input/output operations, reflecting the data read/write performance of the system.

### Videos

{% embed url="<https://www.youtube.com/watch?v=NxFK6tAO2UA>" %}

{% embed url="<https://www.youtube.com/watch?ab_channel=IT-Conductor&v=qRFYZkHKBvU>" %}

{% embed url="<https://vimeo.com/254364914>" %}

### Related Information

* [The Practical Guide to HANA Monitoring Solutions](https://www.itconductor.com/blog/wanna-monitor-hana)


# SAP HANA Scale-Out Monitoring

SAP HANA Scale-out means combining multiple independent nodes in one system. SAP HANA systems that are remotely configured in IT-Conductor are monitored by distributing the tenant databases across multiple nodes.

IT-Conductor provides monitoring of multiple databases such as system DB and tenant databases. They are observed as separate elements, but each tenant is monitored like other primary tenant databases. Furthermore, IT-Conductor offers a drill-down feature for further analysis, correlated alerts, operational status, and performance metrics across applications/DB/OS. The platform also provides time-correlated information about how the monitored system functions and performs.

### Configure HANA Systems for Monitoring in IT-Conductor <a href="#configured-hana-systems-in-it-conductor" id="configured-hana-systems-in-it-conductor"></a>

{% hint style="info" %}
**Note:** To learn more about configuring SAP HANA Systems in IT-Conductor, kindly refer to this [article](/user-guide/monitoring/database/sap-hana-system).
{% endhint %}

In the Administrator dashboard, navigate to HANA Systems.

![Figure 1: SAP HANA Systems in Administrator Dashboard](/files/1hWLx1cUfRU7ui29awkY)

The page will show the list of HANA Systems defined in IT-Conductor.

![Figure 2: Sample List of SAP HANA Systems](/files/4xwcxBxydw1vT4g9G9ba)

Clicking the **\<System Name>** will give all the configured inputs when the system is first added to IT-Conductor for monitoring. The next page will show the details such as the System ID, Role, Host, Tenant Database, etc.

![Figure 3: SAP HANA System Properties](/files/GV5Yskvsahoi1KF5DvDF)

### SAP HANA Tenants Monitoring in IT-Conductor <a href="#sap-hana-tenants-monitoring-in-it-conductor" id="sap-hana-tenants-monitoring-in-it-conductor"></a>

Every tenant database is monitored separately. Important features such as availability, alerts, and services are integrated into IT-Conductor for detailed monitoring.

![Figure 4: SAP HANA Tenants in Service Grid](/files/QzTyZ5TQXYgn19Zm19pS)

An SAP HANA node contains the CPU, memory, response times, threads, requests, and volume information to be tracked. Individual nodes in a distributed system have different roles (master, slave, or none) depending on the task.

![Figure 5: SAP HANA Services Monitoring](/files/4T2JNRfHEcPYF05JhPYp)

As mentioned, IT-Conductor offers a drill-down function providing more detailed information about the monitoring features. Clicking on the triangle icon to expand the grid or the graph icon will give the graphical charts where you can compare each component easily. This also enables administrators to troubleshoot faster with root cause analysis.

![Figure 6: Expandable Icons](/files/78KNbXJEmUpjH5Qe5s6N)

![Figure 7: Sample Charts for Thread Monitoring](/files/LQgKZqeQYjDBIbywUn8R)

#### Alerts <a href="#alerts" id="alerts"></a>

Performing regular checks on the status, performance, and resource usage is part of the continuous internal monitoring of a system. When configurable threshold values are exceeded, it issues alerts. Alerts can be monitored in individual tenant databases. When the alerts are triggered, they can potentially impact the system’s overall health.

![Figure 8: Sample Chart for Alert Monitoring](/files/nFgP9AwYiQRPEgtzqSlw)

#### SQL Statements <a href="#sql-statements" id="sql-statements"></a>

In addition to the performance metrics overview, IT-Conductor can also give comprehensive information about SQL statements with just a click on the graph. SQL statements give a high-level overview of the database’s workload.

![Figure 9: Sample SQL Statement](/files/wZfLhf2HqKB7LLmzpMs6)

#### Linux Monitoring <a href="#linux-monitoring" id="linux-monitoring"></a>

Linux monitoring is also supported by IT-Conductor. Providing the SSH parameters will add the nodes to the monitoring platform. IT-Conductor automatically discovers Linux servers to monitor File Systems (if any) and important system metrics such as the CPU and memory utilization to know how much memory is used.

![Figure 10: Linux Monitoring in SAP HANA](/files/2qr8PpDwSF5LLu57wZgi)

### Video

{% embed url="<https://vimeo.com/254364914>" %}


# SAP HANA Overview Dashboard

The HANA System Overview Dashboard is a pre-configured dashboard for your HANA systems that you may access from the Service Grid.

It displays vital system information such as database availability, alerts summary, memory, disk consumption, CPU utilization, the most recent successful backup, savepoint duration, indexserver threads, and I/O ratio.

The charts are dynamic, enabling you to have a detailed view of each performance metric when you click them. This allows you to visually correlate data for troubleshooting or analysis while seeing multiple comprehensive metrics on a single dashboard.

HANA Overview dashboards will allow quick recovery actions to prevent and reduce maintenance windows that may cause interruptions or bottlenecks in your daily operations.

<figure><img src="/files/rbeFT1jhc3aJInnpFNAI" alt=""><figcaption><p>Figure 1: HANA Overview Dashboard</p></figcaption></figure>

<figure><img src="/files/3mW5mLGZ20oEJ2lAbFsT" alt=""><figcaption><p>Figure 2: HANA Dashboard Metrics</p></figcaption></figure>

### Step-by-step Guide

* [The Practical Guide to HANA Monitoring Solutions](https://www.itconductor.com/blog/wanna-monitor-hana)

### Video

{% embed url="<https://youtu.be/qRFYZkHKBvU>" %}


# SAP HANA Alert Management

Effective alert management is essential for maintaining the stability, performance, and overall health of an SAP HANA system. HANA Alert Management helps administrators stay informed through timely alerts, enabling efficient handling of system health via proactive monitoring and defined threshold settings.

HANA alerts are triggered at various priority levels based on the severity of issues. SAP HANA’s internal monitoring infrastructure continuously gathers and evaluates data on system status, performance, and resource usage. Regular checks on system tables and views are conducted, with alerts generated when specific thresholds are exceeded. For instance, if 90% of disk space is used, a low-priority alert is issued; at 98% usage, a high-priority alert is triggered.

Alerts are categorized by severity to help administrators prioritize their responses. The scale ranges from 1 to 4, with 1 being informational and 4 being critical.

It is important to have a well-defined alert management strategy to ensure alerts are handled effectively and that critical issues are addressed promptly. Proper configuration and management of these alerts enable the maintenance of optimal system performance.

### HANA Alert Exclusion

HANA Alerts can be excluded by creating alert configurations or thresholds to prevent specific alerts from being triggered. Alternatively, administrators can use the SAP HANA Cockpit or SAP HANA Studio to manually suppress alerts during maintenance or for known conditions, reducing false alarms during these periods. This allows for continued monitoring of critical alerts while excluding unnecessary or low-priority HANA alert notifications.

IT-Conductor provides a simple alternative for managing HANA alerts using the HANA Alert Retriever, Threshold Override, and RegEx (Regular Expression).

### Exclude HANA Alerts Using IT-Conductor HANA Alert Retriever <a href="#exclusion-using-it-conductor-hana-alert-retriever" id="exclusion-using-it-conductor-hana-alert-retriever"></a>

This method prevents IT-Conductor from retrieving specific HANA alerts based on the provided Alert ID. The excluded alert is neither displayed on the monitoring chart nor triggers notifications.

{% hint style="info" %}
**Note:** This exclusion is only effective for one HANA system.
{% endhint %}

1. Navigate to **Dashboards** **→** **Default**. Locate the **Alerts** panel and select the HANA alert you want to exclude.

<figure><img src="/files/xzkipGlEnYEKtxQGxO9O" alt=""><figcaption><p>Figure 1: Default Dashboard in IT-Conductor</p></figcaption></figure>

Alternatively, the **Alerts** page can be accessed by navigating to **Management → Monitoring → Alerts**.

2. Take note of the **Alert ID** (e.g., 106).

<figure><img src="/files/3SZgdH2HtZcPGzZc9vCo" alt=""><figcaption><p>Figure 2: HANA Alert Details Page</p></figcaption></figure>

3. Navigate to the relevant HANA system in the Service Grid and click **Retrievers**.

<figure><img src="/files/eTe0EJ2aN3dWkEfHR2zC" alt=""><figcaption><p>Figure 3: HANA System View in Service Grid</p></figcaption></figure>

4. Click **Alert Retriever** from the list.

<figure><img src="/files/a7W2Yh31056orcNoijmI" alt=""><figcaption><p>Figure 4: HANA Retrievers</p></figcaption></figure>

5. Under the **Exclusion Criteria** section, click **Add New Row** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">.
6. In the **Attribute** dropdown, select `HANAAlert.ALERT_ID`.
7. Choose the appropriate operator (e.g., **=** for a single value or **in** for multiple values).
8. Enter the Alert ID (e.g., 106) in the **Value** field.
9. Click **Create** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the entry, then click **Save** <img src="/files/7y7XLw4Pq9rZ6qwlkvIp" alt="" data-size="line"> to apply the changes.

You can later edit this row using **Modify Row** <img src="/files/6wWKel0tb8I3eJs4ouGh" alt="" data-size="line">.

<figure><img src="/files/dvtvjVb1D35MyT0Opdde" alt=""><figcaption><p>Figure 5: Modify HANA Alert Retriever</p></figcaption></figure>

### Exclude HANA Alerts Using IT-Conductor HANA Alert Threshold Override <a href="#exclusion-using-it-conductor-hana-alert-threshold-override" id="exclusion-using-it-conductor-hana-alert-threshold-override"></a>

This second approach allows for the collection and display of HANA alerts on the monitoring chart, but it doesn't trigger notifications. Unlike the first method, this one ensures data is still captured and visible for monitoring trends and severity.

This exclusion method offers more flexibility. It can be applied to individual HANA systems, groups of systems, specific environments (DEV, QA, or PROD), and individual organizations within your tenant. It can also be applied globally across all systems in your environment. This granular control allows you to tailor alert exclusion to your specific needs across your entire environment.

1. Click **All Alerts** <img src="/files/JxePeZFB8fpfmErv1aka" alt="" data-size="line"> to open the **Object** **menu**, then click **Overrides**.

<figure><img src="/files/42AvLmqVyFucHoADAw7y" alt=""><figcaption><p>Figure 6: Overrides Menu Option</p></figcaption></figure>

2. Click the override name (e.g., **HANA: High Priority Alerts**).

<figure><img src="/files/s74ro6dRntfvFLQWmwI9" alt=""><figcaption><p>Figure 7: HANA Alert Override</p></figcaption></figure>

3. In the **Object Criteria** section, click the **Add New Row** button.
4. Select `HANAAlert.ALERT_ID` from the **Attribute Name** dropdown.
5. Choose the appropriate operator (e.g., **=** for a single value or **in** for multiple values).
6. Enter the Alert ID (e.g., 106) in the **Value** field.
7. Click **Create** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the entry, then click **Save** <img src="/files/7y7XLw4Pq9rZ6qwlkvIp" alt="" data-size="line"> to apply the changes.

<figure><img src="/files/qMQYPCehteWxS65dl977" alt=""><figcaption><p>Figure 8: HANA Override Object Criteria</p></figcaption></figure>

### Exclude HANA Alerts Using RegEx <a href="#using-regex-for-hana-alerts-exclusion" id="using-regex-for-hana-alerts-exclusion"></a>

Regular expressions, which are powerful tools for pattern matching, can be used to exclude HANA alerts in either the HANA Alert Retriever or the Threshold Override Rule. This is particularly useful when you need to match alerts based on specific patterns or criteria.

In the example below, the steps are demonstrated using the Threshold Override Object Criteria; however, similar steps can be applied when using the HANA Alert Retriever method.

1. Add a new rule to the **Object Criteria** by clicking **New Row** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">.
2. Select the appropriate attribute (e.g., `HANAAlert.ALERT_NAME`).
3. Choose the RegEx operator (e.g., `!regex`).
4. Enter the value that matches the HANA alert pattern you want to exclude.
5. Click **Create** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the entry, then click **Save** <img src="/files/7y7XLw4Pq9rZ6qwlkvIp" alt="" data-size="line"> to apply the changes.

<figure><img src="/files/iWuRAjkEpDxynZXB2iyz" alt=""><figcaption><p>Figure 9: HANA Override Object Criteria Using RegEx</p></figcaption></figure>

{% hint style="info" %}
**Note:** Regular reviews of alert configurations are recommended to determine when to revert to previous settings or disable unnecessary alerts. This helps keep the system organized and prevents excessive notifications or noise.
{% endhint %}

### Video

{% embed url="<https://www.youtube.com/watch?v=9xWZcFVpkI0>" %}


# SAP ASE Database Monitoring

SAP Adaptive Server Enterprise (ASE), formerly Sybase ASE, is a high-performance, relational database management system designed for mission-critical, data-intensive environments. SAP ASE provides robust transactional processing capabilities, scalability, and high availability.

Monitoring SAP ASE helps ensure optimal database performance, detect and resolve issues promptly, maintain high availability, and improve overall system efficiency. Regular monitoring allows for proactive resource management, effective capacity planning, and enhanced security by identifying potential vulnerabilities and anomalies in real-time.

### Prerequisites

Before configuring an SAP ASE for monitoring in IT-Conductor, follow the instructions below.

#### ASE MDA Configuration

To configure the MDA Tables, follow the steps below.

{% hint style="info" %}
Only perform these steps if your SAP ASE version is 14 and under.
{% endhint %}

* Enable monitoring

```
sp_configure "enable monitoring", 1
go
```

* Enable error log 'pipe' table and set the number of messages to at least 100

```
sp_configure "errorlog pipe active", 1
go
sp_configure "errorlog pipe max messages", 100
go
```

* Enable deadlock 'pipe' table and set the number of messages to at least 100

```
sp_configure "deadlock pipe active", 1
go
sp_configure "deadlock pipe max messages", 100
go
```

* Enable lock timeout 'pipe' table and set the number of messages to at least 100

```
sp_configure "lock timeout pipe active", 1
go
```

#### Account Requirements

1. On the SAP ASE database, create a new SAP ASE monitoring account.
2. Grant the user the "mon\_role" role.

### Configure SAP ASE Database for Monitoring

To configure SAP ASE database monitoring in IT-Conductor, follow the instructions below.

#### Add New ASE Server

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **ASE Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/jKeVJIg6TcaGGIu7JA1W" alt=""><figcaption><p>Figure 1: ASE Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New ASE Server** button to start adding a new instance for monitoring.

<figure><img src="/files/zWPcaHrU5PLWDo2fXXe9" alt=""><figcaption><p>Figure 2: ASE Servers Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New ASE Server** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the instance.

<figure><img src="/files/O1lIPpjfY3y1VVZyImgD" alt=""><figcaption><p>Figure 4a: New ASE Server Wizard (New ASE Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the server being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the database server will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Host** - refers to the hostname or IP address of the server being added.
* **Port** - refers to the port number through which the server communicates with IT-Conductor. This is typically set to 7100.
* **Character Set** - refers to the encoding used by the SAP ASE database to store and retrieve character data.
* **Encrypt Password** - enables encryption of data exchanged between the server and IT-Conductor if checked.
* **JCE Provider Class** - refers to the Java Cryptography Extension provider class used for cryptographic operations.
* **SSL** - enables SSL protocol to secure the connection between the server and IT-Conductor.
* **Request HA** - indicates the request or configuration for high-availability features, such as failover and redundancy.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/W3WP13TflIKMFyLYkbte" alt=""><figcaption><p>Figure 4b: New ASE Server Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the server being added.
* **Person** - refers to the name of the user who is adding the server.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **User Password** - refers to the password of the previously created user.
* **Re-type Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **ASE Servers** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **ASE Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor SAP ASE Database in IT-Conductor

To view the availability and performance metrics of an ASE database, locate the **ASE Servers** node in the service grid.

<figure><img src="/files/XIKPxaDPKzgmhJBmF5QV" alt=""><figcaption><p>Figure 5: ASE Servers View in Service Grid</p></figcaption></figure>

#### **SAP ASE Server Key Metrics**

* **Availability** - refers to the operational state and accessibility of the SAP ASE server.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of server downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the SAP ASE server.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the SAP ASE server.

{% hint style="info" %}
**Note:** All metrics will not show data when a server is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/fDg7xWpQsTHPowxmrmTT" alt=""><figcaption><p>Figure 6: ASE Server Availability Chart in Service Grid</p></figcaption></figure>

#### **Error Logs**

To view the error logs that the ASE server generates, click **Error Log** in the Service Grid, and you will be redirected to the Error Logs Explorer, as shown in Figure 7.

<figure><img src="/files/JTXrgiavb9ngEaWOZUWP" alt=""><figcaption><p>Figure 7: ASE Server Error Logs Explorer</p></figcaption></figure>

To view the error logs in more detail, click on any bar or data point in the chart, and a list will be displayed. To export the list, click ![](/files/ALWvLckMfaCdOCv9CFmh) and a .csv file will start downloading.

<figure><img src="/files/h8s0Ah2wZXusq8vDfNXv" alt=""><figcaption><p>Figure 8: ASE Server Error Logs Details</p></figcaption></figure>

#### SAP ASE Database Key Metrics

* **DATA Used Space** - refers to the amount of storage currently occupied by the actual data within the database.
* **LOG Used Space** - indicates the portion of the transaction log used in an SAP ASE database.
* **Dump Errors** - refer to issues encountered when creating a database backup in SAP ASE.
* **Free Space** - refers to the amount of available storage within the database that is not yet utilized.

To view the metrics of a specific database, expand the **Databases** node by clicking <img src="/files/lmWNoNHAlYyGAcGpOP3L" alt="" data-size="line">.

<figure><img src="/files/PSEsnuO9ioA8l4JgPHZe" alt=""><figcaption><p>Figure 9: Expanded ASE Database View in Service Grid</p></figcaption></figure>

Alternatively, locate any ASE server and click **Databases**. You will be redirected to a page, as shown in Figure 10. To view details about a specific database, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line">.

<figure><img src="/files/oo9m8REbW9SkqaV50DUR" alt=""><figcaption><p>Figure 10: ASE Database Node View in Service Grid</p></figcaption></figure>

To view other tool options for monitoring the ASE server, click any ASE server node, and you will be redirected to a page, as shown in Figure 11.

<figure><img src="/files/fGf2lMyEsWljJwLU8BHS" alt=""><figcaption><p>Figure 11: ASE Server Node View in Service Grid</p></figcaption></figure>

#### **SQL Jobs**

To view all SQL jobs, click **SQL Jobs** from the server node view, and you will be redirected to the SQL Jobs actions panel page. To create a new SQL job, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">.

<figure><img src="/files/10Ba2vCygAzlSzxSN0OO" alt=""><figcaption><p>Figure 12: ASE Database SQL Jobs Actions Panel Page</p></figcaption></figure>

You will be redirected to the **Create Synchronous SQL Script** configuration page. Fill out all the necessary information, then click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save the script.

<figure><img src="/files/9UrbLWVcirSTxfiTRKUg" alt=""><figcaption><p>Figure 13: Create Synchronous SQL Script Configuration Page</p></figcaption></figure>

* **Name** - refers to a descriptive name for the job.
* **Description** - refers to any relevant information about the job being added.
* **Owner** - refers to the user who's adding the new job.
* **Status** - refers to the SQL job status. At this stage of the process, this is set to **Initial.**
* **Work Queue** - specifies the queue or list where the job is managed and processed. This field contains the name of the ASE Database.
* **Schedule** - sets the frequency or timing for executing the job. You may choose from one of the schedules previously created in IT-Conductor. See [How to Define Operating Schedules](/user-guide/reporting/scheduling-reports#reportscheduling-definingandoperatingschedules) for more details.
* **Planned Start Time** - refers to the scheduled start time for the SQL job.
* **Time Windows Begin** - refers to the beginning of the time window during which the SQL job can be executed.
* **Time Windows End** - refers to the end of the time window during which the SQL job can be executed.
* **Repeat** - if checked, it specifies that the job should be repeated or executed only once.
* **Completion Monitoring** - if checked, it enables tracking and reporting on the completion status of the SQL job.
* **Deliver Log** - if checked, it determines if the log or output of the SQL job should be sent or delivered to specified recipients.
* **SQL** - refers to the SQL query or script to be executed as part of the job.
* **Echo** - if checked, it controls whether the executed SQL query or script is echoed back in the job output.
* **Preserve Formatting** - if checked, it specifies whether it maintains the original formatting of the SQL query or script in the job output.
* **Wrapped** - if checked, it indicates if long lines of SQL output should be wrapped or truncated to fit within specified constraints.
* **Query Timeout** - refers to the maximum duration (in seconds) allowed for the execution of the SQL query before it is terminated. By default, this is set to 180 seconds.

To view all the available SQL jobs actions, click <img src="/files/8P0PVQddBEO9LwWgMCwG" alt="" data-size="line">.

<figure><img src="/files/Ytvanu8JtLOXheamEgaC" alt=""><figcaption><p>Figure 14: ASE Database SQL Jobs Actions Menu</p></figcaption></figure>

To view the execution logs of a specific SQL job, click **Execution Log** from the actions menu.

<figure><img src="/files/FJWom7sDYzE2xP4ruFXK" alt=""><figcaption><p>Figure 15: SQL Job Errors Execution Log</p></figcaption></figure>

#### **Instances**

To view the metrics of a specific database instance, expand **Instances** by clicking <img src="/files/lmWNoNHAlYyGAcGpOP3L" alt="" data-size="line">.

<figure><img src="/files/UoxZIFgGDcCibClEkeZS" alt=""><figcaption><p>Figure 16: Expanded ASE Server Instances View in Service Grid</p></figcaption></figure>

Alternatively, locate any ASE server and click **Instances**. You will be redirected to a page, as shown in Figure 17. To view details about the instance or a specific engine, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line">.

<figure><img src="/files/l1bvtg6XXVKyCrqhb8vp" alt=""><figcaption><p>Figure 17: ASE Database Instances Node View in Service Grid</p></figcaption></figure>

* **Status** - refers to the current operational state of the database instance.
* **Disk reads per second** - indicates the number of read operations the database performs on the disk per second.
* **Disk writes per second** - indicates the number of read operations the database performs on the disk per second.
* **Kernel run queue length** - indicates the number of processes waiting to be executed by the CPU.
* **Network reads per second** - indicates the rate at which data is read from the network by the database.
* **Network writes per second** - indicates the rate at which data is written to the network by the database.
* **Outstanding disk I/Os** - indicates the number of I/O operations by the disk subsystem.
* **Percent I/O busy** - indicates the percentage of time the disk subsystem is busy handling I/O operations.
* **Percent system busy** - indicates the percentage of time the system is engaged in executing kernel-level operations.
* **Percent user busy** - indicates the percentage of time the CPU is busy executing user-level processes.
* **Run queue length** - indicates the number of processes waiting in the queue to be executed by the CPU.

### Video

{% embed url="<https://vimeo.com/252786778>" %}


# SAP MaxDB Monitoring

SAP MaxDB is a powerful, enterprise-grade relational database management system designed for high performance and scalability. It offers robust features such as data integrity, transaction management, and advanced backup and recovery capabilities. With support for various platforms, it's an ideal choice for businesses requiring reliable data management solutions.

Monitoring MaxDB helps maintain reliability, performance, and security. IT-Conductor allows monitoring of several components, such as SQL report automation, space usage, etc. You can also view historical data depending on the selected time range.

### Prerequisites

Before configuring an SAP MaxDB for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Login to the Sqlcli with your SYSDBA/DBADMIN user as shown below:

```
>sqlcli -d <database_name> -u <dbadmin_user>,<dbadmin_password>
```

2. Create a database user with a STANDARD user class using the following script:

```
>CREATE USER <user_name> PASSWORD <user_password> STANDARD
```

### **Configure SAP MaxDB Monitoring in IT-Conductor**

To configure SAP MaxDB monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP MaxDB System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **MaxDB Instances** actions panel and click the title to access the complete list.

<figure><img src="/files/9FHKLLCPWDXL8MZNvwbA" alt=""><figcaption><p>Figure 1: MaxDB Instances Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New MaxDB System** button to start adding a new system for monitoring.

<figure><img src="/files/O79aTaJZMpwqnOU2jRWi" alt=""><figcaption><p>Figure 2: MaxDB Instances Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New MaxDB System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/sfnywLyf2yazGAUz5uit" alt=""><figcaption><p>Figure 3a: New MaxDB System Wizard (New MaxDB Instance Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **DB Name** - refers to the name of the SAP MaxDB instance being added.
* **Hostname** - refers to the hostname or IP address of the server hosting the SAP MaxDB instance.
* **SQL Mode** - refers to the SQL mode setting that determines the SQL compatibility level for the database, influencing syntax and behavior.
* **Cache** - refers to the memory cache the SAP MaxDB uses to store frequently accessed data.
* **Unicode** - indicates whether the database supports Unicode character encoding for multilingual support.
* **Session TimeOut** - specifies the duration of inactivity before a database session is automatically terminated.
* **Comm TimeOut** - defines the maximum time allowed for communication between the database server and client applications.
* **Verify SQL** - refers to an option to validate SQL statements for syntax errors and compatibility before execution.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/sRmecQx6CcdzvKqLermn" alt=""><figcaption><p>Figure 3b: New MaxDB System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the SAP MaxDB user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created SAP MaxDB user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **MaxDB Instances** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **MaxDB Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor SAP MaxDB System in IT-Conductor

To view the availability and performance metrics of a SAP MaxDB system, locate the **MaxDB Servers** node in the service grid.

<figure><img src="/files/NL4Zpvrb1QM1GanwXke9" alt=""><figcaption><p>Figure 4: SAP MaxDB Servers View in Service Grid</p></figcaption></figure>

#### **SAP MaxDB Systems Key Metrics**

* **Availability** - refers to the operational state and accessibility of the MaxDB system.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the MaxDB system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the MaxDB system.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/oGtINl2c0WI6aesD8z7w" alt=""><figcaption><p>Figure 5: SAP MaxDB Availability Chart in Service Grid</p></figcaption></figure>

#### **Data Disk Usage**

To view the usage or the disk space consumed by the system processes, locate and expand the **Data** node in the service grid.

<figure><img src="/files/bH0sFJBkOLVydubmiseo" alt=""><figcaption><p>Figure 6: SAP MaxDB Data Disk Used Chart in Service Grid</p></figcaption></figure>

**Log Files Usage**

To view the usage consumed by the log files, locate and expand the **Log** node in the service grid.

<figure><img src="/files/qxZmQEsB8Kvt1kmd8JDy" alt=""><figcaption><p>Figure 7: SAP MaxDB Log Files Used Chart in Service Grid</p></figcaption></figure>

**SQL Jobs**

To view and run SQL jobs, navigate to the specific MaxDB server node and click **SQL Jobs**.

<figure><img src="/files/m4RXSe1Y6cQAPBeIazKe" alt=""><figcaption><p>Figure 8: SQL Jobs Object Menu in Service Grid</p></figcaption></figure>

You will be redirected to the SQL Jobs page that lists all active SQL jobs. To view the job details of a specific SQL job, click the title, and you will be redirected to another page, as shown in Figure 10.

<figure><img src="/files/FYtCEZe7VhnPjsMgDS07" alt=""><figcaption><p>Figure 9: SAP MaxDB SQL Jobs</p></figcaption></figure>

<figure><img src="/files/Q95Ngd6eoosqolyUnPuD" alt=""><figcaption><p>Figure 10: SAP MaxDB SQL Job Details</p></figcaption></figure>

To view the tools or the different actions you can perform on the SQL job, click ![](/files/8P0PVQddBEO9LwWgMCwG).

<figure><img src="/files/bTocCE3g647q9Xv9x8cS" alt=""><figcaption><p>Figure 11: SAP MaxDB SQL Job Tools</p></figcaption></figure>


# HA/DR Monitoring

SAP Adaptive Server Enterprise (ASE) High Availability and Disaster Recovery (HADR) system involves two ASE servers, one serving as the primary for transaction processing and the other as a standby with replicated databases.

For monitoring this setup, IT-Conductor's ASE HA/DR monitoring feature provides visibility into the primary and standby servers, along with the status of the HADR system, synchronization mode, and synchronization state.

In the event of a primary server failure and the promotion of the standby server to the primary role, IT-Conductor quickly identifies the new active primary server.

The servers are visually organized in a cluster grouping, distinguishing the standby server with an inactive status symbol, typically represented by a power icon. This enables teams to promptly identify the current state of the system and take necessary actions to ensure uninterrupted service.

### Prerequisites

[Configure ASE primary and secondary databases for monitoring](https://docs.itconductor.com/user-guide/monitoring/database/sap-ase) before configuring HA/DR monitoring in IT-Conductor.

<figure><img src="/files/Ps8OkaXrK83mOAxa5ksR" alt=""><figcaption><p>Figure 1: Existing ASE Databases</p></figcaption></figure>

### Configure HA/DR Monitoring in IT-Conductor <a href="#configure-ha-dr-monitoring-in-it-conductor" id="configure-ha-dr-monitoring-in-it-conductor"></a>

To configure ASE HA/DR monitoring in IT-Conductor, follow the instructions below.

#### Add New HA/DR Cluster <a href="#add-a-new-ha-dr-cluster" id="add-a-new-ha-dr-cluster"></a>

1. Navigate to the desired ASE databases and select **Retrievers**.

<figure><img src="/files/dXhOSMlzNeS1JO1JqRe3" alt=""><figcaption><p>Figure 2: ASE Database Menu</p></figcaption></figure>

2. Activate the following retrievers by clicking on the retriever’s object menu, then click **Activate**.
   1. ![](/files/cJe9dXGNLCEPWTzgctr9)HADR Path
   2. ![](/files/cJe9dXGNLCEPWTzgctr9) HADR Resource Status
   3. ![](/files/qWkM6PVQSPoM4QBu6nDl) HADR Status

<figure><img src="/files/shFcXkprCZpita6Pvn9u" alt=""><figcaption><p>Figure 3: Available Retrievers</p></figcaption></figure>

4. Navigate to **Dashboards** → **Administrator**.

<figure><img src="/files/odiRsJF7F4qXMZTIC2Uj" alt=""><figcaption><p>Figure 4: Accessing the Administrator Menu</p></figcaption></figure>

5. In the Administrator dashboard, locate the “Clusters” panel. Then click ![](/files/GyE5mIvG5sbjOhzYdtwX) to create a new cluster.

<figure><img src="/files/GjqgqJkVmEbAszAdbpEE" alt=""><figcaption><p>Figure 5: Create a New Cluster Option</p></figcaption></figure>

5. In the "New Cluster" wizard, fill out all the necessary information. Then click ![](/files/GyE5mIvG5sbjOhzYdtwX) to add the cluster.

<figure><img src="/files/wQylFOlnAH1MkPcV8cSN" alt=""><figcaption><p>Figure 6a: New Cluster Wizard</p></figcaption></figure>

* **Name** - refers to the name of the cluster being added.
* **Description** - refers to any relevant information about the cluster being added.
* **Role** - refers to the specific function or responsibility assigned within the database system.
* **Member Class** - refers to the classification or category of a database user or group. Select **ASE** from the dropdown menu.
* **Controller Class** - refers to the type or level of control associated with a particular user or group. Select **ASEServerService** from the drop-down menu.
* **Active Condition** - refers to the current operational status or state of a specific aspect or component. Click ![](/files/GyE5mIvG5sbjOhzYdtwX) to open the pop-up window and fill out the following fields:
  1. **Name**: Select **ASEServerService.ScriptVersion.HADRState** from the menu.
  2. **Operator**: Select **“=”.**
  3. **Value**: Type “Active”**.**
  4. Then click ![](/files/GyE5mIvG5sbjOhzYdtwX) to close and save.

<figure><img src="/files/MmrCDBzwOjMSa4VlmFo1" alt=""><figcaption><p>Figure 6b: New Cluster Wizard (Adding Active Condition)</p></figcaption></figure>

8. On the following screen, select the databases that you would like to configure for HA/DR monitoring. Then click ![](/files/6Kab8sFwhwzwL39TSRmv) to save.

<figure><img src="/files/MEcbWuVFhfOHXOIeFJRd" alt=""><figcaption><p>Figure 7: Selecting ASE Databases for HA/DR Monitoring</p></figcaption></figure>

After saving, please allow a few minutes for the clusters to appear in the IT-Conductor Service Grid.

<figure><img src="/files/orw8yYVJe9ANqKsbYOsj" alt=""><figcaption><p>Figure 8: Monitored Clusters</p></figcaption></figure>


# Infrastructure Monitoring


# File Server Monitoring

File Server is a centralized location for storing, managing, and sharing files within a network environment. It enables users to manage files efficiently while ensuring security and compliance. Integrating it with IT-Conductor extends its capabilities, particularly with the File Watcher feature designed for SMB (Samba) File Server environments.

Through this integration, users can monitor shares, directories, and individual files in SMB setups, tracking their status and modifications. IT-Conductor allows users to set up alerts for specific file conditions, such as timely arrival, enabling proactive management and enhancing data integrity across the network. Integrating File Server with IT-Conductor's file watcher functionality provides real-time monitoring and control over file-related events, improving operational efficiency and security.

### Prerequisites

Before configuring a file server for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

Create or designate an account with read access to the Shares, Folders, and Files that will require monitoring on the Windows Server.

### **Configure** File Server Monitoring **in IT-Conductor**

To configure file server monitoring in IT-Conductor, follow the instructions below.

#### Add a New File Server

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **File Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/RyHkiMJ92xH1w0ykcykP" alt=""><figcaption><p>Figure 1: File Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the ![](/files/x6oPxr215br4EVnXE1PP) icon to add a new file server

<figure><img src="/files/ph57Ku9bTvXm1wWH64G3" alt=""><figcaption><p>Figure 2: File Servers Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New File Server** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/L8EcBuaJGkXwk8FMgYed" alt=""><figcaption><p>Figure 3a: New File Server Wizard (New File Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the file server being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Server Name** - refers to the name of the server that will be added.
* **SMB2** - refers to the network communication protocol used for file sharing.

6. Provide the account information in the wizard and click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/Ty7EGolYFWalHtwpX2ko" alt=""><figcaption><p>Figure 3b: New File Server Wizard (New Account Screen)</p></figcaption></figure>

* **Description -** refers to any relevant information about the user account being added.
* **Application** - refers to the previously added file server.
* **Person** - refers to the name of the user who is adding the server.
* **User** - refers to the user aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **File Servers** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/fZV8GSHFCJx1ejjNKcfJ) to display the log and troubleshoot as needed. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

9. Navigate to the service grid and verify if the system was added under the **File Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

<figure><img src="/files/vnCTbnwxkMSUwHEZGEUf" alt=""><figcaption><p>Figure 6: File Servers in IT-Conductor Service Grid</p></figcaption></figure>

### Monitor File Servers in IT-Conductor

To view the availability and performance metrics of a File Server, locate the **File Server** node in the service grid.

<figure><img src="/files/OO4VC16X8ZnZ9SIMFeKB" alt=""><figcaption><p>Figure 7: File Server View in Service Grid</p></figcaption></figure>

#### **File Server Key Metrics**

* **Availability** - refers to the operational state and accessibility of the File Server.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the File Server.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the File Server.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of these metrics, click <img src="/files/DpIRuNEsBGyPRwNw1TNt" alt="" data-size="line">and a pop-up chart will be displayed.

<figure><img src="/files/dx0QYXAPxAe580OzYwDd" alt=""><figcaption><p>Figure 8: Availability Chart in Service Grid</p></figcaption></figure>

#### **Health Explorer**

To view a more detailed analysis of metrics and time-synchronized data, click **Health** in the service grid, and you will be redirected to the **Health Explorer** page.

<figure><img src="/files/NW7mwtPEOfnOFoMk18Gq" alt=""><figcaption><p>Figure 9a: File Server Health Explorer</p></figcaption></figure>

<figure><img src="/files/3kkslRTDujLI3iCo2Oky" alt=""><figcaption><p>Figure 9b: File Server Health Explorer</p></figcaption></figure>

#### **Application Log**

An application log records events or messages generated by software during its execution. It is typically used for debugging and troubleshooting purposes.

To view the logs for the file servers, click **Application Log** in the service grid, and you will be redirected to a page with a list of all events and their status.

<figure><img src="/files/mnFgadP4YXpuZZ6uWw3X" alt=""><figcaption><p>Figure 10: File Server Application Log</p></figcaption></figure>

#### **Scheduled Maintenance Events**

To view the scheduled maintenance events for monitored File Servers, click **Events** in the service grid, and a pop-up list of **Scheduled Maintenance Events** will be displayed.

<figure><img src="/files/fjVJN7Yoaa14OU0urxs7" alt=""><figcaption><p>Figure 11a: File Server Scheduled Maintenance Events</p></figcaption></figure>

To schedule a maintenance event, click ![](/files/05hFmGjTlYTQYtRE3GjN) and you will be redirected to a page listing all maintenance events associated with the file server. Then click **Create New Maintenance Events.**

<figure><img src="/files/MTWojJT2WhOKD1tLetDP" alt=""><figcaption><p>Figure 11b: Create a New Maintenance Event</p></figcaption></figure>

### Related Information

Please refer to the [File Watcher Documentation](/user-guide/monitoring/infrastructure/file-server/file-watcher) to learn how to monitor the information within the shares, folders, and files.


# File Watcher Monitoring

IT-Conductor File Watcher facilitates application integrations by tracking file exchanges between business partners, clients, providers, etc. This monitoring mechanism enables seamless communication through file sharing, where entities post files into designated directories for application consumption.

File Watcher monitoring in IT-Conductor relies on retrievers that periodically collect files from external systems such as SAP, SMB file servers, and SFTP hosts, enabling users to monitor shares, directories, and files - their existence, size, and modification time.

By setting up alerts, users can ensure that specific conditions regarding the files, such as timely arrival, are met. Users can trigger automated processing and enable event-driven integrations by setting up recovery actions. This proactive monitoring and automation approach enhances operational efficiency and helps maintain compliance and data integrity across integrated systems.

### Prerequisites <a href="#pre-requisites" id="pre-requisites"></a>

Before proceeding, configure file retrieval from your source system (e.g., SAP system, SMB server, or SFTP host) by following the appropriate setup instructions for your environment.

#### SMB Server <a href="#smb-server" id="smb-server"></a>

* Set up a file server for file management and a watcher in IT-Conductor. See [File Server Monitoring ](https://docs.itconductor.com/user-guide/monitoring/infrastructure/file-server)for instructions.

#### SFTP host <a href="#sftp-host" id="sftp-host"></a>

* Set up SSH2 host monitoring. See [Linux Monitoring](https://docs.itconductor.com/user-guide/monitoring/infrastructure/os/unix-linux-system) for instructions

#### SAP System <a href="#sap-system" id="sap-system"></a>

* Set up SAP System monitoring. See [SAP Netweaver monitoring](https://docs.itconductor.com/user-guide/monitoring/sap/netweaver) for instructions.
* Download the SAP NW File Watcher Role and the SAP NW Monitoring Role file in [**Support → Downloads → SAP Security Download**](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=5930548857087850)**.**

<figure><img src="/files/lYXJdFtZG8WnhKTgXR8z" alt=""><figcaption><p>Figure 1: SAP Security Roles</p></figcaption></figure>

* Assign both roles to the designated IT-Conductor user

### Configure File Watcher Monitoring in IT-Conductor <a href="#configure-file-watcher-monitoring-in-it-conductor" id="configure-file-watcher-monitoring-in-it-conductor"></a>

To configure the file watcher monitoring in IT-Conductor, follow the instructions below.

{% hint style="info" %}
**Note:** Before proceeding, note that configuration methods may vary depending on your system and environment; ensure you select the appropriate approach for your setup ([SMB Server](#smb-server-1), [SFTP/SSH2 Host](#sftp-host), or [SAP System](#sap-system-1)).
{% endhint %}

#### **Add New File Monitors** <a href="#add-new-file-monitors" id="add-new-file-monitors"></a>

#### **SMB Server**

Follow these instructions to add a new file monitor for files located on an SMB/CIFS network share.

1. Navigate to the File Server and click **File Monitors**.

<figure><img src="/files/GVuwrzOJhauEN1lG1acV" alt=""><figcaption><p>Figure 2: Add new file monitor - SMB Server</p></figcaption></figure>

2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new retriever.

<figure><img src="/files/fORnUhGQA36uTh3jmhOx" alt=""><figcaption><p>Figure 3: Add new file monitor</p></figcaption></figure>

3. Fill out all the necessary information in the **Create Get Directory Files** wizard. Some of these may already be filled out.
   1. **Name** - refers to the name given to the retriever.
   2. **Description** - refers to any relevant information about the directory being added.
   3. **Application** - refers to the file server from which the files are being pulled.
   4. **Repeat** - when enabled, IT-Conductor retrieves files from the SAP system periodically at the configured interval (in minutes).
   5. **Repeat interval** - refers to the frequency with which each retriever pulls files into IT-Conductor. By default, this is set to every 15 minutes. However, depending on the sensitivity of the information, this can be adjusted as needed.
   6. **Share** - the share that will be pulled into IT-Conductor.
   7. **Folder** - the folder's name inside the share that will be pulled into IT-Conductor.
   8. **File Name/Mask** - refers to the file names that will be pulled into IT-Conductor. You can use regex in this field. (Optional)

<figure><img src="/files/ELGYoaHK7FSQwoBPvI5N" alt=""><figcaption><p>Figure 4a: Create new CIFS file retriever wizard</p></figcaption></figure>

4. Fill in the optional **insertion** and **exclusion criteria.** This will enable additional filtering of files retrieved from the SMB server. To add a criteria, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new row, then fill in the following fields:
   1. **Attribute**- the exact criteria that you can monitor. You can choose one of the available criteria from the drop-down menu.
   2. **Operator** - refers to the operator validation (=, !=, >, <, in, regex, NULL, etc.)
   3. **Value** - refers to the exact value that will be monitored. This is an open field where you can specify file names or formats for monitoring.

<figure><img src="/files/iecwy2loQlEt2JcRAzbD" alt=""><figcaption><p>Figure 4b: Create new CIFS file retriever wizard - Insertion &#x26; Exclusion criteria</p></figcaption></figure>

5. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save and finish

#### **SAP System**

Follow these instructions to add a new file monitor for files accessible within an SAP system.

1. Navigate to the SAP System and click **File Monitors**.

<figure><img src="/files/2F94VskbsdMV3u80IfOH" alt=""><figcaption><p>Figure 5: Add file monitors option - SAP System</p></figcaption></figure>

2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new file monitor

<figure><img src="/files/PxOdMGyX8W9QCJT2mtA1" alt=""><figcaption><p>Figure 6: Add new file monitor</p></figcaption></figure>

3. Fill out all the necessary information in the **Create SAP Get Directory Files** wizard. Some of these may already be filled out.
   1. **Name** - refers to the name given to the retriever.
   2. **Description** - refers to any relevant information about the directory being added.
   3. **SAP System** - refers to the SAP system from which the files are being pulled.
   4. **Repeat** - when enabled, IT-Conductor retrieves files from the SAP system periodically at the configured interval (in minutes).
   5. **Repeat interval** - refers to the frequency with which each retriever pulls files into IT-Conductor. By default, this is set to every 15 minutes. However, depending on the sensitivity of the information, this can be adjusted as needed.

<figure><img src="/files/r04IMaihObR0b7JydPPP" alt=""><figcaption><p>Figure 7a: Create new SAP file retriever wizard</p></figcaption></figure>

4. Fill in the optional **insertion** and **exclusion criteria.** This will enable additional filtering of files retrieved from the SAP system. To add a criteria, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new row, then fill in the following fields:
   1. **Attribute**- the exact criteria that you can monitor. You can choose one of the available criteria from the drop-down menu.
   2. **Operator** - refers to the operator validation (=, !=, >, <, in, regex, NULL, etc).
   3. **Value** - refers to the exact value that will be monitored. This is an open field where you can specify file names or formats for monitoring.
5. Input parameters
   1. **Directory** - the file system path on the SAP server where IT-Conductor retrieves files for monitoring.

<figure><img src="/files/Oos1iNv7yzvRyej2B16z" alt=""><figcaption><p>Figure 7b: Create new SAP file retriever wizard - Insertion &#x26; Exclusion criteria</p></figcaption></figure>

6. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save and finish.

#### **SFTP/SSH2 Hosts**

Follow these instructions to add a new file monitor for files located on a Linux host via SSH access.

1. Navigate to the Linux Host and click **File Monitors**.

<figure><img src="/files/S8JH33ssv5UdR6zatxrL" alt=""><figcaption><p>Figure 8: Add file monitors option - SAP System</p></figcaption></figure>

2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new file monitor

<figure><img src="/files/nk1VjDKq4iw9qO4d6Tis" alt=""><figcaption><p>Figure 9: Add new file monitor</p></figcaption></figure>

3. Fill out all the necessary information in the **Create SFTP Directory** wizard. Some of these may already be filled out.
   1. **Name** - refers to the name given to the retriever.
   2. **Description** - refers to any relevant information about the directory being added.
   3. Application
   4. **Repeat** - when enabled, IT-Conductor retrieves files from the SFTP host periodically at the configured interval (in minutes).
   5. **Repeat interval** - refers to the frequency with which each retriever pulls files into IT-Conductor. By default, this is set to every 15 minutes. However, depending on the sensitivity of the information, this can be adjusted as needed.
   6. **Directory** - the remote folder path on the SSH2 host where files are retrieved from for monitoring.
   7. **File** - the specific file name or pattern to be retrieved and monitored from the SSH2 directory.

<figure><img src="/files/oANbXgOsheqBiwaIxDH4" alt=""><figcaption><p>Figure 10a: Create new SFTP file retriever wizard</p></figcaption></figure>

4. Fill in the optional **insertion** and **exclusion criteria.** This will enable additional filtering of files retrieved from the host. To add a criteria, click on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> button, then fill in the following fields:
   1. **Attribute**- the exact criteria that you can monitor. You can choose one of the available criteria from the drop-down menu.
   2. **Operator** - refers to the operator validation (=, !=, >, <, in, regex, NULL, etc).
   3. **Value** - refers to the exact value that will be monitored. This is an open field where you can specify file names or formats for monitoring.

<figure><img src="/files/eiW1Bd7FQMJpvgSZMFO7" alt=""><figcaption><p>Figure 10b: Create new SFTP file retriever wizard - Insertion &#x26; Exclusion criteria</p></figcaption></figure>

6. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save and finish.

After saving, it’ll take a few minutes for IT-Conductor to pull the files in that share and folder.

Retrievers execute at a defined interval (typically every few minutes, depending on the configuration) to pull files from the source system. For each file retrieved, a corresponding object is created in IT-Conductor. These objects serve as the basis for monitoring and contain metadata such as:

* Directory path
* File name
* Size
* Last modification timestamp

<figure><img src="/files/bjnoFV66owrhvD2ATLCD" alt=""><figcaption><p>Figure 11: File view in IT-Conductor</p></figcaption></figure>

#### **Add New File Watcher**

File watchers are typically created per target group to monitor a specific set of files. Each watcher selects relevant file objects based on high-level criteria such as directory path (using regular expressions/regex) and the source system. This initial filtering defines the pool of file objects that the watcher will evaluate. By setting up the file watcher, you specify how folders and files that are periodically pulled from the file server are monitored.

{% hint style="info" %}
**Note:** After configuring file retrieval and creating the file monitor for your SAP system, SFTP host, or SMB file server, the next step is to create a file watcher to define how the retrieved files will be monitored.

Regardless of the source type, the process for creating a file watcher remains the same, and the File Watcher container is automatically created under the corresponding site.
{% endhint %}

1. On the file server node, click **File Watchers.**

<figure><img src="/files/ttUA5kOOUNQrfsq9GPFf" alt=""><figcaption><p>Figure 12: File Watchers</p></figcaption></figure>

2. Click **Create New Object** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create a new file watcher.

<figure><img src="/files/fuvfOp8hpd85V67B7sin" alt=""><figcaption><p>Figure 13: Create a new File Watcher</p></figcaption></figure>

3. On the following screen, fill out the following details

* **Name** - refers to the name assigned to this file watcher.
* **Description** - refers to any relevant information about the file watcher being added.
* **Application** - refers to the file server.
* **File Mask** -This is an optional file selector - a regular expression (Regex) instruction where you specify what files will match the criteria. In the simplest form, specify the full path of the file, but make sure you escape special characters such as \[]\().:\\^$ with '\\' as: \\\[, \\], \\(, \\) etc. For more advanced options, please refer to online regex tutorials and testers such as [Free Online Regular Expression Tester - FreeFormatter.com](https://www.freeformatter.com/regex-tester.html)

4. Click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to save.

<figure><img src="/files/TD4a5I0nAd2SXHtzepUj" alt=""><figcaption><p>Figure 14: Create File Watcher Wizard</p></figcaption></figure>

5. Click the recently created file watcher. Then click **Threshold Overrides** <img src="/files/SXYNTv4GriRFzclbiTkw" alt="" data-size="line"> to create an override to specify what the file watcher will monitor.

<figure><img src="/files/y5T2co5QAOZTcyxRSgpi" alt=""><figcaption><p>Figure 15: File Watcher Activity Chart</p></figcaption></figure>

{% hint style="info" %}
**Note:** The overrides in the selected file watcher will apply only to the files pre-selected by the monitor based on the corresponding file mask.
{% endhint %}

6. On this page, you may see the previously created overrides for monitoring. Click <img src="/files/zYe5VRf809qKLeDXLdEs" alt="" data-size="line"> to create a new override, or click <img src="/files/3tJv7dAgTsU4VoY3D5Db" alt="" data-size="line"> to [create an override from an existing template](https://docs.itconductor.com/user-guide/notifications/creating-threshold-overrides). In this example, we’re creating a new override.

<figure><img src="/files/em7TmgVOE262QAXuvDxu" alt=""><figcaption><p>Figure 16a: Creating a New Override</p></figcaption></figure>

**Overrides** define the specific monitoring logic applied to the file objects selected by the file watcher. While the watcher performs a broad selection (e.g., by directory), it further refines the scope by applying additional criteria such as file name patterns (using regex).

Overrides also define:

* The time window during which monitoring is active
* The look-back interval, which determines how far back in time file modification timestamps are considered

This allows monitoring to focus only on relevant files within a specific timeframe and context.

7. Fill out all the necessary information in the **Create New Override** wizard. Once completed, click<img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to add the new override.

<figure><img src="/files/mzLnt0KhAFiaJJiZLR36" alt=""><figcaption><p>Figure 16b: Creating a New Override</p></figcaption></figure>

* **Name** - refers to the assigned name for the override being added.
* **Description** - any relevant information about the override being added.
* **Object Criteria** - refers to the specific attributes that will be monitored. If you add the folder path in step 3, it will appear here. Under Object Criteria, you may specify what you want to monitor in this path. To add more criteria, click on the **Add New Row** <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line">, then fill in the following fields:
  * **Name** - refers to the exact criteria that you can monitor. You can choose one of the available criteria from the drop-down menu.
  * **Oper** - refers to the operator validation (=, !=, >, <, in, regex, NULL, etc).
  * **Value** - refers to the exact value that will be monitored. This is an open field where you can specify file names or formats for monitoring.

In the example above, we add the object criteria **Path**, and the operator '=', which means that the override will search for files within the folder path that we add.

<figure><img src="/files/EAl8p3ViDTMaKaqHrQHd" alt=""><figcaption><p>Figure 16c: Creating a New Override</p></figcaption></figure>

* **Scheduling** - refers to the section where you can specify when the override will perform validation. You may choose to run the override on a specific day and time. If you don't specify a day, it will run daily at the indicated time. Alternatively, you can assign [a pre-existing schedule ](https://docs.itconductor.com/user-guide/reporting/scheduling-reports#reportscheduling-definingandoperatingschedules)from the dropdown menu.
  * **Start** - refers to the time when the override will start monitoring.
  * **End** - refers to the time when the override will stop monitoring.
* **Aggregation -** refers to the metrics used to define the aggregation values.
  * **Aggregation interval** - defines the period within which the files are collected and added to the file server.
  * **Consecutive interval** - refers to the regularity or frequency of occurrences within a defined number of minutes.
  * **Aggregation** - refers to the function that will be applied, such as sum, average, count, minimum, or maximum.

The **Scheduling** and **Aggregation** sections tell the override when to look for files. The example above specifies a time window between 6:30 am and 7:00 am. During that time, the override will search for files added to the server in the previous 360 min, as specified in the **Consecutive Interval** field below.

<figure><img src="/files/MU7AvQAHVGgTsv782tx4" alt=""><figcaption><p>Figure 16d: Creating a New Override</p></figcaption></figure>

* **Thresholds** - refers to the metrics used to define the threshold values.
  * **Warning Value** - refers to the value determining if the threshold was reached. If this field is blank or zero, it means that there’s no data.
  * **Warning Operator** - refers to the operator validation (=, !=, >, <, in, regex, NULL, etc).
  * **Warning Severity** - refers to the severity status that will be triggered if the validation reaches the Warning Value.
* **Alerting** - refers to the section where you can indicate when the users will receive the alerts.
  * **Alert On** - refers to the status that will trigger the alert and notify the users. This is usually set to “Warning”.
  * **Alert Message** - refers to the message that the users will see. This message is customizable by the user.

**Threshold** and **Alerting** sections tell the override when to send a message to the user. This example specifies that if there have been 0 posted files in the server, the status of the override will turn to **Warning**, and if the status is Warning, an alert will be sent to the user.

{% hint style="info" %}
**Note:** The more criteria you add, the more specific the override is and the higher the precedence.
{% endhint %}

8. Click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to save.

<figure><img src="/files/wAvoHULYh1tyCcLn3sGO" alt=""><figcaption><p>Figure 17: Existing File Watchers</p></figcaption></figure>

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/fZV8GSHFCJx1ejjNKcfJ) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

### Monitor Files in IT-Conductor <a href="#monitor-files-in-it-conductor" id="monitor-files-in-it-conductor"></a>

Locate the previously configured file server under the File Servers node in the service grid to monitor the files pulled from the file server. Click **Files** to view all the files added to that share.

<figure><img src="/files/6a5v0k2b6kxKqxftg4BC" alt=""><figcaption><p>Figure 18: Pulling Files from the File Server</p></figcaption></figure>

By clicking on any of the files, you can see the following information from each file:

* **Description** - refers to any relevant information about the file.
* **File name** - refers to the name of the file and its extension.
* **Path** - refers to the path’s full size, including the share and folders before it.
* **Size** - refers to the file size.
* **Last modified** - refers to the time and date when the file was last modified or added to the server.

<figure><img src="/files/f3cnJQ0ObXC2RSLHuQeh" alt=""><figcaption><p>Figure 19: File information</p></figcaption></figure>

To validate file monitoring, you can cross-check the files displayed in IT-Conductor against those in the SAP transaction AL11 by ensuring the same directory path, file names, and timestamps align; note that IT-Conductor reflects files from the last retriever cycle, so recent files may not appear immediately. If the directory is not visible in AL11, it must first be defined as a logical directory using the FILE transaction, as required by the function module used by IT-Conductor.

#### **File Watchers**

To monitor the existing file watchers, locate the **File Watchers** node in the service grid.

The number displayed next to the file watcher indicates the number of alerts generated by the override. Click ![](/files/wlAuALXlp7zAJzOoUlb6)to inspect the activities.

<figure><img src="/files/6cWde1XuEGtkKvPf473q" alt=""><figcaption><p>Figure 20: File Watcher View in Service Grid</p></figcaption></figure>

By enlarging the chart, you can see the activity of the override. By clicking on the green bars, you can see which files have arrived recently and at what time. The image below is an example of 3 files arriving in the folder path at 8:30pm.

<figure><img src="/files/iIGz46VSuIWlXNPSUcHJ" alt=""><figcaption><p>Figure 21: Reading the override charts</p></figcaption></figure>

Alternatively, the following image represents an alert sent to the user’s email because the override didn’t detect any files during the consecutive interval period.

<figure><img src="/files/6t3vznOlc8uiiBHOHyI5" alt=""><figcaption><p>Figure 22: Reading File Watcher Alerts</p></figcaption></figure>

### SAP System Use Case: Monitoring File Delivery and Configuring Alerts <a href="#sap-system-use-case-monitoring-file-delivery-and-configuring-alerts" id="sap-system-use-case-monitoring-file-delivery-and-configuring-alerts"></a>

In this scenario, we demonstrate how to configure an alert when retrieving files from a **SAP system**, specifically when a file with a defined name is not received in a directory by a specified time of day. The alert is then linked to a subscription so that designated users are notified and can take appropriate action. This approach is commonly used to ensure that expected files are delivered on time for downstream processing.

First, we’re going to create the override

1. Locate the **File Watch** node in the main service grid and select the file watcher for which you wish to create an alert by clicking the <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> icon.

<figure><img src="/files/y7kLcU0b0E1HdD492L40" alt=""><figcaption><p>Figure 23: Access File Watch in Service Grid</p></figcaption></figure>

2. Click on **Threshold Overrides** ![](/files/RT3mGxIBZHHnoQqWOsrq) and click on **Create Override button** <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> or **Create override from template**. <img src="/files/wS9sqbJBt80uwBS1qL1n" alt="" data-size="line">

<figure><img src="/files/KOFD0Lf90IKKCCxM1ny6" alt=""><figcaption><p>Figure 24: Threshold Overrides in File Watch</p></figcaption></figure>

3. On the **Create Override** screen, some fields such as name, description, and target object type may be pre-populated. These can be updated if required. Then complete the following fields:
   1. Application Role -> Production (if the override applies to the production environment)
   2. Object criteria → This section defines the conditions used to identify the files to monitor. Click on the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> icon to add a new criteria.
      1. Name → OBJECT\_Name
      2. Oper → regex
      3. Value → ^TEST (This configuration matches files whose names start with “TEST”. By using the regex operator and the ^ symbol, IT-Conductor evaluates file names accordingly and includes matching files in the monitoring logic.)
   3. Click on <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a row

{% hint style="info" %}
**Note:** Since this scenario involves monitoring files retrieved from a SAP system, the object name criteria include the corresponding SAP prefix.
{% endhint %}

<figure><img src="/files/FmXPudoXe3IQqiLWaQ3Z" alt=""><figcaption><p>Figure 25a: Create Override for SAP File Watch - Add object criteria</p></figcaption></figure>

This scenario is only one example. You can adapt the alert criteria to match different file naming patterns depending on your requirements.

For example:

| Match files that start with TEST                   | regex ^TEST      |
| -------------------------------------------------- | ---------------- |
| Match files that contain TEST anywhere in the name | regex TEST       |
| Exclude files that contain TEST                    | !regex TEST      |
| Match files that start with TEST                   | !regex ^(?:TEST) |

4. In this case, specifying the file directory is not required because the override is created within the selected directory. If you wish to modify it, select the existing row, click the<img src="/files/BjoIPFlUnN3WokI8NULi" alt="" data-size="line">icon, and update the **Value** field accordingly.

<figure><img src="/files/qjQRovC8CG0Kr7ZouPHG" alt=""><figcaption><p>Figure 25b: Create Override for SAP File Watch - Specify directory</p></figcaption></figure>

5. In the **Scheduling** section, define when the override should evaluate the files. You can either select a pre-defined schedule (See [Create a Schedule](https://docs.itconductor.com/user-guide/reporting/scheduling-reports/hana#create-a-schedule) documentation) or configure specific days and times. In this example, the evaluation window is set between 7:30 PM and 8:00 PM.

<figure><img src="/files/efpeZf58jTU4X5WUeklF" alt=""><figcaption><p>Figure 25c: Create Override for SAP File Watch - Set override schedule</p></figcaption></figure>

6. In the **Thresholds** section, specify the following details:
   1. Alarm value → 0
   2. Alarm operator → =
   3. Alarm severity → Warning (This configuration ensures that if no matching files are found during the evaluation window, the override status is set to **Warning**.)
7. In the **Alerting** section, specify the following details:
   1. Alert on → Warning
   2. Alert Message → *File \Guidewire\Activity\In\TEST\* has not been posted by 8:00 PM.* (This message will be sent if no files meeting the defined criteria are detected.)

<figure><img src="/files/KA37dbeENXBq8xIA1amR" alt=""><figcaption><p>Figure 25d: Create Override for SAP File Watch - Set alarm threshold values</p></figcaption></figure>

8. Click save.

{% hint style="info" %}
**Note:** For a detailed explanation of how Overrides work in IT-Conductor, please refer to our [Threshold overrides](https://docs.itconductor.com/user-guide/notifications/threshold-overrides) documentation.
{% endhint %}

The same scenario can be applied to files retrieved from an SMB file server, with criteria adjusted to use the CIFS prefix.

<figure><img src="/files/7a6FOadkahiyX8Yb5nAe" alt=""><figcaption><p>Figure 26: Create Override for SMB Server File Watch - Add object criteria</p></figcaption></figure>

Second, let’s create the subscription. This is what will notify us of the change in the override’s status

1. On the main menu, click on **Management → Notifications → Subscriptions**, and click on **Create new subscription**
2. Fill the following fields
   1. Target → Select the File Watcher node
   2. Subscriber → Select the IT-Conductor user, [distribution list](https://docs.itconductor.com/user-guide/notifications/distribution-lists), or [notification target](https://docs.itconductor.com/user-guide/notifications/notification-targets) that will receive the alert
   3. Minimum severity → Warning (to align with the override configuration)
3. Click on <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to save.

<figure><img src="/files/azNZLQCMY4PzZ9mkvmkz" alt=""><figcaption><p>Figure 27: Create subscription for file watcher</p></figcaption></figure>

{% hint style="info" %}
**Note:** You may add extra layers of triggers to make the subscription even more specific by adding those in the **Alert criteria** box. For more information on how to better utilize this tool and other use cases, please refer to the [Subscriptions ](https://docs.itconductor.com/user-guide/notifications/subscriptions)documentation
{% endhint %}


# Git Server

Git server is a centralized platform for hosting Git repositories, facilitating version control and collaboration in software development projects. The IT-Conductor Git Adapter enables seamless integration and synchronization across diverse Git servers, including GitHub, GitLab, BitBucket, Azure DevOps, and self-hosted options. Software development teams use various Git platforms depending on their project requirements and preferences.

### **Configure Git Server in IT-Conductor**

To configure a git server in IT-Conductor, follow the instructions below.

#### **Add New Git Server**

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Git Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/cDBVuedvGc3sgGY5H2ol" alt=""><figcaption><p>Figure 1: Git Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click **Create New Github Connection** <img src="/files/S1lfHzAUiLKrq1at50tJ" alt="" data-size="line"> or **Create New Git Connection** <img src="/files/kFAclOV8CyNRuKPx61Lf" alt="" data-size="line">.

<figure><img src="/files/asdHmFyPqrRLjjor4PCW" alt=""><figcaption><p>Figure 2: Git Servers Actions Panel Page</p></figcaption></figure>

**Add New GitHub Connection**

1. Fill out all the necessary information in the **New Github Instance** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/G8pja8YPhzz7wz8HJhm7" alt=""><figcaption><p>Figure 3a: New GitHub Instance Wizard (New Git Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the git server being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role** - refers to the environment where the git server will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Host** - refers to the type of git server that will be added to IT-Conductor. By default, it's github.com.

2. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/ea31kfYsQxTyWc6IwpC9" alt=""><figcaption><p>Figure 3b: New GitHub Instance Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the GitHub account being added.
* **Person** - refers to the user who's creating the GitHub instance.
* **User Name** - refers to a unique token generated on GitHub. For more information on generating a token, please refer to this [documentation on managing personal access tokens on Git Hub.](https://docs.github.com/en/enterprise-server@3.9/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
* **Token** - allows IT-Conductor to use a GitHub-generated token instead of a username and password.

{% hint style="info" %}
**Note:** When configuring GitHub access, please use the GitHub-generated **Access Token** as the user name (the password field should be blank).
{% endhint %}

4. Verify if the server was added to the **Git Servers** actions panel and check its status.

**Add New Git Connection**

1. Fill out all the necessary information in the **New Git Instance** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/r1eZV6aQuAQOmcCbwbzx" alt=""><figcaption><p>Figure 4a: New Git Instance Wizard (New Git Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the git server being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role** - refers to the environment where the git server will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Protocol** - refers to the communication protocol (HTTPS by default) that will be used to access the git server.
* **Host** - refers to the type of git server that will be added to IT-Conductor. It can be GitHub, GitLab, BitBucket, or Azure DevOps.

2. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/QhUuKDAYS2jXRMCAa7xQ" alt=""><figcaption><p>Figure 4b: New Git Instance Wizard (New Account Screen)</p></figcaption></figure>

* **Description -** short description of the user.
* **Application** - refers to the type of git server added in step 1.
* **Person** - refers to the user who's creating the Git instance.
* **User name** - unique token generated on GitHub. For more information on generating a token, please refer to this [documentation on managing personal access tokens on Git Hub.](https://docs.github.com/en/enterprise-server@3.9/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
* **Token** - this field allows IT-Conductor to use a GitHub-generated token instead of a username and password.

{% hint style="info" %}
**Note:** When configuring GitHub access, please use the GitHub-generated **Access Token** as the user name (the password field should be blank).
{% endhint %}

4. Verify if the newly added connection was added to the **Git Servers** actions panel and check its status.

{% hint style="info" %}
**Note for Git and Github connections:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain on **Ready**. Click on the negative space to trigger the pop-up menu and click on the **Log** icon ![](https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252FGx0Q4OSu3wOOo5O8ZbQC%252Flog.gif%3Falt=media%26token=55a3b985-c68a-4120-a285-2afac310a988\&width=42\&dpr=4\&quality=100\&sign=c722a48497f25a2090f362f749f70677b04e8ad6a14fbfe2efcbe21458940d70) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

5. Navigate to the service grid and verify if the system was added under the **Git Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The server will appear in the service grid within 5-15 minutes.
{% endhint %}

<figure><img src="/files/S74ssyaCrvzCqFXWYxaf" alt=""><figcaption><p>Figure 5: Git Servers in the Service Grid</p></figcaption></figure>


# OS Monitoring


# Unix/Linux System Monitoring

Unix and Linux are well-known operating systems (OS) for their versatility and robustness in various computing environments. Unix/Linux OS has three main components: kernel, shell, and programs. The kernel is the core component that manages system resources and provides a platform for software applications to interact with the hardware.

To monitor the availability and performance of Unix/Linux systems, critical kernel metrics such as CPU, memory, and disk utilization must be monitored. It is also recommended that the programs and applications running inside the system, the processes executing these programs, and user login activities be monitored to ensure peak performance.

### Prerequisites

Before configuring a Unix/Linux system for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a user that can execute `df`, `fstab`, `vmstat`, `mpstat`, `lpstat`, `free`, `uptime`, and `ps` commands at a minimum.
2. Add the user created as a member of the system group.
3. Ensure the user’s default shell is set to `bash.`
4. Ensure the user’s shell startup profile files (e.g., `.bashrc`, `.profile`) does not contain customizations or scripts that may interfere with shell initialization. These should be removed or simplified to allow the shell to start cleanly. Validate the configuration by running `bash -i` and confirming it returns `0` with no errors.

{% hint style="info" %}
**Note:**

* Perform these steps on the Linux system that will be monitored.
* Access to additional commands may be required if a custom configuration is involved.
  {% endhint %}

### Configure Unix/Linux System Monitoring in IT-Conductor <a href="#configure-unix-linux-monitoring-in-it-conductor" id="configure-unix-linux-monitoring-in-it-conductor"></a>

To configure Unix/Linux system monitoring in IT-Conductor, follow the instructions below.

#### Add New Unix/Linux System <a href="#add-new-unix-linux-system" id="add-new-unix-linux-system"></a>

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Unix/Linux Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/TMn79LeE117MjdNYWHO9" alt="Unix/Linux Systems Panel in Administrator&#x27;s Dashboard"><figcaption><p>Figure 1: Unix/Linux Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New Linux System** button to start adding a new system for monitoring.

<figure><img src="/files/gcDyBaaYI6ESJ68XCqRg" alt=""><figcaption><p>Figure 2: Unix/Linux Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New Linux System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/sLLgsCKJA6vniEoyQxXY" alt=""><figcaption><p>Figure 3a: New Linux System Wizard (New Linux System Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Host** - refers to the host of the system being added.
* **Port Number** - refers to the port number (SSH Port 22 by default) that will be used to access the system being added.
* **Shell** - refers to the command-line interface of the OS used by the system being added.
* **Sudo Arguments** - refer to the additional parameters or options passed to the sudo command.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/gqw1TVDCPUx1bwzYaPhG" alt=""><figcaption><p>Figure 3b: New Linux System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **Realm** - refers to a domain or administrative boundary within a network environment. If the server supports Kerberos authentication, input the domain name.
* **User Name** - refers to the Linux user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created Linux user.
* **Retype Password** - refers to the same password provided in the **Password** field.
* **Private Key File** - refers to the file containing cryptographic keys used for authentication, encryption, and decryption in secure communication protocols such as SSH and SSL/TSL. A path to the "gateway-local .ppk" file if the key authentication is required.

7. Verify if the system was added to the **Unix/Linux Systems** actions panel and check its status.

<figure><img src="/files/bxl8HIKRnaA07KKsicuA" alt=""><figcaption><p>Figure 4: Newly Added Linux System in Unix/Linux Systems Actions Panel Page</p></figcaption></figure>

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **Linux Systems** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor Unix/Linux System in IT-Conductor

To view the availability and performance metrics of a Unix/Linux system, locate the **Linux Systems** node in the service grid.

<figure><img src="/files/6HHPuQw353eVXAdWkaS9" alt=""><figcaption><p>Figure 5: Linux Systems View in Service Grid</p></figcaption></figure>

#### Linux System Key Metrics <a href="#linux-systems-key-metrics" id="linux-systems-key-metrics"></a>

* **Availability** - refers to the operational state and accessibility of the Unix/Linux system.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the Unix/Linux system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the Unix/Linux system.
* **CPU I/O Wait** - refers to the percentage of CPU spent waiting for Input/Output (I/O) operations to complete.
* **CPU Idle** - refers to the percentage of idle CPU time or not executing any tasks.
* **CPU System** - refers to the percentage of CPU time spent executing kernel-level processes and system calls.
* **CPU User Peak -** refers to the highest level of CPU usage by user-space processes within a certain period.
* **CPU User Time** - refers to the percentage of CPU time spent executing user-space processes.
* **Load Average** refers to the average number of processes running or uninterruptible over a defined period.
* **Load Avg/CPU** - refers to the ratio of the load average to the number of CPU cores in a system.
* **Free Memory** - refers to the amount of physical RAM currently not used by any active processes or cached by the system.
* **Memory Used** - refers to the percentage of memory currently utilized by active processes, cached data, and system buffers.
* **Memory Used Peak** - refers to the highest percentage of memory utilization observed within a certain period.
* **Swap Used** - refers to the percentage of swap space currently utilized by the system.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/YkHbbc7lSgSVMR1eQUJF" alt=""><figcaption><p>Figure 6: Availability Chart in Service Grid</p></figcaption></figure>

#### File Systems Utilization Metrics

File systems are also part of the default monitoring setup upon adding a Unix/Linux system in IT-Conductor. The following metrics are automatically tracked for file systems:

* **Allocated Size** - refers to the amount of disk space allocated per directory.
* **Available Space** - refers to the amount of available or unused disk space.
* **Mount Status** - refers to the current state of a file system. It indicates whether the file system is successfully mounted and accessible for read and write operations.
* **Used %** - refers to the percentage of disk space used per directory.

<figure><img src="/files/2KT2YeKp1BWQoZetexUL" alt=""><figcaption><p>Figure 7: File Systems View in Service Grid</p></figcaption></figure>

{% hint style="info" %}
**Note:** You can also enable Process Usage, a metric that measures the utilization of specific processes. Once enabled, it operates at regular intervals, running in the background to produce reports for each system where it's enabled.
{% endhint %}

#### Health Explorer

To view a more detailed analysis of metrics and time-synchronized data, click **Health** in the service grid, and you will be redirected to the **Health Explorer** page.

<figure><img src="/files/zEugXXH2juX5FiwQUs6U" alt=""><figcaption><p>Figure 8: Unix/Linux Systems Health Explorer</p></figcaption></figure>

#### Scheduled Maintenance Events

To view the scheduled maintenance events for monitored Unix/Linux systems, click **Events** in the service grid, and a pop-up list of **Scheduled Maintenance Events** will be displayed.

<figure><img src="/files/4BJIm4CnM0MhnQg2je9T" alt=""><figcaption><p>Figure 9: Unix/Linux Systems Scheduled Maintenance Events</p></figcaption></figure>

#### Heat Map

To view a heat map for monitored Unix/Linux systems, click **Heat Map** in the service grid, and a pop-up heat map will be displayed. Click on a tile to show a more detailed view of a system's health.

<figure><img src="/files/TrdLPHF5wQV4i5wioAnQ" alt=""><figcaption><p>Figure 10: Unix/Linux Systems Heat Map</p></figcaption></figure>

#### Performance Overview

To view a high-level comparison of system health for monitored Unix/Linux systems, click **Performance Overview** in the service grid. You will be redirected to the **Performance Overview** page.

<figure><img src="/files/vEyjrrGb1eO9avF19Bxa" alt=""><figcaption><p>Figure 11: Unix/Linux Systems Performance Overview</p></figcaption></figure>

Click the checkboxes to exclude the system(s) from view, depending on what you want to investigate.

#### Network Interface Monitoring

To view the network interface metrics of a Linux system, locate the **Network Interfaces** node in the service grid.

<figure><img src="/files/8t0hREqllsTLUU3U44rB" alt=""><figcaption><p>Figure 12: Linux Network Interfaces View in Service Grid</p></figcaption></figure>

#### Network Interfaces Key Metrics

* **State** - refers to the current operational state of the network interface.
* ***IP Address*** - refers to the IP address assigned to each network interface in a Linux system.
* ***Other Details*** - includes details about the network interface configured for monitoring.

{% hint style="info" %}
**Note:**

* Only interface status, IP addresses, and other details are initially pulled. For extended features, see [Linux Network Interface Monitoring](/user-guide/monitoring/infrastructure/os/unix-linux-system/network-interface).
  {% endhint %}

To view more information about the interface and access a historical view of a specific metric, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line"> and <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> respectively.

<figure><img src="/files/vv75Rg3sluFfameDq9dp" alt=""><figcaption><p>Figure 13: Network Interface Properties &#x26; Link State Monitoring Chart in Service Grid</p></figcaption></figure>

### Related Information

* [Central Syslog Server Monitoring](/user-guide/monitoring/general/central-syslog-server)


# Linux Network Interface Monitoring

Network interface monitoring in Linux involves tracking and managing individual network interfaces within Linux-based systems. By continuously monitoring network interfaces on Linux systems, administrators can track bandwidth usage, optimize resource allocation, detect network errors or congestions, and troubleshoot connectivity issues that may impact system performance and reliability.

Monitoring network interfaces in IT-Conductor enables real-time visibility into network interface status, errors, throughput, remote host ping statistics, etc. It allows the identification of networking issues without full-fledged network monitoring infrastructure.

To view the Linux network interface metrics, locate the **Network Interfaces** node in the **Linux Systems** grid.

<figure><img src="/files/zp12VHWPjc74X82iFI3t" alt=""><figcaption><p>Figure 1: Linux System Grid</p></figcaption></figure>

{% hint style="info" %}
**Note:** Only interface status, IP addresses, and other details are initially pulled.
{% endhint %}

### Configure Extended Network Interface in IT-Conductor

If required, IT-Conductor can utilize the `ifstat` command to collect other network interface metrics. To enable this feature, follow the instructions below.

1. Click **Configuration** in the **Network Interfaces** grid.

<figure><img src="/files/8yFJFX3gE1XhZI6Oyeux" alt=""><figcaption><p>Figure 2: Configuration Tool in Network Interfaces Grid (Basic Metrics)</p></figcaption></figure>

2. Click <img src="/files/5svWPq2U0rnJ49VRXnoy" alt="" data-size="line"> to activate the IFStat retriever.

<figure><img src="/files/B2f95RhbgLzM2vcRIDtM" alt=""><figcaption><p>Figure 3a: Linux Network Interfaces Configuration Actions Panel Page (Inactive)</p></figcaption></figure>

<figure><img src="/files/hSuf7HyvGQ5TOl4RZNB2" alt=""><figcaption><p>Figure 3b: Linux Network Interfaces Configuration Actions Panel Page (Initial)</p></figcaption></figure>

{% hint style="info" %}
**Note:** The newly collected metrics will appear in the service grid within 5-15 minutes.
{% endhint %}

3. Verify if the newly collected metrics are showing properly in the **Network Interfaces** grid.

<figure><img src="/files/fc7mCc9LseoiChwVoZVu" alt=""><figcaption><p>Figure 4: Network Interfaces Grid (Extended Metrics)</p></figcaption></figure>

#### Network Interfaces Extended Metrics

* **State** - refers to the current operational state of the network interface.
* **RX Data** - refers to the amount of data received (in bytes) by the network interface.
* **RX Dropped** - refers to the number of incoming packets dropped by the network interface due to issues like buffer overflows or congestion.
* **TX Data** - refers to the amount of data transmitted (in bytes) by the network interface.
* **TX Dropped** - refers to the number of outgoing packets dropped by the network interface, typically due to congestion or other network issues.
* **TX Errors** - represents the number of transmission errors encountered by the network interface, which could include issues like collisions or failed transmissions.

{% hint style="info" %}
**Note:** The thresholds can be set up for all monitors. See [Creating Threshold Overrides](/user-guide/notifications/threshold-overrides) for more information.
{% endhint %}

### Configure Remote Host Ping Monitoring in IT-Conductor

Host ping is deactivated by default.

#### Activate Host Ping

To activate host ping, follow the instructions below.

1. Click **Properties** in the **Linux System** grid.
2. Check the **Network Ping Monitoring** option, and then click Save.

<figure><img src="/files/2MqYyeAQYdtW9BYq9iui" alt=""><figcaption><p>Figure 5: Network Ping Monitoring Option in Linux System Properties</p></figcaption></figure>

3. Verify if the **Host Ping** node shows in the **Linux System** grid.

<figure><img src="/files/jUC7Ck8RtTO2WHHcKQaK" alt=""><figcaption><p>Figure 6: Host Ping Grid</p></figcaption></figure>

#### Configure Individual Host Ping

To set up individual host ping, follow the instructions below.

1. Click **Configuration** in the **Host Ping** grid.
2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new ping.

<figure><img src="/files/NYWSvAnS4glLGGe8viJy" alt=""><figcaption><p>Figure 7: Host Ping Configuration Actions Panel Page</p></figcaption></figure>

3. Fill out all the necessary information in the **Create Host Ping Retriever** configuration page. Once completed, click **Finish** to add the system.

<figure><img src="/files/0T8OXTk6Qzl2mnJ8LAK3" alt=""><figcaption><p>Figure 8: Create Host Ping Retriever Configuration Page</p></figcaption></figure>

{% hint style="info" %}
**Note:**

* Specify a proper name and host(s). Multiple hosts should be separated by spaces.
* You can override the default Linux ping command parameters: Interval, Packets, & Timeout.
  {% endhint %}

4. Verify if the newly collected metrics are showing properly in the **Host Ping** grid.

<figure><img src="/files/fmGJJWvgaU3qFbelGUiB" alt=""><figcaption><p>Figure 9: Host Ping Grid (Extended Metrics)</p></figcaption></figure>

#### Host Ping Key Metrics

* **Packet Loss** - refers to the percentage of packets that fail to reach their destination over a network interface. It aggregates all ping result records and alerts on each host that has a loss value above the threshold.
* **Response Time** - refers to the time it takes for a packet to travel from its source to its destination and back.

5. Verify the additional **Response Time** monitor in the **Host Ping** grid.

**View Historical Ping Results**

To view historical ping results, navigate to the **Packet Loss** explorer and click on any data point (green circle) on the chart line to display the ping result records for the interval selected.

<figure><img src="/files/z8fpPTl4Kf0Tw4HX8zkf" alt=""><figcaption><p>Figure 10: Packet Loss Monitoring</p></figcaption></figure>

<figure><img src="/files/Eb3dYzZ3P7H8k7QNEokm" alt=""><figcaption><p>Figure 11: Reported Packet Loss</p></figcaption></figure>

To the effective thresholds, click![](/files/RT3mGxIBZHHnoQqWOsrq). Adjust the values and alerting as required.

<figure><img src="/files/H35YEpVgPIhtPX66bYDk" alt=""><figcaption><p>Figure 12: Packet Loss Overrides</p></figcaption></figure>

{% hint style="info" %}
**Note:** The same approach can be applied to Response Time monitors.
{% endhint %}

#### View Historical Response Time

To view historical response time, navigate to the specific host's **Response Time** explorer and click on any data point (green circle) on the chart line to display the response time records for the interval selected.

<figure><img src="/files/77sEwbva8YIa2tCEKKki" alt=""><figcaption><p>Figure 13: Response Time Monitoring</p></figcaption></figure>


# OS Printer Monitoring

Monitoring printers provides real-time visibility into printer status, errors, and alerts. It allows you to manage printing workloads and identify issues like paper jams and connectivity problems. Proactive monitoring helps minimize printer downtime and reduce IT support's burden.

### Prerequisites

Configure a Linux system with connected printers for monitoring. See [Unix/Linux System Monitoring](/user-guide/monitoring/infrastructure/os/unix-linux-system) for more details

### Configure OS Printer for Monitoring in IT-Conductor <a href="#how-to-configure-os-printer-for-monitoring" id="how-to-configure-os-printer-for-monitoring"></a>

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. From the IT-Conductor Service Grid, click ▶ to expand “Linux Systems”.

<figure><img src="/files/FCQhpaytYEIkjaWj6pUh" alt=""><figcaption><p>Figure 1: Linux Systems in IT-Conductor Service Grid</p></figcaption></figure>

2. Click the object menu of the Linux system to be configured and then click **Retrievers**.

<figure><img src="/files/YOkJ1W9f4nj6JEmSsykX" alt=""><figcaption><p>Figure 2: Navigate to Retrievers Option</p></figcaption></figure>

3. Click the object menu of retriever “Printers (lpstat -p)“ and then click **Activate**.

<figure><img src="/files/anDmL9tXp61sVisLUvp7" alt=""><figcaption><p>Figure 3: Activate Printer</p></figcaption></figure>

4. The connected printers will be added to IT-Conductor for monitoring.

### Monitor OS Printer in IT-Conductor <a href="#monitoring-features" id="monitoring-features"></a>

To view the printer statistics navigate to the **Linux Systems** > **SID > Printers** in the service grid. Here, you can see details of the following metrics:

* **Status:** Current operational state of the printer or print queue (e.g., idle, printing, disabled).
* **Request age:** Time elapsed since a print job was submitted to the queue.
* **Request count:** Total number of print jobs currently in the queue or processed over a time period.

<figure><img src="/files/0Q2SfEltdlGL28OLtJ5H" alt=""><figcaption><p>Figure 4: Printer Statistics in IT-Conductor</p></figcaption></figure>

View each metric in more detail by clicking on the bar chart <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> metric name. Adjust the chart depending on your preferred timescale.

<figure><img src="/files/FBB9bUKB2NkZAbxV6XMI" alt=""><figcaption><p>Figure 5: Printer Status (Hourly)</p></figcaption></figure>

{% hint style="info" %}
**Note:** Printer status could be “Idle”, “Printing”, or “Disabled”.
{% endhint %}

<figure><img src="/files/ytCIetXiggUzpFmoOcd6" alt=""><figcaption><p>Figure 6: Job Count (Daily)</p></figcaption></figure>

#### Alerting <a href="#alerting-features" id="alerting-features"></a>

IT-Conductor generates alerts based on the values of collected stats.

<figure><img src="/files/ChLXKf2ZSGEqhclI6LPv" alt=""><figcaption><p>Figure 7: Configure Alerts based on Job Count</p></figcaption></figure>

In Figure 4, the warning alert is generated if the average request count is more than 1 in the last 15 minutes, and the alert is resent if, after 15 minutes, there are still jobs running.

<figure><img src="/files/aedMVeLapIDaSJ1hU6gz" alt=""><figcaption><p>Figure 8: Configure Alerts based on Request Age</p></figcaption></figure>

Similarly, in Figure 5, the critical alarm alert is generated if the job has been running for more than 60 minutes (3600 seconds), and the alert is resent if, after 60 minutes, there are still jobs running.

See [Configuring IT-Conductor Alerts](https://docs.itconductor.com/~/changes/j1RdUn49WBcajmJEmXUf/users-guide/notifications/configuring-itc-alerts#configuringitcalerts-howtoconfigureitcalerts) for further instructions.

### Related Information <a href="#related-articles" id="related-articles"></a>

* [OS Printer Queue Restart Automation](/user-guide/automation/os-printer-queue-restart)


# Windows System Monitoring

Windows is an operating environment developed by Microsoft. A Windows system refers to any computing environment running a version of Microsoft Windows.

Monitoring Windows systems involves tracking availability and performance metrics such as CPU usage, memory consumption, and disk utilization. Effective monitoring helps ensure system stability, optimize performance, identify potential issues, and maintain the overall efficiency of Windows-based environments.

### Prerequisites

Before configuring a Windows system for monitoring in IT-Conductor, follow the instructions in the pages specified below.

* [WinRM Configuration](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/winrm-services-configuration)
* [Domain User Access](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/domain-user-access)
* [Configure Access to WMI Namespace](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/wmi-namespace-access)
* [Allow Windows Service Configuration Manager Access](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/windows-service-configuration)

### Configure Microsoft Windows for Monitoring in IT-Conductor

To configure Windows system monitoring in IT-Conductor, follow the instructions below.

#### Add New Windows System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **Windows Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/KPfe6e64G0nWUuvsWmw3" alt=""><figcaption><p>Figure 1: Windows Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New Windows System** button to start adding a new system for monitoring.

<figure><img src="/files/Jg8bmPtZ753YM6wXEdob" alt=""><figcaption><p>Figure 2: Windows Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New Windows System** wizard. Once completed, click ![](https://docs.itconductor.com/~gitbook/image?url=https%3A%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt%3Dmedia\&width=40\&dpr=4\&quality=100\&sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db) to add the system.

<figure><img src="/files/PkWsocWBYwCxHbvC9OVo" alt=""><figcaption><p>Figure 3a: New Windows System Wizard (New Windows System Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Timeout** - refers to the maximum time IT-Conductor will attempt to establish a connection to the host agent (It is set to 120 seconds by default).

**Authentication**

* **Authentication** - refers to the authentication mechanism, such as Kerberos, NTLM, Basic, Negotiate, or Custom, to verify user identities.
* **Realm** - refers to a domain or administrative boundary within a network environment. If the server supports Kerberos authentication, input the domain name.
* **KDC** - refers to a component of Kerberos authentication that issues ticket-granting tickets.
* **Domain Controller** - refers to a server in a Windows domain responsible for authenticating users and enforcing security policies.

**HTTP Proxy Configuration**

* **Proxy** - refers to the HTTP proxy communication protocol that facilitates routing HTTP requests between a client and the Internet. When selected, you can enter the host and port to be used.

**WinRM Connection**

* **Protocol** - refers to the communication protocol (HTTP or HTTPS) that will be used to access the Windows system.
* **Host** - refers to the host of the system being added.
* **Port** - refers to the port number (Port 5985 by default) used to access the Windows system being added.

6. Provide the account information in the **New Account** screen and click ![](https://docs.itconductor.com/~gitbook/image?url=https%3A%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt%3Dmedia\&width=40\&dpr=4\&quality=100\&sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db) to complete the configuration.

<figure><img src="/files/F26MrwaZNnUVK5o9xGZ6" alt=""><figcaption><p>Figure 3b: New Windows System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the Windows user created aligned with the [Account Requirements](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/domain-user-access).
* **Password** - refers to the password of the previously created Windows user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **Windows Systems** actions panel and check its status.

<figure><img src="/files/Jg8bmPtZ753YM6wXEdob" alt=""><figcaption><p>Figure 4: Newly Added Windows System in Windows Systems Actions Panel Page</p></figcaption></figure>

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **Windows Systems** nod&#x65;**.**

### Monitor Windows System in IT-Conductor

To view the availability and performance metrics of a Windows system, locate the **Windows Systems** node in the service grid.

<figure><img src="/files/IwSsjEfV5TmParQu40t4" alt=""><figcaption><p>Figure 5: Windows Systems View in Service Grid</p></figcaption></figure>

#### **Windows System Key Metrics**

* **Availability** - refers to the operational state and accessibility of the Windows system.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the Windows system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the Windows system.
* **Available Memory** - indicates how much memory is utilized by all the running services and applications in a server.
* **Committed Memory in Use** - refers to the amount of virtual memory that Windows has allocated for all running processes, reflecting active memory demand.
* **Peak Processor Time** - refers to the highest utilization recorded at a specific point in time.
* **Processor Time** - indicates how much processing power is being utilized. The higher the CPU utilization, the more work is being done by the system, and the greater the potential for system instability.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/maldZDRbYk0ECqoKAxqi" alt=""><figcaption><p>Figure 6: Available Memory chart in Service Grid</p></figcaption></figure>

#### **File Systems Utilization Metrics**

File systems are also part of the default monitoring setup upon adding a Windows system in IT-Conductor. The following metrics are automatically tracked for file systems:

* **Free Space %** - refers to the amount of disk space left for use represented in percentage
* **Free Space** - refers to the amount of disk space left for use, megabytes (MB) or gigabytes (GB).
* **I/O Utilization** - Measures the overall input/output activity of the file system, indicating how busy it is with read and write operations.
* **Idle Time** - refers to the percentage of time the file system is not handling any I/O operations, reflecting its inactivity.
* **Read Utilization** - refers to the percentage of time the file system is occupied with read operations, showing how much of the activity involves data reading.
* **Write Utilization** - refers to the percentage of time the file system is occupied with write operations, indicating the activity level involving data writing.

<figure><img src="/files/mxNkeitEL4XjhHJArK8w" alt=""><figcaption><p>Figure 7: File System Metrics</p></figcaption></figure>

#### **Health Explorer**

To view a more detailed analysis of metrics and time-synchronized data, click **Health** in the service grid, and you will be redirected to the **Health Explorer** page.

<figure><img src="/files/C5snmZ8VvGqJVCOg4EPl" alt=""><figcaption><p>Figure 8: Windows Systems Health Explorer</p></figcaption></figure>

#### **Scheduled Maintenance Events**

To view the scheduled maintenance events for monitored Windows systems, click **Events** in the service grid, and a pop-up list of **Scheduled Maintenance Events** will be displayed. You may enlarge the pop-window to find the option to [create a maintenance event](/user-guide/monitoring/general/maintenance-mode/scheduled).

Alternatively, you may click the **Maintenance On** option to set the system on maintenance immediately.

<figure><img src="/files/TeaCbdAZHAIbmu43RYsQ" alt=""><figcaption><p>Figure 9: Creating Maintenance Events</p></figcaption></figure>

#### **Retrievers**

Retrievers deliver all information about a monitored system. Every component or application has a dedicated retriever that can help ensure that each application's state is reported accurately. You may check which retrievers are being monitored by clicking on **Retrievers** on the service grid.

<figure><img src="/files/irNVqhfSGu6aw7NtzeCM" alt=""><figcaption><p>Figure 10: Monitored Retrievers in Windows Systems</p></figcaption></figure>

#### **Application Log**

An application log records events or messages generated by software during its execution. It is typically used for debugging and troubleshooting purposes. To view the logs for the Windows system, click **Application Log** in the service grid, and you will be redirected to a page with a list of all events and their status.

<figure><img src="/files/gMMAYKkaPWQPg55nsLL9" alt=""><figcaption><p>Figure 11: Windows System Application Log</p></figcaption></figure>

### Video

{% embed url="<https://www.youtube.com/watch?v=nNegaDlNUsw>" %}


# WinRM Adapter Configuration

### Configure IT-Conductor WinRM Adapter <a href="#winrmadapterconfiguration-itconductorwinrmadapterconfiguration" id="winrmadapterconfiguration-itconductorwinrmadapterconfiguration"></a>

To allow IT-Conductor to connect to Windows systems, the WinRM must be configured properly.

1. WinRM Adapter Configuration
2. User Privileges

The easiest way to authorize a remote User to access WinRM is to make it a member of the local Administrators group. If granting administrative access is not possible due to a security policy, please follow the procedure to enable monitoring with a non-privileged account:

* [Domain User Access](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/domain-user-access)
* [WMI Namespace access](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/wmi-namespace-access)
* [Windows Service Configuration Manager Access](/user-guide/monitoring/infrastructure/os/windows-system/winrm-adapter-configuration/windows-service-configuration)


# WinRM Services Configuration

Use Domain Group Policy to apply these settings to multiple windows machines.

![Figure 1: Group Policy Management](/files/5u7e4l1qQqP6arXF2X43)

If configuring manually, run the following commands on each monitored machine:

1. Make sure WinRM is enabled. Run the following command:

```
winrm quickconfig
```

![Figure 2: WinRM QuickConfig Command](/files/GU5lSrQdshNMQDtFLJuQ)

2. Enable **AllowUnencrypted**. Run the following command:

```
winrm set winrm/config/service @{AllowUnencrypted="true"}
```

![Figure 3: AllowUncrypted Command](/files/CvzLxo1DlmJkfiZRKRLi)

3. Add **Gateway** host to WinRM trusted hosts. Run the following command:

```
winrm set winrm/config/client @{TrustedHosts="<Gateway Host 1>,<Gateway Host 2>,..."}
```

Please make sure the failover Gateway Host (when configured) is included.

![Figure 4: Add Gateway Host Command](/files/E5ntgJkpPuxAjIIURxEs)

4. Enable **Basic Authentication**. (Optional)

If the monitored Windows host is a standalone computer (not part of a Domain), the Basic authentication must be enabled. Run the following command:

```
winrm set winrm/config/service/auth @{Basic="true"}
```

![Figure 5: Enable Basic Authentication Command](/files/Lm0LpFlrjbJWTIIddVpV)

5. Verify if WinRM is running by opening Services.msc

![Figure 6: Services Window](/files/19qOj8ridCURf2GJhBzG)


# Domain User Access

The easiest way to enable remote user access to WinRM is to add it to the local Administrators group. If granting administrative access is not possible due to a security policy, please follow the procedure to enable monitoring with a non-privileged account.

### Add Domain Account or Group to Local WinRM Accounts <a href="#domainuseraccess-adddomainaccountorgrouptolocalwinrmaccounts" id="domainuseraccess-adddomainaccountorgrouptolocalwinrmaccounts"></a>

The local group membership can be assigned to the Domain Group Policy. Otherwise, follow the instructions below.

1. Open the Computer Management console (compmgmt.msc).
2. Go to Local Users and Groups.
3. Expand Groups.
4. Add the desired domain group or user to Performance Log Users, Performance Monitor Users, and Remote Management Users.

![Figure 1: Computer Management Window](/files/7ssTUNP7Dglkoi8YjtgE)


# WMI Namespace Access

### Configure WMI Namespace Access

WMI Namespace access configuration is not supported in the Domain Group Policy and has to be configured on each monitored machine.

1\. From the Computer Management console, expand **Services and Applications**.

2\. Right-click on **WMI Control** and click **Properties** to access WMI configuration.

![Figure 1: WMI Control Properties](/files/hFrQg9PqGv06dEKJ32hQ)

3\. Open the **Security** tab and select the **CIMV2** namespace.

4\. Click on **Security** to choose which user or group will be granted access.

![Figure 2: WMI Control Properties - Security Tab](/files/rwR8cD6GJhSzmVuFacCS)

5\. In the Security dialog box, click **Add.**

6\. In the Select Users, Computers, or Groups dialog box, enter the object's name (user or group) you want to add and click **OK**.

7\. Click **Advanced** to open the Advanced Security Settings dialog box.

![Figure 3: Advanced Security Settings](/files/7VzvjpA8y4HmgsKNdrZy)

8\. In the **Permissions** tab, select the desired user from the Permissions entries and click **Edit**.

![Figure 4: Advanced Security Settings - Permissions Tab](/files/7ayebdoQwwyFfSCifaNa)

9\. Set the following details:

* **Type** - Set to "Allow".
* **Applies to** - Set to "This namespace and subnamespaces".
* **Permissions** - tick the "Execute Methods", "Enable Account", and "Remote Enable".

![Figure 5: Permission Entry](/files/sPMzOTmkNVhbIokMEtHk)

10\. Click **OK** to close all windows and apply the changed settings.

{% hint style="info" %}
**Note:** See [Authorize WMI users](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-r2-and-2008/cc771551\(v=ws.11\)) and set permissions for more details.
{% endhint %}


# Windows Service Configuration

### Grant User with Windows Service Configuration Manager Access

1. Run a Command Prompt as Administrator, and execute the following command.

```
sc sdset SCMANAGER D:(A;;CCLCRPRC;;;AU)(A;;CCLCRPWPRC;;;SY)(A;;KA;;;BA)S:(AU;FA;KA;;;WD)(AU;OIIOFA;GA;;;WD)
```

![Figure 1: Administrator Command Prompt](/files/xEYT1Iy50evwEmQ1zZFr)

{% hint style="info" %}
**Note:** See [Best practices and guidance for writers of service discretionary access control lists](https://support.microsoft.com/en-us/topic/3cf7240a-86ad-1fc3-bbb6-f468454981c4) for more details.
{% endhint %}


# VMWare vCenter Monitoring

VMWare vCenter is the centralized management platform for vSphere environments, providing a single point of control to monitor the availability and performance of virtualized environments in both cloud and on-prem environments.

Monitoring VMWare vCenter servers helps ensure availability, maintain performance, and optimize resource utilization. Effective monitoring allows administrators to proactively identify and address potential issues before they impact end-users, such as hardware failures, network bottlenecks, or storage constraints.

### Prerequisites

Before configuring a vCenter server for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new vCenter server monitoring account.
2. Grant the user with at least a Read-Only role.

{% hint style="info" %}
**Note:** Perform these steps on the vCenter server to be monitored.
{% endhint %}

### Configure vCenter Server Monitoring in IT-Conductor

To configure vCenter server monitoring in IT-Conductor, follow the instructions below.

#### Add New vCenter Server

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **VMware vCenter Servers** actions panel and click the title to access the complete list.

<figure><img src="/files/EnJvQInikj5Yo32dEKbL" alt=""><figcaption><p>Figure 1: VMWare vCenter Servers Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to start adding a new server instance for monitoring.

<figure><img src="/files/CP1OZhvuSWcvdQLEqhMe" alt=""><figcaption><p>Figure 2: VMWare vCenter Servers Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New vCenter Instance** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the server instance.

<figure><img src="/files/GSE37iF9e9JlKsHBA3JV" alt=""><figcaption><p>Figure 3a: New vCenter Instance Wizard (New vCenter Server Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the server instance being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the server instance will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Scheme** - refers to the communication protocol used to connect to the vCenter server.
* **Host** - refers to the hostname or IP address where the vCenter server is deployed.
* **Connect Timeout** - refers to the maximum time that IT-Conductor will wait while attempting to connect to the vCenter server.
* **Enforce Certificate** - refers to a security setting that requires IT-Conductor to verify the SSL certificate of the vCenter server.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/FCcU2zedUAwzOOddCTKL" alt=""><figcaption><p>Figure 3b: New vCenter Instance Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the server instance being added.
* **Person** - refers to the name of the user who is adding the server instance.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Re-type Password** - refers to the same password provided in the **Password** field.

7. Verify if the server was added to the **VMware vCenter Servers** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click ![](/files/3SXlNMwWxiHcqzkNv3p7) to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the server was added under the **vCenter Servers** nod&#x65;**.**

{% hint style="info" %}
**Note:** The server will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor vCenter Server in IT-Conductor

To view the availability and performance metrics of a vCenter server and its hosts, locate the **vCenter Servers** node in the service grid.

<figure><img src="/files/aipkz6sCsn9jR1VfxCxF" alt=""><figcaption><p>Figure 4: vCenter Servers Node View in Service Grid</p></figcaption></figure>

#### vCenter Server Key Metrics

* **Availability** - refers to the operational state and accessibility of the server instance.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the server, enabling real-time detection of server downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the server instance.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the server instance.

#### VM Hosts Key Metrics

* **Power State** - refers to the operational status of the virtual machine (VM) host.
* **Guest State** - refers to the status of the operating system running inside the VM host.

{% hint style="info" %}
**Note:** All metrics will not show data when a server or a host is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/snmEhy9Wz9WbtWKNzQBg" alt=""><figcaption><p>Figure 5: Guest State &#x26; Power State Monitoring Charts in Service Grid</p></figcaption></figure>

#### Datastores

Datastores are storage containers that provide the underlying storage infrastructure for VM hosts.

To see more information about a specific datastore, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line">. To access the historical view of its storage utilization, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line">.

<figure><img src="/files/2B2Sy6WoXYh7uuV02dM9" alt=""><figcaption><p>Figure 6: Datastore Properties &#x26; Space Used Chart in Service Grid</p></figcaption></figure>


# SAP Monitoring

Managing the operating systems, databases, and SAP applications can be tedious and time-consuming. Monitoring too many systems, servers, and applications can result in data oversights that can cause service disruption and significant loss in the business. An ideal monitoring plan should be considered to ensure the healthy status of the environment. A checklist is a long list of things that must be monitored regularly and manually to guarantee that the business runs optimally.

Having service management that can guarantee the seamless daily performance of the SAP environment is an exceptional help to businesses, customers, and other stakeholders. Since the SAP world is changing quickly, it's not easy to manage the growing demands of different environments. With all the possible struggles in manual monitoring, automation is the best solution to reduce the team's manual effort in doing daily spot checks and mainly prevent downtime and outages that can affect the whole business.

### IT-Conductor's Approach to Automation <a href="#it-conductors-approach-to-automation" id="it-conductors-approach-to-automation"></a>

IT-Conductor is an enterprise-grade IT/SAP Service Management solution in the Cloud providing End-User Experience Monitoring, App & Infrastructure Monitoring, Impact Analysis, Root Cause Analysis, Notification, and IT Process Automation.

IT-Conductor does all the work using cloud-based automation. The platform can discover and display features in a hierarchical view where you can drill up and down the components making up your entire system landscape. You can monitor your SAP systems with a few clicks and a few minutes. It can track critical applications' availability and performance metrics, send alerts in case of performance issues, and generate performance analysis reports.

![Figure 1: Expandable Service Grid Levels by Component](/files/U6CiiWd74cxKMEO42rlS)

Monitoring the system's availability is considered the most basic need. The system's availability ensures that the application, service, or infrastructure component is operational. Performance monitoring consists of the key performance indicators (KPIs) such as CPU/memory/disk utilization, response times, and more that must be tracked and managed. IT-Conductor provides a flexible approach using detailed graphs and charts with data points you can click on for more information and performance analytics.

![Figure 2: Sample Availability Monitoring Chart in IT-Conductor](/files/cJLvyNfETu9CdobNqAhu)

![Figure 3: Service Performance Overview](/files/7sXZwPKOHgs3eCAMLlvQ)

Having lots of data to analyze would be challenging to diagnose when an issue occurs. Defining thresholds for important metrics can help the user to detect exceptions and generate alerts. When the threshold is breached, getting notified of all performance issues will help faster troubleshooting before affecting end-users. IT-Conductor sends out alert notifications via email or SMS, provided the user has subscribed to receive notifications to a particular service. This enables the administrators to find the origin of the problem quickly.

![Figure 4: Sample Alert Chart in IT-Conductor](/files/nFgP9AwYiQRPEgtzqSlw)

Pinpointing and resolving performance issues are more effective and efficient when all the data/metrics required in troubleshooting are time-synchronized. Correlation plays a considerable part in troubleshooting and finding the root cause of the problem. The IT-Conductor platform displays the visual and statistical correlation of data that can help provide valuable information and comparisons between different periods (hourly, daily, weekly, and monthly) can make troubleshooting and root-cause analysis easier.

IT-Conductor lets you define the monitoring capabilities of your system. You can decide what component to prioritize when receiving the warnings/alerts. You can choose which particular condition requires daily checks and notifications. You can also add a role-based subscription to determine who should be notified of what's being impacted.

IT-Conductor can monitor your system's overall health through [Service Health](/overview/monitoring-concepts/application-performance-management). This combines the graphical and detailed view of Availability, Performance, Alerts, and Analytics. Ensuring your SAP Systems are running uninterrupted is critical to your business. Monitoring an SAP system can consume several hours a day; in unexpected cases, issues can occur outside of business hours. IT-Conductor offers real-time system monitoring, looking for signs of potential problems and sending alerts before impacting the business.

### Video <a href="#sapbasischecklistautomation-video" id="sapbasischecklistautomation-video"></a>

{% embed url="<https://www.youtube.com/watch?v=0FlbfYxP_R8>" %}

### Related Information

* [SAP Basis Checklist is Old School](https://www.itconductor.com/blog/sap-monitoring-basis-checklist-is-old-school)


# Business Process Monitoring

Business Process Monitoring refers to the proactive monitoring of an organization's core business processes, including business application logs and messages, business documents, dialog transactions, and background jobs. It also involves monitoring interfaces to ensure seamless data transfer between software components.

Monitoring business processes in IT-Conductor allows users to manage the overall business process performance and identify bottlenecks through cross-system observation of the technical infrastructure and components required to run business processes.

IT-Conductor also allows users to design, create, and manage business process hierarchies using the drag-and-drop [Business Process Composer](/user-guide/monitoring/sap/business-process/composer). This feature streamlines the process of mapping out complex workflows and simplifies the overall business process management.


# Business Process Composer

Business Process Composer is a core feature of IT-Conductor that simplifies business process management by facilitating the mapping of complex business process workflows. It provides a streamlined approach for organizations to visualize and optimize their business operations efficiently.

### Configure Business Process Monitoring Service in IT-Conductor

1. Navigate to **Management → Monitoring → Business Process Monitoring.**

<figure><img src="/files/2n9Z2YtkZkL9gL40I8xQ" alt=""><figcaption><p>Figure 1: Navigating to Business Process Monitoring</p></figcaption></figure>

2. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add a new Business Process Monitoring Service.

<figure><img src="/files/VcVvPeIawq8L1ezeHTSH" alt=""><figcaption><p>Figure 2: Business Process Monitoring Actions Panel</p></figcaption></figure>

3. In the **Create BP Monitoring Service** wizard, fill out all the necessary information. Then click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the service.

<figure><img src="/files/ajzISwJSscVAu4FIYbj7" alt=""><figcaption><p>Figure 3: Create BP Monitoring Service Wizard</p></figcaption></figure>

* **Name** - refers to a unique identifier for the new service being created.
* **Description** - refers to any relevant information about the new service being created.
* **Role** - refers to the environment where the service will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.

4. A pop-up message will confirm that the service has been created successfully. Click **OK** to dismiss.

<figure><img src="/files/rGRaC0lRtE1DWTXAJoaZ" alt=""><figcaption><p>Figure 4: BP Monitoring Service Created Successfully</p></figcaption></figure>

5. The newly added service will appear in the Business Process Monitoring Services list.

<figure><img src="/files/K1vz8b8yC4EK95J4MdEy" alt=""><figcaption><p>Figure 5: Updated Business Process Monitoring Actions Panel</p></figcaption></figure>

6. Click ![](/files/PDxGSQDA9K5neAvJWEo9) to access the Business Process Composer.

<figure><img src="/files/3WdRv7kS3QW36MSpBIOB" alt=""><figcaption><p>Figure 6: Business Process Composer</p></figcaption></figure>

You can create additional containers, or child nodes, within the business process by clicking <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line">

<figure><img src="/files/aMaKyOwBp9b7aENQalkt" alt=""><figcaption><p>Figure 7: Create a Child Node within the Business Process</p></figcaption></figure>

You can also drag existing metrics from the left onto the BP Monitoring nodes on the right. The latter action will seamlessly connect the branches of the service tree to the BP Monitoring tree.

<figure><img src="/files/7RD1ksBHthxj4koRO7Bn" alt=""><figcaption><p>Figure 8: Add existing metrics to the Business Process</p></figcaption></figure>

To disconnect a BP Monitoring service node, click ![](/files/sHZdYeKK9izar9z3OvP3).

To delete a BP Monitoring service node, click ![](/files/IoludZ0JpdrcvJX5Qy39).

{% hint style="info" %}
**Note:** Make sure to associate the newly created service with an appropriate Site. Leaving it empty will show the service under the tenant's root.
{% endhint %}

### Monitor Business Process Monitoring Service in IT-Conductor

To access the monitored metrics of a BP Monitoring service, locate the BP Monitoring node in the service grid.

<figure><img src="/files/YHb3GvytAtXnPNdrYO8N" alt=""><figcaption><p>Figure 9: BP Monitoring Service Node in Service Grid</p></figcaption></figure>

To access a preview of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/PwXSfb5NJUBFm8Yy5A34" alt=""><figcaption><p>Figure 10: Sample Metric Chart Preview in Service Grid</p></figcaption></figure>

To access the historical view of a specific metric, click the chart title, and you will be redirected to a page similar to Figure 9.

<figure><img src="/files/dWDYKG9iL0WLTl9eCuTG" alt=""><figcaption><p>Figure 11: Sample Metric Chart Historical View</p></figcaption></figure>

To access the table view of a specific metric, click ![](/files/U2N5MH1XpmfKKpJHLT9e) and you will be redirected to a page similar to Figure 10.

<figure><img src="/files/cnQihOb2MbMaPZKC8Z75" alt=""><figcaption><p>Figure 12: Sample Metric Table View</p></figcaption></figure>

To compare two metric charts using different time step scales, click ![](/files/WzDAXtnBKgmyxuNrrb7D) and you will be redirected to a page similar to Figure 11.

<figure><img src="/files/YydI15CTmUSNVSKHyKJd" alt=""><figcaption><p>Figure 13: Sample Metric Comparison Mode View</p></figcaption></figure>


# BDoc Monitoring

BDocs, short for Business Documents, serve as containers for the data that constitute a business process, such as application messages or transactions. It is a concept specific to the SAP Customer Relationship Management (CRM) system.

BDoc messages are internally transmitted within the CRM Server, facilitating communication between the CRM Application and the CRM Middleware, as well as between the CRM Server and CRM Mobile Clients, also known as Field Applications.

SAP ERP does not incorporate the concept of BDocs, thus preventing the exchange of BDoc messages between an SAP ERP system and SAP CRM. Instead, business data is encapsulated within containers when utilizing BAPI calls. Consequently, when exchanging data with SAP ERP, there are indeed outbound and inbound BDoc messages within the CRM Server, specifically to interact with the inbound and outbound ERP (R/3) adapters.

### Configure BDoc for Monitoring <a href="#configure-bdoc-for-monitoring" id="configure-bdoc-for-monitoring"></a>

1. In the IT-Conductor Service Grid, navigate to the system where you want to enable BDoc monitoring. Then click the object menu of the system.

<figure><img src="/files/zYxR34hy78rPD6JEJ8Yi" alt=""><figcaption><p>Figure 1: Select Object Menu of SAP System in IT-Conductor Service Grid</p></figcaption></figure>

2. In the object menu, click **Retrievers**.

<figure><img src="/files/ZgQ63R4IFvFEwXij0g68" alt=""><figcaption><p>Figure 2: Select Retrievers in Object Menu</p></figcaption></figure>

3. In the Retrievers list, click the object menu of BDoc Errors. Then click **Activate**.

<figure><img src="/files/g0gkuVP4zGsf7ELpBhEZ" alt="" width="375"><figcaption><p>Figure 3: Activate BDoc Errors</p></figcaption></figure>

4. Navigate to the system in the IT-Conductor Service Grid and expand the BDocs node to view the monitored object.

<figure><img src="/files/gyyZrSNovq26angITgBQ" alt=""><figcaption><p>Figure 4: BDocs Monitoring in IT-Conductor</p></figcaption></figure>

You also have the option to view BDocs in-error directly from the service grid.


# IDoc Monitoring

IDocs, short for Intermediate Document, serve as standardized containers for the exchange of data between applications. Within SAP applications, this data interchange is facilitated through the Application Link Enabling (ALE) layer, which, in turn, employs either tRFC or File technology as its underlying methods.

A single IDoc contains different types of information, such as application data intended for exchange (e.g., sales order) and technical data including source and target information. IDocs also contain status information that shows the current processing stage of the data exchange.

### Configure IDoc for Monitoring <a href="#configure-idoc-for-monitoring" id="configure-idoc-for-monitoring"></a>

1. In the IT-Conductor Service Grid, select the system where you want to enable IDoc monitoring.

<figure><img src="/files/Xk9L2f0pe3fQvAcfWd0Y" alt=""><figcaption><p>Figure 1: Select SAP System in IT-Conductor Service Grid</p></figcaption></figure>

2. Click **IDoc Monitors** from the available tools as shown in Figure 2.

<figure><img src="/files/DYOuorMCF0aLbprjAYnC" alt=""><figcaption><p>Figure 2: Select IDoc Monitors</p></figcaption></figure>

3. Click the **Create new IDoc Error Monitor** icon to create a new object and add monitoring for a new message type.

<figure><img src="/files/5PmkKSUQFPnvsX0ouiy7" alt="" width="563"><figcaption><p>Figure 3: Create New IDoc Error Monitor Icon</p></figcaption></figure>

4. In the New IDoc Error Monitor wizard, fill out the “Message Type” field. Then click the **Create new SAP IDoc Error Count Retriever** icon to save.

<figure><img src="/files/4w4MwlrFxY2HQbDBlc8N" alt=""><figcaption><p>Figure 4: New IDoc Error Monitor Wizard</p></figcaption></figure>

A new retriever is generated, and the message type is appended to the defined name.

<figure><img src="/files/jZ1i6HDXapFOv7ZxgVNb" alt=""><figcaption><p>Figure 5: IDoc Monitors List</p></figcaption></figure>

5. Navigate to the system in the IT-Conductor Service Grid to view the monitored object.

<figure><img src="/files/Ve6u3swpZkwB0MeD1rX8" alt=""><figcaption><p>Figure 6: IDocs Monitoring in IT-Conductor</p></figcaption></figure>

You also have the option to view In-Error IDoc Count for specific message types directly from the service grid.


# SAP BusinessObjects Monitoring

SAP BusinessObjects (BOBJ) is a suite of business intelligence (BI) tools and applications designed to help businesses analyze data and make well-informed decisions. These tools encompass a range of functionalities, including reporting, dashboards, data visualization, and data exploration, which collectively enable users to derive insights from their data assets.

Monitoring SAP BOBJ helps maintain the reliability, performance, and security of BI platforms. By continuously monitoring the SAP BOBJ environment, organizations can proactively identify and address potential issues that may impact system availability, responsiveness, or data integrity.

### Prerequisites

Before configuring an SAP BOBJ system for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new SAP BOBJ monitoring account.
2. Assign it to the standard "Monitoring Users" user group and "Everyone" group.

{% hint style="info" %}
**Note:** Perform these steps on the SAP BOBJ system.
{% endhint %}

### Configure SAP BusinessObjects Monitoring in IT-Conductor

To configure SAP BOBJ monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP BOBJ System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **BusinessObjects Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/HcvyuJtyieGiE813Jscf" alt=""><figcaption><p>Figure 1: BusinessObjects Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New BusinessObjects System** button to start adding a new system for monitoring.

<figure><img src="/files/BWJ5kaithzDhCIjbzAJc" alt=""><figcaption><p>Figure 2: BusinessObjects Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New BusinessObjects System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/bL4gL7HblocFMAOA7C9X" alt=""><figcaption><p>Figure 3a: New BusinessObjects System Wizard (New BI System Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Auth Type** - refers to the authentication type to be used to access the BOBJ system.
* **Availability Ping** - refers to the mechanism used to check the availability of the BOBJ system.

6. Provide the account information in the **New Account** screen and click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/pXITazHDI7XCvyH4hJMm" alt=""><figcaption><p>Figure 3b: New BusinessObjects System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **Authentication Type** - refers to the authentication type to be used to access the BOBJ system.
* **Domain** - refers to a logical group that contains one or more BOBJ servers and services. Specify the System ID value in this field.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7\. Verify if the system was added to the **BusinessObjects Systems** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8\. Navigate to the service grid and verify if the system was added under the **BusinessObjects Systems** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

#### Activate Job Executions Retriever

In IT-Conductor, you need to activate Job Executions first before creating threshold overrides. Once activated, follow the instructions in [Create Threshold Overrides](#create-threshold-overrides).

1. Select the BOBJ system in the service grid, then click **Retrievers**. You will be redirected to a page listing all available BOBJ retrievers.

<figure><img src="/files/SRfCDQypZmQ3NS0yCKrU" alt=""><figcaption><p>Figure 4: BOBJ Retrievers Option in Service Grid</p></figcaption></figure>

2. Click **Job Executions** in the list of retrievers.

<figure><img src="/files/eQ7FbzwBuzrG7Z1Q7tdL" alt=""><figcaption><p>Figure 5: BOBJ Retrievers List</p></figcaption></figure>

3. Click <img src="/files/kNSqI7TzNH2Q52cjm1fT" alt="" data-size="line"> to activate the **Job Executions** retriever.

<figure><img src="/files/nuK3MmnjqpoRDkDCPZvG" alt=""><figcaption><p>Figure 6a: Modify Jobs Executions Page (Inactive)</p></figcaption></figure>

<figure><img src="/files/4FmtAIi2yLbjjQObEDEy" alt=""><figcaption><p>Figure 6b: Modify Jobs Executions Page (Activated)</p></figcaption></figure>

#### Create Threshold Overrides

In IT-Conductor, you can create threshold overrides with or without a template.

{% hint style="info" %}
**Note:** Ensure **Job Executions** retriever is activated. See [Activate Jobs Executions Retriever](#activate-job-executions-retriever) and follow the instructions if it has not been activated yet.
{% endhint %}

1. Navigate back to the BOBJ system in the service grid and select **Failed Jobs**. Then click ![](/files/f5a49vZ21KKXgnl6cyde) on the **Failed Jobs** page. You will be redirected to the **Failed Jobs Overrides** page.

<figure><img src="/files/AjONCYmUzvJvgQyvUidf" alt=""><figcaption><p>Figure 7: Create Threshold Override from Failed Jobs Page</p></figcaption></figure>

2. To create an override without a template, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> on the **Failed Jobs Overrides** page.

<figure><img src="/files/Ns4dPgdkOoru3jxDFKQL" alt=""><figcaption><p>Figure 8: Failed Jobs Overrides (Create Override Without Template)</p></figcaption></figure>

3. Fill out all the necessary information on the **Create New Override for Failed Jobs** page. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create the new override.

<figure><img src="/files/SDZgDeT7C6KXGJd41uSj" alt=""><figcaption><p>Figure 9: Create New Override for Failed Jobs</p></figcaption></figure>

* **Name -** refers to the identifier assigned to the override configuration.
* **Description** - refers to any details about the purpose or functionality of the override.
* **Target Object Class** - refers to the specific type or class of object to which the override settings will apply.
* **Application Role** - refers to the application environment where the override will be used.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Object Criteria** - refers to specific conditions or criteria used to target and apply the override.
* **Value Attribute** - refers to a specific parameter or attribute associated with an object that can be modified or overridden.
* **Comments** - refers to any additional notes, explanations, or contextual information related to the override.
* **Scheduling** - refers to the specific time frame during which the threshold override is in effect. You can either select a pre-defined schedule under the **Schedule** dropdown menu or select specific days and define the **Start** and **End** times.
* **Aggregation Interval** - refers to a specific period or interval used for consolidating data or events within the BOBJ system.
* **Consecutive Interval** - refers to a specific period during which a series of events or conditions occur continuously without interruption or gaps.
* **Aggregation** - refers to the aggregation method to calculate the key metrics or statistics from collected data.
* **Warning Value** - refers to the **Warning** limit or threshold set for the override configuration. If selected in the **Alert On** field, this metric will be utilized.
* **Alarm Value** - refers to the **Alarm** limit or threshold set for the override configuration. If selected in the **Alert On** field, this metric will be utilized.
* **Reset After** - refers to the number of minutes after which an active alert will automatically reset or clear once the triggering condition is no longer present.
* **Alert On -** refers to the setting that prompts the system to issue an alert when the **Warning Value** or the **Alarm Value** is met or exceeded.
* **Recovery On** - refers to the setting that prompts the system to restore normal operation after the **Warning Value** or the **Alarm Value** falls below the specified thresholds.

4. To create an override using a template, click <img src="/files/wS9sqbJBt80uwBS1qL1n" alt="" data-size="line"> on the **Failed Jobs Overrides** page.

<figure><img src="/files/LdCcxx3bV6JAHF2REoLW" alt=""><figcaption><p>Figure 10: Failed Jobs Overrides (Create Override Using a Template)</p></figcaption></figure>

5. Select the override template you want to copy on the **Failed Jobs Threshold Default Settings Templates** page.

<figure><img src="/files/5oYAbZatjXpjwrsywUtx" alt=""><figcaption><p>Figure 11: Failed Jobs Threshold Default Settings Templates</p></figcaption></figure>

6. Modify the parameters to match your specific requirements, then click ![](/files/7y7XLw4Pq9rZ6qwlkvIp) to save.

<figure><img src="/files/UJrhHfYGpmMdXmPscuvI" alt=""><figcaption><p>Figure 12: Threshold Override Template</p></figcaption></figure>

### Monitor SAP BusinessObjects System in IT-Conductor <a href="#monitoring-sap-businessobjects-in-it-conductor" id="monitoring-sap-businessobjects-in-it-conductor"></a>

To view the availability and performance metrics of a SAP BOBJ system, locate the **BusinessObjects Systems** node in the service grid.

<figure><img src="/files/N9uk0HRisdPi06aOLLSF" alt=""><figcaption><p>Figure 13: BusinessObjects Systems View in Service Grid</p></figcaption></figure>

#### SAP BusinessObjects Systems Key Metrics <a href="#businessobjects-systems-key-metrics" id="businessobjects-systems-key-metrics"></a>

* **Availability** - refers to the operational state and accessibility of the BOBJ system.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the BOBJ system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the BOBJ system.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/nHfPKyEkUEhEnuzb2UrA" alt=""><figcaption><p>Figure 14: Heartbeat Chart in Service Grid</p></figcaption></figure>

#### Authentication <a href="#authentication" id="authentication"></a>

Authentication in SAP BOBJ is critical for ensuring data security, regulatory compliance, and user access control. Organizations can protect sensitive information, prevent unauthorized access, and enforce security policies across their BI environment by effectively authenticating users.

To view more information about the authentication mode, click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line">.

<figure><img src="/files/rOafJcEgwMEPXl9S7HaB" alt=""><figcaption><p>Figure 15: BOBJ Authentication View in Service Grid</p></figcaption></figure>

#### Connections <a href="#connections" id="connections"></a>

BusinessObjects rely on connections to the backend or data universes. If you are connected to any SAP system, it will automatically associate with the application in the service grid. You can track performance metrics from the backend system since they provide data to the BOBJ environment and impact the service.

<figure><img src="/files/oQM1kU4K1eTZDnb7SGr9" alt=""><figcaption><p>Figure 16: BOBJ Connections View in Service Grid</p></figcaption></figure>

#### Crypto Keys <a href="#crypto-keys" id="crypto-keys"></a>

Crypto keys are essential components of security infrastructure within SAP BOBJ, playing a crucial role in protecting data, securing communications, and verifying the identity and integrity of users and resources within the BI environment.

<figure><img src="/files/KrEqAZg9opTkdLtn6rJs" alt=""><figcaption><p>Figure 17: Crypto Keys View in Service Grid</p></figcaption></figure>

#### Enterprise Nodes <a href="#enterprise-nodes" id="enterprise-nodes"></a>

You may have one or more enterprise nodes in a cluster. Each node contains server-processing services such as Adaptive Job Server, Adaptive Processing Server, and Web Intelligence.

<figure><img src="/files/eYo889UljJZbQGyZHNrJ" alt=""><figcaption><p>Figure 18: BOBJ Enterprise Nodes View in Service Grid</p></figcaption></figure>

#### Failed Jobs <a href="#failed-jobs" id="failed-jobs"></a>

Failed Jobs refers to the number of jobs that failed on the server. IT-Conductor monitors failed job executions in BOBJ by querying for scheduled jobs that couldn't be completed within a specific period.

<figure><img src="/files/cLkXLymk0Hh1LJiPvzoW" alt=""><figcaption><p>Figure 19: Monitor Failed Jobs Chart &#x26; Failed Jobs View in Service Grid</p></figcaption></figure>

<figure><img src="/files/lTPezqyECwuzjQOxKTYz" alt=""><figcaption><p>Figure 20: Failed Jobs Page</p></figcaption></figure>

{% hint style="info" %}
**Note:** To enable this feature, activate the **Jobs Executions** retriever in IT-Conductor. See [Activate Jobs Executions Retriever](#activate-job-executions-retriever) for more details.
{% endhint %}

#### License Keys <a href="#license-keys" id="license-keys"></a>

License keys monitor the expiration of the BOBJ SAP license and their quota of number/types of users.

<figure><img src="/files/0fWxGxFLJzuPDWUEI3PQ" alt=""><figcaption><p>Figure 21: BOBJ License Keys View in Service Grid</p></figcaption></figure>

#### Probes <a href="#probes" id="probes"></a>

Probes are where you can schedule probes to run at specified intervals. The probes often ping different services to ensure the service is up and responding.

<figure><img src="/files/hI36AQrsKHBvtb6j8cm7" alt=""><figcaption><p>Figure 22: BOBJ Probes View in Service Grid</p></figcaption></figure>

#### Health Explorer <a href="#health-explorer" id="health-explorer"></a>

To view a more detailed analysis of metrics and time-synchronized data, click **Health** in the service grid, and you will be redirected to the **Health Explorer** page.

<figure><img src="/files/JO4S7FAmNwnzQ2XJl6YJ" alt=""><figcaption><p>Figure 23: BOBJ Health Explorer</p></figcaption></figure>

### Video <a href="#sapbusinessobjects-bobj-monitoring-video" id="sapbusinessobjects-bobj-monitoring-video"></a>

{% embed url="<https://www.youtube.com/watch?t=2653s&v=D19XYfcrF7g>" %}

{% embed url="<https://player.vimeo.com/video/258886890?h=164bb5dd1e>" %}

### Related Information <a href="#sapbusinessobjects-bobj-monitoring-step-by-stepguide" id="sapbusinessobjects-bobj-monitoring-step-by-stepguide"></a>

* [SAP BO Data Services Monitoring](/user-guide/monitoring/sap/businessobjects/data-services)
* [BusinessObjects Monitoring is Tricky but These Resources Should Help](https://www.itconductor.com/blog/businessobjects-monitoring-is-tricky-but-these-resources-should-help)


# SAP BO Data Services Monitoring

SAP BusinessObjects Data Services (BODS) monitoring helps organizations analyze dataflow execution information (trace, monitor, and error logs) and get detailed information from job executions from different repositories for batch and real-time jobs.

### Prerequisites

Before configuring an SAP BODS system for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new SAP BODS monitoring account.
2. Assign it to the standard "Data Services Monitor Users" user group and "Everyone" group.

{% hint style="info" %}
**Note:** Perform these steps on the SAP BODS system.
{% endhint %}

### Configure SAP BusinessObjects Data Services Monitoring in IT-Conductor

To configure SAP BODS monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP BODS System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **BusinessObjects Data Services Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/ar39OzDwkhRKX7XdNa4d" alt=""><figcaption><p>Figure 1: BusinessObjects Data Services Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New BO Data Services System** button to start adding a new system for monitoring.

<figure><img src="/files/uhUYevoEf4erK0AmVexX" alt=""><figcaption><p>Figure 2: BusinessObjects Data Services Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New BusinessObjects System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/0jkDyOQGwXJWO3tB6c6Z" alt=""><figcaption><p>Figure 3a: New BO Data Services System Wizard (New BO Data Services Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](/user-guide/setup/gateway-setup) for more details.
* **Timeout** - refers to the maximum time IT-Conductor will attempt to establish a connection to the host agent (300 seconds by default).
* **Proxy** - refers to the HTTP proxy communication protocol used to facilitate the routing of HTTP requests between a client and the Internet. When selected, you can enter the host and port to be used.
* **Protocol** - refers to the method used for communication between IT-Conductor and the BODS system.
* **Host** - refers to a server or client host where the BODS system is installed and running.
* **Port** - refers to the port number used for the communication between IT-Conductor and the BODS system. Use \<host name>:\<port> notation with the port typically set to 6400.
* **BO CMS** - stands for BusinessObjects Central Management Server and contains the configuration and operation information of the BODS system.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/Wdg8NcwWWFd5KWtcQYVA" alt=""><figcaption><p>Figure 3b: New BO Data Services System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **Authentication Type** - refers to the authentication type to be used to access the BODS system.
* **CMS System** - refers to the server that contains the configuration and operation information of the BODS system.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **BusinessObjects Data Services Systems** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **BusinessObjects Systems** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes. BODS systems are currently monitored as part of the BusinessObjects node. There is no standalone BODS node dedicated to the newly added BODS system.
{% endhint %}

### Monitor SAP BusinessObjects Data Services in IT-Conductor

To view the availability and performance metrics of an SAP BODS system, locate the **BusinessObjects Systems** node in the service grid and then **Data Services**.

<figure><img src="/files/Df2V7MON8zS03Ur0ZATv" alt=""><figcaption><p>Figure 4. SAP BusinessObjects Data Services View in Service Grid</p></figcaption></figure>

#### SAP BusinessObjects Data Services Key Metrics

IT-Conductor allows monitoring of the following BODS components:

* **Batch Jobs:** View, trace, and monitor error logs for failed jobs. See [Activate Job Executions Retriever](/user-guide/monitoring/sap/businessobjects#activate-job-executions-retriever) for instructions on enabling batch job monitoring.
* **BODS Server**: View metrics of the BODS Server. See [BusinessObjects Systems Key Metrics](/user-guide/monitoring/sap/businessobjects#businessobjects-systems-key-metrics) for more details.
* **Access Server and Client Interface**: Monitor the status of the RFC Connections. Identify why remote connections might be broken and get the status of the configured Access Server.
* **Repositories and Job Server**: Monitor if the Job Server is enabled or disabled and get notifications about failed jobs.
* **RFC Servers**: Monitor the connection status of the RFC Connections for batch jobs.

### Related Information

* [SAP BusinessObjects Monitoring](/user-guide/monitoring/sap/businessobjects)


# SAP Cloud Connector Monitoring

Monitoring the SAP Cloud Connector ensures its availability and timely detection of performance bottlenecks. This facilitates proactive issue resolution, resource optimization, and alignment of the SAP Cloud Connector application with user expectations.

### Prerequisites

Before configuring an SAP BODS system for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements <a href="#account-requirements" id="account-requirements"></a>

1. Create a new SAP Cloud Connector monitoring account.
2. Assign it with its appropriate authorization level as defined below.

| Role          | Technical Role Name | Authorization                    |
| ------------- | ------------------- | -------------------------------- |
| Administrator | admin or sccadmin   | All operations                   |
| Support       | sccsupport          | Edit log and trace configuration |
| Display       | sccdisplay          | Read configuration               |
| Monitoring    | sccmonitoring       | Read monitoring information      |

### Configure SAP Cloud Connector for Monitoring in IT-Conductor <a href="#configure-sap-cloud-connector-for-monitoring-in-it-conductor" id="configure-sap-cloud-connector-for-monitoring-in-it-conductor"></a>

To configure SAP Cloud Connector monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP Cloud Connector <a href="#add-new-sap-cloud-connector" id="add-new-sap-cloud-connector"></a>

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **SAP Cloud Connectors** actions panel and click the title to access the complete list.

<figure><img src="/files/TlzkL9OIbCyeW1Ze1ssU" alt=""><figcaption><p>Figure 1: SAP Cloud Connectors Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to start adding a new connector for monitoring.

<figure><img src="/files/lBJZQXvWDGso3a5kaGbv" alt=""><figcaption><p>Figure 2: SAP Cloud Connectors Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New SAP Cloud Connector** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the connector.

<figure><img src="/files/x5M8JwgclI8Q32yaLJuO" alt=""><figcaption><p>Figure 3a: New SAP Cloud Connector Wizard (New Cloud Connector Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the connection being created.
* **Organization** - refers to an administrative structure defining objects with a common goal or purpose.
* **Role** - refers to the environment where the connection will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform.
* **Scheme** - refers to the web protocol to be used.
* **Host** - refers to the host of the cloud connector server.
* **Connection Timeout** - refers to the maximum time IT-Conductor will attempt to establish a connection to Cloud Connector (300 seconds by default).

6. Provide the new account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/7aJrz5U4JW42nOJisZzo" alt=""><figcaption><p>Figure 3b: New SAP Cloud Connector Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the account being created.
* **Application** - refers to the Cloud Connector instance created in Step 3.
* **Person** - refers to the name of the user who is adding the connector.
* **User Name** - refers to the user with the “Administrator” role as listed in [Account Requirements](#inlineextension-account-requirements).
* **User Password** - refers to the password of the user.
* **Re-type Password** - refers to the same password provided in the **User Password** field.

7. Verify if the connector was added to the **SAP Cloud Connectors** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **SAP Cloud Connectors** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor SAP Cloud Connector in IT-Conductor <a href="#monitoring-sap-cloud-connector-in-it-conductor" id="monitoring-sap-cloud-connector-in-it-conductor"></a>

To view the availability and performance metrics of a SAP Cloud Connector, locate the **SAP Cloud Connector** node in the service grid.

<figure><img src="/files/wHDpxbR4Rv9Nr1ErqUi8" alt=""><figcaption><p>Figure 4: SAP Cloud Connector View in Service Grid</p></figcaption></figure>

#### SAP Cloud Connector Key Metrics <a href="#sap-cloud-connector-key-metrics" id="sap-cloud-connector-key-metrics"></a>

* **Availability** - refers to the operational state and accessibility of the SAP Cloud Connector instance.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Memory: Heap Total** - refers to the total amount of heap memory allocated to the SAP Cloud Connector process.
* **Memory: Physical Free** - refers to the amount of physical memory that is currently available and unused.
* **Memory: Physical Used** - refers to the amount of physical memory currently utilized by the system.
* **Missing Account** - shows if the SAP Cloud Connector has a missing or wrong account configured in ITC.
* **Retriever Failures** - shows if ITC failed to retrieve SAP Cloud Connector data.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252F5WqsRtSeSZXYOiW2YXbk%252Fmetric-history-icon.gif%3Falt=media%26token=ef41e39f-428e-4fbd-9d2f-ac6da2caa19c&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=7ed0177f7265e0f4a0f645927183092b94d564d0906ed254a3d77bb886709c75" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/KOAswsY433zi7e52sTfK" alt=""><figcaption><p>Figure 5: SAP Cloud Connector Availability Chart in Service Grid</p></figcaption></figure>

#### Sub-Accounts in Service Grid <a href="#sub-accounts-in-service-grid" id="sub-accounts-in-service-grid"></a>

The expanded view of sub-accounts displays the sub-accounts associated with the Cloud Connector.

<figure><img src="/files/d1spm1Luq8DiBMRueKLE" alt=""><figcaption><p>Figure 6: SAP Cloud Connector Sub-accounts in Service Grid</p></figcaption></figure>

Expand further into the sub-account to view the **Certificate**, **Cloud to On-Prem** and **On-Prem to Cloud** virtual hosts, and **Tunnels**.

<figure><img src="/files/9y7iatyRl1ekTKojZyY1" alt=""><figcaption><p>Figure 7: Sub-account Certificate, Virtual Hosts, and Tunnels in Service Grid</p></figcaption></figure>

#### Sub-Accounts Key Metrics <a href="#sub-accounts-key-metrics" id="sub-accounts-key-metrics"></a>

* **Certificate Days to Expiration** - refers to the number of days remaining before a certificate expires.
* **Virtual Host and Resource Calls**
  * **Calls** - refers to the total number of calls or requests.
  * **Received** - refers to the total number of bytes received through a call or request.
  * **Calls Sent** - refers to the total number of bytes sent back as a response.
* **Tunnel State** - refers to the connection state of the tunnel. The state is either Connected, ConnectFailure, or Disconnected.

<figure><img src="/files/6VEJRgDdDcrpwt6LNDWt" alt=""><figcaption><p>Figure 8: SAP Cloud Connector Monitored Metrics for Sub-Accounts</p></figcaption></figure>

### Video

{% embed url="<https://youtu.be/HcuEGlT_fLw>" %}


# SAP Host Agent Monitoring

In a standard SAP environment, the SAP Host Agent monitors operating systems (OS), databases, system instance control, and SAP applications. IT-Conductor provides additional monitoring capabilities, including SAP Host Agent monitoring for services such as Access Points, Enqueue/Locks, and Process States, as well as SMTP monitoring to verify email connectivity and availability. This monitoring includes message servers, web dispatchers, gateways, and error logs such as SAP Gateway logs and SAP Message Server logs.

We can easily monitor the status and availability of the services and applications in real time to determine if the system and its components are up and running and get notified in case of failure. The state and status of the App Server and Host Agent levels are also available. This allows for checking the availability of the database and the application server.

### Prerequisites

Before configuring an SAP host agent for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a user account and ensure that it is added to the specified groups:

* **Linux/Unix Servers:** sapsys group
* **Windows Servers:** SAP\_LocalAdmin group

{% hint style="info" %}
**Note:**

* Perform these steps on the server where you installed the gateway. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* IT-Conductor uses web services provided by the SAP host agent, which are protected and can only be used by an authenticated caller (see [SAP Note 927637](https://launchpad.support.sap.com/#/notes/0000927637)).
  {% endhint %}

2. Perform the following instructions for all hosts to be monitored to authorize users to access SAP host agent services.

{% hint style="info" %}
**Note:** For Linux/Unix users, do this after ensuring that the executable \<DIR\_EXECUTABLE>/sapuxuserchk has 4750 permission.
{% endhint %}

**For All Instances in a Host**

{% hint style="info" %}
**Note:** Only needed if not using adm; we recommend sapadm or daaadm.
{% endhint %}

a. Open the file:

{% tabs %}
{% tab title="Linux/Unix" %}
/usr/sap/hostctrl/exe/host\_profile
{% endtab %}

{% tab title="Windows" %}
C:\Program Files\SAP\hostctrl\exe\host\_profile
{% endtab %}
{% endtabs %}

b. Add the `service/admin_users` parameter with the following values (separated by a blank space):

{% tabs %}
{% tab title="Linux/Unix" %}
service/admin\_users = \<user1> \<user2>
{% endtab %}

{% tab title="Windows" %}
service/admin\_users = \[domain]\<user1> \[domain]\<user2>
{% endtab %}
{% endtabs %}

c. Restart SAP Host Agent with:

{% tabs %}
{% tab title="Linux/Unix" %}
/usr/sap/hostctrl/exe/saphostexec -restart
{% endtab %}

{% tab title="Windows" %}
C:\Program Files\SAP\hostctrl\exe\saphostexec.exe -restart
{% endtab %}
{% endtabs %}

d. Log on with the OS user to be checked and execute:

```
sapcontrol -prot GSOAP_HTTP -nr -user "<User Name>" "<User Password>" -function AccessCheck <function>
```

where `function` in IT-Conductor include:

* `GetAccessPointList`
* `GetProcessList`
* `GetEnvironment`
* `GetInstanceProperties`
* `ABAPGetWPTable`
* `GetSystemInstanceList`
* `GetQueueStatistic`
* `GetAlertTree`
* `GetAlerts`
* `EnqGetStatistic`
* `EnqGetLockTable`
* `ICMGetProxyConnectionList`
* `ICMGetCacheEntries`
* `ICMGetThreadList`
* `WebDispGetServerList`
* `WebDispGetGroupList`
* `WebDispGetVirtHostList`

**For the SAP Instance only (Recommended):**

a. Open the SAP instance profile "\<DIR\_INSTALL>/profile/DEFAULT.PFL".

b. Add the following parameters:

```
service/admin_users = <sid>adm daaadm sapadm service/protectedwebmethods = -GetAccessPointList -GetProcessList -GetEnvironment -GetInstanceProperties -ABAPGetWPTable -GetSystemInstanceList -GetQueueStatistic -GetAlertTree -GetAlerts -EnqGetStatistic -EnqGetLockTable -ICMGetThreadList -ICMGetConnectionList -ICMGetProxyConnectionList -ICMGetCacheEntries -WebDispGetServerList -WebDispGetVirtHostList -J2EEGetProcessList -J2EEGetProcessList2 -J2EEGetThreadList -J2EEGetThreadList2 -J2EEGetCacheStatistic -J2EEGetCacheStatistic2 -J2EEGetWebSessionList - J2EEGetWebSessionList2 -J2EEGetEJBSessionList -J2EEGetRemoteObjectList -J2EEGetSharedTableInfo -J2EEGetVMHeapInfo
```

c. Restart the relevant "sapstartsrv", this will restart your SAP system, so please make sure you can do it during maintenance.

{% hint style="info" %}
**Note:** For Linux root users, restart the relevant "sapstartsrv" process for the sap instance using: "systemctl restart sapinit", which requires an SAP downtime, so make sure to do it during maintenance.
{% endhint %}

### Configure SAP Host Agent Monitoring in IT-Conductor

To configure SAP Host Agent monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP Host Agent

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **SAP Host Agents** actions panel and click the title to access the complete list.

<figure><img src="/files/fpKGhT9DScqUHBMkCDlJ" alt=""><figcaption><p>Figure 1: SAP Host Agents Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New SAP Host Agent** button to start adding a new agent for monitoring.

<figure><img src="/files/nXHgO5H27BNFm2F7ROwa" alt=""><figcaption><p>Figure 2: SAP Host Agents Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New SAP Host Agent** wizard. Once completed, click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to add the agent.

<figure><img src="/files/SkvVjtDccyBj0ik86w1f" alt=""><figcaption><p>Figure 3a: New SAP Host Agent Wizard (New Host Agent Screen)</p></figcaption></figure>

* **Description** - refers to a descriptive title about the host agent being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role** - refers to the environment where the host agent will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. Select the previously configured gateway from the dropdown menu. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **Timeout** - refers to the maximum time IT-Conductor will attempt to establish a connection to the host agent (300 seconds by default).
* **Proxy** - refers to the HTTP proxy communication protocol used to facilitate the routing of HTTP requests between a client and the Internet. When selected, you can enter the host and port to be used.
* **SID -** refers to a unique identifier for a specific SAP system instance.
* **Host Name** - refers to a unique name assigned to the server where the SAP system is installed.
* **System Number** - a two-digit identifier assigned to an SAP instance (or application server) within an SAP system landscape.

6. Provide the account information in the **New Account** screen and click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252Fgit-blob-7f816831472c5030e6dfbcb513035d87da645a67%252Fadd.png%3Falt=media&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=e691117173a2adddeb4af6cbe6c2cd5535f4de6b5205247208ca52eb94ee71db" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/NK8ZPXGeNkXJuNn3ajGf" alt=""><figcaption><p>Figure 3b: New SAP Host Agent Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the application account owner within IT-Conductor
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Retype Password** - refers to the same password provided in the **Password** field.

7. Verify if the agent was added to the **SAP Host Agents** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **SAP Host Agents** nod&#x65;**.**

{% hint style="info" %}
**Note:** The agent will appear in the service grid within 5-15 minutes.
{% endhint %}

### **Monitor SAP Host Agent Services in IT-Conductor** <a href="#monitor-sap-host-agent-in-it-conductor" id="monitor-sap-host-agent-in-it-conductor"></a>

To view the associated availability and performance metrics of the associated SAP components, locate the **SAP Host Agents** node in the service grid.

<figure><img src="/files/7S5stSOE6EwqInDJTY1r" alt=""><figcaption><p>Figure 4: SAP Host Agents View in Service Grid</p></figcaption></figure>

#### SAP Host Agents Key Metrics

* **Availability** - refers to the operational state and accessibility of the host agent.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the host agent.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the host agent.
* **Error log** - records system issues, failures, or abnormal activities, providing critical details for diagnosing and resolving host-level problems in SAP environments.
* **Process State** - refers to the current condition or status of a particular process running on a host where the SAP Host Agent is installed.
* **Process Status** - indicates whether the process is running normally, stopped, encountering errors, or in any other state relevant to its operation.
* **Access points -** refer to the HTTPS protocol's host and port information. This information is used to discover whether the access port is active (Collection is disabled by default).
* **Enqueue** - also known as the Lock server, refers to an SAP system component that manages the Lock Tables. The table is locked to prevent multiple record modifications simultaneously and ensure data consistency.
* **ICM** - stands for Internet Communication Manager and refers to the SAP component responsible for managing communication between SAP systems and external clients, including HTTP and HTTPS traffic.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="https://docs.itconductor.com/~gitbook/image?url=https:%2F%2F377464071-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FXhp08OmU8050PePmMgDt%252Fuploads%252F5WqsRtSeSZXYOiW2YXbk%252Fmetric-history-icon.gif%3Falt=media%26token=ef41e39f-428e-4fbd-9d2f-ac6da2caa19c&#x26;width=40&#x26;dpr=4&#x26;quality=100&#x26;sign=7ed0177f7265e0f4a0f645927183092b94d564d0906ed254a3d77bb886709c75" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/6BHjUzBh8cEE0sbi4NIY" alt=""><figcaption><p>Figure 5: SAP Host Agent Key Metrics</p></figcaption></figure>

### Video

{% embed url="<https://youtu.be/J2GYhNzExCA>" %}


# SAP NetWeaver Monitoring


# SAP ABAP System Monitoring

SAP ABAP (Advanced Business Application Programming) system is a component of SAP software that focuses on developing and managing business applications. It is used to develop custom reports, interfaces, enhancements, and forms within the SAP environment. The SAP ABAP system enables businesses to tailor SAP modules to their needs, automate processes, and improve efficiency. It includes tools for coding, testing, debugging, and runtime environments for executing ABAP programs.

Monitoring SAP ABAP systems involves overseeing performance, health, and efficiency. It includes tracking system metrics such as response times, memory usage, and workload distribution and identifying and resolving issues that could impact system performance. Effective monitoring ensures optimal operation, minimizes downtime and helps maintain system stability and reliability. Key tools and techniques include transaction codes like ST22 for dumps, SM21 for system logs, and ST03 for workload analysis.

### Prerequisites

Before configuring an SAP ABAP system for monitoring in IT-Conductor, follow the instructions below.

#### Account Requirements

1. Create a new SAP ABAP monitoring account. To create an SAP ABAP monitoring account, use the transaction code `SU01` to create a new user and assign the authorization objects`S_RFC` for Remote Function Call authorizations and `S_TOOLS_EX` for monitoring tools access.
2. Grant the user the appropriate IT-Conductor SAP role. See [Security Role Import](/user-guide/monitoring/sap/netweaver/abap-system/security-role-import) for more details.

{% hint style="info" %}
**Note:** Some of the IT-Conductor functionalities might require additional roles. See [SAP Transports](/user-guide/monitoring/sap/netweaver/abap-system/sap-transports) for more details.
{% endhint %}

### Configure SAP ABAP System Monitoring in IT-Conductor

To configure SAP ABAP system monitoring in IT-Conductor, follow the instructions below.

#### Add New SAP System

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to **Dashboards → Administrator** to access the **Administrator's Dashboard**.
3. Locate the **SAP Systems** actions panel and click the title to access the complete list.

<figure><img src="/files/Mag96vbPgedTMkqrZeVC" alt=""><figcaption><p>Figure 1: SAP Systems Actions Panel in Administrator's Dashboard</p></figcaption></figure>

4. Click the **New SAP System** button to start adding a new system for monitoring.

<figure><img src="/files/UU4ooqAfhiQADnVu6bqv" alt=""><figcaption><p>Figure 2: SAP Systems Actions Panel Page</p></figcaption></figure>

5. Fill out all the necessary information in the **New SAP System** wizard. Once completed, click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to add the system.

<figure><img src="/files/C1IWvv5dm5ZyumMQnL3e" alt=""><figcaption><p>Figure 3a: New SAP System Wizard (New SID Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the SAP system being added.
* **Organization** - refers to an administrative structure that defines objects with a common goal or purpose. If you previously created an organization, please select it.
* **Role -** refers to the environment where the system will be used.
* **Site** - refers to a logical object that describes a particular area or location, depending on the context in which it is used.
* **Gateway** - allows communication between the customer's site network and the IT-Conductor cloud platform. See [Gateway Setup](https://docs.itconductor.com/user-guide/setup/gateway-setup) for more details.
* **System ID** - refers to the unique identifier for an SAP system. It typically consists of three alphanumeric characters and is used to differentiate between different systems within the SAP landscape.
* **Connection Type** - refers to the method used to connect to the SAP system.
* **System Number** - refers to a two-digit identifier assigned to an SAP system instance. It helps distinguish between different instances of SAP running on the same host.
* **Host Name** - refers to the server's hostname where the SAP instance runs.
* **Gateway Service** - refers to the service that manages communication between IT-Conductor and the SAP system.
* **Router String** - specifies the route used to connect to an SAP system through multiple network layers or firewalls.
* **SNC** - stands for Secure Network Communications. It provides a layer of security for communication between IT-Conductor and the SAP system.
* **Database** - refers to the underlying database system that stores all the data and configurations of the SAP system to be added.

6. Provide the account information in the **New Account** screen and click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to complete the configuration.

<figure><img src="/files/IAT2IE9qOvGO3PCdjAJa" alt=""><figcaption><p>Figure 3b: New SAP System Wizard (New Account Screen)</p></figcaption></figure>

* **Description** - refers to any relevant information about the user account being added.
* **Application** - refers to the name given to the system being added.
* **Person** - refers to the name of the user who is adding the system.
* **User Name** - refers to the user created aligned with the [Account Requirements](#account-requirements).
* **Password** - refers to the password of the previously created user.
* **Re-type Password** - refers to the same password provided in the **Password** field.

7. Verify if the system was added to the **SAP Systems** actions panel and check its status.

{% hint style="info" %}
**Note:** The status will remain on **Ready** for a few minutes. Refresh the panel if needed. If there are configuration issues, such as incorrect connection parameters or an invalid account, the status will remain **Ready**. Click <img src="/files/3SXlNMwWxiHcqzkNv3p7" alt="" data-size="line"> to display the logs and troubleshoot. If everything is configured correctly, the status will change to **In Progress.**
{% endhint %}

8. Navigate to the service grid and verify if the system was added under the **SAP Systems** nod&#x65;**.**

{% hint style="info" %}
**Note:** The system will appear in the service grid within 5-15 minutes.
{% endhint %}

### Monitor SAP ABAP System in IT-Conductor

To view the availability and performance metrics of an SAP ABAP system, locate the **SAP Systems** node in the service grid.

<figure><img src="/files/9Un8OVMZdVDByUp0YwJV" alt=""><figcaption><p>Figure 4: SAP J2EE System View in Service Grid</p></figcaption></figure>

#### SAP ABAP System Key Metrics

* **Availability** - refers to the operational state and accessibility of the SAP ABAP system.
* **Connection Failures** - refer to the events where attempts to establish a connection are unsuccessful.
* **Heartbeat** - refers to the periodic signal sent to the system, enabling real-time detection of system downtime.
* **Missing Account** - refers to the absence of a required user account or resource within the SAP ABAP system.
* **Retriever Failures** - refer to the errors or issues encountered during the retrieval process of essential data or information within the SAP ABAP system.
* **Concurrent Users** - refers to the number of users simultaneously logged into the SAP ABAP system at any time.
* **Active Dialog Users** - refers to the number of users actively engaged in dialog tasks within the SAP ABAP system.

{% hint style="info" %}
**Note:** All metrics will not show data when a system is unavailable.
{% endhint %}

To access a historical view of each of these metrics, click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> and a pop-up chart will be displayed.

<figure><img src="/files/e6I1JzZdDJT3HjqKq3XD" alt=""><figcaption><p>Figure 5: SAP System Availability Chart in Service Grid</p></figcaption></figure>

#### App Servers

To monitor the instances of the SAP application server that handles user requests, process transactions, and execute ABAP programs, locate the **App Servers** node in the service grid.

<figure><img src="/files/9Kkq5AHXYEoDbZhtrzf9" alt=""><figcaption><p>Figure 6: App Servers Node View in Service Grid</p></figcaption></figure>

* **Availability** - refers to the operational state and accessibility of the application server.
* **Background Utilization** - refers to the utilization of background processing jobs.
* **CPU 5 Min Load-Average** - refers to the average CPU load over a five-minute interval.
* **DB Request Time** - refers to the average time it takes to complete database requests.
* **Dialog LogonLoadQuality** - refers to the quality and efficiency of user logons in dialog mode.
* **Dialog Response Time** - refers to the average time it takes to process dialog transactions.
* **Dialog Users Logged In** - refers to the number of users logged into the system in dialog mode.
* **Dialog Utilization** - refers to the utilization of dialog work processes.
* **Front-End Response Time** - refers to the time it takes for the front-end client to receive a response from a server after a user action.
* **ICM Connections** - refers to the number of active connections handled by the Internet Communication Manager (ICM), responsible for managing HTTP, HTTPS, and other protocol communications.
* **ICM Connections (Peak)** - refers to the highest number of connections handled by the ICM.
* **Memory Management: EsAct** - refers to the actual extended memory currently used.
* **Memory Management: Ext. Global Memory Used** - refers to the amount of extended global memory used by the system.
* **Memory Management: Free Memory** - refers to the amount of free memory available in the system.
* **Memory Management: HeapAct** - refers to the actual heap memory currently used.
* **Memory Management: PrivWpNo** - refers to the number of private work processes currently used.
* **Memory Management: VM Shared Memory Usage** - refers to the shared memory in the virtual machine environment.
* **OS Collector State** - refers to the status of the operating system collector.
* **Paging: Page\_Out** - refers to the number of pages swapped out to disk.
* **PerformanceU1/2 Response Time** - refers to the response time of a customized performance metric.
* **PerformanceU1/2 Utilization** - refers to the utilization of a customized performance metric.
* **Program HitRatio** - refers to the effectiveness of the program buffer, indicating how often requested programs are found in the buffer versus being loaded from the database.
* **Spool Status** - refers to the current status of the spool system, which handles print requests.
* **Spool WaitTime** - refers to the average time print jobs wait in the spool queue before processing.

#### BDocs

To monitor data synchronization in business documents, locate the **BDocs** node in the service grid.

<figure><img src="/files/LnMgyzFBtMxMAvSW1aPH" alt=""><figcaption><p>Figure 7: BDocs Node View in Service Grid</p></figcaption></figure>

See [BDoc Monitoring](/user-guide/monitoring/sap/business-process/bdoc) for more details.

#### CCMS Alerts

To monitor the health and performance of an SAP ABAP system, locate the **CCMS Alerts** node in the service grid.

<figure><img src="/files/iyuDAi7XUt1OvGaMogiX" alt=""><figcaption><p>Figure 8: CCMS Alerts Node View in Service Grid</p></figcaption></figure>

See [SAP CCMS Alerts Monitoring](/user-guide/monitoring/sap/netweaver/abap-system/ccms-alert) for more details.

#### Enqueue

To monitor the lock management of an SAP ABAP system, locate the **Enqueue** node in the service grid.

<figure><img src="/files/PpidHkJ2SWGx8frkbrY8" alt=""><figcaption><p>Figure 9: Enqueue Node View in Service Grid</p></figcaption></figure>

**Enqueue Key Metrics**

* **Enqueue Errors** - refers to the issues encountered while locking resources.
* **Request Rejects** - refers to the number of user requests rejected by the system for various reasons such as resource constraints, system overload, or configuration issues.
* **Utilization** - refers to the utilization of work processes dedicated to managing locks.

#### Spool

To monitor the printing and output processes of a print server, locate the **Spool** node view in the service grid.

<figure><img src="/files/dzhO880jegRoAqc1PMg0" alt=""><figcaption><p>Figure 10: Spool Node View in Service Grid</p></figcaption></figure>

**Spool Key Metrics**

* **Utilization** - refers to the utilization of the print server resources dedicated to spool processes.
* **Wait Time** - refers to the average time print jobs spend in the spool queue before being processed.

See [Print Spooler Monitoring](/user-guide/monitoring/sap/netweaver/abap-system/print-spooler) to configure Spool Devices and Spool Request (Error) retrievers.

#### tRFC & qRFC

To monitor the transaction Remote Function Calls (tRFC) and queued Remote Function Calls (qRFC) in an SAP ABAP system, locate the **tRFC & qRFC** node in the service grid.

<figure><img src="/files/v0eJks0DIL59LtgcJScs" alt=""><figcaption><p>Figure 11: tRFC &#x26; qRFC Node View in Service Grid</p></figcaption></figure>

**tRFC & qRFC (Inbound Queues) Key Metrics**

* **Failed Queue Recoveries** - refers to the number of attempts to recover failed queues that have not been successful.
* **First Entry Age** - refers to the longest duration for which a request has been waiting for processing.
* **In-Error Queues** - refers to the number of queues that are in an error state.
* **Queues Depth** - refers to the number of entries within a queue.

For more details, see the [Inbound/Outbound Queue Restart Automation](/user-guide/automation/inbound-outbound-queue-restart) documentation, and refer to the [Subscriptions](/user-guide/notifications/subscriptions) documentation for examples on how to tailor queue monitoring alerts.

#### SAPOffice Send Records Monitoring <a href="#sapoffice-send-records-monitoring" id="sapoffice-send-records-monitoring"></a>

SAPOffice Send Records Monitoring in IT-Conductor provides visibility into the status of messages, emails, and documents sent through SAPOffice within SAP systems. By enabling the SAPOffice retriever, IT-Conductor collects send record information and monitors message delivery activity to help identify communication issues.

The **Send Errors** metric tracks failed SAPOffice transmissions and can generate alerts when send errors occur. Failures may result from invalid recipient or sender addresses, SMTP/SAPconnect configuration issues, mail server unavailability, authentication or relay failures, oversized attachments, or communication timeouts. This helps teams quickly identify and troubleshoot message delivery problems.

IT-Conductor also provides visibility into SAPOffice messages that become stuck before fully reaching SAPconnect. For example, error messages such as “Still no entry in queue/No entry in queue” may not be captured by standard SAP CCMS monitoring because the request remains at the application level. By monitoring SAPOffice send records directly, IT-Conductor can proactively detect and alert on failed or stalled messages, helping teams identify missed business notifications earlier and take corrective action quickly.

<figure><img src="/files/zZzus0quEdKX1B3l97IW" alt=""><figcaption><p>Figure 12: SAPOffice 'Send Errors' Metric</p></figcaption></figure>

### Video

{% embed url="<https://youtu.be/RO3h1qADFkQ>" %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXhp08OmU8050PePmMgDt%2Fuploads%2FVig9BlFiHqcRioliECXY%2F409964?alt=media>" %}


# SAP Transports

IT-Conductor advanced SAP functionality requires a transport to be imported into the SAP System. The following Modules are included:

### IT-Conductor Function Modules <a href="#itcsaptp.core" id="itcsaptp.core"></a>

* Background Job Monitoring & Automation
* STMS (Transport System) Monitoring & Automation
  * STMS Status Monitoring and change
  * Transport Request Monitoring and Import
* Enqueue monitoring
* ARFC Monitoring
* SAP Workload Monitoring (ST03)
* iDoc Monitoring
* System-wide User List

### IT-Conductor BW Function Modules <a href="#itcsaptp.bw" id="itcsaptp.bw"></a>

* BW Precalc Servers monitoring

### IT-Conductor CRM Function Modules <a href="#itcsaptp.crm" id="itcsaptp.crm"></a>

* CRM BDoc Monitoring

### IT-Conductor LMDB Function Modules <a href="#itcsaptp.crm" id="itcsaptp.crm"></a>

* LMDB Query

### IT-Conductor HANA Function Modules <a href="#itcsaptp.crm" id="itcsaptp.crm"></a>

* HANA in-band Monitoring (monitoring SAP-specific HANA tenant DB directly from SAP)

### IT-Conductor Concur Function Modules <a href="#itcsaptp.crm" id="itcsaptp.crm"></a>

* Concur Connection Monitoring

When you log into the IT-Conductor portal, you can download the transport file by navigating to [**Support → Downloads → SAP Transport Downloads**](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=5843758999113569).<br>

<table data-full-width="true"><thead><tr><th>Name</th><th>Description</th><th width="96">Version</th><th>Transport Number</th></tr></thead><tbody><tr><td>IT-Conductor Function Modules</td><td>Extended Function Modules</td><td>6.87</td><td>ZO2K900154</td></tr></tbody></table>

### Common ABAP Import Errors

When importing the transport, please be aware that you may encounter import errors, and the import will complete with a return code of 8. This is normal as the transport includes modules that require certain SAP components to be installed. When not present, errors are generated, and the specific modules are not activated; the other modules remain unaffected.

*`Type 'SMOFPARNAM' is unknown`*

* **Cause:** Requires Software Component BBPCRM (SAP CRM) in package SMOF (*R/3 Adapter Service*, application CRM-MW-ADP).
* **Impact:** IT-Conductor BDoc Monitoring

\
*`Type 'CL_CTE_FND_HTTP_CHECK' is unknown.`*

* **Cause:** Requires add-on SAP Concur Integration Foundation and software Component CTE\_FND
* **Impact:** IT-Conductor Concur Monitoring

<figure><img src="/files/DToUWawYOf2hdQwz2sVG" alt=""><figcaption><p>Figure 1: ABAP Error Log</p></figcaption></figure>

*`Type 'DMC_MT_IDENTIFIER' is unknown.`*

* **Cause:** Requires Software Component SAP LT / DMIS
* **Impact:** IT-Conductor SLT Monitoring

*`Type 'CWBSEARCH_CRITERIA' is unknown.`*

* **Cause:** Requires the latest version of Note Assistant / Correction Workbench (package *SCWB*), which is part of the software component SAP\_BASIS.
* **Impact:** IT-Conductor SNote Monitoring

*`The function 'LOWER' is unknown`*

* **Cause:** Requires Software Component SAP\_BASIS 7.40 SP05 and later
* **Impact:** IT-Conductor Advanced User Security Automation (Resolving user e-mail to user ID)

<figure><img src="/files/SwY8XLqTraoqq7rR340V" alt=""><figcaption><p>Figure 2: ABAP Error Log</p></figcaption></figure>

For additional error messages, please contact [IT-Conductor support](mailto:support@itconductor.com).


# Security Role Import

IT-Conductor NW (ABAP) interface interacts with the SAP System via Remote Function Module calls (RFC). The IT-Conductor SAP Monitoring account requires explicit authorizations to perform the RFCs. IT-Conductor supplies an importable SAP Security role that bundles all the necessary authorizations to simplify the account setup.

1. Download the SAP NW Monitoring Role file in [**Support → Downloads → SAP Security Download**](https://service.itconductor.com/objectSavedSearch?OBJECT_Id=5930548857087850).

| Name                         | Description                                         | Version |
| ---------------------------- | --------------------------------------------------- | ------- |
| SAP J2EE Monitoring Role     | SAP J2EE Monitoring Role Import File                | 6.62    |
| SAP NW BATCH Scheduling Role | SAP NW BATCH Scheduling Role Import File            | 6.67    |
| SAP NW File Watcher Role     | SAP NW File Watcher Role Import File                | 6.87    |
| SAP NW Monitoring Role       | SAP NW BCSEN Monitoring Role Import File            | 7.00    |
| SAP NW SLT Monitoring Role   | SAP NW SLT Monitoring Role Import File              | 6.73    |
| SAP NW STMS Management Role  | SAP NW Transport System Management Role Import File | 6.86    |

2. Upload it into the SAP client using Profile Generator (transaction PFCG) to create the role.
3. Review the Authorization Objects. Remove/modify those violating your security policies, then generate the profile and assign it to the account.

![Figure 2: SAP Authorization Objects](/files/z0rT3MEiQr8GnFfmiT5J)


# SAP ABAP Overview Dashboard

The SAP ABAP Overview Dashboard is a built-in dashboard for ABAP systems monitored within IT-Conductor, accessible from the service grid.

It displays important system information, such as service alerts, system availability, CCMS alerts within the last 24 hours, system performance, Service Grid overview, DB request time, and the utilization of ABAP work processes.

The dashboard charts are dynamic, offering a high-level overview of the health and performance of the ABAP system within a single pane. You can click on any metric on the dashboard, instantly popping up a window with more detailed information and the option of zooming in for in-depth analysis.

<figure><img src="/files/bgre5aMbhzpSvhGCmIe3" alt=""><figcaption><p>Figure 1: SAP ABAP Overview Dashboard</p></figcaption></figure>


# SAP CCMS Alert Monitoring

While monitoring is a critical component in the monitoring system, another key component that will provide visibility into the health of the system is called alerting. Alerting is an element of the monitoring system that triggers action whenever there are changes in the metric values. The main purpose of alerting is to bring attention to the current status of the system. Alerts should contain information on what is wrong and where to go for additional information.

The SAP Computing Center Management System (SAP CCMS) is one of the tools in an SAP system that provides system-wide monitoring and produces alerts that will be beneficial in monitoring the whole SAP system. IT-Conductor provides 24-hour CCMS alerts that have been detected, monitored, and categorized. Automated templates are also available to create IT-Conductor alerts from the CCMS alerts.

### Use 24-hour SAP CCMS Alerts by Categories <a href="#itcsapccmsalertmonitoringoverview-howtouse24-hoursapccmsalertsbycategories" id="itcsapccmsalertmonitoringoverview-howtouse24-hoursapccmsalertsbycategories"></a>

1. Locate the SAP System ID (SID) by expanding the **SAP Systems** node from the service grid.

![Figure 1: IT-Conductor Service Grid View](/files/IZG17vHkUif28LEu06Bv)

2. In the SID node view, locate and click **Overview**.

![Figure 2: IT-Conductor Overview View in Service Grid](/files/odWytUL3LE26aHJAarjg)

3. Locate the pie chart for **CCMS Alerts (24 hours)** which shows the breakdown of the different CCMS alerts for the last 24 hours.

![Figure 3: IT-Conductor CCMS Alerts in Last 24 Hours](/files/eTHVGt5ZXQqBSk0LkNLk)

4. By clicking on the different categories, you will see all the available alerts from the CCMS for this particular system.

![Figure 4: CCMS Alerts Categories](/files/R7RVDieaduSv7dMR0TCO)

5. Choose a unique ID, and you will be able to see the details of the SAP alerts. You can also see all the necessary fields populated by IT-Conductor from CCMS alerts.

![Figure 5: Sample List of Database Administration](/files/11XhUzCyznhILwP4cz9Y)

### Use Automated Templates to Create IT-Conductor Alerts from CCMS Alerts <a href="#itcsapccmsalertmonitoringoverview-howtouseautomatedtemplatestocreateitcalertsfromccmsalerts" id="itcsapccmsalertmonitoringoverview-howtouseautomatedtemplatestocreateitcalertsfromccmsalerts"></a>

In IT-Conductor, you can subscribe to automated CCMS alerts that can be saved as templates for future use. Subscriptions can be modified and filtered by any template-available criteria.

1. Within the CCMS Alert Categories window, choose a category you want to subscribe to automated alerts.

![Figure 6: CCMS Alert Category](/files/aBzxNQP2U9MT4soDNeaj)

2. Click the unique ID, then click the **subscribe** icon to create a template.

![Figure 7: Sample Details of a SAP ID](/files/IsjNsYMKoaqw2JKhLCVG)

3. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line">.

![Figure 8: Create Icon](/files/IH5uTmYKrcBT0zqCZMPt)

4\. In this part, you can modify the criteria in the alert template. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to insert the configuration. This will create the object template for this subscription.

![Figure 9: CCMS Alert Object Template](/files/BkzgxcxqwFSQdMCI0Vyj)

### Video <a href="#itcsapccmsalertmonitoringoverview-video" id="itcsapccmsalertmonitoringoverview-video"></a>

{% embed url="<https://vimeo.com/250878903>" %}


# SAP Batch Jobs Monitoring

SAP Batch Job is a scheduled program that runs without user intervention. It is frequently used to automate tasks that need to be performed regularly. This process runs in the background to process huge data in batches rather than separate transactions.

Batch jobs are less visible to the end-users because they run in the background. Activating alerts will allow the users to regularly check if the batch jobs have run successfully or, in case of any failure, be able to identify the root cause of any error in the failed stages.

### IT-Conductor Job Alert Subscription <a href="#sapbatchjobsmonitoring-it-conductorjobalertsubscription" id="sapbatchjobsmonitoring-it-conductorjobalertsubscription"></a>

IT-Conductor allows users and/or teams to subscribe to automated alerts. These alerts can be modified through the system and set to specific jobs via filters. IT-Conductor offers very flexible criteria for managing alerts.

Below are simple subscriptions to CCMS job failure alerts:

![Figure 1: Sample Failed Batch Jobs CCMS Alerts Subscription](/files/10FMrpMuJqZuoCCgNaIU)

Navigate to **SAP Systems → SAP System Name → CCMS Alerts → Failed Batch Jobs** in the IT-Conductor dashboard. This will show the chart where the failed jobs are detected. Clicking on the graph will show the details of the failed jobs.

IT-Conductor can create thresholds based on the number of failed jobs per interval, which can raise IT-Conductor alerts when too many jobs fail within an interval.

![Figure 2: Sample Failed Batch Jobs](/files/t8w2Z7wJu23iuvZYVw98)

With the ability to track job failures from CCMS alerts, IT-Conductor can also track specific failed jobs by any fields in the job details, such as name, user, server, or combinations.

![Figure 3: CCMS Alerts Sample Template](/files/ZDgXqgidg4hvD02ADMuu)

Batch server performance for job processing is also monitored, by default, Batch queue utilization %.

IT-Conductor also supports multi-step jobs via our scheduler to be executed in SAP, which, of course, will allow us to monitor the job run time and job logs. The [IT-Conductor Support Team](/references/support) can configure job performance, such as runtime, delays, and more, for specific jobs or groups. These are called SLAs.

![Figure 4: Sample SAP Batch Jobs](/files/t55C7YpYDgI60YFDckac)

We don't have a ready-made report for long-term reports on job processing logs. Still, it is simple to define and run a report on a periodic schedule to be stored in IT-Conductor and distributed to designated users via email HTML reports. We use the SAP XBP (External Batch Processing) interface to monitor and manage jobs. Most objects in IT-Conductor can have a retention period set via a template to be retained at the detail level if required. Otherwise, the leaf nodes are expired, but their reports of # counts will still be available for months/years, not in drill-down details unless we mark them with longer retention.

![Figure 5: Activity Logs](/files/HgOZCiPxcV0Hp55110Ci)


# SAP Batch Job Monitoring for CCMS Alerts

SAP alerts are vital when monitoring and maintaining the health of the systems. IT-Conductor provides active monitoring of the status and performance of all scheduled jobs. Setting alerts for job failures is a basic requirement when monitoring alerts, but different correlated activities in the system need to be monitored, such as job scheduling, workload monitoring, delayed jobs, etc.

The IT-Conductor platform can monitor alerts via the alert panel and get a 24-hour overview and alert timeline. It can also create filters to enable exception handling and job notification.

### Monitor SAP Batch Job Alerts using IT-Conductor Alert Panel <a href="#itcsapbatchjobmonitoringforccmsalerts-monitoringsapbatchjobalertsusingitcalertpanel" id="itcsapbatchjobmonitoringforccmsalerts-monitoringsapbatchjobalertsusingitcalertpanel"></a>

1. In the IT-Conductor dashboard, locate the **Alerts** panel and click the title to access the complete list.

The Alert Panel will show several alert failures in terms of batch jobs. The SAP instances, the cause of the job failure, and the actual aborted jobs are available.

![Figure 1: Sample Alerts in Alert Panel](/files/pPrwNtov1YxnrgzBkvhh)

2. Choose one of the aborted jobs you want to review; you can see several areas, such as message argument, job name, cause, etc.

The **Related CCMS Alerts** icon will show the CCMS-related alerts.

![Figure 2: Related CCMS Alerts Page](/files/nUofNt9MLklSh1UtYAQw)

3. You can click for any IT conductor alerts and see what generated it.

![Figure 3: Sample Related CCMS Alerts](/files/hhTdok9omiB5XZyCK6yS)

![Figure 4: Sample CCMS Alert Template](/files/m2dl2ZimXn25Z1A46bnQ)

### Monitor CCMS Alerts in the Last 24 Hours <a href="#itcsapbatchjobmonitoringforccmsalerts-monitoringccmsalertsinthelast24hours" id="itcsapbatchjobmonitoringforccmsalerts-monitoringccmsalertsinthelast24hours"></a>

1. In the IT-Conductor dashboard, navigate to the SAP Systems. Click on the particular SAP System ID.

![Figure 5: IT-Conductor Service Grid View](/files/HjAcAcIFkfAgsEl1azK6)

2. In the service grid, navigate to **CCMS Alerts → Failed Batch Jobs**.

![Figure 6: IT-Conductor Service Grid Failed Batch Jobs View](/files/B0C2hKZsVQJevA8pV3fW)

3. Clicking on the preview of Failed Batch Jobs will show all the CCMS batch job alerts coming from the system. A portion of the actual CCMS batch job can be seen when clicking on the bar graph.

![Figure 7: Sample CCMS Batch Job Alerts](/files/XWQAHHL8MwL14bhJ5mll)

4. Clicking on the chart's title will show the timeline for changing the intervals. In any bar you click, actual alerts in that interval that failed can be viewed. This is a better way to check the number of job failures within the interval.

You can set a threshold and subscribe to an alert if you have many batch job failures in a given time interval. This allows you to look not at individual alerts but at the frequency of alert failures.

![Figure 8: Sample Failed Batch Jobs Graph](/files/KrFg5WT27N7AjAyqPpxo)

![Figure 9: Sample CCMS Failed Batch Jobs](/files/dWBc6kVjhjaqoF7saKEg)

Another way of monitoring CCMS alerts in the last 24 hours is by [categories](/user-guide/monitoring/sap/netweaver/abap-system/ccms-alert).

### Monitor CCMS Alert Timeline <a href="#itcsapbatchjobmonitoringforccmsalerts-monitoringccmsalerttimeline" id="itcsapbatchjobmonitoringforccmsalerts-monitoringccmsalerttimeline"></a>

1. In the IT-Conductor dashboard, locate the **Alerts** panel.

The cause information will show the details, such as the source of the alert/failure. This information is based on the details and criteria of the set alert subscription.

![Figure 10: Sample Alerts in Alert Panel](/files/fW62gzwVle9jHgMhd5hB)

2. SAP batch jobs subscription can also be modified in this section.

![Figure 11: Modify Failed Batch Jobs Alerts Subscription](/files/gP1cxZt6PA9iegMwDB3R)

3. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to create/modify the job template by choosing available “Attribute" Names. In the “Attribute Value”, you can type a specific job name or could be a regular expression containing different job names that can be critical in your environment to monitor.

Adding this becomes a criterion that once a matching event from SAP comes in, it will create an IT-Conductor alert that can be sent to notify yourself or the team.

![Figure 12: Add Row in Templates](/files/NsHdwKj9mhXFskHlgiho)

### Check the Active SAP Batch Job Subscriptions <a href="#itcsapbatchjobmonitoringforccmsalerts-howtochecktheactivesapbatchjobsubscriptions" id="itcsapbatchjobmonitoringforccmsalerts-howtochecktheactivesapbatchjobsubscriptions"></a>

1. In the IT-Conductor dashboard, navigate to **Management → Automation → Object Templates**.

![Figure 13: IT-Conductor Management Menu](/files/dTRXL2GsysnRLRAnPgus)

2. This will show all the active subscriptions in the system.

![Figure 14: Sample Object Templates](/files/NqTSamdBIw0A8rFgRMEw)

### Video <a href="#itcsapbatchjobmonitoringforccmsalerts-video" id="itcsapbatchjobmonitoringforccmsalerts-video"></a>

{% embed url="<https://vimeo.com/253322284>" %}

### Related Information

* [Monitoring SAP Background Jobs](https://www.itconductor.com/blog/monitoring-sap-background-jobs)


# Advanced SAP Batch Job Monitoring

Monitoring job failures such as runtime errors and delays that exceed a certain threshold are part of the [SAP Batch Job Monitoring](/user-guide/monitoring/sap/netweaver/abap-system/batch-jobs). By setting a threshold, an alert message can be generated when the set limits are exceeded, which usually indicates a performance issue that needs to be investigated.

In IT-Conductor, job failures, runtimes, and delays that exceed pre-defined thresholds can be monitored.

### **Set Threshold for Job Runtime**

Runtime is a period of time when a program is running. An alert may be generated when a problem or timeout occurs while the program is running, and metrics to alert long runtime jobs can be set in the threshold.

1. In the IT-Conductor dashboard, active alerts can be seen in the Alert Panel. Here, you can identify the alert caused by a runtime error. By clicking on the cause section, a chart will pop up with the details of the runtime that is currently tracking inflight time for jobs.

![Figure 1: Sample Alerts in Alert Panel](/files/p4Of2zRJdoRMA6NlM7L3)

2. Click the data point to get the list of jobs captured during the selected interval and get details such as user, inflight time, and job name from each job.

![Figure 2: In-Flight Time Graph](/files/eJYLnzcGzCl2JDNXY6Ae)

![Figure 3: In-Flight Time Sample](/files/FpDfSz4P7X67n5A6uWdD)

3. Returning to the chart, click on the **Threshold Override** icon to see the alerts captured by the threshold.

![Figure 4: Threshold Override Icon](/files/P8aeLFh26u8oOzA6Fxjb)

![Figure 5: Sample of Runtime Overrides](/files/yK7mVpRGeVeHZs0FRvg7)

4. Click on an alert to get information such as Warning Value, Warning Severity, and Alarm Severity from each job, all these can be set to your standard metrics. You can also set when the alert will be triggered.

![Figure 6: Modify SAPJobDefinition In-Flight Time](/files/Zkcb5QyYir7V3yY4YD0I)

### Monitor Specific SAP Batch Job Performance

#### **Retrievers**

Retrievers deliver all information about a monitored system. Every component or application has a dedicated retriever that can help ensure that each application's state is reported accurately.

1. In the IT-Conductor dashboard, navigate to **SAP System ID → Retrievers**.

![Figure 7: IT-Conductor Retrievers View in Service Grid](/files/mn4KNYoDEZy0OagNN8do)

#### **Failed Batch Jobs**

Most common alerts are caused by failed jobs. Looking for these alerts is one of the basic requirements when monitoring systems.

1\. In the IT-Conductor dashboard, navigate to **SAP System ID → Background Jobs → Failed**.

2\. Click on the graph on the chart to see the list of failed batch jobs. You can also click on any of the job names to get more details about the alert.

![Figure 9: Sample Chart for Failed Batch Jobs](/files/0TN80Q3diXGY7AYy6T7h)

![Figure 10: Sample Failed Batch Jobs](/files/T0e1i99UhBaSe5xQHNZb)

#### **In-Flight Times**

In-flight time is the time when the background jobs are running.

1\. In the IT-Conductor dashboard, navigate to ***SAP System ID*****&#x20;→ Background Jobs → Runtime**.

In any of the data points you click, it captures the maximum runtime of the jobs during the interval. You can set the frequency on how many jobs would trigger the alert or set the threshold based on severity.

![Figure 11: IT-Conductor Runtime View in Service Grid](/files/2EIBtQGN7USrWnjN6HCr)

![Figure 12: Sample Chart for Runtime](/files/HXP0ESFAKnGfYpIkmJJp)

![Figure 13: Sample List of Job Names with In-Flight Time Details](/files/DIm4qtu3vDC5bwVIZaER)

### **Set Threshold for Delay**

A delay means that something is preventing a scheduled background job from starting, impacting the job's overall performance. This can be caused by several reasons (for example, there are not enough dialog processes for the scheduler). All reasons can be captured in IT-Conductor, and a threshold can be created to set metrics for alerts.

1\. In the IT-Conductor dashboard, navigate to **SAP System ID → Background Jobs → Delay Time**.

Click the chart title, then click the **Threshold Override** icon to see the available job names.

![Figure 14: IT-Conductor Delay Time View in Service Grid](/files/g5rNikX382vd07h3ZuQq)

![Figure 15: Threshold Override Icon](/files/gwChF1hYVBdnfkGgf5eO)

2. You can also set the override threshold by clicking on the job name. This override allows tracking when the system is busy or when jobs are scheduled but not able to run on time.

![Figure 16: Delay Time Overrides](/files/Ks5yJOfuRfcqIJ5G6fAt)

### **Monitor Job Performance in Application Server** <a href="#itcadvancedsapbatchjobmonitoring-monitoringjobperformanceinapplicationserver" id="itcadvancedsapbatchjobmonitoring-monitoringjobperformanceinapplicationserver"></a>

Jobs run on particular servers. Checking the performance metrics on these servers gives you an idea of why the job takes much longer than usual. This can also show you what resources are accumulated, as this can impact other shared resources in the system.

![Figure 17: IT-Conductor Server View in Service Grid](/files/VCq8PQNj7wUnrd9JMScn)

### **Monitor Overall Health** <a href="#itcadvancedsapbatchjobmonitoring-monitoringoverallhealth" id="itcadvancedsapbatchjobmonitoring-monitoringoverallhealth"></a>

[Service Health Monitoring](/overview/monitoring-concepts/application-performance-management) provides all the information about the system's overall health. In the service grid, click on **Health**. This will show the monitoring components of the system.

![Figure 18: IT-Conductor Health View in Service Grid](/files/zdjJ0XSJmhmwxhbdgCwq)

Expanding the components will give visibility to the alert warning symbols indicating if there are specific alerts in the current state.

In this option, all the graphs and details can be seen simultaneously synchronizing with the time of the other performance criteria.

This is beneficial in doing analytics to figure out where the bottlenecks are in terms of workload.

![Figure 19: Health Explorer Sample View](/files/c9FABs2DgDeP8SgIWRIr)

### Video <a href="#itcadvancedsapbatchjobmonitoring-video" id="itcadvancedsapbatchjobmonitoring-video"></a>

{% embed url="<https://vimeo.com/255057948>" %}


# SAP SLT & RFC Connection Monitoring

SAP Landscape Transformation (SLT) is a trigger-based data replication method that helps customers replicate business data across their system landscape at the database trigger level. Thus, allowing real-time data or scheduled-based data replication between similar or disparate database platforms.

SLT and many other SAP applications depend significantly on Remote Function Call (RFC) Connectivity. RFC is the standard SAP interface for communication between SAP systems that needs to be monitored to ensure high-quality service of the SAP ecosystem.

In a standard SAP environment, monitoring SLT and RFC uses CCMS or SAP Solution Manager. IT-Conductor requires no software installation, no CCMS, and no Solution Manager configuration. IT-Conductor came up with a much simpler way to monitor availability, latency, and alerts with a few clicks in just a few minutes.

### Availability and Performance Challenges <a href="#availability-and-performance-challenges" id="availability-and-performance-challenges"></a>

It is important to monitor the availability and performance of an SAP system because of the following reasons:

#### SLT

Replication monitoring involves partners of multiple or combinations of systems, objects, and complex schema of different tables. It also consists of the connectivity, real-time replication status of tables, and data latency issues that need to be monitored.

#### RFC Connectivity <a href="#rfc-connectivity" id="rfc-connectivity"></a>

Monitoring and maintaining the RFC Connectivity targets is critical since this is the cornerstone of many connections in the SAP Ecosystem. It involves tracking connection latency to ensure no problems are encountered when transferring data that may impact the availability and performance of the system.

#### Central Monitoring <a href="#central-monitoring" id="central-monitoring"></a>

Since numerous systems are involved, Central Monitoring is one of the important challenges in maintaining a healthy and operational system. Central Monitoring involves tracking data flows between the systems, outages, and delays that may cause business disruption.

### What’s Available for SLT Monitoring from SAP? <a href="#whats-available-for-slt-monitoring-from-sap" id="whats-available-for-slt-monitoring-from-sap"></a>

#### LTR <a href="#ltr" id="ltr"></a>

This is the Configuration and Monitoring dashboard inside the NetWeaver Business Client Web UI where you can view status information and monitor the replication process.

* Checks the status of batch jobs available and utilized by SLT.
* Checks the connection between the source and the target system (RFC and DB connections).
* Checks the status of the triggers based on the tables configured to replicate DB triggers created on the source system to record changes in SLT logging tables.
* Checks the statistics that refer to the replication details such as insert, update, and delete. The latency between the data transfer (in seconds over the last 24 hours) is also shown.
* Configure data transfer job options as well as replication schedule.

#### LTRC & LTRO <a href="#ltrc-and-ltro" id="ltrc-and-ltro"></a>

Inside the SAP GUI transaction, there are different ways to monitor the SLT Server.

* LTRO - Replication Server Monitoring (new with SP6)
  * Monitors the number of currently running and free batch and dialog processes running on all application servers of the SAP LT Replication Server system.
  * Monitors the availability status for all connected target systems, and the corresponding log entries including warnings and errors.
  * Monitors the status of multiple configurations (mass transfer IDs) within a single screen.
* LTRC
  * LTRC is first introduced before LTRO
  * Similar to LTRO but can only view one configuration at a time
  * Provides a guided view into the configuration as well as data transfer monitoring and statistics.

<figure><img src="/files/bcZlg1KBTp9PlycMf2Wv" alt=""><figcaption><p>Figure 1: SAP LT Replication Server Monitoring</p></figcaption></figure>

<figure><img src="/files/mGVCPYCZmc5MPNmX3XIG" alt=""><figcaption><p>Figure 2a: SAP LT Replication Server Cockpit (Participating Objects)</p></figcaption></figure>

<figure><img src="/files/MP4RvnAidAdYPapjbpUa" alt=""><figcaption><p>Figure 2b: SAP LT Replication Server Cockpit (Expert Functions)</p></figcaption></figure>

#### MWBMON <a href="#mwbmon" id="mwbmon"></a>

Migration Workbench Monitor is a standard SAP transaction code for mass data transfer.

* Similar to LTRC but with in-depth performance analysis for tables, indexes, space, and even host resource utilization.
* Has expert functions such as reset of processing steps, table mapping, and performance analysis.

<figure><img src="/files/6v8ijabaUfrtBUjUVWbP" alt=""><figcaption><p>Figure 3a: Mass Data Transfer (Relevant Tables)</p></figcaption></figure>

<figure><img src="/files/zLDjhSuNoc3W1XVoMGTu" alt=""><figcaption><p>Figure 3b: Mass Data Transfer (Expert Functions)</p></figcaption></figure>

#### Solution Manager <a href="#solution-manager" id="solution-manager"></a>

Solution Manager is the tool used to monitor SAP centrally. The solution manager must be installed first before monitoring the SLT system. It provides aggregated information for a schema. Therefore, it does not allow the viewing of details for tables and related triggers

* Checks the SLT Latency, including the average and maximum latency time in the last 24 hours.
* Checks the Table performance metrics and trigger status.
* It also provides details about load jobs and SLT Table status.

### Configure RFC Destination Monitoring in IT-Conductor <a href="#it-conductor-slt-and-rfc-connection-monitoring" id="it-conductor-slt-and-rfc-connection-monitoring"></a>

IT-Conductor offers a simple and centralized approach to RFC Connection monitoring. When you add an ABAP system for monitoring, IT-Conductor can discover and display components in a hierarchical view.

#### Prerequisites

* Configure an ABAP system for monitoring. See [SAP ABAP System Monitoring](https://docs.itconductor.com/user-guide/monitoring/sap/netweaver/abap-system) documentation for more details

#### Add New RFC Destination

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to the SAP Systems menu, and find the SAP system that you want to add the RFC connection to
3. In the main menu, click **RFC Destinations**

<figure><img src="/files/Z8oLzKtDi7iAqNtviu7w" alt=""><figcaption><p>Figure 4: Configuring RFC Destinations</p></figcaption></figure>

4. On the next screen, click **New RFC Destination**

<figure><img src="/files/W50nfUcdzlwEVhwePbQr" alt=""><figcaption><p>Figure 5: List of existing RFC Connections</p></figcaption></figure>

5. Fill in the wizard New RFC Destination wizard
   1. **Description** - a short description for the new connection
   2. **Role** - refers to the environment where the system will be used.
   3. **SAP SID** - refers to the system where you’re adding the connection
   4. **RFC Destination** - the target SAP or external system used for the RFC connection.
   5. **Interval** - The target SAP or external system used for the RFC connection (by default, this is 5 minutes).
   6. **Type** - the communication method for the RFC connection (*ABAP*, *HTTP*, or *None*).
6. Click the <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="original"> button to save and finish.

<figure><img src="/files/AzJueTZZgbIaytTBGXa4" alt=""><figcaption><p>Figure 6: New RFC Destination Configuration Wizard</p></figcaption></figure>

Within 5-10 minutes, the new connection should be visible in the system’s grid. Scroll down to find an **RFC Destinations** node.

<figure><img src="/files/xcZwSQl1sAXKQmZp2QNG" alt=""><figcaption><p>Figure 7: RFC Destination Info Panel</p></figcaption></figure>

### Monitor SAP SLT and RFC Connection <a href="#monitor-it-conductor-slt-and-rfc-connection" id="monitor-it-conductor-slt-and-rfc-connection"></a>

#### Monitor RFC Connection <a href="#monitor-rfc-connection" id="monitor-rfc-connection"></a>

In RFC Performance Monitoring, all RFC destinations in the managed system are collected. IT-Conductor monitors the **availability** and **latency** of RFC Destinations, which are critical to ensure that the connections are all up and running.

<figure><img src="/files/WEHVjfAmuIIkYEvOa97t" alt=""><figcaption><p>Figure 8: RFC Destinations in IT-Conductor Service Grid</p></figcaption></figure>

Graphical charts provide visibility into performance trends over time, helping identify latency issues and connection degradation. IT-Conductor can monitor RFC destination connectivity status, track response times and performance metrics, and generate alerts when connections fail or performance deteriorates.

By configuring threshold-based alerts, subscriptions, and escalation policies for critical RFC destinations, teams can proactively detect service disruptions and respond quickly before they impact business operations. (See our [Threshold overrides documentation](https://docs.itconductor.com/user-guide/notifications/threshold-overrides)).

Notifications can be routed through email, SMS, or integrated ticketing systems to ensure timely corrective action. (See our [Subscriptions ](https://docs.itconductor.com/user-guide/notifications/subscriptions)documentation)

<figure><img src="/files/gc7XpaVXPXqpaSy57hnB" alt=""><figcaption><p>Figure 9: RFC Destination Availability</p></figcaption></figure>

<figure><img src="/files/CL2VKH2XbZYoDUGyE801" alt=""><figcaption><p>Figure 10: RFC Destination Latency</p></figcaption></figure>

#### Monitor SAP SLT <a href="#monitor-sap-slt" id="monitor-sap-slt"></a>

IT-Conductor offers a simple and centralized approach to SLT monitoring. When you add a NetWeaver System that includes SLT, IT-Conductor can discover and display components in a hierarchical view. You can drill up and down the details for easier monitoring and troubleshooting.

The SAP SLT involves schema, roles, users, and tables where status and latency can be monitored. All information is displayed in a time-synchronized manner to quickly troubleshoot issues before they affect the end users. You can drill up and down the details for easier monitoring and troubleshooting.

<figure><img src="/files/36WDRsCPZtE4cdhQnBq9" alt=""><figcaption><p>Figure 11: SLT Monitoring in IT-Conductor Service Grid</p></figcaption></figure>

<figure><img src="/files/HOCf6lG3S1Bu2Kd2Cij2" alt=""><figcaption><p>Figure 12: Table Replication Latency</p></figcaption></figure>

<figure><img src="/files/g2ER2FEXSVHoU04L20b1" alt=""><figcaption><p>Figure 13: Table Replication Status</p></figcaption></figure>

<figure><img src="/files/06Ynp13EjbJrgjZDomSO" alt=""><figcaption><p>Figure 14: Source Connection Status</p></figcaption></figure>

<figure><img src="/files/62kQSFQec9A43wPQt01L" alt=""><figcaption><p>Figure 15: Target Connection Status</p></figcaption></figure>

### SAP SLT Dashboard

A customized dashboard can be deployed to provide an overview of SLT source and target connection statuses within a particular time interval, and other metrics such as peak latency, peak unprocessed records, and daily inserts.

<figure><img src="/files/AWiook6Qli6KY41PazqE" alt=""><figcaption><p>Figure 16: SLT Dashboard</p></figcaption></figure>

### Videos <a href="#sapslt-and-rfcconnectionmonitoring-video" id="sapslt-and-rfcconnectionmonitoring-video"></a>

{% embed url="<https://www.youtube.com/watch?v=CujHdTgzwEs>" %}

{% embed url="<https://www.youtube.com/watch?v=17rqCaZKPbQ>" %}


# Print Spooler Monitoring

SAP print spooler is a component within the SAP system responsible for managing and processing print jobs sent from different devices to a printer or a network of printers. It serves as an intermediary, efficiently queuing, prioritizing, and routing print jobs to ensure smooth and timely processing across all connected printers.

Monitoring print spoolers enables you to proactively identify and resolve issues such as stuck jobs, printer errors, or system bottlenecks, ensuring uninterrupted printing operations and optimal performance.

### Configure Print Spooler Retriever in IT-Conductor <a href="#enable-print-spooler-retriever" id="enable-print-spooler-retriever"></a>

To configure print spooler retriever(s) in IT-Conductor, follow the instructions below:

1. Visit [service.itconductor.com](https://service.itconductor.com/) and enter your login credentials.
2. Navigate to the target system in the service grid, then click **Retrievers**.

<figure><img src="/files/USnHVFXofYZpY04q95GS" alt=""><figcaption><p>Figure 1: System Node View in Service Grid</p></figcaption></figure>

3. Select the retriever you want to enable.

There are two spool retrievers in IT-Conductor, namely **Spool Devices** and **Spool Request (Error)**.

<figure><img src="/files/863JYmBw2Gju8CX6QRSO" alt=""><figcaption><p>Figure 2: Print Spooler Retrievers</p></figcaption></figure>

* **Spool Devices** - retrieves the output devices (i.e., printers) configured in the SAP spool system. It supports filtering based on device attributes such as name, status, or type.
* **Spool Request (Error)** - used to retrieve information about spool requests in the SAP system, such as the status of the spool request (e.g., processed, pending, or error).

4. Click <img src="/files/oqn8RL2g7n684ORCwtgx" alt="" data-size="line"> to activate the retriever.

a. Spool Devices Retriever Configuration

<figure><img src="/files/4Sh20wa8TgLH7RiuS1iu" alt=""><figcaption><p>Figure 3: Spool Devices Retriever Configuration</p></figcaption></figure>

* **Name** - refers to the default retriever name.
* **Description** - refers to the retriever object description. It describes the purpose of the retriever.
* **Owner** - refers to the account owner in IT-Conductor.
* **SAP System** - refers to the SAP system from which to retrieve spool device data.
* **Schedule** - if required, a schedule can be defined to specify when the retriever should run (e.g., daily, weekly, etc.).
* **Planned Start Time** - determined automatically and specifies the day and time when the retriever will begin pulling data.
* **Time Windows Begin** - used to manually specify the earliest start time for spool data retrieval.
* **Time Windows End** - used to manually specify the latest permissible time for spool data retrieval.
* **Repeat** - enables or disables periodic execution of the retriever.
* **Repeat Interval** - refers to the interval between consecutive executions when repeat is enabled.
* **Object Class** - defines the type of spool objects to retrieve.
* **Insertion Criteria** - refers to the rules or conditions for including spool objects in the retriever output.
* **Exclusion Criteria** - refers to the conditions for excluding certain spool objects from the retriever output.
* **Object Count** - refers to the total number of spool objects currently retrieved.
* **Runtime Info** - refers to the SAP runtime information, such as the client number and SAP system time.
* **Input Parameters** - this requires elevated admin access to enable the “Return Long Name” flag.

b. Spool Request (Error) Retriever Configuration

<figure><img src="/files/JuTyzC27dUr1fvwjGgNu" alt=""><figcaption><p>Figure 4: Spool Request (Error) Retriever Configuration</p></figcaption></figure>

* **Name** - refers to the default retriever name.
* **Description** - refers to the retriever object description. It describes the purpose of the retriever.
* **Owner** - refers to the account owner in IT-Conductor.
* **SAP System** - refers to the SAP system from which spool error requests will be retrieved.
* **Schedule** - if required, a schedule can be defined to specify when the retriever should run (e.g., daily, weekly, etc.).
* **Planned Start Time** - determined automatically and specifies the day and time when the retriever will begin pulling data.
* **Time Windows Begin** - used to manually specify the earliest start time for spool data retrieval.
* **Time Windows End** - used to manually specify the latest permissible time for spool data retrieval.
* **Repeat** - enables or disables periodic execution of the retriever.
* **Repeat Interval** - refers to the interval between consecutive executions when repeat is enabled.
* **Object Class** - defines the type of spool objects to retrieve.
* **Top Attribute** - refers to the attribute that holds time-related metadata about a spool request.
* **Top Value** - refers to the last biggest object value for the retriever.
* **Selector Operator** - refers to the top selector value comparison operator.
* **Insertion Criteria** - refers to the rules or conditions for including spool requests in the retriever output.
* **Exclusion Criteria** - refers to the conditions for excluding certain spool requests from the retriever output.
* **Object Count** - refers to the total number of spool objects currently retrieved..
* **Runtime Info** - refers to the SAP runtime information, such as the client number and SAP system time.
* **Errored** - refers to the retriever input parameter flag used to enable or disable the retrieval of spool requests with errors.
* **None** - refers to the retriever input parameter flag used to enable or disable the retrieval of spool requests in None mode.
* **Processing** - refers to the retriever input parameter flag used to enable or disable the retrieval of spool requests in Processing status.

5. Verify the successful activation of the spool retriever by navigating back to the service grid. Expand the **Spool** node, then confirm if **DevicesRequest Errors/Stuck** and/or **Devices** are present.

<figure><img src="/files/haYxg4crVZJw2n5Hv6J9" alt=""><figcaption><p>Figure 5: Spool Requests Monitors</p></figcaption></figure>

### Monitor Spooler Devices and Request Errors in IT-Conductor

To view spool devices being monitored, navigate to **Spool** node view in the service grid. Expand **Devices** and click <img src="/files/SuIncSHgvy7tcw7wCCtj" alt="" data-size="line"> to view their properties.

<figure><img src="/files/bkJPmCpdRCysXsW1R4sE" alt=""><figcaption><p>Figure 6: Spool Devices in Service Grid</p></figcaption></figure>

To view spool requests with errors/stuck status, navigate to **Spool** node view in the service grid. Locate **Request Errors/Stuck** and click <img src="/files/uEjqdT0XqJBm6IUsLixD" alt="" data-size="line"> to view the Request Errors/Stuck chart. You may also click on a data point to see more details.

<figure><img src="/files/uNvNvKVKoNVXEqRTM9VM" alt=""><figcaption><p>Figure 7: SAP Spool Requests Errors/Stuck</p></figcaption></figure>

### Related Information

* [SAP ABAP System Monitoring](/user-guide/monitoring/sap/netweaver/abap-system)
* [OS Printer Monitoring](/user-guide/monitoring/infrastructure/os/unix-linux-system/os-printer)


# Workload Monitoring

Workload monitoring in IT-Conductor represents the health status in a graphic and detailed view of the system in terms of usage to monitor response times in transactions, users, expensive running programs, etc.

Workload represents the usage of system resources by units to complete business processes such as the following:

* Transactions
* Jobs
* Programs
* Sessions or Tasks

### Why Monitor Workloads? <a href="#workloadmonitoring-whymonitorworkloads" id="workloadmonitoring-whymonitorworkloads"></a>

System administrators must always be aware of the system's health status to prevent crashes or unexpected incidents that can impact the business.

The three points that we will analyze are the following:

* **Performance:** Workloads to measure how much work can be done and to monitor response times and processing windows to guarantee the operativity of the services.
* **Capacity & Configuration:** Provisioning of capacity in an early stage to prevent any issue.
* **Baseline & Trend:** Capture the performance statistics.

### What’s Available for Workload Monitoring in SAP? <a href="#workloadmonitoring-whatsavailableforworkloadmonitoringinsap" id="workloadmonitoring-whatsavailableforworkloadmonitoringinsap"></a>

* **SAP CCMS Transaction SLA:** Response time per app/server/client, smoothed out per interval in RZ20.
* **Netweaver Workload Analysis:** ST03 – Analyzes SAP statistical records from a historical reporting perspective, detailed transaction records but without context.
* **Solution Manager:** IT Performance Report, EarlyWatch Report: historical snapshots of workload types and top workloads in an aggregated format. Not monitoring.

### Why Our Approach to Workload Monitoring is Beneficial? <a href="#workloadmonitoring-whyourapproachtoworkloadmonitoringisbeneficial" id="workloadmonitoring-whyourapproachtoworkloadmonitoringisbeneficial"></a>

The workload retriever filters matching criteria and brings detailed statistics for analytics, providing in-depth performance intelligence at the OS, database, and application levels.

#### Service-Oriented Workload Monitoring <a href="#workloadmonitoring-service-orientedworkloadmonitoring" id="workloadmonitoring-service-orientedworkloadmonitoring"></a>

* **Service Alert:** Set customized alerts with value ranges defined by the business to determine the health status of the systems (OS, APP, DB).

![Figure 1: Sample Service Alert Graph](/files/5tei9KwmvDmC50MoIfyv)

* **Overrides:** Create Overrides to set customized metrics and severity ranges to monitor the system.

![Figure 2: Sample System Overrides](/files/gljZvEpqL7KM6QdFcqdv)

* **System Availability:** Set metrics to assure that the system is working as required.

![Figure 3: Sample Availability Graph](/files/z72p1eqYEjgrZjrSXMOJ)

* **Memory Used:** Set metrics and alerts when memory exceeds the warning value previously configured in overrides.

![Figure 4: Sample Memory Used Graph](/files/73xfdVD9CZ4Ea344yGc3)

* **Dialog Response Time:** Set metrics to monitor the average time required to process dialog steps.

![Figure 5: Sample Dialog Response Time Graph](/files/PnHnBPxHC7LUyXn9DFzn)

* **Dialog Users Logged in:** Review how many users have logged into the system in a period of time.

![Figure 6: Sample Dialog Users Logged In Graph](/files/S44Y1gyotrdpXxyal8oq)

* **Active Dialog Users:** Review how many users connected from GUI in a period of time.

![Figure 7: Sample Active Dialog Users Graph](/files/bNipKVoP4YXWKNJFafJv)

#### **CCMS Alerts**

* **Details for Failed Batch Jobs:** Get information about failed batch jobs in a period of time.

![Figure 8: Sample Failed Batch Jobs](/files/iFHqAnGrOdEOvm5cWhxk)

* **Details for Failed Updates:** Get information about failed updates in the system in a period of time.

![Figure 9: Sample Failed Updates](/files/zp2S7D0huQooNHqcCGrR)

* **Details for Shortdumps:** Get information about short dumps in the system in a period of time.

![Figure 10: Sample Shortdumps](/files/q8J1BiqA8gM7M7i9tkcv)

**Service-Oriented Workload Monitoring** helps SAP Basis teams to answer the following questions:

* What was running on the system during that time?
* Who was running that problem transaction or job?
* Where did those problem users or transactions come in from?
* When did the performance problem start?
* How was the workload or services impacted?

### Video <a href="#workloadmonitoring-video" id="workloadmonitoring-video"></a>

{% embed url="<https://www.youtube.com/watch?t=872s&v=vbhKxNRPoeU>" %}


# Transaction Code Monitoring

Due to performance overhead and limited use, we transitioned workload monitoring from wholesale to custom configurations. Here are the instructions on how to add single TCODE monitoring.

### Collection <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-1.collection" id="workloadmonitoring-manuallyaddingatcodeformonitoring-1.collection"></a>

Workload Statistics are not collected for all TCODEs anymore; to collect specific TCODE stats, you need to explicitly configure a retriever (or create a dedicated retriever).

Navigate to the system of interest in the grid, and click **Retriever tool/leaf.**

An **inactive** retriever, Stats Summary Retriever, is always created. For easy maintenance, make a copy for each type as needed:

* For TCODEs selection
* For TaskType (and TCODEs) selection
* For User (and TCODEs) selection
* Any combination of custom selector

Please be advised that a single retriever's Gateway/SAP overhead is repeated for each additional one. Stats Summary retriever always pulls/summarizes all STAT records for the interval; the On-Gateway retriever will enumerate all records returned from SAP and match them to the selector; only matching records will be posted to IT-Conductor. Busy SAP systems have thousands of STATS records per interval (normally 15 min), which will create a significant overhead, so try to consolidate these retrievers as much as possible.

#### Retriever Selectors <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-retrieverselectors" id="workloadmonitoring-manuallyaddingatcodeformonitoring-retrieverselectors"></a>

![Figure 1: Modify Retriever Selectors](/files/2HKqOWvAaK00nYeI1JEo)

Add/Modify the Insertion Criteria records; the drop-downs will suggest the values.

![Figure 2: Add/Modify the Insertion Criteria Records](/files/p5zrnPEHd7qMenjm0reg)

You usually focus on:

* SAPDialogStep.TASKTYPE
* SAPDialogStep.TCODE
* SAPDialogStep.TERMINALID
* SAPDialogStep.ACCOUNT

All Insertion criteria work on an “AND” basis.

Use Exclusion criteria if needed, which will be applied after the Insertion Criteria so you can filter out undesired records.

Modify the Read Interval if needed (default 15 min). This interval is for calculating the summary records and calculating the repeat executions of the retriever.

If you set the interval to 30 minutes, then 30 min average records for each TCODE/TASKTYPE/ACCOUNT/TERMINAL/TimeStamp combination will be created; you will not be able to zoom in time-wise below that. If you change it afterward, you will need to update the associated aggregators, or the end data will not be accurate.

### Aggregation <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-2.aggregation" id="workloadmonitoring-manuallyaddingatcodeformonitoring-2.aggregation"></a>

#### Consolidators <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-2.1consolidators" id="workloadmonitoring-manuallyaddingatcodeformonitoring-2.1consolidators"></a>

After the STAT Record objects (class SAPServiceAggregatorSTATSummaryTCODE) are created in IT-Conductor you need to configure the aggregation/threshold to make sense of the interval data. The individual TCODE Aggregators (SAPServiceAggregatorSTATSummaryTCODE) are automatically created (currently, the template is disabled for an overhead reason) however, you will need to configure manually the so-called Buckets (aka consolidators) that consolidate individual aggregator data into bucket data.

You can either create a new consolidator manually or add “source” to an existing consolidator. The “source” is a setup that defines the criteria for the inclusion of aggregators into the bucket. If you only need to monitor a single “standalone” TCODE you don't need a consolidator.

The Threshold (monitor) is auto-created for Consolidator. But for individual (standalone) TCODE aggregators, you will need to create one manually.

#### Threshold Override for Consolidators <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-2.1.1thresholdoverrideforconsolidators" id="workloadmonitoring-manuallyaddingatcodeformonitoring-2.1.1thresholdoverrideforconsolidators"></a>

Create a threshold override for Target Class=ConsolidatorSAPStats.

![Figure 3: Sample Threshold Override for Consolidator](/files/ZUET8ue0YvO26UNLoPBH)

#### Threshold Collector <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-2.2thresholdcollector" id="workloadmonitoring-manuallyaddingatcodeformonitoring-2.2thresholdcollector"></a>

An alternative, more modern, and efficient way to aggregate the data is to use **Threshold Collector** (SAPStatSummaryThresholdCollection). Threshold Collector combines data record aggregation and value monitoring in one.

Modify an existing one to include more TCODEs or create a [new](https://service.itconductor.com/objectCreate?OBJECT_ClassName=SAPStatSummaryThresholdCollection) one.

* Select **Value Attribute** to form the drop-down menu (default - SAPDialogStep.RESPTI).
* Select **Application** (SAP NW) from the drop-down menu (Optional).
* Type in the **SAP Account** (Optional).
* Type in **TCODE** **Regex** (any valid regex expression, case sensitive, use (?i) to turn off case sensitivity).
* Type in **Task Type** list (comma-separated, optional, use Task-Type [Field Definition](https://service.itconductor.com/fieldEdit?Name=SAP_STAT_TASK_TYPE) for numeric task type values).

![Figure 4: Modify Threshold Collector](/files/jQHGcF1ShSL0A7Z94OvL)

{% hint style="warning" %}
**Important:** Ensure you create objects when impersonating the tenant’s user or select the proper tenant owner if you are IT-Conductor administrator.
{% endhint %}

Upon creating the "Threshold Collector", a new Workload container will be created (if it doesn’t exist) and discovered under the SAP Grid; the threshold will also appear.

{% hint style="info" %}
**Note:** We recommend creating "Threshold Collector" instead of old-style Consolidators, but if you need Bucket support with drill-down functionality (into individual TCODEs), the Consolidators are the way to go.
{% endhint %}

#### Threshold Override for Threshold Collector <a href="#workloadmonitoring-manuallyaddingatcodeformonitoring-2.2.1thresholdoverrideforthresholdcollector" id="workloadmonitoring-manuallyaddingatcodeformonitoring-2.2.1thresholdoverrideforthresholdcollector"></a>

Create a threshold override for Target Class=SAPStatSummaryTCODE.

![Figure 5: Sample Threshold Override for Threshold-Collector](/files/JoX4g035Px6Z0uo9TqSd)

### Monitoring Long-Running Transactions

In SAP systems, long-running transactions refer to business processes or activities that take a significant amount of time to complete. These transactions can have an impact on system performance and overall efficiency. If your SAP system is experiencing performance degradation, it may be due to the long-running job execution time that is caused by an expensive SQL statement. Other causes and side effects of long-running transactions can also show up in areas like waits, blocking, locks, memory bottlenecks, high process, and CPU utilization, and timeouts.

#### **Create Override Threshold for Long-running Background Activity** <a href="#create-override-threshold-for-long-running-background-activity" id="create-override-threshold-for-long-running-background-activity"></a>

Getting started with monitoring expensive and long SAP SQL Statements is as simple as defining the recovery activity within the background job threshold override.

1. Navigate to the **IT-Conductor main menu → Support → Downloads** and download and import the following IT-Conductor SAP Transport Modules into the target SAP System (v6.76.1 IT-Conductor Function Module MS1K900554)

<figure><img src="/files/nGSasyMSeuTdvuUqJAJi" alt=""><figcaption><p>Figure 1: IT-Conductor Function Modules</p></figcaption></figure>

This will enable batch job monitoring in your SAP system. When the runtime threshold is reached, it will display the ABAP SQL Statement that is currently being executed.

2. After importing the transport, you must define the recovery activity for the job you want to monitor. In this case, let’s define a recovery activity for a background job.
3. Navigate to **Target System → Background jobs,** then click on the **Runtime gear icon → Override.**

<figure><img src="/files/5gTSd4vyuSUTY9XtTbi8" alt=""><figcaption><p>Figure 2: Override Option for Background Jobs</p></figcaption></figure>

4. You may choose to create an override from zero or [create an override from a template](https://docs.itconductor.com/users-guide/notifications/creating-threshold-overrides).

<figure><img src="/files/b3PREFMVJ6p0xdt5g67X" alt=""><figcaption><p>Figure 3: Creating a New Override</p></figcaption></figure>

5. Give the override a descriptive name.
6. On the object criteria, fill out the following fields:
   * Elapsed Time
   * Target System (SID)
   * Job Name you wish to track
   * Owner of the job

<figure><img src="/files/kM0f6AHXk5lNBCpEVakx" alt=""><figcaption><p>Figure 4: Object Criteria for Overrides</p></figcaption></figure>

7. Set the threshold values and the alert message that will be displayed whenever the job elapsed time goes over the defined threshold. The message will display the objects selected in the object criteria section.
8. Under the Recovery section, click on the drop-down arrow for recovery activities and select the predefined recovery activity for background jobs.

<figure><img src="/files/WphSrRm4SPdrL0uDapm5" alt=""><figcaption><p>Figure 5: Defining an Alert Message and a Recovery Activity for the Override</p></figcaption></figure>

9. Click on the **Save** icon.

A recovery action activity will also be triggered when an alert is generated for a long-running job.

#### **Tracking In-Flight Time**

You may also track the time in which a background activity exceeds the previously established elapsed time.

1. Navigate to **Target System → Background jobs** → **In-Flight Time**.

Monitoring the In-Flight Time is crucial for performance analysis and optimization in SAP environments. This practice aids in tracking the elapsed time of a background job and the duration for which the job has been active and processed. High or unexpected In-Flight Times may indicate potential issues, such as performance bottlenecks or resource constraints.

Utilizing IT-Conductor to monitor In-Flight Time ensures the efficient use of resources and timely completion of tasks. The chart below provides a visual representation. By clicking on a data point, a pop-up window displays a list of jobs and their respective In-Flight times. This view can be expanded, and the time and other attributes can be sorted as required for detailed analysis.

<figure><img src="/files/akVpNN8DTyapdMKwcYUr" alt=""><figcaption><p>Figure 6: Tracking In-flight Time</p></figcaption></figure>

<figure><img src="/files/e8unxrGI6PnwGFFPmWOd" alt=""><figcaption><p>Figure 7: In Flight Time Chart</p></figcaption></figure>

<figure><img src="/files/gVf3SK5bBZq1AuBZIVvW" alt=""><figcaption><p>Figure 8: Job In Flight Time Runtime</p></figcaption></figure>


# SAP Workload Monitoring

Workload Monitoring is an important part of performance management, especially in end-user experience. It provides information about the critical workload data such as response time distribution, memory usage for each transaction, CPU times, workload and transactions used by users, and overall health.

IT-Conductor provides a graphical and detailed view of the system's health. Each chart shows data points that you can click on for more information and performance analytics. Defining thresholds can help the user detect exceptions and generate alerts. When the threshold is breached, notifications are sent to subscribers ahead of time to prevent unexpected incidents that can impact the business.

### Features

There are various task types that can be monitored depending on the task of the associated application process. IT-Conductor allows for customizable configuration of monitoring workloads by [adding or configuring a retriever](/user-guide/monitoring/sap/netweaver/abap-system/workload/transaction-code) to add a specific task type in a particular system.

#### SAP Workload Types

![Figure 1: Sample Task Types in IT-Conductor Service Grid](/files/7zms1vX1LlulKtXn92Ry)

**Background** - Monitors the response time of the batch jobs and the transaction steps started by a background work process.

**Dialog** - Monitors dialog user's activity response time.

**HTTP** - Monitors the response time of web requests from the ICM based on the corresponding Internet protocols.

**RFC** - Monitors the communication response time between two independent SAP systems or between an external system and an SAP system.

**Update** - Monitors the response time of the SAP update task.

#### **Performance Overview** <a href="#performance-overview" id="performance-overview"></a>

This provides a high-level overview of system performance, while the workload overview provides detailed statistical data of a specific task type for the system performance analysis.

**Dialog Response Time** - Refers to the average response time for dialog transactions.

**Front-End Response Time** - Measures the time taken for the communication between the frontend (SAP GUI) and SAP application server.

**Dialog Users Logged In** - Displays the number of dialog users logged into the system within a specific time period.

**CPU Utilization** - Measures the CPU resource capacity utilized by all the processes and services in the system.

**Extended Memory Utilization** - Measures extended memory usage that is being used.

**Heap Utilization** - Displays the heap memory usage.

![Figure 2: IT-Conductor Performance Overview](/files/3thH9M5klRuUDbQ9BzBH)

#### Overall Service Health <a href="#overall-service-health" id="overall-service-health"></a>

[Service Health Monitoring](/overview/monitoring-concepts/application-performance-management) provides all the metrics and status of the entire system. The Workload is a sub-component in the [automated monitoring](/user-guide/reporting/creating-reports/service-health-kpi-report) that calculates the overall system's health. This allows simultaneously showing all the task types and the response times in graphs.

![Figure 3: IT-Conductor Service Health View](/files/vmdc4BGy7bahF7AsXlhX)

### Video <a href="#itcsapworkloadmonitoring-step-by-stepguide" id="itcsapworkloadmonitoring-step-by-stepguide"></a>

{% embed url="<https://vimeo.com/255798899>" %}




---

[Next Page](/llms-full.txt/1)

