Far south networks Com.X1 PBX, Administrator'S Manual

Page 1: ...Com X1 PBX Administrator Guide Version 1 0 22 January 2010 2010 Far South Networks...

Page 2: ...Document History Version Date Description of Changes 1 0 10 01 22 Preliminary 2010 Far South Networks...

Page 3: ...ed backup 14 2 3 4 Managing existing archives 15 2 3 5 Restoring an archive 16 3 COMMISSIONING THE UNIT 17 3 1 NETWORK CONFIGURATION 17 3 1 1 Listing ethernet interfaces 17 3 1 2 Configuring an interf...

Page 4: ...providers 37 3 4 2 Analogue trunk groups 37 3 4 2 1 Adding trunk groups 37 3 4 2 2 Adding trunks to a group 39 3 4 2 3 Removing trunks from a group 40 3 4 2 4 Removing a trunk group 41 3 4 2 5 Viewing...

Page 5: ...ATION 55 4 1 ADMINISTRATORS 56 4 2 ANNOUNCEMENTS 57 4 3 CALLBACK 58 4 4 CONFERENCES 59 4 5 DAY NIGHT CONTROL 60 4 6 FEATURE CODES 61 4 7 GENERAL SETTINGS 62 4 7 1 Dial command options 62 4 8 IVR 65 4...

Page 6: ...ITORING FUNCTIONS 86 6 CONSOLE ADMINISTRATION 89 6 1 CONSOLE ACCESS 89 6 1 1 Authentication 89 6 1 2 Accessing the unit 89 6 1 2 1 Serial access 89 6 1 2 2 Secure shell access 89 6 2 REBOOTING THE SYS...

Page 7: ...Com X1 PBX administrator and details access to commisioning management and monitoring of the Com X1 PBX It forms part of a suite of manuals and guides for the Com X1 product range which also includes...

Page 8: ...es eth1 eth2 No 192 168 2 1 255 255 255 0 eth3 No 192 168 3 1 255 255 255 0 2 1 2Authentication Web login has been pre configured with the Administrator username and password for convenience 2 1 3Remo...

Page 9: ...X1 GUI facilitates status monitoring and control of the unit and peripheral devices via a set of menus accessible from the menu bar After any changes have been made to the configuration these need to...

Page 10: ...n the status on the Status tab is SYNCHRONIZED the configuration is up to date and synchronized with the underlying system configuration resources If the status is PENDING or MODIFIED the Review Apply...

Page 11: ...the task list and select Apply to proceed To revert changes and return to the configuration last applied select the Revert button To continue configuration without applying select Cancel During apply...

Page 12: ...ct Start and then Restart or Shutdown as desired Please note that any changes that have not been applied will be lost When the system has been shut down it remains powered on but halted Only a physica...

Page 13: ...Backup Restore 2 3 1Backup contents The following selection of backup sets are provided for backup 2 3 1 1Configuration Recordings All system configuration including network device trunk extension vo...

Page 14: ...cessful completion the backup archive will be listed under the appropriate section 2 3 3Scheduled backup To schedule a backup select the Options menu for the desired backup set select schedule and sel...

Page 15: ...the appropriate sections on the backup panel Most recent backups appear at the bottom of each section All columns in these tables can be sorted by clicking on the column header Individual backup archi...

Page 16: ...list of steps to be executed during the restore are displayed Select Continue to restore or cancel Reboot the system once restore has completed please see 2 2 4 To restore from a data file saved at an...

Page 17: ...ing an interface Double click an ethernet interface to configure the following fields Field Content Name Operating System allocated interface name Description A description for the interface DHCP Clie...

Page 18: ...Apply the configuration Note that after a network apply the unit needs to be rebooted please see 2 2 4...

Page 19: ...ress for the range of IP addresses from which new DHCP requests should be served DHCP Router Address The address of the IP router gateway to be used by the device requesting IP configuration normally...

Page 20: ...mber this assignment across restarts and will always reserve the IP for that unit The IP will no longer be served to future commas Comma End Address The end address for the range of IP addresses to al...

Page 21: ...X1 unit can detect network devices present on all network attached to it By default deviceed requesting either DHCP IP information or Comma boot information will automatically be added to the list of...

Page 22: ...om the Com X1 Manager Once an IP has been allocated the Auto IP field becomes disabled and the IP is statically reserved for the device by the Comma Manager always issuing the same IP to the device IP...

Page 23: ...e is always allocated the same IP static disable Auto IP and enter the IP manually If the static IP falls in the DHCP pool the DHCP server will always allocate it to the device i e the DHCP client on...

Page 24: ...ist the available ports on the device are grouped and listed Comma ports are enumerated using de device s name the card index in the device and the port number I e device a2 5 would indicate the fifth...

Page 25: ...al non linear processing echo suppression algorithm NLP can also be employed during echo cancellation If you expect the devices connected to the port to be in a noisy environment how ever you might pr...

Page 26: ...cellation delay and algorithm to be employed on the port The delay up to which the echo canceller can compensate is specified in milli seconds An optional non linear processing echo suppression algori...

Page 27: ...st cost routing Bus termination Comma BRI cards have terminating resistors on board removing the need for external terminators If this device should terminate the BRI bus usual case enable this settin...

Page 28: ...s Signalling role When configured as Terminal the device is an ISDN TE connected to the telco NT When configured ad Network this port acts as though it is an ISDN NT device This is useful when the Com...

Page 29: ...xtensions panel Configured extensions are categorized as those having been assigned to extension ports and those that are unassigned For each extension the number friendly name port assignment extensi...

Page 30: ...he ports in the ports list and selecting Assign from the context menu A starting extension number can be specified and upon acceptance extensions are numbered incrementally from the starting number fo...

Page 31: ...3 3 2 2Adding Unassigned extensions When a range of extensions is added the friendly name is set equal to the extension number 3 3 2 3Adding SIP extensions...

Page 32: ...rd generator is used to generate a unique password for each newly created extension 3 3 3Configuring extensions 3 3 3 1Basic configuration Field Content Number The extension number selected during cre...

Page 33: ...n when it rings using a specified feature code 8 3 3 4Configuring SIP extensions In addition to the basic and advanced configurations please see 3 3 4 SIP extensions also allows the configuration of v...

Page 34: ...ensions Unassigned extensions can be assigned to a port by editing the extension and selecting the Port button From there a menu of available extension ports can be accessed Only available ports are l...

Page 35: ...3 3 6Unassigning extensions Extensions associations with ports can be removed by selecting the extension in the extensions list and selecting Unassign from its context menu...

Page 36: ...to any of the SIP extensions can be configured This includes the SIP codec configuration Note that since multiple extensions may have different values for shared fields these fields default to disable...

Page 37: ...ks select select Start followed by Configuration and then the Trunks Panel The list is populated with analogue trunks in the top section and SIP providers in the lower section of the panel 3 4 2Analog...

Page 38: ...A new group may also be created by selecting trunks of the same type and selecting New Group from the context menu...

Page 39: ...ted from a selection of trunks the type will automatically be selected After creation the new group and any ports belonging to it will be listed under the Trunk Groups node 3 4 2 2Adding trunks to a g...

Page 40: ...on of trunks from a trunk group find the group under the Trunk Groups node and select the trunks using Ctrl left click to select multiple Select the Remove from Group option from the context menu Note...

Page 41: ...e Remove Group option from the context menu The turnks will be removed from the group and the reference to the group removed from the trunks under the Trunk Ports node and the group will be removed fr...

Page 42: ...the group listed under the Trunk Groups node where the devices and trunks included in the group are listed 3 4 3SIP trunks Multiple SIP trunks can be configured for call routing SIP trunks can also a...

Page 43: ...trar The address of the SIP provider s registration server Username The registration user name provided by the SIP provider Password The registration password provided by the SIP provider Act as Provi...

Page 44: ...the sender s address and port This should be enabled when the Com X1 is located behind a NAT router Secure If this is setting is enabled after registration with the SIP provider all invites will requ...

Page 45: ...all the codec with the highest priority at the top of the list will be attempted first then the second and so on 3 4 3 3Editing a SIP trunk To update the configuration of a SIP trunk select the Edit P...

Page 46: ...electing Start followed by Configuration and the Outbound panel For each route listed the route s name the pin code and an indication of whether the route is an emergency and or intra company route is...

Page 47: ...aled a number that matches the dial pattern of this route the user will be prompted to enter the pin code in order for the call to proceed Emergency When enabled emergency dialing indicates that the e...

Page 48: ...Dial Pattern header 3 5 4 2Dial pattern syntax Dial patterns consist of the following characters only 0 1 2 3 4 5 6 7 8 9 X Z N X matches any digit from 0 9 Z matches any digit from 1 9 N matches any...

Page 49: ...the Trunk Priorities section of the route Note that the route has to be edited first before this option becomes available If no existing trunks are included in the route the context menu can be access...

Page 50: ...outbound route select Delete from the route s context menu 3 5 8Outbound route priority Outbound routes can be moved up and down the overall list by right clicking and selecting Up or Down An outboun...

Page 51: ...Inbound panel For each configured inbound route the DID and CID pair used to match the route the route description destination type and destination are displayed To manage inbound routes select an opt...

Page 52: ...er is the caller s number sent to the PBX by the telco This field may contain a pattern to be matched against an incoming caller ID Please see 3 5 4 2 for more on the dialed pattern syntax If left bla...

Page 53: ...nfigured the destinations will become available selections in the Inbound Routes destination menus 3 6 4 3Extensions To configure conferences select Start from the main menu bar followed by Configurat...

Page 54: ...elect the desired extension and edit the extension configuration Please see 3 3 for more details Only extensions that have voicemail enabled will be available for voicemail termination 3 6 4 7IVR Inte...

Page 55: ...u Selecting a function from this menu opens a new window which can be maximized with detailed configuration options for the feature Once configured select Submit at the bottom of the configuration pag...

Page 56: ...atures from the Advanced menu Field Content Username A user name unique to this user Password A custom password for the user Department Name If a department is specified here this user will only have...

Page 57: ...the user the option of repeating Allowed keys are 0 9 Allow skip If this is enabled should the user press a key during an announcement the announcement will be skipped Return to IVR When enabled after...

Page 58: ...ld Content Callback description A custom description for this callback Callback number The number to call back If this is left blank the caller ID will be used to callback Delay before callback The am...

Page 59: ...ser must press after entering the pin Join message If set this audio recording will be played before a user joins the conference Leader wait If enabled the conference will not start until the leader h...

Page 60: ...ht will be the initial value for this day night control Optional password If not blank a user will have to enter this password in order to toggle this day night control Day destination The destination...

Page 61: ...re code associated with the function Field Content Name The name of the function category or the individual function Code The feature code currently associated with the function Use default If enabled...

Page 62: ...s specified here applies to outbound calls Please see 4 7 1 for more details Extension recording override If enabled all user recording settings other than the on demand settings will be ignored and n...

Page 63: ...ail on feature codes Direct dial to voicemail message type The message or no message the user will hear before the voicemail prompt when dialling directly into an extension s voicemail Can be one of D...

Page 64: ...ssage if no entry pressed Msg Play Number of times to play the recorded message if the caller does not press any options and it times out Error Re tries Number of times to play invalid options and rep...

Page 65: ...rsion updates Updates of the FreePBX and Asterisk modules are managed by Far South Networks for the Comma and Com X product ranges This field should be left blank Update email An email address to send...

Page 66: ...ctory Please see 4 6 for more information on feature codes VM Return to IVR When enabled should one of the IVR options result in the user s call being transferred to a voicemail box after leaving a me...

Page 67: ...terminates Destinations For each valid selection in this IVR enter the digit s to activate the selection and the call destination to transfer the caller to A special t destination is used to configure...

Page 68: ...me This value is linear but human sound perception is logarithmic As a result we recommend that you test the volume configured here for comfort and quality levels This feature will convert MP3 files t...

Page 69: ...e the streaming details to Asterisk Please see information on the musiconhold conf configuration for different audio and internet streaming source options Optional format An optional format line that...

Page 70: ...device s emergency CID value if configured Intra company route If enabled the internal caller ID information will be retained and not replaced by the extension s external CID nor the route s external...

Page 71: ...usy before paging it Active calls may be interrupted This is useful for emergency pages Duplex When enabled all supporting devices will allow two way communication to all other extensions and devices...

Page 72: ...o connect to the original destination again if not answered in the interim Context The call context of parked calls This should remain the default funless requested otherwise for test purposes by Far...

Page 73: ...res without using a common pin for the features Field Content Description Custom description for this Pin set This will be listed in selection lists that allow Pin sets Record in CDR If enabled when t...

Page 74: ...being pre pended to the caller ID displayed on phones that ring in this queue e g Support 101 Wait time prefix When set to Yes the CID Name will be prefixed with the total wait time rounded to the nea...

Page 75: ...ified only this amount of users are allowed to wait in the queue 0 indicates an unlimited number of callers Join empty This field governs caller entry into queue Options are Yes Callers are allowed to...

Page 76: ...er destination is activated If this field is set to a number of seconds the ringing strategy will start a new iteration of ringing attempts after waiting the specified number of seconds after the prev...

Page 77: ...ogged into more than one queue calls waiting in the higher priority queue will be placed with these agents first Autofill If enabled and if the ring strategy allows this will cause one call to be sent...

Page 78: ...announced every Frequency seconds If One the caller s estimated remaining hold time will be announced only once Note If remaining time is less than one minute remaining time is no longer announced IVR...

Page 79: ...extensions in the list and so forth prim These modes act as described above However if the primary extension the first entry in the list is occupied the other extensions will not be rung If the primar...

Page 80: ...ble CFU or call forwarding on busy CFB configured will be ignored and not rung If the extension has a appended it might not honor this setting and be included in any case Skip busy agent When enabled...

Page 81: ...Field Content Destination if no answer The destination to transfer the call to if the call is not successfully picked up in the ring time specified...

Page 82: ...number If an extension number is entered here this number will be used to record a recording should the Save Recording feature code see 4 6 be dialled from that extension Upload A recording file in PC...

Page 83: ...s the time range that results in a match for this time condition If the current system time does not match this time group the call will be routed to the no match destination Please see 4 21 for detai...

Page 84: ...fies Time to finish The end time for the block of time this time group specifies Week day start The start day for the block of time this time group specifies Week day finish The end day for the block...

Page 85: ...re the voicemail prompt for this voicemail blasting group Password Optional Voice mailbox list Select using Ctrl click all the extensions that should receive the voicemail message in their mailboxes D...

Page 86: ...o the desired extension or an outbound call is placed with the desired number Field Content Name The name to look the first three letters up from Number The extension or outbound number to be dialed f...

Page 87: ...ich suite of monitoring funtions are available from the Com X1 GUI Monitoring domains include PBX system monitoring and events Configuration details Host system monitoring Telephony status and events...

Page 88: ...ring data Note Due to a known issue with the tabular representation of results if you are only seeing one page manually enter 2 in the page number at the bottom of the table and press enter All pages...

Page 89: ...erformance active processes memory usage and page file usage System log Displays the system wide log This includes information warning and error messages from system wide applications and services var...

Page 90: ...ave registered with the PBX and their status SIP registry Asterisk CLI sip show registry Displays the PBX SIP registry SIP trunks should be listed here when registered with SIP providers misdn channel...

Page 91: ...in the IP address allocated by a DHCP server 6 1 2 1Serial access Connect a serial cable to the unit s serial port and configure a terminal emulator such as putty with the following settings 115200 8...

Page 92: ...rnel ubuntu installer i386 vmlinuz 2 6 24 24 generic append vga normal initrd ubuntu installer i386 initrd nfs gz root dev nfs nfsroot 192 168 0 75 hardy chroot ip dhcp interface eth0 console ttyS0 11...