Jump to: navigation, search

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.

Genesys Administrator Extension can be deployed using Setup Mode or the command line.

  • 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.

Any interruption in the Setup Mode process might result in only partial and incomplete configuration of your environment. A complete restart of the setup process is needed. If you encounter an interruption while deploying GAX using Setup Mode, first reset Configuration Server (for example, stop any running Configuration Server processes) and your environment (for example, reset the Configuration Database) to their initial values. Then restart Setup Mode from scratch.

To deploy GAX via Setup Mode

To deploy GAX using Setup Mode, you must do the following:

  1. Set up the GAX database
  2. Set up the Host on which GAX will be installed
  3. Install the GAX Server on the Host
  4. Deploy GAX
  5. Set up a connection to Solution Control Server
  6. Configure Centralized Logs

Step 1 -- Set Up the GAX Database

In Setup mode, results of executing SQL statements that contain the drop keyword are ignored, although they are still logged by GAX. This is because some databases return errors when dropping tables or views; you can ignore these errors. If required, you can find the errors in the logs of the GAX server.

Choose one of the following database types:

[+] Show steps for Oracle

[+] Show steps for Microsoft SQL

[+] Show steps for Postgre SQ

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: jdbc:sqlserver://hostname:portnumber;Database=gax_https;username=sa;password=sa@2008;ssl=off
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.

Each DBMS configures URL in different ways. You must provide the URL in the correct format and syntax as required for your DBMS. GAX cannot establish a connection to the Database if the URL is incorrect or not improperly formed.

Step 2 -- Set Up the Host

To set up the host on which GAX will be installed:

  1. 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: http://www.oracle.com/technetwork/java/javase/downloads/index.html
    Support for JDK 1.6 is withdrawn starting from release and JDK 1.7 is mandatory to install GAX However, JDK 1.6 is still supported for releases prior to GAX

    Refer to the Oracle documentation for more information on how to install the tar.gz package.

    GAX only supports the 64-bit version of Oracle Java HotSpot Server VM.
  2. Set the following environment variables for your host, as follows:

    1. 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
    2. Log out and log in again to activate the new environment variables in the current session.

    1. 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.
    2. Edit the Path variable and append C:\Programs\Java\jre1.6.0_23\bin to the existing value.

  3. 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.


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
  • Select the Username field and enter root. By default, there is no password.
  • Click Log In.
  • Choose Connect to an Existing Deployment.
  • You must provide configuration information about the existing Management Framework deployment. This screen pre-populates with existing details about the deployment, such as:
    • Primary Configuration Server Host
    • Port number
    • Default Client Application Name
    • Username
    • Password
    If there are any errors, GAX prompts you to re-enter the configuration information.
  • Click Next.
  • Associate this instance of GAX with an Application object. Do one of the following:
    When you are first installing GAX, be sure to use an Application object that is based on the template from the GAX IP.
    • 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.
      This creates an application of type Genesys Administrator. If the Host object does not exist, it is automatically created.
  • Click Next.
  • GAX prompts you to enter configuration information for the GAX database. This screen pre-populates with existing details that might be stored in Configuration Server. You must provide the following configuration information:
    • Database Server Type
    • Database Host
    • Port (numeric only)
    • Database Name
    • Username
    • Password
  • Click Next.
  • GAX verifies the database version and creates (or updates) the database access configuration. If an error occurs, an error message displays and you can either cancel or restart the deployment process.
  • Click Finish.
  • GAX restarts to finish the setup operation. When it is done, GAX displays the login screen and you can login to GAX.
  • Important
    If you start or stop GAX from GA or SCI when GAX is using gax_starup.bat, then GAX status appears incorrectly in Windows Services. To view the synchronized status in Windows Services, GA and GAX, you must manually edit the GAX application in Configuration Server and update the command line to gaxservice.exe and the command line arguments to, for example, -service GAX64 -immediate - app GAX application name.
  • Deploy GAX or Later and Management Framework 8.5.x/8.1.x [+] Click to show steps
  • Deploy GAX or Earlier and Management Framework 8.1.x [+] Click to show steps
  • Step 5 -- SCS Connection

    GAX must have a connection to Solution Control Server (SCS) for the System Dashboard to function.



    1. In GAX, go to Configuration Manager.
    2. Hover over the Environment icon and select Applications in the pop-up list.
    3. In the Applications list, open the Application object for GAX.
    4. In the GAX Application object details window, click the Connections tab.
    5. Click Add.
    6. 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.
    7. Click OK.
    8. 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.
    9. 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:

    [+] Show steps

    To deploy GAX and Management Framework, do the following:

    You can only deploy Management Framework 8.5.x if you are using GAX or later. GAX or earlier can deploy only Management Framework 8.1.x.

    [+] Show steps

    Deploying GAX into an existing Tomcat installation

    These steps are optional. GAX uses an embedded instance of Jetty for web-server functions, so this procedure only applies if you prefer to deploy GAX into an existing Tomcat installation.

    For this procedure, see Deploying GAX into Tomcat 8 in the Genesys Administrator Extension Migration Guide.

    This page was last edited on June 21, 2021, at 00:07.
    Comments or questions about this documentation? Contact us for support!