ATC/Current/PacingServiceDeployment/Installation - Revision history

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:34:30Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:44:02Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Bmarshall: Published

2019-06-06T15:12:15Z

Published

DannaShirley: Published

2019-05-07T21:57:06Z

Published

DannaShirley: Published

2018-12-05T14:42:12Z

Published

Bgrenon: 1 revision imported

2018-11-07T15:27:09Z

1 revision imported

DannaShirley at 12:56, November 2, 2018

2018-11-02T12:56:59Z

New page

{{ArticleUnstructured
|DisplayName=Install the Pacing Service
|Platform=PureEngage
|TocName=Installation
|Context=Complete the steps to install the Pacing Server.
|Displaytitle=Install the Pacing Service
}}
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.

==Deploy Pacing Server==
To deploy Pacing Server, follow these steps:
# [[#importcluster|Import the Pacing Service Cluster Application template]]
# [[#createcluster|Create the cluster application]]
# [[#configcluster|Configure the cluster application]]
# [[#importapp|Import the Pacing Server Application template]]
# [[#createnode|Create and configure a node application]]
# [[#addnode|Add the node application to the cluster]]
# [[#installserver|Install Pacing Server]]
# [[#configalarms|Configure alarms]]
# [[#configforwardproxy|Configure a forward proxy (optional)]]

{{AnchorDiv|importcluster}}

==Import the Pacing Service cluster application template==
'''Prerequisite:''' Download the Pacing Server installation on the host where you are going to install it.
# Open Genesys Administrator Extension and navigate to '''Environment > Application Templates''':
#:[[File:aps-all_app_templates.png|800px|]]
# Click '''New'''. In the '''Tasks''' panel, click '''Import Application Template''':
#:[[File:aps-node_app_template.png|800px|]]
# Navigate to the '''Pacing Server installation root/templates''' folder and select '''Pacing_Server_Cluster.apd''':
#:[[File:aps-cluster_apd.png|300px|]]
# Click '''Import Metadata'''.
# Navigate to the '''Pacing Server installation root/templates''' folder and select '''Pacing_Server_Cluster.xml''':
#:[[File:aps-cluster_xml.png|300px|]]
# Click '''Save'''

{{AnchorDiv|createcluster}}
==Create the cluster application==
'''Prerequisite:''' Import the Pacing Service cluster application template
# Open Genesys Administrator Extension and navigate to '''Environment > Applications'''.
# In the '''Tasks''' panel, click '''New''':
#:[[File:aps-new_app.png|800px|]]
# Specify the name of the Pacing Service cluster application (for example, ''Pacing_Service_Cluster_9.0''), then click to select a template:
#:[[File:aps-new_cluster_app_template.png|600px|]]
# Select the application template that you created previously:
#:[[File:aps-select_cluster_app_template.png|600px|]]
# 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'''.
#:[[File:aps-set_cluster_values.png|800px|]]
# The new Cluster application is now available:
#:[[File:aps-new_cluster_app_created.png|800px|]]

{{AnchorDiv|configcluster}}
==Configure the cluster application==
'''Prerequisite:''' [[#createcluster|Create the cluster application]]
# Open Genesys Administrator Extension and navigate to '''Environment > Applications''', then open your cluster application:
#:[[File:aps-open_app.png|600px|]]
# In the '''Connections''' tab, click '''Add''':
#:[[File:aps-cluster_connections.png|800px|]]
# Select the '''Stat Server''' application. Leave the connection port ID set to '''default'''. Click '''OK''':
#:[[File:aps-cluster_stat_server_connection.png|400px|]]
# If appropriate, you can also add a connection to Message Server (to apply the network logging options).
# 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.
#:[[File:aps-cluster_port.png|800px|]]
# In the '''Tenant''' tab, click '''Add''' and select your tenant. For instance, ''Environment''.
#:[[File:aps-cluster_tenant.png|600px|]]
# Navigate to the '''Application Options''' tab. You can keep the default values for all options except the ones in the '''pacingEndpoint''' section. '''Note:''' For the '''pacingEndpoint''' section you must use the values provided by Altocloud for the '''authEndpoint''', '''authClientId''', '''password''', and '''targetEndpoint''' options.
#:[[File:aps-cluster_options.png|800px|]]
# Click '''Save'''.

{{AnchorDiv|importapp}}
==Import the Pacing Server application template==
'''Prerequisite:''' [[#configcluster|Configure the cluster application]]
# Open Genesys Administrator Extension and navigate to '''Environment > Application Templates''':
#:[[File:aps-all_app_templates.png|800px|]]
# Click '''New'''. In the '''Tasks''' panel, click '''Import Application Template''':
#:[[File:aps-node_app_template.png|800px|]]
# Navigate to the '''Pacing Server installation root /templates''' folder and select '''Pacing_Server.apd''':
#:[[File:aps-node_apd.png|300px|]]
# Navigate to the '''Pacing Server installation root/templates''' folder and select '''Pacing_Server.xml''':
#:[[File:aps-node_xml.png|300px|]]
# Click '''Save'''.

{{AnchorDiv|createnode}}
==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:''' [[#importapp|Import the Pacing Server application template]]
# Open Genesys Administrator Extension and navigate to '''Environment > Applications'''.
#:[[File:aps-open_app.png|600px|]]
# In the '''Tasks''' panel, click '''New''':
#:[[File:aps-new_app.png|800px|]]
# Specify the name of the Pacing Server application, for example, ''Pacing_Server_Node_01'', then click to select a template for creating the application:
#:[[File:aps-create_node.png|600px|]]
# Select the application template you created previously:
#:[[File:aps-select_node_template.png|500px|]]
# 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 Server node will reside.
## Click '''Save'''.
#:[[File:aps-set_node_values.png|800px|]].
# Navigate to the '''Connections''' tab and click '''Add'''. Select the Pacing Service cluster application you created previously, then click '''OK''':
#:[[File:aps-node_connections.png|400px|]]
# 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'''.

{{NoteFormat|
* 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.
|1}}

[[File:aps-node_port.png|800px|]]

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

[[File:aps-node_tenant.png|700px|]]

9. Click '''Save'''.

{{AnchorDiv|addnode}}
==Add a node application to the cluster==
'''Prerequisites:'''
* [[#createcluster|Create the cluster application]]
* [[#configcluster|Configure the cluster application]]
* [[#createnode|Create and Configure a node application]]

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

{{NoteFormat|
*Every time you establish a new node, you must complete the steps described in [[#createnode|Create and Configure a node application]].
*If you use multiple nodes, you must set up load balancing in your environment.|1}}

{{AnchorDiv|installserver}}
==Install Pacing Server==
'''Prerequisite:''' [[#createnode|Create and Configure a node application]]

{{NoteFormat|For more information on how to install apps that you have configured in Genesys Administrator Extension, consult [https://docs.genesys.com/Documentation/GA/latest/user/CfgAppPrototype Generic Installation Procedures].|1}}

{{AnchorDiv|windows}}
<tabber>
Windows=
===Windows===

# In your installation package, locate and double-click '''setup.exe'''. InstallShield opens the welcome screen.
# Click '''Next'''. The '''Connection Parameters to the Configuration Server''' screen appears.
# 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.)
# Under '''User''', enter the user name and password for logging into Configuration Server.
# Click '''Next'''. The '''Select Application''' screen appears.
# 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.
# Click '''Next'''. The '''Choose Destination Location''' screen appears.
# Under '''Destination Folder''', either keep the default value or browse for the desired installation location.
# Click '''Next'''. The '''Backup Configuration Server Parameters''' screen appears.
# If you have a backup Configuration Server, enter the '''Host''' name and '''Port'''.
# Click '''Next'''. The '''Ready to Install''' screen appears.
# 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.
# Click '''Finish''' to complete your installation of the Pacing Server.

{{AnchorDiv|linux}}
|-|
Linux=
===Linux===

# Open the Pacing Server IP in a terminal window, and run '''Install.sh'''. The Genesys Installation starts.
# Enter the '''hostname''' of the host on which you are going to install.
# Enter the connection information to log into Configuration Server:
## The '''hostname'''. For instance, ''demosrv.genesyslab.com''.
## The '''listening port'''. For instance, ''2020''.
## The '''user name'''. For instance, ''demo''.
## The '''password'''.
## If the connection settings are successful, a list of keys and Pacing Server applications is displayed.
# Enter the key for the Pacing Server application—that is, the Node app you created above—that you are installing.
# 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.
# If you have a backup Configuration Server, enter the '''Host''' name and '''Port'''.
# If the installation is successful, the console displays the following message:
''Installation of Pacing Server, version 9.0.x has completed successfully.''
</tabber>
{{NoteFormat|This installation procedure automatically provisions all of the Pacing Server–related configuration information. For more information, see {{#mintydocs_link:topic=ProvisioningArticle}}.|1}}

{{AnchorDiv|configalarms}}
==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'''.

[[File:aps-open_alarm.png|600px|]]

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

{{AnchorDiv|configforwardproxy}}
==Configure a forward proxy (optional)==
{{NoteFormat|This feature is available in release 9.0.000.10 and higher.|1}}

If your environment permits connections to the Internet only through a forward proxy service (such as DMZ or your local intranet),
[https://docs.genesys.com/Documentation/Options/latest/ATC/ATC_PSC-forward-proxy configure the forward-proxy options], so the Pacing Service can connect to Altocloud.

@@ Line 1: / Line 1: @@
 {{ArticleUnstructured
 |DisplayName=Install the Pacing Service
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |TocName=Installation
 |Context=Complete the steps to install the Pacing Server.

@@ Line 12: / Line 12: @@
 * 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.
 ==Deploy Pacing Server==

@@ Line 73: / Line 73: @@
 # In the '''Tenant''' tab, click '''Add''' and select your tenant. For instance, ''Environment''.
 #:[[File:aps-cluster_tenant.png|600px|]]
-# Navigate to the '''Application Options''' tab. You can keep the default values for all options except the ones in the '''pacingEndpoint''' section. '''Note:''' For the '''pacingEndpoint''' section you must use  the values provided by {{MINTYDOCSPRODUCT}} for the '''authEndpoint''', '''authClientId''', '''password''', and '''targetEndpoint''' options.
+# Navigate to the '''Application Options''' tab. You can keep the default values for all options except the ones in the '''pacingEndpoint''' section.
-#:[[File:aps-cluster_options.png|800px|]]
+#:[[File:9000200AppOptions.png|800px|]]
 # Click '''Save'''.

← Older revision	Revision as of 15:27, November 7, 2018
(No difference)

ATC/Current/PacingServiceDeployment/Installation - Revision history

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Bmarshall: Published

DannaShirley: Published

DannaShirley: Published

Bgrenon: 1 revision imported

DannaShirley at 12:56, November 2, 2018

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"