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).
Contents
- 1 Configuration options
- 1.1 Cassandra section
- 1.2 Cluster section
- 1.3 dialplan section
- 1.4 dm section
- 1.5 dm-gax-plugin section
- 1.6 fs-gax-plugin section
- 1.7 gdpr section
- 1.8 Log section
- 1.9 Monitoring section
- 1.10 python section
- 1.11 security section
- 1.12 SMTP section
- 1.13 TServer section
- 1.14 VoicemailServer section (Application object)
- 1.15 VoicemailServer section (Switch)
- 1.16 history-log section
- 1.17 ScheduledTasks section
Cassandra section
| Option | Values (default value in bold) | Description |
|---|---|---|
| connection-pool-limit | 15, or any positive number | Limits the number of connection pools to Cassandra when the rate limiting feature is applied to Voicemail, GAX, and Device Management.
This value must be higher than the value set for request-rate-vm, request-rate-dm and request-rate-gax.
When the value is configured as 0 or not configured, the default value of maximum 15 connections will be allowed. |
| connection-type | thrift (or empty) for THRIFT or cql for CQL, values are not case-sensitive. | When set to CQL, Feature Server attempts to make connection to external Cassandra using the CQL protocol. If you want to use this option, the embedded Cassandra should have been disabled in the startup mode of Feature Server. You can do this by setting the startCassandra parameter (com.genesyslab.common.application.cassandraServer) to false in launcher/_64.xml. Setting Feature Server to use the CQL protocol while embedded Cassandra is enabled does not give any result.
Takes effect after restart. |
| 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:
|
| replicationOptions | replication_factor=2, replication_factor=3, replication_factor=4, ... (or) |
Specifies the number of Cassandra nodes used in the replication scheme, depending on the value of replicationStrategyClassName:
|
| 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.
Note: For Cassandra to retry in a particular interval, make sure you also set an appropriate interval in the retry-sleep-ms option. |
| retry-sleep-ms | None, <positive integer value> | Defines the interval time after which Feature Server triggers Cassandra to retry a failed Cassandra read/write operation.
To be configured in milliseconds. Note: This option must be configured along with the retry-max-attempts option for Cassandra to retry after a failure. |
| 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. |
| trusted-ca | Default is empty (no certificate validation), Absolute or relative path (from Feature Server installation folder) to the PEM file that has trusted authority certificate to validate remote Cassandra server when establishing the TLS connection. | Specifies whether to validate the server certificate when TLS CQL connections are established between Cassandra and Feature Server core and its Dialplan sub-module. When this option is not configured, validation wouldn't occur even when TLS is enabled. Note that when this option is set incorrectly, Feature Server wouldn't start.
If you want to use this option, Feature Server's startup criteria should have the cassandra_encryption parameter (com.genesyslab.voicemail.application.cassandraEncryption) set to true (in launcher/_64.xml) Takes effect after restart. |
| verify-host | false, true | Specifies whether Feature Server's Dialplan module should validate the FQDN of host being contacted. When set to true and TLS CQL connection is enabled for Cassandra, Dialplan validates the FQDN of the host with the values provided in trusted-ca certificate.
If the FQDNs doesn't match, the TLS connection is not established. If the trusted-ca option is not set or cassandra_encryption is not enabled during startup, then enabling this option does not give any result. Takes effect after restart. |
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. Configuring to false will perform an initial import of tenant data and switch data of its switch during the first startup. In rare scenarios, Cassandra data between nodes might become inconsistent. This may appear that the switch data is not available in the Cassandra database. Therefore, SIP Feature Server would re-import all the switch data, resulting in data duplication. To prevent this duplication, configure the option to true after first startup. This disables the initial import trigger in the subsequent starts/restarts. |
| 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. |
| reimport-on-conf-history-log-error-max-attempts | 5, Positive integer value | This limits the number of reimport loops that occur due to permission error on retrieving history log information from the Configuration Server.
This option is available for SIP Feature Server 8.1.202.33 and later versions. |
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. |
| cassandraPoolSize | 15 and above, or any positive number | Specifies the SIP Feature Server dialplan Cassandra pool size utilized for all Cassandra operations. You must restart SIP Feature Server for the changes to reflect. |
| 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. |
| dialplanEnhancement | false, true | When set to true, this option enables performance monitoring of dialplan such as heartbeat, health check and response code improvements of SIP Feature Server.
Important This option is supported only for SIP Feature Server 8.1.202.33 and later versions. To handle the SIP Feature Server error responses and exceptions, SIP Server 8.1.103.79 and later versions must be used. |
| 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. |
| log-python-stdout-capture | false, true | When Cassandra's connection-type option is set to CQL, then setting this option to true captures the error/crash printouts from Dialplan sub-process of Feature Server application into the main Feature Server logfile (in case python process terminates unexpectedly). |
| 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. |
| profileRefreshInterval | 300 | SIP Feature Server Dialplan refreshes all profiles and partitions into cache after every interval of the timer configured. The values are in seconds. (Valid values can be 1 and above.)
Important This option is supported only for SIP Feature Server 8.1.202.33 and later versions. |
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. |
| corrupted-messages-threshold | None, <positive integer value> | Specifies the threshold value of the number of corrupted messages in the mailbox. |
| 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. |
| prometheus-monitoring | false, true | When set to true, this option enables SIP Feature Server to capture statistics that can be monitored using the Prometheus tool. Value change requires restart of SIP Feature Server. |
| request-rate-gax | 50, zero, or any positive number | The number of requests per second that SIP Feature Server can process from fs-gax-plugin and dm-gax-plugin.
When the value is configured as 0, there is no rate limit applied. |
| request-rate-vm | 50, zero, or any positive number | The number of requests per second that SIP Feature Server can process from Media Control Platform (MCP) during voicemail deposit and access.
When the value is configured as 0, there is no rate limit applied. |
| request-rate-dm | 100, zero, or any positive number | The number of requests per second that SIP Feature Server can process by provisioning requests from IP Phones through Elastic Load Balancing (ELB) and IP phone upgrade requests.
When the value is configured as 0, there is no rate limit applied. |
python section
| Option | Values (default value in bold) | Description |
|---|---|---|
| process-launcher | python or empty, Absolute file path or an executable name (if can be found using Operating System's PATH , as applicable to FS process) to start the standalone python process installed on the system. | When Cassandra's connection-type option is set to CQL, the Dialplan and Maintenance/Scheduler script execution will be performed using external python interpreter. This option helps to specify alternative name for external python 3.X executable. In the Thrift mode execution of Dialplan, Maintenance/Scheduler scripts is performed by embedded jython interpreter (python2). |
security section
| Option | Values (default value in bold) | Description |
|---|---|---|
| security-headers-enabled | true, false | When set to true, security headers will be added to all API calls in SIPFS. |
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.
|
| 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. |
| 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. |
| cassandra-counter | true, false | When set to true, the default Cassandra counter is used for calculating voicemail messages count. When set to false, Feature Server uses its own methodology to calculate the voicemail messages count.
Note: This option is supported only for SIP Feature Server 8.1.202.19 and later versions. For upgrading existing deployments, this option should be configured to false only after upgrading all the SIP Feature Server applications to 8.1.202.19 and later versions. |
| disable | true, false | When set to true, the Voicemail functionality will be disabled for both VUI and TUI. However, when managing mailboxes and messages, the profiles can be still provisioned even when Voicemail is disabled. |
| disable-general-deposit-prompt | false, true | When set to true, this option disables the prompt, Please leave your message after the tone and press # when you finish, during voicemail deposit.
|
| enable-default-password | false, true | Indicates whether users can use mailbox IDs as default passwords to log on to a mailbox. When set to false, SIP Feature Server allows mailbox IDs to be used as default passwords. When set to true, administrators must assign first-time passwords to all mailboxes. The first-time password can be used to log on to the mailbox once, after which, users must set unique mailbox passwords. Default passwords are optional only when user-login is set to false. When user-login is set to true, this option does not take effect. |
| 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.
|
| locale | en-US, other locale strings | Specifies the default locale for the Telephone User Interface (TUI). |
| max-concurrent-sessions | Numeric Value | This option restricts the number of concurrent voicemail access sessions for all users. If this option is not configured, there will be no restriction for the concurrent voicemail access, which takes effect for the next voicemail access. This option will be effective only when the user-login option is set to true.
|
| 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 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 Switch level. If set on both levels, the application level setting takes precedence. |
| prompt-delay-ms | 0, zero or any positive integer in multiples of 600 ms and not greater than 6000 ms (6000 ms = 6 seconds). | Enables delay by introducing silent prompts in multiples of 600 milliseconds before each menu's first prompt during voicemail access. 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.
Note: For the home or welcome menu, the value configured in access-first-prompt-delay-ms 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. |
| skip-optout-prompt | false, true | When set to true, the option disables the prompt, "To interrupt recording and hear more options, press 0 at any time” during the voicemail deposit session.
|
| skip-confirm-ouptout-prompt | false, true | When set to true, the option disables the prompt, "To continue without leaving a message press 1, To leave a message press 2” during the voicemail deposit session.
|
| 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:
|
| 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. |
| user-login | false, true | Indicates whether mailbox validation will be done through a common user password or not. |
| 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. |
| vxml-access-fetch-timeout | 60, any positive integer | This parameter controls the timeout in MCP. |
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. |
| 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.
|
| 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.
When SSL and Cassandra authentication is enabled, the following three additional parameters must be appended to the existing values for the <script name>.cmd option:
- -u <username>—The Cassandra username. Default value is "cassandra".
- --pw <password>—The Cassandra password. Default value is "cassandra".
- --tls—Enables SSL connection.
For example, if we consider update-mailbox-counters task, update-mailbox-counters.cmd must be set as "refereshInvalidMailboxCounters.py -H localhost -p 9160 -o update-mailbox-counters.log -u cassandra –pw cassandra –tls".
| 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>]
|
| 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>
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>
|
| forget-me.schedule | 0 0 6 ? * * | Schedule time for task to run. Should be configured in cron-style format. |
| reimport.active | false, true | When set to true, this option will enable the task and will schedule the task at the time configured in the reimport.schedule option. |
| reimport.schedule | Time in CRON format | Schedule time for the task to run. Should be configured in CRON style format. |
This page was last edited on August 6, 2024, at 11:43.
Comments or questions about this documentation? Contact us for support!