Jump to: navigation, search

Workbench Server Options

This section contains options used to configure the Workbench Server Application object.

Application Options tab - general Section

This section of the Workbench Server Application Options tab is used to define general properties for the Workbench application and to activate a Remote Alarm Monitoring license.

This section must be called general.

end_user_id

Default Value: None
Valid Values: The license key supplied by Genesys Customer Care.
Changes Take Effect: After restart of Workbench.

Specifies the license key to activate your Remote Alarm Monitoring subscription.

Important
Any changes to the end_user_id option must also be made to the corresponding endUserId field in the configuration file aml.psdk_client.cfg, located in the folder <Workbench-Install-Folder>/karaf/etc.

origin

Default Value: None
Valid Values: The name 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 support team. It’s recommended that you use a naming convention like <node-location_node-name>. Example: EMEA_London-Datacenter
Changes Take Effect: After restart of Workbench.
Specifies the origin, or site name, to be used when Workbench routes alarms.

Important

  • Any changes to the origin option must also be made to the corresponding origin field in the configuration file aml.psdk_client.cfg, located in the folder <Workbench-Install-Folder>/karaf/etc.
  • If you change the origin value after initial Workbench installation, metrics updates to heat maps will be disrupted, and all metrics data collected before the origin is changed will be lost. You will need to recreate all existing heat maps to restore metrics collection.

customer_name

Default Value: default
Valid Values: Automatically retrieved from customer account with Genesys based on license supplied
Changes Take Effect: On Workbench startup
This is the customer’s name as recorded in their account information with Genesys. This is the same that might be viewed in customer cases.

data_collection_controller_ip

Default Value: localhost
Valid Values: IP or hostname
Changes Take Effect:On Workbench startup
The IP or hostname where the workbench Server is running. This IP is used for the Workbench Agent to connect to Workbench. The Workbench Agent collects environmental metrics from each one of the servers where it is deployed.

Important
This option specifies the location of the Workbench Server and should not be edited by the user after initial setup

scs_host_ip

Default Value: No default – this a mandatory parameter
Valid Values: Solution Control Server IP or host name
Changes Take Effect: On Workbench startup
Solution control Sever that is used to monitor the Genesys environment.

Important
This option is created automatically during Workbench Server startup and should not be edited by the user after initial setup.

scs_host_port

Default Value: No default – This a mandatory parameter
Valid Values: On Workbench startup
Changes Take Effect: On Workbench startup
Solution control Sever port that is used to monitor the Genesys environment.

Important
This option is created automatically during Workbench Server startup and should not be edited by the user after initial setup.

Application Options Tab - log Section

This section contains all options relating to creating, viewing, and otherwise using the centralized log facility in Genesys software.

This section must be called log

all

Default value: No default value
Valid Values: [filename]
Changes Take Effect: After restart of Workbench.
Specifies the file location to which the application sends application monitor log events.

expire

Default value: 20
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of Workbench.
Determines how many log file snapshots are saved before the oldest snapshot is deleted.

segment

Default value: 10000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of Workbench.
Determines the rollover size of the log files.

verbose

Default value: info

Valid Values:

  • all - All log events are printed.
  • trace - All log events are printed.
  • debug - DEBUG, INFO, WARN, FATAL, and ERROR log events are printed.
  • info - INFO, WARN, FATAL, and ERROR log events are printed.
  • warn - WARN, FATAL, and ERROR log events are printed.
  • error - FATAL and ERROR log events are printed.
  • fatal - Only FATAL log events are printed.
  • off - No log events are printed.

Changes Take Effect: After restart of Workbench.

Specifies the default logging level for the Workbench Server application.

Application Options Tab - security Section

Important
The security section of the Workbench Server application options is used to identify the protocol and ciphers used to enable secure communications between Workbench Server, Workbench Agent and Log Extractor. These options are not included by default in the provided application template and must be added manually to the Workbench Server application defined in Configuration Server.

This section must be called security.

protocol

Default Value: None
Valid Values: TLSv1.2
Changes Take Effect: After restart of Workbench
Identifies the protocol to be used for SSL communication between the Workbench components.

enabled_ciphers

Default value: None
Valid value = TLS_RSA_WITH_AES_128_CBC_SHA
Changes Take Effect: After restart of Workbench
Identifies the cipher to be used for SSL communication between the Workbench components. This value is auto-populated when the Workbench Server application template is imported. The value should not be changed.

mutual_tls

Default value: None
Valid values = true, false
Changes Take Effect: After restart of Workbench Server.
Indicates whether mutual TLS is enabled for file transfer.

Application Options Tab - security.keystore Section

Important
The security.keystore section of the Workbench Server application options is used to identify the keystore properties through which Workbench Server will load the necessary keys for secure communications

This section must be called security.keystore.

path

Default value: None
Valid values = System path to the keystore that will be used by Workbench Server
Changes Take Effect: After restart of Workbench Server.
Identifies the path to the local keystore to be used by Workbench Server to load the necessary keys.

password

Default value: None
Valid values = Any valid password for the local keystore defined in the path option of the security.keystore section
Changes Take Effect: After restart of Workbench Server.
The password to be used by Workbench Server to access the keystore

Application Options Tab - security.truststore Section

Important
The security.truststore section of the Workbench Server application options is used to identify the truststore properties through which Workbench Server will load the necessary certificates for secure communications.

This section must be called security.truststore.

path

Default value: None
Valid values = System path to the truststore that will be used by Workbench Server
Changes Take Effect: After restart of Workbench Server.
Identifies the path to the truststore to be used by Workbench Server to load the necessary certificates.

password

Default value: None
Valid values = Any valid password for the local truststore identified in the path option of the security.truststore section Changes Take Effect: After restart of Workbench Server.
The password to be used by Workbench Server to access the truststore

Ports Tab

Add the following listening ports on the Ports tab.

data_collection_controller_port

Default Value: 9999
Valid Values: Valid port number
Changes Take Effect: On Workbench startup
Port number where the Workbench Server is running. This port number is used for the Workbench Agent to connect to Workbench. The Workbench Agent collects environmental metrics from each Genesys application server where it is deployed.

Important
This option is a part of the Workbench Server configuration and should not be edited by the user after initial setup.

ftmessaging

Default Value: 6543
Valid Values: Valid port number
Changes Take Effect: On Workbench startup
Workbench starts its TCP file transfer system on this port. Log Extractor components that are remote can connect to Workbench on this port to send files for Log Analysis requests.


messaging_remote

Default Value: 2552
Valid Values: Valid port number
Changes Take Effect: On Workbench startup
Workbench starts its TCP messaging system on this port. All other Workbench components located on remote machines (for example, Log Extractor) can connect to Workbench on this port to send and receive messages.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 30, 2017, at 10:39.