Deploying Genesys Administrator Extension
This page describes how to install and deploy Genesys Administrator Extension. Before beginning your installation, ensure that you have met the prerequisites listed in Prerequisites. If you plan to install any of the modules in Genesys Administrator Extension, refer to Prerequisites for Genesys Administrator Extension Modules before using them.
- Although Configuration Server might support more database types, GAX only supports the following database types: Oracle, Microsoft SQL Server, and PostgreSQL. Refer to the Genesys Supported Operating Environment Reference Guide for information on which operating environments are supported by GAX.
- Do not connect GAX to a Configuration Server Proxy; connect it to Configuration Server only. Configuration Server Proxy does not support some functionality that is required by GAX.
- Although Management Framework supports various operating systems, GAX can only be deployed on an Operating System that is also supported by Configuration Server and DB Server. For more information, see Genesys Administrator Extension and Framework pages of Genesys Supported Operating Environment Reference.
Deploying Genesys Administrator Extension via Setup Mode
Setup Mode can set up new instances of GAX to connect to an existing Management Framework deployment. You can also use Setup Mode to install and configure new Genesys deployments. In the latter scenario, Setup Mode will install GAX, Configuration Server, and DB Server (where applicable). After these components are installed, you can use the installation package (IP) management features of GAX to deploy other installation packages.
If you are using Setup Mode to install GAX for the first time, you must be a local user on the machine on which GAX will be installed. You are considered a local user if you are using this machine in person or via a remote desktop connection. After the set up is completed, the local user account is no longer used for subsequent installations.
To deploy GAX via Setup Mode
To deploy GAX using Setup Mode, you must do the following:
- Set up the GAX database
- Set up the Host on which GAX will be installed
- Install the GAX Server on the Host
- Deploy GAX
- Set up a connection to Solution Control Server
- Configure Centralized Logs
Step 1 -- Set Up the GAX Database
Choose one of the following database types:
Database Access Points
After you have set up the GAX database, you must configure a Database Access Point (DAP) through which GAX can access the GAX Database. Normally, a basic DAP is all you need. Follow the instructions here.
Starting in GAX 8.5.25x, you can create a custom JDBC URL to connect to the GAX Database. This URL is specified in the Database Access Point (DAP), and is an alternative to using a connection based on the DAP object that enables access to the GAX Database.
To configure a custom JDBC URL, use the jdbc_url option in the [GAX] section of the DAP object. If this option is not configured, GAX will use the DAP object values for establishing the connection.
Option Name: jdbc_url
Valid Values: Any valid URL to an existing configured database.
Changes take effect: After restart of GAX
A sample URL for an MSSQL database is:
In this URL, username and password are optional for security reasons, and may not be specified. If specified, GAX will consider them to be the access credentials to the GAX Database, and make the connection. If not specified, GAX will use the username and password values from the General tab of the DAP object.
Step 2 -- Set Up the Host
To set up the host on which GAX will be installed:
- If Java Server JRE 6, 7, or 8 is not already installed on the host machine where Genesys Administrator Extension will be installed, install it now by downloading it from the following website:
ImportantSupport for JDK 1.6 is withdrawn starting from release 8.5.260.11 and JDK 1.7 is mandatory to install GAX 8.5.260.11. However, JDK 1.6 is still supported for releases prior to GAX 8.5.260.11.
Refer to the Oracle documentation for more information on how to install the tar.gz package.ImportantGAX only supports the 64-bit version of Oracle Java HotSpot Server VM.
- Set the following environment variables for your host, as follows:
- Insert the following lines into the /etc/profile file:
export JRE_HOME=/usr/lib/java/jre-<version of Java downloaded>/jre export PATH=$PATH:/usr/lib/java/jre-<version of Java downloaded>/jre/bin
- Log out and log in again to activate the new environment variables in the current session.
- Create a new System Variable named JRE_HOME and use the path that was used during installation as the value. For example, C:\Programs\Java\jre1.6.0_23.
- Edit the Path variable and append C:\Programs\Java\jre1.6.0_23\bin to the existing value.
- Insert the following lines into the /etc/profile file:
- Install Local Control Agent on this host. For detailed instructions, refer to the Framework Deployment Guide.
Step 3 -- Install the GAX server on a host
To install the GAX Server, follow the instructions for the type of Operating System you are using.
- The environment variable JRE_HOME has been configured in Step 2 -- Set Up the Host.
To install the GAX Server on Linux: [+] Click to show steps
To install the GAX server on Windows: [+] Click to show steps
Step 4 -- Deploy GAX
The deployment procedure for GAX depends on the installation environment. Follow the steps that corresponds to your situation.
- Deploy GAX to an Existing Management Framework Deployment [+] Click to show steps
- Primary Configuration Server Host
- Port number
- Default Client Application Name
- To use an existing Application object, select the Application object from the list. If the Host object on which the object is configured has the same Host name or IP address as the current GAX instance, the Application object is highlighted as recommended.
- To create a new Application object, provide the following information in the corresponding fields:
- Administrator Extension Application Object Name—The name of the Application object to create.
- Template—The application template to use.
- Database Server Type
- Database Host
- Port (numeric only)
- Database Name
Step 5 -- SCS Connection
GAX must have a connection to Solution Control Server (SCS) for the System Dashboard to function.
- Solution Control Server is installed and configured.
- In GAX, go to Configuration Manager.
- Hover over the Environment icon and select Applications in the pop-up list.
- In the Applications list, open the Application object for GAX.
- In the GAX Application object details window, click the Connections tab.
- Click Add.
- In the pop-up window, enter information about the connection to SCS. Refer to the procedure "Creating Application Objects" on the Applications page for more information.
- Click OK.
- Click Save. You might see an error in the system dashboard at this point but it is resolved in the next step when you restart GAX.
- Restart GAX.
Deploying GAX via the Command Line
You can also deploy GAX (with or without Management Framework) via the command line by using a setup file to provide deployment instructions. This feature is useful for situations in which you cannot access the GAX host via a remote desktop connection.
To install GAX into an existing Management Framework Deployment, do the following:
To deploy GAX and Management Framework, do the following: