Configuring GVP Components 3
Perform these advanced configuration procedures after installation and basic configuration.
Using Resource Groups
To enable ease of management, common GVP resources can be grouped into Logical Resource Groups (LRGs). When multiple instances of a resource, such as, the Media Control Platform, Call Control Platform, or CTI Connector, are assigned to a resource group, the Resource Manager can easily manage and provide load balancing for the resources within the group. In addition, connections are created to enable the physical resources to communicate with the Resource Manager so that they can be assigned to fulfill requests for services. To create the connections, see Procedure: Creating a Connection to a Server.
Procedure: Creating a Resource Group
Group resources that use common services and provide load balancing.
The MCPGroup created in this procedure provides load balancing for the resources within it that are using VoiceXML services. If you have one or more Call Control Platforms installed in your deployment, create a resource group that includes resources that use CCXML services. You can also create a group to manage resources that use the gateway, CTI, conference services, or recording servers.
- Verify that all of the GVP components are installed. See Procedure: Using the Deployment Wizard to Install GVP.
- Log in to Genesys Administrator.
- On the Provisioning tab, click Voice Platform > Resource Groups.
- On the Details pane toolbar, click New.
The Resource Group Wizard opens to the Welcome page. - On the Resource Manager Selection page, select the Resource Manager Application object for which you want to create the group. On the Group Name and Type page:
- Enter a group name; for example, MCPGroup.
- Select one of five group types:
- Media Control Platform
- Call Control Platform
- Gateway
- CTI Connector
- Recording Server
TipWhen creating resource groups in multi-tenant environments, ensure that only one CTI Connector resource group is configure for the entire hierarchy.A short video on how to create an MCP resource group:
A short video on how to create a Gateway resource group:
- On the Tenant Assignments page, select the child tenant to which the resource group will be assigned.
- On the Group Properties page, enter the information from the table below for each resource group that you are configuring.
TipFor the Media Control Platform group, the Max.Conference Size and Max.Conference Count, and Geo-location options are optional; therefore, they are not included in thus table. For a complete list of resource-group options and their descriptions, see the GVP 8.5 User's Guide.
Table: Group Properties Resource Groups Wizard Field name Value Media Control Platform Monitoring Method Retain the default value: SIP OPTIONS. Load Balance Scheme Select least percent. Call Control Platform Monitoring Method Retain the default value: none. Load Balance Scheme Select least percent. Gateway Monitoring-Method Retain the default value: none. Load Balance Scheme Select least percent. CTI Usage Select Always off, Always on, or Based on DN lookup. CTI Connector Monitoring-Method Retain the default value: none. Load Balance Scheme Retain the default value: round-robin. Recording Server Monitoring-Method Retain the default value: SIP Options. Load Balance Scheme Retain the default value: round-robin. - On the Resource Assignment page:
- Select the checkbox beside each resource you want to assign to this group.
- In the SIP Port column, click in the column to select a port number from the drop-down list.
- In the SIPS Port column, click in the column to select a port number from the drop-down list.
TipWhen you are creating Gateway resource groups: there is only the SIP Port column, and you must enter the port number (there is no drop-down list of ports).
- In the Max Ports column, enter a number that represents the maximum number of requests this resource is capable of handling.
- In the Redundancy column, click in the column to choose active or passive from the drop-down list.
The Resource Assignment list is compiled depending on the type of group that you are creating; for example, if you are creating a Media Control Platform group, only Media Control Platform servers appear in the list.
The Resource Manager (RM) supports physical resources as active or passive inside a Logical Resource Group. Configure each resource with the option redundancy-type. The default value is active.
If redundancy-type is not specified for a resource, then RM considers it as active.
Normally, RM load-balances the active resources. When one or more active resources go down, the passive resources activate to replace them. RM load-balances the remaining active resources and passive resources.
When all active resources become available again, RM returns to using only the active ones—although existing sessions on the passive resources are allowed to complete.
- On the Confirmation page, click Finish.
- Continue with the post installation activities for the Resource Manager. See Procedure: Creating IVR Profiles.
Creating IVR Profiles and DID Groups
GVP uses IVR Profiles, which are VoiceXML, CCXML, Announcement, and Conference applications, to control interactions that require the use of Direct Inward Dialing (DID) numbers and provides service for the resources that use them.
You can create as many IVR Profiles as you need and any number of DIDs or DID ranges. DIDs are grouped into DID Groups for ease of assignment and administration. DIDs are obtained from the Dialed Number Identification Service (DNIS). The Resource Manager can be configured to obtain DNIS information from SIP Server.
If GVP is configured to map DIDs to IVR Profiles or a tenant, the Resource Manager uses DNIS to determine which IVR Profile to invoke for the session. If GVP is not configured in this way, the Resource Manager uses a default IVR Profile that is specified for the Environment (or default) tenant.
This section contains the following procedures:
- Procedure: Creating IVR Profiles
- Procedure: Adding a Context Services base URL to an IVR Profile
- Procedure: Creating DID Groups
Procedure: Creating IVR Profiles
Create IVR Profiles that use DIDs to provide service for the resources that use them.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Voice Platform > IVR Profiles.
- In the Tasks panel, click Define New IVR Profile.
The IVR Profile Wizard opens to the Welcome page. - On the Service Type page:
- Enter a name for the IVR Profile for example, VPS_IVRProfile.
TipThe IVR Profile name is case-sensitive and can be up to 255 characters in length. For information about naming IVR Profiles, see Genesys Administrator 8.1 Help.
- From the drop-down list, select one of four service types:
- VoiceXML
- CCXML
- Conference
- Announcement
- Enter a name for the IVR Profile for example, VPS_IVRProfile.
- On the Service Properties page, enter the mandatory values from Table: IVR Profile Wizard Service Properties for the service type that you selected in the previous step.
This table includes only those options that are mandatory to create an IVR Profile. For a complete list of the options used to configure IVR Profiles and their descriptions, see the
GVP 8.5 User's Guide.
Table: IVR Profile Wizard Service Properties Service Type Field Value VoiceXML Initial Page URL Enter the Universal Resource Locator (URL) to your VoiceXML page for example, http://samples/hello.vxml or file:///C:/GVP/VP_MCP/samples/helloaudio.vxml CCXML Initial-Page-URL Enter the URL to your CCXML page for example, http://samples/hello.vxml or file:///C:/GVP/VP_CCP/samples/helloaudio.ccxml Conference Conference-ID Enter a value that starts with a letter, number, or underscore (cannot exceed 255 characters), for example: 3332. Announcement Play Enter the URL that points to the announcement you want to play for example, http://samples/hello.vxml or C:/GVP/VP_CCP/samples/announcements.
Note that the URLs in this table are examples. When you create your IVR Profiles, enter the URLs that point to the actual VoiceXML, CCXML, Conference, or Announcement applications in your environment. The small icon to the right of the URL field in the wizard, is used to load the URL into a pop-up web page, verify the accuracy, and confirm that an application actually exists at that location. TipAfter the Service Properties are entered, you have the option of clicking Finish and a basic IVR Profile is created. However, if you want to customize the profile, you can continue on through the Usage Limits, IVR Capabilities, CTI Parameters, and Dialing Rules pages which contain optional configuration parameters. For more information about these configuration parameters, see the GVP 8.5 User's Guide. - On the Usage Limits page, in the Maximum Concurrent Sessions field, enter a number to define the maximum number of concurrent sessions that can be used by the IVR Profile.
- On the IVR Capabilities page, configure the parameters in the table below as required for your IVR Profiles.
The IVR Capabilities page appears only if you have selected the VoiceXML or CCXML service types in Step 4.
IVR Capabilities Page IVR Profile Wizard Option Description Allow Outbound Calls Insert a check mark to enable (or leave blank to disable).
Sets the value of the outbound-call-allowed parameter (for bridge or consultation transfers, as well as for outbound calls), in the gvp.policy configuration section. By default, INVITE transfers are enabled
Allows Transfers Insert a check mark to enable (or leave blank to disable).
Sets the value of the transfer-allowed parameter (for blind or consultation transfers), in the gvp.policy configuration section. By default, REFER transfers are enabled.
Gateway Selection Select one of three options: - Always use the same gateway
- Use same gateway if possible
- Use any available gateway
- On the CTI Parameters pane, configure the parameters as described in the table below.
The CTI Parameters page appears only if you have selected the VoiceXML service type earlier in this procedure.
Table: CTI Parameters Pane IVR Profile Wizard Option Description Require CTI Interaction Insert a check mark to enable (or leave blank to disable). Sets the value of the cti-allowed parameter, in the gvp.policy configuration section. By default, the CTIC is not required.
Transfer on CTI Insert a check mark to enable (or leave blank to disable). Sets the values of the cti.transferoncti and cti.defaultagent, respectively, in the gvp.service-parameters configuration section.
Default Agent The default agent to whom transfers will fall back if the original transfer fails. - On the Dialing Rules page:
- In the Action field, retain the default value Accept.
- In the Regular Expression field, enter the expression in the form of a URL. The Dialing Rules page appears only if you have selected the VoiceXML or CCXML service type in step 4 of Procedure: Creating IVR Profiles.
- On the Policies page, in the SQ Notification Threshold (%) field, enter a number between 1 and 100.
- On the Confirmation page, if the configuration is correct, click Next.
- Click Finish.
- (Optional) Manually add a Context Services base URL to an IVR Profile. See Procedure: Adding a Context Services base URL to an IVR Profile.
- Create the DID Groups. See Procedure: Creating DID Groups.
Procedure: Adding a Context Services base URL to an IVR Profile
Universal Contact Server (UCS) interfaces use a database that stores contact (customer) data. Classic UCS works with Genesys eServices (Multimedia). By using Context Services, which is an optional set of additional capabilities, UCS can work with other Genesys products and solutions, such as Genesys Voice Platform and Conversation Manager. This procedure is optional.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Voice Platform > IVR Profiles.
- Select the newly created IVR Profile.
- To add a new option, click New:
- In the Section field, enter gvp.service-parameters.
- In the Name field, enter voicexml.cs_base_url.
- In the Value field, enter fixed, <the base HTTP URL of the context services>.
ImportantThe voicexml.cs_base_url value can also contain the username and password if it is required by the context services. If the username and password is required, use this syntax:
http://<username>:<password>@<host>:<port>
If the username and password is not required, use this syntax:
http://<host>:<port>
- Click OK.
Procedure: Creating DID Groups
Create DID Groups that contain DIDs to assign to IVR Profiles and tenants. DID Groups enable ease of management and assignment. The groups can contain a single DID, a range of DIDs, or no DIDs. Empty DID Groups can be created initially as placeholders until you are ready to populate them.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Voice Platform > DID Groups.
- Select New.
- In the Name field, enter the name of the DID Group.
- In the IVR Profile field, click the browse icon to find the IVR Profile or tenant that you want to associate with this DID Group.
- In the DIDs field, click Add.
- In the DID dialog box, enter a DID, a range of DIDs or a number prefix for example:
1234
4567-8901
456* - In the DID Group Property panel, click Save or click Save & New to create another DID Group.
- Configure the Environment (default) Tenant and default IVR Profile. See Assigning Default Tenants and Creating Default Profiles
Assigning Default Tenants and Creating Default Profiles
In multi-tenant environments, the default tenant and IVR Profile are used for those calls that are not validated or cannot be associated with a specific tenant or profile. To properly configure the default objects, a specific Resource Manager instance must be configured to manage the default tenant, the tenant data must be configured, and a default IVR Profile must be created.
- You must create a default IVR-Profile object under that tenant. For simplicity, in the IVR-Profile's Annex tab, the parameter service-type under gvp.general section may point to voicexml.
- In that tenant's Annex tab, the parameter default-application under gvp.general section must point to that profile object.
Use the following procedures to complete the task in this section:
- Procedure: Adding the Environment Tenant to the Resource Manager
- Procedure: Creating a Default Profile for the Default Tenant
- Procedure: Updating the Tenant Data
Procedure: Adding the Environment Tenant to the Resource Manager
Add the Environment Tenant to the Resource Manager Application that is used to create a default IVR application.
This procedure describes the steps to add the Environment tenant to the Resource Manager Application when GVP is deployed in a multi-tenant environment. If your environment is single-tenant, the default tenant is named Resources and not Environment.
- Verify that all of the GVP components are installed. See Procedure: Using the Deployment Wizard to Install GVP.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Click the Resource Manager Application object you want to configure.
The Configuration tab appears. - In the Server Info section, in the Tenants field, click Add.
A Browse dialog box appears. - Select Environment, and then click OK.
The Environment Tenant object appears in the Tenants field. - Save the configuration.
- Create a default IVR Profile for the Environment Tenant. See Procedure: Creating a Default Profile for the Default Tenant
Procedure: Creating a Default Profile for the Default Tenant
Create a default IVR Profile that can be used to accept calls other than those specified in the dialing plans.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Voice Platform > IVR Profiles.
- In the Tasks panel, click Define New IVR Profile.
The IVR Profile Wizard opens to the Welcome page. - On the Service Type page:
- Enter the name of the default IVR Profile, IVRAppDefault.
- Select VoiceXML from the drop-down list.
- On the Service Properties page, enter http://samples/hello.vxml.
- Click Finish.
- Update the Environment tenant data. See Procedure: Updating the Tenant Data.
Procedure: Updating the Tenant Data
Configure the tenant to look for the default IVR Profile application, so that calls other than those specified in the dialing plans are accepted.
- All of the GVP components are installed. See Procedure: Using the Deployment Wizard to Install GVP.
- A default IVR Profile has been created, named, IVRAppDefault. See Procedure: Creating a Default Profile for the Default Tenant.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Tenants.
- Click the Environment tenant or, if you are configuring a single-tenant environment, click Resources.
- On the Options tab, create a new section named gvp.general.
- In the gvp.general section, create a new option named default-application.
- For the default-application option, enter the value IVRAppDefault.
- Enter the values for the remaining options in the gvp.general, gvp.policy section, and gvp.dnis-range sections as shown in the table below.
The default-application option is mandatory for a tenant.Sections, Names, and Values GVP Options Section Name Value gvp.general default-application IVRAppDefault sip.sessiontimer 1800 gvp.policy usage-limits 100 The values for the gvp.dnis-range configuration option are added automatically by the DID wizard.
The IVR Profile and Environment tenant configuration sections, gvp.log, gvp.log.policy, and gvp.policy.dialing-rules can be further defined with many more supported options. For a complete list of these options, go to the Options tab of the Application object template.
- Save the configuration.
- Complete the post-installation activities for the Reporting Server. See Integrating the Reporting Server User Interface with GVP, below:
Integrating the Reporting Server User Interface with GVP
The Reporting Server User Interface (RPTUI) is installed when Genesys Administrator is installed, however, you can customize your environment by using the default Application object (or Configuration Server object) to configure port numbers, authentication, and HTTP settings.
In addition, you must create a connection to Reporting Server in the default Application object to ensure that the RPTUI functions properly. The RPTUI discovers the Reporting Server host based on this connection. Furthermore, the RPTUI reads and enforces the data reporting limits that are configured in the Reporting Server Application object (in the reporting section).
Finally, you must configure the Reporting Server logging and messaging parameters so that the monitoring and reporting functionality perform as intended.
Procedure: Configuring the Reporting Server User Interfaces
Configure the default Application object to ensure that the Reporting Server user interfaces are exposed and to create the connection to the Reporting Server.
- Verify that:
- Genesys Administrator is installed and fully functional. See the Framework 8.1 Deployment Guide.
- All of the GVP components are installed and started. See Procedure: Using the Deployment Wizard to Install GVP.
- Log in to Genesys Administrator.
- On the Provisioning tab, select Environment > Applications.
- Click the default Application object.
- In the Connections section, click Add.
The Connection Info dialog box appears. - In the Server field, click the Browse icon.
- Select the Reporting Server to which you want to create a connection.
- Click OK.
The Reporting Server you selected appears in the Connection section. - On the Options tab, select GVP Reporting from the View drop-down list.
The Options list is filtered, and all of the rptui section options appear.TipIf you do not see GVP Reporting, select Show options in groups from the View drop-down list. The list changes, and GVP Reporting is available for selection. - Retain or modify the values for the options in the rptui section, as shown in the table below.
Table: default Application Object Options Tab Option Value enablehttps Retain the default value, false. httpport Retain the default port value, 8080, or enter a port number from 1030 to 65535. httptimeout Retain the timeout value, 30, or enter any value greater than 0. username Enter a user name to enable the web server for authentication. (Must match the password that is configured in the Reporting Server Application.) password Enter a password. (Must match the password that is configured in the Reporting Server Application.) tzoffset Retain the default time zone offset value, -08:00, or enter a value in the format shh:mm, where s is either a plus (+) or minus (-), hh represents hours, and mm represents minutes. dsthours Retain the default value 01:00, or enter a value in the format shh;mm, where s is either a plus (+) or minus sign (-), hh represents hour, and mm represents minutes. localtimeformat Retain the default value true to display the datetime fields in local time format, or enter false to display the datetime fields in Universal Time Coordinated (UTC). TipClick on any option on the Options tab for a detailed description and the default value. - Save the configuration.
- In the default Application object, create a connection to the Reporting Server. See Procedure: Creating a Connection to a Server.
- Create a database for the Reporting Server. See Reporting Server Database.
Configuring the Reporting Server Locale
If the Reporting Server is installed on a host that is configured with a locale other than English (default), you must complete the procedure in this section to achieve full functionality of the Reporting Server.
Procedure: Configuring the Reporting Server Locale
Configure the Reporting Server with a locale that is not the default (English).
- In the Reporting Server installation directory, locate the JavaServerStarter.ini file.
- In the [JavaArgs] section, add the line Duser.language=en, for example:
[JavaArgs]
-Xmx1536M
-Duser.language=en - Open the Java Control Panel and on the Java tab, click View.
- On the User tab, in the Runtime Parameters field, change the language setting.
This configuration affects all JVM default locales.