> ## 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.

# Deploy Monitoring for SOAP

> Deploy the GermainUX Engine required to execute SOAP monitoring from the appropriate network location.

Components
[`Engine`](https://docs.germainux.com/main/germain-ux-engine)
[`Mobile App`](https://docs.germainux.com/main/germain-ux-mobile-app)
[`RUM JS`](https://docs.germainux.com/main/germain-ux-rum-js)
[`RUM Extension`](https://docs.germainux.com/main/germain-ux-rum-extension)

Availability
2017.1 or later

> **[Architecture](#architecture)**
>
> How SOAP monitoring runs

> **[Deploy the GermainUX Engine](#1-deploy-the-germainux-engine)**
>
> Place engine near service

> **[Verify the SOAP Request](#4-verify-the-soap-request)**
>
> Confirm a predictable response

> **[Validate Engine Connectivity](#6-validate-engine-connectivity)**
>
> Check network reach to services

**Deploying the GermainUX Engine for SOAP Monitoring: Steps and Prerequisites**

Deploy the GermainUX Engine required to execute SOAP monitoring from the appropriate network location.

## Architecture

SOAP monitoring is executed by a GermainUX Engine.

The Engine:

| | Action |
| - | - |
| 1 | Connects to the SOAP endpoint. |
| 2 | Sends the configured SOAP request. |
| 3 | Receives the response. |
| 4 | Measures the transaction. |
| 5 | Sends the monitoring results to GermainUX. |

The Engine must therefore have network access to both the SOAP service being monitored and the GermainUX environment.

## Prerequisites

Before deployment, confirm that:

* A GermainUX environment is available.
* A GermainUX Engine can be deployed.
* The Engine can communicate with GermainUX.
* The Engine can reach the SOAP endpoint.
* Required firewall access is available.
* Required proxy access is available.

> **Show all 13**
>
> * DNS resolution is available.
> * Required TLS certificates are trusted.
> * Required credentials are available.
> * The SOAP endpoint and operation are known.
> * A valid SOAP request has been tested.
> * The expected response is understood.
> * The request is safe to execute repeatedly.

When a WSDL is available, use it to identify:

* Service endpoint
* SOAP operation
* XML namespaces
* Request structure
* Required parameters
* Expected response

GermainUX monitors the operations you configure; every operation defined in the WSDL does not need to be monitored.

## 1. Deploy the GermainUX Engine

Go to:

**Germain Workspace > Left Menu > Wizards**

Deploy or select an Engine capable of reaching the SOAP service.

The appropriate Engine location depends on the service being monitored.

For example:

| Scenario | Recommendation |
| - | - |
| **Internal SOAP Service** | Deploy an Engine inside the network where the service is accessible. |
| **Internet-Accessible SOAP Service** | Use an Engine with outbound connectivity to the service. |
| **Multiple Locations** | Use different Engines when the service needs to be monitored from different network locations. |

## 2. Configure Network Access

Allow the Engine to communicate with the SOAP endpoint over the required HTTP or HTTPS port.

Verify:

* DNS
* Routing
* Firewall
* Proxy
* HTTP/HTTPS access
* TLS
* Certificates

If the service requires a client certificate, ensure that the certificate is available to the Engine and appropriately secured.

## 3. Verify Authentication Requirements

Determine the authentication mechanism required by the SOAP service.

Depending on the service and GermainUX configuration, this can include:

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

Authentication capabilities depend on the SOAP service, GermainUX version, and selected monitoring component.

Do not embed sensitive credentials directly into the SOAP request when an appropriate GermainUX authentication configuration is available.

## 4. Verify the SOAP Request

Before configuring continuous monitoring, verify that you have a working request.

Confirm:

* Endpoint
* HTTP method
* SOAP version
* Content-Type
* SOAPAction when required
* XML namespaces

> **Show all 10**
>
> * Request headers
> * Request body
> * Authentication
> * Required parameters

The request should return a predictable response that GermainUX can validate.

## 5. Verify That the Request Is Safe

SOAP monitoring executes the configured request repeatedly.

Use an operation that is safe for synthetic monitoring.

Avoid requests that unintentionally:

* Create production orders
* Submit payments
* Modify customer records
* Send messages
* Trigger irreversible workflows
* Generate unwanted production data

When a business transaction must be tested, use dedicated test data and an approved cleanup process.

## 6. Validate Engine Connectivity

From the Engine environment, verify that:

* The endpoint resolves.
* The endpoint is reachable.
* TLS negotiation succeeds.
* Authentication succeeds.
* The SOAP request can be submitted.
* A response is received within the expected time.

Once these requirements are satisfied, continue with **Configure Monitoring for SOAP**.

## Get More Information

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

[Contact GermainUX Support](https://docs.germainux.com/main/support.md).

## Get Help

> **[Contact GermainUX Support](https://docs.germainux.com/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.