Deploy Genesys Web API Server on a Supported Web Application Server

Important

This procedure assumes that you have installed and configured a web application server.

1. Unzip data.tar.gz (data.zip for Windows machines) to a directory we shall refer to as the $UNZIP_DIRECTORY
2. Inside the $UNZIP_DIRECTORY, there will be two (2) folders:
   • webapi contains the exploded war file; and
   • dist/ contains helper files
3. The WebAPIServer_850.apd template file is located in the /templates folder on the CD image. This is the template file that needs to be imported into Configuration Server. The WebAPIServer_850.xml template file is located in the /templates folder on the CD image. This is the template file that needs to be imported into Genesys Administrator.
4. Create an application in Configuration Manager using the imported template. Note the name of the application (APPLICATION_NAME).
5. Copy $UNZIP_DIRECTORY/dist/messaging/webapimsg.lms to a directory accessible by the supported web application server process. Copy this location. Using either Genesys Administrator or Configuration Manager, navigate to the log section of the configuration options, create a new messagefile option if one does not exist, and set the value for this option to be the location you saved.

6. Deploy $UNZIP_DIRECTORY/webapi as directed by instructions for your web application server. For example:

   • For Jetty, copy the directory to $JETTY_INSTALL_PATH/webapps/
   • For Tomcat, copy the directory to $TOMCAT_INSTALL_PATH/webapps/
   • For WebLogic, use the Administrative console and navigate to Admin Home -> Deployments -> Install
   • For WebSphere, use the Administrative console install wizard
7. In $UNZIP_DIRECTORY/dist/conf, you will find the server-settings.yaml file. Copy this file to a location that can be accessible by the supported web application server process.
8. Modify the server-settings.yaml file by adding the appropriate host and port for your Configuration Server and the APPLICATION_NAME you noted in step 4.
9. Add this JVM parameter to tomcat: -Dconfig.file=path_to/server-settings.yaml (replace path_to/server-settings.yaml with the file path to your server-settings.yaml file).
10. The API will be available at {APP_HOST}:{APP_PORT}/{context}/api/v2/chats.