API Gateway Package Configuration Properties

Edit online

API Gateway uses API Data Store (Elasticsearch) as its data repository. API Gateway starts the API Data Store instance, if configured, using the default configuration shipped and located at SAG_root/InternalDataStore/config/elasticsearch.yml

Note: To run API Data Store 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 : SAG_root/​IntegrationServer/instances/IS_Instance_Name​/packages/WmAPIGateway/config/resources/elasticsearch/config.properties

pg.gateway.elasticsearch.autostart

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

Possible values: true, false.

Default value is true.

pg.gateway.elasticsearch.http.connectionTimeout

Denotes maximum time in milliseconds API Gateway waits for API Data Store 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 SAG_root/InternalDataStore/config/elasticsearch.yml

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