Configuration

Overview

Once the Web API Server is installed, the application requires a system property called config.file to be available to the Java Virtual Machine and connections in Configuration server.

Config File

The config.file contains the absolute name of a file containing the required properties.

The file must be in YAML format and contains the following information:

• Configuration server hostname (cmeHost)
• Configuration server port number (cmePort)
• WebAPI application name on configuration server (app)

Example

Below is an example configuration file. For the purpose of this example, we will assume that the absolute name of the file is /webapi/server-settings.yaml.

cmeHost: ci-vm184
cmePort: 8888
app: esv_web_logic

One method to make a file available to the Java Virtual Machine is to pass the following parameter to the server launch script:

-Dconfig.file=/webapi/server-settings.yaml

Server specific ways to specify this property will be described in server specific sections.

Configuration Server Settings

The following must be configured using Configuration Manager or Genesys Administrator.

• Create a new Application object for the Web API Server. For example: webapi_server
• Create a connection to Email Server, Message Server, and SCS Server using default ports
• Connect to the Chat Server via the webapi port

Example

app: webapi_server
cmeHost: ci-vm184
cmePort: 8888