Jump to: navigation, search

Configuration Options

Knowledge Center Cluster Application Options

Knowledge Center Cluster Application Configuration Options
Name Description Value
Section: general
session-ttl Specify time that server will store session information while no activities are taking place. Default: 8h

Valid Values: number + unit, e.g. 1d or 3m. Supported units: d (days), m (minutes), h (hours), or w(weeks)
Changes Take Effect: After restart.

Section: multicast
enabled Specify whether enabled node should use multicast or unicast to discover other servers within the same cluster. Default: true

Valid Values: true, false
Changes Take Effect: After restart.

Important
Genesys Knowledge Center Servers are configured to use multicast discovery out of the box. Multicast works by sending UDP pings across your local network to discover nodes. Other Knowledge Center Servers will receive these pings and respond. A cluster is formed shortly after. This ease of use is the reason you should disable it in production otherwise other servers could accidentally join your production cluster simply because they received an errant multicast ping or are misconfigured having the same cluster name.
Section: reporting
ttl Specify time that records will be stored in the history. Default: 14d

Valid Values:number + unit, e.g. 1d or 3m. Supported units: d (days), m (minutes), h (hours), or w(weeks)
Changes Take Effect: After restart.

Section: security
auth-scheme Specifies the HTTP authentication scheme used to secure REST API requests to the Knowledge Server. With the Basic scheme, clients must be authenticated with a user ID and password. Default: none

Valid Values: none, basic
Changes Take Effect: After restart.

user-id The user identifier (login) used in authentication for the REST API. Default: n/a

Valid Values: string
Changes Take Effect: After restart.

password The user password used in authentication for the REST API. Default: n/a

Valid Values:string
Changes Take Effect: After restart.

Section: internal
Important
Knowledge Center Server uses this section to store internal initialization parameters. Do not attempt to change these options.

Knowledge Center Server Application Options

Knowledge Center Server Application Configuration Options
Name Description Value
Section: archiving
enabled Specifies whether a node will allow to execute archiving using its API. Enabling archiving on the node does not affect other nodes of the cluster. Archiving is

resource consuming functionality - use it wisely.

Default: true

Valid Values: true, false
Changes Take Effect: After restart.

type Defines format of resulted archive will be stored in. Default: tar

Valid Values: tar, zip, cpio
Changes Take Effect: After restart.

path Path to the stored archive. The archive will be stored as <path>/history_<requested_date_range>.<archive> Default: none

Valid Values: string
Changes Take Effect: After restart.

Section: security
trusted-ca-type Specifies the type of trusted certificate authority. No TLS is applied for connections between this server and other Genesys servers if this option is absent. Default: MSCAPI

Valid Values: MSCAPI – MSCAPI certificate storage is used for TLS certificate verification. PEM – PEM certificate storage is used for TLS certificate verification. In this case, the trusted-ca option should also be specified and should contain the path to the PEM file.
JKS – JKS certificate storage is used for TLS certificate verification. In this case, the trusted-ca option should also be specified and should contain the path to the JKS file. You should also set the trusted-ca-pwd option to the password for the JKS file.
Changes Take Effect: After restart.

trusted-ca Specifies the path to the trusted store file (valid for PEM and JKS types, depending on value of the trusted-ca-type option). Default: none

Valid Values: Path to the trusted store file (valid for PEM and JKS types, depending on value of the trusted-ca-type option).
Changes Take Effect: After start or restart.

trusted-ca-pwd Specifies the password for the trusted store file (valid for JKS type only). Default: none

Valid Values: Password for the trusted store file (valid for JKS type only).
Changes Take Effect: After start or restart.

Section: log
all Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured. For example: all = stdout, logfile Default: stdout

Valid Values: (log output types)

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: After start or restart.

standard Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured. For example: standard = stderr, network Default: stdout

Valid Values:

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: Immediately

trace Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured. For example: trace = stderr, network. Default: stdout

Valid Values:

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: Immediately

verbose Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug. Default: standard

Valid Values:

Name Description
all All log events (that is, log events of the Standard, Trace, Interaction, and Debug levels) are generated.
debug The same as all.
trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
none No output is produced.

Changes Take Effect: Immediately

segment Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created. This option is ignored if log output is not configured to be sent to a log file. Default: 1000

Valid Values:

Name Description
false No segmentation is allowed.
<number> KB or <number> Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
<number> MB Sets the maximum segment size, in megabytes.
<number> hr Sets the number of hours for the segment to stay open. The minimum number is 1 hour.

Changes Take Effect: After restart.

expire Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed. This option is ignored if log output is not configured to be sent to a log file. Default: 3

Valid Values:

Name Description
false No expiration; all generated segments are stored.
<number> file or <number> Sets the maximum number of log files to store. Specify a number from 1—1000.
<number> day Sets the maximum number of days before log files are deleted. Specify a number from 1—100.

Changes Take Effect: After restart.

Important
If an option's value is not set within the range of valid values, it will automatically be reset to 10.
affectedLoggers Verbosity settings are explicitly applied for the following loggers:
  • Loggers that are not declared explicitly in the log4j2.xml configuration file.
  • Loggers that are specified explicitly in the log4j2.xml and are specified in the value for this affectedLoggers option.

For other loggers specified in log4j2.xml, but not mentioned in the value for this option, the verbosity level is not re-applied.
Here is a use case for when you might need to set this option:

  • Cassandra needs to write error messages to a log file, and at the same time, Genesys components also need to write debug messages to the log file.

To resolve this use case, you would:

  1. Specify the following logger in log4j2.xml: <logger name="org.apache.cassandra" level="error" additivity="false">
  2. Do not include org.apache.cassandra in the value for the affectedLoggers option.
  3. The default log4j2.xml file contains the following logger: <logger name="com.genesyslab.platform" level="info" additivity="false">
  4. Include com.genesyslab.platform in the value for the affectedLoggers option.
  5. Set the verbose option to debug.

In the sample above, the value of affectedLoggers should be com.genesyslab.platform. Error (but not debug or info) messages from Cassandra will be available in logs, and debug messages from com.genesyslab.platform will be available in logs.

Default: None

Valid Values: The names of loggers, separated by a semicolon (;), specified in the LOG4J2.xml. For example:
com.genesyslab.webme.commons;PROTOCOL;org.apache.cassandra
Changes Take Effect: Immediately

time_format Specifies how to represent, in a log file, the time when an application generates log records. A log record's time field in the ISO 8601 format looks like this: 2001-07-24T04:58:10.123 Default: time

Valid Values:

Name Description
time The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
locale The time string is formatted according to the system’s locale.
ISO8601 The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.

Changes Take Effect: Immediately

time_convert Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since 00:00:00 UTC, January 1, 1970. Default: local

Valid Values:

Name Description
local The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application’s host computer is used.
utc The time of log record generation is expressed as Coordinated Universal Time (UTC).

Changes Take Effect: Immediately


Knowledge Center CMS Application Options

Knowledge Center CMS Application Options
Name Description Value
Section: log
all Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured. For example: all = stdout, logfile Default: stdout

Valid Values: (log output types)

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: After start or restart.

standard Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured. For example: standard = stderr, network Default: stdout

Valid Values:

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: Immediately

trace Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured. For example: trace = stderr, network. Default: stdout

Valid Values:

Name Description
stdout Log events are sent to the Standard output (stdout).
stderr Log events are sent to the Standard error output (stderr).
network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
[filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.

Changes Take Effect: Immediately

verbose Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug. Default: standard

Valid Values:

Name Description
all All log events (that is, log events of the Standard, Trace, Interaction, and Debug levels) are generated.
debug The same as all.
trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
none No output is produced.

Changes Take Effect: Immediately

segment Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created. This option is ignored if log output is not configured to be sent to a log file. Default: 1000

Valid Values:

Name Description
false No segmentation is allowed.
<number> KB or <number> Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
<number> MB Sets the maximum segment size, in megabytes.
<number> hr Sets the number of hours for the segment to stay open. The minimum number is 1 hour.

Changes Take Effect: After restart.

expire Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed. This option is ignored if log output is not configured to be sent to a log file. Default: 3

Valid Values:

Name Description
false No expiration; all generated segments are stored.
<number> file or <number> Sets the maximum number of log files to store. Specify a number from 1—1000.
<number> day Sets the maximum number of days before log files are deleted. Specify a number from 1—100.

Changes Take Effect: After restart.

Important
If an option's value is not set within the range of valid values, it will automatically be reset to 10.
affectedLoggers Verbosity settings are explicitly applied for the following loggers:
  • Loggers that are not declared explicitly in the log4j2.xml configuration file.
  • Loggers that are specified explicitly in the log4j2.xml and are specified in the value for this affectedLoggers option.

For other loggers specified in log4j2.xml, but not mentioned in the value for this option, the verbosity level is not re-applied.
Here is a use case for when you might need to set this option:

  • Cassandra needs to write error messages to a log file, and at the same time, Genesys components also need to write debug messages to the log file.

To resolve this use case, you would:

  1. Specify the following logger in log4j2.xml: <logger name="org.apache.cassandra" level="error" additivity="false">
  2. Do not include org.apache.cassandra in the value for the affectedLoggers option.
  3. The default log4j2.xml file contains the following logger: <logger name="com.genesyslab.platform" level="info" additivity="false">
  4. Include com.genesyslab.platform in the value for the affectedLoggers option.
  5. Set the verbose option to debug.

In the sample above, the value of affectedLoggers should be com.genesyslab.platform. Error (but not debug or info) messages from Cassandra will be available in logs, and debug messages from com.genesyslab.platform will be available in logs.

Default: None

Valid Values: The names of loggers, separated by a semicolon (;), specified in the LOG4J2.xml. For example:
com.genesyslab.webme.commons;PROTOCOL;org.apache.cassandra
Changes Take Effect: Immediately

time_format Specifies how to represent, in a log file, the time when an application generates log records. A log record's time field in the ISO 8601 format looks like this: 2001-07-24T04:58:10.123 Default: time

Valid Values:

Name Description
time The time string is formatted according to the HH:MM:SS.sss (hours, minutes, seconds, and milliseconds) format.
locale The time string is formatted according to the system’s locale.
ISO8601 The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.

Changes Take Effect: Immediately

time_convert Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since 00:00:00 UTC, January 1, 1970. Default: local

Valid Values:

Name Description
local The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application’s host computer is used.
utc The time of log record generation is expressed as Coordinated Universal Time (UTC).

Changes Take Effect: Immediately

This page was last modified on August 26, 2015, at 10:12.

Feedback

Comment on this article:

blog comments powered by Disqus