Create and test SOAP, SAP, and REST data sources
The Integration Wizards simplify the process of using data from external services in your application. The wizards walk you through the process of getting details of the service, defining a data model from a WSDL or example XML/JSON, testing your configuration before generation, and creating data sources in your application from your selections.
The wizards are available on the Integrationlanding page in Designer Studio:
Once you have arrived at the last step in the wizard, it creates all records required to start using the data sources you selected, including classes, properties, authentication profiles, and connectors. The wizard also provides ruleset options that make it easy to export and reuse the Integration across your applications, including the option to add a new ruleset to your application to be used for it.
Click a link to see the steps to create a new SOAP, SAP, or REST integration:
Create a SOAP integration
Use the wizard to create a data sources in your application from operations in an external SOAP (Simple Object Access Protocol) service.
- From the Designer Studio menu, click
. The first step of the wizard displays:
A SOAP Integration requires a WSDL (Web Services Description Language), which describes the remote service. You need to provide a URL where the WSDL is hosted. If the server hosting the WSDL does not allow unauthenticated access, you are prompted for credentials. If your WSDL is unavailable via URL, you can upload the WSDL as a file by clicking the second radio button and providing the file location.
Many WSDLs do not stand alone, but rather link to other WSDLs (for example to share a data model). The wizard only allows you to specify a single file, so you cannot upload WSDLs that employ links.
- Click to move to the Select Operations step:
The wizard analyzes the WSDL that you provided and suggests the operations available for it. Select the check box next to each operation that you want to use as a data source in your application.
- If this connector requires authentication, click the Edit Authentication link. In the form that displays, select the authentication profile to use and provide any required information, such as authentication scheme (Basic or NTLM), user name, and password.
You can also reuse an existing authentication profile if you have already defined one for a different Integration that has the same authentication requirements. If the operations have different security requirements, you can clear the Use a single Authentication Profile for all Data Sources check box and select different profiles for each selected operation.
- To test the connection for the operation, click the button next to it. You can see the operation in tree view or as XML and verify the authentication used. Click to save your configuration in case you want to test multiple configurations or need to test another operation and come back. You can restore your configuration from the saved data at any point until you generate the Integration.
- Click View WSDL to review the WSDL file, which displays in its own window:
- When you are ready, move to the Review And Save step:
On this screen you can adjust several key components:
- Name your new Integration in the Integrationfield. The shortname is a unique identifier set from the Integration name that is used in the class names, the ruleset, and the authentication profile (if you select that option) generated.
- The Reuse Layer determines where this Integration can be reused within your application.
- You can fine tune where you want the records to be generated and set: the name of the new ruleset, the version of the existing ruleset, and whether you want to use a branch instead of a version of the production ruleset directly. If you name an existing Integration and intend to update it you do not have the option to choose your ruleset: it is set from the original Integration.
- Click to review a summary of the records the wizard creates to support this Integration.
- Depending on what ruleset options you have chosen and what security settings are in use in your application and its rulesets, a password (or passwords) might be required to proceed. If so, a prompt displays and you are not allowed to proceed until you provide all required passwords.
- When you are ready, click to create the Integration. When the Integration is created, it becomes available for selection and use in lists of data sources.
Create a SAP integration
From the Designer Studio menu, click
The process to create a SAP (Systems Applications and Products) integration is identical to that for creating a SOAP integration, except that there is an initial page where you enter account and access information:
The rest of the wizard is like the SOAP integration wizard, and similarly generates the records needed to support the new data integration.
Create a REST integration
Use the wizard to create a data sources in your application from methods in an external REST (Representational State Transfer) service.
- From the Designer Studio menu, click
. The first step of the wizard displays:
- Enter the endpoint URL of the service. If you have a URL that you have used to obtain a response from this service in the past, enter it in this field as-is. You are able to specify which pieces of the URL are parameterized later.
- Click to move to the Define Parameters step.
- The wizard analyzes the URL you provided and suggests the elements that might represent parameters. Each resource path and query string element found in the URL is listed individually. Resource path elements are assumed to be static by default; query string elements are always assumed to be parameters.
- If some of your resource path elements are not static and the value is to be treated as part of the request by the remote service, select the check box in the Is Parameter? column. The system generates a property as part of the request data model and substitutes that property's value for that part of the URL at run time. This is denoted in the URL at the top by the parameter's name displayed within brackets.
- Query string parameters are always considered part of the request; a property is created for them as well. Add additional parameters by clicking the relevant + icon and providing parameter details.
The resource path parameters are set only here and are part of the request data model for all data sources in this service. You have the option to vary query string parameters for the individual methods later.
- When you are ready, click Select Methods step:
to display the
- Verify the Connector Name. This is the unique identifier you reference from data pages and activities when using the data sources created from the methods.
- If this REST service requires authentication, click the Edit Authentication link. You can set up your authentication profile in the same way as described for SOAP Integrations, although for REST, all data sources created for a Connector must use the same profile.
- The standard methods for obtaining data from a REST service are GET, POST, PUT and DELETE. Select the check box next to each method that you want to use as a data source in your application.
- Click Configurenext to each selected method to manually configure the request and response for this particular data source:
You can adjust the query string parameters recognized by this method if not all methods accept the same ones. If you have a file of typical response data or, in the case of POST and PUT, typical request data, you can upload it here. This is used to generate the request/response data model so data returned by this data source can be mapped into your application. You can also click for this purpose (see the following step).
- Click to test the method using the form that displays.
- On the left side of the form, provide values for any parameterized parts of the URL (resource path parameters and query string parameters) and adjust the authentication details for this test if required. If you are testing the POST or PUT method, you can also use the tree view or XML/JSON tab to configure the body of the request. Click to view the response on the right.
- Click Save Data to add the current response (and request body if this is POST or PUT) to the list of samples used to generate the data model for this data source. This also saves the request configuration to be restored later in the same way you can with SOAP and SAP.
- When you are ready, click to display the Review and Save step. This step is the same as for the SOAP wizard, as described earlier in the article.
- When you are ready, click
to create the Integration. When the Integration is created, it becomes available for selection and use in lists of data sources.
Published November 1, 2013 — Updated April 7, 2016