More about SOAP connector rules

Development

For information about how to build a SOAP connector, see Building SOAP Connectors, a document on the Integration section of the Pega Developer Network. For information about testing SOAP connectors, see Testing Services and Connectors, also on the Pega Developer Network.

Axis2, SOAP attachments, XML Literal data type, SOAP 1.2

The Process Commander SOAP connector architecture uses an Axis client that serializes and deserializes the SOAP messages. The default Axis client is Axis 1.2.1, but there are times when you may need to manually configure a SOAP connector to use Axis2 instead:

• If you want to send SOAP with attachments. In this case, see PRKB-25026 How to configure a SOAP or dotNET connector to send or receive SOAP with attachments.
• If the Web service requires that the SOAP Request envelope belongs to the SOAP version 1.2 namespace. In this case, you need to specify Axis2 and SOAP 1.2 on the Advanced tab.
• If there are any XSD constructs in the Web service's WSDL file that the Connector Accelerator could not interpret (untyped elements, wildcards, nested choice groups, for example)

As described in PRKB-24093 How to verify and troubleshoot rules created from XSD or WSDL by Accelerators, some XSD constructs are too ambiguously defined to be interpreted by the Accelerators. For many of these issues, a work-around is to modify the generated XML parse or stream rule yourself so that it interprets the data as you intended. For SOAP connectors, however, XML objects are mapped to and from XML Page parameters whose schema is described in model rules, not XML parse and stream rules. If the generated model rules cannot handle the XSD constructs in your WSDL file, complete the following steps to map the data to and from XML Parse and stream rules instead:

1. Use the Metadata and Connector Accelerator to generate XML parse and stream rules from the WSDL.
2. Open the connector rule, select the Advanced tab and specify Axis2 in the Axis Version field.
3. Still on the Advanced tab, delete the rows in the Schema Definitions sections.
4. On the Request tab, change the data type of the parameters being mapped from XML Page to XML Literal, change the Map From option from Clipboard to XML Stream, and then identify the stream name in the Map From Key field.
5. On the Response tab, change the data type of the parameters being mapped from XML Page to XML Literal, change the Map To option from Clipboard to XML Parse, and then identify the stream name in the Map To Key field.

You can also map the values to and from single-value clipboard properties and then call the parse or stream rule from the connector activity.

Asynchronous execution by the Pega-IntSvcs agents

To perform SOAP connector processing asynchronously:

1. Create a Connector Request Processor data instance that defines the characteristics and classes of queued requests. Associate this data instance with the RuleSet that contains the Connect SOAP rules.
2. On the Service tab of the Connect SOAP rule, select queuing in the Intended for field and identify the Connector Request Processor created in step 1. Leave the Response tab blank; it is not used.
3. Update one or more Data-Admin-Queue instances to ensure that the ProcessConnectQueue agent entry within the Pega-IntSvcs agent is enabled with an appropriate time period.
4. In the activity steps that execute the Connect-SOAP method, set the Execution Mode parameter value to Queue.
5. Test.

Performance Statistics

For information on gathering performance information about this connector see Testing Services and Connectors, a document on the Integration pages of the Pega Developer Network.

Upgrading from V4.2 to version V5.X

If your system is upgraded from V4.2 and includes SOAP or dotNET connector rules generated in V4.2, see Pega Developer Network article PRKB-24060 How to Upgrade SOAP and dotNET Connector Rules from V4.2 to V5.1.

	Integrator task, connector, SOAP
	Creating Connector Simulations About Connect Request Processor data instances Connect-SOAP method How to detect lengthy connector executions Understanding the Pega-IntSvcs agent
	W3C SOAP 1.1 Specification W3C HTTP 1.0 Specification
	Atlas — Standard SOAP Connector rules

About Connect SOAP rules