Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Integration wizards

Updated on June 27, 2016

You can define and manage interfaces between an application that is hosted on the Pega 7 Platform and the external systems that the application connects to for data. For example, you can connect to an external weather service from the Pega 7 Platform to get the weather conditions of a city, based on its postal code.

Integration wizards simplify the process of using data from external services in your application. The wizards walk you through the process of getting the details of the services, defining a data model from a WSDL document, example XML document, or JSON document, testing your configuration, and creating data sources in your application.

You can access the integration wizards by clicking Designer Studio > Integration > Connectors, as shown in the following figure:

Opening the integration wizards from Designer Studio

Integration wizards

When you use the wizards to create data sources, the system generates all the records that are required to use the data sources. These data sources include classes, properties, authentication profiles, connectors, and so on. The wizards provide ruleset options for exporting and reusing the integration across your application.

The Pega 7 Platform provides wizards for SOAP, REST, and SAP integration.

SOAP integration

Use the New SOAP Integration wizard to create data sources in your application from the operations in external SOAP services. Each external SOAP service is described by using a WSDL document, which you can upload by specifying a URL or file. The system creates one data source for each operation that you select in the wizard. You can configure the authentication for the data sources and test the operations that you select.

Selecting SOAP operations

SOAP operations

Testing SOAP operations

SOAP operation testing

For more information, see Creating SOAP integration.

REST integration

Use the New REST Integration wizard to create data sources in your application by using standard methods to obtain data from external REST services. A REST service defines a set of resources and actions that can be accessed by using an endpoint. You can provide the endpoint URL of the REST service in this wizard, update the resource path and query string parameter names, and add custom headers and authentication if needed. The system creates a data source for each REST integration based on this information and the methods that you select in the wizard. You can set up the data model for your REST integration and obtain responses or upload files that contain requests and responses to generate sample request and response data.

Updating resource path, query string parameters, and headers for a REST endpoint URL

Resource path, query string parameters, and headers for a REST endpoint URL

Defining a data model for REST integration

Data model for REST integration

For more information, see Creating REST integration.

SAP integration

Use the New SAP Integration wizard to create data sources in your application that are based on input documents that describe external SAP services. You can upload an IDoc XSD or WSDL document as the input by specifying a URL or file. You can generate an integration layer for both the input types and an additional data layer if the input is an IDoc XSD document. The wizard is similar to the New SOAP Integration wizard except that this wizard allows IDoc XSD input documents and requires that you configure the authentication details that you want to use to connect to an SAP system.

Selecting an input document for SAP integration

Input document for SAP integration

Configuring an SAP connection

SAP connection configuration

For more information, see Creating SAP integration.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us