Asterisk Feature Busy Lamp Field (BLF) - Revision history

Hans.zeiner: /* Using the FPK */

2016-08-03T13:59:07Z

‎Using the FPK

Horemu: moved Preview:Asterisk Feature Busy Lamp Field (BLF) to Asterisk Feature Busy Lamp Field (BLF) over redirect

2012-09-27T12:15:30Z

moved Preview:Asterisk Feature Busy Lamp Field (BLF) to Asterisk Feature Busy Lamp Field (BLF) over redirect

Horemu at 06:38, 27 September 2010

2010-09-27T06:38:35Z

Harald.saller: /* For Users */

2010-08-23T10:53:24Z

‎For Users

Harald.saller at 10:20, 23 August 2010

2010-08-23T10:20:21Z

Harald.saller: /* Technical Background */

2010-08-23T10:08:37Z

‎Technical Background

Harald.saller: /* Configuring the "Server Feature" Type */

2010-08-20T13:14:13Z

‎Configuring the "Server Feature" Type

Harald.saller: /* For Administrators */

2010-08-20T12:13:56Z

‎For Administrators

Harald.saller: /* Using the FPK */

2010-08-20T11:23:27Z

‎Using the FPK

Harald.saller: /* For Users */

2010-08-20T11:21:19Z

‎For Users

@@ Line 46: / Line 46: @@
 |-
 |On
-|No action
+|Watched party is called
 |-
 |}

← Older revision		Revision as of 06:38, 27 September 2010
Line 1:		Line 1:
−	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. In the [[Asterisk]] community, this feature is called "Busy Lamp Field"; sometimes the term 'Direct Station Selection' is used for the same functionality.	+	The busy lamp feature allows users to monitor the dialog state of another phone/user extension. This is indicated by the [[LED]]s in an [[FPK]]. In the [[Asterisk]] community, this feature is called "Busy Lamp Field"; sometimes the term 'Direct Station Selection' is used for the same functionality.

	The feature is available for [[OpenStage]] 40/60/80.		The feature is available for [[OpenStage]] 40/60/80.

@@ Line 7: / Line 7: @@
 == 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:
+The basic Busy Lamp Field feature allows the user to monitor the dialog state of another phone. The dialog state is shown by a distinct LED behavior:
 * LED '''off''' -> Watched extension is '''idle'''
@@ Line 17: / Line 17: @@
 '''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:
+There are four users: Leo, Alice, Joe and Bob. Leo is watching the extensions of Alice, Bob and Joe. Each of the extensions is configured on an specific FPK. The example shows the three different extension statuses. Joe is talking to another persion, Alice gets a call, her phone is ringing and Bob is in idle state, like Leo. The following picture illustrates this example:
 [[Image:FPKBLFStatus.gif|thumb|left|300px|Extension status on FPK: Joe is in busy state, Alice is in ringing state, and Bob is in idle state]]<br clear="left"/>
@@ Line 27: / Line 27: @@
 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 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.
+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.

← Older revision		Revision as of 10:20, 23 August 2010
Line 1:		Line 1:
−	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 busy lamp feature allows users to monitor the dialog state of another phone/user extension. This is indicated by the LEDs in an FPK. In the [[Asterisk]] community, this feature is called "Busy Lamp Field"; sometimes the term 'Direct Station Selection' is used for the same functionality.

	The feature is available for [[OpenStage]] 40/60/80.		The feature is available for [[OpenStage]] 40/60/80.

@@ Line 139: / Line 139: @@
 == Technical Background ==
-The BLF feature gives the user the possiblity to watch one other users dialog state. To support the feature [http://www.ietf.org/rfc/rfc4235.txt RFC 4235] is used.
+The BLF feature gives the user the possiblity to watch the dialog state of other users. The feature is implemented according to [http://www.ietf.org/rfc/rfc4235.txt RFC 4235]. This document defines a dialog event package for the SIP Events architecture, along with the data format used in notifications for this package. The dialog package allows users to subscribe to state changes relating to another user. When the subscription is made, the user will receive a notification as soon as the state of an INVITE-initiated dialog on the other user's side changes.
-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 started with an initial subscription from the watching phone. The following table shows the subscription from Leo for Joe's extension:
 {|
@@ Line 175: / Line 173: @@
 |}
-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:
+After that the Asterisk PBK sends a notification to Leo's phone to tell the status of Joe's line. The table below shows an example notification:
 {|
@@ Line 195: / Line 193: @@
 |}
-Within the Notify the line status is delivered in the XML body. The OpenStage phone support three line status
+The line status is delivered in the XML body of the notify message. OpenStage phones supports three different line statuses:
 === Idle (LED off) ===
@@ Line 201: / Line 199: @@
 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.
+Here is an example for Joe's idle state sent to Leo.
 ''Message:''<br />
@@ Line 234: / Line 232: @@
 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.
+Here is an example for Joe#s ringing state sent to Leo.
 ''Message:'' <br />
@@ Line 266: / Line 264: @@
 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.
+Here is an example for Joe's connected/busy state sent to Leo.
 ''Message:'' <br />

← Older revision	Revision as of 12:15, 27 September 2012
(No difference)

@@ Line 125: / Line 125: @@
 '''Key label''' - This is the label of the selected FPK. <br />
 '''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 when the key is pressed during a call. <br />
 '''LED control''' - A subscription is sent to the given URL. <br />
 '''Example:'''
-If Bob has the extension numer ''222'', the parameters will be:
+If Bob has the extension number "222", the parameters will be:
-'''Key label''' - ''Bob'' <br />
+'''Key label''' - "Bob" <br />
-'''Feature Code''' - ''222'', pressing the FPK will always call Bob independant of his line status.. <br />
+'''Feature Code''' - "222": pressing the FPK will always call Bob, independent of his line status. <br />
-'''DTMF Digits''' - n.a..,  not neccessary in this feature <br />
+'''DTMF Digits''' - not neccessary in this feature. <br />
-'''LED control''' - ''222@192.168.6.10'', a subscription for the LED will be sent to the server at the IP address <span style="color: red;">192.168.6.10</span>. If no IP address is given, the request will be automatically sent to the configured SIP proxy server. <br />
+'''LED control''' - "222@192.168.6.10", a subscription for the LED will be sent to the server with the IP address <span style="color: red;">192.168.6.10</span>. If no IP address is specified here, the request will be automatically sent to the SIP server configured for this phone under '''System''' > '''Registration'''. <br />
 == Technical Background ==

@@ Line 69: / Line 69: @@
 == For Administrators ==
-=== Using FPK "BLF" ===
+=== Configuring the "BLF" Type ===
-The FPK are administrated as '''BLF'''. This is one option of the FPK programming options. The configuration can be found in
+Open the web interface and navigate to
-''Administrator Pages -> System -> Features -> Program Keys'':
+'''Administrator Pages''' > '''System''' > '''Features''' > '''Program Keys'''.
-The FPK function is ‘''BLF''’. Select this option and press ‘''Edit''’
+Select the '''BLF''' option and press '''edit'''.
 [[Image:BLFPickUpFPKConfig.png|left|thumb|450px|Basic BLF Configuration with BLF Key]]<br clear="left"/>
-Within the BLF feature four options are given:
+Now, configure the parameters for the BLF feature:
 [[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 />
 '''Monitored Phone''' - This is the SIP URI/phone number of the monitored phone <br />
-'''Audible Alert''' - These checkbox activates a short beep/ringing alert, if LED status changes to blinking <br />
+'''Audible Alert''' - This checkbox activates a short beep/ringing alert, if LED status changes to blinking <br />
-'''Popup on alert''' - These checkbox activates a popup message, if LED status changes to blinking <br />
+'''Popup on alert''' - This checkbox activates a popup message, if LED status changes to blinking <br />
 '''Example:'''
-If Bob has the extension numer ''222'', the parameters will be:
+If Bob has the extension number "222", the parameters will be:
-'''Key label''' - ''Bob'' <br />
+'''Key label''' - "Bob" <br />
-'''Monitored Phone''' - ''222'' <br />
+'''Monitored Phone''' - "222" <br />
-'''Audible Alert''' - ''yes'', a short beep or ringing tone is done, if Bob gets a call.<br />
+'''Audible Alert''' - "yes": a short beep or ringing tone sounds when Bob gets a call.<br />
-'''Popup on alert''' - ''yes'', a popup is shown, if Bob gets a call. <br />
+'''Popup on alert''' - "yes": a popup is shown when Bob gets a call. <br />
 '''Remark:'''
-It migth be neccessry to configure an BLF Pickup Group Feature Key to enable the function. This can be done at
+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'':
+'''Administrator Pages''' > '''System''' > '''Features''' > '''Services''':
 [[Image:BLFPickUpGroupFK.jpg|thumb|left|450px|BLF Pickup Code Configuration]]<br clear="left"/>
-=== Using FPK "Server Feature" ===
+=== Configuring the "Server Feature" Type ===
-The FPK are administrated as '''Server Key'''. This is one option of the FPK programming options. The configuration can be found in
+To assign the '''Server Feature''' function to the FPK, proceed as follows:
-''Administrator Pages -> System -> Features -> Program Keys'':
+Open the web interface and navigate to
-The FPK function is ‘''Server Feature''’. Select this option and press ‘''Edit''’
+'''Administrator Pages''' > '''System''' > '''Features''' > '''Program Keys''':
 [[Image:BLFBasicFPKConfig.png|left|thumb|450px|Basic BLF Configuration with Server Key]]<br clear="left"/>
-Within the server feature four options are given:
+Now, configure the parameters for the BLF feature:
 [[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, if the key is pressed in idle status <br />
+'''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 Subscribtion is sent to the given URL <br />
+'''LED control''' - A subscription is sent to the given URL. <br />
 '''Example:'''

@@ Line 31: / Line 31: @@
 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.
-The OpenStage FPK is able to perform different actions depending on the satus of the FPK.
+Depending on the configured type and the status of the observed party, different actions are performed.
 '''BLF Type:'''

@@ Line 13: / Line 13: @@
 * LED '''on''' -> Watched extension is '''busy/connected'''
-In the basic configuration pressing the FPK will call the monitored persion in any call state.
+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 annother persion, Alice gets a call, her phone is ringing and Bob is in idle like Leo is. The following picture shows this 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:
-[[Image:FPKBLFStatus.gif|thumb|left|300px|Extension status on FPK: Joe is in busy, Alice is in ringing and Bob is in idle state]]<br clear="left"/>
+[[Image:FPKBLFStatus.gif|thumb|left|300px|Extension status on FPK: Joe is in busy state, Alice is in ringing state, and Bob is in idle state]]<br clear="left"/>
-Leo can see at any time the status of the other people by watching the LEDs on the FPK.
+Leo can see the status of the other people at any time by watching the LEDs on the FPK.
-=== Using FPK ===
+=== Using the FPK ===
-The OpenStage phone supports the BLF functionality in two differen FPK functions types.
+The OpenStage phone supports the BLF functionality in two different FPK function types.
-The ''BLF-Type'' can be used in scenarious, where team members want to pick up the call for each other team members.
+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 receiptions for example, where the receptionist wants to see the call status of all employees, but never wants to pick up the call for someone.
+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.
 The OpenStage FPK is able to perform different actions depending on the satus of the FPK.
-'''BLF-Type:'''
+'''BLF Type:'''
 {|
@@ Line 39: / Line 39: @@
 ! Action by Key Press
 |-
-|off
+|Off
-|Wachted Party is called
+|Watched party is called
 |-
-|blinking
+|Blinking
-|Incoming call for watched persion is picked up
+|Incoming call for watched person is picked up
 |-
-|on
+|On
-|Nothing
+|No action
 |-
 |}
-'''Server Feature-Type:'''
+'''Server Feature Type:'''
 {|
@@ Line 56: / Line 56: @@
 ! Action by Key Press
 |-
-|off
+|Off
-|Wachted Party is called
+|Watched party is called
 |-
-|blinking
+|Blinking
-|Wachted Party is called
+|Watched party is called
 |-
-|on
+|On
-|Wachted Party is called
+|Watched party is called
 |-
 |}