Administration

UCX Administration
Advanced Settings
IMPORTANT

Use caution when making changes to settings on this page! You are urged to backup before making any changes!

Overview

The Advanced Settings page contains settings that are applied to the entire UCX system. One of the first steps in the configuration of your UCX system is to review the Advanced PBX settings.

To view the Advanced settings of your UCX system, perform the following steps:

  1. From the PBX tab, select PBX Configuration
  2. From the left side column, select Advanced Settings
  3. Review the configured defaults

Review Settings

You should review and configure at least the following settings:

  • Asterisk Dial Options – Options to be passed to the Asterisk Dial Command when making internal calls or for calls ringing internal phones. Go to the Asterisk Dial Options section for details, a subset of which are described here.
    The default options T and t allow the calling and called users to transfer a call with ##.
    The r option allows Asterisk to generate ringing back to the calling phones which is needed by some phones and sometimes needed in complex dialplan features that may otherwise result in silence to the caller.
  • Asterisk Outbound Trunk Dial Options – Options to be passed to the Asterisk Dial Command when making outbound calls on your trunks when not part of an Intra-Company Route. Go to the  Asterisk Dial Options section for details, a subset of which are described here.
    The default options T and t allow the calling and called users to transfer a call with ##.
    It is HIGHLY DISCOURAGED to use the r option here as this will prevent early media from being delivered from the PSTN and can result in the inability to interact with some external IVRs.
  • Country Indications Tones – Select the localized indications for your country/region.

Making Changes

If you change a setting, you must save the change by clicking on the green check mark icon  that appears on the right hand side of the setting.

You can restore the default value by clicking on the green arrow icon . This icon is displayed if the value is not the default.

The example below shows the green icons after a change is made to one of the settings.

Modules

Asterisk Builtin mini-HTTP server

FieldDescription
Enable Static ContentDefault is False
Enable the mini-HTTP ServerDefault is False. Set this to True to enable the mini-HTTP server
HTTP Bind AddressDefault is blank. Enter a specific network interface for additional security
HTTP Bind PortDefault is 8088. Change this as required
HTTP PrefixDefault is blank

AdvSettingsBuiltinminiHTTPServer.png

Note that to begin using this interface you need to enable the AMI interface in the manager.conf file. Refer to Configuration File Editor for additional details.

Call Flow Control Module

FieldDescription
Hook Time Conditions ModuleBy default, the Call Flow Control module will not hook Time Conditions allowing one to associate a call flow toggle feature code with a time condition since time conditions have their own feature code. If there is already an association configured (on an upgraded system), this will have no affect for the Time Conditions that are effected. Setting this to TRUE reverts the behaviour by allowing the use of a call flow toggle to be associated with a time condition.
This can be useful for two scenarios:
First, to override a Time Condition without the automatic resetting that occurs with the built-in Time Condition overrides.
Second is the ability to associate a single call flow toggle with multiple time conditions thus creating a master switch that can be used to override several possible call flows through different time conditions.

Call Forward Module

FieldDescription
Call Forward RestrictionsThis option is to determine which Call Restrictions are to be used when calling an extension that is forwarded to an external destination: caller or callee.
Note: this option is used only for calls between extensions.
Create Call Forward HintsSetting this flag will generate the required dialplan that allows users to subscribe to BLF notifications about the device call forwarding status.

ChanSpy Direct Settings

FieldDescription
ChanSpy Direct Excluded ExtensionsA list of extensions to be excluded from the ChanSpy Direct Feature (i.e. extensions that cannot be listen to). enter a comma separated list of extensions and/or extension ranges (do not use spaces).
For example: 221,222,240-249,299
ChanSpy Direct PasswordPassword required to listen to or listen & whisper to a specific extension.

DAHDI Configuration Module

FieldDescription
Allow PRI Discrete ChannelsDAHDI trunk configuration is normally done using groups for PRI configuration. if there is a need to configure trunks to specific channels, setting this to TRUE will allow each channel to be configured. This can be useful when troubleshooting a PRI and trying to isolate a bad B Channel.
Software ECSoftware EC to be used in system.conf.

Device Settings

FieldDescription
Require Strong SecretsRequires a strong secret on SIP and IAX devices with at least two numeric and non-numeric characters, and a minimum of 6 characters.
SIP canreinvite (directmedia)Default setting for SIP canreinvite (same as directmedia). See Asterisk documentation for details.
SIP trustrpidDefault setting for SIP trustrpid. See Asterisk documentation for details.
SIP sendrpidDefault setting for SIP sendrpid. A value of YES is equivalent to RPID and will send the Remote-Party-ID header. A value of PAI will send the P-Asserted-Identity header. See Asterisk documentation for details.
SIP nat

Default setting for SIP nat.

  • YES will attempt to handle nat, also works for local (uses the network ports and address instead of the reported ports).
  • NO follows the protocol.
  • NEVER tries to block it, no RFC3581.
  • ROUTE ignoes the rport information.

See Asterisk documentation for details.

SIP encryptionDefault setting for SIP encryption. Whether to offer SRTP encrypted media (and only SRTP encrypted media) on outgoing calls to a peer. Calls will fail with HANGUPCAUSE=58 if the peer does not support SRTP. See Asterisk documentation for details.
SIP qualifyfreqDefault setting for SIP qualityfreq. Frequecy that ‘quality’ OPTIONS messages will be sent to the device. Can help to keep NAT holes open but not dependable for remote client firewalls. See Asterisk documentation for details.
SIP and IAX qualifyDefault setting for SIP and IAX qualify. Whether to send periodic OPTIONS messages (for SIP) or otherwise monitor the channel, and at what point to consider the channel unavailable. A value of YES is equivalent to 2000, time in msec. Can help to keep NAT holes open but not dependable for remote client firewalls. See Asterisk documentation for details.
SIP trunk inbound limit handling

This option sets the action(s) taken when the configured maximum SIP trunk channel limit (if any) is exceeded by a new inbound call. The options are:

  • warning – generate a warning event only (default)
  • congestion – generate a warning event and reject the call with a congestion message followed by the congestion tone

Dialplan and Operational

NOTE

Use caution when changing the setting for Disallow Transfers for Inbound Callers. Read the notice Security exploit of the Transfer functionality (FREEPBX-12058) before making the change.

FieldDescription
Block CNAM on External TrunksSome carriers will reject a call if a CallerID Name (CNAM) is presented. This occurs in several areas when configuring CID in the PBX using the format of ‘CNAM’. To remove the CNAM part of CID on all external trunks, set this value to TRUE. This WILL NOT remove CNAM when a trunk is called from an intra-company route. This can be done on each individual trunk in addition to globally if there are trunks where it is desirable to keep CNAM information, though most carriers ignore CNAM.
Call Recording PolicyThis policy is used to resolve the winner in a conflict between two extensions when one wants a call recorded and the other does not, if both their priorities are also the same.
Generate Diversion HeadersIf this value is set to TRUE, then calls going out on outbound routes that originate from outside the PBX and were subsequently forwarded through a call forward, ring group, follow-me or other means, will have a SIP diversion header added to the call with the original incoming DID assuming there is a DID available. This is useful with some carriers that may require this under certain circumstances.
Voicecall Ignores DNDWhen this value is set to TRUE, intercom calls will be sent to extensions even when the extension has been set to DND (Do Not Disturb) by the user. This is a system-wide setting. Default value is FALSE.
Asterisk dial OptionsOptions to be passed to the Asterisk Dial command when making internal calls or to calls ringing internal phones. See Asterisk Dial Options for details.
Asterisk Outbound Trunk Dial OptionsOptions to be passed to the Asterisk Dial command when making outbound calls on trunks when not part of an intra-company route. See Asterisk Dial Options for details.
Country Indication TonesChoose the country’s indication tones to use when creating the different standard telephony tones such as ringing, busy, congestion, etc.
Disallow Transfers for Inbound CallersDisallow transfer features (by default ## and *2) for callers who pass through inbound routes (e.g. external callers).
Display CallerID on Calling PhoneWhen set to TRUE and when CONNECTEDLINE() capabilities are configured and supported by the phone, the CID value being transmitted on this call will be updated on the phone in the CNAM field prepended with CID; so user knows what is being presented to the caller if the outbound trunk supports setting the transmitted CID.
Display Dialed Number on Calling PhoneWhen set to TRUE and when CONNECTEDLINE() capabilities are configured and supported by the phone, the number actually dialed will be updated on the phone in the CNUM; so user sees the final manipulated number.
No Answer Timeout for Attended TransferThe number of seconds to wait for an attended transfer destination to answer when using the Asterisk Attended Transfer function for a Blind Transfer. The default value is 15 seconds.
Ringtime DefaultDefault number of seconds to ring phones before sending callers to voicemail or other destinations. This can be set per extension. Extensions with no voicemail or other destinations will ring indefinitely.
Speaking Clock Time FormatTime format to use with the Speaking Clock.
Digital Trunk Inbound DelayA processing delay after receiving an inbound call over a digital trunk.
Enable this delay if the digital trunk (PRI) is connected to a CO that sends the caller ID number (CNUM) in the setup message and the caller ID name (CNAM) in a following facility message. When such a call is routed to a SIP endpoint (trunk or phone) without a delay, the caller ID name is not presented to the SIP endpoint until the call is answered. Configuring a short delay allows the facility message to be processed before routing the call to the SIP endpoint – the caller ID name is then presented when the call starts ringing at the SIP endpoint.

UCX70AdvSettingsDialPlanandOperationalv2.png

Follow Me Module

FieldDescription
Create Follow Me at Extension Creation TimeWhen creating a new extension, setting this to TRUE will automatically create a new Follow-Me for that extension using the default settings listed below.
Disable Follow Me Upon CreationDefault value for Follow-Me Disable setting. When first creating a Follow-Me or if auto-created with a new extension, setting this to TRUE will disable the Follow-Me setting which can be changed by the user or admin later.
Default Follow Me Ring TimeThe default Follow-Me Ring Time when first created or if auto-created with a new extension.
Default Follow Me Initial Ring TimeThe default Follow-Me Initial Ring Time when first created or if auto-created with a new extension.
Default Follow Me Ring StrategyThe default Follow-Me Ring Strategy when first created or if auto-created with a new extension.
Follow Me RestrictionsThe default value for setting the dialing restrictions used to when deciding how to handle any outbound calls initiated by Find Me settings. Choices are to use the restrictions associated with the Caller (the party that originated the the call to the extension configured for Follow Me) or the Callee (the party that is configured for Follow Me).
Loop Prevention – Minimum DID SizeThis option is used to configure the minimum size of DID numbers configured on the Inbound Routes page that should be checked in order to avoid Follow Me to DID loops.
When this option is enabled and a configured DID is matched with a number in the Follow Me list, the number is skipped.
The values are: disabled (default), 4567891011.

Media Settings

NOTE

If you are using InfinityOne softphones and do not have ICE enabled, InfinityOne calls will ring, but no speech path will be established.

FieldDescription
ICE Support EnabledSet this field to TRUE if you are configuring InfinityOne softphones on your system. (Does not require STUN to also be configured.)
STUN Server HostnameA valid STUN server (such as stun.emetrotel.org:3478) may be required to be configured to resolve unusual network configurations that result in no speech path. Use as directed by E-MetroTel Support.

Queues Module

FieldDescription
Hide Queue No Answer OptionThe field Queue No Answer is hidden by default. To display the field, you have to change this setting to False.
Agent Called Events DefaultDefault state for AMI events related to an agent’s call. This setting only affects the default for NEW queues, does not change existing queues.
Member Status Event DefaultDefault state for AMI QueueMemberStatus event. This setting only affects the default for NEW queues, does not change existing queues.
Stop Recording After TransferWhen an external incoming queue call that is being recorded is transferred by an agent, you can choose either to stop recording the call or to continue recording the call.

System Setup

FieldDescription
Call Recording FormatFormat to save recorded calls for most call recording unless specified differently in specific applications.

Time Condition Module

FieldDescription
Enable Maintenance PollingIf set to FALSE, this will override the execution of the Time Conditions maintenance task.
Maintenance Polling IntervalThe polling interval in seconds used by the Time Conditions maintenance task.

User Portal

FieldDescription
User Portal EnabledControls whether the UCX responds to https login requests to access the User Portal for any extension on the system (i.e. https://<ucxipaddress>/recordings). Set to True to enable the portal or False to disable it.

UserPortalSetting.png

Voicemail Module

Field
Description
Mask Voicemail PasswordsThis field controls the display of the voicemail password, “masked” or “unmasked” in the Extensions page. By default the password is unmasked (False).
Create Voicemail HintsSet this to TRUE to allow the programming of busy lamp fields (BLF) for voicemail boxes on your phone.
Provide IMAP Voicemail FieldsSet this to TRUE if you have voicemail configured with IMAP, so the IMAP username and password fields are displayed on the Extensions page.

Asterisk Dial Options

The Asterisk Dial Options are defined in two fields:

  • Asterisk Outbound Trunk Dial Options (for outgoing external calls)
  • Asterisk Dial Options (for other types of calls)

The system wide settings for these options are defined in the Advanced Settings page under the Dialplan and Operational section. The values set should be appropriate for the majority of usage in the system to reduce the need to override them. The default system wide values on the UCx system are:

  • Outbound Trunk Dial Options = Tt
  • Asterisk Dial Options. = Ttr

The system wide values can be overridden in two places by checking the Override box beside the field:

  • In the Trunk configuration page you can override the values for Asterisk Outbound Trunk Dial Options
  • In the Extension configuration page you can override the values for Asterisk Dial Options
OptionDescription
D(called:calling)Send the specified digits after the called party has answered, but before the call gets bridged. The ‘called’ digits are sent to the called party, and the ‘calling’ digits are sent to the calling party. Both arguments can be used alone.
hAllow the called party to hang up by using the In-Call Asterisk Disconnect code (default value is **)
HAllow the calling party to hang up by using the In-Call Asterisk Disconnect code (default value is **)
iAny forwarding requests that may be received on this dial attempt will be ignored.
IAny connected line update requests or any redirecting party update requests that may be received on this dial attempt will be ignored.
rGenerate ringing to the calling party, even if the called party is not actually ringing. Pass no audio to the calling party until the called channel has answered.
S(x)Hang up the call x seconds after the called party has answered the call.
tAllow the called party to transfer the calling party by using the In-Call Asterisk Blind Transfer code (default value is ##)
TAllow the calling party to transfer the called party by using the  In-Call Asterisk Blind Transfer code (default value is ##)
wAllow the called party to enable recording of the call by using the  In-Call Asterisk Toggle Call Recording code (default value is *1)
WAllow the calling party to enable recording of the call by using the  In-Call Asterisk Toggle Call Recording code (default value is *1)
NOTE

Checking the Override box clears the default system wide value and makes the field editable. Make sure the desired options are entered in the field. If left blank, call features like Call Park that require the Blind Transfer capability will not work.

Contents