API Gateway Package Configuration Properties

Edit online

webMethods API Gateway uses Elasticsearch as its data repository. webMethods API Gateway starts the Elasticsearch instance, if configured, using the default configuration shipped and located at InstallDir/config/elasticsearch.yml

Note: To run Elasticsearch instances in a cluster, the elasticsearch.yml file must be updated on each instance. For additional details, see https://www.elastic.co/guide/​en/elasticsearch/guide/current/important-configuration-changes.html#important-configuration-changes.

Location : InstallDir/​IntegrationServer/instances/IS_Instance_Name​/packages/WmAPIGateway/config/resources/elasticsearch/config.properties

pg.gateway.elasticsearch.autostart

Denotes the flag to manage (start or stop) Elasticsearch as part of webMethods API Gateway. Set it to false if the start or stop of the external Elasticsearch is managed from outside the webMethods API Gateway.

Possible values: true, false.

Default value is true.

pg.gateway.elasticsearch.http.connectionTimeout

Denotes maximum time in milliseconds webMethods API Gateway waits for Elasticsearch to start and stop if autostart is set to true.

Default value is 10000.

pg.gateway.elasticsearch.config.location

Denotes the location of the config file. If you have to use a different config file, mention the location of the config file here.

Default value is InstallDir/config/elasticsearch.yml

Note:
  • If the Elasticsearch hostname is same as localhost, then the system automatically modifies the value of <prop key=cluster.name> in InstallDir/IntegrationServer/instances/IS_Instance_Name/​packages/WmAPIGateway/​config/resources/beans/gateway-datastore.xml to cluster.name property in the elasticsearch.yml file.
  • If the Elasticsearch hostname is same as localhost, then the system automatically modifies the port value of localhost:9340 in InstallDir/IntegrationServer/instances/IS_Instance_Name/​packages/WmAPIGateway/​config/resources/beans/gateway-datastore.xml to transport.port property in the elasticsearch.yml file.
  • Ensure that the cluster.name and transport.port properties are in synchronization if you encounter any errors.