Jump to: navigation, search

Workbench Server

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

  • For Linux: /templates
  • For Windows: \templates


Note: For successful Workbench installation, the System account for the Workbench Server application must have Full Control so it can add keys to the General section of configuration options.


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, 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 to 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. In the General tab, enter a name for the Workbench Server application in the Name field.
    2. Click on the Template field and navigate to the application template created in the previous steps.
    3. In the Connections section, click Add and navigate to the Workbench Log Extractor application(s) from which you want to get log files to be used in Log Analysis. You may add all of the Workbench Log Extractor applications at this step. This can be updated at any point, but will require a Workbench restart to take effect.
    4. In the Working Directory field, enter the destination folder of the Workbench Server, including a trailing slash.
      1. Linux example: /home/genesys/wb/
      2. Windows example: C:\Program Files\genesys\wb\
    5. In the Command Line field, enter one of the following:
      1. On Linux: ./monitor_startup.sh
      2. On Windows: monitor_startup.bat
    6. In the Command Line Arguments field, enter -app <Name of Workbench Server App> -host <Configuration Server Host> -port <Configuration Server Port>.
    7. In the Host field, select the host where Workbench Server will be installed.
    8. In the Options tab, review and configure the Workbench Server options. See the Workbench Server Configuration section for details.
    9. In the Ports tab, add the following listening ports. See the Workbench Server Configuration section for details.
      1. data_collection_controller_port
      2. default
      3. ftmessaging
      4. messaging_remote
  11. In the Connections section, click Add and navigate to the Solution Control Server you wish the workbench server to use for its operations. Workbench will automatically use the backup Solution Control Server if one has been configured.
  12. Click Save to save the new application


Installing the Workbench Server on Linux

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

Note: 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). This is the IP address the database will use to listen for connections. Change it to the actual IP address of the machine where you are installing Workbench in case 127.0.0.1 is not allowed on your environment. 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. Press Enter without typing any value to use the default.
  8. Review the default values for 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 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)
  9. (Optional) Configure Genesys Remote Alarm Monitoring:
    1. Enter your Genesys Remote Alarm Monitoring License Key provided by Genesys Customer Care. (See note below.)
    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.
    3. Click Next.
  10. On the Installation Progress screen, click Install. To see the installation progress, click Show Details.
  11. (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.
  12. (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.
  13. On the Installation Complete screen, click Finish.
  14. Start the Workbench Server application in Genesys Administrator Extension.
Important

To activate a Remote Alarm Monitoring License Key after you have installed Workbench:

  1. Edit the Workbench_Server application object in Genesys Administrator Extension (or Genesys Administrator or Configuration Manager).
  2. In the General section of the configuration options, enter the License Key in the end_user_id option.

Installing the Workbench Server on Windows

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

Note: 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). This is the IP address the database will use to listen for connections. Change it to the actual IP address of the machine where you are installing Workbench in case 127.0.0.1 is not allowed on your environment. 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.
  8. Review the default values for the following ports for possible port conflicts, and modify as required. Then click Next. See Database Options 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)
  9. (Optional) Configure Genesys Remote Alarm Monitoring
    1. Enter your Genesys Remote Alarm Monitoring License Key provided by Genesys Customer Care. (See note below.)
    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.
    3. Click Next.
  10. On the Installation Progress screen, click Install. To see the installation progress, click Show Details.
  11. (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.
  12. (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.
  13. On the Installation Complete screen, click Finish.
  14. Start the Workbench Server application in Genesys Administrator Extension.
Important

To activate a Remote Alarm Monitoring License Key after you have installed Workbench:

  1. Edit the Workbench_Server application object in Genesys Administrator Extension (or Genesys Administrator or Configuration Manager).
  2. In the General section of the configuration options, enter the License Key in the end_user_id option.

Database Options

Database Transport Port

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


Database Internode Port

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


Database JMX Port

  • Default Value: 7199
  • Valid Values: Any port that is available for connections.
  • Port used to monitor and stop Cassandra.
This page was last modified on February 23, 2018, at 07:37.

Feedback

Comment on this article:

blog comments powered by Disqus