Jump to: navigation, search

Configuration options

Set these configuration options in Genesys Administrator, in the Options tab of the SIP Feature Server Application object (or the GAX Application object, as noted).


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:
  • SimpleStrategy uses the value of replicationOptions to determine the number of Cassandra nodes to which the application distributes data. This is used in single data center deployment (Not recommended for production deployment).
  • 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. This is used in single and multi data center deployment.
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.
readConsistencyLevel and writeConsistencyLevel CL_ONE Do not change this value for either option. Determines the minimum number of nodes that data must be written to and read from.
regionalKeyspace None Defines the keyspace name for a region. Add this option to create new regional keyspaces. For Example,

regionalKeyspace=us_vm (which will hold voicemails for us_east and us_west) regionalKeyspace=eu_vm (which will hold voicemails for eu_east and eu_west)

regionalReplicationOptions None Defines the number of replication options for a region. Add this option to configure the number of regional replication options. For Example,

regionalReplicationOptions = us_east=2, us_west=2 regionalReplicationOptions = eu_east=2, eu_west=2

retry-max-attempts None <positive integer value> Defines the maximum number of times a Feature Server application can retry a failed Cassandra read/write operation.
retry-sleep-ms None <positive integer value> Defines the interval time after which Feature Server should retry a failed Cassandra read/write operation.

To be configured in milliseconds.

nodes None, Comma-separated Cassandra node IP address or FQDN that are local to its data center Mandatory if Feature Server is configured with co-located/external Cassandra cluster. Defines the Cassandra nodes where the SIP Feature Server application connects.
keyspace sipfs, <keyspace name (alpha numeric value)> Defines the keyspace name to be used by the Feature Server application. By default, sipfs is the Cassandra keyspace name, but it can be changed to any desired alpha numeric name. Applicable only for co-located/external Cassandra cluster.
username None, <cassandra username> Configure this option only if authentication is enabled in co-located/external Cassandra. Restart Feature Server for changes to reflect.
password None, <cassandra password> Configure this option only if authentication is enabled in co-located/external Cassandra. Restart Feature Server for changes to reflect.
nodeFailureTolerance None, [replication_factor of its data center – 1]. Specifies that the Feature Server application can process requests until the configured number of Cassandra nodes are down in its local data center.

This option must be configured when the Feature Server application is configured with a replication_factor less than the number of Cassandra nodes in its local data center (For example, if a data center has four nodes, but the replication factor is set to three, then configure this option as replication_factor_value-1. Applicable only for co-located/external Cassandra cluster.

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. Synchronization of switch data occurs regardless of this value. The initial import of Tenant data is performed by the master Feature Server only.
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. Initial import and real-time synchronization of switch data occurs regardless of this value. Value changes take effect immediately.
disable-initial-import Valid values: false, true Set to false to enable initial import of tenant data upon startup.

To prevent another import, set to true, which disables the initial import trigger after the initial import is completed.

reimport-on-conf-history-log-error false, true If set to true, in the master Feature Server application, then returning from an outage will automatically trigger Reimport.

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.
logHandler RotatingFileHandler, DialPlanRotatingFileHandler When set to DialPlanRotatingFileHandler, the log file is generated in the format logfile_name.YYYYmmdd_HHMMSS_ms.log.

When set to RotatingFileHandler, the log file is generated in the format logfile_name.log. Value change requires a restart.

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 backup 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.
default-dn None, any valid DN Specifies the DN to which calls are sent when Feature Server is not connected to Cassandra. Applicable only for co-located/external Cassandra cluster.

dm section

Option Values (default value in bold) Description
Active false, true When set to true, enables Feature Server to manage devices. Restart required.
fs_url IP address:port/fs, FQDN:port/fs, none Specifies the address of the Feature Server that processes Firmware upgrade requests in device management. In an N+1 deployment, the FQDN resolves to the IP address of all the Feature Server instances in that deployment. For example, http://Feature Server FQDN:8080/fs. When this option is not set, Feature Server attempts to detect the IP address automatically and port will be the default Feature Server port. Restart required.
audiocodes/genesys/polycom/yealink None, comma separated value of the device model names to be supported Device Management handles and provisions the phone models that are configured in this option, but only if the corresponding firmware version is supported.
UA_Pattern_[audiocodes/genesys/polycom/yealink] None, parameters with value specific to the phone model Custom UA header pattern for newly-added phones with a different Header pattern than the default supported pattern.

dm-gax-plugin section

Set the dm-gax-plugin configuration options in the Options tab of the GAX Application object.

Option Values (default value in bold) Description
fs_urls IP address:port/fs, FQDN:port/fs, none Specifies the addresses of the Feature Servers that control device management. Specify comma-separated values for multiple Feature Servers. For an N+1 deployment, specify the FQDNs of N servers and the backup server, separated by a comma. For example, http://10.10.192.02:8080/fs, http://10.10.192.01:8080/fs.

Restart required.

fs-gax-plugin section

Set the fs-gax-plugin configuration options in the Options tab of the GAX Application object.

Option Values (default value in bold) Description
fs_urls IP address:port/fs, FQDN:port/fs, none Specifies the addresses of the Feature Servers that control voicemail management. Specify comma-separated values for multiple Feature Servers. For an N+1 deployment, specify the FQDNs of N servers and the backup server, separated by a comma. For example, http://10.10.192.02:8080/fs, http://10.10.192.01:8080/fs.

Restart required.

gdpr section

Set this option in the gdpr section on the Options tab of the Master Feature Server application.

Option Values (default value in bold) Description
gdpr-directory An absolute path to the directory with read and write access The forget-me task will take the input JSON files from this directory. The output log file of the forget-me task will present in this directory.

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 info, debug, 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.
monitoring-request-interval 60000 (one minute), 10000 (ten seconds) and above The frequency with which Feature Server requests monitoring information.

SMTP section

Set these options, used in email notifications of voicemail, in the SMTP section on the Options tab of the SIP Feature Server Application object.

Option Values (default value in bold) Description
Host Server host name The name of the SMTP host server that you want to use to generate email that notifies users of voicemail.
channel SMTP, TLS, SSL The connection protocol that your SMTP host uses. TLS and SSL require a valid username and password.
port port number The port number your SMTP server uses, depending on the specified channel.
username valid username The username required to log into the designated SMTP server when you have enabled either TLS or SSL security. For example, an e-mail address.
password valid password The password for the specified username.
trusted false, true When set to true, Feature Server assumes that the specified SMTP server can be trusted, so no server validation through certificates or installation of certificates is necessary.

TServer section

Set these options, used in Find Me Follow Me, in the TServer section on the Options tab of the SIP Server (not SIP Feature Server) Application object.

Option Values (default value in bold) Description
fmfm-prompt-file A valid filename Specifies the filename of the confirmation prompt. Must match the path and filename in the MCP folder/users folder on the Media Control Platform server host. For example: users/fmfm-confirmation-prompt-0.wav
fmfm-confirmation-digit 0-9 Specifies the digit that a caller must enter for call confirmation. This number must match the number in the recorded fmfm-prompt-file. To use a different digit, you must record a new prompt and place the file in the MCP folder/users folder on the Media Control Platform server host.
fmfm-confirmation-timeout An integer between 5 and 60; the default value is 10 Specifies the timeout value (how long to wait with no input), in seconds. Enter a number that includes playing time of the confirmation prompt and time for the confirmation digit to be entered.


Note: A call is considered abandoned when: the caller hangs up, the entered digit does not match the value of the fmfm-confirmation-digit option, or the call times out with no input at all.

fmfm-trunk-group A valid Trunk Group DN name Specifies the Trunk Group DN where events are generated, when each destination leg connects to Media Server. Enter a Trunk Group DN name that represents Media Server. SIP Server uses that DN to play ringback, and for all outbound calls to FMFM destinations.
msml-support true, false When set to true, enables the MSML support required to use Find Me Follow Me.

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
access-first-prompt-delay-ms 0, zero or any positive integer no greater than 6000 (6000 ms = 6 seconds). Enables delay in multiples of 600 ms before the first prompt during voicemail access. The delay will be limited to 6000 ms (6 seconds). Defined in milliseconds, the duration value is rounded to the next largest value divisible by 600 ms.

For example, 800 ms is rounded to 1200 ms, 100 ms is rounded to 600 ms, and so on.
Overrides the value set at the switch level.

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.
group-optout-use-default false, true When set to true, uses the governing value of voicemail-optout-destination as the default group optout prompt. When set to false, does not play any optout prompt if the Group Mailbox does not have an Optout Phone set.
language <server locale>, de, en-AU, en-GB, en-US, es, es-MX, fr, it, ja, pt-BR, ru, zh-CN, ko The language used for voicemail prompts; overrides the language set at the switch level, and overridden by the language set for a mailbox:

Note: The group mailbox language changes based on how it is accessed.

  • When accessed through personal mailbox, the personal mailbox language is used.
  • When accessed by a non-member or when accessed through a local telephone, the application-level language is used.
  • When accessed directly, the group mailbox language is used.
  • When depositing voicemail to group mailbox, the group mailbox language is used.
locale en-US, other locale strings Specifies the default locale for the Telephone User Interface (TUI).
play-disclaimer false, true When set to true, enables the system to play a recorded disclaimer; see Provisioning mailboxes. Overrides the value set at the switch level.
play-review-on-deposit true, false Specifies whether the Telephone User Interface (TUI) will play the first audio menu prompt: “To confirm press 1, to review press 2, to erase and rerecord press 3.”

When set to true, the TUI plays the first audio prompt.

When seet to false, the TUI omits the first audio prompt and continues as if the caller had pressed choice 1.

Note: You can set this option here or on the Switch level. If set on both levels, the application level setting takes precedence.

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-max-login-attempt-count 4, any positive integer Specifies the maximum number of login attempts while accessing an account. The account will be locked after 4 failed login attempts.
security-password-enhanced-validation
false, true When set to true, forces users to set or reset their passwords to eliminate repeats (333333, for example) and sequences (123456, for example) in mailbox passwords. It also prevents users from using their mailbox number as their password.
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. Increasing this number forces existing users to reset their passwords, if under the new minimum.
suspending-state-timeout
-1, any integer greater than 0 Maximum time, in seconds, for which Feature Server will be in suspending state while waiting for ongoing voicemail sessions to be completed.

By default (when the option value is set to -1 or no value is configured), Feature Server waits until all the voicemail sessions are completed. This option facilitates a graceful shutdown of the voicemail service during a scheduled maintenance or a software upgrade in Feature Server and ensures the following:

  • Ongoing TUI voicemail sessions are completed before shutdown.
  • New TUI voicemail sessions are redirected to an alternate Feature Server.
  • New web UI requests are redirected to an alternate Feature Server.
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.
use-employee-login None, TController When set, uses employee ID as agent login code.
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 set to 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.
voice-mwi true, false If set to false, FS will not generate MWI while handling voicemails.
voicemail-optout-destination empty (means that the feature is disabled), any phone number or routing point When set, enables a caller to transfer out of voicemail to the specified destination at any moment during a call; overrides the voicemail-optout-destination value set at the switch level, but overridden when the Optout Phone field of the Mailboxes settings page has a value. See Provisioning mailboxes.
voicemail-quorum false, true Obsolete. The value should always be false.

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
access-first-prompt-delay-ms 0, zero or any positive integer no greater than 6000 (6000 ms = 6 seconds). Enables delay in multiples of 600 ms before the first prompt during voicemail access. The delay will be limited to 6000 ms (6 seconds). Defined in milliseconds, the duration value is rounded to the next largest value divisible by 600 ms.

For example, 800 ms is rounded to 1200 ms, 100 ms is rounded to 600 ms, and so on.
Overridden by the value set at the application level.

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-AU, en-GB, en-US, es, es-MX, fr, it, ja, pt-BR, ru, zh-CN, ko The language used for voicemail prompts; overridden by the language set at the application or mailbox level.

Note: The group mailbox language changes based on how it is accessed.

  • When accessed through personal mailbox, the personal mailbox language is used.
  • When accessed by a non-member or when accessed through a local telephone, the application-level language is used.
  • When accessed directly, the group mailbox language is used.
  • When depositing voicemail to group mailbox, the group mailbox language is used.
play-disclaimer false, true When set to true, enables the system to play a recorded disclaimer; see Provisioning mailboxes. Overridden by the value set at the application level, so to enable a disclaimer for a switch, you must also set this option to true at the application level.
play-review-on-deposit true, false Specifies whether the Telephone User Interface (TUI) will play the first audio menu prompt: “To confirm press 1, to review press 2, to erase and rerecord press 3.”

When set to true, the TUI plays the first audio prompt.

When set to false, the TUI omits the first audio prompt and continues as if the caller had pressed choice 1.

Note: You can set this option here or on the Application level. If set on both levels, the application level setting takes precedence.

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 phone number or routing point When set, enables a caller to transfer out of voicemail to the specified destination at any moment during a call; overridden when the voicemail-optout-destination of the application has a value or when the Optout Phone field of the Mailboxes settings page has a value. See Provisioning mailboxes.


history-log section

Set these options in the history-log section on the Options tab of the Configuration Server application object.

Option Values (default value in bold) Description
active true, false When Feature Server is disconnected and then reconnected, the changes made in the Configuration Server during the disconnected period are written in the Cassandra database upon reconnection.
expiration 30, 1-30 History log expiration time in days.
max-records 1000, 1-1000 Maximum records stored for retrieving the history log.

ScheduledTasks section

Set these options in the ScheduledTasks section on the Options tab of the Master Feature Server application.

Option Values (default value in bold) Description
update-mailbox-counters.active false, true When set to true, this option will enable the task and will schedule the task at the time configured in the update-mailbox-counters.schedule option.
update-mailbox-counters.cmd refereshInvalidMailboxCounters.py

-H localhost -p 9160 -o update-mailbox-counters.log

Command line for update-mailbox-counters task execution

Command line format: refereshInvalidMailboxCounters.py -H localhost -p 9160 -o <log file name> [-v] [-f all|<number>]
where:

  • refereshInvalidMailboxCounters.py is the name of the script file located in /<FS_installed_path>/python/util
  • -H localhost -p 9160 is the Feature Server Cassandra host and port. These parameters may be changed only for external Cassandra deployments.
  • -o <script log file name> is the script log filename and may include a full path. If the filename is specified, then the default location is /<FS_Installed_path>/python.
  • -v enables additional logging (verbose mode).
  • -f all|<number> enables ‘fix’ mode, which changes invalid counters. If -f parameter is missing, then script generates only the report and no changes are made to the database. The word 'all' can be replaced by an integer, which is the number of changes to be fixed.
update-mailbox-counters.schedule 0 0 6 ? * SUN Schedule time for task to run. Should be configured in cron style format.
delete-expired-messages.active false, true When set to true, this option will enable and schedule the task at time configured in option delete-expired-messages.schedule.
delete-expired-messages.cmd removeExpiredMessages.py

-H localhost -p 9160 -o delete-expired-messages.log

Command line for delete-expired-messages task execution.

Command line format: removeExpiredMessages.py -H localhost -p 9160 -o <log file name>
where:

  • removeExpiredMessages.py is the name of the script file located in /<FS_installed_path>/python/util.
  • -H localhost -p 9160 is the Feature Server/Cassandra host and port. These parameters may be changed only for external Cassandra deployments.
  • -o <script log filename> is the script log filename and may include a full path. If the filename is specified, then the default location is /<FS_Installed_path>/python.
Important
For each run, the script will create a new log file <script log file name>_<datetime>.log.
delete-expired-messages.schedule 0 0 4 ? * SUN Schedule time for task to run. Should be configured in cron style format.
forget-me.active false, true When set to true, this option will enable the task and will schedule the task at time configured in option forget-me.schedule.
forget-me.cmd forgetMe.py --dbhost <host> --dbport <port> Command line for forget-me task execution.

Command line format: forgetMe.py --dbhost <host> --dbport <port>
where:

  • forgetMe.py is the name of the script file located in /<FS_installed_path>/python/util.
  • --dbhost <host> --dbport <port> is the Feature Server/Cassandra host and port.
forget-me.schedule 0 0 6 ? * * Schedule time for task to run. Should be configured in cron-style format.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on July 25, 2018, at 02:20.