Install the Pacing Service

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Agent Pacing Service Deployment Guide for version Current of Altocloud.

Complete the steps to install the Pacing Server.

The 9.0 release of Pacing Server can be used on premises.

About the Pacing Service Cluster

Agent Pacing Service uses an N+1 architecture. This means that almost all of the configuration is handled at the level of the cluster, rather than at the level of individual nodes. In particular,

  • The cluster combines one or more nodes. You must install and configure at least one Pacing Server node in order to use Pacing Service. Every time you add a node to the cluster, you must create and configure it using the same steps you used for the first node.
  • All nodes are treated as equivalent to each other. Because of this, the nodes only contain a connection to the cluster application.
  • Connections to other Genesys servers—such as Stat Server and Message Server—are defined for the cluster.
Important
Pacing Service is a single-tenant application—it only has access to the tenant, objects, and transaction list of the tenant it is configured for. In a multi-tenant environment, you can configure a Pacing Service for each individual tenant.


Deploy Pacing Server

To deploy Pacing Server, follow these steps:

  1. Import the Pacing Service Cluster Application template
  2. Create the cluster application
  3. Configure the cluster application
  4. Import the Pacing Server Application template
  5. Create and configure a node application
  6. Add the node application to the cluster
  7. Install Pacing Server
  8. Configure alarms
  9. Configure a forward proxy (optional)


Import the Pacing Service cluster application template

Prerequisite: Download the Pacing Server installation on the host where you are going to install it.

  1. Open Genesys Administrator Extension and navigate to Environment > Application Templates:
    Aps-all app templates.png
  2. Click New. In the Tasks panel, click Import Application Template:
    Aps-node app template.png
  3. Navigate to the Pacing Server installation root/templates folder and select Pacing_Server_Cluster.apd:
    Aps-cluster apd.png
  4. Click Import Metadata.
  5. Navigate to the Pacing Server installation root/templates folder and select Pacing_Server_Cluster.xml:
    Aps-cluster xml.png
  6. Click Save

Create the cluster application

Prerequisite: Import the Pacing Service cluster application template

  1. Open Genesys Administrator Extension and navigate to Environment > Applications.
  2. In the Tasks panel, click New:
    Aps-new app.png
  3. Specify the name of the Pacing Service cluster application (for example, Pacing_Service_Cluster_9.0), then click to select a template:
    Aps-new cluster app template.png
  4. Select the application template that you created previously:
    Aps-select cluster app template.png
  5. Select the General tab and:
    • Set the value of the Working Directory and Command Line fields to . (a single dot).
    • Make sure that State is enabled.
    • Select the Host on which the Pacing Service Cluster will reside. This is usually the fully qualified domain name or IP address of the load balancer that provides access to the Pacing Service (that is, the set of Pacing Servers)
    • Click Save.
    Aps-set cluster values.png
  6. The new Cluster application is now available:
    Aps-new cluster app created.png

Configure the cluster application

Prerequisite: Create the cluster application

  1. Open Genesys Administrator Extension and navigate to Environment > Applications, then open your cluster application:
    Aps-open app.png
  2. In the Connections tab, click Add:
    Aps-cluster connections.png
  3. Select the Stat Server application. Leave the connection port ID set to default. Click OK:
    Aps-cluster stat server connection.png
  4. If appropriate, you can also add a connection to Message Server (to apply the network logging options).
  5. Navigate to the Ports tab and set the desired value of the default port. Note: The cluster application does not represent a particular server: you must treat as the load balancing entry point. Set the connection type to http. Genesys recommends that you use a secure connection.
    Aps-cluster port.png
  6. In the Tenant tab, click Add and select your tenant. For instance, Environment.
    Aps-cluster tenant.png
  7. Navigate to the Application Options tab. You can keep the default values for all options except the ones in the pacingEndpoint section.
    9000200AppOptions.png
  8. Click Save.

Import the Pacing Server application template

Prerequisite: Configure the cluster application

  1. Open Genesys Administrator Extension and navigate to Environment > Application Templates:
    Aps-all app templates.png
  2. Click New. In the Tasks panel, click Import Application Template:
    Aps-node app template.png
  3. Navigate to the Pacing Server installation root /templates folder and select Pacing_Server.apd:
    Aps-node apd.png
  4. Navigate to the Pacing Server installation root/templates folder and select Pacing_Server.xml:
    Aps-node xml.png
  5. Click Save.

Create and configure a node application

You must create and configure every node that you add to the cluster, using the instructions in this section and the following one.

Prerequisite: Import the Pacing Server application template

  1. Open Genesys Administrator Extension and navigate to Environment > Applications.
    Aps-open app.png
  2. In the Tasks panel, click New:
    Aps-new app.png
  3. Specify the name of the Pacing Server application, for example, Pacing_Server_Node_01, then click to select a template for creating the application:
    Aps-create node.png
  4. Select the application template you created previously:
    Aps-select node template.png
  5. Select the General tab and:
    1. Set the value of the Working Directory and Command Line fields to . (a single dot).
    2. Make sure that State is enabled.
    3. Select the Host on which the Pacing Server node will reside.
    4. Click Save.
    Aps-set node values.png.
  6. Navigate to the Connections tab and click Add. Select the Pacing Service cluster application you created previously, then click OK:
    Aps-node connections.png
  7. Navigate to the Ports tab and make sure that the value of the default port is set to the port that this Pacing Server node should listen on. Also, set the protocol type to http or https.
Important
  • Genesys recommends that you always use the HTTPS protocol.
  • Genesys recommends that all instances of Pacing Server listen on the same ports.
  • Pacing Servers are connected in the cluster through a dedicated port on the host where the Pacing Server instance is installed. By default, this port is 7800. If this port is already in use, go to the Ports tab and add another port with ID clustering and the desired value. You don't have to specify a connection type for this port.


Aps-node port.png

8. Navigate to the Tenants tab and click Add. Select the same tenant that is specified for the Pacing Service Cluster application:

Aps-node tenant.png

9. Click Save.

Add a node application to the cluster

Prerequisites:

Although a single-node configuration works well in a lab environment, in order to provide high availability in production, you must use multiple nodes.

Important
  • Every time you establish a new node, you must complete the steps described in Create and Configure a node application.
  • If you use multiple nodes, you must set up load balancing in your environment.


Install Pacing Server

Prerequisite: Create and Configure a node application

Important
For more information on how to install apps that you have configured in Genesys Administrator Extension, consult Generic Installation Procedures.


Windows[ | edit source]

  1. In your installation package, locate and double-click setup.exe. InstallShield opens the welcome screen.
  2. Click Next. The Connection Parameters to the Configuration Server screen appears.
  3. Under Host, specify the host name and port number where Configuration Server is running. (This is the main listening port entered in the Server Info tab for Configuration Server.)
  4. Under User, enter the user name and password for logging into Configuration Server.
  5. Click Next. The Select Application screen appears.
  6. Select the Genesys Generic Server application—that is, the Node app you created above—that you are installing. The Application Properties area shows the Type, Host, Working Directory, Command Line executable, and Command Line Arguments information previously entered in the Server Info and Start Info tabs of the selected Application object.
  7. Click Next. The Choose Destination Location screen appears.
  8. Under Destination Folder, either keep the default value or browse for the desired installation location.
  9. Click Next. The Backup Configuration Server Parameters screen appears.
  10. If you have a backup Configuration Server, enter the Host name and Port.
  11. Click Next. The Ready to Install screen appears.
  12. Click Install. The Genesys Installation Wizard indicates it is performing the requested operation for Pacing Server. When it is finished, the Installation Complete screen appears.
  13. Click Finish to complete your installation of the Pacing Server.

Linux[ | edit source]

  1. Open the Pacing Server IP in a terminal window, and run Install.sh. The Genesys Installation starts.
  2. Enter the hostname of the host on which you are going to install.
  3. Enter the connection information to log into Configuration Server:
    1. The hostname. For instance, demosrv.genesyslab.com.
    2. The listening port. For instance, 2020.
    3. The user name. For instance, demo.
    4. The password.
    5. If the connection settings are successful, a list of keys and Pacing Server applications is displayed.
  4. Enter the key for the Pacing Server application—that is, the Node app you created above—that you are installing.
  5. Enter the location where Pacing Server is to be installed on your host.

Note: This location must match the previous settings that you entered in Configuration Server.

  1. If you have a backup Configuration Server, enter the Host name and Port.
  2. If the installation is successful, the console displays the following message:

Installation of Pacing Server, version 9.0.x has completed successfully.

Important
This installation procedure automatically provisions all of the Pacing Server–related configuration information. For more information, see Provisioning.


Configure alarms

Genesys recommends that you tune the following Pacing Server–related alarms:

  • GC Latency
  • Heap Memory Usage
  • PacingRequestsFailed
  • PacingResponseTargetError
  • PacingResponseValidationError

Although these alarms are created automatically during installation, you can remove them if necessary and then re-create them manually.

To access the alarms in Genesys Administrator Extension, open Environment > Alarm Conditions.

Aps-open alarm.png

The automatic provisioning procedure places the Pacing Server-related alarms in the dedicated PacingService alarm folder.

Configure a forward proxy (optional)

Important
This feature is available in release 9.0.000.10 and higher.


If your environment permits connections to the Internet only through a forward proxy service (such as DMZ or your local intranet), configure the forward-proxy options, so the Pacing Service can connect to Altocloud.