Welcome to the Genesys
Product Support Center

Workbench Host/Server Operating System requirements

Workbench 9.x comprises several components; a network Admin-level account is required that has Full Control permissions for all Workbench application related folders.

WARNING

• The Workbench Primary and Additional (e.g., Node2 and Node3) hosts/nodes (across ALL Data-Centers) should all be running the same Operating System.
• Workbench uses the Hostname for component configuration
• Please ensure DNS hostname resolution between the Workbench Hosts and the Engage Hosts is accurate and robust
• If the Workbench Hosts have multiple NIC's, please ensure the Hostname resolves to the desired IP Address prior to Workbench installation
• Workbench 9.x is limited to a maximum of 100 Hosts (the global combined Workbench or Engage Hosts), due to delays in loading the Configuration Host and Application objects/details; this limitation will be addressed in the next release of Workbench.

Supported browsers

• Google Chrome

Workbench 9 to Engage integration

Genesys recommends Engage Configuration Server, Solution Control Server, Message Server and SIP Server versions of 8.5+.

WARNING

• If your Engage Configuration Servers are configured for HA, please ensure the respective CME Host Objects have the IP Address field configured, else Workbench will fail to install.
• Ensure each and every Engage CME Application has an assigned Template else the Workbench installation will fail.
• Genesys support for the platform versions mentioned on this page ends when the respective vendors declare End of Support.

WARNING

• Currently Workbench Agent 9.x uses Port 5067 - this unfortunately clashes with GVP - if your Genesys deployment contains GVP please change the Workbench Agent(s) Port (e.g., to 5068) and restart the Workbench Agent(s) and Workbench Logstash(s) components.
  • This oversight will be addressed in a future Workbench 9.x release

Java requirements

Workbench 9.x ships/installs with a pre-bundled OpenJDK 11 package, therefore the historical JRE is not mandatory.

NOTE:

• the Workbench Agent that gets installed on the Workbench Nodes/Hosts utilizes the pre-bundled OpenJDK 11 package
• the Workbench Agent (Remote, WAR) that's installed on “remote” Nodes/Hosts (i.e. SIP, URS, FWK etc) is Go based and therefore does not rely on either OpenJDK or the historical JRE packages

WARNING

• If the JAVA_OPTS settings are changed, ensure the xms and xmx values are different; if the values are the same issues will be encountered when starting Logstash

Network ports - Workbench hosts

Workbench components use the network ports below, from a firewall perspective, please review, edit and ensure not already in use.

WARNING

• Double-check, these network ports below, that are used by Workbench, are from a firewall perspective, open and not already in use by other applications

Workbench Host Ports (i.e. the Primary, Node 2, Node 3, Node N etc hosts)

Network ports - Non-Workbench hosts (e.g., SIP, URS, FWK, etc.)

NOTE: The ports below can be edited via the Workbench Configuration Console through the respective Workbench application object

WARNING: Ensure the Ports are reviewed, edited, opened and not in use prior to starting the Workbench installation

• Workbench Agent/Metricbeat installed on the Genesys Application Servers will send metric data to the local WB Data-Center instance/Cluster

Hardware sizing requirements

Please review What hardware size should I use for Workbench.

Linux pre-installation steps

For Linux based installations, some Operational System settings are required to enable support of Elastic Search, a key components of Workbench 9.

1. Run the command:
   • ulimit -a
2. This should print something like the following:
        bash-4.2$ ulimit -a
        core file size (blocks, -c) 0
        data seg size (kbytes, -d) unlimited
        scheduling priority (-e) 0
        file size (blocks, -f) unlimited
        pending signals (-i) 31152
        max locked memory (kbytes, -l) 64
        max memory size (kbytes, -m) unlimited
        open files (-n) 8192
        pipe size (512 bytes, -p) 8
        POSIX message queues (bytes, -q) 819200
        real-time priority (-r) 0
        stack size (kbytes, -s) 8192
        cpu time (seconds, -t) unlimited
        max user processes (-u) 4096
        virtual memory (kbytes, -v) unlimited
        file locks (-x) unlimited
3. Make the following changes:
   1. Run the command
      • sudo vi /etc/security/limits.con
   2. Add the following lines to the bottom. <username> is the current username.
      • <username> - nofile 131070
      • <username> - nproc 8192
      • <username> - memlock unlimited
   3. Logout and log back in.
   4. Run the command:
      • sudo sysctl -w vm.max_map_count=262144
   5. Run the command:
      • sudo vi /etc/sysctl.conf
   6. Add the line vm.max_map_count=262144 to the bottom.
3. Exit the current terminal window and open a new one.
4. Run the command:
   • ulimit -a
5. This should print something like the following:
        bash-4.2$ ulimit -a
        core file size (blocks, -c) 0
        data seg size (kbytes, -d) unlimited
        scheduling priority (-e) 0
        file size (blocks, -f) unlimited
        pending signals (-i) 31152
        max locked memory (kbytes, -l) 64
        max memory size (kbytes, -m) unlimited
        open files (-n) 131070
        pipe size (512 bytes, -p) 8
        POSIX message queues (bytes, -q) 819200
        real-time priority (-r) 0
        stack size (kbytes, -s) 8192
        cpu time (seconds, -t) unlimited
        max user processes (-u) 8192
        virtual memory (kbytes, -v) unlimited
        file locks (-x) unlimited
4. Verify the following values match:
   • max user processes=8192
   • open files=131070

RHEL 7.x - specific steps

The following change is needed only for machines running Red Hat Enterprise Linux Server release 7.x.

For the Workbench services to start correctly after a machine reboot, it is necessary to run the following commands:

1. Type:
   • sudo visudo
2. Press Enter.
3. Enter the sudo password when prompted.
4. Change the line Defaults requiretty in the opened file to:
   • #Defaults requiretty
5. Type:
   • :wq
6. Press Enter to save the changes and exit.

Alternatively, upon reboot of the machine, these services can be manually started in the following sequence:

• service WB_Elasticsearch_9.1.000.00 start
• service WB_ZooKeeper_9.1.000.00 start
• service WB_Kibana_9.1.000.00 start
• service WB_Agent_9.1.000.00 start
• service WB_IO_9.1.000.00 start