Designer 10.5 | webMethods Service Development Help | Building Connector Listeners | Editing Connector Listeners
 
Editing Connector Listeners
Pre-requisites
*The CloudStreams provider package that has streaming service capability has been installed.
*A connection for the connector has been created and enabled in Integration Server Administrator.
*The connector listener has been created in Software AG Designer.
Editing a connector listener consists of configuring the subscription request, that is, selecting a channel from a list of available subscription channels, configuring headers and parameters, choosing a different connection pool, optionally selecting a document type to represent the event, and configuring the action to be applied on the incoming events. You edit a connector listener using the Software AG Designer. Before you edit a connector listener, create the listener as described in Creating Connector Listeners.
Note:
Information about connector listeners is also located in the Administering webMethods CloudStreams document, webMethods Deployer User’s Guide, and also in the documentation specific to your CloudStreams provider, for example, the webMethods CloudStreams Provider for Salesforce.com Installation and User's Guide.
*To edit a connector listener
1. Open Software AG Designer if it is not already open.
2. Navigate to and open the connector listener you created in Creating Connector Listeners.
The listener opens in the connector listener editor.
3. On the Listener tab, complete the following fields:
Field
Description
Connection Pool
This is an optional step. Select a connection pool in case you want to use a connection pool other than the one selected while creating the connector listener.
Connection Type
This field cannot be modified.
Subscription
Displays the subscription channel.
Click the icon to configure or select a different subscription. In the Subscriber Configuration dialog box, select the subscriber you want the connector listener to connect.
Description, HTTP Method, Subscription Path
These fields cannot be modified.
4. On the Headers tab, Software AG Designer displays the pre-configured HTTP transport headers, optionally with their default values for the selected subscription.
a. To specify a value for a pre-configured header variable, click the Value box to the right of the variable and type or paste the new value. Note that the option to modify the value for a pre-configured HTTP transport header is available only for select headers.
b. To add a header, click . Type a name for the header, select the Active check box to include the header as part of the subscription request, and provide a value.
c. To move a header up in the list, select the header and click . To move a header down in the list, select the header and click .
d. To delete a header that you added, select the header and click .
Note:
You cannot delete required headers.
5. On the Parameters tab, Software AG Designer displays the pre-configured parameters, optionally with their default values for the selected subscription.
a. Review the details about the parameters. Software AG Designer displays the parameter name and description, the data type used to represent the kind of information the parameter can hold, and the value and parameterization style for the subscription request. The supported parameter styles for subscription requests are URI_CONTEXT and QUERYSTRING_PARAM. For information about these parameter styles, see the section Understanding REST Parameters in the Administering webMethods CloudStreams document.
b. To specify a value for the parameter, click the Value box to the right of the parameter. Then type or paste the default value.
6. On the Event tab, configure the event action for the listener subscriber.
a. For the Document field, click Browse and select the Integration Server document type to use as the event document. The option to specify a document other than the pre-configured one is enabled for select subscriptions.
b. Click Add Action and select the event processing action to be applied on the incoming events.
Note:
Actions are not invoked as per the order in the Applied Action panel. For example, if you have added Log Invocation first and then Service Invocation, the Service Invocation action will be invoked before Log Invocation.
c. If you select Service Invocation, in the Service Name field, select the service that will be invoked when the events are received. In the Run As User field, select the user you want Integration Server to use when running the service. Integration Server runs the service as if the user you specify is the authenticated user that invoked the service. If the service is governed by an Access Control List (ACL), ensure that you specify a user that is allowed to invoke the service.
d. If you select Log Invocation, in the Log Level field, select the level at which you want the events to be logged in the server log.
7. On the Summary tab, review the details about the connector listener.
8. On the Comments tab, enter descriptive comments or usage notes, if any.
9. Click File > Save to save your changes.
10. To manage an existing listener, go to Integration Server Administrator > Solutions > CloudStreams > Providers > Connector, and in the Listeners tab for the connector, click Configure to edit the listener communication or transport specific parameters for accessing the Streaming API. Then enable the listener. Once the listener is enabled, connection with the Streaming API is established, and incoming events will be processed whenever the Streaming Provider/SaaS Provider triggers the events.