Configuring the GVP Components
Perform these advanced configuration procedures after GVP installation and basic configuration.
Integrating Application Objects
After the Media Control Platform and Call Control Platform Application objects are created and the components are installed, they are integrated with the Resource Manager which acts as a proxy server. SIP devices and VoiceXML or CCXML applications can then make use of media-centric services through the proxy, without having to know the actual location of these resources.
This procedure is optional and required only if you want the Resource Manager to act as a proxy server for outbound requests. To integrate these Application objects with the Resource Manager, you configure the Session Initiation Protocol (SIP) settings.
This procedure describes how to integrate Application objects with the Resource Manager by configuring SIP and secure SIP options.
Procedure: Integrating Application Objects with Resource Manager
[+] Purpose
To integrate an Application object with Resource Manager by configuring the Application parameters.
[+] Prerequisites
- All of the GVP components must be installed. See [[[Procedure: Using the Deployment Wizard to Install GVP, on page 221]]].
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Click the Application object that you want to configure for example, the Media Control Platform or Call Control Platform Application.
The Configuration tab appears.
- Click the Options tab, and use the View drop-down list to select Show options in groups...
- In the sip section, find the routeset option.
- In the Value field, type the following:
- sip:<IP_RM>:<SIPPort_RM>;lr to integrate the Media Control Platform with Resource Manager.
- sip:<IP_RM>:<SIPPort_RM>:lr to integrate the Call Control Platform with Resource Manager.
...where IP_RM is the IP address of the Resource Manager, and SIPPort_RM is the SIP port of the Resource Manager typically, 5060.
Tip
You must include the angle brackets in the Value field in the
sip.routeset and
sip.securerouteset parameters.
- In the Value field of the securerouteset option, type the following:
- sip:<IP_RM>:<SIPSecurePort_RM>;lr to integrate the Media Control Platform with Resources Manager.
- sip:<IP_RM>:<SIPSecurePort_RM> to integrate the Call Control Platform with Resource Manager.
In this case, IP_RM is the IP address of the Resource Manager, and SIPSecurePort_RM is the SIP secure port of the Resource Manager typically, 5061.
Tip
Although the GVP components support secure SIP capabilities, the external SIP Server does not.
- To use the Call Recording Solution through third-party recording servers: In the vrmrecorder section, configure the following options (pointing to the Resource Manager s IP address and SIP port, as shown in Steps 6 and 7):
- sip.routeset
- sip.securerouteset
- Save the configuration.
[+] Next
- Create the connections to the Message Server. See [[[Creating a Connection to a Server.]]]
Creating a Connection to a Server
Use the procedure in this section to create connections to:
- The Message Server—Create a connection in the Media Control Platform, Call Control Platform, Resource Manager, Supplementary Services Gateway, CTI Connector, PSTN Connector, MRCP Proxy, Reporting Server and Policy Server Applications to ensure that component log information reaches the Log database and can be viewed in the Solution Control Interface (SCI).
- The Reporting Server—Create a connection in the Media Control Platform, Call Control Platform, Resource Manager, PSTN Connector, CTI Connector, Supplementary Services Gateway, and MRCP Proxy Applications to ensure that these components detect the Reporting Server to which they are sending reporting data. Genesys Administrator also requires a connection to Reporting Server to monitor GVP components.
- SIP Server—Create a connection in the Resource Manager, Supplementary Services Gateway, and PSTN Connector Applications to manage the initiation of outbound calls.
- MRCP Proxy—Create a connection in the Media Control Platform Application if you are planning to use the proxy to manage MRCPv1 RTSP traffic within the GVP deployment.
- MRCP Server—Create a connection in the MRCP Proxy Application if you are planning to use the proxy to manage MRCPv1 RTSP traffic within the GVP deployment (in the Media Control Platform Application if you are not deploying the MRCP Proxy).
- Cisco T-server—Create a connection in the UCM Connector Application to ensure the tenant DBID of the Cisco T-Server is included in Request URI in any SIP INVITE messages sent to the UCM Connector.
- The SNMP Master Agent—Create a connection in the Media Control Platform, Call Control Platform, Resource Manager, Supplementary Services Gateway, CTI Connector, PSTN Connector, MRCP Proxy, and Reporting Server Applications if you want to capture alarm and trap information.
Procedure: Creating a Connection to a Server
[+] Purpose
To create a connection in an Application object to a server or component.
[+] Prerequisites
- All of the GVP components are installed. See [[[Procedure: Using the Deployment Wizard to Install GVP, on page 221.]]]
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Click the Application object for which you are creating the connection; for example, the Media Control Platform Application object.
The Configuration tab appears.
- In the General section, in the Connections field, click Add.
The Connection Info dialog box appears. See Figure 13.
Figure 13: Application Object Connection Info
- In the Server field, click the down arrow to open the Browse Application dialog box.
- Select the server or component to which you want to create a connection for example, Message Server, SIP Server, or SNMP Master Agent.
The required fields in the Connection Info section are populated automatically. (Ensure the Connection Protocols field is left blank. It is not required for GVP components.)
- Click OK.
The server or component you selected in Step 6 appears under Connections.
- Save the configuration.
[+] Next
- Complete the remaining post-installation activities for the Media Control Platform. See [[[Provisioning the Speech Resources.]]]
Provisioning the Speech Resources
The Media Resource Control Protocol (MRCP) speech resources are controlled by the Call Manager Application Program Interface (CMAPI), which opens and closes sessions, and provides the speech recognition and speech synthesis commands that the MRCP Server uses to carry out speech requests.
If the MRCP Proxy is deployed, the configurations in this procedure vary slightly. Therefore, the configurations are described with and without the MRCP Proxy. If you have installed the MRCP Proxy, see also Provisioning the MRCP Proxy on page 250.
Tip
The procedures in this section are required only if you are using Automatic Speech Recognition (ASR) and Text-to-Speech (TTS) speech resources, and have an MRCP Server or MRCP Proxy in your deployment.
This section contains two procedures that create the Speech Resource Applications and assign the MRCP Server or MRCP Proxy to the Media Control Platform.
Procedure: Provisioning Speech Resource Application Objects
[+] Purpose
To create the MRCP Speech Resource Applications for ASR and TTS.
[+] Summary
After a Speech Resource Application is created with the basic configuration, it must be provisioned with the IP address and port number of the MRCP Server or the MRCP Proxy (if required).
[+] Prerequisites
- The ASR and TTS servers are installed and operational.
- The MRCP Speech Resource object templates are imported. See Procedure: Importing Application Object Templates Manually, on page 313
- The MRCP Speech Resource objects are created. See Procedure: Creating Application Objects Manually, on page 318.
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Select the Speech Resource Application you want to configure.
The Configuration tab appears.
- Click the Options tab, and scroll to the provision section.
- Enter the value for each Option as described in Table 21:
Table 21: MRCP Application Properties Options Tab
| Option name
|
Option value
|
| For MRCPv1
|
|
| vrm.client.resource.name
|
Enter the identifier used to link the VoiceXML application to a common set of speech resources; for example,
- For ASR, enter IBM, NUANCE, or TELISMA.
- For TTS, enter REALSPEAK, VOCALIZER, OSR, or IBM.
Notes:
- A common set of speech resources means that the provisioning data for each speech resource with the same name is identical. A resource with the same name but different provisioning data should not be added to the common set of resources.
- GVP supports dynamically removing and adding ASR/TTS servers (resources), but does not support dynamically changing a resource's provisioning data. To change a resource's provisioning data, follow these steps:
1. Remove (delete) the resource.
2. Modify the resource s provisioning data.
3. Add back (reconnect) the resource.
Important: If the provisioning data of the modified resource is different from an existing common set of resources with the same name, then you must use a different name for this resource.
|
| vrm.client.resource.uri
|
The URI must contain the IP address and port number of the MRCP Server or the MRCP Proxy by using the following format:
rtsp://servername:<port>/<path>
For the recommended resource Universal Resource Identifier (URI), check the MRCP vendor documentation.
Tip The MRCP Proxy supports MRCPv1 speech resources only.
|
| vrm.proxy.ping_interval
|
Enter a value (or retain the default) to specify the ping interval in milliseconds (used only when the MRCP Proxy is deployed).
Default value: 30000
|
| For MRCPv2
|
|
| vrm.client.resource.name
|
Enter the identifier used to link the VoiceXML application to a common set of speech resources for example,
For ASR, enter NUANCE.
For TTS, enter REALSPEAK or VOCALIZER.
|
| vrm.client.resource.uri
|
The URI must contain the IP address and port number of the MRCP server using one of two formats:
sip:mresources@<MRCP server IP>:<port>;transport=TLS
sips:mresources@<MRCP server IP>:<port>
(The default SIPS port number for Nuance Speech Servers is 5061.)
For the recommended resource URI, check the MRCP vendor documentation.
|
| vrm.client.TransportProtocol
|
Enter one of two values:
MRCPv2 without Security
MRCPv2 with secure TLS
|
- Save the configuration.
Tip
Complete Steps 7 to 10 if you are deploying MRCPv2 with Secure RTP (SRTP) only.
Configure the Media Control Platform Application
- Select the Media Control Platform Application that is associated with this speech resource.
The Configuration tab appears.
- Click the Options tab, and scroll to the mpc section.
- Configure the following parameters with the values that are shown here:
- asr.srtp.mode=offer
- asr.srtp.sessionparams=none
- tts.srtp.mode=offer
- asr.srtp.sessionparams=none
- Save the configuration.
Configure the ASR Server
- Configure the following options on the ASR Server:
- If the ASR Server supports session timeout, configure 600000 (milliseconds, or 10 minutes) for the timeout value to prevent interruption of any active recognition sessions.
- For Nuance SpeechWorks MediaServer and OpenSpeech Recognizer, configure the server.transport.sessionTimeout VXIInteger option with a value of 600000 (10 minutes).
- For Nuance Speech Server and Nuance Recognizer, configure the server.mrcp2.sip.sessionTimeout and server.mrcp1.rtsp.sessionTimeout options with a value of 600000 (10 minutes).
For other ASR vendors, check the vendor documentation.
- To make the ASR service work correctly with GVP, you must edit the Nuance Recognizer file baseline.xml. and comment out the third and fourth lines in the code sample below:
<param name="swirec_extra_nbest_keys">
<value>SWI_meaning</value>
<style="color: red;"><!--</style> <value>SWI_literal</value> <style="color: red;">--></style>
<style="color: red;"><!--</style> <value>SWI_grammarName</value> <style="color: red;">--></style>
</param>
The characters to add to the code are marked in red.
[+] Next
- Assign the MRCP Server to the Media Control Platform Application object. See Procedure: Assigning the MRCP Server to the Media Control Platform.
Procedure: Assigning the MRCP Server to the Media Control Platform
[+] Purpose
To assign the MRCP Server to the Media Control Platform Application object.
[+] Summary
[+] Prerequisites
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Double-click the Media Control Platform Application object that you want to configure.
The Configuration tab appears.
- In the General section, in the Connections field, click Add.
The Connection Info dialog box appears.
- Enter the information in the required fields, as shown in Table 22:
Table 22: Connection Info Dialog Box
| Field
|
Description
|
| Server
|
Browse to select the MRCP Server.
|
| ID
|
This field is populated automatically with the value default.
|
| Trace Mode
|
This field is populated automatically with the value Trace is Turned Off.
|
| Application Parameters
|
Enter provisiontype=primary for a primary MRCP server.
Enter provisiontype=backup for a backup MRCP server.
|
- Click OK.
- Save the configuration.
Tip
There is no limit to the number of primary or backup MRCP servers that you can assign to the Media Control Platform; however, do not assign the same server as both primary and backup.
[+] Next
Provisioning the MRCP Proxy
The MRCP Proxy is an optional component, but must be deployed if ASR and TTS usage reporting is required. You can deploy the MRCP Proxy in stand-alone or warm active standby HA mode. The procedures in this section describe the steps for each configuration.
Tip
By design, the MRCP Proxy supports only the NUANCE speech resource.
Procedure: Configuring the MRCP Proxy
[+] Purpose
To configure the MRCP Proxy to act as a proxy for all MRCPv1 traffic in the environment.
[+] Prerequisites
- The MRCP Speech Resource objects are provisioned. See Procedure: Provisioning Speech Resource Application Objects, on page 245.
- The server connections are created. See Procedure: Creating a Connection to a Server, on page 243.
- The connections to the ASR and TTS resource access points are created. See Procedure: Provisioning Speech Resource Application Objects, on page 245.
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Double-click the MRCP Proxy Application that you want to configure.
The Configuration tab appears.
- Click the Options tab, in the vrmproxy section, configure the host part of the uri configuration option with the actual IP address of the MRCP Proxy.
Important
If the Media Control Platform is installed on the same host as the MRCP Proxy, retain the default value for the uri configuration option.
- Create a connection to the MRCP Server. See the Prerequisites section of this procedure.
- Save the configuration.
Procedure: Configuring the MRCP Proxy for HA
[+] Summary
A configured MRCP Proxy acts as a warm standby in case of failover which means that, like a hot standby, the standby instance becomes active if the active instance fails. However, unlike a hot standby, a warm standby does not handle existing sessions. Application requests are rejected mid-stream during a failover; and applications must be designed to accommodate such a failure.
The failover sequence of events is as follows:
- The primary MRCP Proxy terminates.
- The LCA in the primary MRCPP machine informs SCS about this event.
- SCS checks to see if the terminated MRCPP has a backup instance configured.
- If there is a backup instance configured, SCS instructs through LCA in the backup computer the other MRCPP to become primary.
In a standard configuration, the MRCP Proxies are configured as backup to each other, and SCS has an HA license to perform a switch-over.
[+] Purpose
To configure the MRCP Proxy in HA mode to act as a proxy for all MRCPv1 traffic in the environment.
[+] Prerequisites
Tip
The prerequisites for the MRCP Proxy backup server are the same as for the primary in HA mode, and the connections must be the same on both MRCP Proxy Applications in the HA pair.
[+] Steps
- Complete Steps 1 to 5 in the [[[Procedure: Configuring the MRCP Proxy, on page 250]]] for both MRCP Proxy Applications in the HA pair.
- In the primary MRCP Proxy Application, click the Configurations tab.
- In the Server Info section, in the Backup Server field, browse to the backup MRCP Proxy Application and click to select it.
- In the Redundancy field, select warm-standby.
- Save the configuration.
Connect to the MCP
- In the Media Control Platform Application, create a connection to the primary MRCP Proxy.
- Save the configuration.
Procedure: Adding a Speech Server as Primary or Backup
[+] Purpose
To add a speech server as primary or a bBackup.
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Select the MRCP Proxy Application that you want to configure and click Manage Connections.
The Manage Connections dialog appears.
- Click Next twice in the Manage Connections dialog.
The Add Connections dialog appears.
- Click Add and select the speech server to add.
- Click Edit and select the Advanced tab.
- Enter provisiontype=primary in the Application Parameters field, to add the speech resource as primary.
OR
Enter provisiontype=backup in the Application Parameters field to add the speech resource as backup.
- Click Execute and then Finish.
Configuring the CTI Connector for Cisco ICM
When you install the CTI Connector, you can select the CTI Framework that is appropriate for your environment Genesys CTI or Cisco ICM. Use the procedure in this section to configure the CTI Connector if you selected Cisco ICM.
Procedure: Configuring the CTI Connector for Cisco ICM Integration
[+] Purpose
To configure the CTI Connector to integrate with Cisco Intelligent Contact Management (ICM).
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Double-click the CTI Connector Application that you want to configure.
The Configuration tab appears.
- Click the Options tab.
- If you want to use the Call Routing Interface (CRI), in the icmc section:
- Configure the ICMInterface option with the CRI value.
Tip
During installation, when you select Cisco ICM, the Service Control Interface is initialize by default.
- Configure the TrunkGroupID option with an applicable value.
For Single Tenant Environments:
- In the Tenant1 section:
- Enter the tenant name in the TenantName configuration option value field.
- Change the value of the Ports configuration option, as required. For example, 8000 (or retain the default, 9000).
For Multi-Tenant Environments:
- Copy the Tenant1 section and rename it for each additional tenant. For example: Tenant2, Tenant3, Tenant4.
- For each newly created tenant:
- Enter the tenant name in the TenantName configuration option value field.
- Change the value of the Ports configuration option, as required. For example, 8000 (or retain the default, 9000).
Ensure that there are no duplicate ports configured across all tenants.
Tip
You can specify a comma-separated list of listener ports for a single tenant, one for each VRU-PG. For example, 8000, 9000, 10000.
- Save the changes.
[+] Next
- Configure an IVR Profile to support ICM call flows, see Chapter 6 in the Genesys Voice Platform 8.5 User s Guide.
Provisioning the PSTN Connector
The procedures in this section describe how to configure the mandatory parameters for the Public Switched Telephone Network (PSTN) Connector Application object and the how to integrate the PSTN Connector with SIP Server. There are many more configurable parameters for the PSTN Connector, all of which are optional. For a complete list and description of configuration options, see the Genesys Voice Platform 8.5 User's Guide.
The PSTN Connector component is required if you are planning to migrate from GVP 7.x Voice Communication Server (VCS), or a VoiceGenie (VG) TDM interface to GVP 8.1.2 or later.
This section contains procedures for Configuring the PSTN Connector and Configuring a Trunk DN for the PSTN Connector.
Procedure: Configuring the PSTN Connector
[+] Purpose
To prepare the PSTN Connector to manage inbound and outbound calls for GVP.
[+] Prerequisites
- All of the GVP components are installed. See Procedure: Using the Deployment Wizard to Install GVP, on page 221.
- The connections to Message Server, SIP Server, and the SNMP Master Agent are configured in the PSTN Connector Application object. See Procedure: Creating a Connection to a Server, on page 243.
- SIP Server is installed. See the
Voice Platform Solution 8.1 Integration Guide.
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Select the PSTN Connector Application object that you want to configure.
The Configuration tab appears.
- Click the Options tab, and from the View drop-down list, select the Mandatory Options view.
- In the DialogicManager_Route1 and GatewayManager sections, enter the values for the mandatory options as shown in Table 23.
Table 23: PSTN Connector Mandatory Parameters
| Section
|
Option
|
Value
|
| DialogicManager_Route1
|
RouteType
|
Specify one of three route types or call directions for this route, enter:
- 0 for Inbound
- 1 for outbound
- 2 for In/Out
(See Note below, in this table.)
|
|
|
Signaling Type
|
Specify one of five signaling types, enter:
- 0 for T1-ISDN (PRI)
- 1 for Analog
- 2 for E1-ISDN (PRI)
- 3 for T1-RobbedBit
- 4 for E1-CAS
|
|
|
Channels
|
Specify the ports for this route by using the format, [<Card>:<PortRange>,<Card>:<PortRange>].
You can provision more than one board in a route and a partial range of ports in a board for example:
- 1:1-23
- 1:1-23,2:1-23
- 1:1-30,2:1-30
- 1:1-12,2:1-15
|
| GatewayManager
|
SIP Destination IP Address
|
Enter the SIP endpoint IP address that will receive SIP calls from the PSTN Connector. (This is the IP address for SIP Server or the
Resource Manager, depending on your configuration.)
|
|
|
SIP Destination Port Number
|
Enter the SIP endpoint port number of the server that is configured in SIP Destination IP Address.
|
| MediaManager
|
Supported Local Codec Type
|
Enter the audio format that is in use on the TDM trunk:
|
Notes
- The Inbound & Outbound route type is supported only on ISDN (PRI) lines. If you select one of these route types, ensure that you use a compatible signaling type.
- If you are using a T1-Robbed Bit or E1-CAS interface, options in the T1rb options group must be configured, specifically the T1rbProtocolFile option, see the component metadata.
- For JCT boards only, a separate span is required to support ASR or recorded VoiceXML applications in T1-ISDN, E1-ISDN, or E1-CAS environments. The MediaVoxResourceBoard option must be configured with route number that is used for CSP.
- When JCT boards are used with the PSTN Connector, and the VoiceXML application uses ASR or recording media, not all the spans can be used for call handling. For each span that is configured to take calls, there must be another dedicated span for streaming echo cancelled audio to the Media Control Platform. Therefore, if Route1 is configured to handle calls on span1 (for example, ports=1:1-23), the MediaVoxResourceBoard option under the DialogicManagerRoute1 section should be set to 2. Repeat the same steps if you have configured a DialogicManager_Route2 section.
This restriction does not apply in the following scenarios:
- The VoiceXML application is a pure DTMF application (does not use ASR or recording media).
- The VoiceXML application uses ASR but the JCT board is configured with the T1-Robbed Bit protocol.
|
- Create additional DialogicManager_Route<N> sections as required (for example, you may want to create a section for inbound ports and one for
outbound ports):
- From the View drop-down list, select either Advanced View (Options) or Advanced View (Annex).
- Right-click on the Section column heading and select New.
- Enter DialogicManager_Route2 for the Section name, Description for the Option name, and Route2 Information for the Value.
- Click OK.
- Copy and paste all of the options from the DialogicManager_Route1 and DialogicManager_Route2 sections, modifying the mandatory values as required.
- Repeat these steps as required.
Tip
Dialogic Circular Buffer Size
When you configure the PSTN Connector application, set the value for [DialogicManager] DialogicTransferBufferSize to 2048. This specifies the size of the Dialogic Circular buffer which is used for transferring data to the Dialogic firmware. The default value of this parameter on Windows is different, but must be set to 2048 for Linux. If not, the Dialogic may return LOW_WATER_MARK warnings during initial play of the media, which interferes with normal audio play and may result in the prompt being cut off.
Save the configuration.
[+] Next
- Configure the Trunk and Trunk Group DNs for the PSTN Connector. See Procedure: Configuring a Trunk DN for the PSTN Connector.
Procedure: Configuring a Trunk DN for the PSTN Connector
[+] Purpose
To configure SIP Server with a Trunk DN, which points to the PSTN Connector Application object to ensure outbound calls can be routed to a specific PSTN Connector instance.
[+] Summary
You can deploy multiple PSTN Connectors, however, you must ensure that SIP Server routes the outbound call to the same PSTN Connector instance as the inbound call. This procedure includes configuration options to enable this functionality.
[+] Prerequisites
- The PSTN Connector is installed and configured. See Procedure: Configuring the PSTN Connector, on page 254.
[+] Steps
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Switching > Switches.
- Double-click the switch that you want to configure.
The Configuration tab appears.
- On the DNs tab, select New.
- In the General section, enter values for the mandatory fields, selecting Trunk from the Type drop-down list.
- In the Switch pane, double-click the Trunk DN you created in Step 4.
- On the Options tab, select Advanced View (Annex) from the View drop-down list.
- Right-click on the Section column, and select New.
- In the New Option dialog:
- In the Section field, enter TServer.
- In the Name field, enter contact.
- In the Value field, enter the IP address and port number of the PSTN Connector separated by a colon for example, 10.10.10.101:5060
- 1In the DNs pane, click New.
- In the TServer section, add the following options and values:
- prefix = <xyzz> where <xyzz> represents a number which, if present in the dial string of the outbound call, enables the SIP Server to route the call to the PSTN Connector instance that is configured with this prefix.
- replace-prefix = <empty String) where <empty String) represents an empty string to ensure that the prefix added by Resource Manager to the destination number string is removed by the SIP Server before the call is forwarded to the same PSTN Connector instance.
- 1Save the configuration.
For information about how the PSTN Connector fits into a common VPS deployment architecture, see the Supported Architecture chapter in the
Voice Platform Solution 8.1 Integration Guide.
[+] Next
- If required, complete the post-installation activities for the Supplementary Services Gateway. See [[[Procedure: Configuring the Supplementary Services Gateway, on page 259]]].