Revision as of 19:38, August 13, 2018 by Jokane (talk | contribs) (Update with the copy of version: DRAFT)
Jump to: navigation, search

Privacy Manager

The full name of this component is Privacy Manager Plug-in for GAX.

Deploying Privacy Manager

Prerequisites

  • Privacy Manager 8.5.1
    • Genesys Administrator Extension (GAX) 8.5.210.14 or later
    • UCS 8.5.200.08 or later
    • Classification Server 8.5.110.03 or later
    • If a previous version of Privacy Manager was installed on the current host, uninstall that version.
  • Privacy Manager 8.5.3
    • Genesys Administrator Extension (GAX) 8.5.240.19 or later
    • UCS 8.5.200.19 or later
    • UCS Proxy 8.5.100.04 or later.
    • Classification Server 8.5.200.05 or later
    • If a previous version of Privacy Manager was installed on the current host, uninstall that version.
Important
One UCS instance can support multiple tenants in Privacy Manager, and each tenant's data is stored separately from other tenants. The graphic below shows two tenants (Environment and Tenant_extra) using one UCS instance (ContactServer_852_2). The Environment tenant has data that is not accessible in the Tenant_extra tenant.
ES Admin PM853 MultiUCS.png

Create a Zip File

  1. Create a temporary folder on your desktop.
  2. Copy the IP folder from the original location (typically, the product CD) into the temporary folder.
  3. Copy the templates folder from the original location into the temporary folder.
  4. Zip the temporary folder.

Alternatively, contact Genesys Customer Care to obtain the required Zip file containing the installation package and associated templates.

Install with the GAX Installation Wizard

  1. Add the following option to the Application Options tab of the Genesys Administrator Extension (GAX) Application object on the host:
    Section name: asd
    Option name: plugin_ip_list
    Option value: PrivacyMng64 (Windows host) or PrivacyMng (Linux host)
    Tip
    This option is also used by eServices Manager Plug-in for GAX and Content Analyzer Plug-in for GAX. If you are running both eServices Manager and Content Analyzer with Privacy Manager, the value can be a comma-separated list; for example, eSMngrPlgnAdm,PrivacyMng,CntAnlzPlgnAdm
  2. Restart GAX.
  3. Upload the Privacy Manager installation package (IP). If you previously uploaded the IP, do so again.
  4. Carry out the plug-in installation process. To uninstall Privacy Manager, use the general procedure for removing a plug-in.
  5. Restart GAX.

Configuring Privacy Manager

In Genesys Administrator Extension,

  1. Create a Privacy Manager Application with the type Application Cluster.
  2. Add tenants to Privacy Manager Application.
  3. Specify the Host and Port. The Application Cluster application object and the GAX application must be configured with the same host in order to enable mutual TLS connections.
  4. Connect the Privacy Manager Application to UCS and Classification Server.
  5. Configure these connections: TLS, ADDP, and so on.
  6. Do one of the following:
    • For Privacy Manager 8.5.1:
      1. Navigate to the GAX Application object's privacy-manager-plugin section.
      2. For the app-name value, specify the Privacy Manager Application name.
    • For Privacy Manager 8.5.3:
      1. Navigate to the GAX Application object's gax-privacy-manager section.
      2. For the app-name value, specify the Privacy Manager Application name.
      3. For the file-storage-path value, specify where you want Privacy Manager to create its temporary files.
  7. If you need multi-language support, set the UTF-8 JVM parameter for all Java components (UCS, GAX Server, Browser) in the corresponding .ini file (or .bat file if you start the component from command line):
    • ini file: [JavaArgs] -Dfile.encoding=UTF-8 ...
    • bat file: set JAVA_OPTS=%JAVA_OPTS% -Dfile.encoding=UTF-8 ...
  8. Restart GAX.

Role-Based Access Control

Privacy Manager uses role privileges to control user access to various functions. Refer to the section below that corresponds to your environment.

Privacy Manager 8.5.1

To grant a user access to the GAX menu and Privacy Manager Plug-in for GAX, assign the following privileges to the users in GAX:

  • COM/Access Configmanager—Allows user to access Configuration Manager in GAX.
  • privacy-manager-plugin/Privacy Manager Plug-in for GAX Access—Allows user to access Privacy Manager.

You can also use the privilege Regex Access to control access to the regular expressions. Users without that privilege cannot see the RegEx tab and cannot create or edit regular expressions.

Roles in Privacy Manager 8.5.3

To grant a user access to the GAX menu and Privacy Manager Plug-in for GAX, assign the following privileges to the users in GAX:

  • COM/Access Configmanager—Allows user to access Configuration Manager in GAX.
  • gax-privacy-manager/Privacy Manager Plug-in for GAX Access—Allows user to access Privacy Manager.

In Privacy Manager 8.5.3, you can also assign the following gax-privacy-manager role privileges to users:

  • Import/Export Access—Allows user to access the import and export buttons.
  • Regex Access Create—Allows user to create RegEx rules.
  • Regex Access Delete—Allows user to delete RegEx rules.
  • Regex Access Edit—Allows user to edit RegEx rules.
  • Regex Access—Allows user to access the RegEx tab.
  • Rule Access Create—Allows user to create chat and email rules.
  • Rule Access Delete—Allows user to delete chat and email rules.
  • Rule Access Edit—Allows user to edit chat and email rules.

You might need a combination of role privileges to accomplish certain tasks. See the tables below for examples.

Import and Export

Task Required role privileges
Export
  • Import/Export Access
  • Regex Access
Import
  • Import/Export Access
  • Rule Access Create
  • Regex Access
  • Regex Access Create

Test rules with ability to create new tests

Task Required role privileges
Test new chat/email rule
  • Rule Access Create
  • Regex Access
  • At least one of the following:
    • Regex Access Create
    • Regex Access Edit
Test existing chat/email rule
  • Rule Access Edit
  • Regex Access
  • At least one of the following:
    • Regex Access Create
    • Regex Access Edit
Test new RegEx rule
  • Regex Access
  • Regex Access Create
Test existing RegEx rule
  • Regex Access
  • Regex Access Edit

Test chat/email rules without ability to create new tests

Task Required role privileges
Test new chat/email rule Rule Access Create
Test existing chat/email rule Rule Access Edit

Initialize a UCS database

You must initialize a UCS database if it has not been previously used with Privacy Manager. If the UCS database has not been initialized, Privacy Manager displays a warning message:

ES Admin PM853 Initialize.png

You can initialize the database by clicking Initialize. However, to access the Initialize button, you must have the following role privileges:

  • Rule Access Create
  • Regex Access
  • Regex Access Create

Using Privacy Manager

Starting

  1. In GAX Configuration Manager, go to eServices and select Privacy Manager.
  2. Do one of the following steps:
    1. For 8.5.1 releases and lower, select a UCS. The main Privacy Manager window displays.
    2. For 8.5.3 releases and higher, you can select a UCS and tenant to use with Privacy Manager.

ES Admin PM853 UI.png

Tip
Privacy Manager is designed to be viewed at a minimum screen resolution of 1280х1024, or a full HD resolution of 1920x1080.

Creating or Editing a Rule

  • To create a rule, click New.
  • To edit an existing rule, click the rule name or the Edit icon.

The window that opens is titled either New Rule/Test Rule or Edit Rule/Test Rule, but in either case the fields and functionality are identical.

New Rule, Edit Rule, Test Rule

Note the following:

  • For RegEx, you can either select one of the ready-made regular expressions or open the RegEx Create/Edit window to create a new one.
  • For Priority, 1 is the first (highest) priority, 2 is next, and so on.
Important
Although it is possible to assign the same priority to multiple rules in the same group, Genesys recommends against doing so.

Testing a Rule

The right-hand pane of the edit/create window allows you to test a rule.

  • Test message is text that you will try applying the rule to. You can select a ready-made test message or write your own.
  • Click Test to run the rule on the test message. The results appear in Test Result.

Creating, Editing, and Testing RegExes

  • To create a RegEx,
    • Click New on the RegEx tab, or
    • Click New next to the RegEx field in the New Rule/Edit Rule window.
  • To edit a RegEx, click its Edit icon on the RegEx tab.
New RegEx/Test RegEx
  • Testing RegExes works in the same way as testing rules.

Importing and exporting rules

Important
  • This feature is only available in 8.5.3 releases and higher.
  • Your account must have sufficient role privileges to use this feature. Refer to the Role-Based Access Control section for more information.

You can export and import rule sets as JSON files. This is useful if you want to copy a rule set to another instance of Privacy Manager.

To export a rule set, click ES Admin PM853 Export.png. Privacy Manager prepares the JSON file for export. Click Download to save the JSON file to your computer.

To import a rule set, click ES Admin PM853 Import.png. Select a JSON file and click Import.

Privacy Manager does not overwrite existing rules when you import a rule set. For example, if you import a rule set and a rule name matches one that already exists, Privacy Manager appends Copy_1_of_ to the imported rule name (for example, Credit Card rule for Chat becomes Copy_1_of_Credit Card rule for Chat).

Limitations

Genesys recommends that you observe the following limits:

  • RegEx: no more than 400 per Tenant
  • Test Messages per RegEx: no more than 20
  • Rules per Group: no more than 200
Comments or questions about this documentation? Contact us for support!