How Do I Publish Data to an Integration Server Service using Custom Destination?

This use case explains how to publish data to an IS service.

The use case starts when you have data to be published and ends when you have successfully configured an IS service as a destination to publish the data.

Ensure you have the IS service details to which the data has to be published.

To publish data to a IS service

1. Expand the menu options icon

, in the title bar, and select Administration.

2. Click Destinations.

3. Select Custom destinations from the left navigation pane.

The Custom destination page appears.

4. Provide the name of the custom destination in the Name field.

The name must be unique and must not be the name of any pre-defined API Gateway destinations such as Elasticsearch.

5. To configure conditions that determine the data to be published in the specified destination, perform the following steps in the Conditions section:

Select one of the following options in the Condition type field:

AND. To publish data that satisfies all your conditions.

OR. To publish data that satisfies one of your conditions.

Click + Add condition.

Provide the following details for your condition:

Variable. Name of the variable based on which you want to validate your condition. This field supports the variables that are available in the Variable framework. For details on the list of variables, see Variable Framework.

Operator. The operator to use to relate variable and the value.

Value. The value of the variable that must be matched to satisfy the condition.

Click Add.

The condition appears in the grid.

Repeat this process to add the required number of conditions. Click on a condition to edit it and click

next to a condition to delete it.

6. Select webMethods IS service in the Type field.

7. Provide the following information in the Invoke webMethods IS section, as required:

Property	Description
webMethods IS Service	Name of the webMethods IS service or IS server alias to which the data has to be published. Note: Only the local IS service is supported. You cannot specify a remote IS service.
Run As User	Authentication mode to invoke the IS service. If this field is left blank the incoming credentials of the user, identified by API Gateway, are used to authenticate and invoke the IS service. You can also specify a particular user, you want API Gateway to invoke the IS service.
Comply to IS Spec	Select this property to mark it true, if you want the input and the output parameters to comply to the IS Spec present in pub.apigateway.invokeISService.specifications folder in wmAPIGateway package.

Click Add webMethods IS Service to add another IS service. Repeat this step to add the required number of services.

8. From the Events section, select the data that you want to publish to the configured destination. The options available are:

Event types. Type of events to publish to the specified destination. The available event types are:

Error. Occurs each time an API invocation results in an error.

Lifecycle. Occurs each time API Gateway is started or shut down.

Policy violation. Occurs each time an API invocation violates the policy enforcement that was set for the API.

Performance metrics data. To publish to the specified destination.

In the Publish interval of performance metrics data field, enter a time interval (in minutes) to specify how often API Gateway must publish performance metrics. Provide a value from 1 through 60. The default is 60 minutes.

Events. API Gateway modules for which the audit logs to publish to the specified destination.

9. Click Add.

The custom destination is created successfully and appears in the Custom destinations page. The configured events are published to the specified destination.

Note:
To edit a custom destination, you can click the required custom destination, make changes and click Update. To delete a custom destination, click

next to required custom destination. You cannot delete a custom destination that is associated with an API.