Jump to: navigation, search

Prerequisites for CCAdv and WA

Before you deploy Contact Center Advisor (CCAdv), Workforce Advisor (WA), or Alert Management (AM) Administration, it is helpful to answer the following questions:

  • Will you deploy the software on a Linux Red Hat or a Windows platform?
  • New3.png Where will you store log files? Starting with release 9.0.001, you can specify a storage location for log files when you run the installation wizard.
  • Each of the modules associated with a CCAdv/WA installation (CCAdv XML Generator, WA server, Resource Management Console) can be installed on a different machine, or multiple modules can be installed on the same machine. If you are installing multiple modules, on which system will you install each module?
  • Some of these modules require integration with SCS. For details see Integration with Solution Control Server and Warm Standby. Ensure you understand the limitations and special configuration requirements when planning which Advisors applications to install on a server.
  • Will you install the CCAdv application, and if so, will you install it with XML Generator and CCAdv Web Services on the same system; or will you install it in distributed mode, with CCAdv Web Services on different system(s) than the XML Generator? If distributed, which systems will host the XML Generator, and which will host the Web Services?
  • Each system on which you install XML Generator is a unique cluster node. What will you use for the node ID?
  • Will you install the WA application, and if so, will you install it with WA Server and WA Web Services on the same system; or will you install it in distributed mode, with WA Web Services on different system(s) than the WA Server? If distributed, which systems will host the WA Server, and which will host the Web Services?
  • If you will install WA, what are your workforce management data sources and how many do you require?
  • Will CCAdv or WA send email notifications about alerts?
  • Where did you install Advisors Platform on this system? When installing WA Server or RMC, the installation directory must be the same as the directory in which Platform was installed.

Prerequisites

Ensure you have completed all the tasks in the following Table before you begin Contact Center Advisor/Workforce Advisor deployment.

If you have already installed Advisors Platform on the same system, then you will have done many of these tasks. If you are installing CCAdv XML Generator on a system on which Platform is not installed, then you must do them.

Y or N Prerequisite
All Modules
A verified Genesys environment must be ready and available.
In a Genesys environment, you have established connection to the Genesys Configuration Server.
While you can use any Genesys configuration interface to import Advisors privileges into a Role, or to assign Role-based permissions to Users or Access Groups for access to the Advisors business attributes, you can view the Advisors privileges associated with a Role only in Genesys Configuration Manager. If you need to view the Advisors privileges associated with Roles regularly, then ensure you have access to Genesys Configuration Manager.
You have configured the Advisors User account in the Genesys Configuration Server. For more information see Creating the Advisors User.
You have initialized databases—databases must be present and at the current version prior to running the installation files. The following list shows the databases required by each component:
  • Contact Center Advisor XML Generator: Platform database and metric graphing database
  • Workforce Advisor Server: Platform database and metric graphing database
  • Accessiblity Services, or Resource Management Console: Platform database.

You have configured administrator accounts that can be used by applications to access the databases.

Advisors Platform is successfully installed on each system on which you will install all modules (it is no longer required for CCAdv XML Generator).
You have located the ccadv-wa-installer-<version>.jar file on the installation CD and have copied it to the local drive of your server.
CCAdv XML Generator
In a Genesys environment, you have established connection to the Genesys Solution Control Server and to its backup if there is one.
You have installed the Local Control Agent (LCA). See Integration with Solution Control Server and Warm Standby and Overview: Configuring Advisors Application Objects and Deploying Modules that are Controlled by SCS for more information.
You have created the required Application and Host objects in Genesys Administrator or Configuration Server. If you are configuring Advisors in warm standby mode, then you have configured both primary and backup Applications and associated each primary Application with its backup for failover. See Integration with Solution Control Server and Warm Standby and Overview: Configuring Advisors Application Objects and Deploying Modules that are Controlled by SCS for more information.
There is a database-level connection between the Advisors Platform database and the datasource database (a Genesys metrics database).

To configure the connectivity, see Configure Oracle Metrics Data Sources.

For Genesys installations, the Advisors Genesys Adapter is installed.
You have set the Regional and Language options to the locale for which you want the servers to be deployed.
Workforce Advisor Server
In a Genesys environment, you have established connection to the Genesys Solution Control Server.
You have installed the Local Control Agent (LCA). See Integration with Solution Control Server and Warm Standby and Overview: Configuring Advisors Application Objects and Deploying Modules that are Controlled by SCS for more information.
You have created the required Application and Host objects in Genesys Administrator or Configuration Server. If you are configuring Advisors in warm standby mode, then you have configured both primary and backup Applications and associated each primary Application with its backup for failover. See Overview: Configuring Advisors Application Objects and Deploying Modules that are Controlled by SCS for information.
Verified workforce management data sources must be ready and available.

For Workforce Advisor installations connecting to Genesys WFM, the server running WA must be able to access your Genesys WFM installation.

To verify this access, ensure you can do all of the following from your WA server machine:

  1. Successfully ping the server name or IP address specified in the base WFM URL.
  2. Successfully telnet the server name or IP address and the port specified in the base WFM URL.
  3. Successfully ping the host name of your Genesys WFM instance as it appears in your WFM server's Genesys Administrator application.

Your WA server must have access to the WFM server by its associated Genesys Administrator host name. If it does not, an UnknownHostException occurs because the SOAP API's service locator provides a host name that is not reachable by the WA server.

If you cannot ping or access the Genesys WFM instance using the associated Genesys Administrator host name from the machine hosting the WA server, then you must add the following lines to the hosts file on the machine that will host the WA server:
# For WA connectivity with WFM
[IP address of WFM server] [Associated Genesys Administrator host name for the WFM instance]

Example: 192.168.98.229 demosrv.genesyslab.com
The hosts file is OS-specific. For example, for Windows 2003, the host file resides in the following location:
%SystemRoot%\system32\drivers\etc\

Collect Information

During deployment of Contact Center Advisor/Workforce Advisor, the installer will prompt you for the information in the following Table. Default values provided by the installer are entered in the Table.

Information Input
All Modules
Location and name of the base directory in which you will install Advisors.

The installation directory for CCAdv/WA modules must be the same as the directory where Advisors Platform was installed. Contact Center Advisor XML Generator does not require Platform, so can be installed independently.

Default on Windows:
C:\Program Files\GCTI\Advisors

Default on Linux:
/opt/gcti/advisors
Location of the Java Development Kit (root directory).
Contact Center Advisor XML Generator
New3.png Path to the directory in which log files will be written. Starting with release 9.0.001, the installation wizard prompts you to provide the log file storage location, and provides a default path.

Specifying the log file directory in the installation wizard will not change the directory that was set for previous installations.
For more information about log files, see Adjust Logging Settings and Configure Administrative Actions Logs.

Default on Windows:
c:\genesys\log\advisors\ccadv-xmlgen\
Default on Linux:
/mnt/log/advisors/ccadv-xmlgen/
Connection details to the Genesys Configuration Server:
  • The name of the Configuration Server (the Application name, obtained from Genesys Administrator). If you have Configuration Servers configured in High Availability mode, enter the name of the primary Configuration Server.
  • The name or IP address of the machine that hosts the Configuration Server.
  • The port that the configuration server is listening on (if you are not using a TLS connection). If you use a TLS connection, identify the TLS port number.
  • The name of the application that XML Generator will use to log in to the Configuration Server (for example, default).
  • The user name and password of the account that XML Generator will use to connect to the Configuration Server. This is the 'Advisors User'.
Important
If you are installing CCAdv XML Generator on an existing Advisors Platform server, you must use the Configuration Server connection properties that were provided during the Advisors Platform installation. See also the Advisors Platform installation prerequisites for additional information.

If you will connect to the Configuration Server using TLS, then you also require the following information:

  • The TLS port number for the Configuration Server.
  • The location of the TLS properties file.

If you use a backup Configuration Server, you require the following information, as well:

  • The name of the backup Configuration Server (the Application name, obtained from Genesys Administrator).
  • The name or IP address of the machine that hosts the backup Configuration Server.
  • The port on which the backup Configuration Server listens.
Defaults are:
  • Configuration server name: confserv
  • Configuration server port: 2020
  • Application name: default
The name of the default tenant in the Configuration Server under which the Advisors metadata is maintained.

When multiple Advisors suite installations are deployed to use the same Configuration server, the default tenant selected on each Advisors suite installation must be a different tenant. The default tenant configuration is selected when installing the Advisors Platform server.

The name, in Configuration Server, of the XML Generator Application. See Integration with Solution Control Server and Warm Standby for more information.
The name, in Configuration Server, of the primary Solution Control Server application. Default is SCServer.
The port number on which Local Control Agent listens on this system. Default is 4999.
Node ID for this server in the Advisors cluster. Use letters, numbers, or the dash character. The maximum 16 characters. For details see Advisors Cluster Information.
The IP address or host name that other cluster members will use to contact this node (not localhost or 127.0.0.1).
The local host address (localhost or 127.0.0.1). Default is localhost.
The HTTP port number the members of the cluster will use to communicate with XML Generator.
If you are going to install two different deployments of XML Generator on the same machine see Multiple Advisors Deployments on One System for how to choose this port number.
Default is 8090.
The Java Messaging Service port number the members of the cluster will use to communicate with XML Generator.
If you are going to install two different deployments of XML Generator on the same machine see Multiple Advisors Deployments on One System for how to choose this port number.
Default is 61616.
The port number the cluster's distributed caching will use to communicate with XML Generator.
If you are going to install two different deployments of XML Generator on the same machine see Multiple Advisors Deployments on One System for how to choose this port number.
Defaults are 11211 and 11212.
The maximum number of times that XML Generator should attempt to connect to a database if there is a connection failure.

This parameter is applicable to retry attempts when XML Generator is already running; that is, after establishing connections at startup.

Default is 32 times.
The number of seconds between CCAdv XML Generator’s reconnection attempts in the event of a database connection failure.

This parameter is applicable to retry attempts when XML Generator is already running; that is, after establishing connections at startup.

Default is 30 seconds.

The following details for the SMTP (mail) service that XML Generator will use to send email:

  • The host name or IP address of the SMTP server that XML Generator will use to send email.
  • (Optional) The address from which XML Generator will send notification email about alerts.
  • The address to which to send notification email for support staff concerning issues with XML Generator. This address will also appear in the From: header of these types of email.
Important
Advisors modules store the email addresses that you enter on the installation wizards and use those addresses to notify support staff about operating issues. The email addresses are stored in the relevant properties file. A user's email address persists in the properties file even after a user's Person object is removed from Configuration Server. An email address that contains an employee's full name can be considered to be personally identifiable information (PII) and therefore, to be compliant with the General Data Protection Regulation (GDPR), you must remove the user's email address from the properties files if the user makes a "forget me" request. The need to update the properties file(s) to remove email addresses can be avoided if you always use an email alias for support staff, rather than user-identifying email addresses. For example, use advisors.support@yourcompany.com instead of john.doe@yourcompany.com. For more information about PII and the GDPR, see the Genesys Security Deployment Guide.
Frequency (in seconds) at which CCAdv XML Generator stores metrics and threshold violations for the values calculated for the Medium and Long groups of time profiles.

For example, if you enter 120 seconds for this parameter, XML Generator stores metrics and threshold violations for these time profiles no more often than that. However, XML Generator may store the view data less frequently depending upon load and the complexity of the configuration.

Default is 120 seconds.
The frequency (in seconds) at which snapshots are stored in the metric graphing database.

For example, if you enter 60 seconds for this parameter, XML Generator and WA Server store graphable snapshots no more often than that. However, they may store the snapshots less frequently depending upon load and the complexity of the configuration.

Default is 60 seconds.
Should graphs display values from the previous day? Do not check the Start at midnight box if you want graphs to display values from the previous day.
What are XML Generator's sources of real-time data? Specify the following:
  • the database name or linked server name
  • the source type (Genesys or Cisco)
  • (optional) the display name
  • the threshold update delay—how long CCAdv will wait for new data from this data source before notifying users on the CCAdv dashboard, and, if configured to do so, administrators by email.
  • the Relational Database Management System (RDBMS) type (MS SQL or Oracle)

Up to five data sources may be added to the deployment of XML Generator.

Workforce Advisor Server
The name, in Configuration Server, of the WA Server Application.
The name, in Configuration Server, of the Solution Control Server application. Default is SCServer.
The port number on which Local Control Agent listens on this system. Default is 4999.
Specify your workforce management data sources (IEX TotalView, Aspect eWFM, Genesys WFM).
The 'From' address WA puts in email it sends about alerts to users that are members of distribution lists configured in the Administration module.
If you are using WFM data from IEX TotalView, then specify:
  • the port number on which the FTP connection in WA listens for data from TotalView.
Default port number is 6021.
If you are using WFM data from Aspect eWFM, then specify:
  • the URL of the directory from which WA reads data from eWFM. For example file:/// followed by the location of the eWFM files. Additional information is provided in the descriptions of installation screens on the Deploying CCAdv and WA page.
If you are using WFM data from Genesys WFM, then specify:
  • The Application name of the WFM server as configured in the Configuration Server.
  • The URL of the WFM server.
  • The username WA Server will use to connect to Genesys WFM.
  • The password WA Server will use to connect to Genesys WFM.
  • The interval (in ms) at which the Genesys WFM service is polled for forecast data.
  • The number of hours of forecast metrics to get on each polling.
Default values are:
  • Application name: WFM_Server
  • Username and password: no defaults.
  • Polling interval: 1800000 ms. (30 minutes.)
  • Number of hours of forecast metric to retrieve: 24 hours.
CCAdv XML Generator and Workforce Advisor Server
The time profile to use for default historical metrics that you want to display for agent groups in Contact Center Advisor and Workforce Advisor. The choices are 5 minute sliding, or 30 minute growing. The same choice applies to both applications. Default is 5 minutes sliding.
Type of database used in your enterprise (MS SQL or Oracle), and connection details to the Advisors Platform database:
  • The host name, IP address, or named instance of the server on which the Advisors Platform database is installed.
  • Port number that the database listens on (you do not require this information if the server is a named instance)
  • The Platform database name (the Service name for an Oracle installation)
  • The username (the schema for clustered databases or an Oracle installation) and password associated with the account that modules will use to access the Platform database
  • For Oracle environments, the location of the JDBC driver.
  • For clustered databases, the location of the file that contains the JDBC URL (you should have the freeform JDBC URL in a text file).

Use the same database configuration that was specified when the Advisors Platform database was configured.

Default values for port number:
  • Oracle: 1521
  • MS SQL: 1433
    When using numerical IP addresses or names with dots in the installations with MS SQL, enclose the literal in brackets. If the MS SQL database server is a named instance, then omit the port number and use double backslash: <host name>\\<instance name>
Connection details to the Metric Graphing database:
  • The host name, IP address, or named instance of the server on which the Metrics Graphing database is installed.
  • Port number on which the database listens (you do not require this information if the server is a named instance).
  • The Metrics Graphing database name (the Service name}} for an Oracle installation).
  • The username and password associated with the account that modules will use to access the Metrics Graphing database.
  • For clustered databases, the location of the file that contains the JDBC URL (you should have the freeform JDBC URL in a text file).
Default values for port number:
  • Oracle: 1521
  • MS SQL: 1433
    When using numerical IP addresses or names with dots in the installations with MS SQL, enclose the literal in brackets. If the MS SQL database server is a named instance, then omit the port number and use double backslash: <host name>\\<instance name>
This page was last edited on May 22, 2019, at 14:51.
Comments or questions about this documentation? Contact us for support!