Installing and Using the Administrator Plugin

Installing the Knowledge Center Plugin for Administrator

Prerequisites

• Genesys Administrator must have been installed, but should be stopped before installing the plugin
• If the Administrator Plugin was previously installed on the current host, manually remove the previous version from the /plug-ins folder in the Genesys Administrator installation directory

Windows Installation Procedure

Start

1. In your installation package, locate and double-click the setup.exe file. Install Shield opens its welcome screen.

Knowledge Center Administrator Plugin Install Shield Window

2. Click Next. The Choose Destination Location screen appears.

Knowledge Center Administrator Plugin Destination Window

3. Under Destination Folder, keep the default value or browse to the desired installation location. Click Next.
4. Click Install. The Genesys Installation Wizard indicates it is performing the requested operation for the Backend Server. When it has finished, the Installation Complete screen appears.

Knowledge Center Administrator Plugin Installation Complete

5. Click Finish to complete your installation.
6. Inspect the directory tree of your system to make sure that the files have been installed in the location that you intended.
7. gax-plugin-knowledge.jar should be added as a Genesys Administrator plugin.
8. Restart Genesys Administrator.

End

Linux Installation Procedure

Start

1. Open a terminal in the Genesys Knowledge Center Plugin for Administrator IP, and run the install.sh file. The Genesys Installation starts.
2. Enter full path to the GAX installation directory.
3. Enter full path to your installation directory for the plugin and confirm it.
4. If the installation is successful, the console displays the following message: Installation of Genesys Knowledge Center Plugin for Administrator, version 8.5.x has completed successfully.
5. gax-plugin-knowledge.jar should be added as a Genesys Administrator plugin.
6. Restart Genesys Administrator.

End

A Knowledge Center item should appear under the Administration menu.

Knowledge Center in Administrator Menu

Providing access to Knowledge Center Plugin for Administrator

Important

Users must have the next privilege in order to use the Administrator plugin.

• Knowledge. ADMINISTER — Enables access to the Knowledge Center Plugin for Administrator tab in Genesys Administrator

To configure the appropriate role for an agent:

Start

1. Go to Provisioning > Environment > Application Templates.
2. In the Tasks panel, click Upload Template.
3. In the Click 'Add' and choose application template (APD) file to import window, click Add.
4. Choose the application template (APD) file from the import window and click Add.
5. Browse to the Knowledge_Center_GAX_Plugin_850.apd file available in the templates directory of your installation CD. The New Application Template panel opens.
6. Click Import Metadata.
7. Click Add and select the Knowledge_Center_GAX_Plugin_850.xml file.
8. Click Open.
9. Information from the metadata file will be added to the template and the appropriate privilege will be added into the framework.
10. Save and Close.
11. Go to Provisioning > Accounts > Roles.
12. In the taskbar click New to create a new object.
13. Set the name of the role in the General section.
14. Go to the Role Privileges tab, and select the set of roles for Genesys Knowledge Center.
15. Open the Genesys Administrator privileges list and select the Genesys Knowledge Center Plug-In Privileges section.
16. Set the appropriate privileges as allowed.
17. Go back to the Configuration tab.
18. Add the appropriate Agent to the Members section by clicking the Add button.
19. Save and Close.

End

Managing Knowledge Bases

In order to use Knowledge Center Server you need to create at least one knowledge base in the Knowledge Center Cluster application, using the Knowledge Center Plugin for Administrator. This section describes the structure and specific options you need in order to create an index for this knowledge base in Knowledge Center Server.

Selecting the Knowledge Center Cluster Application

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges

Start

1. Log in to Genesys Administrator and navigate to the Administration > Knowledge Center menu item.
2. Using the button, open the menu for Select Knowledge Cluster. Select the appropriate cluster from the drop-down and click the Ok button. A list of the knowledge bases that have been defined for this cluster will be displayed.

Selecting a Knowledge Cluster

End

Creating a Knowledge Base

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application

Start

1. Click the + button. A panel with the main knowledge base parameters will be displayed. Fill in the following fields:
   • ID—The ID should only contain numbers, lower-case Latin letters, and underscores, with a maximum length of 50 characters. The limitation to lower-case letters is because ElasticSearch is case-insensitive and will therefore render all names as lower-case.
   • Name—Maximum length is characters
   • Description—optional
   • Select the default knowledge base language.
   • Make the knowledge base public or private. (If the knowledge base is made public, it will be visible to all users, whether or not they are authorized.)
   • Make the knowledge base active or inactive. (If the knowledge base is made inactive, the knowledge base will be hidden from active users.)

Creating a Knowledge Base

2. Click Save. The knowledge base will be created.

End

Creating Custom Fields

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application
• You must create and select a knowledge base definition

Start

1. Click the + sign under the Custom Fields section. The New Custom Field panel will be displayed.

Creating a Custom Field

2. To define a custom field, fill in the following information:

• Name—Should consist only of numbers, Latin letters and underscores, with a maximum length of 50 characters.
• Display name
• Select the type of field
• For String fields define:
• Default value (optional)
• If the field can be left empty, set the check box to Allow empty
• For Numeric fields define:
• Default value (optional)
• Minimum value (optional)
• Maximum value (optional)
• For DateTime fields define:
• Default value (optional; format should be yyyy-MM-dd HH:mm:ss)

Click Save to save your changes.

End

Adding Language-specific Information

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application
• You must create and select a knowledge base definition

Start

1. Click the English, default row in the Languages section. A panel with language-specific settings will be displayed.

Adding Language-Specific Information

2. You can define the following parameters in this section:

• A localized knowledge base name
• A localized knowledge base description
• Whether or not the selected language is the default
• Default filter conditions

To create a default filter condition click on the + under the Default filter conditions section and fill in the appropriate mandatory fields:

• Select the appropriate field (custom or basic)
• Select a filter operator
• Fill in the values for the filter criteria

Important

All filter criteria are applied using AND logic. For example, CreatedDate>2014-01-01 00:00:00 AND Segment=="VIP".

Default Filter

4. Click the Save button

End

Editing Knowledge Base Options

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application
• You must create and select a knowledge base definition

Start

1. To edit the options for a particular knowledge base, click the Options button and then click the appropriate option to edit its value. The options are initialized with their default values.

Editing Knowledge Base Options

2. Enter the new option value and click the Save button.

End

Important

It is not recommended to set the out-of-domain value higher than 0.75 as it represents an exact match of the question with no feedback accumulated for the query. The optional setting is 0.5 (default value).

Editing a Knowledge Base Definition

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application

Start

1. Select a knowledge base from the list.

Editing Knowledge Base Definition

2. Edit the knowledge base definition and click the Save button.

End

Deleting a Knowledge Base Definition

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application
• You must have created a knowledge base definition

Start

1. Select a knowledge base from the list.
2. Press the Delete button and confirm the action.

End

Purging Knowledge Bases

Prerequisites

• The Administrator user must have Knowledge.ADMINISTER privileges
• You must create and select a Knowledge Center Cluster application

Start

1. To purge a particular knowledge base, select it from the list, press the Purge button, and confirm the action.

Purging a Knowledge Base

2. To purge all knowledge bases, use the Purge All button.

End