Difference between revisions of "Asterisk Feature Busy Lamp Field (BLF)"
The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.
m (→Using the FPK) |
(→For Administrators) |
||
| Line 69: | Line 69: | ||
== For Administrators == | == For Administrators == | ||
| − | === | + | === Configuring the "BLF" Type === |
| + | To assign the '''BLF''' function to the FPK, proceed as follows: | ||
| − | + | Open the web interface and navigate to | |
| − | ''Administrator Pages | + | '''Administrator Pages''' > '''System''' > '''Features''' > '''Program Keys'''. |
| − | + | Select the '''BLF''' option and press '''edit'''. | |
[[Image:BLFPickUpFPKConfig.png|left|thumb|450px|Basic BLF Configuration with BLF Key]]<br clear="left"/> | [[Image:BLFPickUpFPKConfig.png|left|thumb|450px|Basic BLF Configuration with BLF Key]]<br clear="left"/> | ||
| − | + | Now, configure the parameters for the BLF feature: | |
[[Image:BLFPickUpFPKParam.jpg|framed|left|Basic BLF Configuration Parameters]]<br clear="left"/> | [[Image:BLFPickUpFPKParam.jpg|framed|left|Basic BLF Configuration Parameters]]<br clear="left"/> | ||
| Line 86: | Line 87: | ||
'''Key label''' - This is the label of the selected FPK <br /> | '''Key label''' - This is the label of the selected FPK <br /> | ||
'''Monitored Phone''' - This is the SIP URI/phone number of the monitored phone <br /> | '''Monitored Phone''' - This is the SIP URI/phone number of the monitored phone <br /> | ||
| − | '''Audible Alert''' - | + | '''Audible Alert''' - This checkbox activates a short beep/ringing alert, if LED status changes to blinking <br /> |
| − | '''Popup on alert''' - | + | '''Popup on alert''' - This checkbox activates a popup message, if LED status changes to blinking <br /> |
'''Example:''' | '''Example:''' | ||
| − | If Bob has the extension | + | If Bob has the extension number "222", the parameters will be: |
| − | '''Key label''' - | + | '''Key label''' - "Bob" <br /> |
| − | '''Monitored Phone''' - | + | '''Monitored Phone''' - "222" <br /> |
| − | '''Audible Alert''' - | + | '''Audible Alert''' - "yes": a short beep or ringing tone sounds when Bob gets a call.<br /> |
| − | '''Popup on alert''' - | + | '''Popup on alert''' - "yes": a popup is shown when Bob gets a call. <br /> |
'''Remark:''' | '''Remark:''' | ||
| − | It | + | It might be necessary to configure a BLF pickup code to ensure that the pickup functionality will be started at Asterisk. This can be done at |
| − | ''Administrator Pages | + | '''Administrator Pages''' > '''System''' > '''Features''' > '''Services''': |
[[Image:BLFPickUpGroupFK.jpg|thumb|left|450px|BLF Pickup Code Configuration]]<br clear="left"/> | [[Image:BLFPickUpGroupFK.jpg|thumb|left|450px|BLF Pickup Code Configuration]]<br clear="left"/> | ||
| − | === | + | === Configuring the "Server Feature" Type === |
| − | + | To assign the '''Server Feature''' function to the FPK, proceed as follows: | |
| − | + | Open the web interface and navigate to | |
| − | + | '''Administrator Pages''' > '''System''' > '''Features''' > '''Program Keys''': | |
| + | |||
| + | Select the '''Server Feature''' option and press '''edit'''. | ||
[[Image:BLFBasicFPKConfig.png|left|thumb|450px|Basic BLF Configuration with Server Key]]<br clear="left"/> | [[Image:BLFBasicFPKConfig.png|left|thumb|450px|Basic BLF Configuration with Server Key]]<br clear="left"/> | ||
| − | + | Now, configure the parameters for the BLF feature: | |
[[Image:BLFBasicFPKParam.jpg|framed|left|Basic BLF Configuration Parameters]]<br clear="left"/> | [[Image:BLFBasicFPKParam.jpg|framed|left|Basic BLF Configuration Parameters]]<br clear="left"/> | ||
| − | '''Key label''' - This is the label of the selected FPK <br /> | + | '''Key label''' - This is the label of the selected FPK. <br /> |
| − | '''Feature Code''' - This code is sent within an INVITE message | + | '''Feature Code''' - This code is sent within an INVITE message when the key is pressed in idle status. <br /> |
| − | '''DTMF Digits''' - These Digits are sent as DTMF signals, if the key is pressed during a call <br /> | + | '''DTMF Digits''' - These Digits are sent as DTMF signals, if the key is pressed during a call. <br /> |
| − | '''LED control''' - A | + | '''LED control''' - A subscription is sent to the given URL. <br /> |
'''Example:''' | '''Example:''' | ||
Revision as of 12:13, 20 August 2010
The busy lamp feature allows users to monitor the dialog state of another phone/user extension. This is indicated by the LEDs in an FPK. This feature is called "Busy Lamp Field" in the Asterisk community. Sometimes the term 'Direct Station Selection' is used for the same functionality.
The feature is available for OpenStage 40/60/80.
The feature description uses always the same example background with fixed names, numbers and IP addresses. The example configuration can be found in Asterisk Feature Example Configuration.
Contents
For Users
The basic Busy Lamp field feature allows the user to monitor the dialog state of another phone/user extension. The dialog state is shown by a distinct LED behavior:
- LED off -> Watched extension is idle
- LED blinking -> Watched extension is ringing
- LED on -> Watched extension is busy/connected
In the basic configuration, pressing the FPK will call the monitored person in any call state.
Example:
There are four users: Leo, Alice, Joe and Bob. Leo is watching the extensions of Alice, Bob and Joe. Each of the extensions are configured on an specific FPK. The example shows the three different extension status. Joe is talking to another persion, Alice gets a call, her phone is ringing and Bob is in idle like Leo is. The following picture shows this example:
Leo can see the status of the other people at any time by watching the LEDs on the FPK.
Using the FPK
The OpenStage phone supports the BLF functionality in two different FPK function types.
The BLF type can be used in scenarios where team members want to pick up the call for other team members.
The server feature type can be used in receptions, for example, where the receptionist wants to see the call status of all employees, but never wants to pick up the call for someone.
Depending on the configured type and the status of the observed party, different actions are performed.
BLF Type:
| LED Status | Action by Key Press |
|---|---|
| Off | Watched party is called |
| Blinking | Incoming call for watched person is picked up |
| On | No action |
Server Feature Type:
| LED Status | Action by Key Press |
|---|---|
| Off | Watched party is called |
| Blinking | Watched party is called |
| On | Watched party is called |
For Administrators
Configuring the "BLF" Type
To assign the BLF function to the FPK, proceed as follows:
Open the web interface and navigate to
Administrator Pages > System > Features > Program Keys.
Select the BLF option and press edit.
Now, configure the parameters for the BLF feature:
Key label - This is the label of the selected FPK
Monitored Phone - This is the SIP URI/phone number of the monitored phone
Audible Alert - This checkbox activates a short beep/ringing alert, if LED status changes to blinking
Popup on alert - This checkbox activates a popup message, if LED status changes to blinking
Example:
If Bob has the extension number "222", the parameters will be:
Key label - "Bob"
Monitored Phone - "222"
Audible Alert - "yes": a short beep or ringing tone sounds when Bob gets a call.
Popup on alert - "yes": a popup is shown when Bob gets a call.
Remark:
It might be necessary to configure a BLF pickup code to ensure that the pickup functionality will be started at Asterisk. This can be done at
Administrator Pages > System > Features > Services:
Configuring the "Server Feature" Type
To assign the Server Feature function to the FPK, proceed as follows:
Open the web interface and navigate to
Administrator Pages > System > Features > Program Keys:
Select the Server Feature option and press edit.
Now, configure the parameters for the BLF feature:
Key label - This is the label of the selected FPK.
Feature Code - This code is sent within an INVITE message when the key is pressed in idle status.
DTMF Digits - These Digits are sent as DTMF signals, if the key is pressed during a call.
LED control - A subscription is sent to the given URL.
Example:
If Bob has the extension numer 222, the parameters will be:
Key label - Bob
Feature Code - 222, pressing the FPK will always call Bob independant of his line status..
DTMF Digits - n.a.., not neccessary in this feature
LED control - 222@192.168.6.10, a subscription for the LED will be sent to the server at the IP address 192.168.6.10. If no IP address is given, the request will be automatically sent to the configured SIP proxy server.
Technical Background
The BLF feature gives the user the possiblity to watch one other users dialog state. To support the feature RFC 4235 is used.
This document defines a dialog event package for the SIP Events architecture, along with a data format used in notifications for this package. The dialog package allows users to subscribe to another user and to receive notification of the changes in state of INVITE -initiated dialog usages in which the subscribed- to user is involved.
The framework is startet with an initial subscription from the watching phone. The following table shows the subscription from Leo for Joe's extension:
| 192.168.0.247 | 192.168.0.10 | SIP Message |
|---|---|---|
| Request: SUBSCRIBE | SIP: Request: SUBSCRIBE sip:333@192.168.0.10:5060 | |
| Joe's phone ------------------> Asterisk | ||
| Status: 401 Unauthorized | SIP: Status: 401 Unauthorized | |
| Joe's phone <------------------ Asterisk | ||
| Request: SUBSCRIBE | SIP: Request: SUBSCRIBE sip:333@192.168.0.10:5060 | |
| Joe's phone ------------------> Asterisk | ||
| Status: 200 OK | SIP: Status: 200 OK | |
| Joe's phone ------------------> Asterisk | ||
After that the Asterisk PBK sends Notification to Leo's phone to tell the status of Joe's line. The table below shows an example Notification:
| 192.168.0.247 | 192.168.0.10 | SIP Message |
|---|---|---|
| Request: NOTIFY | SIP: Request: NOTIFY sip:444@192.168.0.247:5060 | |
| Joe's phone <------------------ Asterisk | ||
| Status: 200 OK | SIP: Status: 200 OK | |
| Joe's phone ------------------> Asterisk | ||
Within the Notify the line status is delivered in the XML body. The OpenStage phone support three line status
Idle (LED off)
The idle state is notified within the dialog event subscription. The dialog state in the message body is terminated or left empty.
Here is an example for Joes idle state sent to Leo.
Message:
NOTIFY sip:444@192.168.0.247:5060;transport=udp SIP/2.0
v: SIP/2.0/UDP 192.168.0.10:5060;branch=z9hG4bK38e76e71;rport
f: <sip:333@192.168.0.10:5060;transport=udp>;tag=as4aa60d2a
t: Leo Demo 444 <sip:444@192.168.0.10>;tag=cc29a24a90;epid=SCBCC441
m: <sip:333@192.168.0.10>
i: 46c0a8f00bff87e0
CSeq: 102 NOTIFY
User-Agent: Asterisk Gemeinschaft
Max-Forwards: 70
o: dialog
c: application/dialog-info+xml
Subscription-State: active
l: 208
Body:
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="0" state="full" entity="sip:333@192.168.0.10:5060">
<dialog id="333">
<state>terminated</state>
</dialog>
</dialog-info>
Ringing (LED blinking)
The ringing state is notified within the dialog event subscription. The dialog state in the message body is early.
Here is an example for Joes ringing state sent to Leo.
Message:
NOTIFY sip:444@192.168.0.247:5060;transport=udp SIP/2.0
v: SIP/2.0/UDP 192.168.0.10:5060;branch=z9hG4bK66a6adf2;rport
f: <sip:333@192.168.0.10:5060;transport=udp>;tag=as6576596c
t: Leo Demo 444 <sip:444@192.168.0.10>;tag=9304448a7d;epid=SCBCC441
m: <sip:333@192.168.0.10>
i: 7a5553c742843273
CSeq: 103 NOTIFY
User-Agent: Asterisk Gemeinschaft
Max-Forwards: 70
o: dialog
c: application/dialog-info+xml
Subscription-State: active
l: 225
Body:
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="1" state="full" entity="sip:333@192.168.0.10:5060">
<dialog id="333" direction="recipient">
<state>early</state>
</dialog>
</dialog-info>
Connected/Busy (LED on)
The connected/busy state is notified within the dialog event subscription. The dialog state in the message body is confirmed.
Here is an example for Joes connected/busy state sent to Leo.
Message:
NOTIFY sip:444@192.168.0.247:5060;transport=udp SIP/2.0
v: SIP/2.0/UDP 192.168.0.10:5060;branch=z9hG4bK3685f474;rport
f: <sip:333@192.168.0.10:5060;transport=udp>;tag=as05967368
t: Leo Demo 444 <sip:444@192.168.0.10>;tag=2ad7b4ac94;epid=SCBCC441
m: <sip:333@192.168.0.10>
i: 4a6a3f0f21b83343
CSeq: 103 NOTIFY
User-Agent: Asterisk Gemeinschaft
Max-Forwards: 70
o: dialog
c: application/dialog-info+xml
Subscription-State: active
l: 207
Body:
<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" version="1" state="full" entity="sip:333@192.168.0.10:5060">
<dialog id="333">
<state>confirmed</state>
</dialog>
</dialog-info>
Complete Example Call Flow
A example call flow has been recorded. At the end of this call flow Joe is in busy (LED on), Alice is in ringing (LED blinking) and Bob is in idle state (LED off).
The complete example call flow: 
BLFBasicCallFlow
