Configuring Cloud Connector Services (SOAP)

Cloud Application Integration (On-Premises) : Administering CloudStreams : Creating Custom Cloud Connectors : Configuring Custom SOAP Cloud Connectors : Configuring Cloud Connector Services (SOAP)

In this task, you will configure the cloud connector service you just created in the New Cloud Connector wizard. You will:

Configure the operations for the cloud connector service and map their signatures.

Select any abstract objects that will be needed by the service's Complex type operations (if any).

To configure a cloud connector service (SOAP)

1. Start Software AG Designer and open the CloudStreams Development perspective by clicking Window > Open Perspective > Other > CloudStreams Development.

2. In the CloudStreams Connectors view, expand your CloudStreams Provider project and click the cloud connector you just created (as described in Creating Custom SOAP or REST Cloud Connectors).

The Overview page is displayed, showing the general information you defined in the New Cloud Connector wizard.

3. Click the Services link in the Connector Content section of the page (or click the Services tab at the bottom of the page).

If you already created a cloud connector service on page 2 of the New Cloud Connector wizard, the Services Configuration page will show your new service and the default nodes Abstract Objects and Operations.

If you did not create a cloud connector service in the New Cloud Connector wizard, create it now by right-clicking the Services node, selecting Add Service and specifying the SaaS provider's WSDL that CloudStreams will use to generate the document types. For a description of the Document Type Package field, see Creating Custom SOAP or REST Cloud Connectors.

4. Add any abstract objects that will be needed by the service's Complex type operations.

CloudStreams supports the abstract object types businessObject and schemaObject.

For a businessObject, perform the following steps:

a. Click the Abstract Objects node.

b. In the Configuration section of the page, in the Type field select businessObject.

c. In the Document Type field, select the document name of the abstract object from the drop-down list.

d. Next to the Business > List field, click the Add icon.

The Lookup Selection dialog appears, displaying the list of lookup services that implement the boList lookup type.

e. Next to the Business Object > Describe field, click the Add icon. The Lookup Selection window appears, displaying the list of lookup services that implement the boDescribe lookup type.

f. In the Lookup Selection dialog boxes, select the lookup services that you implemented for the abstract object and click OK.

The selected services will be shown in the Service table.

For a schemaObject, perform the following steps:

a. Click the Abstract Objects node.

b. In the Configuration section of the page, in the Type field, select schemaObject.

c. In the Document Name field, select the document name of the abstract object from the drop-down list.

d. Next to the Schema Object > List field, click the Add icon.

The Lookup Selection window appears, displaying the list of lookup services that implement the soList lookup type.

e. In the Lookup Selection dialog boxes, select the lookup service that you implemented for the abstract object and click OK.

The selected service will be shown in the Service table.

5. Click the Operations node and select the operation type for each operation in the Configuration section of the page as follows:

Field	Description
Operation/Name	(Read-only field.) The operation name.
Type	Select the type of the operation: SIMPLE: This is any operation that has all the information needed to build the messages for a connector's operation based solely on the WSDL. A simple operation neither requires dynamic signature updating nor uses an abstract type definition. COMPLEX: This is any operation that requires additional efforts to capture the metadata needed to build messages and to invoke a provider's service because the WSDL by itself does not suffice. Not every provider will have Complex operations. METADATA: Metadata operations are special operations provided by the provider which are used by the connector to capture the additional information that is needed for a complex operation. Not every provider will have Metadata operations. LOGIN/LOGOUT: The Login and Logout operations are those that are invoked when a managed connection pool is enabled (login) or disabled (logout). Some providers require login/logout methods to be invoked in order to set up a session for the user to use when invoking any of the business operations. Other providers do not require them.
Hide	If you select this option for any operation, the operation will not be visible while configuring a Cloud connector service.
Description	Optional. Enter a description for the operation.

Alternatively, you can select the types for the operations individually, by clicking an operation and then selecting its type.

6. Add the operation's input parameters as follows.

You can add predefined parameters (if the operation has any) and you can add additional ones as well.

a. Right-click the operation and select Add Parameters.

The “Configuration” section of the page displays the operation's predefined parameters (if any).

b. If the operation has any predefined parameters, select the check box next to each one you want to add. Mandatory parameters are selected by default and you cannot deselect them.

c. Complete the following fields in the Configuration section.

Field

Description

Name

The parameter's name. (For predefined parameters, this is Read-only.)

Required

Specifies whether the parameter is required.

Default Value

You can provide a default value for any parameter by typing a value in the Default Value field. If the variable is null in the input pipeline, this default value will be used at run time. The value given at run time always takes precedence over the default value. However, if the existing default value is of type "fixed default", the overwrite will fail.

Note:

Parameters have various data validation constraints that apply to them. These constraints are indicated by an icon next to each parameter. For information about these constraints, see Viewing the Constraints Applied to Variables.

Description

Optional description of the parameter.

d. If you want to add additional parameters, click the Add button and complete the fields in the Configuration section (described above).

e. Click OK.

7. Specify the input/output mapping for an operation as follows:

a. Right-click the operation and select Add Mapping.

b. In the Configuration-Signature Mapping section of the page, right-click a parameter you want to map, select Set Configuration and complete the following fields.

Field	Description
Name	Assign a name to the mapping.
Type	Select the data source type: Cookie: HTTP cookies. For example, the Salesforce.com connector inserts the session token from a valid login in the SOAP header of the business operations to be executed. Other providers do the same thing; however, the token is managed via cookies instead of the SOAP header. Header: Request or response HTTP transport headers for the support connection factory implementation. IData: IData is a variable name that is associated with the connection instance when the service is invoked. It is a subset of those configuration fields from the selected groups. Not all fields are eligible for use as a mapping step since their values may not be changed or have any useful meaning in this context. Literal: A constant value. Parameter: Primarily used for REST handlers. Service: The Service type applies to the source, not to the target. Select Service if you want the source to call a given service to perform certain tasks and to map the output of the service to a target. The service must adhere to wm.cloudstreams.service.common.lookup.specs:mapServiceSpec. If an error occurs related to service validation or execution, CloudStreams throws a Mapping Exception. XPath: Enables you to define an XPath expression.
Value	If you selected the Service type, the Value field's drop-down list will display all services that conform to the specification wm.cloudstreams.service.common.lookup.specs:mapServiceSpec. When you choose a service, the Formatter Service Arguments Configuration dialog appears, where you can add/delete/reset the input details specified in the service and specify arguments. If you selected a different type, choose the appropriate connection group field from the drop-down list. The list of fields displayed in the drop-down list depends on the type of the connection group you configure in the Connection Configuration page (as described in Creating Run-Time Connections (SOAP)).
Required	Specify whether the parameter is required.
Fixed	A fixed mapping means its values cannot be changed at run time.

8. Define global mappings, if required by your provider.

Global mappings are mapping statements that must be executed for all Simple and Complex type operations (if required by your provider). These global mapping steps are used by the provider to inject the session token into the SOAP header before invoking the service. Some providers might have configuration values that could be included for every operation. Other providers have configuration content in their SOAP header.

To specify global mapping, right-click the service name, select Global Mapping and complete the fields in the Configuration section of the page as follows:

Field	Description
Name	Assign a name for the global mapping.
Description	Enter a description for the global mapping.
Parameter Type	Select IN or OUT.
Required	Specify whether this is a required mapping.
Fixed	A Fixed mapping means its values cannot be changed at run time.
Mapping Key-Type	Select the source mapping type: Cookie Header IData Literal Parameter Service XPath For descriptions, see the previous step.
Mapping Key-Key	Enter the source mapping key. For example, if your source mapping type is IData, you might enter the key cr.username.
Mapping Value-Type	Select the target mapping type, which can be: Cookie Header IData Literal Parameter Service XPath
Mapping Value-Key	Enter the target mapping key. For example, if your target mapping type is XPath, you might enter the key tns:login/tns:us.
Document Name	The document type generated for that SOAP operation.

9. You can add/delete additional services in the Services page, as long as the connector is not deployed.

10. View the Manifest tab, which shows read-only fields containing attributes whose values were captured from your custom cloud connector definition. The version of the CloudStreams Development Plug-in (Created-By) is also displayed. For imported plug-ins created in a Designer release prior to 9.7, this information is not shown.

Contact Support | Community | Feedback