> ## Documentation Index
> Fetch the complete documentation index at: https://docs.germainux.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure Monitoring for SOAP

> Configure GermainUX to periodically execute a SOAP request, validate the response, measure performance, and detect availability or functional issues.

Components
[`Engine`](/main/germain-ux-engine)
[`Mobile App`](/main/germain-ux-mobile-app)
[`RUM JS`](/main/germain-ux-rum-js)
[`RUM Extension`](/main/germain-ux-rum-extension)

Availability
2017.1 or later

> **[5. Configure the SOAP Request](#5-configure-the-soap-request)**
>
> XML request body setup

> **[10. Configure SOAP Response Validation](#10-configure-soap-response-validation)**
>
> Define a valid response

> **[13. Configure Monitoring Frequency](#13-configure-monitoring-frequency)**
>
> Interval by service criticality

> **[Troubleshooting](#troubleshooting)**
>
> Resolve common SOAP issues

**Configuring SOAP Monitoring with GermainUX: Steps and Best Practices**

Configure GermainUX to periodically execute a SOAP request, validate the response, measure performance, and detect availability or functional issues.

## 1. Create a SOAP Monitor

Sign in to GermainUX Workspace.

Go to:

**Germain Workspace > Left Menu > Wizards**

Open the HTTP, web-service, or SOAP monitoring wizard available in your GermainUX version.

Workspace labels and the exact wizard name may vary by GermainUX version and component type.

Create a new monitoring component.

## 2. Select the Engine

Select the GermainUX node and Engine that will execute the SOAP request.

Choose an Engine that:

* Can reach the SOAP endpoint
* Has the required network access
* Has the appropriate proxy configuration
* Can use the required authentication
* Represents the monitoring location you want to measure

## 3. Configure the Endpoint

Enter the SOAP service endpoint.

For example:

`https://service.example.com/OrderService`

Select the HTTP method required by the SOAP service.

For most SOAP operations:

`POST`

Use the exact endpoint specified by the service or WSDL.

## 4. Configure SOAP Version and Headers

Configure the HTTP and SOAP headers required by the service.

Depending on the service, these can include:

* Content-Type
* SOAPAction
* Authorization
* Custom HTTP headers
* Correlation identifiers
* Customer-defined headers

### SOAP 1.1

SOAP 1.1 commonly uses:

`Content-Type: text/xml`

and may require:

`SOAPAction`

### SOAP 1.2

SOAP 1.2 commonly uses:

`Content-Type: application/soap+xml`

Always use the values required by the monitored service.

## 5. Configure the SOAP Request

Enter the XML request body required for the operation.

Example:

```html theme={null}
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:svc="http://example.com/service">
    <soapenv:Header/>
    <soapenv:Body>
        <svc:GetServiceStatus>
            <svc:ServiceName>OrderService</svc:ServiceName>
        </svc:GetServiceStatus>
    </soapenv:Body>
</soapenv:Envelope>
```

Configure the appropriate:

* Envelope
* Namespace
* Operation
* Parameters
* Environment-specific values

Use a request that is safe to execute repeatedly.

## 6. Configure Authentication

Select the authentication configuration required by the service.

Depending on the service and GermainUX version, supported connection settings can include:

* HTTP Basic authentication
* Request headers
* SOAP-specific headers
* Client certificates
* TLS
* Proxy
* Customer-defined tokens or credentials

Sensitive credentials and tokens should use GermainUX authentication settings instead of being embedded directly in the SOAP envelope whenever supported.

## 7. Configure Proxy and Certificates

If the SOAP service is accessible through a proxy, configure the required proxy settings.

If mutual TLS or another client-certificate mechanism is required, configure the appropriate certificate.

Verify certificate expiration and trust configuration before enabling the monitor.

## 8. Configure Timeout

Define how long GermainUX should wait for the SOAP transaction to complete.

The timeout should be long enough for normal service behavior while still allowing GermainUX to identify abnormal response times.

A timeout can indicate:

* Service unavailable
* Network issue
* Service overload
* Slow downstream dependency
* Application problem

## 9. Configure HTTP Response Validation

Define the HTTP status expected from a successful request.

For example:

`200`

Do not rely exclusively on the HTTP status to determine whether the SOAP operation succeeded.

A SOAP service can return an HTTP response while the actual business operation has failed.

## 10. Configure SOAP Response Validation

Configure conditions that determine whether the returned SOAP response is valid.

Validation can include:

* Expected text
* Expected XML content
* Missing expected content
* Unexpected content
* SOAP Fault detection
* Response-size conditions
* Customer-defined response conditions

For example, GermainUX can verify that:

**Expected**

`<status>SUCCESS</status>`

is present.

And that:

**Unexpected**

`<soap:Fault>`

is not present.

The validation should represent the actual functional success of the monitored operation.

## 11. Configure SOAP Fault Detection

Configure the monitor to identify SOAP Fault responses.

SOAP Faults can indicate:

* Invalid request
* Authentication failure
* Application exception
* Invalid parameters
* Backend failure
* Business-rule failure
* Downstream integration failure

Capture the available fault information as diagnostic evidence when appropriate and permitted.

## 12. Select the KPI

Select the KPI used to store the monitoring result.

Depending on your GermainUX configuration, SOAP monitoring can populate KPIs such as:

* SOAP Service Availability
* SOAP Transaction
* SOAP Error
* SOAP Fault
* HTTP Request

Configure the KPI appropriate for the monitoring objective.

## 13. Configure Monitoring Frequency

Define how frequently the SOAP request should execute.

The appropriate interval depends on:

* Business criticality
* Expected SLA
* Service capacity
* Monitoring overhead
* Request type
* Production impact

For example:

**Every 5 minutes**

GermainUX executes the SOAP request every five minutes and evaluates the result.

Critical services may require more frequent monitoring.

Avoid an execution frequency that creates unnecessary load on the monitored service.

## 14. Configure Measures

SOAP monitoring measures can include:

* Request count
* Success count
* Failure count
* Availability percentage
* Response time
* Error rate
* SLA-violation count
* Response size

These measures can be used for dashboards, reports, SLAs, rules, and historical analysis.

## 15. Configure Pivots

Analyze SOAP monitoring results using dimensions such as:

* Service
* Operation
* Endpoint
* Application
* Environment
* Monitoring location

> **Show all 11**
>
> * HTTP status
> * Error
> * SOAP Fault
> * Server
> * Business process

This enables teams to compare SOAP behavior across services and environments.

## 16. Configure SLAs

Configure SLAs for conditions requiring attention.

Examples include:

### Availability

`SOAP Service Availability < 99.9%`

### Response Time

`Response Time > 2 seconds`

### Failure

`SOAP Request = Failed`

### SOAP Fault

`SOAP Fault = Detected`

### Functional Validation

`Expected Response = Missing`

Thresholds should reflect the expected behavior and business importance of the service.

## 17. Configure Rules and Automated Analysis

Use GermainUX Rules for more advanced conditions.

Examples:

* Multiple consecutive failures
* Error-rate increase
* Response-time degradation
* SOAP Fault frequency increase
* Different behavior between environments
* Abnormal performance compared with historical behavior

Rules can combine SOAP monitoring data with other GermainUX telemetry.

## 18. Configure Alerts and Watches

When a SOAP condition meets an SLA or Rule, GermainUX can:

* Send an alert
* Notify users through a Watch
* Generate a report
* Call an authorized HTTP endpoint
* Execute an authorized script
* Start an approved diagnostic workflow
* Start an approved remediation workflow

For example:

**SOAP request fails 3 consecutive times → Alert Integration Team**

or:

SOAP Fault detected
Collect additional diagnostics
Notify Application Support

## 19. Configure Dashboards

Create dashboards to monitor:

* Availability
* Response time
* Success rate
* Failure rate
* SOAP Faults
* SLA violations

> **Show all 11**
>
> * Performance trends
> * Services
> * Operations
> * Environments
> * Monitoring locations

For critical integrations, combine SOAP data with related application, server, database, network, and business-process KPIs.

## 20. Validate the Configuration

After saving the component, execute or wait for a SOAP monitoring cycle.

Confirm that:

**1. The Engine executes the request**

**2. The SOAP endpoint receives the request**

**3. Authentication succeeds**

**4. A response is returned**

**5. Response time is recorded**

**6. HTTP status is recorded**

**7. Response validation executes**

**8. SOAP Faults are detected when applicable**

**9. The correct KPI is generated**

**10. The result appears in GermainUX**

**11. SLA status is evaluated**

**12. Alerts or Watches operate as expected**

## Troubleshooting

### SOAP Request Does Not Execute

Verify:

* Engine is running
* Component is enabled
* Schedule is configured
* Correct Engine is selected

### Endpoint Cannot Be Reached

Verify:

* Endpoint URL
* DNS
* Firewall
* Proxy
* Port
* TLS configuration
* Network routing

### Authentication Fails

Verify:

* Username and password
* Authentication type
* Token
* Client certificate
* Required headers
* Credential expiration

### HTTP Request Succeeds but Monitor Reports a Failure

Verify the configured response-validation conditions.

The HTTP transaction may succeed while the SOAP operation returns:

* SOAP Fault
* Unexpected business result
* Missing expected content
* Invalid XML
* Error response

### SOAP Fault Is Returned

Review the available:

* Fault code
* Fault string or reason
* Fault detail
* Request parameters
* Authentication
* Application logs
* Related integration errors

### Response Time Is High

Correlate the SOAP transaction with other monitored data, including:

* Application performance
* Server resources
* Database performance
* Network performance
* Logs
* Downstream integrations

SOAP monitoring measures the end-to-end request. Additional monitoring is required to identify internal server-side execution bottlenecks.

## Get More Information

GermainUX can help determine which monitoring, analytics and automation capabilities are appropriate for your SOAP environment.

[Contact GermainUX Support](/main/support.md).

## Get Help

> **[Contact GermainUX Support](/main/support.md)**
>
> The Germain Team can help you set this up.

> **Can't find what you need?**
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.