WS-BPEL: Importing or Exporting an Integration Process (SAP Library

WS-BPEL: Importing or Exporting an Integration Process

Use

Business Process Management supports the process definition part of WS-BPEL 2.0 (Web Services Business Process Execution Language). For more information about WS-BPEL, go to https://www.sdn.sap.com/irj/sdn/docs?rid=/webcontent/uuid/b4313088-0901-0010-3d97-9566d764c212.

You can use WS-BPEL as the exchange format to export an integration process to a non-SAP system and execute it there. You can also use the WS-BPEL format to import an integration process from a non-SAP system and execute it on the Integration Server. For import and export restrictions, see SAP Note 709650. Version BPEL4WS 1.1 is also supported.

Note

WS-BPEL is not intended for importing or exporting integration processes between Enterprise Service Repositories. Instead, use the import function in the Enterprise Services Repository (see: Transporting XI Objects).

Export

The export exports the integration process definition in WS-BPEL format. All data types, message types, and operations referenced in the process definition are exported as a WSDL description.

You can display the WS-BPEL representation of the process definition to be exported in the process editor at any point (see also: Process Editor). You can display the corresponding data type definitions as a WSDL description in the output area.

Export Files

The process definition displayed in the Process Editor is exported as a file. The export file is a .zip file that contains the following files:

● <name>.bpel: Definition of the integration process as displayed in the process editor

● <name>.wsdl: Referenced data types, message types, and so on

● <name>-extnTypes.wsdl: Referenced enhancement types, operations, and so on

You give the .zip file a name. This name is also used for the .bpel and .wsdl files. The .zip file does not contain any path specifications or directories.

Partner Links

For a valid WS-BPEL description to be created during the export, besides the business process definition, the export also requires the partner link type and the partner link.

A partner link type describes the relationship between two services and the role that each service has. For example, the partner link type BuyerSellerLink can define the roles Buyer and Seller. A partner link defines the services with which an integration process interacts. Each partner link has a partner link type. Multiple partner links can have the same partner link type, for example, a procurement process can interact with multiple vendors but use the same partner link type for all vendors.

Since this information is configured in the Integration Directory and is not part of the integration process definition in the Enterprise Services Repository, it cannot be exported automatically. Furthermore, a service interface can be used in different ways in different steps. For example, an integration process can use a service interface in a receive step to receive a purchase order request. In this case, you could define the partner link type PurchaseOrderRequest for the service interface. The same service interface can then be used in a send step later on in the integration process, for instance, to send a purchase response. You could then define the partner link type PurchaseOrderResponse for the same service interface.

The export generates default entries for the partner link type, partner link, and role. SAP recommends that you enter a name that is meaningful within this integration process for the partner link type at least.

Import

The import only imports the WS-BPEL definition of an integration process. The import expects that the data types, message types, and message interfaces (WSDL operations) referenced in the process definition are already available in the relevant namespace, as explained in the following example. The data types and so on are not actually imported but are merely used to support the import procedure.

Example

The process definition to be imported references a message Msg in the namespace http://sap.com/xiexample. The process definition is to be imported to software component version MySWCV. The import expects that there is a namespace http://sap.com/xiexample in this software component version that contains the XI message type Msg.

Import Files

The import expects a .ZIP file (<name>.zip) with the following files:

● <name>.bpel (process definition)

● <name>.wsdl (referenced data types, message types, and so on)

● <name>-extnTypes.wsdl: (referenced enhancement types, operations, and so on)

The .zip file must not contain any path specifications or directories.

Handling Container Elements

Integration processes use message-based container elements in the properties of particular steps and in correlations. These correspond to variables in WS-BPEL. A container element references a service interface that in turn references a message type. However, a WS-BPEL variable references a message type directly. Therefore, no service interface is specified when a WS-BPEL variable is imported.

SAP recommends that you create the required service interfaces in the Enterprise Services Repository before beginning the import. You can then assign the service interfaces during the import in the wizard. If you do not create the required service interfaces beforehand, the process definition will still be imported but the values for the various properties will be missing.

Export an Integration Process

In the process editor editing area, choose This graphic is explained in the accompanying text with the quick info Switch Editor → BPEL Display. The editing area displays the integration process definition in WS-BPEL format. You can also select BPEL4WS format.

You can also display the referenced data types, message types and so on as a WSDL description. To do so, in the output area, choose This graphic is explained in the accompanying text with the quick info Switch View → WSDL Display.

1. In the editing area, choose This graphic is explained in the accompanying text with the quick info Export.

A wizard is displayed.

2. In the Version field, select the required export format.

3. Choose Browse and enter a name for the export files (<name>.zip, <name>.bpel, <name>.wsdl).

4. Select Export Partner Links and choose Continue.

For all send and receive steps, the wizard displays a line that displays the abstract message interface, as well as the defaults for the Partner Link, Partner Link Type and Role fields.

5. If the service interface used in a particular step is not found automatically, select it from input help instead.

6. Enter a meaningful name for the Partner Link Type at least.

You can of course do the same for Partner Link and Role.

7. Choose Finish.

The subsequent system messages indicate whether the export was successful or not.

Import an Integration Process

...

1. Either create a new integration process or open the existing one that you want to import to.

Note

If you import to an existing integration process it will be overwritten.

In the process editor, choose This graphic is explained in the accompanying text with the quick info Switch Editor → BPEL Display. The editing area displays the integration process definition either in WS-BPEL or BPEL4WS format.

2. Choose This graphic is explained in the accompanying text with the quick info text Import.

A wizard is displayed.

3. Choose Browse and specify the .zip file (<name>.zip) that contains the import files (<name>.bpel and <name>.wsdl, <name>-extnTypes.wsdl).

<name> must be the same for all files. The .zip file must not contain any path specifications or directories.

4. Choose Continue.

The wizard displays all container elements that reference a message.

5. Assign the relevant service interfaces.

6. Choose Continue.

The wizard displays all container elements that are used in correlations and that reference messages.

7. Assign the relevant abstract interfaces.

8. Choose Finish.

The subsequent system messages indicate whether the import was successful or not.