Supported Alias and Policy Combinations

Edit online

webMethods API Gateway provides a set of aliases whose runtime-specific environment variables can be used in configuring the policy routing endpoints, routing rules, endpoint connection properties, and outbound authentication tokens. The types of aliases whose properties you can use for the policy configurations are:

  • Simple alias
  • Endpoint alias
  • HTTP transport security alias
  • SOAP message security alias
  • IBM webMethods IS Service alias
  • XSLT Transformation alias

Not all policies support the full set of aliases that are available in webMethods API Gateway. Some aliases are applicable only with certain policies and for certain policy parameters. For example, a Simple alias applies to the routing and traffic monitoring policies, whereas an Endpoint alias applies only to the routing policies. When you define a Straight Through Routing policy with a simple alias, the alias property is defined using the Endpoint URI field. When you define the same Straight Through Routing policy with an endpoint alias, the alias property is defined using a set of fields - Endpoint URI, SOAP Optimization Method, HTTP Connection Timeout, Read Timeout, Pass WS-Security Headers, and Keystore Alias.

The following table identifies the policies and policy parameters that each alias type supports:

Simple Alias

Policy Name Policy Parameter Name
Straight Through Routing In the Straight Through Routing definition:
  • Endpoint URI
Content-based Routing In the default and custom Route To rule definitions:
  • Endpoint URI
Conditional Routing In the default and custom Route To rule definitions:
  • Endpoint URI
Load Balancer Routing In the Route To rule definition:
  • Endpoint URI
Dynamic Routing In the default and custom Route To rule definitions:
  • Endpoint URI
Log Invocation In the Email Destination section:
  • Email Address
Monitor Performance In the Email Destination section:
  • Email Address
Monitor SLA In the Email Destination section:
  • Email Address
Traffic Optimization In the Email Destination section:
  • Email Address

Endpoint Alias

Policy Name Policy Parameter Name
Straight Through Routing In the Straight Through Routing definition:
  • Endpoint URI
  • SOAP Optimization Method (Applicable only for SOAP APIs)
  • HTTP Connection Timeout
  • Read Timeout
  • Pass WS-Security Headers (Applicable only for SOAP APIs)
  • Keystore Alias
  • Key Alias
Content-based Routing In the default and custom Route To rule definitions:
  • Endpoint URI
  • SOAP Optimization Method (Applicable only for SOAP APIs)
  • HTTP Connection Timeout
  • Read Timeout
  • Pass WS-Security Headers (Applicable only for SOAP APIs)
  • Keystore Alias
  • Key Alias
Conditional Routing In the default and custom Route To rule definitions:
  • Endpoint URI
  • SOAP Optimization Method (Applicable only for SOAP APIs)
  • HTTP Connection Timeout
  • Read Timeout
  • Pass WS-Security Headers (Applicable only for SOAP APIs)
  • Keystore Alias
  • Key Alias
Load Balancer Routing In the Route To rule definition:
  • Endpoint URI
  • SOAP Optimization Method (Applicable only for SOAP APIs)
  • HTTP Connection Timeout
  • Read Timeout
  • Pass WS-Security Headers (Applicable only for SOAP APIs)
  • Keystore Alias
  • Key Alias
Dynamic Routing In the default and custom Route To rule definitions:
  • Endpoint URI
  • SOAP Optimization Method (Applicable only for SOAP APIs)
  • HTTP Connection Timeout
  • Read Timeout
  • Pass WS-Security Headers (Applicable only for SOAP APIs)
  • Keystore Alias
  • Key Alias

HTTP Transport Security Alias

Policy Name Policy Parameter Name
Outbound Auth - Transport In the Authentication scheme:
  • Alias

SOAP Message Security Alias (Applicable only for SOAP APIs)

Policy Name Policy Parameter Name
Outbound Auth - Message In the Authentication scheme:
  • Alias

IBM webMethods IS Service Alias

Policy Name Policy Parameter Name
Invoke IBM webMethods IS (Request Processing) IBM webMethods IS Service Alias
Invoke IBM webMethods IS (Response Processing) IBM webMethods IS Service Alias

XSLT Transformation Alias

Policy Name Policy Parameter Name
Request Transformation (Request Processing) Transformation Configuration
  • Payload Transformation
    • XSLT Transformation alias
Response Transformation (Response Processing) Transformation Configuration
  • Payload Transformation
    • XSLT Transformation alias