BLF implementation using XML

Target release	1.0
Epic	XQI-2015 - Getting issue details... STATUS
Document status	DRAFT
Document owner	Alexander Feldt
Designer	Zsolt Erdei
Developers	Clemens Cramer
QA	Tita Petre

Goals

Align BLF and Extension behavior for PFKs on Snom desk phones by using XML definitions instead
- Improve user experience
- Improve performance

Background and strategic fit

BLF is a valuable feature for Snom customers, like enterprises who are looking to assist in connecting their customers to a live, available person as well as save business phone use time. Overall, it enables businesses to streamline their communication and better serve customers. BLF aka Extension monitoring has been utilized in numerous ways by businesses using Snom phone systems with multiple extensions. The current implementation appears to be kind of duplicated, but with a few little differences and erroneous behaviour.

Assumptions

Use case#1: A secretary's phone shall display the call status of the boss's line, allowing the secretary to know whether the boss is on a phone call or not. This will enable the secretary to make the decision to put the new caller on hold or let them through to the boss.
Use case#2: Call centers and customer support groups have also a need for BLF: it enables employees to see if their colleagues are free to take a support call or if their supervisor is on another line and unable to help another customer.
Use case#3: BLF is needed by teams working on a specific project: supervisors can monitor team members' extensions and vice versa so all team members are aware of each other's current status.

Requirements

#

Requirement title

Functionality

Importance

Implementation status

1

D8XX_BLF-XML_FR-1

On Snom IP phones acting as UAS, any SIP extension having an active subscription of its state changes, shall sent a notification SIP message (NOTIFY) to the UAC, when one of the following state changes occur:

from any state => terminated
from any state => trying
from any state => early/proceeding
from any state => confirmed

Must Have

FULLY IMPLEMENTED

2

D8XX_BLF-XML_FR-2

On D8xx IP phones, any PFK (programmable function key - physical or virtual) can be assigned to a key type called "BLF-XML", and a key number, which corresponds to a SIP extension on another IP phone in the same VoIP environment. The following functionality is required:

Monitoring certain states of the configured SIP extension, see details below
Quick-dial to the configured SIP extension in idle state
Pick-up an incoming call to the configured SIP extension

Dialog states of the configured SIP extension shall be monitored, processed, and translated according to its direction.

UAS state	Dialog state (NOTIFY)	Direction	Translated state	Allowed actions
idle mode	terminated	-	idle	Quick-dial
offhook / dialling	trying	initiator	offhook	-
incoming call ringing	early/proceeding	recipient	ringing	Pick-up
incoming call accepted	confirmed	recipient	talking	-
outgoing call ringing	early/proceeding	initiator	calling	-
outgoing call accepted	confirmed	initiator	talking	-

According to the translated state the following actions are allowed, when the PFK is pressed:

Dialog state	terminated	trying	early/proceeding		confirmed
Translated state	idle	offhook	calling	ringing	talking
Direction	-	initiator	initiator	recipient	initiator/recipient
Allowed actions	Quick-dial	-	-	Pick-up	-

Must Have

PARTLY IMPLEMENTED

3

D8XX_BLF-XML_FR-3

The assignment shall be configured either manually via web user interface (WUI) and/or phone user interface (PUI), and automatically via auto-provisioning (HTTP/TFTP setting server), SRAPS, or remote management (TR-069).

Must Have

FULLY IMPLEMENTED

4

D8XX_BLF-XML_FR-2-1

On D8xx series, during an active subscription, state changes of the monitored SIP extension shall be visualized on both, PFK LED and PFK label.

Must Have

FULLY IMPLEMENTED

5

D8XX_BLF-XML_FR-2-1-1

The PFK LED behaviour and colour shall be according to this table

Dialog state	terminated	trying	early/proceeding		confirmed
Translated state	idle	offhook	calling	ringing	talking
Direction	-	initiator	initiator	recipient	initiator/recipient
LED behaviour	off	on	on	blinking	on
LED colour	-	red	red	red	red

Must Have

PARTLY IMPLEMENTED

6

D8XX_BLF-XML_FR-2-1-2

The PFK label shall be composed of 3 areas:

(A) icon area	(B) name area
	(C) state area

Must Have

FULLY IMPLEMENTED

7

D8XX_BLF-XML_FR-2-1-2-1

The label icon area (A) shall contain the following graphical symbol and colour

Dialog state	terminated	trying	early/proceeding		confirmed
Translated state	idle	offhook	calling	ringing	talking
Direction	-	initiator	initiator	recipient	initiator/recipient
Graphical symbol	tbd	tbd	tbd	tbd	tbd
Colour	white/tbd	white/tbd	white/tbd	white/tbd	white/red

Must Have

PARTLY IMPLEMENTED

8

D8XX_BLF-XML_FR-2-1-2-2

The label name area (B) shall contain a text using either the display name or number (configurable) of the monitored / calling party. Depending on the available space, the text shall be scrolled.

Dialog state	terminated	trying	early/proceeding		confirmed
Translated state	idle	offhook	calling	ringing	talking
Direction	-	initiator	initiator	recipient	initiator	recipient
Text (based on target)	local	local >	local > remote	remote > local	remote <> local	local <> remote
Text colour	white	white	white	white	white	white
Example (using number)	101	101 >	101 > 102	102 > 101	102 <> 101	101 <> 102
Example (using display name)	Alex	Alex >	Alex > Alice	Alice > Alex	Alice <> Alex	Alex <> Alice

Must Have

PARTLY IMPLEMENTED

9

D8XX_BLF-XML_FR-2-1-2-3

The label state area (C) shall contain a text and colour representing the translated state

Dialog state	terminated	trying	early/proceeding		confirmed
Translated state	idle	offhook	calling	ringing	talking
Direction	-	initiator	initiator	recipient	initiator/recipient
text	idle	offhook	calling	ringing	talking
colour	white	white	white	white	white

Must Have

PARTLY IMPLEMENTED

Interactions and output

Interactions

SIP message

XML definition

Result

UAS

UAS => NOTIFY => UAC

UAC NOTIFY parsing rules

PFK LED & label

goes offhook

dialog state => trying

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full"
	entity="sip:101@...">
	<dialog id="..." >
		<state>trying</state>
	</dialog>
</dialog-info>

translate state => offhook

quick dial not allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	...
  	<level3
		translates_to="offhook">/dialog-info/dialog/state[.="trying"]
	</level3>
  	...
</NotifyParsingRules>
...
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

🔴		101 >
		offhook

goes onhook

dialog state => terminated

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full"
	entity="sip:101@...">
	<dialog id="..."
		direction='initiator'
		call-id='...'
		local-tag=""
		remote-tag="">
		<state>terminated</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
			</target>
		</local>
	</dialog>
</dialog-info>

translate state => idle

quick dial allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	...
  	<level5 translates_to="idle"/>
</NotifyParsingRules>
...
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

⚪️		101
		idle

incoming call ringing

dialog state => early/proceeding

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full" entity="...">
	<dialog
		id="..."
		direction='recipient'
		call-id='...'
		local-tag="..."
		remote-tag="...">
		<state>early</state>
		<local>
			<identity display="B">
				sip:101@...
			</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
			</target>
		</local>
		<remote>
			<identity display="C">
				sip:102@...
			</identity>
			<target uri="sip:102@..."/>
		</remote>
	</dialog>
</dialog-info>

translate state => ringing

quick dial not allowed
pick-up allowed

XML definition

...
<NotifyParsingRules type="state">
	<level1
		translates_to="ringing">/dialog-info/dialog/state[.="early"]
	</level1>
	...
	<level2
		translates_to="ringing">/dialog-info/dialog/state[.="proceeding"]
	</level2>
  ...
</NotifyParsingRules>
<NotifyParsingRules
	type="variable"
	id="call_id"
	state="ringing">
	<level1 fetch_attribute="call-id">/dialog-info/dialog[@call-id]</level1>
</NotifyParsingRules>
<NotifyParsingRules
	type="variable"
	id="remote_tag"
	state="ringing">
	<level1 fetch_attribute="remote-tag">/dialog-info/dialog[@remote-tag]</level1>
</NotifyParsingRules>
<NotifyParsingRules
	type="variable"
	id="local_tag"
	state="ringing">
	<level1 fetch_attribute="local-tag">/dialog-info/dialog[@local-tag]</level1>
</NotifyParsingRules>
<NotifyParsingRules
	type="variable"
	id="remote_uri"
	state="ringing">
	<level1 fetch_attribute="uri">/dialog-info/dialog/remote/target[@uri]</level1>
</NotifyParsingRules>
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

🟠		102 > 101
		ringing

incoming call accepted

dialog state => confirmed

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full"
	entity="sip:101@...">
	<dialog
		id="..."
		direction='recipient'
		call-id='...'
		local-tag="..."
		remote-tag="...">
		<state>confirmed</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
				<param pname="+sip.rendering" pval='yes' />
			</target>
		</local>
			<remote>
				<identity display="C">sip:102@...</identity>
				<target uri="sip:102@..."/>
			</remote>
	</dialog>
</dialog-info>

translate state => talking

quick dial not allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	...
	<level4
		translates_to="talking">/dialog-info/dialog/state[.="confirmed"]
	</level4>
</NotifyParsingRules>
...
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

🔴		102 <> 101
		talking

Incoming call terminated

dialog state => terminated

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="8"
	state="full"
	entity="sip:101@...">
	<dialog id="..."
		direction='recipient'
		call-id='...'
		local-tag="..."
		remote-tag="...">
		<state>terminated</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
			</target>
		</local>
		<remote>
			<identity display="C">sip:102@...</identity>
			<target uri="sip:102@..."/>
		</remote>
	</dialog>
</dialog-info>

translate state => idle

quick dial allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
  ...
  <level5 translates_to="idle"/>
</NotifyParsingRules>
... 
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

⚪️		101
		idle

Outgoing call ringing

dialog state => early/proceeding

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="13"
	state="full"
	entity="sip:101@...">
	<dialog
		id="..."
		direction='initiator'
		call-id='...'
		local-tag="..."
		remote-tag="">
		<state>early</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
			</target>
		</local>
		<remote>
			<identity display="D">sip:103@...;user=phone</identity>
			<target uri="sip:103@...;user=phone"/>
		</remote>
	</dialog>
</dialog-info>

translate state => calling

quick dial not allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	<level1
		translates_to="ringing">/dialog-info/dialog/state[.="early"]
	</level1>
	<level1-1
		translates_to="calling">/dialog-info/dialog[@direction="initiator"]
	</level1-1>
	<level2
		translates_to="ringing">/dialog-info/dialog/state[.="proceeding"]
	</level2>
	<level2-1
		translates_to="calling">/dialog-info/dialog[@direction="initiator"]
	</level2-1>
</NotifyParsingRules>
...
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

🔴		101 > 103
		calling

Outgoing call accepted

dialog state => confirmed

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full"
	entity="sip:101@...">
	<dialog
		id="..."
		direction='initiator'
		call-id='...'
		local-tag="..."
		remote-tag="...">
		<state>confirmed</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
				<param pname="+sip.rendering" pval='yes' />
			</target>
		</local>
		<remote>
			<identity display="D">sip:103@...</identity>
			<target uri="sip:103@..."/>
		</remote>
	</dialog>
</dialog-info>

translate state => talking

quick dial not allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	...
	<level4
		translates_to="talking">/dialog-info/dialog/state[.="confirmed"]
	</level4>
</NotifyParsingRules>
... 
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

🔴		101 <> 103
		talking

Outgoing call terminated

dialog state => terminated</state>

NOTIFY

NOTIFY
...
<?xml version="1.0"?>
<dialog-info
	xmlns="urn:ietf:params:xml:ns:dialog-info"
	version="..."
	state="full"
	entity="sip:101@...">
	<dialog
		id="..."
		direction='initiator'
		call-id='...'
		local-tag="..."
		remote-tag="...">
		<state>terminated</state>
		<local>
			<identity display="B">sip:101@...</identity>
			<target uri="sip:101@...;line=...">
				<param pname="x-line-id" pval="0" />
			</target>
		</local>
		<remote>
			<identity display="D">sip:103@...</identity>
			<target uri="sip:103@..."/>
		</remote>
	</dialog>
</dialog-info>

translate state => idle

quick dial allowed
pick-up not allowed

XML definition

...
<NotifyParsingRules type="state">
	...
  	<level5 translates_to="idle"/>
</NotifyParsingRules>
... 
<action>
	<invite target="$(subscr_uri)"
		when="on press"
		states="idle"/>
	<invite target="$(remote_uri)"
		when="on press"
		state="ringing"
		request_uri="$(remote_uri)"
		replaces="$(call_id);to-tag=$(remote_tag);from-tag=$(local_tag)"/>
</action>

⚪️		101
		idle

Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question	Outcome

Space shortcuts

Page tree

Goals

Background and strategic fit

Assumptions

Requirements

Interactions and output

Questions

Not Doing