Configuration options

Warning

This Deployment Guide applies ONLY to the Legacy SIP Feature Server 8.1.200.xx release. Unless you have been told to use this documentation, use the current 8.1.2 Deployment Guide

Set these configuration options in Genesys Administrator, in the Options tab of the SIP Feature Server Application object.

Cassandra section

Option	Values (default value in bold)	Description
logFile	cassandra.log	The log file name; applies only to Cassandra logs.
logLevel	error, none, debug, info, warning, critical	The log level; applies only to Cassandra logs.
maxFileSize	20000000	The threshold, in bytes, after which a new log file is created; applies only to dial plan logs.
maxFileCount	2	The number of log files kept at one time; applies only to Cassandra logs.
replicationStrategyClassName	SimpleStrategy, NetworkTopologyStrategy	Specifies the strategy used in distributing data to Cassandra nodes: In single-data center installations, SimpleStrategy uses the value of replicationOptions to determine the number of Cassandra nodes to which the application distributes data. In multi-data center installations, NetworkTopologyStrategy uses the value of replicationOptions and the values entered in the file resources/cassandra-topology.properties to determine the identity and number of Cassandra nodes to which the application distributes data.
replicationOptions	replication_factor=2, replication_factor=3, replication_factor=4, ... or data center 1 name=number of replication nodes, data center 2 name=number of replication nodes, ...	Specifies the number of Cassandra nodes used in the replication scheme, depending on the value of replicationStrategyClassName: When replicationStrategyClassName is set to SimpleStrategy, set any of the first group of values to specify the number of Cassandra nodes used in the replication scheme. When replicationStrategyClassName is set to NetworkTopologyStrategy, set any one of the second group of values to specify the data center name and the number of Cassandra nodes used in the replication scheme for each data center.

Cluster section

Option	Values (default value in bold)	Description
master	false, true	When set to true, this option designates this Feature Server as the server that coordinates the synchronization of real-time non-switch data (such as people, agents, and agent groups) from Configuration Server. Important: Designate only one server as master.
confsync	false, true	When set to true in a non-master Feature Server, this option enables the server to handle the synchronization of real-time non-switch data with Configuration Server whenever the master server is not operating.

dialplan section

Except for active, which indicates whether you are using the Feature Server dial plan or the SIP Server dial plan, these options apply only if you are using the Feature Server dial plan.

Option	Values (default value in bold)	Description
active	true, false	Determines whether Feature Server starts and displays the Feature Server dial plan. Setting the option to false disables the Feature Server dial plan and hides dial plan-related settings in the Feature Server Administration and User web applications. Value change requires restart.
heartbeatFailInterval	60	The timeout, in seconds, between heartbeat queries from Feature Server to the dial plan when the previous request failed.
heartbeatOkInterval	300	The timeout, in seconds, between heartbeat queries from Feature Server to the dial plan when the previous request succeeded.
logFile	none, <dial plan script working directory>, <another directory>	The log file location on the Feature Server host; applies only to dial plan logs.
logLevel	none, debug, info, warning, error, critical	The log level; applies only to dial plan logs.
maxFileSize	1000000	The threshold, in bytes, after which a new log file is created; applies only to dial plan logs.
maxFileCount	2	The number of log files kept at one time; applies only to dial plan logs.
port	8800, <other valid http port>	The port specific to the dial plan; must differ from the Feature Server http port.

Log section

Feature Server uses standard Genesys logging, with the following exceptions to the default values.
For details of all logging options, see Common Configuration Options log section.

Option	Values (default value in bold)	Description
internal	Error, Info, Debug	The PSDK logging level; events appear in the same log file.
verbose	trace, all, debug, interaction, standard, none	The verbose logging level.

Monitoring section

Option	Values (default value in bold)	Description
active	true, false	Determines whether Feature Server collects environment statistics for monitoring. When set to true, the option enables Feature Server environment monitoring to occur even when the monitoring interface is unavailable. To conserve disk space, set the option to false if you are not using environment monitoring.
logFile	monitoring.log, <string>.log	The log file name in the Feature Server application directory; applies only to monitoring logs.
logLevel	debug, info, warning, error, critical	The log level; applies only to monitoring logs.
maxFileSize	1000000	The threshold, in bytes, after which a new log file is created; applies only to monitoring logs.
maxFileCount	2	The number of log files kept at one time; applies only to monitoring logs.

VoicemailServer section (Application object)

Set these options in the VoicemailServer section on the Options tab of the SIP Feature Server Application object.

Option	Values (default value in bold)	Description
advance-audio-control	true, false	Displays advanced audio controls (forward, rewind, pause, and volume) to the web application user. Overrides the value set at the switch level.
language	<server locale>, de, en-GB, en-US, es, es-LA, fr, it, ja, pt, ru, zh-CN	The language used for voicemail prompts; overrides the language set at the switch level, and overridden by the language set for a mailbox.
locale	en-US, other locale strings	Specifies the default locale for the Telephone User Interface (TUI).
security-account-lockout-duration	10, zero or any positive integer	Specifies the time interval, in minutes, that Feature Server waits before unlocking an account that has been locked because of incorrect login entries; the user is locked out after four failed login attempts. A value of 0 (zero) means that only an administrator can unlock the mailbox.
security-password-check-internal-call	true, false	Specifies whether the password check request is played when a user dials the voicemail system from an internal phone.
security-password-length-min	4, any positive integer	Specifies the minimum length of the password digits.
time-zone	<server time zone>, any valid time zone (see http://joda-time.sourceforge.net/timezones.html)	Specifies the default time zone for voicemail messages (applies to the entire application, and overrides any value set at the switch); overridden when the time zone of the user or mailbox is set to a value other than the default.
voice-can-deposit-during-extended-absence	true, false	When set to true, enables the voicemail deposit after the absence greeting is played.
voice-enrollment-enabled	true, false	When set to true, enables the voicemail enrollment.
voice-greeting-extended-max-duration	24, any positive integer	Specifies the length of time, in seconds, allowed for the user to record their extended greeting; after the period ends, a prompt asks the user to confirm their recorded message.
voice-greeting-personal-max-duration	12, any positive integer	Specifies the length of time, in seconds, allowed for the user to record their personal greeting; after the period ends, a prompt asks the user to confirm their recorded message.
voice-message-max-duration	10, any positive integer	Specifies, in seconds, the maximum message length.
voice-message-priority-enabled	false, true	Enables callers to specify whether the voicemail they are leaving is urgent or normal priority. When set to true it plays the message priority selection menu to choose between normal or urgent delivery. When false, messages are all sent with normal priority.
voice-mailbox-message-count	10, any positive integer	Specifies the maximum number of voicemail messages per mailbox.
voicemail-optout-destination	empty (means that the feature is disabled), any valid destination URI in one of these formats: sip:NNNN@<IP address>:<port> sips:NNNN@<IP address>:<port> sip:<user name>@<host>:<port> sips:<user name>@<host>:<port>	When set, enables a caller to transfer out of voicemail to the specified destination at any moment during a call; overridden when the optout destination of the switch has a value or when the Optout Phone field of the Mailbox settings page has a value. See Provisioning mailboxes.

VoicemailServer section (Switch)

Set these options in the VoicemailServer section on the Options tab of the SIP Switch object, not in the Application object.

Option	Values (default value in bold)	Description
advance-audio-control	true, false	Displays advanced audio controls (forward, rewind, pause, and volume) to the web application user. Overridden by the value set at the application level.
language	<server locale>, de, en-GB, en-US, es, es-LA, fr, it, ja, pt, ru, zh-CN	The language used for voicemail prompts; overridden by the language set at the application or mailbox level.
play-disclaimer	true, false	When true, enables the system to play a recorded disclaimer; see Provisioning mailboxes.
time-zone	<server time zone>, any valid time zone (see http://joda-time.sourceforge.net/timezones.html)	Specifies the default time zone for voicemail messages (applies to the switch); overridden when the time zone of the user, mailbox, or application is set to a value other than the default.
voicemail-optout-destination	empty (means that the feature is disabled), any valid destination URI in one of these formats: sip:NNNN@<IP address>:<port> sips:NNNN@<IP address>:<port> sip:<user name>@<host>:<port> sips:<user name>@<host>:<port>	When set, enables a caller to transfer out of voicemail to the specified destination at any moment during a call; overrides the optout destination value set at the application level, but overridden when the Optout Phone field of the Mailbox settings page has a value. See Provisioning mailboxes.