Revision as of 20:21, October 9, 2015 by Dsolnit (talk | contribs) (Update with the copy of version: DRAFT)
Jump to: navigation, search

message-close

Section: inactivity-control
Default Value: Chat session closed due to inactivity of chat participants.
Valid Values: Any string
Changes Take Effect: Immediately


Specifies the message sent to chat participants upon expiration of the timeout specified by the option "timeout-close". If an empty string is specified, no message is sent.

timeout-close

Section: inactivity-control
Default Value: 45
Valid Values: Any integer from 1-86400
Changes Take Effect: Immediately
Modified: 8.5.301.06

Specifies, in seconds, a timeout that starts after "timeout-alert" or "timeout-alert2" (if specified) expires. If any qualifying activity occurs, (see "timeout-alert" or "timeout-alert2" for a description of what qualifies as activity), the timeout stops and both "timeout-alert" and "timeout-alert2" timers are reset. If qualifying activity does not occur, Chat Server:

  • Sends the IDLE_CONTROL_CLOSE notice with a message specified by the value of the "message-close" option.
  • Closes the chat session.

message-alert

Section: inactivity-control
Default Value: Chat session will be closed soon due to inactivity of chat participants.
Valid Values: Any string
Changes Take Effect: Immediately


Specifies the message sent to chat participants upon expiration of the timeout which is specified by the option "timeout-alert". If an empty string is specified, no message is sent.

timeout-alert

Section: inactivity-control
Default Value: 255
Valid Values: Any integer from 1-86400
Changes Take Effect: Immediately
Modified: 8.5.301.06

Specifies an inactivity alert timeout, in seconds. The inactivity timeout is set (or reset) for a session after any of the following activities: chat participant joined or left, chat participant sent a message or a notice (as defined by "include-notices"). If no qualifying activity is detected during this timeout, Chat Server:

  • Sends the IDLE_CONTROL_ALERT notice with a message specified by the value of the "message-alert" option.
  • Starts the timeout specified by the value of the "timeout-alert2" (if specified) or "timeout-close" option.

enabled

Section: inactivity-control
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately


Enables (true) or disables (false, the default) chat session inactivity control by Chat Server. For active sessions, enabling or disabling of inactivity control takes effect only after some activity of chat participants occurs, or after the current inactivity timeout (specified by the "timeout-alert", "timeout-alert2" and "timeout-close" options) expires.

transcript-cleanup-mask

Section: settings
Default Value: An asterisk (*)
Valid Values: Any character
Changes Take Effect: Immediately
Modified: 8.5.103

Specifies the character that replaces sensitive data. If more than one character is specified, the first one is used.

In release 8.5.103, this option was renamed default-rep-char and moved to the [transcript-cleanup] section.

default-repchar

Section: transcript-cleanup
Default Value: *
Valid Values: Any character
Changes Take Effect: Immediately
Modified: 8.5.301.06

Specifies the character used to replace sensitive data. If multiple characters are specified, then the first one is used.

Note: This option replaces the "transcript-cleanup-mask" option in the [settings] section, used in previous releases.

transcript-cleanup-typing

Section: settings
Default Value: none
Valid Values: any, message, none, notice
Changes Take Effect: Immediately
Discontinued: 8.5.103 (replaced by typing-preview in the transcript-cleanup section)

Enables/disables masking out sensitive data in typing notifications only (by replacing all digits with the character specified by "transcript-cleanup-mask"). Possible values:

  • any: mask out sensitive data both in message part and notice part of notification.
  • message: mask out sensitive data only in message part of notification.
  • none: disable this functionality.
  • notice: mask out sensitive data only in notice part of notification.

In release 8.5.103, this option was renamed typing-preview and moved to the [transcript-cleanup] section.

typing-preview

Section: transcript-cleanup
Default Value: none
Valid Values: any, message, none, notice
Changes Take Effect: Immediately


Enables or disables masking sensitive data only in typing notifications by replacing all digits with characters defined by "default-repchar". Possible values:

  • any: masks sensitive data in both the message and notice part of a notification.
  • message: masks sensitive data in only the message part of a notification.
  • none: disables this functionality.
  • notice: masks sensitive data in only the notice part of a notification.

Note: This option replaces the "transcript-cleanup-typing" option in the [settings] section, used in previous releases.

Transcript

Section: log-filter-data
Default Value: hide
Valid Values: copy, skip, hide
Changes Take Effect: Immediately


Specifies log filtering type for attribute Transcript.

StructuredText

Section: log-filter-data
Default Value: hide
Valid Values: copy, skip, hide
Changes Take Effect: Immediately


Specifies log filtering type for attribute StructuredText.

message-log-print-size

Section: settings
Default Value: 0
Valid Values: Any integer from 0-7000
Changes Take Effect: Immediately


Specifies the number of characters from the whole client message that the log prints, starting from the beginning of the message.

limits-restore-threshold

Section: settings
Default Value: 80
Valid Values: Any integer from 0-100
Changes Take Effect: Immediately


Specifies the level (as percentage of maximum value) which metric must drop below in order to restore the service.

limits-reached-report-scs

Section: settings
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately


With a value of "false" Chat Server does not send "SERVICE UNAVAILABLE" notifications to Solution Control Server when Chat Server reaches any of its configured load limits. This can prevent Chat Server from switching over when configured as primary/backup.

limit-for-sessions

Section: settings
Default Value: 1000
Valid Values: Any integer from 0-1000000
Changes Take Effect: Immediately


Defines the maximum number of chat sessions that Chat Server handles simultaneously.

limit-for-flex-users

Section: settings
Default Value: 1001
Valid Values: Any integer from 0-1000000
Changes Take Effect: Immediately


Defines the maximum number of flex users that Chat Server handles simultaneously.

limits-control-enabled

Section: settings
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately


Enables (true) or disables (false) load restriction for Chat Server, controlled by options: limit-for-flex-users, limit-for-reply-delay, limit-for-sessions.

Chat Server Administration

This page provides general recommendations for the administration of Chat Server. See also the following:

Limitations

The following table lists recommended limitations for a Genesys Chat solution running on a single host with two Intel Xeon 3.0GHz processors. Observe these limitations for optimum performace (meaning without significant delay).

Item

Maximum

Message size

4 KB (Genesys Desktop limitation; Chat Server does not have this restriction.)

Transcript size

54 KB (Genesys Desktop limitation; Chat Server does not have this restriction.)

Concurrent sessions (in a realistic simple scenario)

1000 per Chat Server

Messages per second

50 (rare temporary peaks up to 150)

Sessions opened and closed per second

10 (rare temporary peaks up to 30)


Chat Server also has a timeout that you can configure using the user-register-timeout option (default value 30 seconds). This is the maximum time between opening a socket and either of the following:

  • Receiving a registration over the socket
  • Receiving a flex packet over the socket

This timeout prevents keeping unused connections open.

Connection Delay with Antivirus

It may take some time (up to several minutes on some UNIX Platforms) for Chat Server to connect to an unopened port on a Windows host on which an antivirus program is running. For example, if Chat Server is running on Linux and is trying to connect to an inactive UCS instance, it could take up to three minutes for Chat Server to detect that the listening port is not open.

Chat HA

Deploying a high-availability Chat solution requires some special configuration.

Setting Load Limits

Starting in the 8.5.0 release of Chat Server, you can impose load limits on Chat Server: when Chat Server reaches the specified limit, it no longer creates new sessions or restores existing sessions.

You do this using the following configuration options (full descriptions are in the eServices Options Reference):

  • Enable or disable the general functionality of load limitation using limits-control-enabled.
  • Set the limits using
    • limit-for-flex-users—Maximum number of currently logged-in flex users.
    • limit-for-sessions—Maximum number of concurrent chat sessions.
    • If any of these limits is reached, Chat Server stops creating and restoring sessions.

  • If Chat Server is configured in primary/backup mode, you may want to stop it from reporting service unavailable to SCS when a limit is reached. You can do this using limits-reached-report-scs. Blocking the reports avoids a scenario in which Chat Server in primary/backup mode closes a chat session because (1) Chat Server detects disconnection from Interaction Server and/or UCS, (2) it sends a service unavailable notification to Solution Control Server, (3) SCS switches Chat Server to backup, which closes the chat session. (This scenario does not apply if Chat Server is in N+1 mode: multiple Chat Servers with no backup configured).
  • Set the point at which Chat Server returns to full functionality using limits-restore-threshold. This value is a percentage of the limit set by the three limit-for-X options.

Example

If limit-for-flex-users is set to 400 and limits-restore-threshold is set to 80, then:

  1. When the number of flex users reaches 400, Chat Server stops creating and restoring sessions, and rejects login attempts by flex users.
  2. Then when the number of flex users falls to 320, Chat Server returns to full functionality.

Masking Sensitive Data

Chat Server logs and chat transcripts may contain sensitive data such as credit card numbers, phone numbers, Social Security numbers, and so on. You can omit this data from logs and mask it in transcripts.

In Logs

To omit sensitive data from logs, you must configure both UCS, as described elsewhere, and Chat Server, as follows:


  • In the [settings] section, set message-log-print-size to 0. This means that logs do not show the messages sent between chat participants. Where a message occurs, the log shows [truncated from size=x], where x is the number of characters in the suppressed message.
  • In the [log-filter-data] section,
    • Set StructuredText to hide so that logs will omit the transcript that UCS sends to Chat Server.
    • Set Transcript to hide so that logs will omit the transcript that Chat Server sends to UCS.


In Chat Transcripts

Name Regular Expression
Credit card GCTI_CreditCards 8.5.0 version only:

(?>^|(?<=[\s[:alpha:](),.:;?!"'`]))(?>4\d{3}|5[1-5]\d{2}|6011|622[1-9]|64[4-9]\d|65\d{2})[ -]?\d{4}[ -]?\d{4}[ -]?\d{4}(?>$|(?=[\s[:alpha:](),.:;?!"'`]))
8.5.1 version only:
(?>^|(?<=[\s[:alpha:](),.:;?!"'`]))(?>4\d{3}|5[1-5]\d{2}|6011|622[1-9]|64[4-9]\d|65\d{2})[ -.]?\d{4}[ -.]?\d{4}[ -.]?\d{4}(?>$|(?=[\s[:alpha:](),.:;?!"'`]))

Social Security Number GCTI_SSN (?>^|(?<=[\s[:alpha:](),.:;?!"'`]))(?!000|666|9)\d{3}[- ]?(?!00)\d{2}[- ]?(?!0000)\d{4}(?>$|(?=[\s[:alpha:](),.:;?!"'`]))
Phone number using the North American Numbering Plan GCTI_PhoneNANPA (?>^|(?<=[\s[:alpha:](),.:;?!"'`]))(?:\+?1[-. ]?)?(?:\(?[2-9][0-9]{2}\)?[-. ]?)?[2-9][0-9]{2}[-. ]?[0-9]{4}(?>$|(?=[\s[:alpha:](),.:;?!"'`]))


In Typing Preview

Typing preview allows an agent to see text that a customer types before the text is submitted to the chat session. You can have Chat Server mask all digits in the typing preview by setting the typing-preview (called transcript-cleanup-typing before release 8.5.103) option to a value other than none. Chat Server then replaces all digits in the typing preview with the character specified by default-repchar (called transcript-cleanup-mask before release 8.5.103).


Inactivity Monitor

Inactivity monitoring control closes the chat session if there is no activity by chat participants after a certain length of time. To enable it, set the enabled option in the [inactivity-control] section to true. It works as follows:

  • Chat Server carries out inactivity monitoring only if there is at least one customer and one agent participating in the chat session.
  • If there is no activity during the time specified by timeout-alert, Chat Server issues a warning consisting of the text specified by message-alert. The default warning is "Chat session will be closed soon due to inactivity of chat participants."
  • If there is no activity for another timeout-close seconds, Chat Server issues a notification consisting of the text specified by message-close and closes the chat session (thus removing all participants from it). The default notification is "Chat session closed due to inactivity of chat participants."
  • If any activity occurs, Chat Server resets both of the timeouts. Activity here means any activity in the chat session that is visible to all participants—so, for example, coaching messages between agents do not count as activity in this sense.
Comments or questions about this documentation? Contact us for support!