Workbench IO Application Type

General Section

Workbench Application Name

Default Values: "WB_IO_Primary"
Valid Values: Any String name (i.e. "EMEA_WB_IO")
Changes Take Effect: Immediately
Description: The name of the Workbench IO (Karaf) Application

Elasticsearch Host

Default Values: The Hostname/IP Address of the Workbench Elasticsearch application
Valid Values: Valid Hostname/IP Address (i.e. "LAB-WB-VM1" or "10.20.30.40")
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The Hostname/IPv4 address of the Workbench Elasticseach application that this Workbench IO application is connecting to

ElasticSearch Port

Default Values: 9200 (or the port number given at custom installation time)
Valid Values: A valid and free port number (i.e. not used by other applications on the host)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The Port of the Workbench Elasticseach Applications that is used by this application

Warning

• Restart of Workbench Elasticsearch, Workbench_IO, Kibana, Logstash and Heartbeat required when this option is changed.
• Workbench Logstash components will need to be changed to this new port.

Elasticsearch Nodes

Default Values: #ES_NODES
Valid Values: Elasticsearch Nodes:Port (i.e. "WB1:9200,WB2:9200,WB3:9200"
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The list of Elasticsearch Nodes to use for clustering; please review section on Installing Additional Nodes

Warning

• Restart of Workbench Elasticsearch, Workbench_IO, Kibana, Logstash and Heartbeat required when this option is changed.
• Workbench Logstash components will need to be changed to this new port.

ZooKeeper Nodes

Default Values: <PRIMARY_NODE_HOSTNAME>:2181
Valid Values: ZooKeeper Nodes
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The list of ZooKeeper Nodes to use for clustering; please review section on Installing Additional Nodes

Workbench Application Type

Default Values: Workbench IO
Valid Values: Valid Workbench Application Type
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: Workbench Application Type

Workbench Version

Default Values: "9.x.xxx.xx"
Valid Values: WB Version
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The Workbench Application Version

Workbench HTTP Port

Default Values:

• For WB 9.0 to 9.2 - the default port is: 8182 (or the port number given at custom installation time)
  
• For WB 9.3 - the default port is: 8181 (or the port number given at custom installation time)
  

Valid Values: A valid and free Port number (i.e. not used by other applications on the host)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description:
For WB 9.0 to 9.2 - used for integration from the Kibana Http Port
For WB 9.3 - the main UI port at which Workbench Users connect via their Chrome browser

Associated Workbench Agent Application

Default Values: "WB_Agent_Primary"
Valid Values: Name of associated Workbench Agent application
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The name of the Workbench Agent associated with this application/host

Data-Center

Default Values: default
Valid Values: Read-Only
Changes Take Effect: Aftern Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The name of the Data-Centre associated with this application; a prepatory setting that will evolve in WB 9.x

Host Name

Default Values: Hostname of the Workbench IO application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The Hostname of the host where this Workbench IO application is running

Host IP Address

Default Values: IP Address of the Workbench IO application associated host (i.e. "10.20.30.40")
Valid Values: Valid IP address
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The IPv4 Address of the host where this Workbench IO application is running

Host Time-Zone

Default Values: Time-Zone of the Workbench IO application associated host (i.e. "Europe/London")
Valid Values: Valid Host Time-Zone
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: The Time-Zone of the host where this Workbench IO application is running

Deployment Section

Installation Directory

Default Values: "<WORKBENCH_HOME>\Karaf"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.1.0000.00\Karaf")
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: Absolute path of the folder where this application is installed

Configuration Directory

Default Values: "<WORKBENCH_HOME>\Karaf\etc"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.1.0000.00\Karaf\etc")
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") startup
Description: Absolute path of the folder where the configuration file of this application is located

Logging Section

Log Level

Default Values: INFO
Valid Values: ALL, INFO, DEBUG, ERROR, WARNING, FATAL, TRACE, OFF
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Application/Component Logging Level (e.g. INFO or DEBUG)

Log File Location

Default Values:<WORKBENCH_HOME>\Karaf\data\log
Valid Values: Valid Path (i.e. "C:\Program Files\Workbench_9.1.0000.00\Karaf\data\log")
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Absolute path of the folder where the Workbench IO application log file is located

Segment (MB)

Default Values: 10
Valid Values: Valid positive integer
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Maximum size of the log file before it is rotated/cycled

Expire

Default Values: 10
Valid Values: Valid positive integer
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Maximum count of log files before rotated/cycled

Genesys Engage Integration - Configuration Server

Primary/CSProxy Configuration Server Host Name or IP Address

Default Values: Hostname/IP Address of the Genesys Engage Configuration Server (CS) provided during Workbench installation
Valid Values: Valid Hostname/IP Address
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Hostname/IPv4 address of the Genesys Engage Configuration Server that is used by the Workbench IO application

Primary/CSProxy Configuration Server Port

Default Values: Port number of Genesys Engage Configuration Server given during installation time (i.e. 2020)
Valid Values: Valid positive integer (i.e. not used in other application)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Port of the Genesys Engage Configuration Server that is used by the Workbench IO application

Genesys Engage Workbench Client Application Name

Default Values: Workbench Client Application name in the Genesys Engage Configuration Server provided during Workbench installation
Valid Values: The correct Genesys Engage Workbench Client Application name created prior to Workbench installation (i.e. WB9Client)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The Genesys Engage "Workbench Client" application name; this has to be configured in Genesys Engage prior to Workbench installation

Genesys Engage Workbench Server Application Name

Default Values: Workbench Server Application name in the Genesys Engage Configuration Server provided during Workbench installation
Valid Values: The correct Genesys Engage Workbench IO (Server) Application name created prior to Workbench installation (i.e. WB9IO)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The Genesys Engage "Workbench Server" application name; this has to be configured in Genesys Engage prior to Workbench installation

Genesys Engage Integration - Message Server(s)

Enabled

Default Values: Enabled
Valid Values: Enabled/Disabled
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Determines if Workbench IO connects to the Genesys Engage Message Servers; if not Changes Console "ChangedBy" field will be "N/A"

Genesys Engage Message Server Application(s)

Default Values:
Valid Values: Valid String: The correct Genesys Engage Log Message Application name (i.e. "log_message_server")
Changes Take Effect: After IO application (i.e. "WB_IO_Primary") restart
Description: Genesys Engage Message Server application name to which Workbench will connect for Changes ChangedBy metadata information

Genesys Engage Integration - Solution Control Server (SCS)

Genesys Engage Solution Control Server Application

Default Values: The selected Genesys Engage Solution Control Server application provided during Workbench installation
Valid Values: Valid String: The correct Genesys Engage Solution Control Server (SCS) application name (i.e. "emea_scs_primary")
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Genesys Engage Solution Control Server application name to which Workbench will connect for Genesys Engage Alarm integration

Remote Alarm Monitoring (RAM) Service

Enabled

Default Values:
Valid Values: True/False
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Is Remote Alarm Monitoring enabled; only enable if/when a RAM license has been received from Genesys Customer Care

End User ID

Default Values:default
Valid Values: The RAM End User ID/License Key received from Genesys
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: The End User ID (License Key) allocated to the customer by Genesys Customer Care

Origin

Default Values:default
Valid Values: Valid String)
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: A descriptive region/location/data-center name of the where the Workbench is installed (i.e. EMEA, APAC, Chicago)

Customer Name

Default Values:
Valid Values: Obtained automatically via Workbench to RAM communication
Changes Take Effect: After valid RAM License Activation and Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Customer Name

License Expiration Time (ms)

Default Values:0
Valid Values: Epoch Milliseconds
Changes Take Effect: Post every (20 minutes) Workbench to RAM keep-alive
Description: RAM license Expiration time in epoch milliseconds

Management Diagnostics

SSH Enabled

Default Values:
Valid Values: True/False
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Is Secure Access enabled/disabled

SSH Port

Default Values:8101
Valid Values: Valid free positive integer Port number
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Secure access Port number where the SSHd server is bound

Workbench Distributed Mode

Remote WB Primary ZooKeeper

Default Values:#REMOTE_ZK_Address Host:Port#
Valid Values: <ZK_IP:ZK_PORT>
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Is Secure Access enabled/disabled

TLS Enabled

Default Values:false
Valid Values: false/true
Changes Take Effect: After Workbench IO application (i.e. "WB_IO_Primary") restart
Description: Secure the Workbench IO to Workbench IO application communication