Table of Contents 1 INTRODUCTION ..........................7 1.1 O ............................7 VERVIEW 2 MANAGING THE UNIT ........................8 2.1 A ..........................8 CCESSING THE UNIT 2.1.1 Factory network configuration ....................8 2.1.2 Authentication ......................... 8 2.1.3 Remote web login ........................8 2.2 C ......................
This document is intended for the 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 the Com.X1 End User manual and the Com.X1 installation guide.
2Managing the unit 2.1Accessing the unit 2.1.1Factory network configuration The Com.X1 units ship with three external ethernet ports (eth0 – eth2) and one internal ethernet bus (eth3), factory-configured as follows: Interface DHCP client? Netmask eth0 eth1 eth2 192.168.2.1 255.255.255.0 eth3 192.168.3.1...
2.2Configuration management 2.2.1GUI layout The Com.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 be reviewed and applied before they...
2.2.2Configuration status The current configuration status, indicating which tasks, if any, are pending, can be viewed from the configuration menu: When 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 button will be emphasized and the administrator needs to review and apply the configuration using the Review/Apply button in order to synchronize.
2.2.3Applying and reverting a configuration Select the Review/Apply button. A list of tasks to be applied will appear. Review 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.
2.2.4Rebooting and Shutting down Select 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 physical power cycle will power it on again.
2.3Backup and Restore The entire Com.X1 configuration can be backed up to the unit's internal hard drive, or downloaded to another machine. Backups can be scheduled daily, weekly and monthly, and individual sections of the configuration can be configured for backup, each with its own schedule.
2.3.2Immediate backup To initiate an immediate backup, select the Options menu for the desired backup set, and select Backup Now. After successful 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 select the desired backup frequency.
2.3.4Managing existing archives As scheduled backups complete and immediate backups are initiated, the existing archives are listed under 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.
2.3.5Restoring an archive To restore from an existing archive, right-click the archive in the list and select Restore. The 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 external location, first upload the archive to the server in the appropriate location and then follow the procedure above:...
3Commissioning the unit 3.1Network configuration The Com.X1 product procides functionality to configure all four ethernet interfaces, as well as provision of DHCP IP allocation for IP phones and booting of Comma iTA devices. The Com.X1 unit can serve both DHCP and Comma addresses simultaneously, provided the IP ranges do not overlap.
Page 18
Apply the configuration. Note that after a network apply, the unit needs to be rebooted (please see 2.2.4).
DHCP Router Address The address of the IP router / gateway to be used by the device requesting IP configuration, normally the same as the Com.X1 address on this interface. DHCP DNS Server The primary DNS address to be configured on the device requesting IP configuration, may be left blank.
Apply the configuration. Note that after a network apply, the unit needs to be rebooted (please see 2.2.4) The eth3 interface is the internal ethernet bus serving the Com.X1 Media processor card and should not changed from its factory configuration.
IP address and current status are also listed. 3.2.2Detecting and scanning for devices The Com.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 detected devices.
Auto IP On first boot, request an IP address from 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.
Indication whether the Com.X1 DHCP server should allocate an IP to the device on DHCP request. Note that once the DHCP lease on the IP expires, the Com.X1 DHCP server might issue a different IP to the device. To ensure a device is always allocated the same IP (static), disable Auto IP and enter the IP manually.
3.2.5Configuring device ports When a device is selected in the device list, 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 port on the second analogue card (a –...
3.2.5.1Configuring Analogue Trunk (FXO) ports Field Content Input gain Indicates how much, if any, gain adjustment should be performed in the input direction. Values are in deciBels. Output gain Indicates how much, if any, gain adjustment should be performed in the output direction. Values are in deciBels. Echo canceller The echo cancellation delay and algorithm to be employed on the port.
3.2.5.2Configuring Analogue Extension (FXS) ports Field Content Input gain Indicates how much, if any, gain adjustment should be performed in the input direction. Values are in deciBels. Output gain Indicates how much, if any, gain adjustment should be performed in the output direction. Values are in deciBels. Echo canceller The echo cancellation delay and algorithm to be employed on the port.
3.2.5.3Configuring BRI ports Field Content Link Type Indicates whether this device is part of a point-to-point (i.e. DIDs issued by the telco) or point-to-multipoint (i.e. one or more multi- subscriber numbers issued, or multiple BRI devices sharing the BRI bus.) The link type needs to match the mode of the service provided by the telco.
3.2.5.4Configuring PRI Field Content Physical interface The service offering, either 23B+D T1 or 30B+D E1. For E1, double frame or CRC4 multi-frame can be enabled, and for T1 framing can be either Super Frame (D4) or Extended Super Frame (ESF, using CRC-6) Switch type National switch type options are: •US National ISDN phase 1 (NI-1)
3.2.6Removing devices To remove a device configuration, select Remove from the device's context menu. Note that any of the device' ports that are included in trunk groups will be removed from the groups, outbound routes that make use of the ports will no longer be associated with the ports and any extensions associated with device ports or channels will become unassigned.
3.3.2.1Adding extensions from ports Single extensions or a group of extensions can be assigned to available extension ports by selecting the 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 for the number of extensions selected.
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...
The following password generation schemes are supported for SIP extensions: •Fixed: The same password is set for all the newly created extensions •Same as Extension: The password for each newly created extension is the same as the extension number •Random: A random password generator is used to generate a unique password for each newly created extension.
3.3.3.2Advanced configuration Field Content Voicemail Enable this to enable voicemail for the extension The user pin used to access voicemail and features Email An email address to which voicemail will be emailed Call waiting Enables the call waiting feature, allowing an indication to be provided to the user when an incoming call arrives while the user is on the phone Pickup group...
3.3.5Assigning extensions 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 listed in the menus.
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.
3.3.7Configuring multiple extensions Multiple extensions can be configured simultaneously. When the list of extensions for configuration include both analogue and SIP extensions, only those fields that are not unique to any individual extension can be configured: When only SIP extensions are included in the list, only those fields not unique to any of the SIP extensions can be configured.
3.3.8Deleting extensions Extensions may be deleted individually, or as a group, by selecting Delete from the extension context menu. Note that deleting an extension that is in use in an inbound route will result in an update to the route to terminate with hangup. 3.4Trunk groups and SIP providers 3.4.1Listing existing trunk groups and SIP providers To view the list of configured trunks, select select Start, followed by Configuration...
Page 38
A new group may also be created by selecting trunks of the same type, and selecting New Group from the context menu.
Field Content Name Unique identifier for this group. Analogue groups may only be numbers from 1 – 62, and BRI groups may be any unique combination of alpha-numeric characters. Type The group type. Only trunks of this type may be included in the group.
After being added to a group, the trunks under the Trunk Ports node will show the group name they belong to in paranthesis. 3.4.2.3Removing trunks from a group To remove a selection 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).
3.4.2.4Removing a trunk group To completely remove a trunk group and remove the group association from all the trunks included in the group, select the group in the Trunk Groups list and select the 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 from under the Trunk Groups node.
3.4.2.5Viewing group members Membership of trunks to their respective groups may be observed either by expanding individual devices listed under the Trunk Ports node, where group membership is denoted in parenthesis after trunks, or by selecting the desired group in 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.
3.4.3.2Sip trunk configuration SIP trunk configuration is divided into basic, advanced and codec configuration, accessible from their accompanying tabs on the SIP Provider form. Field Content Name The unique name of this SIP Provider Description A custom description of this SIP trunk Registrar The address of the SIP provider's registration server Username...
Page 44
/ login number. When enabled, the system ignores the SIP and SDP headers' address and port and replies to the sender's address and port. This should be enabled when the Com.X1 is located behind a NAT router. Secure...
Codecs supported by a SIP trunk can be selected by using the Codecs button. Use Ctrl-Left-Click (holding Ctrl down) to select multiple codecs. Individual codecs can be moved up and down the codec priority list by selecting the codec entry, and selecting the Up or Down buttons.
3.5Outbound route configuration A variety of trunk types can be combined and prioritised to form outbound routes, routing calls based on dial-patterns. The Com.X1 supports routing to trunk groups, as well as individual FXO trunks and BRI channels. 3.5.1Viewing configures outbound routes The list of existing configured outbound routes can be accessed by selecting Start, followed by Configuration and the Outbound panel.
3.5.2Adding outbound routes New routes can be added by selecting the Add button on the Outbound panel. For the route configuration, please see 3.5.3. 3.5.3Configuring outbound routes Field Content Name A unique name for the route. If set, after a user has dialed 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.
3.5.4Dial Patterns 3.5.4.1Adding dial patterns to an outbound route The Dial Patterns for Outbound routes are analyzed, and the highest priority route for which a pattern match is made is tasked with routing the call. New dial patterns can be added to a route by selecting New from the context menu of the Dial Patterns section of the route.
3.5.4.3Removing Dial Patterns from a route A Dial Pattern can be removed from a route by selecting Remove from the pattern's context menu. 3.5.5Adding trunks to an outbound route Trunks can be added to a route by selecting Add from the context menu of the Trunk Priorities section of the route.
3.6Inbound route configuration Inbound routes allows incoming calls to be routed to a particular destination based on the incoming call's DID and CID number pair. The Com.X1 supports a rich set of destination types, greatly simplifying incoming call routing.
3.6.1Viewing existing inbound routes This list of configured inbound routes can be viewed by selecting Start, followed by Configuration and the 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.
3.6.3Configuring inbound routes Field Content Direct Inward Dialing allows a number of incoming numbres to be services across a limited number of physical connections from the telco to the PBX. This field may contain a pattern to be matched against an incoming number. Please see 3.5.4.2 for more on the dialed pattern syntax.
3.6.4Configuring call destinations 3.6.4.1Conferences To configure conferences, select Advanced from the main menu bar and Conferences. Once configured, the destinations will become available selections in the Inbound Routes destination menus. 3.6.4.2Day/Night To configure day/night inbound routing modes, select Advanced from the main menu bar and Day/Night Control.
3.6.4.5Termination The following termination options are available for inbound routing: •busy: a busy tone is provided to the caller •congestion: an 'All circuits are busy now' message is provided to the caller •hangup: hang up the call •on hold forever: places the call on hold without termination •ring: provides the caller with a ring tone •sit ring: provides the caller with a specific ring tone.
4Advanced configuration Access to a variety of advanced features is provided via the Advanced menu. 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 page.
4.1Administrators The Administrators function allows the creation, editing and deletion of advanced feature administrator accounts. These accounts are different from the Com.X1 GUI login administrator account and are only prompted for authentication when attempting to access any of the advanced features from the Advanced menu.
4.2Announcements Announcements added as destinations allow messages to be played on inbound calls before transferring the calls to appropriate destinations. Announcements can play recordings created or uploaded as detailed in 4.19. Field Content Description The description of the annoucnement that will appear in selection lists (e.g.
4.3Callback This feature allows users to dial into the system and hang up while ringing, after which the system will call the user back. Field 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.
4.4Conferences This featue allows multiple users to join a conference with two-way audio on all devices. Conference features include join and leave announcements, passwords, conference administration, in-conference menus, etc. Field Content Conference number The number to dial to access the conference Conference name A custom name for this conference User PIN...
4.5Day / Night control A number of day / night modes can be programmed on the Com.X1. Each has a feature index and can route calls according to its own set of rules. These allow configuration of day / night to support multiple receptionists, tea or lunch breaks, after hours, etc.
4.6Feature Codes An extensive list of feature codes are available to users and administrators to facilitate administration of the system and user call preferences using a phone. For each function, the administrator may change the feature code associated with the function, enable or disable the function, or revert to the default feature code associated with the function.
4.7General Settings General settings apply system-wide on the Com.X1 platform. Users can typically override general settings with their own preferences, but some general settings override all user preferences. 4.7.1Dial command options t: Allow the called user to transfer the call with the “in-call blind transfer” feature code (default ##).
Page 63
Field Content If there is a requirement for an administratot to get access to all recordings, set this location to /var/www/recordings and secure the directory (please see the Apache web server administration manuals). Then access the list using http://<server- ip>/recordings/ Run after record If not empty, this field specifies a custom script to be run after each recording has completed.
Page 64
Timeout/#-press default The internal destination to route a user after timeout. This should remain the default unless requested otherwise for test purposes by Far South Networks. Loop Exceed default The destination that a user is transferred to when exceeding the maximum number of invalid selection options during a voicemail call.
Page 65
This field should be left blank. Update email An email address to send notifications of available updates to. 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.
4.8IVR The Interactive Voice Response feature allows the creation of and chaining together of interactive voice announcements and corresponding menu selections to facilitate user call transfer in the Com.X1 system. Field Content Name Name used to identify this IVR. This entry will be displayed in selection lists that support IVR.
Page 67
Field Content selection is invalid. Repeat loops The number op times the IVR should be played if the user does not provide an option before timeout, or if the option is invalid. The IVR will only loop on invalid input if the 'Loop before i-dest' option is enabled.
Enabling random play will select audio files to play in a random play order. If this is disabled, files are played in the order listed here. 4.11Adding a music category Music categories categorize the audio files available on the Com.X1 PBX server storage. Field Content Category name...
Page 69
4.12Adding a streaming category Streaming categories allow the inclusion of internet streaming audio streams for features that support Music on hold. Field Content Category name A unique name for this streaming category. Application This is the "application=" line used to provide the streaming details to Asterisk.
4.13Outbound routes This featue allows advanced access to outbounds routes and should only be used when the Outbound Routes panel does not provide sufficient levels of detail or flexibility given the administration need. Field Content Route name A unique name for this route. Route password An optional password.
4.14Paging Paging allows groups of extensions to be created that will receive calls (provided the phones for the specified extensions allow paging). Field Content Paging extension The extension to dial to activate the page Group description A custom description for this group Device list The list of devices and extensions to include in this paging group...
4.15Parking Lot Callers can be placed in a parking with a time out associated, after which the caller is transferred to the specified destination. This allows receptionist, for example, to place a caller on hold while waiting for their desired extension to become available. The caller in the parking lot would then, after the parked timeout, automatically ring reception again, by which time the desired extension might have freed up.
4.16Pin Sets Pin Sets are a convenient way to group sets of pins to facilitate multiple users with individual pins gaining access to features, 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.
4.17Queues Queues are a powerful feature of the Com.X1 system, allowing callers to be placed on hold and transferred according to a number of strategies and based on priority. Callers waiting in the queue are provided with their position in the queue, projected waiting time and the option to use self-service menus to exit the queue and transfer to other destinations.
Page 75
Field Content included in this list. Agent announcement If specified, the audio announcement configured here is played to the agent receiving the call before putting the call through. E.g. “The following call comes from the support queue” Join announcement If specified, this announcement is played to a caller before being placed in the queue.
Page 76
Field Content start ringing. roundrobin: Each available agent rings in turn • leastrecent: The extension of the agent that was • called the longest period ago rings fewestcalls: The extension of the agent that has • taken the fewest calls from this queue rings random: Rings agents randomly •...
Page 77
Field Content announcement. AgentComplete: An agent completed a call by • picking the call up from the queue, listening to the announcement and some time later terminating the call either by going on hook, or by transferring the call. Member status When enabled, the following queue events are recorder in the queue log file (/var/log/asterisk/queue_log): QueueMemberStatus: The status of the extension.
Page 78
Field Content Frequency When 0, this field is ignored. When greater than 0, indicates how frequently (in seconds) the caller in this queue is informed of his / her queue position and the estimated remaining holding time before the call is likely to be answered. This behaviour is also determined by the values for the 'announce position' and 'announce hold time' fields.
4.18Ring Groups Ring groups allow groups of extensions to be notified of incoming calls using a number of powerful ring strategies. A rich set of ring group parameters allow flexible configuration of timeout, alerts, music on hold, pick-up confirmation and other features.
Page 80
Field Content calling user before ringing the ring group. Play music on hold If specified, music on hold from the specified category will be played to the user while waiting for someone to pick up the call. CID name prefix Setting a CID prefix here would result in the prefix being pre- pended to the caller ID displayed on phones that ring in this ringing group, e.g.
Page 81
Field Content Destination if no The destination to transfer the call to if the call is not answer successfully picked up in the ring time specified.
4.19Sytem Recordings Audio can be recorded and used in functions such as announcements, IVR, etc. Recordings can be uploaded and made from an extension. Field Content Extension 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.
4.20Time Conditions Time conditions check the current Com.X1 system time and compares it with the specified Time Group to determine whether there is a match. The call is then routed either to a day-night entry if this over-ride has been enabled, or to the match destination if the current time falls within the time block specified in the Time Group, or to the no match destination otherwise.
4.21Time Groups Time groups allows the specification of blocks of time for use in call routing rules, such as time conditions. Please see 4.20 for more detail on Time Conditions. Field Content Name A name to identify this time group with. This will appear in selection lists that allow time groups.
4.22Voicemail Blasting Voicemail blasting allows messages to be added to a number of voicemail boxes at once. Field Content Voicemail blast The extension to dial to leave a message to this voicemail number blasting group Group description Custom description for this voicemail blasting group Audio label Select the audio recording or announcement to play before the voicemail prompt for this voicemail blasting group.
4.23Phonebook The phonebook feature allows names and speed dialing codes to be matched with extension and outbound numbers. It allows user to dial numbers by phoning the phonebook feature code (please see 4.6) and entering the first three letters of a desired phonebook entry's name, after which the call is transferred to the desired extension or an outbound call is placed with the desired number.
Page 87
5Monitoring the system A rich 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 and Gui web server status.
5.1Retrieving monitoring information To access monitoring functions, select Monitoring from the main menu bar, and select the category and function of interest. Results are displayed in tabular format, with the ability to page to more results. In some cases the information is colour coded to facilitate easier analysis.
Page 89
Category Function Description (/etc/dahdi/system.conf) Dahdi channels Dahdi channel configuration (/etc/asterisk/chan_dahdi.conf) Extensions Extension configuration file (/etc/asterisk/extensions.conf) Network interfaces System nerwork interface configuration file (/etc/network/interfaces) System Network status System networj interface status (ifconfig) Displays interfaces, whether they are Up and their Rx, Tx and error statistics.
Page 90
Category Function Description decrease in call quality. Device discovery Displays the list of Comma devices visible to the Comma Manager on all networks, including their ethernet and IP configuration status. Manager log Displays the Comma Manager log. This is a useful resource for finding problems with Comma devices booting and channel events.
Page 91
6Advanced administration 6.1Console access 6.1.1Authentication Default username: comma Default password: farsouth 6.1.2Accessing the unit On power-on the unit can be accessed either via serial cable or via a secure shell using ssh if the IP address is known from a DHCP server. A serial connection can also be used to obtain the IP address allocated by a DHCP server.
Page 92
6.3PXE booting The Com.X1 supports PXE LAN booting, provided a 32-bit kernel is used and console redirection enabled. This section includes examples of PXE boot configurations for the Com.X1 6.3.1Architecture Please ensure that the boot kernel image provided is a 32-bit architecture image. 64 bit Server images are not supported on the Com.X1 servers.
Need help?
Do you have a question about the com.x1 and is the answer not in the manual?
Questions and answers