AsteriskUI Features:

The AsteriskUI is planned to provide the following features:

• see who's telephones are online (Sip Channels) (working)
  • dial the extensions telephone number (working)
• interface to manage the users voice-mail (exists)
  • see MWI state, and count of Old and New messages (working)
  • Message Waiting Notification (MWI) (working)
    • PopUp Notification (working)
    • bold Telephony Dock (working)
  • dialing the voicemail box from the webinterface (should work, but OGoAsteriskDialer has to be made aware of the VoiceMail Prefix)
• management of virtual telephone conference rooms
  • one teleconference room for each team
    • team creators should be able to create, delete, ... team conference rooms for their teams
  • a user should be able to create up to 10 private virtual teleconference rooms, and give them names, stored in Defaults
  • add calendar entry on creation of a conference room, send out reminders...
  • telephone conference reminder should contain number and access information to the conference
• interface to manage parked calls (working)
• interface to manage queues (partially working)
  • viewing statistics about queues and their agents (yet only working for one queue)
  • possibility for agent logon/logoff to queues
• interface to see the Zap Channels
• interface to see the IAX Channels
• Preferences page, to allow configuration of the AsteriskUI (working)
  • enabling/disabling of available tabs (working)
  • setting size of lists (working)
  • including of SIP trunks in SIP accounts list (working)
• maybe appointment, job, birthday notification via telephone (via some Asterisk text to speech plugin)
• maybe handling of FAX'es incoming to the users extension, define E-Mail address to forward the fax to

Above list will potentially become longer, as I get more Ideas on things I would like to have...

Screenshots

Following some screenshots taken from the AsteriskUI:

A screenshot can be seen here

Another one, showing the parked calls list, here

Another one, showing the preferences, here

Another one, showing the Queues tab, here

Another one, showing the Voice Mails tab, here

Another one, showing the AsteriskVoiceMailPopUp, here

Installation

The latest version of the patch can be found here and is applied more or less in the following way to the ogo source packages:

tar -xvpzf opengroupware.org-trunk-latest.tar.gz
patch -p0 < latestAsteriskUI.patchfile
cd opengroupware.org/Misc/AsteriskUI
. /path/to/GNUstep.sh 
gmake -s install debug=yes strip=no

Enabling and disabling the Tabs

The availability of each Tab for the user can be enabled/disabled via a Default by the administrator, these are :

• AsteriskUIConferencesTabEnabled = YES;
• AsteriskUIExtensionsTabEnabled = YES;
• AsteriskUIParkedCallsTabEnabled = YES;
• AsteriskUIQueuesTabEnabled = YES;
• AsteriskUIVoiceMailTabEnabled = YES;
• AsteriskUIZapChannelsTabEnabled = YES;

Configuration of the AsteriskUI in the Preferences

At the preferences of the AsteriskUI, the user can configure the following personal preferences:

• enabling/disabling of tabs that the Administrator made available for use
• defining the size of lists
• whether SIP trunks are included in the SIP accounts list or not
• the users voice Mail Extension
• the voice mail prefix (will be changed in the future to a global Default)

Note There seem to be some bugs in the Preferences, some missing -retain's?

Connection configuration

The configuration to the Asterisk is configured via the OGoAsteriskConnectionDictionary. This is the same used by the OGoAsteriskDialer. It contains the host name and port of the Asterisk management interface listener.

$ Defaults read NSGlobalDomain OGoAsteriskConnectionDictionary
{
    hostName = "127.0.0.1";
    port = 5038;
}

Command Configuration

The command configuration contains also the login information of the asterisk manager user. The Username and Secret has to be set for the Login command.

$ Defaults read NSGlobalDomain AsteriskCommands
{
    Conferences = {
        Action = "database show conferences";
        EndEvent = "--END COMMAND--";
        ExpectedResult = Success;
        ReturnType = Command;
    };
    DBGet = {
        Action = dbget;
        ExpectedResult = Success;
        Parameter = {
            Family = "";
            Key = "";
        };
        ReturnType = Single;
    };
    DBPut = {
        Action = dbput;
        ExpectedResult = Success;
        Parameters = {
            Family = "";
            Key = "";
            Value = "";
        };
    };
    Login = {
        Action = login;
        ExpectedResult = Success;
        Parameters = {
            Events = off;
            Secret = MySecret;
            Username = OGo;
        };
    };
    Logoff = {
        Action = logoff;
        ExpectedResult = Goodbye;
    };
    MailboxCount = {
        Action = mailboxcount;
        ExpectedResult = Success;
        Parameters = {
            Mailbox = "";
        };
        ReturnType = Single;
    };
    MailboxStatus = {
        Action = mailboxstatus;
        ExpectedResult = Success;
        Parameters = {
            Mailbox = "";
        };
        ReturnType = Single;
    };
    Originate = {
        Action = originate;
        ExpectedResult = Success;
        Parameters = {
            Channel = "";
            Context = default;
            Exten = "";
            Priority = 1;
            Timeout = 30000;
        };
    };
    ParkedCalls = {
        Action = parkedcalls;
        EndEvent = ParkedCallsComplete;
        ExpectedResult = Success;
        ReturnType = Multiple;
    };
    Ping = {
        Action = ping;
        ExpectedResult = Pong;
    };
    QueueStatus = {
        Action = queuestatus;
        EndEvent = QueueStatusComplete;
        ExpectedResult = Success;
        ReturnType = Multiple;
    };
    SIPShowPeer = {
        Action = sipshowpeer;
        ExpectedResult = Success;
        Parameters = {
            Peer = "";
        };
        ReturnType = Single;
    };
    SIPpeers = {
        Action = sippeers;
        EndEvent = PeerlistComplete;
        ExpectedResult = Success;
        ReturnType = Multiple;
    };
}

OGoAsteriskDialer

With the latest patch, and a working OGoAsteriskDialer (here)CTI Dialer configured, SkyDialNumber, and the OGoAsteriskDialer, will be used to dial the other extensions. The telephone icon will show up next to telephone numbers, and will trigger your phone to dial the number next to it.

The SIP Accounts Tab

The Sip Accounts Tab shows the following information about the configured SIP Accounts in the Asterisk:

• SIP Extension (the SIP extensions of the configured users)
• Status (whether OK, UNKNOWN, ...)
• IP Address (The IP address of the users)
• Dynamic (whether these are static or dynamic SIP accounts)

The List can be configured in the preferences to include or ignore statically configured SIP accounts (usually trunks).

The Voice Mails Tab

The Voice Mails Tab only shows basic Information about the Voice Mailbox yet. A dial icon to trigger the users telephone to dial the users voice mail box is there too. The following Information is shown about the users Voice Mail Box:

• MWI Status
• New Messages Count
• Old Messages Count

The Parked Calls Tab

The Parked Calls tab shows a list of parked calls, if there are any. If there are any parked calls, it is possible via a SkyDialNumber field to dial the park slot. The following information is shown about the calls in the park lot:

• park slot
• Caller ID (the callers number)
• Name (the callers name (if set))
• Timeout (parking timeout)

The Queues Tab

The Queues tab yet only works for one configured queue. It shows general Information about the queue itself, these are:

• Number of calls
• Number of abandoned calls
• Number of completed calls
• configured Holdtime
• configured maximum
• Service Level of the queue
• Service Level performance of the queue
• queue weight

The following information about each queue agent is shown:

• Agent location
• Agent membership
• Agent penalty
• calls taken by the agents
• last call of the agent
• agent status
• paused state

Message Waiting Indicaton

The OGoAsteriskVoiceMailPopUp can be configured in the preferences to show up on login time or reload, when a voice message is waiting on the Asterisk. The Asterisk Telephony dock will also be bold in case there are new voice messages waiting.

Translations

Right now, the AsteriskUI is available in English and German. Feel free to take the OGoAsteriskUI.strings file and translate it to your language of choise and add it here to the enhancement request in the bugzilla.

Open Issues:

following a list of known issues, there are very likeley more:

• sorting of lists not working
• the queues tab is not very eye candy
• the voice mails tab is not very eye candy
• queues tab only working for one queue
• dialing the voice mail box from the Voice Mail Tab is not working, SkyDialNumber (not part of AsteriskUI) needs an update to allow more flexible distinguishing between outgoing and internal
• dialing the voice mail box via SkyDialNumber from within the OGoAsteriskVoiceMailPopUp not working calls