(Update with the copy of version: 8.5.2DRAFT) |
(Update with the copy of version: 8.5.2DRAFT) |
||
Line 1: | Line 1: | ||
− | = Installing | + | = Installing = |
__TOC__ | __TOC__ | ||
− | To install | + | To install Web Services, first you need to set up the two application objects it uses in the Genesys configuration environment: |
− | *An application of type <tt>Genesys Generic Server</tt> that is called the | + | *An application of type <tt>Genesys Generic Server</tt> that is called the WS Cluster Application. |
− | *An application of type <tt>Genesys Generic Client</tt> that is called the | + | *An application of type <tt>Genesys Generic Client</tt> that is called the WS Node Application. |
− | ==Configuring the | + | ==Configuring the Web Services applications== |
− | Perform the following procedures to configure the | + | 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> | <tabber> | ||
− | Configuring the | + | Configuring the applications in Configuration Manager= |
<div class="cloud-wrapper"> | <div class="cloud-wrapper"> | ||
<div class="cloud-left" style="padding-top:0;"> | <div class="cloud-left" style="padding-top:0;"> | ||
− | ===Creating | + | ===Creating and importing the application templates=== |
− | The | + | 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/> | '''Start'''<br/> | ||
Line 20: | Line 20: | ||
<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>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: | <li>Configure the '''General''' tab of the template as shown below: | ||
− | * Name: | + | * Name: WS_Node |
* Type: Genesys Generic Client | * Type: Genesys Generic Client | ||
* Version: 8.5 | * Version: 8.5 | ||
Line 33: | Line 33: | ||
'''End''' | '''End''' | ||
− | ===Creating the | + | ===Creating the WS Cluster Application=== |
'''Start''' | '''Start''' | ||
Line 41: | Line 41: | ||
<li>Select the '''Workspace_Web_Edition_Web_Services_852''' template and click '''OK'''.</li> | <li>Select the '''Workspace_Web_Edition_Web_Services_852''' template and click '''OK'''.</li> | ||
<li>Configure the '''General''' tab as shown below: | <li>Configure the '''General''' tab as shown below: | ||
− | * Name: | + | * Name: WS_Cluster |
* Template: Workspace_Web_Edition_Web_Services_852 | * Template: Workspace_Web_Edition_Web_Services_852 | ||
* Component Type: [Unknown] | * Component Type: [Unknown] | ||
Line 51: | Line 51: | ||
</li> | </li> | ||
<li>On the '''Server Info''' tab, choose a <tt>Host</tt> object. 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 '''Server Info''' tab, choose a <tt>Host</tt> object. 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. | + | <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: | <li>On the '''Connections''' tab, add the following connections: | ||
<ul> | <ul> | ||
Line 59: | Line 59: | ||
<li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li> | <li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li> | ||
<li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]]) | <li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]]) | ||
− | {{NoteFormat|KPIs and Statistics are reported only for the voice channel. | + | {{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> | </li> | ||
<li>[[Documentation/GMS|Genesys Mobile Services]] (if supporting [[MobilePushNotifications|mobile push notifications]]) | <li>[[Documentation/GMS|Genesys Mobile Services]] (if supporting [[MobilePushNotifications|mobile push notifications]]) | ||
Line 66: | Line 66: | ||
</ul> | </ul> | ||
</li> | </li> | ||
− | <li>Click '''OK''' to save the <tt> | + | <li>Click '''OK''' to save the <tt>WS_Cluster</tt> application.</li> |
</ol> | </ol> | ||
'''End''' | '''End''' | ||
− | ===Creating the | + | ===Creating the WS Node Application=== |
− | |||
'''Start''' | '''Start''' | ||
<br/> | <br/> | ||
<ol> | <ol> | ||
<li>Navigate to the '''Applications''' folder. Right-click and select '''New > Application<'''.</li> | <li>Navigate to the '''Applications''' folder. Right-click and select '''New > Application<'''.</li> | ||
− | <li>Select the <tt> | + | <li>Select the <tt>WS_Node</tt> template and click '''OK'''.</li> |
<li>Configure the '''General''' tab as shown below: | <li>Configure the '''General''' tab as shown below: | ||
− | * Name: | + | * Name: WS_Node |
− | * Template: | + | * Template: WS_Node |
* State Enabled: Yes | * State Enabled: Yes | ||
</li> | </li> | ||
Line 86: | Line 85: | ||
</li> | </li> | ||
− | <li>Click '''OK''' to save the <tt> | + | <li>Click '''OK''' to save the <tt>WS_Node</tt> application.</li> |
</ol> | </ol> | ||
</div> | </div> | ||
Line 100: | Line 99: | ||
|-| | |-| | ||
− | Configuring the | + | Configuring the applications in Genesys Administrator= |
<div class="cloud-wrapper"> | <div class="cloud-wrapper"> | ||
<div class="cloud-left" style="padding-top:0;"> | <div class="cloud-left" style="padding-top:0;"> | ||
− | ===Creating | + | ===Creating and importing the application templates=== |
− | The | + | 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/> | '''Start'''<br/> | ||
Line 111: | Line 110: | ||
<li>To create the <tt>Genesys Generic Server</tt> template, navigate to '''PROVISIONING > Environment> Application Templates'''.</li> | <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: | <li>Select '''New...''' and configure the properties of the template as shown below: | ||
− | * Name: | + | * Name: WS_Node |
* Type: Genesys Generic Client | * Type: Genesys Generic Client | ||
* Version: 8.5 | * Version: 8.5 | ||
Line 124: | Line 123: | ||
'''End''' | '''End''' | ||
− | ===Creating the | + | ===Creating the WS Cluster Application=== |
− | |||
'''Start''' | '''Start''' | ||
<br/> | <br/> | ||
Line 131: | Line 129: | ||
<li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li> | <li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li> | ||
<li>In the '''General''' section, configure the properties of the application as shown below: | <li>In the '''General''' section, configure the properties of the application as shown below: | ||
− | * Name: | + | * Name: WS_Cluster |
* Template: Workspace_Web_Edition_Web_Services_852 | * Template: Workspace_Web_Edition_Web_Services_852 | ||
* State: Enabled | * State: Enabled | ||
Line 142: | Line 140: | ||
<li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li> | <li>[[Documentation/ES|Universal Contact Server]] (if supporting multimedia)</li> | ||
<li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]]) | <li>[[Documentation/RTME|Stat Server]] (if supporting [[ReportingConfiguration|reporting]]) | ||
− | {{NoteFormat|KPIs and Statistics are reported only for the voice channel. | + | {{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> | </li> | ||
<li>[[Documentation/GMS|Genesys Mobile Services]] (if supporting [[MobilePushNotifications|mobile push notifications]]) | <li>[[Documentation/GMS|Genesys Mobile Services]] (if supporting [[MobilePushNotifications|mobile push notifications]]) | ||
Line 159: | Line 157: | ||
#Click '''OK'''. | #Click '''OK'''. | ||
</li> | </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. | + | <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> | </ol> | ||
'''End''' | '''End''' | ||
− | ===Creating the | + | ===Creating the WS Node Application=== |
'''Start''' | '''Start''' | ||
Line 170: | Line 168: | ||
<li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li> | <li>Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.</li> | ||
<li>In the '''General''' section, configure the properties of the application as shown below: | <li>In the '''General''' section, configure the properties of the application as shown below: | ||
− | * Name: | + | * Name: WS_Node |
− | * Template: | + | * Template: WS_Node |
* State: Enabled | * State: Enabled | ||
</li> | </li> | ||
Line 186: | Line 184: | ||
'''End''' | '''End''' | ||
− | ==Next | + | ==Next step== |
*[[InitializingCassandra|Initializing Cassandra]] | *[[InitializingCassandra|Initializing Cassandra]] | ||
[[Category:V:HTCC:8.5.2]] | [[Category:V:HTCC:8.5.2]] |
Revision as of 19:57, January 22, 2016
Installing
To install Web Services, first you need to set up the two application objects it uses in the Genesys configuration environment:
- An application of type Genesys Generic Server that is called the WS Cluster Application.
- An application of type Genesys Generic Client that is called the WS Node Application.
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
- To create the Genesys Generic Client template, navigate to the Application Templates folder. Right-click and select New > Application Template.
- Configure the General tab of the template as shown below:
- Name: WS_Node
- Type: Genesys Generic Client
- Version: 8.5
- State Enabled: Yes
- Click OK.
- To import the Genesys Generic Server template, navigate to the Application Templates folder in Configuration Manager. Right-click and select Import Application Template.
- Navigate to the templates folder in your installation package.
- Select the Workspace_Web_Edition_Web_Services_852 template file.
- Click OK.
End
Creating the WS Cluster Application
Start
- Navigate to the Applications folder. Right-click and select New > Application.
- Select the Workspace_Web_Edition_Web_Services_852 template and click OK.
- Configure the General tab as shown below:
- Name: WS_Cluster
- Template: Workspace_Web_Edition_Web_Services_852
- Component Type: [Unknown]
- State Enabled: Yes
- On the Tenants tab, click Add.
- Choose the Environment tenant (or any other tenant that has a connection to your Configuration Server).
- Click OK.
- On the Server Info tab, choose a Host object. This automatically adds a corresponding port entry. The port value is ignored by the server and does not need to be modified.
- 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.
- 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)
ImportantKPIs 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.
- Genesys Mobile Services (if supporting mobile push notifications)
ImportantFor single node or lab deployments, the connection can be a Genesys Mobile Services (GMS) node. For production environments, the connection should be a GMS cluster application.
- Click OK to save the WS_Cluster application.
End
Creating the WS Node Application
Start
- Navigate to the Applications folder. Right-click and select New > Application<.
- Select the WS_Node template and click OK.
- Configure the General tab as shown below:
- Name: WS_Node
- Template: WS_Node
- State Enabled: Yes
- On the Connections tab, add the following connections:
- Cluster application that was configured in the previous procedure.
- Click OK to save the WS_Node application.
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
- To create the Genesys Generic Server template, navigate to PROVISIONING > Environment> Application Templates.
- Select New... and configure the properties of the template as shown below:
- Name: WS_Node
- Type: Genesys Generic Client
- Version: 8.5
- State: Enabled
- Click Save & Close.
- 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.
- Click Add and navigate to the templates folder in your installation package.
- Select the Workspace_Web_Edition_Web_Services_852 template file and click Open.
- Click Save & Close.
End
Creating the WS Cluster Application
Start
- Navigate to PROVISIONING > Environment > Application and click New....
- In the General section, configure the properties of the application as shown below:
- Name: WS_Cluster
- Template: Workspace_Web_Edition_Web_Services_852
- State: Enabled
- 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)
ImportantKPIs 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.
- Genesys Mobile Services (if supporting mobile push notifications)
ImportantFor single node or lab deployments, the connection can be a Genesys Mobile Services (GMS) node. For production environments, the connection should be a GMS cluster application.
- In the Server Info section, select a Tenant:
- Click Add.
- Choose the Environment tenant (or any other tenant that has a connection to your Configuration Server).
- Click OK.
- Choose a Host object.
- Add a default Listening Port:
- Click Add.
- Enter the application's Port. For instance 7000.
- Click OK.
- 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
- Navigate to PROVISIONING > Environment > Application and click New....
- In the General section, configure the properties of the application as shown below:
- Name: WS_Node
- Template: WS_Node
- State: Enabled
- Add the following connections:
- Cluster application that was configured in the previous procedure.
- Click Save & Close.
End