webMethods CloudStreams 10.4 | webMethods CloudStreams | webMethods CloudStreams Development | CloudStreams Provider Project | Editing Connection Configuration and Authentication Groups | Start and Stop Sequences for SOAP-based providers
 
Start and Stop Sequences for SOAP-based providers
CloudStreams allows you to define optional Start and Stop sequences, which lets you to manage the connection behavior. For example, you can define a login sequence, which takes the user name and password as inputs and calls the login operation. When you create a connector, the Start Sequence and Stop Sequence options appear under Connection on the left pane. You can add only one start and one stop sequence for a connection.
To add a Start Sequence
1. Right-click Start Sequence under Connection on the left pane and select Add Start Sequence. The Select Operation dialog box appears.
2. In the Select Operation dialog box, Select Service field, select a service from the drop-down list. All operations from the selected service appear in the pane.
3. Select an operation. The selected operation will be used to begin the session with the back end.
4. Click Next
5. Configure the start sequence input by completing the following fields:
Field
Description
Document Reference
The Document Reference for the start sequence input is displayed, for example myConnector_v1.customDoctypes:docTypeRef_LoginInput. The Document Reference is taken from the selected operation and cannot be edited.
Request Body
Represents the input of the document reference. All required fields must be independently populated using the assignment functionality for each field.
To assign values to a leaf element, right-click on the leaf element and select Assign From. For example, you can refer a connection parameter defined in the connection.
6. Click Next.
7. Configure the start sequence output by completing the following fields.
Field
Description
Document Reference
The Document Reference for the start sequence output is displayed, for example myConnector_v1.customDoctypes:docTypeRef_LoginOutput. The Document Reference is derived from the selected operation and cannot be edited.
Response Body
Represents the output of the document reference. Optionally, you can assign values from the output to the supported parameters to be used in operation interactions.
To assign values to a leaf element, right-click on the leaf element and select Assign To. For more information, see Assigning Values.
For example, in a login operation, the response can return the Session ID and/or Server URL to which the subsequent operations can use. Fields from the response body can be mapped to the appropriate connection parameters.
Error Handling
Select Use a service to configure the error message if you want to handle the error messages sent by the back end for requests that are not successful. Click Browse and in the Services pane, select the custom service that you have created. This service is needed to read and display error messages for unsuccessful requests.
Note: By default, CloudStreams automatically handles errors and flags connection errors. However, if you want to handle the response on your own in a customized way, you need to create and use a service (which follows the service mapping spec wm.cloudstreams.service.common.lookup.specs:mapServiceSpec), which returns an output that is treated as an error message. If the service does not return an output, it is treated as success.
8. Click Finish.
The details appear in the Overview pane.
9. To configure a Stop Sequence, right-click Stop Sequence under Connection, select Add Stop Sequence, and configure a Stop Sequence in a similar manner.
Note: While enabling or disabling the connection in the Integration Server Administrator, the start or stop sequences, if configured, will be run respectively.
Copyright © 2013- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release