PBXware 3.8 System

From Bicom Systems Wiki

File System

System window administers the core PBXware components such as the file system, system services, server details, licensing, sound files, MOH (Music On Hold), etc.



All PBXware logs, sound recordings, CLI and CLIR files are stored on the local file system. Some of these files can grow to a size which will not leave any space on the system. This section provides management of how and when these files should be rotated or deleted in order to prevent such a scenario.

File System


The following files are rotated after a selected period of time


  • PBXware logs:
Time PBXware logs are kept on the filesystem
 '/opt/pbxware/pw/var/pbxware/log'
(ex. Default value '4 weeks' )
(Select box)
  • Other log files:
Time Asterisk logs are kept on the filesystem
 '/opt/pbxware/pw/var/log/asterisk'
(ex. Default value '4 weeks')
(Select box)
File System

Following files are deleted after selected period of time


  • PBXware CLIR files:
Time PBXware CLIR files are kept on the filesystem
 '/opt/pbxware/pw/var/pbxware/cli'
(ex. Default value '4 weeks')
(Select box)
  • Asterisk Backup files:
Time Asterisk backup files are kept on the filesystem
 '/opt/pbxware/pw/etc/asterisk/backup'
(ex. Default value '9 weeks')
(Select box)
  • Voicemail:
Time voicemail files are kept on the filesystem
 '/opt/pbxware/pw/var/spool/asterisk/voicemail/default/$VOICE MAILBOX' 
(ex. Default value '6 weeks')
(Select box)
  • Recordings:
Time recording files are kept on the filesystem
 '/opt/pbxware/pw/var/spool/asterisk/monitor'
(ex. Default value 'week')
(Select box)
  • Fax:
Time fax files are kept on the filesystem
 '/opt/pbxware/pw/var/pbxware/fax'
(ex. Default value 'week')


Services

This window controls the basic actions (start, stop, restart, reload) of PBXware services

Services
  • System
Stop/Start/Restart the system
(ex. Clicking on the 'Restart' button would reboot the system)
(Command button)
  • PBX service
Stop/Start/Restart/Reload the Asterisk (The core PBXware runs on)
(ex. Clicking on the 'Restart' button would restart the Asterisk)
(Command button)
  • PBXware:
Stop/Start/Restart/Reload the PBXware
(ex. Clicking on the 'Restart' button would restart the PBXware)
(Command button)
  • HTTP service
Stop/Start/Restart/ the nginx web server
(ex. Clicking on the 'Restart' button would restart the nginx web server. If you cannot reach the PBXware login screen this is the service you need to start/restart)
(Command button)
  • Database service
Stop/Start/Restart/Reload the MySQL database
(ex. Clicking on the 'Restart' button would restart the MySQL database server)
(Command button)
  • TFTP service
Stop/Start/Restart/ the TFTP server
(ex. TFTP is used for storing and serving the UAD/Phone auto-configuration files)
(Command button)
  • Jabber service
Stop/Start/Restart/Reload the Jabber messaging server
(ex. Clicking on the 'Restart' button would restart the Jabber server)
(Command button)
  • Memcached
Stop/Start/Restart the memcached service
(ex. Memcached service stores information which is read by PBXware Proxy)
(Command button)
  • PBXware Proxy
Stop/Start/Restart the PBXware Proxy
(ex. PBXware Proxy is connecting to asterisk manager and reading events which are then put into memcached for later usage. Based on that data, monitoring section will show information that user wants)
(Command button)

Server Details

This window resets the root PBXware password, timezone, and hostname

Server Details
  • Root Password:
PBXware prompts for this password during the system/ssh login and when accessing system services through the interface
([a-z][0-9])
  • Confirm Password:
Re-type the Root Password entered in the field above
([a-z][0-9])
  • Time zone:
Select the appropriate time zone in which PBXware is located
(Select box)
  • Hostname:
The name given to the machine which will identify the system on the network
(ex. my host)
([a-z][0-9])

For information on the rest of the fields in the Server details, check section Server Details in chapter Getting Started

Licensing

This window (re)licenses the system. Free and requested licenses are available (both bond to a system MAC address). If you are upgrading your license just paste the license key in the 'License Number' field, select the MAC address assigned to a license key and click on the 'Save' button

NOTE: The system must have access to a fully operational Internet connection in order to license the system.
Licensing
  • License Type:
Select a system license type
(ex. The system comes with two license types. FREE license and 'Requested License')
(Select box)
  • License Number:
Provide a system license number as received in the email.
TIP This field will not be active if FREE license is requested
(ex. ABCDE123)
([a-z][0-9])
  • MAC:
Select a MAC address to which the license will be applied
(ex. If your system has multiple MAC addresses select the one you wish to assign the license to. If this MAC address changes in the future, you will have to re-license the system)
(Select options)


SMTP Configuration

SMTP Configuration
  • E-mail Account:
Address to which the email will go if a recipient is not specifically defined
(ex. john@domain.com)
([0-9][a-z] @)
  • SMTP Address:
The host to send mail to, in the form "host | IP_addr"
(ex. mail.domain.com)
([0-9][a-z])
  • SMTP port:
Port used to send emails to the host
(ex. Default port is 25)
([0-9])
  • Authentication:
Select whether authentication with the SMTP server is needed or not
(ex. On)
(Option buttons)
  • Username:
Username used for SMTP AUTH
(ex. username)
([a-z][0-9])
  • Password:
Password used for SMTP AUTH
(ex. password)
([a-z][0-9])
  • Allow From: Override:
Are users allowed to set their own From: address
Example:
  • YES - Allow the user to specify their own From: address
  • NO - Use the system generated From: address
(Option buttons)
  • Use SSL:
Specifies whether ssmtp uses TLS to talk to the SMTP server
(ex. The default is NO)
(Option buttons)
  • Use Start TLS:
Specifies whether ssmtp does a EHLO/STARTTLS before starting SSL negotiation
(ex. See RFC 2487)
(Option buttons)

Sound Files

This section administers all sound files used by PBXware

Sound Files

Filter

Sound Files filter
  • Directory
Select directory from the drop down list to display only files located in that specific system directory.
  • Letter
Select letter from the drop down list to display only files with names starting with selected letter.
A-Z, 0-9
  • Type
Select type from the drop down list to display only files of that specific format.
Select among the available options (gsm, ulaw, alaw, g729, ilbc, sln) to display system sound files of that type. e.g. Selecting 'gsm' will display all system sounds with the .gsm file type)
(Select box)
  • Upload
Press Choose File button to select file from your hard drive and press upload file to upload it to your PBXware.
NOTE: Even if this upload method is available we strongly advise you to use PBXware Sound Converter to upload your sound files to the PBXware.
  • Upload button:
Uploads selected file from the local computer to PBXware
(ex. Click the 'Browse' button and select a file from your desktop. Then click this button to upload the selected file to PBXware)
(Command button)

Convert

Sound Files options
  • Convert:
Convert the selected file to the desired codec.
(ex. Select a box next to a sound file (e.g. arizona). Select a codec from the drop down menu and click on Convert. The sound file will be converted to that codec).
(Command button)
  • Rename:
Renames the selected sound file
(ex. Select a box next to a sound file (e.g. arizona). Change 'arizona' into 'Arizona101' and click this button to rename the selected sound file)
(Command button)
  • Delete:
Deletes the selected sound file
(ex. Select a box next to a sound file (e.g. arizona) and click this button to delete the selected sound file)
  • Download:
Downloads the selected sound file to user's desktop
(ex. Select a box next to a sound file (e.g. arizona) and click this button to download the selected file to your desktop)
(Command button)


TIP

PBXware will play only sound file types equal to enabled codecs on dialing extension.

For example, Extension 1000 has only gsm codec enabled. When the same Extension logs in as a Queue Agent by dialing '*202 + $AGENT_NUMBER', all sounds played by PBXware (asking for password etc...) will be in '.gsm' format.

If multiple codecs are enabled for Extension 1000(ulaw,alaw,gsm), PBXware will play sound files with better sound quality (ulaw/alaw).

Music on Hold

Music on Hold is a music or advertisements played to callers while they are waiting for an agent or when put on hold, for example

Music on Hold

Content

MOH content window administers all PBXware MOH sound files. They are listed here with the following details

  • Name:
MOH sound file name
(ex. Motorbreath)
(Display)
  • Class:
MOH class sound file belongs to
(ex. Default)
(Display)
  • Status:
MOH sound file status
(ex. On/Off)
(Display)
  • edit.png Edits the MOH file configuration
(ex. Click to edit MOH file configuration)
(Button)
  • delete.png Deletes a MOH file from the system
(ex. Click to delete a MOH file from the system)
(Button)

Search

Search
  • Search:
Search phrase
(ex. Provide a search phrase here and hit enter to filter the records)
([a-z][0-9])
  • Name:
Should the search filter be applied to track names
(ex. Check the box to search track names)
(Check box)

Add/Edit Content

Add/Edit Content
  • Clip name:
Audio file name
(ex. Für Elise)
([a-z][0-9])
  • Author:
Author name
(ex. Ludwig van Beethoven)
([a-z][0-9])
  • File:
Displays full path to music file on local computer. Click 'Browse' button to select a file
(ex. D:\Music\Ludwig van Beethoven\Ludwig van Beethoven - Für Elise.mp3)
([a-z][0-9])
  • Length:
Clip length
(ex. 6:37)
([0-9][:])
  • Class:
Select a MOH class sound file belongs to
(ex. default)
(Select box)
  • Status:
Set the status of uploaded file(active/inactive)
(ex. On/Off)
(Option buttons)

Classes

Classes

MOH classes are something like folders on a computer filled with music files. Once a MOH class is assigned to the queue, for example, all sound files that belong to 'default' class are played back in random order. MOH classes are listed here with the following details

  • Name:
MOH class name
(ex. test)
(Display)
  • Status:
MOH class system status. When disabled, sound files that belong to the class will not be played anywhere on the system
(ex. On/Off)
(Display)
  • edit.png Edits the the MOH file configuration
(ex. Click to edit MOH file configuration)
(Button)
  • delete.png Deletes a MOH file from the system
(ex. Click to delete a MOH file from the system)
(Button)

Search

Search
  • Search:
Search phrase
(ex. Provide a search phrase here and hit enter to filter the records)
([a-z][0-9])
  • Name:
Should the search filter be applied to class names
(ex. Check the box to search class names)
(Check box)

Add/Edit Classes

Add/Edit MOH
  • Class Name:
MOH class name
(ex. IVR greetings)
([a-z][0-9])
  • Status:
Set the class status
(ex. On/Off)
(Option buttons)
  • Random:
Whether the files assigned to this class be played in random order
(ex. On/Off)
(Option buttons)

Sangoma Cards

This part of the interface is used to set various Sangoma cards: PRI, Analog and BRI.

Sangoma Cards


Depending on the cards inserted and the number of ports on them, appropriate row of information will show up in the list of the cards. Also whether PRI, Analog or BRI card is inserted, they will have different configuration settings.


PRI Cards

When PRI card is inserted (like A101 which has one port) you will get as many "items" in the list as you have ports on that particular card. In this case, A101 has one port hence one item or card in the list. If you insert A102 you will get two items in the list because that card has two ports.

So, you need to configure every port individually, that's why there is a separate Configure button by every port.

PRI Cards

When the card is inserted you will see 'Not connected' Status. You need to connect the cable to it and click on the Configure button.

Card Options
  • Media type:
This is the type of the PRI system that the card is connecting to
Example:
  • T1 - PRI in US
  • E1 - PRI in EU
  • J1 - PRI in Japan
(Select box)
  • Coding:
This is the coding type for this port. This is automatically selected with Media type, so there is no need to change this option.
(ex. B8ZS)
(Select box)
  • Framing:
This is the framing used for this port. This is automatically selected with Media type, so there is no need to change this option.
(ex. ESF)
(Select box)
  • Clock:
Select whether the card will give a clock to devices (Master), or use a clock generated from telco (Normal)
(ex. Master)
(Select box)
  • Reference clock:
This option allows one to use the incoming clock from a different port as a clock source to this port.
NOTE: This option works only if Clock is Master.
(ex. 2)
([0-9])
  • Hardware DTMF:
Enable/Disable Hardware DTMF detection
(ex. Yes, No, N/A)
(Option buttons)

When you choose which type of connection is used and whether the card will use a clock source from the provider or generating one, click on the Save button. After that, click on Apply and then Restart the PBXware button.

If the cable was connected and configuration done properly, the system will display 'Connected' by the cards port.

Analog Cards

When you insert an analog Sangoma card, each card has one "item" in the list, regardless of the number of ports that it has on it. Under Port, it will show you how many FXS and/or FXO ports are configured.

Analog Cards
Analog Cards
  • Codec:
Codec used for this card
(ex. MULAW)
(Select box)
  • FXO Operation mode:
FXO Operation mode.
(ex. FCC)
(Select box)
  • Hardware DTMF:
Enable/Disable Hardware DTMF detection
(ex. Yes, No, N/A)
(Option buttons)

Procedure for configuring FXS/FXO ports is simplest. Click on Configure, Save, click on Apply, and then Restart PBXware.


TIP

If you change the hardware configuration of the card (PCI slot, number of FXS/FXO modules etc.) first reset the settings by clicking on the Reset button in the Configuration window, and then Save.

BRI Cards

Here you can configure Sangoma BRI cards. In this example, we used A500 which has 3 physical ports where every port splits in two ISDN ports by a special cable, thus offering 6 ISDN ports which you must configure by clicking on the Configure button.

BRI Cards
BRI Cards
  • Connection type:
This should match the settings provided by your telco.
(ex. point-to-point)
(Select box)
  • Group:
Select in which group you want to place the current port. This is useful if you want one trunk to use more than one port so all calls could be spread across several ports. In that case put the same number on all ports you want to allocate to the trunk.
(ex. 2)
([0-9])
  • Country:
Set this to your local country.
(ex. usa)
(Select box)
  • Number of incoming digits:
Minimum number of digits for a called number on an incoming call. Incoming calls with called number less than this value will be rejected with cause: Invalid number format.
(ex. 6)
([0-9])
  • Hardware Echo Canceller
Hardware echo cancellation control. You must confirm that your card supports echo cancellation.
Ex. Yes, No, N/A
  • Hardware DTMF
Hardware DTMF control. You must confirm that your card supports DTMF control
Ex. Yes, No, N/A
  • Hardware FAX
Hardware FAX detection control. In order for this option to work your card needs echo cancellation module installed.
Ex. Yes, No, N/A
  • Dialplan:
Some switches require the "type of number" network specific facility to be set.
(ex. international)
(Select box)
  • Numbering plan:
Some switches require the "number plan" network specific facility to be set.
(ex. isdn)
(Select box)
  • National Prefix
National dialing code at the trunk destination.
([0-9])
  • International Prefix
The international dialing code at the trunk destination.
(ex. For the USA 011, for the United Kingdom and Germany 00 etc.)
([0-9])

If the port was connected and properly configured, after clicking on Save and then Apply, restarting PBXware will show Connected by that port.

Information

PBXware continuously monitors system services, load, ZAPTEL modules, etc... in order to achieve and maintain high quality operations across the system and network. The result of these monitoring operations are also accessible to an authorized user.

System Information
  • Refresh Interval:
Time interval in seconds at which data is to be refreshed
(ex. 10 sec)
(Select box)
  • PBXware Uptime:
Total time PBXware is available for service
(ex. 1 hour, 16 minutes, 42 seconds)
(Display)
  • Last Reload:
Total time since PBXware was last reloaded
(ex. 10 minutes, 34 seconds)
(Display)
  • Load:
Load shown for the past 1, 5 and 15 minutes
(ex. 0.16)
(Display)
  • CPU:
CPU usage by: user, kernel and idle
(ex. 2.3%)
(Display)
  • Memory:
Memory usage by: Used, Cache, and Free
(ex. 299.1M)
(Display)
  • Swap:
Swap space usage
(ex. 5.2M)
(Display)
  • Processes:
Processes by Running, Sleeping, Stopped, and Zombie
(ex. 1, 96, 0, 0)
(Display)
  • rootfs:
File systems present shows by type, mount, usage, and free status
(ex. 0B, 0B, 3.3G, 1.5G)
(Display)
  • CPU Info:
Number of CPU's, Model, Speed, and Cache size
(ex. Pentium II (Deschutes), 398.28, 512KB)
(Display)
  • System:
General system details like Name, Kernel, Architecture, and Uptime
(ex. zenica.bicomsystems.com, Linux 2.4.21-27.0.1.EL, i686, 18d 1h 35m)
(Display)
  • Services:
Default system services running on the system
(ex. PBXware, Asterisk, TFTP)
(Display)
  • Modules:
Currently loaded ZAPTEL modules
(ex. wsusb)
  • Zaptel:
A list of all cards detected by the system is displayed here.
Channel Map displays used slots on TDM card. In this case, the first slot is filled with FXO module (displayed in black) while other 'Empty' slots are displayed in gray color).
(ex. Channel Map: 1: FXO, 2:FXS, 3:Empty, 4:FXO)
(Display)


TIP

With TDM cards, please make sure your power cable is connected. Message 'PLEASE CHECK TDM POWER CABLE' will be displayed if this happens.


Next -> 17.Routes