Jump to: navigation, search
(Created page with "= Configuring Web Services and Applications = Category:V:HTCC:9.0.0DRAFT")
 
Line 1: Line 1:
 
= Configuring Web Services and Applications =
 
= Configuring Web Services and Applications =
 +
 +
==Configuring the Web Services applications==
 +
Perform the following procedures to configure the Web Services applications. Select a tab to configure the applications in ''either'' Configuration Manager or Genesys Administrator.
 +
 +
<tabber>
 +
Configuration Manager=
 +
===Creating and importing the application templates===
 +
The Web Services installation package includes a template for <tt>Genesys Generic Server</tt> (the WS Cluster Application), but you must create a new template for <tt>Genesys Generic Client</tt> (the WS Node Application).
 +
 +
'''Start'''<br/>
 +
 +
<ol>
 +
<li>To create the <tt>Genesys Generic Client</tt> template, navigate to the '''Application Templates''' folder. Right-click and select '''New > Application Template'''.</li>
 +
<li>Configure the '''General''' tab of the template as shown below:
 +
* Name: WS_Node
 +
* Type: Genesys Generic Client
 +
* Version: 8.5
 +
* State Enabled: Yes
 +
</li>
 +
<li>Click '''OK'''.</li>
 +
<li>To import the <tt>Genesys Generic Server</tt> template, navigate to the '''Application Templates''' folder in Configuration Manager. Right-click and select '''Import Application Template'''.</li>
 +
<li>Navigate to the '''templates''' folder in your installation package.</li>
 +
<li>Select the '''Web_Services_and_Applications_852''' template file.</li>
 +
<li>Click '''OK'''.</li>
 +
</ol>
 +
'''End'''
 +
 +
===Creating the WS Cluster Application===
 +
 +
'''Start'''
 +
<br/>
 +
<ol>
 +
<li>Navigate to the '''Applications''' folder. Right-click and select '''New > Application'''.</li>
 +
<li>Select the '''Web_Services_and_Applications_852''' template and click '''OK'''.</li>
 +
<li>Configure the '''General''' tab as shown below:
 +
* Name: WS_Cluster
 +
* Template: Workspace_Web_Edition_Web_Services_852
 +
* Component Type: [Unknown]
 +
* State Enabled: Yes
 +
</li>
 +
<li>On the '''Tenants''' tab, click '''Add'''.
 +
# Choose the <tt>Environment</tt> tenant (or any other tenant that has a connection to your Configuration Server).
 +
# Click '''OK'''.
 +
</li>
 +
<li>On the '''Server Info''' tab, choose a <tt>Host</tt> object. See [[Documentation:FR:Dep:DepHosts|Create Host]] in the ''Management Framework Deployment Guide'' for more information about Host objects. This automatically adds a corresponding port entry. The port value is ignored by the server and does not need to be modified.</li>
 +
<li>On the '''Start Info''' tab, add a "." to the <tt>Working Directory</tt>, <tt>Command Line</tt>, and <tt>Command Line Arguments</tt> fields. These values are mandatory for all applications and must be entered to save the application object. Web Services does not use these values, so the "." is used as a placeholder.</li>
 +
<li>On the '''Connections''' tab, add the following connections:
 +
<ul>
 +
<li>Configuration Server</li>
 +
<li>[[Documentation/TS|T-Server]]/[[Documentation/SIPS|SIP Server]] (if supporting voice)</li>
 +
<li>[[Documentation/ES|Interaction Server]] (if supporting multimedia)</li>
 +
<li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li>
 +
<li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]])
 +
{{NoteFormat|KPIs and Statistics are reported only for the voice channel. Web Services does not support real-time statistics for mixed media (voice/multimedia) environments. If a mixed media environment is used, voice statistics are not accurate.}}
 +
</li>
 +
</ul>
 +
</li>
 +
<li>Click '''OK''' to save the <tt>WS_Cluster</tt> application.</li>
 +
</ol>
 +
'''End'''
 +
 +
===Creating the WS Node Application===
 +
'''Start'''
 +
<br/>
 +
<ol>
 +
<li>Navigate to the '''Applications''' folder. Right-click and select '''New > Application<'''.</li>
 +
<li>Select the <tt>WS_Node</tt> template and click '''OK'''.</li>
 +
<li>Configure the '''General''' tab as shown below:
 +
* Name: WS_Node
 +
* Template: WS_Node
 +
* State Enabled: Yes
 +
</li>
 +
<li>On the '''Connections''' tab, add the following connections:
 +
* Cluster application that was configured in the previous procedure.
 +
</li>
 +
 +
<li>Click '''OK''' to save the <tt>WS_Node</tt> application.</li>
 +
</ol>
 +
'''End'''
 +
 +
|-|
 +
Genesys Administrator=
 +
===Creating and importing the application templates===
 +
The Web Services installation package includes a template for <tt>Genesys Generic Server</tt> (the WS Cluster Application), but you must create a new template for <tt>Genesys Generic Client</tt> (the WS Node Application).
 +
 +
'''Start'''<br/>
 +
 +
<ol>
 +
<li>To create the <tt>Genesys Generic Server</tt> template, navigate to '''PROVISIONING > Environment> Application Templates'''.</li>
 +
<li>Select '''New...''' and configure the properties of the template as shown below:
 +
* Name: WS_Node
 +
* Type: Genesys Generic Client
 +
* Version: 8.5
 +
* State: Enabled
 +
</li>
 +
<li>Click '''Save & Close'''.</li>
 +
<li>To import the <tt>Genesys Generic Server</tt> template, click '''Upload Template''' in the '''Tasks''' panel. The '''Click 'Add' and choose application template (APD) file to import''' dialog opens.</li>
 +
<li>Click '''Add''' and navigate to the '''templates''' folder in your installation package.</li>
 +
<li>Select the '''Web_Services_and_Applications_852''' template file and click '''Open'''.</li>
 +
<li>Click '''Save & Close'''.</li>
 +
</ol>
 +
'''End'''
 +
 +
===Creating the WS Cluster Application===
 +
'''Start'''
 +
<br/>
 +
<ol>
 +
<li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li>
 +
<li>In the '''General''' section, configure the properties of the application as shown below:
 +
* Name: WS_Cluster
 +
* Template: Web_Services_and_Applications_852
 +
* State: Enabled
 +
</li>
 +
<li>Add the following connections:
 +
<ul>
 +
<li>Configuration Server</li>
 +
<li>[[Documentation/TS|T-Server]]/[[Documentation/SIPS|SIP Server]] (if supporting voice)</li>
 +
<li>[[Documentation/ES|Interaction Server]] (if supporting multimedia)</li>
 +
<li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li>
 +
<li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]])
 +
{{NoteFormat|KPIs and Statistics are reported only for the voice channel. Web Services does not support real-time statistics for mixed media (voice/multimedia) environments. If a mixed media environment is used, voice statistics are not accurate.}}
 +
</li>
 +
</ul>
 +
</li>
 +
<li>In the '''Server Info''' section, select a <tt>Tenant</tt>:
 +
# Click '''Add'''.
 +
# Choose the <tt>Environment</tt> tenant (or any other tenant that has a connection to your Configuration Server).
 +
# Click '''OK'''.
 +
</li>
 +
<li>Choose a <tt>Host</tt> object. See [[Documentation:FR:Dep:DepHosts|Create Host]] in the ''Management Framework Deployment Guide'' for more information about Host objects.</li>
 +
<li>Add a default Listening Port:
 +
#Click '''Add'''.
 +
#Enter the application's Port. For instance <tt>7000</tt>.
 +
#Click '''OK'''.
 +
</li>
 +
<li>Add a "." to the <tt>Working Directory</tt>, <tt>Command Line</tt>, and <tt>Command Line Arguments</tt> fields. These values are mandatory for all applications and must be entered to save the application object. Web Services does not use these values, so the "." is used as a placeholder.</li>
 +
</ol>
 +
'''End'''
 +
 +
===Creating the WS Node Application===
 +
 +
'''Start'''
 +
<br/>
 +
<ol>
 +
<li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li>
 +
<li>In the '''General''' section, configure the properties of the application as shown below:
 +
* Name: WS_Node
 +
* Template: WS_Node
 +
* State: Enabled
 +
</li>
 +
<li>Add the following connections:
 +
* Cluster application that was configured in the previous procedure.
 +
</li>
 +
<li>Click '''Save & Close'''.</li>
 +
</ol>
 +
'''End'''
 +
</tabber>
  
 
[[Category:V:HTCC:9.0.0DRAFT]]
 
[[Category:V:HTCC:9.0.0DRAFT]]

Revision as of 14:28, January 28, 2020

Configuring Web Services and Applications

Configuring the Web Services applications

Perform the following procedures to configure the Web Services applications. Select a tab to configure the applications in either Configuration Manager or Genesys Administrator.

Creating and importing the application templates

The Web Services installation package includes a template for Genesys Generic Server (the WS Cluster Application), but you must create a new template for Genesys Generic Client (the WS Node Application).

Start

  1. To create the Genesys Generic Client template, navigate to the Application Templates folder. Right-click and select New > Application Template.
  2. Configure the General tab of the template as shown below:
    • Name: WS_Node
    • Type: Genesys Generic Client
    • Version: 8.5
    • State Enabled: Yes
  3. Click OK.
  4. To import the Genesys Generic Server template, navigate to the Application Templates folder in Configuration Manager. Right-click and select Import Application Template.
  5. Navigate to the templates folder in your installation package.
  6. Select the Web_Services_and_Applications_852 template file.
  7. Click OK.

End

Creating the WS Cluster Application

Start

  1. Navigate to the Applications folder. Right-click and select New > Application.
  2. Select the Web_Services_and_Applications_852 template and click OK.
  3. Configure the General tab as shown below:
    • Name: WS_Cluster
    • Template: Workspace_Web_Edition_Web_Services_852
    • Component Type: [Unknown]
    • State Enabled: Yes
  4. On the Tenants tab, click Add.
    1. Choose the Environment tenant (or any other tenant that has a connection to your Configuration Server).
    2. Click OK.
  5. On the Server Info tab, choose a Host object. See Create Host in the Management Framework Deployment Guide for more information about Host objects. This automatically adds a corresponding port entry. The port value is ignored by the server and does not need to be modified.
  6. On the Start Info tab, add a "." to the Working Directory, Command Line, and Command Line Arguments fields. These values are mandatory for all applications and must be entered to save the application object. Web Services does not use these values, so the "." is used as a placeholder.
  7. On the Connections tab, add the following connections:
    • Configuration Server
    • T-Server/SIP Server (if supporting voice)
    • Interaction Server (if supporting multimedia)
    • Universal Contact Server (if supporting multimedia)
    • Stat Server (if supporting reporting)
      Important
      KPIs and Statistics are reported only for the voice channel. Web Services does not support real-time statistics for mixed media (voice/multimedia) environments. If a mixed media environment is used, voice statistics are not accurate.
  8. Click OK to save the WS_Cluster application.

End

Creating the WS Node Application

Start

  1. Navigate to the Applications folder. Right-click and select New > Application<.
  2. Select the WS_Node template and click OK.
  3. Configure the General tab as shown below:
    • Name: WS_Node
    • Template: WS_Node
    • State Enabled: Yes
  4. On the Connections tab, add the following connections:
    • Cluster application that was configured in the previous procedure.
  5. Click OK to save the WS_Node application.

End

Creating and importing the application templates

The Web Services installation package includes a template for Genesys Generic Server (the WS Cluster Application), but you must create a new template for Genesys Generic Client (the WS Node Application).

Start

  1. To create the Genesys Generic Server template, navigate to PROVISIONING > Environment> Application Templates.
  2. Select New... and configure the properties of the template as shown below:
    • Name: WS_Node
    • Type: Genesys Generic Client
    • Version: 8.5
    • State: Enabled
  3. Click Save & Close.
  4. To import the Genesys Generic Server template, click Upload Template in the Tasks panel. The Click 'Add' and choose application template (APD) file to import dialog opens.
  5. Click Add and navigate to the templates folder in your installation package.
  6. Select the Web_Services_and_Applications_852 template file and click Open.
  7. Click Save & Close.

End

Creating the WS Cluster Application

Start

  1. Navigate to PROVISIONING > Environment > Application and click New....
  2. In the General section, configure the properties of the application as shown below:
    • Name: WS_Cluster
    • Template: Web_Services_and_Applications_852
    • State: Enabled
  3. Add the following connections:
    • Configuration Server
    • T-Server/SIP Server (if supporting voice)
    • Interaction Server (if supporting multimedia)
    • Universal Contact Server (if supporting multimedia)
    • Stat Server (if supporting reporting)
      Important
      KPIs and Statistics are reported only for the voice channel. Web Services does not support real-time statistics for mixed media (voice/multimedia) environments. If a mixed media environment is used, voice statistics are not accurate.
  4. In the Server Info section, select a Tenant:
    1. Click Add.
    2. Choose the Environment tenant (or any other tenant that has a connection to your Configuration Server).
    3. Click OK.
  5. Choose a Host object. See Create Host in the Management Framework Deployment Guide for more information about Host objects.
  6. Add a default Listening Port:
    1. Click Add.
    2. Enter the application's Port. For instance 7000.
    3. Click OK.
  7. Add a "." to the Working Directory, Command Line, and Command Line Arguments fields. These values are mandatory for all applications and must be entered to save the application object. Web Services does not use these values, so the "." is used as a placeholder.

End

Creating the WS Node Application

Start

  1. Navigate to PROVISIONING > Environment > Application and click New....
  2. In the General section, configure the properties of the application as shown below:
    • Name: WS_Node
    • Template: WS_Node
    • State: Enabled
  3. Add the following connections:
    • Cluster application that was configured in the previous procedure.
  4. Click Save & Close.

End

Comments or questions about this documentation? Contact us for support!