Configuring extended settings

Edit online

You can configure advanced parameter settings in the Extended settings section. These parameters affect the operation of your server. Do not change these settings unless requested to do so by IBM® Global Support. In addition to extended settings, you can also configure the watt parameter settings.

Before you begin

You must have the Manage user administration functional privilege to configure the extended settings.

Procedure

  1. Open the menu options and select Administration.
  2. Select General > Extended settings.
  3. Click Show and hide keys. This displays all the configurable parameters.
  4. You can configure any of the following parameters in the Extended keys section by providing the necessary values. The configured values are listed under Extended settings at the start of the page.
    allowEGInvokeOnly
    Specifies whether the SOAP APIs with Transport policy set to HTTP, can be started by using the reverse invoke method when you set the external port as HTTPS, and the registration and internal ports as HTTP. Make sure that you enable this setting in the system where the SOAP API is created.
    Note: This setting affects only the behavior of SOAP APIs. You can call the REST APIs by using the reverse invoke method, irrespective of this setting, which is given the said that conditions are true. Possible values are -
    • True - You can call SOAP APIs using the reverse invoke method if the external port is set as HTTPS, and the registration and internal ports are set as HTTP.
    • False - You cannot call SOAP APIs by using the reverse invoke method.
    allowExceedMaxWindowSize

    Specifies whether the number of records that are retrieved by Elasticsearch in a single request exceeds the configured value or not. Possible values are as follows.

    • True. The number of records that are retrieved in a single request can exceed the maximum value that is configured in Elasticsearch. This is the default value.
    • False. Displays an error message when the number of records that are retrieved in a single request exceeds the configured value.
    allowedTracerCount

    Specifies whether the total number of tracer calls stored at a given point of time.

    Default value is 100 and the maximum value is 1000.

    apiDocumentsRestrictedExtension

    Specifies the list of restricted file extensions to prevent users from uploading files with those extensions as the input document for an API. For example, a file with the .exe file extension might contain executable code that runs on demand when it is downloaded. If files with the .exe file extension are restricted, users cannot upload a file with the .exe extension in webMethods API Gateway. By default, several standard file extensions are blocked, including any file extensions that are treated as executable files by Windows Explorer. The file extensions that are blocked by default are -

    • .bat - Batch file
    • .bin - Binary file
    • .dll - Windows dynamic link library
    • .exe - Executable program
    You can remove any or all the default file extensions.
    apiDocumentsUploadSizeLimitInMB
    Specifies the maximum document size, in MB, that can be uploaded as an input document for an API. The default value is 5. This property prevents users from uploading huge files that might slow down the system.
    apig_MENConfiguration_tickInterval

    Specifies the time interval (in seconds) between each interval processor iteration. The value you provide, must be an evenly divisible fraction of the smallest policy interval, which is one minute. The default value is 15.

    Note: Exercise caution when you modify this setting as this setting is a system-level setting.
    apig_rest_service_redirect

    Provide the value true to redirect the incoming service requests to one of the following directives that webMethods API Gateway supports in addition to the /gateway directive.

    • /ws
    • /mediator
    The default value is false.
    apig_schemaValidationPoolSize
    Provide a value that specifies the schema validation pool size. The default value is 10.
    apiGroupingPossibleValues

    Specifies the names of API groups. You can organize your APIs by associating them to the relevant API groups. The groups provided, by default, are as follows.

    • Finance Banking and Insurance
    • Sales and Ordering
    • Search
    • Transportation and Warehousing
    You can add, edit, or delete API groups based on your requirement.
    apiKeyExpirationPeriod

    Specifies the time for which an API Key is valid. You can provide the value in seconds, minutes, days, months, or years. For example, 8 seconds, 8s, 10 months, 10 m, 15 minutes, 15 min. The expiration date is computed as follows.

    • When a new application is created: Expiration date = The time when an application is created + The value that is specified in the apiKeyExpirationPeriod parameter.
    • When an API access key is regenerated: Expiration date = The time when the API key is regenerated + The value that is specified in the apiKeyExpirationPeriod parameter.
    If you do not specify a value, then the API key never expires.
    apiKeyHeader
    Specifies the HTTP header name from which webMethods API Gateway retrieves the API Key from incoming client requests. The default value is x-Gateway-APIKey.
    apiMaturityStatePossibleValues
    Specifies the API maturity state values that can be set for an API. You can search for APIs based on their maturity status. The default values that are provided are Beta, Deprecated, Experimental, Production, and Test.
    appMesh.microgateway.logLevel
    Specifies the log level of Microgateways that are deployed through webMethods API Gateway. The default value is ERROR. Possible values are TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
    clusterNotifierCacheStaleInterval
    Specifies the time interval after which data in the ClusterNotifierCache is considered stale and is removed from the cache. The default value is 900 seconds. If you provide a non-numeric value, API Gateway interprets the value as the default value of 900 seconds. If you provide a value less than 60 seconds, webMethods API Gateway interprets the value as the smaller limit of 60 seconds. The ClusterNotifierCache maintains a data structure, which has an entry for each active member in a cluster. This data structure is used to communicate changes on API definitions, applications, policies, and so on, between the cluster members. When a cluster member shuts down gracefully, it removes its entry from the data structure. However, when a cluster member process is stopped, the entry remains, and other cluster members continue posting notifications to the entry. To avoid endless growing resulting in performance degradation, the cluster data structure is monitored for absent cluster members. If a cluster member does not react within the configured clusterNotifierCacheStaleInterval it is regarded as stale, and its data is removed from the ClusterNotifierCache.
    decodeAllDelimitersInURI

    Specifies whether the encoded characters of the URL in the incoming client requests must be decoded or not. The URLs are encoded as the URI specs or user's requirements. Possible values -

    • True. The encoded characters in the URL of incoming requests are decoded.
    • False. The encoded characters in the URL of the incoming client requests are not decoded. This is the default value.
    defaultSearchResultSize
    Specifies the default size in the search request for the events, and metrics data. The default value is 1000.If you provide a value -1 it displays all the search results.
    designTimeOutboundClientHostnameVerifierEnabled

    Specifies whether the hostname verifier is enabled or disabled for design-time outbound HTTPS connections. These connections are necessary during API creation. Possible values -

    • True - Enables the hostname verifier.
    • False - Disables the hostname verifier. This is the default value.
    disableRemoteEntityReference

    Specifies whether remote entity references are resolved when creating a SOAP API. Possible values:

    • true. Disables the resolving of remote entity references when creating SOAP APIs.
    • false. Enables the resolving of remote entity references when creating SOAP APIs.
    enableHotdeploy

    Specifies whether the hot deploy functionality is enabled. When this feature is enabled, you can modify active APIs. The default value is 'true'. Possible values -

    • True - Enables the hot deployment function. This is the default value.
    • False - Disables the hot deployment function.
    Note: Make sure to refresh your browser when you modify this setting to reflect the changes to the ongoing user sessions.
    enableImportBackup

    Provides an option to secure an API before you overwrite it. Available values are -

    • True - If you set the value to true, the existing API is restored in the event of an error during the import. This is the default value.
    • False - If you set the value to false, the feature to secure an existing API before overwriting is disabled. If the overwrite fails due to an error during the import, the existing API must be deleted.
    enableTeamWork

    Specifies whether the team support feature in webMethods API Gateway is enabled. Possible values are -

    • True - enables the Team Support feature.
    • False - disables the Team Support featured. This is the default value.
    esScrollTimeout
    Specifies the time, in milliseconds, that the search results for each request must be kept active in Elasticsearch. When the allowExceedMaxWindowSize setting is enabled, the Scroll feature of the Elasticsearch is enabled to allow Elasticsearch to accept multiple search requests and return multiple results. That is, you can perform multiple search requests by using the same query until you get the wanted number of records from Elasticsearch. When you send a search request, Elasticsearch returns the result and keeps the result active for the time that is specified in the esScrollTimeout setting. If a request exceeds the time specified in the esScrollTimeout setting, then the subsequent search requests also fail with an Invalid Scroll ID error message. For more information on the Scroll feature, refer to https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll.
    eventsRefreshInterval
    Specifies the default refresh interval for the events indexes in seconds. The default value is 10 seconds.
    forwardInternalAPIsRequest

    This parameter is necessary if a paired gateway deployment scenario by using an Advanced Edition license at DMZ. Specifies whether the incoming requests are forwarded to internal APIs that are deployed in the green zone. Possible values are as follows.

    • True - webMethods API Gateway forwards the incoming requests to the internal APIs that are deployed in the green zone
    • False - webMethods API Gateway does not forward the incoming requests. This is the default value.
    Following are the internal APIs and their URIs for which this parameter is necessary and its value must be set to true:
    • getOAuthToken - /pub/apigateway/oauth2/getAccessToken
    • OAuth Authorization - /pub/apigateway/oauth2/authorize
    • getOpenIdToken - /pub/apigateway/openid/getOpenIDToken
    • openIDCallbackService - /pub/apigateway/openid/openIDCallback
    • getJWTToken - /pub/apigateway/jwt/getJsonWebToken
    forwardQueryParams

    Specifies whether webMethods API Gateway must forward the query parameter that is sent by the client and query parameters that are configured in the Request Processing stage to the native service if the ${sys:resource_path} variable is not present in the Routing policy URL.

    • true. webMethods API Gateway forwards the query parameters that are sent by the client and query parameters configured in Request Processing stage to the native service even if the ${sys:resource_path} is not present in the Routing policy URL.
    • false. webMethods API Gateway does not forward the query parameters to the native service if the ${sys:resource_path} is not available in the Routing policy. This is the default value.
    gatewayClientInvokingToken
    Specifies the value of the client token that can invoke the backend APIs in webMethods API Gateway. The default value is apigateway.
    healthCheckClientHostnameVerifierEnabled

    Specifies whether the hostname verifier is enabled or disabled for health check calls. API Gateway monitors the health of connected components, such as Kibana or configured destinations. Possible values are -

    • True - Enables the hostname verifier.
    • False - Disables the hostname verifier. This is the default value.
    maxAllowedZipFileSize
    Specifies the maximum size of the compressed file that can be uploaded to create an API from the Create API screen. The default value is 100000000.
    maxRegexLengthInSearchQuery
    Specifies the maximum length of Regex parameter that you can use in a Regex expression query. The default value is 37000. This value can be increased based on the requirement.
    maxWindowSize
    Specifies the maximum number of search results that Elasticsearch can return for a single search request. Using the index.max_result_window property in Elasticsearch, you can configure the maximum number of records to be retrieved in a single Elasticsearch request. To know more about the property, refer to https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html. The default value is 10000. If the value configured in the index.max_result_window setting of Elasticsearch is different from that of the default value, then it is recommended that you provide the same value in this field. If you have a value greater than the configured value, then Elasticsearch displays an error message. Also, you must enable the allowExceedMaxWindowSize setting if the total number of results to be retrieved is more than the value specified here. For example, if you have specified 1000 in this setting and the total number of records to be retrieved is 20000, then webMethods API Gateway sends 20 requests to retrieve all records provided the allowExceedMaxWindowSize setting is enabled. In the preceding example, if the allowExceedMaxWindowSize setting is not enabled, an error message is displayed as the value is lesser than the default value.
    numberOfTokensToCacheLocally

    Specifies the number of tokens to be cached locally before you access the cluster for more tokens to serve the next set of requests. When a node receives a request, a locally cached token serves the request. Locally caching tokens avoids access to the cluster for each invocation. Specify a value greater than 0 tokens to cache locally. If you do not specify this value, the node must access the cluster to get token for each invocation. webMethods API Gateway fetches a new set of tokens from the cluster, if

    • All cached tokens are used.
    • The validity of tokens is over.
    The default value is 0.
    openAPIImporterValidation

    Specifies whether webMethods API Gateway validates OpenAPI files for syntax errors during the creation of a new API. Possible values -

    • true. webMethods API Gateway validates OpenAPI files during API creation. If a syntax error is detected, the API is not created, and an error message is displayed in the webMethods API Gateway UI.
    • false. webMethods API Gateway does not validate OpenAPI files for syntax errors. If a syntax error is present, the API is still created. This is the default value.
    paginationPossibleValues
    Specifies the list of possible values of the pagination size, that is, number of items listed per page. The default values displayed for pagination options are 10,20,30,40,50. For example, if you select 20, then 20 items are displayed per page. For example, if you change the values to 5,10,15,20,25 then pagination options displayed are 5, 10, 15, 20 and 25. So now when you select 15, the items displayed per page would be 15. On modifying the value, you have to logout and relogin for the changes to reflect.
    pg_Dataspace_GossipInterval
    Specifies how frequently each node must gossip with one another. By default, the value is set to 3 seconds.
    pg_Dataspace_TimeToFail
    Specifies the maximum permissible interval between two consecutive gossips. By default, the value is set to 30 seconds.
    pg_Dataspace_WarmupTime
    Specifies the maximum permissible rehashing interval from start-up or shut down of the server. By default, the value is set to 300 seconds.
    pg_JWT_isHTTPS

    Specifies whether the transport protocol over which the JSON Web Tokens (JWTs) are granted authorization. Possible values are

    • True - Sets the transport protocol HTTPS. This value is set by default.
    • False - Sets the transport protocol HTTP.
    pg_oauth2_createDefaultScopes

    Specifies whether to create a default scope. Possible values are

    • True - When you set this property to true and the local authorization server is configured as the default authorization server, then webMethods API Gateway automatically creates a scope in Integration Server during API creation webMethods API Gateway creates a scope mapping between the OAuth scope in the local authorization server and the API. This setting is useful in cases where a service is published from Centrasite.
    • False - When you set this property to false, webMethods API Gateway does not create a scope automatically. Users must manually create and map scopes for the services published from Centrasite. This is the default value.
    pg_oauth2_isHTTPS

    Specifies the transport protocol over which the OAuth 2.0 access tokens are granted authorization. Possible values are

    • true. Sets the transport protocol HTTPS. This is set by default.
    • false. Sets the transport protocol HTTP.
    pg_OpenID_isHTTPS

    Specifies the transport protocol over which the OpenID (ID) tokens are granted authorization . Possible values are -

    • true. Sets the transport protocol HTTPS. This is set by default.
    • false. Sets the transport protocol HTTP.
    pg_xslt_disableDoctypeDeclarations
    Disables the xslt doc type declarations. The default value is true.
    pg_xslt_enableDOM
    Provide the value true to enable DOM parsing. The value false disables the DOM parsing and enables other parsers
    pg_xslt_enableSecureProcessing
    Provide the value false to disable the use of extensions by default. The default value is true.
    pg.cs.snmpTarget.connTimeout
    Specify the number of milliseconds before an inactive connection to the SNMP target server is closed. If set to 0, the socket remains open indefinitely.
    pg.cs.snmpTarget.maxRequestSize
    Specify the maximum size (in bytes) for SNMP traps. The default value is 10485760.
    pg.cs.snmpTarget.retries
    Specifies the number of times to resend SNMP traps upon failure. The default value is 1. This parameter works with pg.cs.snmpTarget.sendTimeOut to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations might delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.cs.snmpTarget.sendTimeOut
    Specify the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that resends an SNMP event that has not yet completed when it expires. Set a timeout value that ensures that the trap is sent to the SNMP server within the time frame. This parameter does not abort an event that is in progress. Set this parameter higher than the default when sending traps with large payloads. The default value is 500. This parameter works with pg.cs.snmpTarget.retries to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations could delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.default.enable.oldVersion

    Specifies whether the oldest version of an API must be enabled when the version of an API is not specified. For example, when you have an API that is versioned, the client can specify the version number in the URL to invoke that specific version of the API, that is, API-NAME/Version-number. When the client does not specify the version number, webMethods API Gateway defaults to the latest version of the API and starts it. You can use this parameter to change this behavior such that webMethods API Gateway defaults to the oldest version of the API and starts it. Available values are -

    • True - When you set this parameter as true and invoke an API without specifying the version number, then webMethods API Gateway defaults to the oldest version of the specified API and start it.
    • False - This is the default value. When you set this parameter as false and start an API without specifying the version number, then webMethods API Gateway defaults to the latest version of the specified API and starts it.
    pg.endpoint.connectionTimeout
    Specifies the time interval (in seconds) after which an HTTP connection attempt times out. The default value is 30 seconds. This is a global property that applies to the endpoints of all APIs. If you prefer to specify a connection timeout for the endpoints of an API individually, set the HTTP Connection timeout parameter in the API's Routing Protocols processing step, which might then take precedence over pg.endpoint.connectionTimeout. The precedence of the Connection timeout configuration is as follows -
    1. If you specify a value for the Connection timeout field in the routing endpoint alias, then the Connection timeout value that is specified in the Endpoint alias section takes precedence over the timeout values that are defined at the API level and the global level.
    2. If you specify a value 0 for the Connection timeout field in the routing endpoint alias, then webMethods API Gateway uses the value that is specified in the Connection timeout field in the routing protocol processing step of an API. The Read timeout value that is specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Connection timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then API Gateway uses the value that is specified in this pg.endpoint.connectionTimeout property.
    4. If you do not specify any value for pg.endpoint.connectionTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    pg.endpoint.readTimeout
    Specifies the time interval (in seconds) after which a socket read attempt times out. Default value - 30 seconds. This is a global property that applies to all APIs. If you prefer to specify a read timeout for APIs individually, set the Read Timeout field in the API's Routing Protocols processing step, which might then take precedence over pg.endpoint.readTimeout. The precedence of the Read timeout configuration is as follows:
    1. If you specify a value for the Read timeout field in the routing endpoint alias, then the Read timeout value that is specified in the Endpoint alias section takes precedence over the timeout values that are defined at the API level and the global level.
    2. If you specify a value 0 for the Read timeout field in the routing endpoint alias, then webMethods API Gateway uses the value that is specified in the Read timeout field in the routing protocol processing step of an API. The Read timeout value that is specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Read timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value that is specified in this pg.endpoint.readTimeout property.
    4. If you do not specify any value for pg.endpoint.readTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    pg.lb.failoverOnDowntimeErrorOnly

    Specifies webMethods API Gateway's behavior of endpoints in a load-balanced routing scenario. Possible values are -

    • True - Load balancing does not happen when the service fault that is encountered in the response is a downtime error. This value is the default value.

      For example, the following are some downtime exceptions and for which fail overs happen: ConnectException, MalformedURLException, NoRouteToHostException, ProtocolException, SocketTimeoutException, UnknownHostException, UnknownServiceException, Web Service not available, The service cannot be found.

    • False - Load balancing happens whenever a service fault is encountered in the response coming from endpoint 1 and the webMethods API Gateway immediately tries the next configured endpoint. There is no distinction on the type of fault present in the response from endpoint.
    pg.MTOMStreaming.cachedFiles.delete.interval
    Specifies the interval (in seconds) to delete the cached MTOM files. The default value is 3600 seconds. This property takes effect only when the pg.suppress.IS.lcm setting is set to true.
    pg.overwrite.users.withsameloginid

    Specifies whether webMethods API Gateway must validate and overwrite a user based on their login ID or UUID when you import or promoting the user or team from one stage to another, provided the logged-in credentials (login ID) of both instances are the same. Possible values are -

    • True - webMethods API Gateway validates and overwrites the user with the user's login ID, if the user is not matched with the UUID during import or promotion of a user or teams. The default value is true.
    • False - webMethods API Gateway validates and overwrites the user with the UUID.
    pg.removeSSNID

    Specifies whether to include the set-cookie header in the response header. The set-cookie header contains ssnid value that is sent from the native service. Possible values are

    • True - The client that starts webMethods API Gateway API, does not receive the set-cookie header that contains ssnid value.
    • False - The client that starts webMethods API Gateway API, receives the set-cookie header that contains ssnid value if the native service sends this value in the response.
    pg.security.honourPortAccessModeSettings

    Specifies whether the access mode settings configured in the Administration > Security > Ports section must be enforced on the HTTP and HTTPS ports. In addition to the default port, you can add ports in webMethods API Gateway by using which you can use APIs. You can configure the access mode of the ports to determine whether a port can be used to access an API or not. You can either allow or deny the access of all APIs through a port. When you allow access of APIs by using a port by default, you can specify a list of APIs that must be denied access over the port. Also, if you deny the access of APIs by using a port, you can specify a list of APIs that can be allowed to access by using the port. You can use the pg.security.honourPortAccessModeSettings setting to configure whether the access mode that is configured from the Ports section must be enforced on the HTTP and HTTPS ports or not. This configuration is applicable only for REST and OData APIs. Possible values are -

    • True - Access to the HTTP and HTTPS ports is allowed or denied based on the settings in the Administration > Security > Ports section.
    • False - The access the mode settings that are specified for the ports are not applied. This value is the default value.
    pg.snmp.communityTarget.base64Encoded
    Specify whether to use a third-party SNMPv1 community-based connection. If set to true, the community name must be the Base64 value. The default value is false.
    pg.snmp.communityTarget.maxRequestSize
    Specifies the maximum size (in bytes) for SNMP traps. The default value is 65535.
    pg.snmp.communityTarget.retries
    Specifies the number of times to resend SNMP traps upon failure. The default value is 1. This parameter works with pg.snmp.communityTarget.sendTimeOut to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the sending the thread alert is available to send another event. Malfunctioning event destinations might delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.snmp.communityTarget.sendTimeOut
    Specifies the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that resends an SNMP event that has not yet completed when it expires. Set a timeout value that makes sure that the trap is sent to the SNMP server within the time frame. This parameter does not cancel an event that is in progress. Set this parameter higher than the default when you send traps with large payloads. The default value is 500. This parameter works with pg.snmp.communityTarget.retries to determine the delay in resending SNMP traps to nonresponsive SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations might delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.snmp.customTarget.connTimeout
    Specify the number of milliseconds before a disabled connection to the third-party SNMP server is closed. If set to 0, the socket remains open indefinitely.
    pg.snmp.userTarget.maxRequestSize
    Specify the maximum size (in bytes) for SNMP traps. The default value is 65535.
    pg.snmp.userTarget.retries
    Specifies the number of times to resend SNMP traps upon failure. The default value is 1. This parameter works with pg.snmp.userTarget.sendTimeOut to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations might delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.snmp.userTarget.sendTimeOut
    Specifies the time (in milliseconds) to wait before the SNMP trap times out because the server destination is not responding. This value schedules a timer that resends an SNMP event that has not yet completed when it expires. Set a timeout value that makes sure that the trap is sent to the SNMP server within the time frame. This parameter does not cancel an event that is in progress. Set this parameter higher than the default when you send traps with large payloads. The default value is 500. This parameter works with pg.snmp.userTarget.retries to determine the delay in resending SNMP traps to malfunctioning SNMP servers (that is, it retries sendTimeOut). This means that if the retries parameter is set to 3, and the sendTimeOut parameter is set to 500 milliseconds, there is a 1.5-second delay before the thread sending the alert is available to send another event. Malfunctioning event destinations might delay the amount of time it takes webMethods API Gateway to report events, or it might cause discarded events when the queue reaches its maximum level.
    pg.soapToRest.typeConvertorEnabled
    Specifies whether the key values in a SOAP request must be converted to their primitive type when a SOAP API is transformed to a REST API. For example, if the XML is <number>10</number>, it is converted as "number": 10. Possible values are -
    • True - Values are converted to their primitive type. This value is the default value.
    • False - Values are not converted to their primitive type.
    pg.suppress.IS.lcm

    Specifies whether to override the IS lifecycle manager with webMethods API Gateway lifecycle manager. Possible values are -

    • True - Set this property to true to use the webMethods API Gateway lifecycle manager.
    • False - Set this property to false to use the IS lifecycle manager By default, the value is false.
    webMethods API Gateway lifecycle manager provides options to specify the interval for deleting of cached MTOM files using the pg.MTOMStreaming.cachedFiles.delete.interval setting.
    pgmen.quotaSurvival.addLostIntervals
    Specifies whether the lost intervals from the recovered quota must be added.
    pgmen.quotaSurvival.interval
    Specifies the number of seconds that elapses before the quota survival processor task runs.
    promotionListSortByTime

    Specifies whether the list of promotions in the Promotions tab of the Promotion management page are sorted by the promotion time. Possible values -

    • True - The promotion list is sorted by promotion time with the latest on top.
    • False - The promotion list is sorted by promotion name. This value is the default value.
    retainResponseStatus
    Specifies whether the native service status must be modified before you send it to the client. The default value is false, which specifies that if the outbound authentication-custom credentials or delegate incoming credentials are configured with incorrect credentials the native service status is changed before you send it to the client. If this value is set to true, it specifies that the status that is received from the native service is sent without modifying it.
    return408ForConnectionTimeout

    Specifies the status code to be included in the response when a request to the native service times out. Possible values are

    • True - The response contains 408 error code uniformly when a request to the native service is timed out. This value is the default value.
    • False - The response does not contain 408 error code.
    saveAuditlogsWithPayload

    Specifies whether the audit logs must be saved along with payload. Possible values are

    • True - The audit logs must be saved along with payload. This value is the default value.
    • False - The audit logs are not saved along with payload.
    sendClientRequestURI

    Specifies whether the URI that is present in a request must be decoded before you send it to the native service. Possible values

    • True - The URI is not decoded. The Unicode characters in a request are encoded.
    • False - The URI is decoded without change in the path of the URL. This value is the default value.
    startDayOfTheWeek
    Specifies the start day of a week for the unit of measurement of the Alert Interval that is configured to monitor performance before you send an alert. By default, the start day of the week is set to Monday.
    Note: If you modify this value, you must restart webMethods API Gateway for the modified value to take effect. Contact the IBM support team to restart the API Gateway server.
    setDefaultContentType

    Specifies that the default content type to be included in the GET and DELETE methods, if the content type is missing in the request. Possible values are -

    • True - The default content type 
      application/x-www-form-urlencoded
      is added, if content type is missing in the request. This value is the default value.
    • False - The default content type is not added. The content-type is sent as is.
    strictResourceMatching

    Specifies whether webMethods API Gateway must perform a strict matching of the resource path from runtime invocation with the API definition of resource paths. Possible values are -

    • True - webMethods API Gateway uses the strict you match resource criteria and the matching fails if it encounters any other characters than that are specified. This value is the default value.
    • False - webMethods API Gateway matches the best resource instead of using the strict you match resource criteria.
    This extended setting functions as follows - For example, consider a REST API with resource path /mypath The request http://host:port/servicename/mypath/anytext with strictResourceMatching=true returns an HTTP response 404 immediately. The request http://host:port/servicename/mypath/anytext with strictResourceMatching=false runs the request in an ordinary way.
    tagsTypeAheadSearchResultSize
    Specifies the number of existing tags to display during the type ahead search. This property is available while you add a tag to an API, where you can type a search term. A list of existing API tags appears to depend on the search term. The number of API tags that are displayed in this list is restricted as per the value that is provided in the tagsTypeAheadSearchResultSize property. The default value is 10. The minimum value that you can provide is 1. If you provide zero or an invalid value, the value of this property is set to the default value 10.
    transferEncodingChunked_handleAsStream

    Specifies whether the request payload must be handled as a stream when the request contains a Transfer-Encoding: chunked header. The default value is false. The behavior is as follows depending on the value that is provided for this setting -

    • If Transfer-Encoding-chunked header is sent in the request and the extended setting transferEncodingChunked_handleAsStream is set as true, the request payload is handled as stream.
    • If Transfer-Encoding - chunked header is sent in the request and the extended setting transferEncodingChunked_handleAsStream is set as false, the request payload must be handled as is (no streaming).
    • If Transfer-Encoding-chunked header is not sent in the request. The request payload is handled as is (no streaming).
    • If Transfer-Encoding-chunked header is not sent in the request and the extended setting transferEncodingChunked_handleAsStream is set as true, the request payload is handled as is (no streaming).
    transformerPoolSize
    Specifies the maximum size for transform pool that consists of XSLT transformers. To reduce performance impacts, you can reuse the transformers from the pool instead of creating them for every request.
    useTypeInIndexNameForESDestination
    Specifies the index format that is used when you send data from webMethods API Gateway to a configured Elasticsearch destination. The default value is true. Elasticsearch verison 7.2 supports data with dedicated index for each of the event types. So, webMethods API Gateway sends data in different indexes for different event types if the value of this property is set to true. The event type is concatenated with the Elasticsearch destination index name. That is, the index name is in the following format: {IndexName}_{EventType}. For example, database_transactionalevents; where default is the index name and transactional events in the event type. If the value is set to false, the type name is not concatenated with the index name. In this case, the index that is created for each event is subindexed under a main index when data is sent to a configured Elasticsearch destination. The value of this setting must be set to false, if the version of the destination Elasticsearch is 5.x or earlier.
    xmlToJSONConversion_keepString

    Specifies whether the data type of fields in a response payload, after XML to JSON conversion, must be string or a corresponding data type. The default value is true. Possible values are -

    • True - The datatype of the fields is retained as a string.
    • False - The datatype of the fields is changed to a corresponding data type.
    For example, a Sample XML payload:<?xml version="1.0" encoding="UTF-8"?><EmployeeDetail><ID>12345</ID><Name>John</Name><Address>999 ABC Street</Address></EmployeeDetail>
    • Sample response, if you set the extended setting to true:{"EmployeeDetail": {"ID": "12345","Name": "John","Address": "999 ABC Street"}}. All fields in the response payload are retained as string.
    • Sample response, if you set the extended setting to false:{"EmployeeDetail": {"ID": 12345,"Name": "John","Address": "999 ABC Street"}}. The data type of the field ID is integer.
  5. You can configure the watt parameters in the Watt keys section by providing the necessary values. The configured watt keys are listed under Watt settings below the Extended keys at the top of the page. Only the following watt parameters get synchronized across nodes in a cluster setup:
    • watt.security.ssl.client.ignoreEmptyAuthoritiesList.
    • watt.security.ssl.ignoreExpiredChains.
    • watt.server.url.alias.partialMatching.
    • watt.server.oauth.authServer.alias
    • watt.server.oauth.requireHTTPS
    • watt.net.http401.throwException
    • watt.net.http501-599.throwException
    • watt.server.SOAP.MTOMStreaming.enable
    • watt.server.http.Strict-Transport-Security
    • watt.server.rest.removeInputVariablesFromResponse
    • watt.server.coder.responseAsXML
    • watt.security.ssl.cacheClientSessions
    • watt.server.enterprisegateway.ignoreXForwardedForHeader

    If you modify the other watt parameters in one webMethods API Gateway instance, they do not get synchronized across other nodes in a cluster setup. Manually modify them in the other instances.

  6. Click Save.