SARK UCS/MVP Globals Panel

SARK UCS/MVP _ Globals Panel is the place where various system variables are declared. The variables are as follows:-

Globals Panel Variables

General Settings

Your External IP Address:

Description - This can be specified as either a url or an IP dotted quadrant. It is usually only required to make and receive SIP calls when SME Server is running behind a firewall. If you only make and receive IAX calls, or your SME Server is running in Server-Gateway mode and directly connected to the internet, then you should leave this field blank.
Permissable values - url or IP dotted quadrant or blank.
Default - Empty.

Your Country Identifier:

Description - Country identifier is a two digit code. SARK UCS/MVP uses it to set the correct ring cadences etc. for your country.
Permissable values - au (Australia), br (Brasil), cl (Chile), de (Germany), ee (Estonia), fi (Finland), fr (France), gr (Greece), hu (Hungary), it (Italy), lt (Lithuania), mx (Mexico), nl (Holland), no (Norway), nz (New Zealand), pl (Poland), pt (Portugal), sg (Singapore), se (Sweden), tw (Taiwan), ru (Russia), uk (United Kingdom), us (USA), za (South Africa).
Default - uk

Optimise Speech Compression for:

Description - Drop Down; dictates the speech compression strategy which SARK UCS/MVP will employ for VOIP communications.
Permissable Values - FIDELITY|THRUPUT|g729
Default - FIDELITY
Explanation - SARK UCS/MVP will set all of your iax/sip entries automatically to minimise inter-CODEC translation as follows:-

• • In FIDELITY mode, SARK UCS/MVP will, by default, use alaw/ulaw for all VOIP communication.
  • In THRUPUT mode, SARK UCS/MVP will use gsm/alaw/ulaw.
  • Also in THRUPUT mode, if you have registered any g729 licenses, SARK UCS/MVP will use g729/gsm/ulaw/alaw.
  • In g729 mode, SARK UCS/MVP will force g729 throughout the system irrespective of whether you have any g729 licenses. This is useful if you intend to operate in g729 passthru mode.

You can override/modify the SARK UCS/MVP strategy by adding CODECs of your own choice in the headers, trunklines and extensions panels.
Note - you can change this setting at anytime. Existing entities will be retrospectively changed by SARK UCS/MVP to comply with the new strategy.

Log Call Data Records to MySQL:

Description - Dropdown. Dictates whether Asterisk will log locally or to MySQL.
Permissable values - YES|NO.
Default - NO
Note 1 - By setting this value to YES in a commercial/production environment you agree to abide by the licensing requirements for MySQL. See www.mysql.org
Note 2 - For the stats package to work this value must be set to YES.

Call Recording System Default:

Description - Dropdown. Controls System-Wide Recording defaults
Permissable values - None|OTR|OTRR*|Inbound|Outbound|Both.
Default - None
Note 1 - OTRR is only available with the Advanced Voice Recording option (AVR)

Path to Recording Directory:

Description - Path to the recording Directory
Permissable values - Full Linux file path .
Default - /var/spool/asterisk/monitor
Note - if you elect to use your own dircetory then it is your resposibility to ensure that permsissions are correctly set

Voicemail Instructions:

Description - Dropdown.
Permissable values - YES|NO.
Default - YES
Note 1 - Determines whether long or short voicemal instructions are given by the auto attendent.

Late Termination:

Description - Dropdown. Dictates whether SARK UCS/MVP will terminate inbound calls as soon as it sees them or wait until the callee lifts the receiver
Permissable values - YES|NO.
Default - NO
Note 1 - Setting this to yes can sometimes lead to a slight perceived delay in the call "opening up" on the part of the caller. This usually only happens with mobiles, however, if it is a problem then use early termination by setting this value to "NO".

Conference Type:

Description - Dropdown. Specifies how the SARK UCS/MVP will set-up conferencing.
Permissable values - {simple|announced} Default - simple

Skin:

Description - Drop Down.
Permissable values - SME|SarkBlue.
Default - SME.

Allow Hash Transfer:

Description - Allow users to do hash transfers.
Default - No

EXTENSIONS

Extension Start Number:

Description - This is the beginning extension number off which SARK UCS/MVP will allocate extension numbers. It should be a 4 digit number.
Default - 5000.

Dynamic Proxy Enable:

Description - Dropdown. Dictates whether SARK UCS/MVP will run its Dynamic Proxy.
Permissable values - YES|NO.
Default - NO
Note 1 - Setting this value to YES will enable you (in some circumstances) to proxy through the server manager panel to individual telephones. Phones known to work are; Snom (all variants - 2xx and 3xx series), Aastra (9112i, 9133i, 480i), Grandstream (all variants), Sipura/Linksys (all variants - phones may be inspected but not updated), Polycom (all variants), Mitel (52XX series, all variants, some screens mis-display and update is not allowed)

Proxy Ignore

Description - List. Spedcifies uri's to ignore during proxy operations.
Permissable values - uri list separated by white space.
Default - Empty
Note 1 - SIP phones rarely give back clean canonical uri's. The Dynamic Proxy manager attempts (where it can) to remedy this. However, for other non-SME apps (contribs) running under the server manager you will probably want to bypass this behaviour. Uri's listed here will be ignored by the Dynamic Proxy manager.

Default Ring Time (Seconds)

Description - How long to ring an extension before continuing to the outcome
Permissable values - n (where n is seconds).
Default - 10

Class of Service:

Description - Dropdown. Class of Service master toggle
Permissable values - ON|OFF
Default - OFF

Agent Start:

Description - Start number off which Dynamic Agent ID's will be allocated.
Permissable values - 4 digits.
Default - 1001

Auto Create Alias digits:

Description - Dropdown. Automatic alias creator
Permissable values - Any from the drop down.
Default - none
Note 1 - Setting this value will prepare the system to create an automatic alias for each extension on the system. The actual creation is done in the Alias (now Call Groups) Panel. This feature was useful in earlier SARK releases which only supported 4-digit extension numbers. It will truncate the 4 digit extension to create a 2 or 3 digit alias. Thus, for example, extensions 5221 thru 5229 can have aliases 221 thru 229 or aliases 21 thru 29 created automatically by the system.

System operator:

Description - Here you define how you would like your local switchboard to be numbered
Permissable values - 0 - 1000.
Default - 0
Note - Ensure that the number you choose does not conflict with an alias.

Operator Real Extension: (default Extension Start) :

Description - This is the system operator extension
Permissable values - 1000 - 9999.
Default - Extension Start

EMERGENCY:

Description - EMERGENCY class of service
Permissable values - A set of permissable asterisk dial plan masks.
Default - none
Note 1 - Setting this field will determine the set of emergency numbers which can ALWAYS be dialled by any extension, irrespective of any active class of service restraint.

AUXILIARY SERVERS

TFTP Server:

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run the tftp server
Permissable values - enabled|disabled.
Default - YES
Note 1 - This field is only relevent if you have tftp-server installed.
Note 2 - For further information on tftp operations see DocChapter254.

Flash OPerator Panel:

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run the FOP Daemon
Permissable values - enabled|disabled.
Default - YES

mISDN Driver:

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run the mISDN Daemon
Permissable values - enabled|disabled.
Default - NO

Spamassassin(spamd):

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run spamassassin
Permissable values - enabled|disabled.
Default - YES

Squid Proxy

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run the Squid Proxy
Permissable values - enabled|disabled.
Default - YES

CLAM AV & Freshclam

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run clamd
Permissable values - enabled|disabled.
Default - YES

Multitimer

Description - Dropdown. Dictates whether SARK UCS/MVP will start and run the Multitimer Daemon
Permissable values - enabled|disabled.
Default - NO

VINTAGE EMULATION

Alert-Info for Blind Xfer Bounce

Description - Used to control ringtone on the target handset after a bounce event
Permissable values - A valid SIP header string for the target device.
Default - empty

Campon mini-queue ON/OFF

Description - Controls whether campon directives will be obeyed
Permissable values - ON|OFF.
Default - OFF

Bounce busy destination

Description - Controls where bounce calls will be delivered if the originator is busy
Permissable values - Any valid system end-point.
Default - Operator

Campon mini-queue options

Description - Controls campon mini-queue behaviour
Permissable values - Any valid Asterisk queue parameters.
Default - r,,,30

VOIP SETTINGS

Maximum LOCAL VOIP calls:

Description - Local Inter-node Call Choke. Once this limit is reached, SARK UCS/MVP will stop placing inter-node calls until the load reduces below the limit.
Permissable values - Can be set to any positive digit value.
Default - 24.
Note - This field is only of relevence if you are running three or more SARK UCS/MVP nodes on the same LAN. Its fundamental purpose is to catch runaway trunk-hunt and call-forward loops. SARK UCS/MVP can detect and catch intra-node embraces, intra-node loops and inter-node embraces. However, it cannot directly detect inter-node loops. In such cases, this field will act as a fail-safe. VOIP traffic (unless exteremly high) should not tax a modern 100Mb or Gb LAN. Therefore, as a rule of thumb you should set this value to the number of extensions you have on the node.

Maximum outbound VOIP calls:

Description - Outbound Call Choke. Once this limit is reached, SARK UCS/MVP will stop placing calls via VOIP until the load reduces below the limit. If LCL VOIP or PSTN lines are available (and specified in the relevant Route), SARK UCS/MVP will attempt to place the call on them, otherwise the user will hear a busy signal and the line will be disconnected. see SAIL Bandwidth Usage
Permissable values - Can be set to any positive digit value.
Default - 3.
Note - The exception to this rule is for those trunks which run Local Lookaside (LCL); Calls on LCL Trunks do not increment this counter - see Trunklines.

Induced VOIP Ring Time (seconds):

Description - Inbound VOIP calls do not naturally "ring". This setting will place an artificial ringtone onto the circuit for n seconds before routiing the call.
Permissable values - Can be set to any positive digit value.
Default - 0.

Autosense FAX Extension

Description - Which extension the Autosense FAX machine is on
Permissable values - Any valid extension number. See SAIL FAX management?
Default - None

FAX Detect Delay

Description - This value tells the system how long to wait (in seconds) while it attempts to sense an incoming FAX.
Permissable values - Any number of seconds. See SAIL FAX management?
Default - 2
Note - Only applies to incoming analog lines with FAX detection enabled. TDM400 boards sense FAXes about one second quicker than X100Ps? . Set to 2 seconds for TDM boards and 3 seconds for X100P? .

External ring delay

Description - Set ring delay (seconds) for incoming VOIP lines.
Permissable values - Any number of seconds.
Default - 5
Note - Only applies to incoming VOIP calls. Ordinarily, incoming VOIP to IVR calls do not ring. Callers tend to dislike this so you can force a ring tone onto the line for a period of seconds.

Internal ring delay before dropping to voicemail

Description - Set ring delay (seconds) for extensions.
Permissable values - Any number of seconds.
Default - 10

4-digit password for FOP operations:

Description - This password will be requested by the Flash Operator Panel (FOP) during certain privileged operations (i.e. call create/teardown etc).
Permissable values - 4 digits.
Default - 1234

4-digit password for KEY operations:

Description - This password will be requested by Asterisk during certain privileged keypad operations (i.e. operations at a telephone handset).
Permissable values - 4 digits.
Default - 1111

Vmail Xfer Delay:

Description - Delay to insert before direct transfers to voicemail.
Permissable values - 1 thru 9.
Default - 2.

Enable One-Touch Recording (OTR):

Description - Dropdown. Dictates whether allow OTR
Permissable values - YES|NO.
Default - NO
Note 1 - By setting this value to YES, the callee may record a call by pressing 1 at any time during a call.

Supervisor Email:

Description - Site specific supervisor email address
Permissable values - any valid email address.
Default - none
Note 1 - Setting this value will allow you to use *905* to receive a daily report of of CDR's.

Logging options:

Description - Dropdown. Specifies how the SARK UCS/MVP platform will manage logs and other volatile file elements
Permissable values - {native|ramdisk|usbstick}

• native - run in ordinary CentOS/SME Server mode with volatile directories in their normal mode/location.
• ramdisk - run volatile files in virtual memory. The term ramdisk is a little misleading since it isn't actually used. Instead, tmpfs files are created and mounted as needed.
• usbstick - run volatile files on an external USB connected device.

Default - native
Note 1 - Setting this value to anything other than "native" is primarily intended to be used in conjunction with low power and solid-state implementations. It allows you to direct SARK UCS/MVP to move volatile file directories, either into virtual memory (as tmpfs files) or onto a separate USB mass storage device thus minimising write activity to the main file system (which is usually held on compact flash in these scenarios).
Note 2 - USB memory-sticks must be formatted as ext2 if you wish to use them as logging devices - you can use them as dump/restore devices in FAT/VFAT mode if you wish (see below). FAT and VFAT file systems are not allowed for direct logging due to their inability to support concepts such as permissions and ownership.
NB - IMPORTANT NOTE! - SARK UCS/MVP volatile logging is principally designed for embedded implementations running without conventional disk drives. It operates in much the same way as most other embedded Linux implementations using a symlink-and-overmount architecture. In native mode, the symlinks are not created and the system runs entirely conventionally. In ramdisk and USBstick mode, the volatile datasets are moved to a central directory and the symlinks are created. It is important that you understand this because when the system is in one of these modes, an otherwise routine SME server update (using Yum) could lead to major data loss and a potentially catastrophic outcome. For this reason, you should turn Yum automatic updating OFF when you set this value to anything other than native. Setting the system back to native will allow you to perform regular SME Server maintenance without incident.

Play Tones on Congestion:

Description - Dropdown. Specifies how the SARK UCS/MVP will signal congestion state.
Permissable values - {YES|NO}

• YES - Play regular PSTN tone.
• NO - IVR Announce congestion.

Default - NO

Play Tones on Busy:

Description - Dropdown. Specifies how the SARK UCS/MVP will signal busy state.
Permissable values - {YES|NO}

• YES - Play regular PSTN tone.
• NO - IVR Announce busy.

Default - NO

Play Tones on Failover:

Description - Dropdown. Specifies how the SARK UCS/MVP will signal trunk failover has occurred.
Permissable values - {YES|NO}

• YES - Play a Beep.
• NO - Play nothing.

Default - NO

Diagnostic Alerts:

Description - Dropdown. Specifies Alert transport mechanism to be used by the diagnostic routines.
Permissable values - {sms|email|both}

Default - sms

SMSC Pathway:

Description - Full Asterisk pathway {Technology/Channel/Number}.
Permissable values - A valid Zap channel or group
Example - BT UK SMSC via an analogue channel Zap/7/07094009

SMS Alert Numbers:

Description - Whitespace separated list of target numbers to send sms alerts to.
Permissable values - Valid PSTN numbers
Note - These will usually be mobile numbers, however in the UK, BT offer a text-to-speech facility for sms to landline calls.

Email Alert Addresses:

Description - Whitespace separated list of target addresses to send email alerts to.
Permissable values - Valid email addresses

Group Transformation Mask

Description - Whitespace separated list of transformation couplets (see transformation masks in trunks for a full explanation). This mask is specifically for dials outbound to the ZAP Group.
Permissable values - Valid transformation couplets

Group CLID

Description - default CLID for dials outbound to the ZAP Group.
Permissable Values - Any Valid PSTN number.
Note - This value may not be honoured by your PTT. Consult your PTT for CLID rules on your PSTN Network.

Globals Panel Buttons

Save:

Description - Save changes.
Note 1 - Save will save your changes to the Selintra database ONLY. It will not ripple these changes through to the underlying platorm. Save is useful if you have lots of changes to make because it responds quickly and allows you to make a series of changes before you "commit" the to the system.

Commit:

Description - Commit outstanding changes and saves and rebuild the PBX config.
Note 1 - Commit will save your changes to the Selintra database AND rebuild the PBX (i.e. make your changes live).

Regress:

Description - Regress will put your system back to the state it was in at the last commit point -1.
Note 1 - SARK UCS/MVP can hold up to a maximum of 6 regressions.

Dump:

Description - Dump the SARK UCS/MVP "personality", together with a snapshot of all logfiles to USB Mass storage.
Note 1 - This button will only appear on the screen if SARK UCS/MVP detects a USB mass storage device connected to the system. If it does, it will automatically mount the device and ready it to read or write data. You can dump as many instances as you wish to USB, each one will be time stamped for later inspection/retrieval.

Restore:

Description - Restore a SARK UCS/MVP "personality" from USB Mass storage.
Note 1 - This button will only appear on the screen if SARK UCS/MVP detects a USB mass storage device connected to the system. If it does, it will automatically mount the device and ready it to read or write data. Choosing "Restore" will produce a list of the "personalities" (if any) stored on the USB device. Choosing one of these personalities will load and commit the personality to your SARK UCS/MVP system. Restore is very useful if you have many similar systems to build. One "master" system can have its personality saved to USB and then it can subsequently be uploaded to many different systems. Dump/Restore can also be useful as a quick-backup tool.