Invoke webMethods IS

The webMethods IS policy allows IBM API Studio to process incoming requests before forwarding them to the native API.

The webMethods IS policy can transform the message into the format that is specified or apply custom logic as needed.

For example, if a client sends an order record in a structure that differs from what the native API expects, this policy can convert the record to match the expected format. The policy does it by bridging any mismatch between client and backend requirements.

In IBM API Studio, this policy is identified by the kind WebMethodsISService.

Example of a webMethods IS policy in code view.

kind: WebMethodsISService
apiVersion: api.ibm.com\v1
metadata:
  name: webMethodsISService
  namespace: sample
  version: 1
  spec:
    enabled: true
    condition: |
      (${request.httpMethod} equals POST) or 
      (${request.headers.name} notEquals ${request.payload.jsonPath[$.customer.name]})
    # other operators include Equals, Equals ignore case, Not equals, Not equals ignore case, Contains, Not Contains, Exists, Not Exists, IP Range, Greater Than, Lesser Than
    services:
     - name: sample
       runAs: #developer, administrator, default, replicator
       complyToISSpec: true
    alias: 
      - alias1
      - alias2
For the WebMethodsISService policy kind, configure these specifications.
Code view Form view Description
condition N.A.

Conditions are used to specify when the policy is run. You can add multiple conditions with logical operators. Provide the condition in the format: {set} operator {value} condition {set} operator {value}

Use one of these conditions.
  • Transform the requests that comply with all the configured conditions in the code view by using and, or in the form view by selecting the AND option.
  • Transform the requests that comply with any one configured condition in the code view by using or, or in the form view by selecting the OR option.
You can use the following operators:
  • Equals
  • Equals ignore case
  • Not equals
  • Not equals ignore case
  • Contains
  • Not Contains
  • Exists
  • Not Exists
  • IP Range
  • Greater Than
  • Lesser Than
services Add webMethods IS service

Defines the Integration Server services that this policy applies to.

name webMethods IS Service

Specifies the full webMethods IS service path.

runas Run as user

Defines the authentication mode for starting the IS service. If left blank, IBM API Studio uses the caller’s credentials. Specifies what roles or permissions to use when executing this service.

You can specify a fixed user for IBM API Studio to use by configuring one of these user types:
  • developer
  • administrator
  • default
  • replicator
complyToISSpec Comply to IS spec

Enforces that the service must comply with IS specifications. Set it to true in the code view and in the form view, select the option.

alias webMethods IS service alias Sets another name or alias for the policy.