webApp Configuration Properties

Edit online

These properties are not cluster-aware and, hence, you must manually copy them to all the nodes.

General properties

Location: SAGInstallDir/profiles/IS_instance_name/apigateway/config/uiconfiguration.properties

apigw.auth.priority

webMethods API Gateway supports both Form-based and SAML-based authentication. If both are enabled, this property decides the login page to be displayed, by default, when a user visits the login page http://host:port/apigatewayui. A user can go to a specific login page using:
  • Form: http://host:port/apigatewayui/login
  • SAML: http://host:port/apigatewayui/saml/sso/login

Possible values: Form, SAML.

Default value is Form.

apigw.auth.form.enabled

This property enables or disables Form-based authentication. If both SAML and Form are disabled, the value Form is retained by default.

Possible values: true, false.

Default value is true.

apigw.auth.form.redirect

If a protected resource is accessed and the Form-based authentication is enabled, user is redirected to this page.

Default value is /login.

apigw.is.base.url

Host where the IS package is hosted. localhost is replaced by the hostname that is resolved through localhost.

Note: The port changes to the default port of the Integration Server instance irrespective of HTTP or HTTPS.

Default value is http://localhost:port. Here, port denotes the port that is configured at the time of installation.

apigw.user.lang.default

This property denotes the language to be used in the webMethods API Gateway UI.

Default value is en (English).

apigw.is.timeout

This property denotes the user session timeout value in minutes.

Default value is 90.

Kibana

Location : SAGInstallDir/profiles/IS_instance_name/apigateway/config/uiconfiguration.properties

apigw.kibana.autostart

Specifies whether Kibana should be started as part of web-app.

Possible values: true, false.

Default value is true.

apigw.kibana.url

Denotes the URL where Kibana is running. localhost is replaced by the hostname that is resolved through localhost. The port and other configurations of the Kibana can be changed from SAGInstallDir/profiles/IS_instance_name/apigateway/dashboard/config/kibana.yml

Default value is http://localhost:9405

apigw.es.url

Denotes the URL where API Data Store (HTTP) is running. localhost is replaced by the hostname that is resolved through localhost.

Default value is http://localhost:port

port denotes the API Data Store HTTP port configured during installation.

Note: If the configured host resolves to the host name of the localhost, the port changes to the HTTP port configured in the SAGInstallDir/InternalDataStore/config/elasticsearch.yml file.

kibana.process.stop.signal.number

Specifies the signal number to be used when stopping the Kibana process.

The default signal number is SIGINT(2).

SIGINT(2) stops the Kibana process without producing a core dump. This property is applicable only for Linux Operating System. For information about the signals, see https://www.linux.org/threads/kill-commands-and-signals.8881/.