From Askozia Handbook
Jump to: navigation, search

In the Status menu in the web interface, you find a selection of hardware information about your telephone system as well as the current network and CPU workload.


Stateboards give a live overview of the telephony situation at any given time. A Stateboard displays the availability of each phone, group and queue, that has been added to it. In particular, it shows status of individual phones, groups and queues, the call duration and caller ID or name, and allows drag-and-drop configuration. The following video introduces Stateboards in AskoziaPBX.

The Stateboard overview lists all Stateboards as well as the members assigned to them.

Status Stateboards

By clicking on Askozia add stateboard.png, a new Stateboard can be set up, and a click on Askozia edit.png allows to edit an existing Stateboard. Both adding and editing a Stateboard opens the settings listed below. Clicking on Askozia delete.png deletes the respective Stateboard.

  • Define a Name for the Stateboard.
  • Optionally, a Description can be entered purely for reference.
  • Activate Duration if the call duration should be displayed on the Stateboard.
  • Activate Caller ID if the caller ID should be displayed on the Stateboard.
  • Only the Busy Lamp Field members selected by drag-and-drop will be displayed on the Stateboard.
  • Only the Access members will be able to access the Stateboard through their Client User Interfaces.

Click on Save to save your configuration.

Adding or editing a Stateboard

Clicking on Askozia open cfe.png in the Stateboards overview opens the actual Stateboard where the status of all added extensions is displayed.

Status Stateboard, enlarged representation

On the bottom, you find the toolbar for the Stateboard. It’s possible to choose between a large and more detailed, or smaller representation. Furthermore, the toolbar can be hidden, or the stateboard can be reset.

Status Stateboard toolbar

Status Stateboard, smaller representation

Only Stateboard access members can access it. To access the Stateboard from the web interface, the Client User Interface also needs to be activated for the respective phone accounts.

Status Stateboards access from Client User Interface

System Information

Every time you log in to the web interface the first thing you see is the system information (called Summary in the menu bar). The system overview states relevant system information at a glace. With Askozia summary.png you can get back to the summary page from any point in the web interface.

Name is the host name of the telephone system. By default this is askoziapbx.local. If you have defined a different name, it is stated accordingly. Version informs about the version of AskoziaPBX and the platform being used as well as when the image was built. Last Config Change is of interest when more than one administrator is configuring AskoziaPBX. Especially in this case, the text box for Notes at the bottom of this page can be used. Thus, every system administrator can already see when logging in which changes have been made.

Likewise, the number of Active Channels can be seen in the overview as well as the Uptime and the number of Calls Processed. All successful in and outgoing connections are counted. Memory Usage is especially interesting for users of embedded systems because memory of these is usually more limited than on PC-hardware based systems.

System Information

Network Traffic and CPU Load

Network traffic and CPU load are shown as graphs in the web interface. These graphs can be analyzed for troubleshooting.

The graph for the network traffic can be configured. You can switch between bits per second (bit/s) and bytes per second (bytes/s) as the unit of measure on the y-axis. The scaling can also be adjusted to personal preferences. Auto scale up adjusts the scale to the highest point the graph has reached so far. follow adjusts the scale to the highest point reached in the visible past.

CPU load is always stated in percent.

Network Traffic

Call Detail Records

Call Detail Records (CDRs) list all past incoming and outgoing calls. Click Call Detail Records in the Status section of the menu bar to customize the list and download it as a PDF file.

Call Detail Records

Extension is the number of the phone for which you want to generate CDRs. If all remains selected, all calls of all phones are listed. Select the period for which you want to generate CDRs and choose the date and time format. Afterwards click "Download PDF" or "Download CSV" and save the file. Open the .pfd file with a PDF reader of your choice and the .csv file with a spreadsheet program (e.g. Libre Office's Calc).

Call Detail Records in pdf format

Call Detail Records in csv format

In order to customise the Call Detail Records with your company logo, please follow the steps below. Note that this should be done by advanced users only.

1. Create the "custom" folder on Askozia's storage disk. (e.g. /storage/usbdisk1/askoziapbx/custom/).

2. Name your logo file "logo_cdr.png" and copy this file into the "custom" folder.

3. Reboot the system.

During reboot, AskoziaPBX will recognise the new file. After the reboot, the logo file will have disappeared from the folder. For optimal results, your logo file should have 1316 x 401 pixels. Please also make sure that it is a .png file.

The same workflow can be applied to customise the logo of call queue Wallboards. For this, a file named "logo_cfe.png" needs to be uploaded into the "custom" folder (the optimum size is 179 x 55 pixels). Reboot AskoziaPBX to apply the changes.

To return to the default logos, create an empty file in the "custom" folder and name the file "remove". After a reboot, the logos are set back to default.

Queue Statistics

In AskoziaPBX, the statistics of each queue can be saved as a .CSV file for further processing. Queues require the Askozia Call Flow Editor.

Every queue provides a Wallboard. This is a website with real time statistics and the source for each CSV file containing the queue statistics.

Queue Statistics

Statistics can be saved for a single queue or all queues at once. Select the queue and desired period before clicking on Download CSV. The CSV files contain the IDs of Calls, Queues, Agents and Callers, as well as the UNIX timestamp, call dates, total wait time and total talk time and information if a call has been answered or not.

Queue statistics


Logging messages (logs) are the raw output of Asterisk, the core software of AskoziaPBX. As with the graphs from the previous section, they are mostly used for troubleshooting. To get a better idea of how logs work, here some example scenarios.

Example Scenario "Analog Phone Pick up and Hang up"

Picking up the phone leads to the following messages. Using an ISDN telephone creates a couple of additional messages. The main messages are, nevertheless, identical.

Dec 13 14:50:40 asterisk[1391]: VERBOSE[8722]: 
-- Starting simple switch on 'DAHDI/2-1'

Dec 13 14:50:47 asterisk[1391]: VERBOSE[8722]: 
-- Hungup 'DAHDI/2-1'

The first part of a logging message is the date and time the message was created (Dec 13 14:50:40), followed by the name of the program which has created the event and the process ID (asterisk[1391]). The next part of the message is Asterisk specific and contains the message type (here: VERBOSE) as well as the source of the message (line [8722]). There are other message types. NOTICE is used for less urgent warnings, WARNING for warnings which require more attention and ERROR for serious cases. The source of a message is more of a hint for developers but for finding errors in the telephone system. The text in the second line of the message, introduced by '--', is the actual source of information.

Dec 13 14:50:40 asterisk[1391]: VERBOSE[8722]: 
-- Starting simple switch on 'DAHDI/2-1'

The first message states that Asterisk is now monitoring DAHDI channel 2 (analog port 2). DAHDI is the channel technology which Asterisk is using for analog and ISDN connections.

Dec 13 14:50:47 asterisk[1391]: VERBOSE[8722]: 
-- Hungup 'DAHDI/2-1'

The second message shows that DAHDI channel 2 was hung up. Asterisk no longer interacts with this channel.

Example Scenario "A Call Between Two Analog Telephones"

In this section the logging messages of the following scenario are discussed: Alice (extension 101) calls Bob (extension 102). Both use analog telephones. Bob picks up his phone shortly after ringing. After a short conversation Bob hangs up. Alice hangs up as well.

Dec 13 14:58:51 asterisk[1391]: VERBOSE[9241]: 
-- Starting simple switch on 'DAHDI/1-1'

Alice has picked up her analog telephone with the extension 101. The telephone is connected to port 1 and assigned to DAHDI channel 1.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Executing [102@ANALOG-PHONE-19255578844cea2c43c9977:1] 
NoOp("DAHDI/1-1", "internal calling internal phone: Bob - <![CDATA[<102>]]>") in new stack

Alice has dialed Bobs extension 102. Asterisk is executing step one in the dialplan for analog telephones (ANALOG-PHONE-19255578844cea2c43c9977). The application NoOp prints debugging information. In this case "calling internal phone: Bob..." .

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Executing [102@ANALOG-PHONE-19255578844cea2c43c9977:2] Set("DAHDI/1-1", 
"MISSEDCAUSE=hungup") in new stack

Astering has executed step two of the dialplan and set the internal dialplan variable "MISSEDCAUSE" on the value "hungup". If Alice would hang up now, a missed call notification would be sent.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Executing [102@ANALOG-PHONE-19255578844cea2c43c9977:3] Set("DAHDI/1-1", 
"SENDNOTIFICATIONS=""") in new stack

Step three sets "" as the recipient of the notification e-mail.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Executing [102@ANALOG-PHONE-19255578844cea2c43c9977:4] Macro("DAHDI/1-1", 
"main,DAHDI/g2,102,102,tTo,5") in new stack

Dialplan step four passed different dialplan parameters to a predefined macro called "main". The parameter contains the destination, the transfer settings, the ring length and the voicemail extension.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Executing [s@macro-main:1] Dial("DAHDI/1-1", "DAHDI/g2,5,tTo") in new stack

Asterisk calls DAHDI group two, which Bob's telephone is also part of.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- Called g2

Asterisk finished the call set-up to extension 102.

Dec 13 14:58:59 asterisk[1391]: VERBOSE[9241]: 
-- DAHDI/2-1 is ringing

Dec 13 14:59:00 asterisk[1391]: VERBOSE[9241]: 
-- DAHDI/2-1 is ringing

Bob's telephone is ringing.

Dec 13 14:59:03 asterisk[1391]: VERBOSE[9241]: 
-- DAHDI/2-1 answered DAHDI/1-1

Bob has picked up 102. Alice and Bob are connected.

Dec 13 14:59:10 asterisk[1391]: VERBOSE[9241]: 
-- Executing [h@macro-main:1] NoOp("DAHDI/1-1", "Entering the main macro 
h hangup extension") in new stack

The call was terminated. The special "h" extension is executed. This extension allows Asterisk to execute logic after the call was finished. "h" stands for hang up.

Dec 13 14:59:10 asterisk[1391]: VERBOSE[9241]: 
-- Hungup 'DAHDI/2-1'

Bob's telephone (extension 102, assigned to DAHDI channel 2 and connected to port 2) was hung up.

Dec 13 14:59:10 asterisk[1391]: VERBOSE[9241]: 
== Spawn extension (macro-main, s, 1) exited non-zero on 'DAHDI/1-1' 
in macro 'main' 

The macro terminated non-zero because somebody hung up. It terminates without an error message when the control is returned to the dialplan logic which has called it in the first place. In this case the macro was exited unexpectedly.

Dec 13 14:59:10 asterisk[1391]: VERBOSE[9241]: 
== Spawn extension (ANALOG-PHONE-19255578844cea2c43c9977, 102, 4) exited 
non-zero on 'DAHDI/1-1'

This section was exited non-zero for the same reason.

Dec 13 14:59:10 asterisk[1391]: VERBOSE[9241]: 
-- Hungup 'DAHDI/1-1'

Alice's telephone (extension 101, assigned to DAHDI channel 1 and connected to port 1) was hung up. The call is finished and Asterisk has finished processing.