uCosminexus Service Platform, Reception and Adapter Definition Guide

[Contents][Glossary][Index][Back][Next]

2.2.1 Work flows for defining a SOAP reception

There are two work flows for defining a SOAP reception.

Defining a SOAP reception before defining a business process
If both of the following conditions are satisfied, first create a SOAP reception based on the WSDL, and then define the receive activity and reply activity for the business process.
  • An interface with the service requester has been defined.
  • A WSDL has been created that conforms with the specified interface.
In this case, the operations of the receive and reply activities and the message definitions must be defined on the business process so that they are suitable for WSDL interface input when the SOAP reception is created.

Defining a SOAP reception after defining a business process
If a business process has already been defined, define a SOAP reception that is suitable for the defined business process. Before adding a SOAP reception, you need to create a WSDL that is suitable for the message definition for the operations of the receive and reply activities for the business process and the allocated variables.
Define a SOAP reception so that the operations defined in the receive and reply activities for the business process, and the allocated variables can be called.

The following describes the work flows for defining a SOAP reception according to the above two definitions.

Organization of this subsection
(1) Defining a SOAP reception before defining a business process
(2) Defining a SOAP reception after defining a business process

(1) Defining a SOAP reception before defining a business process

The following figure shows the work flow, in which you define a SOAP reception before defining a business process, and define the receive and reply activities (that are suitable for the interface) for the business process.

Figure 2-2 Work flow for defining a SOAP reception (when defining a SOAP reception before defining a business process)

[Figure]

The following describes the operations for defining a SOAP reception before defining a business process.

(a) Adding a business process

Create a business process for which a SOAP reception is to be defined. Define the business process so that the interface will be suitable for the contents of the SOAP reception to be defined in (b). Therefore, in this stage, you do not have to arrange activities, define variables, or enter information in the dialog box used to define detailed definitions of individual activities.

For details about how to add a business process, see 5.2.1 Adding New Business Processes in the manual Service Platform Basic Development Guide.

(b) Adding a SOAP reception

In the Add User Defined Reception wizard, enter the created WSDL, and add a SOAP reception.

For details about how to add a new SOAP reception, see 2.2.2 Adding a SOAP reception.

(c) Defining a business process

Define the receive and reply activities for all operations defined in a SOAP reception.

The procedure below defines (in the receive and reply activities) a variable with the message format defined in the SOAP reception, and sets it as the allocated variable. (The following procedure is for the receive activity. The same procedure applies in the case of reply activities.)

  1. In the Receive Activity dialog box, set the operation name defined in the SOAP reception.
  2. Click the Edit button under Body allocated variable.
    The List Of Variables And Correlation Sets dialog box appears.
  3. Set the variable name.
  4. Click the Take In button.
    The Take In Message Format dialog box appears. In the Take In Message Format dialog box, the following information is displayed:
    Reception name
    The name of the SOAP reception that has the operation specified in step 1 is set.
    Operation name
    The value specified in step 1 is set.
    Message type
    A request message is selected for a receive activity, and a response message is selected for a reply activity.
    Message format name
    A variable name is set.
    If the operation name specified in step 1 does not exist in the SOAP reception, a blank is displayed for the reception name and operation name. If this occurs, return to step 1, and specify the correct operation name.
    For the message format name, the variable name is set by default. Rename it as necessary.
  5. Click the OK button.
    The Take In Message Format dialog box closes, and you are now able to make operations on the List Of Variables And Correlation Sets dialog box.
  6. In the List Of Variables And Correlation Sets dialog box, click the Add button.
  7. In the List Of Variables And Correlation Sets dialog box, add a variable to be allocated to the message header.
    For details about how to add a variable, see the description of how to define a variable in 5.5.1 Defining Variables in the manual Service Platform Basic Development Guide.
  8. In the List Of Variables And Correlation Sets dialog box, select the added variable from Variable List.
  9. In the List Of Variables And Correlation Sets dialog box, click the OK button.
    The List Of Variables And Correlation Sets dialog box closes.
  10. In the Receive Activity dialog box, click the Set button under Header allocated variable.
    The Header allocated variable dialog box appears.
  11. In the Header allocated variable dialog box, click the Add button.
  12. In the Header allocated variable dialog box, select the added variable from the allocated variables.
  13. In the Header allocated variable dialog box, click the OK button.

For details about the Receive Activity dialog box, see 1.4.7 Receive Activity Dialog in the manual Service Platform Reference Guide. For details about the List Of Variables And Correlation Sets dialog box, see 1.4.1 List Of Variables And Correlation Sets Dialog in the manual Service Platform Reference Guide. For details about the Take In Message Format dialog box, see 1.4.5 Take In Message Format Dialog in the manual Service Platform Reference Guide.

Hint
If an operation of the SOAP reception contained a fault, for the business process, define a reply activity for which the fault name is specified. For Fault name in the Reply Activity dialog box, specify the value displayed for Fault name of Fault message in the user-defined reception definition window, and then assign a variable as shown in steps 2 to 9.
If multiple faults are contained in an operation of the SOAP reception, add as many reply activities as the contained faults, and set the corresponding fault names. In addition, assign variables for individual reply activities as shown in steps 2 to 9.
(d) Checking the contents of a SOAP reception

Check the contents of the SOAP reception that has been added. The contents of the SOAP reception must match the contents of the business process definition.

For details about how to check a SOAP reception, see 2.8 Checking User-Defined Reception Contents.

(e) Saving a SOAP reception

Save the defined SOAP reception to the repository.

For details about how to save a SOAP reception, see 2.9 Saving a user-defined reception.

(f) Validating a SOAP reception

You can validate consistency between the defined SOAP reception and the business process definition.

For details about how to validate a SOAP reception, see 2.10 Validating a User-Defined Reception.

(g) Changing the information of a SOAP reception

For a defined SOAP reception, you can change the reception name, reception ID, and context root, as necessary.

For details about how to change the information of a SOAP reception, see 2.11 Changing the information of a user-defined reception.

(h) Deleting a SOAP reception

You can delete an unnecessary SOAP reception, as necessary.

For details about how to delete a SOAP reception, see 2.12Deleting a User-Defined Reception.

(2) Defining a SOAP reception after defining a business process

The following figure shows the work flow for defining a SOAP reception that is suitable for the interface of the defined business process.

Figure 2-3 Work flow for defining a SOAP reception (after defining a business process)

[Figure]

The following describes the operations for defining a SOAP reception after defining a business process.

(a) Defining a business process

Before defining a SOAP reception, you need to define a business process. Even if the business process has not yet been completely defined, arrange the receive and reply activities that form the interface with the service requester, and set the operation name and allocated variable.

For details about how to define a business process, see 5.3 Defining Business Process Contents in the manual Service Platform Basic Development Guide.

(b) Creating a WSDL

Create a WSDL to be used when a SOAP reception is defined.

For details about how to create a WSDL, see 2.7 Creating WSDL.

(c) Adding a SOAP reception

In the Add User Defined Reception wizard, add a SOAP reception.

For details about how to add a new SOAP reception, see 2.2.2 Adding a SOAP reception.

(d) Checking the contents of a SOAP reception

Check the contents of the SOAP reception that has been added. The contents of the SOAP reception must match the contents of the business process definition.

For details about how to check a SOAP reception, see 2.8 Checking User-Defined Reception Contents.

(e) Saving a SOAP reception

Save the defined SOAP reception to the repository.

For details about how to save a SOAP reception, see 2.9 Saving a user-defined reception.

(f) Validating a SOAP reception

You can validate consistency between the defined SOAP reception and the business process definition.

For details about how to validate a SOAP reception, see 2.10 Validating a User-Defined Reception.

(g) Changing the information of a SOAP reception

For a defined SOAP reception, you can change the reception name, reception ID, and context root, as necessary.

For details about how to change the information of a SOAP reception, see 2.11 Changing the information of a user-defined reception.

(h) Deleting a SOAP reception

You can delete unnecessary SOAP receptions.

For details about how to delete a SOAP reception, see 2.12 Deleting a User-Defined Reception.