Jump to: navigation, search


Also known as JDBC. A Java Application Programming Interface (API) that enables Java programs to execute SQL statements.



If you use a Genesys computer-telephony integration (CTI) installation, you must install Advisors Genesys Adapter with CCAdv and WA applications.

Deploying Advisors Genesys Adapter

You run a .jar installation file to deploy Advisors Genesys Adapter (AGA). The installation wizard guides you through the deployment. The screens displayed during your deployment are dependent on the selections you make on the Module to Install and Server Type screens. Information about each screen is available in the Installer Screens descriptions, below.

In release 9.0, there are changes to the installation wizard screens; therefore, you cannot reuse your previous setup for silent installation or any saved ant.install.properties file.

If you will be configuring multiple Genesys Adapters, note the following:

  • Each primary AGA among the multiple adapters configured should use Stat Servers different from those used by other primary adapters.
  • The primary and the backup AGA in a pair must be configured with the same Stat Servers.

For example, if there are two pairs of adapters configured (AGA1 and AGA2, and AGA3 and AGA4). AGA1 and AGA2 form a primary-backup HA pair. AGA3 and AGA4 form another primary-backup HA pair. The Stat Servers configured for the AGA1/AGA2 pair must not be the same Stat Servers configured for the AGA3/AGA4 pair. The Stat Servers configured for AGA1 and AGA2 must be the same Stat Servers, and the Stat Servers configured for AGA3 and AGA4 must be the same.

The preceding rules ensure the following:

  1. On restart of the system, based on the last persisted Stat Server–object mapping, the statistics are requested with the same adapters, and each adapter queries the same Stat Servers as previously.
  2. On switching over from the primary adapter to the backup adapter, the statistics are requested with the same Stat Servers as previously.
Genesys recommends that the AGA metrics database selected for the primary and the backup AGA instances of a given adapter pair should be the same metrics database.

Deployment Roadmap

The arrow icon in the following roadmap indicates where you are in the Advisors deployment process.

  1. Install the databases that correspond to the Advisors products that you will deploy. Perform the database installation in the following order:
    1. AGA metrics database
    2. Grant select privileges on all AGA metrics views to the Platform user.
    3. Metric Graphing database
    4. Advisors Platform database
  2. Create the Advisors User account in Genesys Configuration Server.
  3. Install the Platform service on servers where it is required for Advisors components. The Platform service is a prerequisite for installing the following components:
    • Advisors Administration
    • Advisors Web Services
    • WA Server
    • FA Server with rollup engine
    • CCAdv/WA/FA Accessibility services
    • CCAdv/WA Resource Management console
  4. Pma you-are-here-arrow.png Install each adapter that you will use and configure the adapter Application objects with Stat Server connections. See additional information for CCAdv/WA installations.
  5. Install the Advisors components for your enterprise.
    • Contact Center Advisor server (CCAdv XML Generator)
    • Workforce Advisor server
    • Frontline Advisor server
    • SDS and the CCAdv/WA Resource Management console
  6. Make any required configuration changes.

You can deploy AGA on a Red Hat Linux or a Windows platform, and with Oracle or MS SQL databases.

Migration Notes

If you are migrating to a new software release, and not installing Advisors Genesys Adapter (AGA) for the first time, there is an existing AGA entry in the ADAPTER_INSTANCES table in the Platform database. You have two options when upgrading your AGA instance:

  1. Install the new AGA instance with the same host name and port number as the previous installation. The previous adapter is updated with the new configuration. For this option, you must have information about the earlier adapter to ensure you overwrite it successfully: host and port number. Ensure you enter that information on the Adapter Port and Registration Option installation screen to match the previous entry exactly. If this information is unavailable, you can find it in the ADAPTER_INSTANCES database table on the Platform database.
  2. Install the new AGA instance with a different adapter host name and port number; it is added as a second adapter in the Platform database. Use this option to install a new adapter instance, or if you need to move the adapter to a new host name or port number. If moving the adapter to a new host name or port number, you must manually remove the previous adapter entry from the Platform database.

Migrating the AGA Metrics Database or Schema

You use scripts supplied by Genesys to simply remove old objects and then add new objects to the Advisors Genesys Adapter metrics database. Genesys provides two scripts for Oracle and one for MS SQL; see the following procedures. Review the Readme.txt file included with the scripts. The Readme file includes important information, including which tools Genesys recommends to execute the scripts.

Procedure: Migration of AGA Oracle METRICS Schemas


  1. Connect to your database management interface as the AGA METRICS user.
  2. Execute one of the following scripts:
    • gc_metrics_<version>_ObjectsPlus.sql (if you use SQL*Plus)
    • gc_metrics_<version>_ObjectsDefault.sql (if you use sqlDeveloper and all objects reside in the default tablespaces assigned to the METRICS user)
    • gc_metrics_<version>_ObjectsCustom.sql (if you use sqlDeveloper and you want to specify explicit names for tablespaces)
  3. Re-issue the GRANT SELECT commands on each METRICS schema view to the Platform user.

Procedure: Migration of AGA MS SQL Databases


  1. Connect to the AGA metrics database.
  2. Execute gc_metrics_db_<version>.sql.

Deploying Advisors Genesys Adapter




  1. Launch the AGA installation file.
    [+] Show Steps for Linux
    [+] Show Steps for Windows
  2. On the Module to Install screen, select the Adapter Server radio button.
  3. Use the Next and Back buttons on the installer to navigate through the installation screens. Enter your information on each screen. Use the information provided in the Installation Screens section on this page to complete the remaining deployment screens. Ensure you provide complete information on each screen.
  4. Click Show Details and verify that there were no errors reported during installation.

Installation Screens

[+] Adapter Metrics Database

[+] Adapter Metrics Database - Advanced

[+] Adapter Port And Registration

[+] Advisors Platform Database

[+] Advisors Platform Database - Advanced

[+] Genesys Config Server Connection Details

[+] Backup Config Server

[+] Installation Details

[+] Java Development Kit

[+] Log Files Directory

[+] Oracle JDBC Driver

[+] RDBMS Type and JDBC Connectivity

[+] SCS Integration Configuration

[+] Server Type

Multiple instances on a server

It is possible to deploy multiple instances of the Genesys Adapter core service on a single server. If you do use the same metrics database for more than one adapter, each adapter must monitor a completely distinct set of objects. For each installation, you should create the metrics database.

Deploy the second, and subsequent AGA instances, using the same procedure you use to deploy a single instance, and follow these rules:

  • You must install each Genesys Adapter instance in a different directory. For example, the first instance could use the following location:
    C:\Program Files\GCTI\Advisors\Genesys\Adapter
    and the second instance could be located at:
    C:\Program Files\GCTI\Advisors\Genesys\Adapter2.
  • You must specify a unique log directory for each Genesys Adapter instance.
  • You must specify a unique port number for each Genesys Adapter instance.
  • You must select a unique application name for each Genesys Adapter instance.


The following Table shows parameter validation errors that you may encounter at the end of installation.

Installation Error Message Cause
[java] Failed to connect to the database using connection URL:

jdbc:sqlserver://192.168.xx.yy:nnn;DatabaseName=ys_gadb;user=sa;password=very_secure_pwd; selectMethod=cursor
[java] The following exception was thrown:
com.microsoft.sqlserver.jdbc.SQLServerException: The TCP/IP connection to the host 192.168.xx.yy, port nnn has failed. Error: "Connection refused. Verify the connection properties, check that an instance of SQL Server is running on the host and accepting TCP/IP connections at the port, and that no firewall is blocking TCP connections to the port.

Wrong database server name / IP address or port number
[java] Failed to connect to the database using connection URL:

jdbc:sqlserver://192.168.xx.yy:nnnn;DatabaseName=NotAPlatformDB;selectMethod=cursor;user=sa; password=very_secure_pwd
[java] The following exception was thrown:
com.microsoft.sqlserver.jdbc.SQLServerException: The TCP/IP connection to the host 192.168.xx.yy, port nnnn has failed. Error: "connect timed out. Verify the connection properties, check that an instance of SQL Server is running on the host and accepting TCP/IP connections at the port, and that no firewall is blocking TCP connections to the port."

Wrong database name
[java] Exception while connecting: Login failed for user 'badUserId'.

[java] url used:
jdbc:sqlserver://192.168.xx.yy:nnnn;DatabaseName=ys_gadb;selectMethod=cursor;user=badUserId; password=very_secure_password

Wrong database user name or password
[loadfile] Unable to load file: java.io.FileNotFoundException: C:\ (The system cannot find the path specified) Produced in error and can be ignored.
C:\Users\<USERNAME>\AppData\Local\Temp\antinstall\ build.xml:189: The following error occurred while executing this line:

C:\Users\<USERNAME>\AppData\Local\Temp\antinstall\ installer-common.xml:468: java.lang.NoClassDefFoundError: javax/xml/bind/DatatypeConverter at com.microsoft.sqlserver.jdbc.SQLServerConnection.sendLogon(SQLServerConnection.java:4061) ...

Ensure that you are launching the installer with a supported version of the Java Development Kit (JDK). You can type java --version in a Windows command prompt window or in the Linux terminal to see which version is currently configured on your system. If you are using a Windows OS, add the JDK folder path to both JAVA_HOME and PATH in environment variables. If you use Red Hat Enterprise Linux, add the JDK folder path to the PATH variable.
This page was last edited on August 13, 2019, at 20:11.
Comments or questions about this documentation? Contact us for support!