Jump to: navigation, search

Workbench Server

The Workbench Server collects data from multiple sources including Configuration Server, Solution Control Server, and other Genesys applications. It then analyzes the data and sends useful information about system and application health and areas pinpointed for potential troubleshooting to the Workbench Client.

The following directories in the Workbench installation package contains the Workbench Server templates:

  • For Linux: /templates
  • For Windows: \templates
Important
For successful Workbench installation, the system account of the Workbench Server application must have full control so it can add keys to the General section of the configuration options of the Workbench Server Object.

Provisioning

Provisioning the Workbench Server in Genesys Administrator Extension 8.5

  1. Log into GAX, and navigate to Configuration Manager.
  2. In the Environment section, select Application Templates.
  3. In the Application Templates section, select New.
  4. In the New Properties pane, select Import Application Template.
  5. In the Import Application Template dialog box, click the Choose File button and navigate to the WorkbenchServer.apd template. Select the template, and click OK to confirm the template import.
  6. In the New Properties pane, click Save to save the new application template.
  7. Once the application template has been imported, navigate back to the Configuration Manager.
  8. In the Environment section, select Applications.
  9. In the Applications section, select New.
  10. In the New Properties pane, complete the following:
    1. Open the General tab. In the Name field, enter a name for the Workbench Server application.
    2. Click on the Template field and navigate to the application template created in the previous steps.
    3. In the Working Directory field, enter the destination folder of the Workbench Server, including a trailing slash.
      • Linux example: /home/genesys/wb/
      • Windows example: C:\Program Files\genesys\wb\
    4. In the Command Line field, enter one of the following:
      • On Linux: ./monitor_startup.sh
      • On Windows: monitor_startup.bat
    5. In the Command Line Arguments field, enter -app -host -port -backuphost -backupport .
    6. In the Host field, select the host where Workbench Server will be installed.
    7. In the Options tab, review and configure the Workbench Server options. See the Workbench Server Configuration section for details.
    8. In the Ports tab, add the following listening ports. See the Workbench Server Configuration section for details.
      • data_collection_controller_port
      • default
      • ftmessaging
      • messaging_remote
  1. In the Connections tab, click the Add icon to establish connections to the following applications:
    1. The Solution Control Server you wish the Workbench Server should use for its operations. Workbench will automatically use the backup Solution Control Server if one has been configured.
    2. The Workbench Log Extractor application(s) from which you want to get log files to use in the Log Analysis. This can be updated at any point, but will require a Workbench restart to take effect.
    3. (Optional) The primary or proxy Configuration Server from which the configuration settings will be retrieved. This is only required if connecting to Configuration Server via TLS. See the Genesys Security Deployment Guide for further instructions. Note: The security certificates must be generated using the SHA-2 secure hash algorithm.
  1. Click Save to save the new application.
Tip
To enable user access to the Login Attempts audit report, you need to use Genesys Administrator to provision the metadata from the WorkbenchServer.apd application template. See "Enabling Login Attempts Report in Genesys Administrator" for the details.

Installing the Workbench Server on Linux

The /installers directory in the Workbench installation package contains the Workbench Server installation package for Linux. 

Important
These instructions assume you are using Genesys Administrator Extension 8.5.x. If you are using older Genesys configuration software, such as Genesys Administrator or Configuration Manager, the configuration steps and the locations of configuration options will differ in some places.
  1. In the directory to which the Workbench Server installation package was copied, execute the install script by running the following command; java -jar <wbInstaller-x.jar> where <wbInstaller-x.jar> should be replaced with the file name of the version you are installing. For example: java -jar wbInstaller-8.5.000.00.jar
  2. On the Welcome screen, press Enter to continue.
  3. Read the Genesys Terms and Conditions, and enter Y to accept.
  4. Enter the Workbench Server installation directory and click Next.
  5. Enter the Host name and Port of the Primary Configuration Server.
  6. Enter the names of the Workbench Client and Workbench Server applications as defined in Configuration Server. Click Next.
  7. Enter a value for the Database IP Address (default: 127.0.0.1). The database will use this IP address to listen to the connections. If the default Database IP Address (127.0.0.1) is not allowed on your environment, change it to the actual IP address of the machine where you are installing Workbench. Press Enter without typing any value to use the default.
  8. Important
    For this release we do not recommend connecting to a Cassandra instance other than the one that will be locally configured by the Workbench installer.
  9. Review the default values of the following ports for possible port conflicts, and modify as required. Then press Enter without typing any value on each of these ports to use the default values. See Database Options Set During Installation for more information about how these ports are used.
    1. Database Transport Port (default: 9042)
    2. Database Internode Port (default: 7000)
    3. Database JMX Port (default: 7199)
  1. (Optional) Configure Genesys Remote Alarm Monitoring:
    1. Enter your Genesys Remote Alarm Monitoring License Key provided by Genesys Customer Care. (See Activating a Remote Alarm Monitoring License for important instructions.)
    2. Enter your Genesys Remote Alarm Monitoring Site Name. This is a name of your choice that will be used to identify your Genesys production environment when alarms are delivered by Workbench to your Mobile App and to the Genesys Customer Care team. (See Activating a Remote Alarm Monitoring License for important instructions.)
    3. Press Enter.
  1. The installation progress is shown on the console.
  2. (Optional) Capture the installation output log:
    1. Select all the console output and copy it.
    2. Save the console text to a file.
  1. Once the installation is complete, you can use the Workbench Server application from the Genesys Administrator Extension.

Installing the Workbench Server on Windows

The \installers directory in the Workbench installation package contains the Workbench Server installation package for Windows. 

Important
These instructions assume you are using Genesys Administrator Extension 8.5.x. If you are using older Genesys configuration software, such as Genesys Administrator or Configuration Manager, the configuration steps and the locations of configuration options will differ in some places.
  1. In the directory to which the Workbench Server installation package was copied, double-click wbInstaller-x.jar to start the installation, where <wbInstaller-x.jar> represents the file name of the version you are installing.
  2. On the Welcome screen, click Next.
  3. Read the Genesys Terms and Conditions. Click Accept.
  4. Enter the Workbench Server installation directory and click Next.
  5. Enter the Host name and Port of the Primary Configuration Server.
  6. Enter the names of the Workbench Client and Workbench Server applications as defined in Configuration Server. Click Next.
  7. Enter a value for the Database IP Address (default: 127.0.0.1). The database will use this IP address to listen to the connections. If the Default Database IP Address (127.0.0.1) is not allowed on your environment, change it to the actual IP address of the machine where you are installing Workbench.
  8. Important
    For this release we do not recommend connecting to a Cassandra instance other than the one that will be locally configured by the Workbench installer.
  9. Review the default values of the following ports for possible port conflicts, and modify as required. Then click Next. See Database Options Set During Installation for more information about how these ports are used.
    1. Database Transport Port (default: 9042)
    2. Database Internode Port (default: 7000)
    3. Database JMX Port (default: 7199)
  1. (Optional) Configure Genesys Remote Alarm Monitoring
    1. Enter your Genesys Remote Alarm Monitoring License Key provided by Genesys Customer Care. (See Activating a Remote Alarm Monitoring License for important instructions.)
    2. Enter your Genesys Remote Alarm Monitoring Site Name. This is a name of your choice that will be used to identify your Genesys production environment when alarms are delivered by Workbench to your Mobile App and to the Genesys Customer Care team. (See Activating a Remote Alarm Monitoring License for important instructions.)
    3. Click Next.
  1. On the Installation Progress screen, click Install. To see the installation progress, click Show Details.
  2. (Optional) Capture the installation output log:
    1. Right-click on the Output tab of the installation dialog.
    2. Select Save Text.
    3. Specify a file name and folder, and click Save.
  1. (Optional) Capture the installation errors log:
    1. Right-click on the Errors tab of the installation dialog.
    2. Select Save Text.
    3. Specify a file name and folder, and click Save.
  1. On the Installation Complete screen, click Finish.
  2. Start the Workbench Server application in Genesys Administrator Extension.

Database Options Set During Installation

Database Transport Port

  • Default Value: 9042
  • Valid Values: Any port that is available for connections.
  • Use: The port where the Workbench Cassandra database will listen for connections.

Database Internode Port

  • Default Value: 7000
  • Valid Values: Any port that is available for connections.
  • Use: Port used during startup to ensure that the database cluster has only one node that is installed with the Workbench.

Database JMX Port

  • Default Value: 7199
  • Valid Values: Any port that is available for connections.
  • Use: Port used to monitor and stop Cassandra.

Activating a Remote Alarm Monitoring License

To activate the Remote Alarm Monitoring service during the initial Workbench installation, simply fill in the end_user_id and origin fields when prompted during the installation process.

Important
If you activate Remote Alarm Monitoring during the initial Workbench installation or later, please choose the origin value carefully. Any change to this value after the initial Workbench installation will disrupt metrics updates to heat maps, and all metrics data collected before this change will be lost. You will need to recreate all existing heat maps to restore metrics collection. Genesys recommends that you use a naming convention for origin like <node location_node name>. For example: EMEA_London Datacenter. the site name will be used to identify your Genesys production environment when alarms are delivered by Workbench to your Mobile App and to the Genesys customer support team

To activate a Remote Alarm Monitoring license key after you have installed Workbench, use these steps:

  1. From the folder <Workbench-Install-Folder>/karaf/etc, open the configuration file aml.psdk_client.cfg in a text editor.
  2. Enter your Remote Alarm Monitoring license key in the endUserId field. The format is endUserId=<your license key>.
  3. In the origin field, enter the site name. The format is origin=<your site name>. See the important note above on the origin value.
  4. Save the aml.psdk_client.cfg file.
  5. Login to Genesys Administrator Extension (GAX).
  6. Edit the Workbench_Server application object in GAX.
  7. In the Application Options tab, enter the license key in the end_user_id field.
  8. Enter the site name in the Origin field. The format is origin=<your site name>. See the important note above on the origin value.
  9. Restart Workbench through GAX.

Enabling Login Attempts Report in Genesys Administrator

Use these steps to enable user access to the Login Attempts Report in Genesys Administrator (GA). This report allows users with the Workbench Admin role to see an audit report of all attempted logins to Workbench.

  1. Login to Genesys Administrator, and select the Provisioning tab.
  2. Select Environment > Application Templates in the left navigation menu.
  3. Select the Workbench Server application template and click Edit.
  4. Click Import Metadata to import the metadata for the Workbench Server application template.
  5. Click Add on the “choose metadata XML file to import” dialog box.
  6. Select the wb-template-metadata.xml file and click Open. The file is uploaded.
  7. Click Save icon to save the metadata.
  8. Select Roles in the left navigation menu.
  9. Click New and add a name for this role. For example wb_admin.
  10. Select the Role Privileges tab. In the Add/Remove Product section, browse for the current Genesys Workbench release (such as Genesys Workbench 8.5.100.00) and select it. The Admin Access field is populated.
  11. Click Save in the top menu.
  12. In the Roles tab, select the wb_admin role and click Edit.
  13. In the Configuration tab, expand the Members section and click Add, to add this wb_admin role to the desired user profiles.
  14. In the list of user names, select one or more users and click Ok.
  15. The selected users will be displayed in the Members list of the wb_admin role, as enabled.
  16. Click Save in the top menu to save the member assignments to this role.

Once you have completed these steps, when a user with wb_admin role logs into Workbench, the Login Attempts Report item will appear under the User Settings drop down menu.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 17 July 2018, at 10:44.