1. Manuals
  2. Brands
  3. SARK Manuals
  4. Conference System
  5. 500
  6. Administrator's manual

SARK 500 Administrator's Manual

Embedded voip/tdm pbx
Hide thumbs Also See for 500:
Table of Contents

Advertisement

Quick Links

Download this manual
SARK500 Embedded VoIP/TDM PBX
Administrators Guide V3.1
SARK Version 3 Release 1-115
May 2011

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the 500 and is the answer not in the manual?

Questions and answers

Related Manuals for SARK 500

Summary of Contents for SARK 500

  • Page 1 SARK500 Embedded VoIP/TDM PBX Administrators Guide V3.1 SARK Version 3 Release 1-115 May 2011...

  • Page 2: Table Of Contents

    3 FEATURES OVERVIEW ...................... 5 4 SARK IMPLEMENTATION ON THE WARP ............... 6 5 USING SARK ........................7 6 LOGGING ON TO SARK AND SETTING THE PASSWORDS ........... 9 7 ADDING TRUNKS ......................11 8 ADDING EXTENSIONS ..................... 18 9 CONFERENCING ......................21 10 INTERACTIVE VOICE RESPONSE .................

  • Page 3: Copyright Information

    1 Copyright Information TRADEMARKS SARK UCS/MVP and SARK500 are registered trademarks of Aelintra Telecom Limited. PIKA is a registered trademark of PIKA Technologies Inc. All other trademarks, product names and company names and/or logos cited herein, if any, are the property of their respective holders.

  • Page 4: Introduction

    VoIP telephony. The system can be configured with up to 20 IP handsets from any of the leading SIP manufacturers (e.g. Snom, Aastra, Cisco, Yealink etc). The onboard SARK UCS/MVP software provides a feature-rich graphical workbench and decision engine designed to generate and run efficient PBX images.

  • Page 5: Features Overview

    The Warp appliance is a purpose-designed solid state telephony platform with its own integrated analog, digital and GSM telephony boards. The SARK Implementation on the WARP appliance uses the SARK source code directly from the SARK svn repository. SARK is also available as, a CentOS 5 .iso, a tarball or a Redhat/CentOS rpm.

  • Page 6: Sark Implementation On The Warp

    Surprisingly few changes were necessary to deploy SARK onto the Warp platform. Over 90% of the code is exactly the same as it is on any other SARK platform. The C code has been recompiled for the WARP's PPC CPU and there are some other minor changes due to the absence of a regular System V initiator, however they are relatively minor.

  • Page 7: Using Sark

    5 Using SARK The SARK browser pages follow a standard layout. The figure below shows a typical SARK Web page. Navigation is handled by the column to the left of the screen. Modifiable data appears in the data window in the centre and information and action buttons appear to the right.
  • Page 8 SARK500 Embedded PBX System Buttons The system buttons are clustered to the right of each data panel. The available buttons are as follows NEW button. Used to create a new object instance SAVE button. Used to save an update or change ACTION button.

  • Page 9: Logging On To Sark And Setting The Passwords

    6 Logging on to SARK and setting the passwords To log on to SARK you will need to know the IP address of the appliance. To obtain the IP address; after the appliance starts press the touch sensitive button to the right of the LCD screen. The button toggles the LCD display between the line status view and the IP address view.
  • Page 10 SARK500 Embedded PBX Changing the Browser Password For security reasons, we recommend that you change the default browser password immediately using the change password panel. The system requires a password of at least 8 characters and you should try to use a mixture of upper and lower case and at least one numeric character.

  • Page 11: Adding Trunks

    SARK500 Embedded PBX 7 Adding Trunks Outbound trunks for FXO/ Digital (BRI) and inbound trunks for FXO are automatically installed on the platform so there is nothing to do to activate them. You will need to add/create inbound and outbound routing (see Routes below).
  • Page 12 DNID). To confuse matters further; in digital systems these numbers are often allocated in blocks by the telephone company and are known as DiD numbers (Direct Inward Dial) or DDI numbers (Direct Dial In). SARK has a special trunk construct to manage and route these DiD numbers. It is called a PTT_DiD_Group trunk and you can define a set of contiguous DiD numbers using this trunk type.
  • Page 13 DiDs to be created. Not to worry, if this happens you can simply regress SARK to the commit BEFORE you made a mistake.(see the section on Backup/Regress). Our trunks have been created and we can now route them to their destinations by clicking the edit button on each trunk.
  • Page 14 Smartlink SARK has a flag called “smartlink” which you can set on when you create a DiD group. This is useful when you first create a set of extensions and then create your DiD trunks later. Smartlink will match the numbers of each extension to the right hand side numbers in the DiD group.
  • Page 15 If the Sibling is remote (i.e. not in the same subnet) then you may want to have SARK create a firewall rule for it. In the example below, the other machine is in the same subnet so there is no need to create a rule.
  • Page 16 Here is a route that will do that… Now, whenever we dial a PSTN number on the Sark500 it will be routed up to the other SARK PBX (perhaps a larger model) for termination onto the PSTN.
  • Page 17 SARK500 Embedded PBX Perhaps we also want to allow extension-to-extension calling between the two PBXs. We can extend our route dial plan to include that also. Let’s say, for example, that the extensions on the remote PBX are 4 digits in length and always begin with “41”. We can modify our route as follows… We’ve added the dialplan _41XX which will route any 4 digit dials beginning 41 up to the other PBX for termination.

  • Page 18: Adding Extensions

    Choose the phone type from the device drop-down. Fill out the details for your phone and (optionally) enter the MAC address if you want SARK to automagically generate a TFTP provisioning file for your phone type. SARK has a fairly extensive phone database and it can provision most commercially available phone types. Click the Save button if you have several entries to create or simply click the Commit button to create this entry and regenerate the Asterisk files immediately.
  • Page 19 …And it will also generate the correct provisioning data for the phone type you chose… You may freely modify any of these entries SARK has generated for you and save them back to the database. You can also freely create your own provisioning templates and profiles allowing you to tailor the SARK provisioning platform to suit your individual needs.
  • Page 20 SARK500 Embedded PBX Adding a PIKA Line-out extension The appliance is equipped with a line-out port that you can use to connect to a public address system. To add an extension for the port, simply create an extension; choose a device type of PIKAFXS and enter a Custom Dial String of “PIKA/audio/1”...

  • Page 21: Conferencing

    Conference room 300 is predefined to the system at the factory. If you want to add other rooms or change the conference room number you can modify the underlying Asterisk “.conf” file directly. As a general rule, SARK keeps its management of Asterisk files to a minimum. You can directly modify most asterisk files just using the Asterisk Edit panel…...
  • Page 22 SARK500 Embedded PBX Once the conference room has been created in this way we can either dial it directly from any extension or we can select it in a route (it will auto magically appear in all end-point drop downs)… Below we route a DiD trunk to our new conference room so we can host a conference with an external callers.

  • Page 23: Interactive Voice Response

    SARK500 Embedded PBX 10 Interactive Voice Response To create an IVR, you must first create a system greeting.. Simply go to any phone and dial *60*+nnnn, where nnnn is a 4 digit number that we will associate with our recording. – *60*4321 The auto attendant will lead you through the process of creating a recording.
  • Page 24 SARK500 Embedded PBX We can now choose our key-press operations by clicking on the keypad graphic and choosing an endpoint from the drop down. And…. Page 24 5/15/2011/PADS-2.2.6.2/SAIL-3.1...
  • Page 25 SARK500 Embedded PBX Finally, after committing the IVR, if we return to the screen we see .that SARK has updated the graphic to show at a glance which keys are in use… The IVR is now ready to use. Page 25...

  • Page 26: Adding Routes

    11 Adding Routes Within SARK, an outbound route consists of a set of dialplans and up to four outbound pathways (Trunks). The SARK HPE processing engine will choose the first available route which matches the dialed number ID (DNID) .

  • Page 27: Firewall

    SARK500 Embedded PBX 12 Firewall SARK uses the Shorewall firewall to manage access to the PBX. Shorewall is a very comprehensive and powerful Linux firewall which, like all firewalls, can be complex to set up. However, SARK completely automates the initial firewall creation.
  • Page 28 The rule consists of an action , a source, destination, protocol and port(s). This SIP rule simply says accept SIP (5060 UDP) traffic from the local LAN (defined by the symbolic parameter $LAN). SARK figures out the local LAN automatically at startup.
  • Page 29 When you create a new VoIP trunk, you can also request automatic creation of a firewall rule. In the above example we have requested SARK to create a rule to allow SIP and RTP traffic from sip.mycarrier.com. After we commit the new trunk, if we go and inspect the firewall rules we will see a new rule for sip.mycarrier.com:-...
  • Page 30 The firewall has reverted to LOCAL MODE. This means that it will accept traffic from the local subnet ONLY. This should allow you to continue to access SARK via the browser and to rectify the error. Once rectified, you should restart the firewall and your rules will be loaded.

  • Page 31: Network Configuration

    SARK500 Embedded PBX 13 Network Configuration To configure the appliance on your network, click the Network link in the navigation menu. The following screen appears. DHCP is enabled by default on the appliance. When you connect the appliance to your network, the DHCP server on your network issues a valid IP address to the appliance during the startup sequence.
  • Page 32 SARK500 Embedded PBX In the IP Address text box put the IP address you want to use Change the values of the other fields as required for your network. You must enter values for all fields if DHCP is no. Click the Save button.

  • Page 33: Backup/Regress & Save To Usb

    14 Backup/Regress & Save to USB SARK will automatically spawn backups every night. It will keep up to 7 on-board backups and you can “regress” to a backup simply by clicking on it. It will also take an “Instant Backup” (called a snapshot) every time you issue a commit.

  • Page 34: Global Settings

    SARK500 Embedded PBX 15 Global Settings The Global Settings Web page allows you to configure global PBX settings. In the left navigation menu, click Global Settings. The following Web page appears. You can click through the various tabs to set the system up to your requirements. Page 34 5/15/2011/PADS-2.2.6.2/SAIL-3.1...

  • Page 35: Call Recording

    SARK500 Embedded PBX 16 Call Recording SARK has several different settings for call recording which you can choose to suit your requirements. However, before you begin call recording, y ou should be aware that in most countries and jurisdictions there are legal implications whenever you record a call and that neither Aelintra Telecom nor its distributors or resellers will be responsible in the event that you use the recording features in an unlawful manner.

  • Page 36: Asterisk File Edit

    17 Asterisk File Edit You can freely modify most of the Asterisk “.conf” files to suit your needs. There are a some files which SARK maintains and it won't allow you to modify them directly but even those files have user include files that you can use to create and maintain your own settings.
  • Page 37 Asterisk restart then Asterisk can be stopped and started from the Global Settings panel. If you choose a file that SARK maintains, then the content will still be viewable but it will be “grayed out” and you won't be able to save or update it. One of the files which SARK manages is called extensions.conf...

  • Page 38: Sark Service Codes

    SARK500 Embedded PBX 18 SARK Service Codes TRANSFERS, PARKING & GROUP PICKUP data function Availability/Terminal Type Comment extension Blind Transfer internal Immediately transfer a call - use with analogue phones - usually turned off none One Touch internal Activates call recording Record(OTR) or One This is an in-band request.
  • Page 39 SARK500 Embedded PBX none Broadcast directly to internal Check with your administrator the overhead page to see if this feature is amps using line out activated – Actual key sequence may vary depending upon extension number choice 700 - 702 none Parked call pickup internal...
  • Page 40 SARK500 Embedded PBX Diverts DIVERTS data function Availability/Terminal Comment Type *20* none Call Forward Immediate to internal sets feature on/off Voicemail Toggle (DND) *21*+ext none or Call Forward Immediate internal Use with no extension to turn off extension (CFIM) Toggle *22*+ext none or Call Forward on Busy/No...
  • Page 41 SARK500 Embedded PBX Permissions PERMISSIONS Key data function Availability/Terminal Comment Type *24* none Allow Call Forward to External master user - requires Numbers password *25* none Deny Call Forward to External master user - requires Numbers password *30* none Set Master Timers to Automatic master user - requires Incoming calls will be checked against (default)
  • Page 42 SARK500 Embedded PBX Miscellaneous operations Miscellaneous data function Availability/Terminal Comment Type *26*+n none or ring delay Set ring delay internal if no ring delay is specified the (seconds) ring will not timeout *40*+group none, pagegroup Page internal Use with no extension to page all (call group) or phones extension...
  • Page 43 SARK500 Embedded PBX Agents and Queues Agents/Queues data function Availability/Terminal Comment Type *65* Agent Log on as an internal Number/Password agent *66* Agent Log off as an internal Number/Password agent followed by # *67* Agent Number ChanSpy master user - requires Allows a supervisor to anonymously listen Function password...

  • Page 44: Nanp Supported Service Codes

    SARK500 Embedded PBX 19 NANP Supported Service Codes data function Availability/Terminal Comment Type none Time and date internal none Check my internal extension number Extension Call Forward internal Immediate (CFIM) none Cancel Call internal Forward Immediate (CFIM) none DND ON internal None DND OFF...

  • Page 45: Pika Telephony Hardware Channel Driver

    The default is 2. Busypattern Specifies the cadence of the busy signal. The format is tone_length,silence_length. In many countries, it is 500 ms on, 500 ms off. Page 45...
  • Page 46 The following shows the default configuration entries for this section. [general] usenativebridge=yes echocancelwhenbridged=yes busycount=2 busypattern=500,500 The parameters in the section [audio] configure the appliance audio line-in and line-out ports. txgain Changes the outgoing volume level on the channels. Valid values are -18 to 6. Default_value = 0 rxgain Changes the incoming volume level on the channels.
  • Page 47 SARK500 Embedded PBX context The initial default context for the dial plan. Default value = from-internal for FXS lines and from-pstn for FXO and BRI trunks extension The initial default extension for the dial plan (used for FXO interfaces and FXS interfaces if immediate=yes is set). For digital interfaces, leave this keyword empty to receive DID in the ${EXTEN} variable.
  • Page 48 SARK500 Embedded PBX usecallerid Specifies whether to detect callerid on incoming calls for FXO ports and whether to generate callerid for FXS ports. Default value = yes. faxdetection Enable fax detection. Default value = yes. musiconhold The music on hold class associated with this group. Default value = default.
  • Page 49 SARK500 Embedded PBX agc.in.enable Specifies whether AGC should be used for the receive side of the call. agc.out.enable Specifies whether AGC should be used for the transmit side of the call. agc.out.attackRate Attack rate for the transmit side of the call in ms. agc.out.decayRate Decay rate for the transmit side of the call in ms.
  • Page 50 SARK500 Embedded PBX group Value from 0 to 31. This group is used to indicate which group the Dial command should use. E.g.: Dial(PIKA/FXO/g0/1234). There is no default value. The group number is unique for different interface types (FXS, FXO, BRI). The following can be used to specify the search algorithm to use when selecting a free channel in the group: g - choose the first free channel, searching from lowest to highest channel number G - choose the first free channel, searching from highest to lowest channel number...
  • Page 51 SARK500 Embedded PBX The following shows the default settings in section [fxs]. The settings in this section apply to all FXS channels on the appliance. This section is always present because there is always at least one FXS channel on the appliance, the built-in FXS channel.
  • Page 52 SARK500 Embedded PBX agc.in.speechLevel=-36 agc.out.speechLevel=-36 group=0 #include pika_fxs_5.conf The following parameters are specific to FXO channels. waitfordialtone If enabled, the channel driver will wait for the dial tone before dialing. Default value = yes. hookflashco Specifies whether to allow hook flash to be sent to the CO. Applicable only to Centrex lines and/or lines with call waiting service.
  • Page 53 SARK500 Embedded PBX The following shows the default settings in section [fxo]. [fxo] gp_group=0 conf_ref=TRUNK_0 context=from-pstn extension=s accountcode=fxo_grp waitfordialtone=yes hookflashco=no flashstring=## callerid=asreceived echocancel=yes echotaillength=64 echosuppression=yes comfortnoise=yes echologging=no usecallerid=yes faxdetection=yes musiconhold=default language=default amaflags=default canpark=no txgain=0 rxgain=0 clippingratio=-2 useagc=no agc.in.enable=no agc.out.enable=no agc.in.targetLevel=-15.0 agc.out.targetLevel=-15.0 agc.in.minGain=-6 agc.out.minGain=-6...
  • Page 54 SARK500 Embedded PBX The following parameters are specific to BRI channels callerid Default=asreceived nationalprefix Default=0 internationalprefix Default=00 Page 54 5/15/2011/PADS-2.2.6.2/SAIL-3.1...
  • Page 55 SARK500 Embedded PBX The following shows the default settings in section [digital]. Each span has its own set of configuration parameters. [digital] gp_group=1 conf_ref=BRI_1_0 briphone=false context=from-pstn extension= accountcode=digital_grp callerid=asreceived nationalprefix=0 internationalprefix=00 immediate=no echocancel=yes echotaillength=64 echosuppression=yes comfortnoise=yes echologging=no usecallerid=yes faxdetection=yes musiconhold=default language=default amaflags=default canpark=no...
  • Page 56 SARK500 Embedded PBX context=from-pstn extension= accountcode=digital_grp callerid=asreceived nationalprefix=0 internationalprefix=00 immediate=no echocancel=yes echotaillength=64 echosuppression=yes comfortnoise=yes echologging=no usecallerid=yes faxdetection=yes musiconhold=default language=default amaflags=default canpark=no txgain=0 rxgain=0 clippingratio=-2 useagc=no agc.in.enable=no agc.out.enable=no agc.in.targetLevel=-15.0 agc.out.targetLevel=-15.0 agc.in.minGain=-6 agc.out.minGain=-6 agc.in.maxGain=18 agc.out.maxGain=18 agc.in.attackRate=170 agc.out.attackRate=170 agc.in.decayRate=750 agc.out.decayRate=750 agc.in.speechLevel=-36 agc.out.speechLevel=-36 group=2 channels=3-4 Page 56 5/15/2011/PADS-2.2.6.2/SAIL-3.1...
  • Page 57 SARK500 Embedded PBX Examples The following shows configuration examples for the appliance. Configuring the Appliance for BRI If there are one or more BRI modules present, the file contains configuration entries for the BRI interfaces. Depending on your network configuration, you may need to change some settings. By default, each BRI span is configured as node type client (TE) and networking configuration point-to-multi-point (PMP).
  • Page 58 SARK500 Embedded PBX Overlap Sending and Receiving The appliance supports both overlap receiving and overlap sending. Overlap receiving means that the Setup message for incoming calls does not contain the complete set of digits required to route the call. Subsequent Info messages contain the remaining digits. Overlap receiving is enabled for the appliance and may not be disabled.
  • Page 59 SARK500 Embedded PBX The following example shows the settings for the first span on a board. It is configured as a TE device in a point- to-point configuration. Overlap sending is disabled. [BRI_1_0] interface=board1,0 networkconfig=pp switchtype=etsi countrycode=Europe line_compandmode=alaw node=client numbertype=unknown umberplan=unknown channelselect=exclusive endpoint=true...
  • Page 60 ;default_tei=0 ;num_digits=0 ;local_number= ;servicetype=voice ;in_calls_behavior=TRANSPARENT_OVERLAP_RCV ;out_calls_behavior=NONE ;general_calls_behavior=CC_UUI_RECOGNITION addsendingcomplete=no maxdigitsconnrq=1 ;taillength=64 You must restart Asterisk for the configuration changes to take effect. Click STOP and START on the SARK; Globals panel to restart asterisk. Page 60 5/15/2011/PADS-2.2.6.2/SAIL-3.1...
  • Page 61 After you finish using pikacf, you must restart the appliance. To configure the appliance for other countries, perform the following steps: Click STOP in SARK Gobals panel. • Run the PIKA configuration program to generate new configuration files. At the Linux command prompt •...
  • Page 62 SARK500 Embedded PBX At the Linux command prompt on the appliance, type reboot. Call Progress Call progress uses inband tone patterns (such as ringing, busy or fast busy) received from remote devices to determine why a call has been disconnected. Enabling call progress ensures that billing does not start until a two-way speech connection has been established.
  • Page 63 SARK500 Embedded PBX Using the PIKA CLI The following lists the Asterisk CLI commands for the PIKA channel driver. pika debug {on| off} Enables or disables debug messages pika rec {on | off} {fromasterisk | toasterisk} gpgroup channel [nocli] Enables or disables audio recording for debugging purposes, either from Asterisk to the card (fromasterisk) or to Asterisk from the card (toasterisk) where gpgroup is the GrandPrix group number and channel is the channel or channel range to record.

  • Page 64: Channel Status On The Appliance Lcd

    SARK500 Embedded PBX 21 Channel Status on the appliance LCD The LCD displays the status for each channel when Asterisk runs. The display reflects only PIKA channels, not other Asterisk channels types, such as SIP channels. During the startup sequence, the LCD shows the message WARP appliance...loading.
  • Page 65 SARK500 Embedded PBX Examples The following example shows the display where channel one (FXS) has a call in progress. A channel on BRI span two and a channel on BRI span four have calls in progress. BRI spans three and five are active but currently idle. BRI spans six through nine are not connected.
  • Page 66 SARK500 Embedded PBX Port Numbering - Provisioning versus LCD On the LCD, channels are numbered sequentially, one through nine, regardless of the module type inserted into the module bay. When phones and trunks are provisioned in Asterisk configuration files, channels are numbered sequentially based on the module type.
  • Page 67 SARK500 Embedded PBX BRI Link State Display Due to limitations of the BRI hardware and the link protocol, the LCD may not accurately represent the channel state under certain conditions. This section attempts to summarize the expected behavior. A span or channel is considered connected when both ends of the link are connected within the telephony network and exchanging low-level signaling information.

  • Page 68: Deployment And Dimensions

    SARK500 Embedded PBX 22 Deployment and dimensions The appliance can be wall or bench mounted. The dimensions are 34mmx172mmx234mm(HxLxW). The external PSU delivers 12V DC to the Appliance. You should NOT use any PSU other than the one supplied with the appliance or by your SARK500 reseller or distributor.

  • Page 69: Sark Directory Structure On The Warp

    23 SARK Directory Structure on the WARP Most of SARK’s files are resident in /opt. SARK customer files (that we will not directly change during a system update) are resident in persisten2/opt. For PIKA-ppc /opt is 'symlinked' to /persistent and /opt customer files are symlinked again into persistent2.
  • Page 70 SARK500 Embedded PBX persistent/etc/ |-- asterisk Asterisk SARK includes | |-- sark_agents_header.conf | |-- sark_agents_main.conf | |-- sark_cdr_mysql.conf | |-- sark_customer_agents_main.conf → persistent2/etc/asterisk | |-- sark_customer_iax_devices.conf → persistent2/etc/asterisk | |-- sark_customer_iax_headers.conf → persistent2/etc/asterisk | |-- sark_customer_iax_main.conf → persistent2/etc/asterisk | |-- sark_customer_iax_registrations.conf → persistent2/etc/asterisk | |-- sark_customer_manager.conf →...
  • Page 71 SARK500 Embedded PBX |-- shorewall Shorewall SARK includes | |-- sark_rules.cfg → persistent2/opt/sark/Shorewall/sark_rules.cfg persistent/var/lib/asterisk/agi-bin/ |-- sarkhpe service/ `-- srkhelpd SARK helper Daemon /var/spool/cron/crontabs/root SARK cron jobs Page 71 5/15/2011/PADS-2.2.6.2/SAIL-3.1...
  • Page 72 `-- sark |-- bkup Daily backups |-- db Database files | |-- DBSQL | |-- emptyTheDB | |-- lineIOdump | |-- sark.db | |-- sarkstart.db | `-- startDBSQL |-- passwd |-- shorewall Shorewall Customer files | |-- sark_rules.cfg `-- snap...

  • Page 73: Sark Additional Perl Dependencies

    SARK500 Embedded PBX 24 SARK Additional Perl Dependencies SARK requires additional Perl modules over and above those installed as part of the Warp platform. The modules are taken from CPAN. AnyEvent AsteriskAMI DBD-SQLite parent IO-Interface IO-Socket-Multicast 25 SARK Additional BusyBox commands SARK requires additional BusyBox commands over and above those installed as part of the Warp platform.

Table of Contents