API Management 10.4 | Using CentraSite | Runtime Governance | Run-Time Alias Management | Defining the Runtime Aliases
 
Defining the Runtime Aliases
Before you define the runtime (routing) endpoint aliases:
*Ensure that the gateways for the aliases have already been created. For example, Development, Testing, and Production gateways.
*Ensure that you have the API Run-time Provider role for creating an alias.
*Ensure that you have the Mediator Publisher role or Publishing permissions on the Mediator gateway for publishing the aliases to Mediator.
* To define runtime endpoint aliases
1. In the CentraSite Business UI activity bar, click Governance Rules.
2. Click Add Runtime Alias.
3. Provide the required information in the wizard 1 of the Add a New Runtime Alias dialog box.
Field
Description
Runtime alias type
Select the type of runtime alias:
*Simple Alias: A simple routing URL or host and port name.
*webMethods Integration Server Alias: Contains the webMethods Integration Server service name.
Note: The webMethods Integration Server service must be available in the Integration Server, to which the aliases are deployed.
*Secure Alias: Contains client's authentication credentials, and domain values. The password is hashed and put into secure storage so that it is not visible in clear text.
*Transformation Alias: Accepts the XSLT style sheet to be used for the request or response transformation.
*Endpoint Alias: A name and value pair which can also contain endpoint properties such as Connection Timeout, Read Timeout, and so on.
Authentication Scheme
For the Secure Alias type only, select one of the following:
*HTTP Basic Authentication
*NTLM Authentication
*OAuth2 Authentication
*Kerberos Authentication
Name
Name of the alias.
Description
(Optional). The description of the alias.
4. Click Next.
5. Provide the required information in the wizard 2 of the Add a New Runtime Alias dialog box.
Field
Description
Default Value
The value used by default when no stage-specific values are entered. This default value is overwritten at deployment time by stage-specific values, if they exist.
For Simple or Endpoint Alias , type a default URL or components of the URL such as service name.
For webMethods Integration Server Alias, type the webMethods Integration Server service name.
For Transformation Alias, select an XSLT style sheet which is considered as a default value.
Stage-specific Values
Stage-specific values are used to define the values that are specific to a particular Mediator. You can select an instance of Mediator and type the value to be used for that Mediator.
Endpoint Properties
For the Endpoint Alias type only. Click the endpoint properties icon next to Default Value to configure endpoint properties.
*SOAP Optimization Method: Optional, This setting is not applicable for REST services. Mediator can accept the following methods to optimize the payloads of SOAP requests:
*None (the default).
*MTOM: Indicates that Mediator expects to receive a request with a Message Transmission Optimization Mechanism (MTOM) attachment, and forwards the attachment to the native service.
*SwA: Indicates that Mediator expects to receive a SOAP with Attachment (SwA) request, and forwards the attachment to the native service.
*Connection Timeout: The time interval (in seconds) after which a connection attempt timeouts. If a value is not specified (or if the value 0 is specified), Mediator uses the value of the global property pg.endpoint.connectionTimeout located in the file Integration Server_directory\packages\WmMediator\config\resources\pg-config.properties. The default of that property is 30 seconds.
*Read Timeout: The time interval (in seconds) after which a socket read attempt will timeout.
The precedence of the Read Timeout configuration is as follows:
i. If a value is specified for this Read Timeout field, Mediator will use this value for the socket read attempt. The read timeout value defined at an alias level takes precedence over the timeout values defined at an API level and the global configuration.
ii. If a value 0 is specified (or if the value is not specified) for this Read Timeout field, then Mediator will use the value specified in the Read Timeout field of the routing action. The read timeout value defined at an API level takes precedence over the global configuration.
iii. If a value 0 is specified (or if the value is not specified) for the Read Timeout field in the routing action (at an API level), then Mediator will use the value of the global property pg.endpoint.readTimeout located in the file Integration Server_directory\packages\WmMediator\config\resources\pg-config.properties (in the Mediator Administration console, go to > Settings > Extended Settings > pg.endpoint.readTimeout property.).
Note: If a value for the Read Timeout configuration is not specified in any of the above configuration parameters, then Mediator will use the default 30 seconds.
SSL Options: To enable SSL client authentication for the endpoint, you must specify values for both the Keystore Alias field and the Client Certificate Alias field. If you specify a value for only one of these fields, a deployment error occurs.
Note: SSL client authentication is optional; you may leave both fields blank.
*Keystore Alias: The keystore alias of the instance of Integration Server on which Mediator is running. This value (along with the value of Client Certificate Alias) is used for performing SSL client authentication.
*Client Certificate Alias: The client's private key to be used for performing SSL client authentication. If you specify a client certificate alias, you must also include in the virtual service's policy the Require SSL action and select that action's Client Certificate Required option. The Client Certificate Required option specifies whether client certificates are required for the purposes of: 1) Verifying the signature of signed SOAP requests or decrypting encrypted SOAP requests, and 2) Signing SOAP responses or encrypting SOAP responses.
WS-Security Header Customization: Indicates whether Mediator should pass the WS-Security headers of the incoming requests to the native service.
*Remove processed security headers: Removes the security header if it is processed by Mediator (that is, if Mediator processes the header according to the virtual service's security run-time policy). Mediator does not remove the security header if both of the following conditions are true: 1) Mediator did not process the security header, and 2) the mustUnderstand attribute of the security header is 0 or false).
*Pass all security headers: Passes the security header, even if it is processed by Mediator (that is, even if Mediator processes the header according to the virtual service's security run-time policy).
Note: If the virtual service does not contain a security run-time policy, and the mustUnderstand attribute of the security header is 0 or false, then Mediator always forwards the security header to the native service.
OAuth2 Token
A valid OAuth 2.0 token. The specified token will be used by Mediator in the outbound request.
Examples:
Endpoint Type
Field Values
Alias
*Name: ProdSandbox
*Default Value: http://myhost:5555
webMethods Integration Server Alias
*Name: ProdService
*Default Value: fault:postProcess
Secure Alias
*Name: ProdAuthToken
*Password: ****
*Domain: mysever.sag
Transformation Alias
*Name: ProdTrans
*Default Value: sample.xsl
Endpoint Alias
*Name: SearchServiceProductionEndpoint
*Description: The clustered production endpoint for the search service.
*Default Value: http://prodcluster:6666/Search
*Endpoint Properties:
*Connection Timeout: 5
*Read Timeout: 15
6. Click OK.
7. Click Publish.
Copyright © 2015- 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