SOAP Integration in Pega from scratch

1. Launching the SOAP Integration Wizard

In Dev Studio, go to:

Configure → Integration → Create SOAP Integration

This opens the SOAP Integration Wizard.

The first step is to provide a WSDL URL, which defines the structure of the web service.
For this example, we will use:

http://www.dneonline.com/calculator.asmx?WSDL

Click Next to continue.

2. Reviewing Service Metadata

After loading the WSDL, the wizard displays:

Service name
Port name
Endpoint
Available operations

You can test operations from this screen. Once testing is done, click Next.

3. Integration Layer Configuration

The wizard now shows:

The integration class
The ruleset
The context where the integration assets will be created

Click Preview Records to see all rules the wizard will generate. This modal displays the rule types and quantities.

When clicking Create, you may encounter an error. This happens because Pega sometimes does not automatically create the integration class for SOAP services.

If this occurs, manually create the class where all integration assets will be stored. After creating the class, click Create again.

This time, the SOAP connector will be successfully generated.

You’ll see:

Class name
Ruleset
WSDL
All created data sources
Option to Undo Generation, which removes all generated rules if needed

Click Close when finished.

4. Reviewing the Generated Connector

Navigate to the integration class:

App Class → Calculator → Integration-Connectors → Connect SOAP

Here you’ll find one connector rule per operation defined in the WSDL.

Inside each connector you can verify:

Endpoint details
Error handling
Processing options
Simulation settings

Connector Request & Response

Under the Request tab, you’ll find:

SOAP headers (if any)
Request parameters
The XML Stream rule (e.g., AddParameters) responsible for request mapping

The Response tab includes the same structure for mapping outputs.

5. Creating the Data Page

Next, create a data class to hold the response from the service.
Then create a Data Page that will invoke the SOAP connector.

Configuration:

Source type: Connector
Connector type: SOAP
Connector name: Add (for this example)

You can try the other operations later as practice—feel free to leave a comment if you have issues.

6. Request Data Transform

Create a Request Data Transform that passes two parameters:

intA
intB

Make sure these parameters exist both in the Data Page and in the Data Transform.

Map the two variables to the fields expected by the SOAP service.

7. Response Data Transform

Pega automatically generates a boilerplate Response Data Transform, but you can customize it.

Important note:
If the connector response returns a page, you must create the corresponding property in your data class and map the values one-to-one.
If your data page runs successfully but the response appears empty, it’s usually because this mapping step was missed.

8. Testing the Integration

To test the integration:

Open the connector rule
Scroll to the bottom
Click Test Connectivity

If the service fails, Pega will show the error details.

To test the Data Page:

Open the Data Page
Click Actions → Run
Enter parameters (intA and intB)
Validate the results and response status

If any errors occur, they will appear in the results panel.

Summary — Complete Integration Steps

Obtain the WSDL
Example: http://www.dneonline.com/calculator.asmx?WSDL
Validate required headers or authentication (Postman helps with this).
Go to
Configure → Integration → Create SOAP Integration
and follow the wizard.
Verify generated classes and rules.
Test connectivity in the connector.
Create:
- Data class
- Data Page
- Request Data Transform
- Response Data Transform
- Any needed properties
Map request and response values.
Run the Data Page and validate that the service works end-to-end.

You can watch the full step-by-step demonstration in the accompanying video.
Feel free to leave questions or comments—happy integrating!

Pega Sandbox