Configuration Variables

For this method,

1. the main script must be included in either the HEAD or BODY of the page
2. a separate configuration script snippet (see example below) must be placed in the BODY part of the page

For this configuration script, all properties must be named explicitly as described in The Softdial object below.

For example, to hide the balloon:

Softdial.balloon.visibleWhenMaximized = false;

When using this method, the function Softdial.run() must be invoked as the final command.

According to HTML5 rules, each tag may contain additional user variables and their values. They can be passed to the main script and set as part of configuration process. To create a variable that might be placed as an attribute of the <script> tag, convert object property names (as described in The Softdial object below) by replacing

• Softdial with data
• dots with dashes

For the same example given above, the variable takes the following form:

data-balloon-visibleWhenMaximized = "false"

The user can send a set of variables and their values directly to the file as part of a URL. This is called the GET method.

The URL should take the following form:

<script type="text/javascript" src='http://[SCC-web-server]:8888/softdial/chat2/js/softdialchat.js?balloon-visibleWhenMaximized=false'></script>

The following rules for formatting the src URL apply:

• Single line string limited to 256 characters (for both location and variable definitions)
• Softdial is omitted
• Replace dots with dashes
• All spaces in values must be converted to %20 according to the URL definition
• If you include more than one variable, they must be divided by the “&” (ampersand) character.

Description	Type	Default value
If set to true and the parent of the chat is the document body, then the chat window becomes a floating window that can be dragged into another place using top bar. The chat window can consume considerable graphical resources. If dragging the floating window is slow, disable it by setting the floating variable to false.	boolean	true

Description	Type	Default value
The language to be used. See also Softdial.chatLocale below.	string	en

Description	Type	Default value
Contains the ID of the outer element – either the parent layer, or the body of the page. If equal to page body then the whole chat window can be made floating and movable (see Softdial.floating). By default, the customer client fills all the possible space of parent object	string	body

Description	Type	Default value
State of the chat on start. Either: max = maximized (inside of the outer container) min = minimized (displays only top bar and balloon, depending on settings)	string	max

The balloon part of the UI

Fig. 1 - Waiting for Input screen

Properties

Objects

Top bar of the chat window

Fig. 2 - Waiting for Input screen

Properties

Objects

Chat window when displayed.

Fig. 3 - Chat in Progress screen

Properties

Objects

Value is an array of lists containing translations of program statements that are used across the application.

The default language, English (en), contains a list of statements in English:

en: {
  pleaseEnterYourName: 'Please enter your name',
  isTyping: 'is typing...',
  joined: 'joined',
  left: 'left',
  errorCouldNotInitServerConnection: 'Could not connect to chat hub',
  errorUnknown: 'Unknown server error',
  msgSessionEnded: 'Your chat session has ended',
  errorMissingParams: 'Error: missing chat
  connection parameters: tenant, campaign, queue',
  errorServerNotFound: 'Server not found. Please contact the System Administrator',
  pleaseWriteAMessage: 'Please write a message in a message box provided on start'
}

To enhance the list, add more languages (e.g. pl for Polish) to the array, translating the full list into this language.e.g:

Softdial.chatLocale = {
  en: {pleaseEnterYourName:'Please enter your name', ...},
  pl: {pleaseEnterYourName:'Proszę podać imię', ...}
}

To select which language to display, use Softdial.lang (above)

Set of configuration variables

Properties

Settings for the list of departments displayed on start screen

Fig. 4 - Waiting for Input screen

Properties

Objects

Settings for the message bar.

Fig. 5 - Chat in Progress screen

Properties

Objects

Settings to position and size the chat window inside the parent.

Properties

Settings for the message displayed over the message input box on a start screen

Fig. 6 - Waiting for Input screen

Properties

When using a separate configuration script, this function must be invoked as the last command in the script, after all changes in configuration have been made.