Jump to: navigation, search

pulse.properties File

The following options are configured in the pulse.properties file under the conf folder inside the Genesys Pulse installation folder.

accesslog_enabled
Default Value: true
Valid Values: true, false
Changes Take Effect: After restart
Enables HTTP access logging.

accesslog_filename
Default Value: ./logs/http-yyyy_mm_dd.log
Valid Values: valid filename
Changes Take Effect: After restart
File name for the HTTP access log.

accesslog_timezone
Default Value: GMT
Valid Values: valid timezone
Changes Take Effect: After restart
Time zone for the HTTP access log.
Note: It is recommended to specify the time zone value in canonical format instead of three-letter time zone IDs. For example, Australia/Sydney, Asia/Kolkata, America/Los_Angeles.

accesslog_append
Default Value: true
Valid Values: true, false
Changes Take Effect: After restart
After Genesys Pulse is restarted, specifies whether to append to the existing HTTP access log.

accesslog_extended
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Specifies whether to include the extended information in the HTTP access log.

accesslog_cookies
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Specifies whether to include cookies in the HTTP access log.

accesslog_retaindays
Default Value: 90
Valid Values: integer
Changes Take Effect: After restart
Specifies the number of days to retain the HTTP access log.

app
Default Value: No default value
Valid Values: Application object name
Changes Take Effect: After restart
Specifies the Genesys Pulse Application object.
This option is mandatory.

backup_port
Default Value: No default value
Valid Values: integer
Changes Take Effect: After restart
Specifies the backup Configuration Server port.

backup_host
Default Value: No default value
Valid Values: Valid FQDN or IP address
Changes Take Effect: After restart
Specifies the backup Configuration Server host, written as a Fully Qualified Domain Name (FQDN) or an IP address.

content_security_policy
Default Value: No default value
Valid Values: delimited list of directives (see the full list of valid directives at Mozilla Developer Network)
Changes Take Effect: After restart
Allows to control the Content Security Policy header for an additional protection against XSS attacks.
Example: default-src 'none'; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline'; img-src * data:; connect-src 'self'; font-src *; frame-src *; form-action 'self'; worker-src 'self'; base-uri 'self'; block-all-mixed-content; frame-ancestors 'none';

Important
This option should be used with caution as wrong values could prevent Genesys Pulse UI from loading. Carefully review the following notes before usage:
  • The value of the script-src directive must include 'unsafe-inline' 'unsafe-eval'
  • The value of the style-src directive must include 'unsafe-inline'
  • In cases using external resources or extensions, the following directives should contain * (asterisk) or exact hostname values (more secure):
    • script-src 'unsafe-inline' 'unsafe-eval' * or script-src self 'unsafe-inline' 'unsafe-eval' <space separated list of sources> for external scripts
    • style-src 'unsafe-inline' * or style-src self 'unsafe-inline' <space separated list of sources> for external styles
    • font-src * or font-src self <space separated list of sources> for external fonts
    • img-src * data: or font-src self data: <space separated list of sources> for external images
    • frame-src * or frame-src self <space separated list of sources> for embedding 3rd party sites in an iframe widget
    • if no external resources or extensions are used then * (asterisk) should be replaced with 'self'
  • If embedding Pulse into an external iframe, the frame-ancestors directive should contain valid parents that may embed: frame-ancestors ‘self' https://example.com; or contain 'none' if prohibited to embed Pulse into external iframe
  • If not specified, the value of the sandbox directive will be set to default 'allow-scripts' 'allow-same-origin' 'allow-popups' 'allow-forms' value. Restrictions that are weaker than the default value will have no effect.

disable_xframe_options
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Disables X-Frame-Options security header. See Configuring System Security for more information.

enable_hsts
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Enables or disables HSTS. See Configuring System Security for more information.

host
Default Value: No default value
Valid Values: Valid FQDN or IP address
Changes Take Effect: After restart
Specifies the primary Configuration Server host, written as a Fully Qualified Domain Name (FQDN) or an IP address.
This option is mandatory.

http_port
Default Value: 8080
Valid Values: integer
Changes Take Effect: After restart
Defines the HTTP port.

https_port
Default Value: No default Value
Valid Values: integer
Changes Take Effect: After restart
Defines the HTTPS port. See Configuring System Security for more information.

keystore_password
Default Value: No default Value
Valid Values: string
Changes Take Effect: After restart
Specifies the keystore password.

keystore_path
Default Value: No default Value
Valid Values: Full path to the location of the keystore
Changes Take Effect: After restart
Defines the keystore path. See Configuring System Security for more information.

max_cfg_connection
Default Value: 200
Valid Values: -1 or any positive integer
Changes Take Effect: After restart
Specifies the maximum number of allowed connections from Genesys Pulse to Configuration Server. To allow unlimited connections, set the value to -1.

max_idle_time
Default Value: 1000*60*60
Valid Values: integer
Changes Take Effect: After restart
Specifies the maximum idle time, in milliseconds, for HTTP connection

port
Default Value: No default value
Valid Values: integer
Changes Take Effect: After restart
Specifies the primary Configuration Server port.
This option is mandatory.

protocol_timeout
Default Value: 30000
Valid Values: Any positive integer
Changes Take Effect: After restart
Introduced: 9.0.006.03
Specifies timeout, in milliseconds, for a connection with Configuration Server.

root_url
Default Value: /pulse
Valid Values: root URL
Changes Take Effect: After restart
Specifies the root URL (host:port/rootURL).

session_samesite
Default Value: strict
Valid Values: none, strict, lax
Changes Take Effect: After restart
Specifies the value for SameSite cookie attribute. See Configuring System Security for more information.

supported_protocol
Default Value: http
Valid Values: http, https, both
Changes Take Effect: After restart
Defines supported protocol(s). See Configuring System Security for more information.

This page was last edited on November 7, 2023, at 18:12.
Comments or questions about this documentation? Contact us for support!