Configuring SpeechMiner

This topic explains how to configure SpeechMiner after it is installed. Most of the configuration is performed in the SMConfig application. This is a Windows application that can be installed on any machine on your network. Once it is installed, it can be used, from any machine on which it is installed, to configure the entire SpeechMiner system. (For information about installing SMConfig, see Installing the Components.)

Required Permissions

The user account from which SMConfig is opened must have read, write, and modify permissions on the local installation folder and files.

For most of the configuration changes you can perform using SMConfig, you will need Administrator privileges on the current machine or on other machines. For each configuration task described below, the required permissions are listed. If you are running SMConfig as a non-administrator user, and errors are generated during the configuration process, make sure that you have the right permissions for the task.

In Windows Vista and later versions of Windows, if User Access Control is enabled, SMConfig will automatically require you to run it with administrator privileges. If User Access Control is disabled, it is recommended to manually run SMConfig with administrator privileges. To do this, right-click the SMConfig icon, and then select Run as administrator.

For more information on the permissions required for the other SpeechMiner component, see Configuring Permissions.

Encrypting the Connection to the Database

The connection between SMConfig and the database can be encrypted to ensure that confidential data cannot be intercepted and viewed by unauthorized people. This option is configured by the system administrator on the SQL database server. Three encryption settings can be defined there:

• Always use encryption
• Never use encryption
• Use encryption when the user requests it

If the latter setting is implemented in your system, you can choose to use an encrypted connection when you log into SMConfig. If the database server is configured to always encrypt or not to encrypt at all, you cannot change this option when you log into SMConfig, and selecting one of the options has no affect.

Configuring the Browser

End users of SpeechMiner access its browser-based interface from Internet Explorer or Google Chrome, which connects to the SpeechMiner Web server through the local network. In order for the SpeechMiner interface to work properly, you must configure each user's browser as explained below. The configuration changes that must be implemented are to allow pop-ups from the SpeechMiner domain, to treat the SpeechMiner domain as part of the local intranet (or as a trusted site), and to enable automatic updating of cached web pages.

In addition, if Internet Explorer is running on a Windows Server 2008 machine or Windows Server 2012 machine, the Enhanced Security Configuration feature should be turned off.
Refer to the Turning Off the Enhanced Security Configuration Feature on Windows Server 2008 / Windows Server 2012 section below.

Tip

To run SpeechMiner 8.5.5 you must use a minimum resolution of 1366X768. We recommend that you work with a 1680x1050 resolution.

Configuring Internet Explorer

1. In the Internet Options dialog box, in the Security tab, select Local Intranet.
   
   



2. Add the SpeechMiner domain to the list of web sites in the Local Intranet zone.
3. Click Sites > Advanced and add *.genesyscloud.com to the list of safe websites.
4. Click Custom Level to customize the local intranet zone security.
5. Under Miscellaneous > Access data sources across domains, select Enable.

Selecting Enable makes Screen Recording playback possible because it allows access from the browser to HTCC.



6. In the Privacy tab, add the SpeechMiner domain to the list of web sites that are permitted to open pop-ups.
7. In the General tab, under Browsing history, select Settings.
8. Under Check for newer versions of stored pages, select Automatically.
   
   



9. Click OK to save the changes.

Important

If the SpeechMiner domain is treated as part of the local intranet, Local intranet should appear in the Status Bar at the bottom of the Internet Explorer window whenever the browser is displaying a SpeechMiner page.

Turning Off the Enhanced Security Configuration Feature on Windows Server 2008 / Windows Server 2012

1. In the Server Manager, in the home page (the top level), expand the Security Information section. The current settings for the Enhanced Security Configuration feature appear under IE Enhanced Security Configuration (ESC).
   
   



2. If the current settings are not Off for Administrators and Off for Users, click Configure IE ESC. The Internet Explorer Advanced Security Configuration dialog box opens.
   
   



3. For both Administrators and Users, select Off.
4. Click OK to save the changes.

Configuring Chrome

1. In the Chrome browser, click the Chrome menu , and select Settings.
2. Under Privacy, click Content Settings....
3. Under Pop-ups, verify that Allow all sites to show pop-ups is selected. If it is not selected perform the following:
1. Click Manage exceptions....
2. In the field provided, type *.genesyscloud.com and select the Allow behavior.
3. Press Enter and click Done.

Verify that Java Script is Enabled

1. In the Chrome Browser, navigate to Chrome Settings > Show Advanced Settings > Privacy > Content Settings.
2. Under Java Script, select Allow all sites to run Java Script (recommended).

For more information about enabling Java Script, see the following example https://support.google.com/adsense/answer/12654.

Opening SMConfig

SMConfig can be run on any machine in your system in which it is installed. During installation, an SMConfig icon is placed on the desktop of the machine.

You can log into SMConfig in one of the following ways:

• Using a SpeechMiner user account
• Using the Windows account you used to log onto the PC
• Using a Genesys user account and connecting to a Genesys configuration server for confirmation

To open SMConfig:

1. On the desktop of the computer, double-click the icon. The SMConfig - Login dialog box appears.
   
   



2. Select the type of user account you want to use to log into SpeechMiner:
   • SpeechMiner Authentication: Use a username and password that are managed by SpeechMiner.
   • Windows Authentication: Use the username and password you used to log into Windows.
   • Genesys Authentication: Use a Genesys username and password.
   Important

   If you are not sure which option to choose, consult your system administrator.
3. In the Username and Password fields, type your username and password.
   Important

   If you are logging in using Windows Authentication, your username and password are inserted automatically, and the username is in the form domain\username.
4. If this is the first time you are opening SMConfig on this computer, or if you want to change the existing database settings, click the DB Settings arrow. The Login dialog box expands and displays the database settings.
   Important

   If you do not need to set or modify the database settings, skip this and the next step.
   
   
   



5. Fill in the fields as follows:

   Field	Description
   SQL Server Authentication / Windows Authentication	Select SQL Server Authentication if the username and password for accessing the database are managed on the SQL server. SelectWindows Authentication if you log into the database using the same username and password you used to log into Windows. Note: If you are not sure which option to choose, consult your system administrator.
   Server	The name of the database server Note: If the database is a named instance on the server, enter both the server name and the instance name, in the format server_name\instance_name.
   Port	The port to use to connect to the database server Note: This should normally be left as <default>, even if the database is a named instance.
   Username	The username to use to connect to the database Note: This field is not available when Windows Authentication is selected. In this case, the username is automatically taken from the username used to log into Windows.
   Password	The password to use to connect to the database Note: This field is not available when Windows Authentication is selected. In this case, the password is automatically taken from the username used to log into Windows.
   Database	The name of the database
   Encrypt connection	If encrypting the connection to the database is optional in your system, select this option to activate encryption. Note: If encryption is always turned on in your system, selecting or clearing this option will have no effect. If encryption is always turned off in your system, selecting this option will prevent SMConfig from connecting to the database server and you will not be able to log in. In this case, an error message stating, Could not connect to database. Please check database settings, will appear when you click OK.

6. If you have chosen to log in using Genesys authentication, an additional option, Configuration Server Settings, appears below DB Settings. If this is either the first time you are opening SMConfig on this computer, or you want to change the existing Genesys configuration server settings, click the Configuration Server Settings arrow. The Login dialog box expands and displays the configuration-server settings.
   Important

   If you do not need to set or modify the Genesys authentication settings, skip this and the next step.
   
   
   



7. Enter the name of the server and the port to use to verify the user information, as follows:
   • Server—Enter the name of the configuration server.
   • Port—The port to use to connect to the configuration server in order to verify the user information.
8. Click OK. You are logged into the system, and the SpeechMiner Configuration Tool (SMConfig) window opens with the first screen, Sites and Machines, displayed.
   
   

The SMConfig interface contains panels (Sites and Machines, Reports, etc.) in which various categories of configuration settings can be accessed.

To open a panel:

• On the left side of the window, select the icon of the panel. The panel opens on the right side of the window.

Saving Changes

Changes you make in one panel of SMConfig are saved temporarily if you open a different panel. Nonetheless, you must click Save in each panel to save the settings in that panel.

After you click Save, before the settings are actually saved, some settings go through a validation process. Validation ensures that the locations specified for folders and files exist and can be accessed, and checks that certain important parameters are configured properly. Certain key settings are always validated when Save is selected; you can choose to have the system validate certain others if you wish.

During the validation process, a Progress window is displayed. The window lists the stages of the validation process as they are completed, with an icon indicating the status of each stage.

Icon	Description
	Success: Validation of the stage was successful.
	Warning: Validation of the stage was successful, but some problematic issues were detected.
	Failure: Validation of the stage failed, because of the problems indicated. No changes to the configuration were saved.

When the process is complete, the Close button at the bottom of the window becomes active. If validation was successful, the last line of the log says Done. If the Progress window contains any stages that failed (indicated by ), the entire save process is cancelled. The following screenshots depict examples of each status:

To see details about a warning or failure:

• In the Progress window, select the item. Details are displayed at the bottom of the window.
  
  

After the configuration changes are successfully saved, a Restart Services message appears.



Select Yes to restart all of the services, or No if you prefer to restart them later (either after you make additional configuration changes, or manually from the Services panel.)

Sites & Machines

The first panel of the SMConfig application, Sites & Machines, is used to configure the layout of the system as well as some other system-wide parameters.

This tool enables you to configure sites, machines and tasks, and system index searches.

Reports

If you want to use any of the SpeechMiner reports, you must deploy both the MRS Library, which is a DLL that provides support for various report features, and all the required reports, on the report server. You can do this from the Reports panel of SMConfig. The DLL and the reports will be deployed on the machine that is identified in the Sites & Machines panel, specified as the Server Name parameter under the Report Server panel.

Required Permissions

To check if the MRS Library has been deployed on the report server, and to deploy the MRS LIbrary, SMConfig reads the report server's Registry to locate the report server’s bin folder and then accesses the folder using the $ share. Therefore, to deploy the MRS Library and any or all of the reports, the user account used to log into SMConfig must have administrator permissions on the report server.

Deploying the Reports

To deploy reports on the report server, you must first deploy the MRS Library on the server, and then deploy the required report templates. You can perform both actions simultaneously by selecting both options in the Reports panel. Once the MRS Library is deployed on the server, you can deploy additional reports without redeploying the library.

Important

When you select the Reports panel, SMConfig checks whether the MRS Library is already deployed on the machine.

To deploy reports on the report server:

1. In the Reports panel, fill in the fields as follows:

   Field	Description
   Validate Report Server	Select this option if you are configuring SpeechMiner to use a report server. SMConfig will check that the parameters are correct. Note: If you select this option, SMConfig will try to validate that the user who is running SMConfig has access to the report web service and can call methods using this web service. Therefore, the user account that was used to run SMConfig must have the Content Manager role on the report server (see Configuring Permissions for UPlatform). Folders Select this option if you want SMConfig to check whether the Package, Backup, and Index folders exist and are configured properly.
   Report Server	Fill in the fields in this area as follows: Server Name: The name of the machine on which the report server is installed Protocol: The protocol SpeechMiner must use to connect to the report server Port: The port SpeechMiner must use to connect to the report server Virtual Folder: The folder of the reports on the report server—usually named ReportServer. If the database is a named instance, enter both the folder name and the instance name, in the format <virtual report folder name>_<instance_name>. Note: If you plan to use the report server, select Validate Report Server.
   Set reports caching time	If you chose to use report caching in the Sites & Machines panel, specify how long report results should be cached, in minutes. The results of reports that are included in active users' Views pages will be saved for the specified period of time. Users who open their Views pages during that time period will see the cached results. The recommended time period is 24 hours (i.e., 24*60=1440 minutes), because the report caching runs once every 24 hours.
   Deploy MRSLibrary	If the MRS Library has not yet been deployed on the report server, select this option. Note: If this option is not selected, but the checkboxes in the Report/Resource list below are active, this means that the MRS Library is already deployed on the machine. In this case, it is not necessary to select this option.
   Deploy reports	Enter the location of the reports folder. This folder is called reports, and is located in the SpeechMiner installation folder. For example, if SpeechMiner was installed in c:\Program Files (x86)\Genesys\Software, the path to enter would be c:\Program Files (x86)\Genesys\Software\reports.
   Select\Unselect All	Select the checkbox to select all of the reports in the Report/Resource list below for installation. Clear it to clear all of the selections in the list. Note: If this option is not available, this means that the MRS Library has not yet been deployed on the machine. In this case, select Deploy MRSLibrary, and this option will become available.
   Report/Resource	Select the reports you want to deploy on the report server Note: If this option is not available, this means that the MRS Library has not yet been deployed on the machine. In this case, select Deploy MRSLibrary, and this option will become available.

2. Click Save. The system begins to deploy the reports on the report server, and the Progress window opens and shows information about the deployment process.

Licenses

For the system to process calls, enter the licenses you received from Genesys must be entered in the Licenses panel. The licenses are not included in the SpeechMiner installation folder.

To update the licenses:

1. Copy the text of the SpeechMiner license that was supplied.
2. In SMConfig, in the Licenses panel, paste the license text into the SpeechMiner License field.
3. Copy the text of the Nuance license that was supplied.
4. In SMConfig, in the Licenses panel, paste the license text into the Nuance License field.
5. Click Save.

Important

If the license texts are stored in separate files, as an alternative to the procedure described above, you can browse to locate the files. When you open the relevant file, its contents are automatically copied into the appropriate field.