webMethods and Intelligent Business Operations 10.2 | API Gateway User's Guide | API Gateway Administration | General Configuration | Configuring Extended Settings
 
Configuring Extended Settings
You must have the API Gateway's manage user administration functional privilege assigned to configure the extended settings.
You can configure advanced parameter settings in the Extended settings section. These parameters affect the operation of your server. You must not change these settings unless requested to do so by Software AG Global Support.
* To configure the extended settings
1. Select Username > Administration.
2. Select General > Extended settings.
3. Provide the following information in the Extended settings section:
Parameter
Description
allowExceedMaxWindowSize
Provide the value true to exceed the maximum window size configured and false to avoid exceeding the maximum window size.
The default value is true.
apiDocumentsRestrictedExtension
Specify a list of restricted file extensions to prevent users from uploading files with those extensions as the input document to API. For example, a file with the .exe file extension could contain executable code that run 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 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 blocked by default are:
*.bat - Batch file
*.bin - Binary file
*.dll - Windows dynamic link library
*.exe - Executable program
apiDocumentsUploadSizeLimitInMB
Provide a value (in MB) to restrict the size of the document that can be uploaded as the input document to API. It is important to set this to a reasonable limit, but not too large to avoid uploading files that are too large and can slow down the system.
Default value is 5.
apig_MENConfiguration_tickInterval
Provide a value to specify the time interval (in seconds) between each interval processor iteration. This must be an evenly divisible fraction of the smallest policy interval, which is one minute.
Default value is 15.
If you have configured the result window size in elastic search, specify the configured value to fetch results accordingly.
apig_rest_service_redirect
Provide the value true to redirect the incoming service requests to one of the following directives that 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 groups that the APIs would be grouped under.
The default groups provided are Finance Banking and Insurance,Sales and Ordering,Search,Transportation and Warehousing
You can delete or add new groups that the APIs can be grouped under.
apiKeyExpirationPeriod
Specifies the length of time that the API key is valid. The key expires after the set number of minutes, hours, days, months, or years. If a value is not specified, then the API key never expires. The expiration date is computed as follows:
*When a new application is created: Expiration date = The time when an application is created + The value specified in the apiKeyExpirationPeriod parameter.
*When an API access key is regenerated: Expiration date = The current time of the application in the system + The value specified in the apiKeyExpirationPeriod parameter.
apiKeyHeader
Provide the header value from which API Gateway receives the API key.
The default value is x-Gateway-APIKey
apiMaturityStatePossibleValues
Specify the API maturity state values that can be set for an API.
The default values provided are Beta, Deprecated, Experimental, Production, Test.
backupSharedFileLocation
Provide the file location where the data backup file has to be archived.
If no path is provided the archive the backup file is archived in the temp folder of the system.
decodeAllDelimitersInURI
The default value is false.
When set to false the URI in the request is not decoded.
When set to trueit overrides the limiters and decodes the complete path to get a meaningful URI.
defaultEncoding
Specify the default encoding format.
The default value is UTF-8.
defaultLanguage
Specifies the display language for the user interface of API Gateway. You can change the display language to your preferred language at any time.
The default value is en.
esScrollTimeout
Provide a value that specifies the time out interval for fetching the result that is greater than maxWindowSize.
Default value is the time, in milliseconds, required to fetch the records specified in maxWindowSize.
forwardInternalAPIsRequest
This parameter is required in the case of a paired gateway deployment scenario using an Advanced Edition license at DMZ.
The default value is false.
Provide the value true to forward the incoming requests to internal APIs that are deployed in the green zone.
Following are the internal APIs and their URIs for which this parameter is required 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
invokeESB_asUser
Provide a User. This user then can run all IS services in API Gateway.
If Run as User is included in the Invoke webMethods IS service policy then that value overrides the User provided here.
If no value is set is either of the places the authenticated user can run the IS service.
maxBackupsLimit
Provide a value to specify the maximum number of backups that are archived.
The default value is 10. If you do not provide any value the infinite number of archives can be stored.
maxWindowSize
Provide a value to set the result window size that specifies the number of records per query.
Default value is 10000.
pg_Active_OpenID_Provider
Specifies the unique identifier (ID) of an active OpenID Provider.
pg_Cache_autoScalerRunInterval
Specifies the run interval in minutes for the autoScaler thread.
The default value is 60 minutes.
pg_Cache_averageObjectSize
This setting is used to convert cache size from object count to bytes
The default value is 64.
Software AG recommends you not to modify this value.
pg_Cache_boundedCacheResizeRunInterval
Specifies the run interval in minutes for the boundedCacheResize thread.
The default value is 30 minutes.
pg_Cache_maxCacheSize
Specifies the maximum cache size. This is set for an unbounded cache
The default value is 1048576
pg_Cache_minCachePercent
Specifies the minimum cache percent computed from the minimum cache size. If the computed value goes below this value it resets to this value.
The default value is 20.
pg_Cache_minCacheSize
Specifies the minimum cache size in terms of number of objects. If the cache size is lesser than this value, it resets to this value.
The default value is 1024.
pg_Cache_statisticsProcessorRunInterval
Specifies the run interval in minutes for the statisticsProcessor thread.
The default value is 15 minutes.
pg_JWT_isHTTPS
Provide a value to specify the transport protocol over which the JSON Web Tokens (JWTs) are granted authorization.
Available values are:
*true. Sets the transport protocol HTTPS. This is set by default.
*false. Sets the transport protocol HTTP.
pg_oauth2_isHTTPS
Provide a value to specify the transport protocol over which the OAuth 2.0 access tokens are granted authorization.
Available values are:
*true. Sets the transport protocol HTTPS. This is set by default.
*false. Sets the transport protocol HTTP.
pg_OpenID_isHTTPS
Provide a value to specify the transport protocol over which the OpenID (ID) tokens are granted authorization.
Available 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.3pSnmpSender.sendDelay
This is an internal parameter. Do not modify.
pg.cs.snmpTarget.base64Encoded
This is an internal parameter. Do not modify.
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
Specify 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 re-sending 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 API Gateway to report events, or it could 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. You must 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 API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.lb.failoverOnDowntimeErrorOnly
Specify API Gateway's behavior for load-balanced endpoints. The default value is true, which means that API Gateway fails over only if the service fault is a downtime error. If the parameter is set to false, then in a load-balanced routing scenario, if a service fault is encountered in the response coming from endpoint 1, then API Gateway immediately tries the next configured endpoint. There is no distinction on the type of fault present in the response from endpoint 1.
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
Specify 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 re-sending 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 API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.snmp.communityTarget.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. You must 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.snmp.communityTarget.retries to determine the delay in re-sending SNMP traps to non-responsive 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 API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.snmp.customTarget.connTimeout
Specify the number of milliseconds before an inactive 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
Specify 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 re-sending 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 API Gateway to report events, or it could 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. You must 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.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 could delay the amount of time it takes API Gateway to report events, or it could cause discarded events when the queue reaches its maximum level.
pg.uddiClient.publish.maxThreads
Specify the maximum allowed number of threads to publish the performance metrics data to CentraSite.
The default value is 2.
pg.uddiClient.uddiClientTimeout
Specify the number of milliseconds that can elapse before not publishing performance metrics to an unavailable API Gateway server.
The default value is 5000.
pgmen.quotaSurvival.interval
Specifies the number of seconds that elapses before the quota survival processor task runs.
pgmen.quotaSurvival.addLostIntervals
Specifies if the lost intervals from the recovered quota should be added.
portClusteringEnabled
Provide the value true to enable port configuration synchronization across API Gateway cluster nodes.
The default value is false.
sendClientRequestURI
The default value is false.
Decodes the URI that comes in a request to API Gateway without changing the path of the URL before sending it out to the native service.
When the value is set to true the URI is sent as is without decoding. It encodes the unicode character contained in the request.
transformerPoolSize
Provide the transformer pool size.
4. Click Save.

Copyright © 2015- 2018 | 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