Documentation

OpenStage - Provisioning Interface

Developer’s Guide

A31003-S2000-R102-6-7620

Communication for the open minded

Siemens Enterprise Communications

www.siemens.com/open
 Copyright © Siemens Enterprise
Communications GmbH & Co. KG 2007
Hofmannstr. 51, D-80200 München
Siemens Enterprise Communications GmbH & Co. KG
is a Trademark Licensee of Siemens AG
Reference No.: A31003-S2000-R102-6-7620
The information provided in this document contains
merely general descriptions or characteristics of
performance which in case of actual use do not
always apply as described or which may change as
a result of further development of the products. An
obligation to provide the respective characteristics
shall only exist if expressly agreed in the terms of
contract. Availability and technical specifications are
subject to change without notice.
Communication for the open minded OpenScape, OpenStage and HiPath are registered
trademarks of Siemens Enterprise
Communications GmbH & Co. KG.
Siemens Enterprise Communications All other company, brand, product and service
www.siemens.com/open names are trademarks or registered trademarks of
their respective holders.
bkIVZ.fm

Nur für den internen Gebrauch

1 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3 Basic Network Infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3.1 Standard Network Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3.2 Firewall And NAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4 Network Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.1 Protocols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.2 Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.3 HTTP Sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.4.4 HTTP/HTTPS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2 DHCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.1 Basic Network Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.2 Extended Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.3 Example DHCP server configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3 Basic Communication Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.1 Basic Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.1.1 Phone Driven Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.1.2 Provisioning Service Driven Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.2 Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.3 Phone Message Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.3.1 Initial Message From the Phone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.3.2 Root Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.3.3 Message Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.3.4 Reason for Contact. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.4 Provisioning Service Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.4.1 Initiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.4.2 Action Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3.5 Phone Driven Interactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.5.1 An Exemplary Startup Interaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
3.5.2 Local Changes in the Phone’s Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.5.3 Announce Deployment Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3.6 Provisioning Service Driven Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.6.1 Start an Interaction: Contact-me. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.6.2 End an Interaction: Clean-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.6.3 Read Phone Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
3.6.4 Modify Phone Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.6.5 Restart Phone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
3.6.6 Factory Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3.6.7 File Provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
3.6.8 Firmware Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.7 Message Fragmentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
3.7.1 Fragmentation of Phone Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

A31003-S2000-R102-6-7620 26. August 2010

-1 Asterisk - OpenStage Family, Developer’s Guide
 bkIVZ.fm
Nur für den internen Gebrauch

3.7.2 Fragmentation of Provisioning Service Messages . . . . . . . . . . . . . . . . . . . . . . . . . 55

3.8 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3.8.1 Example 1: Configuration Item Is Unknown At Phone . . . . . . . . . . . . . . . . . . . . . . 56
3.8.2 Example 2: Items Failed To Be Set At Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.8.3 Example 3: Configuration item Is Read Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4 Phone Parameters - Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
4.1 Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.1.1 XML applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.2 Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.2.1 IP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.2.2 Update Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.2.3 QoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
4.2.4 Port configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
4.2.5 LLDP-MED Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
4.3 System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
4.3.1 System Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
4.3.2 SIP interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
4.3.3 Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
4.3.4 SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.3.5 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
4.3.6 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
4.4 File Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
4.4.1 FTP/HTTPS Access Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
4.4.2 File Provisioning Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
4.4.3 Specifications For Media Files and LDAP Templates . . . . . . . . . . . . . . . . . . . . . . 113
4.5 Local functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
4.5.1 Directory settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
4.5.2 Messages settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
4.5.3 Locality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
4.5.4 Energy Saving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
4.6 Date and time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
4.7 Speech. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
4.7.1 Codec preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
4.7.2 Audio settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
4.8 General information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
4.9 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
4.9.1 Change Admin password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
4.9.2 Change User password. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
4.10 Ringer Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
4.11 Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
4.11.1 Fault trace configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
4.11.2 QoS Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
4.11.3 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
4.12 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

A31003-S2000-R102-6-7620, 26. August 2010

Asterisk - OpenStage Family, Developer’s Guide -2
bkIVZ.fm

Nur für den internen Gebrauch

4.12.1 Remote trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

4.12.2 Restart phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
4.12.3 Factory reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
4.12.4 Secure Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
5 Phone Parameters - User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
5.1 Date and Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
5.2 Audio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.3 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.3.1 Outgoing calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.3.2 Incoming calls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.3.3 Connected calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.3.4 Context menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.3.5 Bluetooth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.4 Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.4.1 Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.4.2 Screensaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.4.3 Program Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.4.4 Key Module 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.4.5 Key Module 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.4.6 OpenStage 15 Key Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.5 Locality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
5.6 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
6 Phone Parameters - Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
6.1 Provisioning Service Related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
6.2 Phone Specific, Hardware Related . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
6.3 Network/DNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
6.4 802.1x Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
6.5 USB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
6.6 SIP/System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
6.7 Audio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
6.8 Feature Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
6.9 Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.10 Provisioning Service Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.11 LDAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.12 Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
6.13 Call Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
7 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.1 XML Schemas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.1.1 Common Message Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
7.1.2 Phone Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
7.1.3 Provisioning Service Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
7.2 Country codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
7.3 Language Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

A31003-S2000-R102-6-7620 26. August 2010

-3 Asterisk - OpenStage Family, Developer’s Guide
 bkIVZ.fm
Nur für den internen Gebrauch

7.4 Locked Configuration Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

7.4.1 Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
7.4.2 Display Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.4.3 Clock Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.4.4 Telephony Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
7.4.5 Audio Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.4.6 Busy Lamp Fields (BLF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.4.7 Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.4.8 Phone Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.4.9 Bluetooth Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.4.10 Call Recordings Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
7.5 Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

A31003-S2000-R102-6-7620, 26. August 2010

Asterisk - OpenStage Family, Developer’s Guide -4
c01.fm

Getting Started
Overview

1 Getting Started

1.1 Overview
Siemens OpenStage SIP phones support the SIP protocol according to RFC 3261 and there-
fore can operate at any standard-compliant SIP server.
Moreover, a multitude of interfaces for control, configuration, and provisioning is available:
• Local user interface, graphical or text based: Allows for control and configuration both by
the user and the administrator.
• Web-based interface: The phone has a built-in web server enabling both the user and the
administrator to control and configure the phone via a standard web browser.
• Phone manager: A phone management tool for the user which allows for e. g. editing the
local phonebook and synchronizing it with MS Outlook contact data. The software, which
communicates over IP, is installed on the user’s PC (Windows 2000 or Windows XP)
• Provisioning interface: The phone is controlled and configured by messages in XML for-
mat which are transmitted by HTTPS. In turn, the phone provides configuration and status
information over the same interface. Moreover, when local changes have been executed
on the phone, it informs the provisioning service automatically. Any kind of administration
task is supported, such as updating the firmware on a selection of phones. Hence, mass
deployment can be accomplished conveniently. Unlike many other VoIP phones, which are
limited to prefabricated configuration files to be downloaded at startup, OpenStage phones
can be deployed and provisioned any time by an interactive service.
This document contains information about the required infrastructure and describes the provi-
sioning interface in detail.

A31003-S2000-R102-6-7620 26. August 2010

1-5 Asterisk - OpenStage Family, Developer’s Guide
 c01.fm
Getting Started
Prerequisites

1.2 Prerequisites
For developing and operating a provisioning service for OpenStage phones, please ensure that
you have the following prerequisites.
1. OpenStage SIP phone with appropriate firmware version.
2. Infrastructure:
• Connection to an IP network.
• (Recommended:) DHCP server to communicate the IP address of the provisioning
server to the phone.
• Web browser to configure the application on the phone using the Web Based Manage-
ment. Alternatively, the phone’s local menu can be used.
• FTP or HTTPS server for file and software deployment.
• SIP server

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 1-6
c01.fm

Getting Started
Basic Network Infrastructure

1.3 Basic Network Infrastructure

1.3.1 Standard Network Structure

All components are connected via LAN. The OpenStage IP phones receive their basic network
configuration from the DHCP server and/or from LLDP-MED. This may include a VLAN ID, if a
VLAN infrastructure is required. Further configuration is done via the provisioning service. Ad-
ditionally, many configuration and deployment tasks can be accomplished via the phone’s web
interface. For uploading files, such as ringtones, screensaver images, or firmware, to the
phone, a file server is required (FTP or HTTPS). To enable telephony, the phones are regis-
tered at a SIP server.

LAN
LAN
DHCP
HTML over HTTP
or HTTPS

SIP HTML/XML over HTTP/

FTP or HTTPS
HTTPS

Web Interface
DHCP Server

SIP Server File Server Provisioning Service

A31003-S2000-R102-6-7620 26. August 2010

1-7 Asterisk - OpenStage Family, Developer’s Guide
 c01.fm
Getting Started
Basic Network Infrastructure

1.3.2 Firewall And NAT

If the phones and the provisioning service reside in different networks or subnets, which are
separated by a firewall and/or NAT, it may be impossible for the provisioning service to estab-
lish a connection with the phones. In this case, provisioning service driven interactions may not
be possibe (for details about provisioning service driven interactions, please refer to Section
1.4.4.2, "Contact-me Messages" and Section 3.1.2, "Provisioning Service Driven Interaction").
To enable a solution for this problem, the phone can be configured to periodically poll the pro-
visioning service, or a special proxy, for new messages. Thus, provisioning service driven in-
teractions are possible even when the provisioning service is located behind a firewall, or in a
DMZ. For further information, please refer to Section 1.4.4.3, "Polling Request To Bridge A
Firewall" and Section 3.1.2.2, "Provisioning Service Located Behind A Firewall".

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 1-8
c01.fm

Getting Started
Basic Network Infrastructure

LAN
LAN

Firewall

Periodic poll over HTTP XML messages over

HTTP/HTTPS

Provisioning Service,
possibly in combina-
tion with a proxy

A31003-S2000-R102-6-7620 26. August 2010

1-9 Asterisk - OpenStage Family, Developer’s Guide
 c01.fm
Getting Started
Network Communication

1.4 Network Communication

This chapter contains the elementary HTTP/HTTPS communication required for interaction
between the phone and the provisioning service. For a high-level description of the possible
interactions, please refer to Section 3, "Basic Communication Procedures".

To prevent communication problems in the HTTP layer, please consider the follow-
> ing:
● The keep-alive timeout in the provisioning server should be set to 10.
● The provisioning server must be set to use HTTP 1.1.
● The provisioning server must not use HTTP chunked encoding (this problem will
be solved with firmware version V2R3).

1.4.1 Protocols
When the provisioning service wants to start communicating with a phone, it has to send a spe-
cial contact-me message. This message, as well as the response from the phone, is transmit-
ted via HTTP (clear text, not encrypted).
All further communication between the provisioning service and the phone consists of messag-
es in XML format, which are transmitted using HTTP v1.1 over TLS (HTTPS).

OpenStage phones expect the interface on port 18443 to be TLS-encrypted

> (HTTPS). Therefore, the provisioning server needs to configure SSL/TLS on this lis-
tener port. Since OpenStage phones do not authenticate the server, any certificate
is suitable. For information on importing or creating a suitable TLS web server cer-
tificate, pleaser refer the relevant documentation for your web server.

1.4.2 Ports
On the phone side, the destination port for messages to the provisioning server can be freely
chosen. The address and port number of the provisioning service are defined unter Network >
Update service in the phone’s web interface or provided by DHCP (see Section 2.2, "Extended
Configuration").
For sending contact-me messages to the phone in order to initiate an interaction, the provision-
ing service must use port 8085 as destination port.

1.4.3 HTTP Sessions

As some interactions may consist of several subsequent HTTPS request/response messages,
it must be possible to establish HTTP sessions. For this purpose, OpenStage SIP phones sup-
port HTTP cookies.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 1-10
c01.fm

Getting Started
Network Communication

To end a session, the provisioning server sends a special clean-up message to the phone. In
some error cases, e. g. when the received XML is invalid, the phone will send a clean-up mes-
sage on its part.

A31003-S2000-R102-6-7620 26. August 2010

1-11 Asterisk - OpenStage Family, Developer’s Guide
 c01.fm
Getting Started
Network Communication

1.4.4 HTTP/HTTPS Messages

Generally, two types of HTTP/HTTPS messages are used by the provisioning interface: XML
messages for phone control and data exchange, and HTML messages for initiating an interac-
tion by the provisioning service.

The content-length of HTTPS responses should be set to the length of the XML mes-
> sage content.

1.4.4.1 XML Messages For Data Exchange

Regular XML messages used for interactions between phone and provisioning service are
transmitted via HTTPS. The HTTP method is POST, and the Content-type is text/xml.
The structure of the XML messages is described in Section 3, "Basic Communication Proce-
dures".
This is the structure of a URI for a request sent by the phone to the provisioning server:
https://<host>:<port>/<path to provisioning service>
Example: https://192.168.1.103:18443/provisioningService

1.4.4.2 Contact-me Messages

With this type of message, the provisioning service announces to the phone that it has a new
message for the phone.
Initial contact-me messages from the provisioning service are transmitted via non-encrypted
HTTP. The POST method is used. The HTTP Content-type is application/x-www-
form-urlencoded. The following parameters must/can be sent to the phone:
• ContactMe (required): Set to true if a response from the phone is expected.
• dls_ip_addr (optional): Target IP address for the response from the phone.
• dls_ip_port (optional): Port associated with the IP address provided with
dls_ip_addr.
The parameters described above enable the provisioning service to scan a certain range of IP
addresses for phones simply by sending contact-me requests to each address consecutively.
The complete URI for contact-me messages has the following structure:
http://<IP address>:8085/contact_dls.html/ContactDLS
Example: http://192.168.1.4:8085/contact_dls.html/ContactDLS
The following examples show the HTTP communication initiated by a contact-me message.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 1-12
c01.fm

Getting Started
Network Communication

Contact-me Message Example

POST /contact_dls.html/ContactDLS HTTP/1.1
Content-type: application/x-www-form-urlencoded; charset=utf-8
User-Agent: Jakarta Commons-HttpClient/2.0final
Host: 192.168.1.103:8088
Content-Length: 14

ContactMe=true

Phone Response to Contact-me Example

The phone sends a corresponding HTTP response. The HTTP status is 204 (no content). The
HTTP Content-type is text/html.
HTTP/1.1 204 No Content
Server: DlsClient
Content-Length: 0
Content-type: text/html

1.4.4.3 Polling Request To Bridge A Firewall

When the provisioning service is located behind a firewall, or in a DMZ, it may have no possi-
bility to send a contact-me message to the phone. To enable provisioning service driven inter-
actions despite this limitation, the phone can be configured to periodically poll the provisioning
service, or a special proxy, for new messages. This configuration is done by the provisioning
service, for instance, at phone startup; for the relevant configuration items, see Section 5.1,
"Provisioning Service Related".
The polling request is an HTTP GET request which contains a particular key/value pair to iden-
tify the phone. The key is device-id, and the value is the phone’s MAC address as a param-
eter. The structure is as follows:
http://<target address>/dcmp/contact-me?device-id=<MAC address>
Example:
http://provisioning.mycompany.com/dcmp/contact-me?device-
id=12:34:56:78:9a:bc

A31003-S2000-R102-6-7620 26. August 2010

1-13 Asterisk - OpenStage Family, Developer’s Guide
 c02.fm
DHCP
Basic Network Configuration

2 DHCP
The use of DHCP for network configuration is highly recommended. To enable an OpenStage
phone to contact the provisioning service immediately on startup, the appropriate contact ad-
dress must be provided beforehand. This can be done by DHCP. Moreover, this method pre-
vents faking a provisioning service with malicious intentions, as the phone will only contact the
provisioning service whose address it has learned from the DHCP server.

Please ensure that the phone’s DHCP client is enabled. For configuration instruc-
> tions, see the OpenStage Administration Manual.

Parameters that have been set by DHCP cannot be modified afterwards, regardless
> of the interface in use (local menu, web interface, provisioning interface).

2.1 Basic Network Configuration

For basic networking functionality, DHCP must provide the following parameters:
• IP Address: IP address for the phone.
• Subnet Mask (option #1 "Subnet Mask"): Subnet mask of the phone.
• Default Route (option #3 "Router"): IP address of the default gateway which is used for
connections beyond the subnet.
• DNS IP Addresses (option #6 "Domain Server"): IP addresses of the primary and sec-
ondary DNS servers.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 2-14
c02.fm

DHCP
Extended Configuration

2.2 Extended Configuration

Additionally, it is possible to provide these parameters by DHCP, as an alternative to setting
them manually, or via provisioning service.
• SNTP IP Address (option #42 "NTP Servers"): IP address or hostname of the SNTP
server to be used by the phone.
• Timezone offset (option #2 "Time Offset"): Offset in seconds in relationship to the UTC
time provided by the SNTP server.
• SIP server (option #120 "SIP Servers DHCP Option"): The SIP server to be used by the
phone.
• Domain name (option #15 "Domain Name"): The name of the DNS domain wherein the
phone is residing.
• VLAN ID: Necessary if the phone operates in a VLAN (Virtual LAN). This parameter can
be provided by means of a "vendor-encapsulated-options" option.
• Provisioning service contact address: Enables the phone to contact the provisioning
service immediately on startup. This parameter can be provided by means of a
vendor-encapsulated-options option.

2.3 Example DHCP server configuration

The following description demonstrates by example how a ISC DHCP server can be configured
in order to build up a working infrastructure for OpenStage phones.
The configuration example has been tested with ISC DHCP server version 3 running on Debian
Linux (package: dhcp3-server).
On startup, the OpenStage phone sends a DHCP discovery message which contains the
vendor-class-identifier option. The fixed value is OptiIpPhone. This identifier is used
by the DHCP server to send a specified set of sub-options to each OpenStage phone by means
of vendor encapsulated options. The vendor-encapsulated-options option allows for de-
fining custom-made options in either a single series of bytes or a sequence of parameters
which is constructed from:
1. the single-byte vendor-specific option code;
2. the single-byte length indication for the option data (the length does not include itself or the
option code);
3. the data itself in as many bytes of data as are specified in the length indication.
The value of the vendor-encapsulated-options option can either be set directly by
coding the bytes in hexadecimal notation, or, preferably, by using the option space state-
ment. This statement is available with ISC DHCP 3.0 onwards.

A31003-S2000-R102-6-7620 26. August 2010

2-15 Asterisk - OpenStage Family, Developer’s Guide
 c02.fm
DHCP
Example DHCP server configuration

To assign the specific vendor-encapsulated-options to the appropriate devices, the use

of classes is recommended. In the example, the vendor-classes class is divided into sub-
classes automatically for each vendor-class-identifier option that is received from the
clients. As OpenStage phones send the value OptiIpPhone, the specifications for these
phones are defined in the corresponding sub-class.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 2-16
c02.fm

DHCP
Example DHCP server configuration

Example dhcpd.conf
# General configuration for all clients in the subnet
subnet 192.168.2.0 netmask 255.255.255.0 {
option domain-name-servers 192.168.2.2;
option broadcast-address 192.168.2.255;
option routers 192.168.2.251;
option subnet-mask 255.255.255.0;
option domain-name "phones.intranet";
option ntp-servers 192.43.244.18;
option time-offset 3600;
default-lease-time 864000;
max-lease-time 8640000;
}
# Set up an option space to contain the vendor-encapsulated options
option space OpenStage;
option OpenStage.vendor code 1 = string;
option OpenStage.vlanid code 2 = unsigned integer 32;
option OpenStage.dls code 3 = string;
# Each vendor-class-identifier will constitute a class
class "vendor-classes" {
match option vendor-class-identifier;
}
# Specifications for OpenStage phones
subclass "vendor-classes" "OptiIpPhone" {
vendor-option-space OpenStage;
option OpenStage.vendor "Siemens";
option OpenStage.vlanid 4;
option OpenStage.dls "sdlp://192.168.2.103:18443";
option sip-server 192.168.2.117;
}

A31003-S2000-R102-6-7620 26. August 2010

2-17 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Basic Message Flow

3 Basic Communication Procedures

This chapter describes the interaction between the phone and the provisioning server in detail.
Depending on the situation and the intended task, the interaction will be started by the phone
or by the provisioning service. First, we will explain the basic message flow.

Depending on the amount of configuration data, the XML messages might become
> quite long. In order to prevent overflow problems, longer messages can be split into
fragments. For details, see Section 3.8, "Message Fragmentation".

3.1 Basic Message Flow

3.1.1 Phone Driven Interaction

A typical reason for contacting the provisioning service is a configuration change on the phone.
The message flow might proceed as follows: In an initial HTTPS request, the phone tells the
provisioning service that it is ready for operation. In its response, the provisioning service asks
for all current settings (configuration items). Hence, the phone sends a complete list of settings,
allowing the provisioning service to update its database. At this point, the provisioning service
may decide whether the phone’s configuration needs to be changed or not. If not, the provision-
ing service should send a clean-up message, telling the phone not to expect any further mes-
sages. This will also end the HTTPS session.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-18
c03.fm

Basic Communication Procedures

Basic Message Flow

Phone Provisioning
Service
HTTPS Request
Initial message, declaring
the reason for contact,
which is one of the follow-
ing:
– Startup (=registration
with the provisioning
service)
– Configuration changes
– Hardware connected/
disconnected
– Indicate file deploy-
ment status

HTTPS Response
Provisioning service re-
quests all configuration
items from the phone

HTTPS Request
Phone sends all available
configuration items

HTTPS Response
Clean-up message tells
the phone that the interac-
tion is finished

A31003-S2000-R102-6-7620 26. August 2010

3-19 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Basic Message Flow

3.1.2 Provisioning Service Driven Interaction

3.1.2.1 No Firewall
A typical reason for contacting the phone is the modification of one or more configuration set-
tings. The message flow might proceed as follows: In an initial HTTP request, the provisioning
service sends a contact-me message to the phone. The phone responds to this request, and
afterwards transmits a basic set of configuration items to the provisioning service. Now, the pro-
visioning service sends a list of configuration items that have to be changed. In its answer, the
phone confirms the action. In order to make sure that the desired changes have been made,
the provisioning service requests those configuration items that should have been rewritten.
The phone sends back the modified Items. Finally, the provisioning service terminates the in-
teraction with a clean-up message.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-20
c03.fm

Basic Communication Procedures

Basic Message Flow

Phone Provisioning
Service
HTTP Request
Contact-me message
(HTML)
HTTP Response
Acknowledged (HTML)

HTTPS Request
Basic configuration items

HTTPS Response
Provisioning service
sends configuration items
which shall be changed
HTTPS Request
Phone accepts the modifi-
cation request
HTTPS Response
Provisioning service re-
quests the changed con-
figuration items from the
phone
HTTPS Request:
Phone sends the configu-
ration items that have
been changed
HTTS Response
Clean-up message tells
the phone that the interac-
tion is finished

A31003-S2000-R102-6-7620 26. August 2010

3-21 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Basic Message Flow

3.1.2.2 Provisioning Service Located Behind A Firewall

When the provisioning service is located behind a firewall, or in a DMZ, it may have no possi-
bility to send a contact-me message to the phone. To enable provisioning service driven inter-
actions despite this limitation, the phone can be configured so that it periodically polls the pro-
visioning service, or a special proxy, for new messages. The procedure is as follows:
1. On startup, the phone receives the address and port of the provisioning service from the
DHCP server.
2. During the startup procedure, the phone contacts the provisioning service (see Section
3.5.1, "An Exemplary Startup Interaction").
3. The provisioning service instructs the phone to poll the provisioning service, or a proxy,
along with the target URL for the polling messages, and the polling interval (see Section
5.1, "Provisioning Service Related").
4. From now on, the phone will periodically poll the provisioning service, or proxy, according
to the configured polling interval.
In the following message flow, the phone polls the provisioning service or proxy, and the pro-
visioning service resp. proxy has no new message for the phone:

Phone Provisioning
Service /
proxy
HTTP Request
Polling the provisioning
service or proxy
HTTP Response
Status=200 OK

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-22
c03.fm

Basic Communication Procedures

Basic Message Flow

In this message flow, the phone polls the provisioning service or proxy, and the provisioning
service resp. proxy has a new message for the phone:

Phone Provisioning
Service /
proxy
HTTP Request
Polls the provisioning ser-
vice or proxy for new mes-
sages
HTTP Response
Status=202 Accepted

HTTP Request
Reason for contact:
solicited
<Basic configuration
items>
HTTPS Response
Provisioning service
sends configuration items
which shall be changed
HTTPS Request
Phone accepts the modifi-
cation request
HTTS Response
Clean-up message tells
the phone that the interac-
tion is finished

A31003-S2000-R102-6-7620 26. August 2010

3-23 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Configuration Data

3.2 Configuration Data

Configuration and control data is communicated in configuration items, which act as containers
for the parameters proper. Most of the simpler configuration items are defined by the name at-
tribute and the content of the element.
The attributes name and index are used in messages sent by the phone, and in messages
sent by the provisioning service. The status attribute only exists in responses from the phone.
The item element can have the following attributes:

Attribute Value Description

name Enumerated: Tag Identifier for the configuration item. However, more
(mandatory) name than one item element may appear within one mes-
sage (See index underneath).
index Number Enables multiple instances of one configuration item.
(optional) It represents the sequential number of a particular
configuration item instance.
type String An arbitrary value may be assiociated with the con-
(optional) figuration item. Currently, this attribute is not used.
status failed The phone did not accept the value of this configura-
(optional) tion item. In current software versions, this value
might also appear when a configuration item does
not apply.
unknown item A configuration item with this name is not known.
read only The value of the configuration item cannot be modi-
fied.
invalid index The index of this configuration item is out of the range
or does not make sense in this context.
unexpected item This configuration item was not expected by the
phone, or within this context.
not supported This configuration item is not implemented yet on
phone side.
invalid data The phone does not accept the value of this configu-
ration item.
undefined status Some other problem has occured.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-24
c03.fm

Basic Communication Procedures

Phone Message Structure

Examples
<Item name="e164">3290</Item> - call number (extension) of the phone
<Item name="device-type">OpenStage 60</Item> - type of phone
<Item index="1" name="ldap-server-address">ldap.mycompany.com</Item> -
DNS name (or IP address) of the first LDAP server to be queried
<Item name="reg-addr">192.168.1.117</Item> - IP address of the SIP server
(registrar) at which the phone is registered or shall be registrated

3.3 Phone Message Structure

3.3.1 Initial Message From the Phone

When the phone initiates an interaction with the provisioning service, it will include at least the
following configuration items in its message:

Configuration item Description

contact-me-uri The provisioning service must send its contact-me messages to this
fully qualified URI in order to start an interaction with the phone.
mac-addr Contains the phone’s MAC address, which is eligible as a unique
identifier for the phone.
e164 This is the subscriber number. It can be used as additional or alterna-
tive identifier in case an identification by the mac-addr alone should
fail.
The e164 configuration item can be rewritten by the provisioning ser-
vice. If so, the new value will be used by the phone for subsequent
interactions.
Table 3-1

3.3.2 Root Element

The root element of any message from the phone to the provisioning service is
WorkpointMessage. For the corresponding XML schema, please refer to Section 3.5.1.2,
"XML Data Exchange".

A31003-S2000-R102-6-7620 26. August 2010

3-25 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Phone Message Structure

3.3.3 Message Element

The root element contains another container element, Message. It has a mandatory attribute
named nonce; its task is to prevent replay attacks. Any reply by the provisioning service con-
tains this attribute. With the optional attribute maxItems, the phone can define the maximum
number of configuration items allowed in one single message document from the provisioning
service. If the reply shold require a greater number of configuration items, it must be fragment-
ed (see Section 3.8, "Message Fragmentation").

3.3.4 Reason for Contact

The ReasonForContact element indicates the motivation for sending the message to the
provisioning service. See the following table for possible values:

Content Value Description

start-up On each startup or reset, the phone sends a message to the pro-
visioning service with reason set to this value. This can be viewed
as a registration with the provisioning service.
local-changes Some configuration changes have been made locally, that is, by
the local phone menu or by the phone’s web interface.
inventory-changes Some inventory configuration items have changed, due to a new
side-car or adaptor that has been connected.
status The phone communicates the status of a file transfer initiated ear-
lier on behalf of the provisioning service.
solicited The phone has received a contact-me message from the provi-
sioning service and is calling back for further actions.
reply-to This message is a reply to a particular message from the provision-
ing service. As it is part of a complex interaction between phone
and provisioning service, it is recommended to establish an HTTP
session by using cookies. If so, OpenStage phones will present a
valid session-cookie along with this message.
Further specifications can be given via the attributes action and
status, and, if applicable, via fragment (see next table).
clean-up If the phone recognizes any problem, either due to its internal state
or due to a corrupted reply from the provisioning service, it will end
the interaction deliberately by sending this value.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-26
c03.fm

Basic Communication Procedures

Phone Message Structure

Furthermore, the ReasonForContact element has additional attributes, which are relevant if
the reason is reply-to:

Attribute Value Description

action action name Contains the action name of the message from the
provisioning service to which this message is a reply.
status accepted The action in question is accepted.
failed The action is not accepted or is unsupported.
busy The phone is busy and therefore cannot accept the
action.
fragment next This attribute is needed only if the list of configuration
items has to be fractioned because of its length. If
one or more message containing further fragments is
expected, this value is used.
final If the list of configuration items is fractioned, and the
current message contains the last fragment, this val-
ue is used.

For examples, see Section 3.5.1.2, "XML Data Exchange"and Section 3.5.2.2, "XML Data Ex-
change".

A31003-S2000-R102-6-7620 26. August 2010

3-27 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Message Structure

3.4 Provisioning Service Message Structure

3.4.1 Initiation
Before issuing XML messages to the phone, the provisioning service must announce to the
phone that it desires an interaction with it. For details, see Section 1.4.4.2, "Contact-me Mes-
sages".

In case a firewall/DMZ should prevent the provisioning service from initiating an in-
> teraction with the phone, please refer to Section 3.1.2.2, "Provisioning Service Lo-
cated Behind A Firewall".

The character encoding of the XML data sent to the phone should be UTF-8 in order
> to allow for special characters, such as german umlaut.

3.4.2 Action Type

Any message from the provisioning service must contain the Action element. It determines the
activity the phone should perform on behalf of the provisioning service. The possible actions
are listed in the following table:

Content Value Description

ReadAllItems The phone will deliver its whole set of configuration items. Howev-
er, this does not include certificates.
WriteItems The phone is requested to modify its current settings for those con-
figuration items contained in the message.
ReadItems The provisioning service asks the phone to deliver the values of a
certain subset of configuration items.
Restart The provisioning service asks the phone to restart.
FileDeployment The phone is requested to download a file from a FTP or HTTPS
server denoted by the configuration items contained in the mes-
sage.
SoftwareDeployment The phone is requested to download a firmware image from a FTP
or HTTPS Server denoted by the configuration items contained in
the message.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-28
c03.fm

Basic Communication Procedures

Provisioning Service Message Structure

Content Value Description

CleanUp In complex interactions, this is the final message indicating the ter-
mination of the whole interaction cycle. It indicates to the phone
that the TLS connection can be cleared. The HTTPS session will
also be closed.
GetNextFragment In case the phone indicates that the current message contains only
a fraction of the configuration items requested, the provisioning
service uses this action to request the next fragment .

A31003-S2000-R102-6-7620 26. August 2010

3-29 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Phone Driven Interactions

3.5 Phone Driven Interactions

Three different kinds of activities intiated by phones can be distinguished:
1. Register with the provisioning service after startup, either initial startup, subsequent resets
or a factory reset.
2. Inform the provisioning service about local configuration changes, even in case of a factory
reset.
3. Inform the provisioning service about the status of a software or file deployment.

3.5.1 An Exemplary Startup Interaction

3.5.1.1 Message Flow

On startup, the phone informs the provisioning service about its existence. The following dia-
gram shows an example message flow which might occur on phone startup:

Phone Provisioning Service

1 HTTPS Request
Reason for contact: start-up
<Basic configuration items>
2 HTTPS Response
Action: ReadAllItems

3 HTTPS Request
Reason for contact: reply-to
<All configuration items>
4 HTTPS Response
Clean-up

A new message flow starts as soon as a new connection to the provisioning service
> is established.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-30
c03.fm

Basic Communication Procedures

Phone Driven Interactions

3.5.1.2 XML Data Exchange

1. At startup, the phone sends a set of data to the provisioning service. See the following ex-
ample:
<WorkpointMessage
xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="ab15234de14f15a667c6f8d">
<ReasonForContact>start-up</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 60</Item>
<Item name="related-device-type">OpenStage 60</Item>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="contact-me-uri">
http://192.168.3.33:8085/contact_dls.html/ContactDLS
</Item>
<Item name="mac-addr">00:01:E3:00:A9:F3</Item>
<Item name="configuration-changed-flag">false</Item>
<Item name="part-number">S30817-S7403-A101-015</Item>
<Item name="sip-mobility-state">0</Item>
<Item name="e164">3290</Item>
<Item name="user-pwd">123456</Item>
<Item status="failed" name="user-pwd-unicode"/>
<Item name="basic-e164">3290</Item>
<Item name="mobility-enabled">false</Item>
</ItemList>
</Message>
</WorkpointMessage>

A31003-S2000-R102-6-7620 26. August 2010

3-31 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Phone Driven Interactions

2. When the provisioning service has received the message from the phone, it sends an ap-
propriate response, including the nonce value received by the phone, and a session
cookie. The nonce value will be the same for all subsequent messages within this message
flow. In this response, the provisioning service may request all configuration items from the
phone in order to gain comprehensive knowledge about its settings. However, if the phone
is already known to the provisioning service, it will be sufficient to look at the
configuration-changed-flag configuration item. By setting it to false, the phone
indicates that the configuration is still the same as with the last data exchange. See the
following example:
<DLSMessage
xsi:schemaLocation="http://mydomain/provisioning"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://mydomain/provisioning">
<Message nonce="ab15234de14f15a667c6f8d">
<Action>ReadAllItems</Action>
</Message>
</DLSMessage>
3. Next, the phone sends the desired data. Note the content of ReasonForContact and the
action attribute:
<WorkpointMessage
xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="ab15234de14f15a667c6f8d">
<ReasonForContact action="ReadAllItems"
status="accepted">reply-to
</ReasonForContact>
<ItemList>
<Item name="...">...</Item>
<Item name="...">...</Item>
...
</ItemList>
</Message>
</WorkpointMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-32
c03.fm

Basic Communication Procedures

Phone Driven Interactions

4. The interaction, as well as the HTTPS session, is closed by the provisioning service, which
is sending a clean-up message:
<DLSMessage
xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="ab15234de14f15a667c6f8d">
<Action>CleanUp</Action>
</Message>
</DLSMessage>

3.5.1.3 Configuration Items Sent On Startup

The following table describes the configuration items typically sent by an OpenStage SIP
phone on startup:
Item Name Values Description
device-type OpenStage 20E Phone variant. This value is displayed in
OpenStage 20 the banner of the web interface.
OpenStage 40
OpenStage 60
OpenStage 80
related-device-type OpenStage 20E Phone variant. This represents the hard-
OpenStage 20 ware type.
OpenStage 40
OpenStage 60
OpenStage 80
software-type Siemens SIP Firmware type used by the phone. For
OpenStage SIP phones, this value is as
indicated here.
related-software- Siemens SIP Firmware type used by the phone. For
type OpenStage SIP phones, this value is as
indicated here.
contact-me-uri String This is the URI to be used by the provi-
Max. 255 characters sioning service in order to send messages
to the phone. It is based on the phone’s IP
address.
mac-addr MAC address The unique MAC address of the phone
can be used as an identifier for the device.

A31003-S2000-R102-6-7620 26. August 2010

3-33 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Phone Driven Interactions

Item Name Values Description

configuration- true Indicates whether any configuration pa-
changed-flag false rameter has been changed since the last
data exchange between phone and provi-
sioning service. If set to true, the provi-
sioning service should update its data-
base.
part-number String Part number of the phone.
Max. 25 characters Example: S30817-S7403-A103.
e164 String The actual E.164 number of the phone.
Max. 64 characters
user-pwd String Password for access to the phone’s user
6 -24 ASCII charac- menu via local menu or WBM.
ters

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-34
c03.fm

Basic Communication Procedures

Phone Driven Interactions

3.5.2 Local Changes in the Phone’s Configuration

A short while after the user or administrator has changed the configuration, the phone will send
an appropriate message to the provisioning service in order to keep it up-to-date. Accordingly,
the ReasonForContact is now set to local-changes.

3.5.2.1 Message Flow

Phone Provisioning Service

1 HTTPS Request
Reason for contact: local-changes

2 HTTPS Response
Action: ReadAllItems

3 HTTPS Request
Reason for contact: reply-to
<All configuration items>
4 HTTPS Response
Clean-up

A31003-S2000-R102-6-7620 26. August 2010

3-35 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Phone Driven Interactions

3.5.2.2 XML Data Exchange

1. The following example shows XML data sent from a phone to the provisioning service after
a local configuration change. Note the value of configuration-changed-flag:
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message maxItems="-1"
nonce="BD9438C65D42D90F566E2D03D6083602">
<ReasonForContact>local-changes</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 60</Item>
<Item name="related-device-type">OpenStage 60</Item>
<Item status="failed" name="gigabit-ethernet"/>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="software-version">V1 R4.9.0</Item>
<Item name="related-software-version">V1 R4.9.0</Item>
<Item name="contact-me-uri">
http://192.168.1.4:8085/contact_dls.html/ContactDLS
</Item>
<Item name="mac-addr">00:01:E3:25:EA:13</Item>
<Item name="configuration-changed-flag">true</Item>
<Item name="part-number">S30817-S7403-A101-015</Item>
<Item name="sip-mobility-state">0</Item>
<Item name="e164">3290</Item>
<Item name="user-pwd">123456</Item>
<Item status="failed" name="user-pwd-unicode"/>
<Item name="basic-e164">3290</Item>
<Item name="mobility-enabled">false</Item>
</ItemList>
</Message>
</WorkpointMessage>
2. The rest of the interaction is analogical to the startup case, as described in Section 3.5.1,
"An Exemplary Startup Interaction".

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-36
c03.fm

Basic Communication Procedures

Phone Driven Interactions

3.5.3 Announce Deployment Status

When the provisioning service has initiated a software deployment action, the phone may com-
municate information about the status of this process.

3.5.3.1 Message Flow

The message flow is simple:

Phone Provisioning Service

1 HTTPS Request
Reason for contact: status
<Modified configuration items including
status>
2 HTTPS Response
Clean-up

A31003-S2000-R102-6-7620 26. August 2010

3-37 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6 Provisioning Service Driven Interaction

To initiate an interaction with the phone, the provisioning service must send an HTML-based
contact-me message to the phone’s contact-me URI. In turn the phone will send a response
with solicited as a ReasonForContact. For the corresponding XML schema, please refer
to Section 3.6.3.2, "XML Data Exchange".

3.6.1 Start an Interaction: Contact-me

The main purpose of the contact-me message is to allow the phone to decide when to send a
response. If the provisioning service is acting as a web server, this initial message is required,
as the service must be contacted by the the phone, which acts as a web client. For details about
the structure of a contact-me message, see Section 1.4.4.2, "Contact-me Messages".
If the phones and the provisioning service reside in different networks or subnets, which are
separated by a firewall and/or NAT, it may be impossible for the provisioning service to send a
contact-me message. To solve this problem, the phone can be configured so that it periodically
polls the provisioning service, or a special proxy, for new messages. For further information,
please refer to Section 1.4.4.3, "Polling Request To Bridge A Firewall" and Section 3.1.2.2,
"Provisioning Service Located Behind A Firewall".

3.6.2 End an Interaction: Clean-up

An interaction is terminated when the phone receives a clean-up message from the provision-
ing service. Together with the clean-up message, the provisioning service should also invali-
date the HTTPS session. See the following example:
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="9A6439F4E323CDB19283E40459828B56">
<Action>CleanUp</Action>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-38
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

3.6.3 Read Phone Settings

Besides the ReadAllItems option, it is also possible to request a particular set of configuration
items from the phone. For this purpose, the provisioning service sends a message with Action
set to ReadItems.

3.6.3.1 Message Flow

Phone Provisioning Service

1 HTTP Request
Contact-me (HTML)

2 HTTP Response
Acknowledged (HTML)

3 HTTPS Request
Reason for contact: solicited
<Basic configuration items>
4 HTTPS Response
Action: ReadItems
<configuration items to read>
5 HTTPS Request
Reason for contact: reply-to
<Requested configuration items>
6 HTTPS Response
Clean-up

A31003-S2000-R102-6-7620 26. August 2010

3-39 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.3.2 XML Data Exchange

To specify the desired configuration items, the provisioning service must send a list with the
corresponding item names.
As the other elements of the message flow are already described in Section 3.4.1, "Initiation",
only the relevant sections (step 4 and 5) are illustrated by examples.
4. The provisioning service sends a list of the desired configuration items.
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="2253A404241C11D774122654989181BC">
<Action>ReadItems</Action>
<ItemList>
<Item name="device-type"/>
<Item name="related-device-type"/>
<Item name="software-type"/>
<Item name="software-version"/>
<Item name="contact-me-uri"/>
<Item name="mac-addr"/>
<Item name="e164"/>
<Item name="ipaddress"/>
<Item name="reg-addr"/>
<Item name="reg-port"/>
<Item name="reg-ttl"/>
<Item name="register-by-name"/>
<Item name="registrar-addr"/>
<Item name="registrar-port"/>
<Item name="rtp-base-port"/>
<Item name="server-type"/>
</ItemList>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-40
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

5. The response from the phone returns the requested configuration items.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message fragment="final" maxItems="-1"
nonce="EB2C4CDF45D86E548CCD6F6612B26112">
<ReasonForContact status="accepted" action="ReadItems">
reply-to
</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 60</Item>
<Item name="related-device-type">OpenStage 60</Item>
<Item name="software-type">Siemens SIP</Item>
<Item name="software-version">V1 R4.7.0</Item>
<Item name="contact-me-uri">http://192.168.1.4:8085/
contact_dls.html/ContactDLS</Item>
<Item name="mac-addr">00:01:E3:25:EA:13</Item>
<Item name="e164">3290</Item>
<Item name="ipaddress">192.168.1.4</Item>
<Item name="reg-addr">192.168.1.117</Item>
<Item name="reg-port">5060</Item>
<Item name="reg-ttl">3600</Item>
<Item name="register-by-name">false</Item>
<Item name="registrar-addr">192.168.1.117</Item>
<Item name="registrar-port">5060</Item>
<Item name="rtp-base-port">5010</Item>
<Item name="server-type">0</Item>
</ItemList>
</Message>
</WorkpointMessage>
6. The provisioning service sends a clean-up message.

A31003-S2000-R102-6-7620 26. August 2010

3-41 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.4 Modify Phone Settings

To modify settings on the phone, that is, to write configuration items to the phone, the provi-
sioning service sends a message with Action set to WriteItems. The configuration items in
question are sent to the phone in a similar fashion as described for reading configuration items
(see Section 3.6.3.2, "XML Data Exchange"), but this time, of course, the desired values are
given.

3.6.4.1 Message Flow

Please note that step 6 and 7 are optional.

Phone Provisioning Service

1 HTTP Request
Contact-me (HTML)

2 HTTP Response
Acknowlegded (HTML)

3 HTTPS Request:
Reason for contact: solicited
<Basic configuration items>
4 HTTPS Response
Action: WriteItems
<configuration items to write>
5 HTTPS Request
Reason for contact: reply-to
Status: Accepted
6 HTTPS Response
Action: ReadItems
<configuration items to read (with-
out values)>
7 HTTPS Request
Reason for contact: reply-to
<configuration items from the
ReadItems list with current val-
ues>
8 HTTPS Response
Clean-up

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-42
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

3.6.4.2 XML Data Exchange

As steps 1-3 are described already in Section 3.6.3, "Read Phone Settings", only the subse-
quent steps are demonstrated here.
4. The provisioning service sends a list of the desired configuration items.
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="58D4EE11C844865CAF0E9AA11ED2856F">
<Action>WriteItems</Action>
<ItemList>
<Item name="sntp-tz-offset">60</Item>
<Item name="auto-daylight-save">true</Item>
<Item name="sntp-addr">time.nist.gov</Item>
<Item name="daylight-save">true</Item>
<Item name="daylight-save-zone-id">9</Item>
</ItemList>
</Message>
</DLSMessage>
5. In its reply, the phone confirms that the action has been accepted.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message fragment="final" maxItems="-1"
nonce="0A8D39A3253E92715EFA5F5F63C25FFB">
<ReasonForContact status="accepted" action="WriteItems">
reply-to
</ReasonForContact>
<ItemList/>
</Message>
</WorkpointMessage>

A31003-S2000-R102-6-7620 26. August 2010

3-43 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

6. The provisioning service requests the configuration items to be modified in order to check
whether they have been set correctly.
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="0A8D39A3253E92715EFA5F5F63C25FFB">
<Action>ReadItems</Action>
<ItemList>
<Item name="daylight-save"/>
<Item name="auto-daylight-save"/>
<Item name="sntp-addr"/>
<Item name="daylight-save-zone-id"/>
<Item name="sntp-tz-offset"/>
</ItemList>
</Message>
</DLSMessage>
7. The phone sends the updated configuration items.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message fragment="final" maxItems="-1"
nonce="9A6439F4E323CDB19283E40459828B56">
<ReasonForContact status="accepted" action="ReadItems">
reply-to
</ReasonForContact>
<ItemList>
<Item name="daylight-save">true</Item>
<Item name="auto-daylight-save">true</Item>
<Item name="daylight-save-zone-id">9</Item>
<Item name="sntp-addr">time.nist.gov</Item>
<Item name="sntp-tz-offset">60</Item>
</ItemList>
</Message>
</WorkpointMessage>
8. The provisioning service sends a clean-up message.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-44
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

3.6.5 Restart Phone

OpenStage phones can be rebooted via the provisioning interface.

3.6.5.1 Message Flow

Phone Provisioning Service

1 HTTP Request
Contact-me (HTML)

2 HTTP Response
Acknowledged (HTML)

3 HTTPS Request
Reason for contact: solicited
<Basic configuration items>
4 HTTPS Response
Restart

A31003-S2000-R102-6-7620 26. August 2010

3-45 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.5.2 XML Data Exchange

As the other elements of the message flow are already described in Section 3.6.3, "Read
Phone Settings", only the relevant section (step 4) is illustrated by an example.
<DLSMessage
xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="ab15234de14f15a667c6f8d">
<Action>Restart</Action>
</Message>
</DLSMessage>

3.6.6 Factory Reset

The factory reset, that is, the complete recovery of the delivery status, can be triggered by the
provisioning service. This includes a phone reboot.
As this is a variant of the phone restart, the message flow is as described in Section 3.4.5, "Re-
start Phone".
Two additional parameters are needed to initiate a factory reset:
• restart-password: For executing a factory reset, OpenStage phones require a special
password, whatever interface is used. The value is 124816.
• restart-type: For a factory reset, this must be set to FactoryReset.

3.6.6.1 XML Data Exchange

The additional parameters indicating the factory reset are transmitted as configuration items:
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="7D49388DE3E95AE2450BD64FEB8A2079">
<Action>Restart</Action>
<ItemList>
<Item name="restart-password">124816</Item>
<Item name="restart-type">FactoryReset</Item>
</ItemList>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-46
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

3.6.7 File Provisioning

The provisioning interface allows for deploying all kinds of files supported by the phone in ques-
tion, such as ringtones, music on hold, or LDAP templates.
While the provisioning service initiates the transfer of files to the phone, the phone obtains the
data from an FTP server or an HTTPS server. The necessary access parameters for the file
server are provided by the provisioning service.
Unlike the phone’s web interface, the provisioning interface also enables deploying more than
one file at the same time.

3.6.7.1 Message Flow

Phone Provisioning Service

1 HTTP Request
Contact-me(HTML)

2 HTTP Response
Acknowledged (HTML)

3 HTTPS Request
Reason for contact: solicited
<Basic configuration items>
4 HTTPS Response
Action: FileDeployment
<File configuration items>
5 HTTPS Request
Reason for contact: status
<Basic configuration items + File
configuration items>
6 HTTPS Response
Clean-up

A31003-S2000-R102-6-7620 26. August 2010

3-47 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.7.2 XML Data Exchange For Single File Deployment

As the other elements of the message flow are already described in Section 3.6.3, "Read
Phone Settings", only the relevant sections (step 4 and 5) are illustrated by an example.
4. In the following example, the phone is provided with a new ringtone, which is available as
.wav file. The file is residing on an FTP server:
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="93D295F38327460697324D39D9824FDB">
<Action>FileDeployment</Action>
<ItemList>
<Item name="file-server">192.168.1.150</Item>
<Item name="file-pwd">dlsftp5</Item>
<Item name="file-path">/media</Item>
<Item name="file-name">ringtone-phone.wav</Item>
<Item name="file-type">RINGTONE</Item>
<Item name="file-username">dls</Item>
<Item name="file-port">21</Item>
</ItemList>
</Message>
</DLSMessage>
In the second example, the ringtone is residing on an HTTPS server:
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="93D295F38327460697324D39D9824FDB">
<Action>FileDeployment</Action>
<ItemList>
<Item name="file-type">RINGTONE</Item>
<Item name="file-username">dls</Item>
<Item name="file-https-base-url">
https://192.168.1.150/media/ringtone-phone.wav
</Item>
</ItemList>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-48
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

5. The response from the phone may look like the following:
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message maxItems="-1"
nonce="4F6A1034A46B463F8D008DA09314040A">
<ReasonForContact>status</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 60</Item>
<Item name="related-device-type">OpenStage 60</Item>
<Item status="failed" name="gigabit-ethernet"/>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="software-version">V1 R4.9.0</Item>
<Item name="related-software-version">V1 R4.9.0</Item>
<Item name="contact-me-uri">
http://192.168.1.4:8085/contact_dls.html/ContactDLS
</Item>
<Item name="mac-addr">00:01:E3:25:EA:13</Item>
<Item name="configuration-changed-flag">false</Item>
<Item name="part-number">S30817-S7403-A101-015</Item
<Item name="sip-mobility-state">0</Item>
<Item name="e164">3290</Item>
<Item name="user-pwd">123456</Item>
<Item status="failed" name="user-pwd-unicode"/>
<Item name="basic-e164">3290</Item>
<Item name="mobility-enabled">false</Item>
<Item name="file-deployment-date">10:06:2008</Item>
<Item name="file-deployment-time">15:35:52</Item>
<Item name="file-deployment-name">
ringtone-phone.wav
</Item>
<Item name="file-deployment-type">RINGTONE</Item>
<Item name="file-deployment-status">ok</Item>
</ItemList>
</Message>
</WorkpointMessage>

A31003-S2000-R102-6-7620 26. August 2010

3-49 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.7.3 XML Data Exchange For Multiple File Deployment

With multiple file deployment, the message exchange is similar to single file deployment, but
the configuration items are indexed. These indexed configuration items enable deploying a set
of files of various types with a singular message. Additionally, it is possible to delete files on the
phone. A single action can include both deployment and deletion commands. A specific file and
the action to be executed with it (file-action) are assigned to each other by a common in-
dex number.
The selective deletion of files is possible because the combination of file-name and file-
type is unique on the phone.
As the phone will not send status information on multiple file deployment or file deletion, the
provisioning server should check the result by requesting a ReadAllItems.
The following example shows a multiple file deployment request; in the message flow, it corre-
sponds to the XML message described in Section 3.6.7.2, "XML Data Exchange For Single File
Deployment".
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="E5BFC5E2FBCE6CD3D20DC9AD975C0355">
<Action>FileDeployment</Action>
<ItemList>
<Item name="file-server" index="1">192.168.1.150</Item>
<Item name="file-path" index="1">/media/</Item>
<Item name="file-name" index="1">
Logo for OpenStage 80.png
</Item>
<Item name="file-type" index="1">LOGO</Item>
<Item name="file-pwd" index="1">dlsftp5</Item>
<Item name="file-port" index="1">21</Item>
<Item name="file-username" index="1">dls</Item>
<Item name="file-action" index="1">deploy</Item>
<Item name="file-server" index="2">192.168.1.150</Item>
<Item name="file-path" index="2">/media/</Item>
<Item name="file-name" index="2">ringtone-ringin.wav</Item>
<Item name="file-type" index="2">RINGTONE</Item>
<Item name="file-pwd" index="2">dlsftp5</Item>
<Item name="file-port" index="2">21</Item>
<Item name="file-username" index="2">dls</Item>
<Item name="file-action" index="2">deploy</Item>
</ItemList>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-50
c03.fm

Basic Communication Procedures

Provisioning Service Driven Interaction

3.6.8 Firmware Deployment

The deployment of firmware for the phone is very similar to the regular file deployment, as de-
scribed in Section 3.6.7, "File Provisioning". The type of Action is different, the configuration
item name file-sw-type is used instead of file-type, and the configuration items file-
sw-version and file-priority are added.

If a call is in progress and the file-priority has not been set to immediate,
> the deployment will be rejected.

When the phone has received the software file, it will reboot, thereby loading the new software.
Like with every startup, the phone will send a startup message (see Section 3.5.1, "An Exem-
plary Startup Interaction"). By issuing a ReadItems or ReadAllItems message, the provi-
sioning service can determine whether the phone has the intended software version now.

3.6.8.1 Message Flow

Phone Provisioning Service

1 HTTP Request
Contact-me (HTML)

2 HTTP Response
Acknowledged (HTML)

3 HTTPS Request:
Reason for contact: solicited
<Basic configuration items>
4 HTTPS Response:
Action: SoftwareDeployment
<Software configuration items>

A31003-S2000-R102-6-7620 26. August 2010

3-51 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Provisioning Service Driven Interaction

3.6.8.2 XML Data Exchange

As the other elements of the message flow are already described in Section 3.6.3, "Read
Phone Settings", only the relevant section (step 4) is illustrated by an example. In the example,
FTP is used; it can also be done by HTTPS.
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="BDB60C70FE707FD023E09F0A9363DD8D">
<Action>SoftwareDeployment</Action>
<ItemList>
<Item name="file-server">192.168.1.150</Item>
<Item name="file-pwd">dlsftp5</Item>
<Item name="file-path">/OS/SIP/HI</Item>
<Item name="file-name">OS_80_SIP_V1_R4_9_0.img</Item>
<Item name="file-type">APP</Item>
<Item name="file-username">dls</Item>
<Item name="file-port">21</Item>
<Item name="file-sw-type">Siemens SIP</Item>
<Item name="file-sw-version">1.4.9.0</Item>
<Item name="file-priority">normal</Item>
</ItemList>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-52
c03.fm

Basic Communication Procedures

Message Fragmentation

3.7 Message Fragmentation

Messages are limited to a length of 50 kB. Larger messages will be split into fragments. On the
phone side, the threshold is defined by the maxItems attribute of the Message element. When
the number of configuration items to be contained in a message exceeds the number given
here, or the message reaches the 50 kB limit, the message is split up. Alternatively, the provi-
sioning service can decide to construct a message as multiple messages.

3.7.1 Fragmentation of Phone Messages

3.7.1.1 Message Flow

In the following message flow example, the phone sends data which is divided into 3 fractions.
Please note that this is not a full interaction, but only the relevant section of an interaction that
could have been driven both by the phone or by the provisioning service.

Phone Provisioning Service

1 HTTPS Request
Reason for contact: reply-to
fragment: next
2 HTTPS Response
Action: GetNextFragment

3 HTTPS Request
Reason for contact: reply-to
fragment: next
4 HTTPS Response
Action: GetNextFragment

5 HTTPS Request
Reason for contact: reply-to
fragment: final
6 HTTPS Response
Clean-up

A31003-S2000-R102-6-7620 26. August 2010

3-53 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Message Fragmentation

3.7.1.2 XML Data Exchange

Step 1 and 2 of the example interaction are presented here.
1. The phone sends its first fragment. The ItemList provided in the example is not real-life,
as it represents a very long list.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message maxItems="-1" nonce="B0151B36FE9CEEA0F667FF3A208AC994"
fragment="next">
<ReasonForContact action="ReadItems" status="accepted">
reply-to
</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 60</Item>
<Item name="related-device-type">OpenStage 60</Item>
...
</ItemList>
</Message>
</WorkpointMessage>
2. The provisioning service requests the next fraction of data from the phone.
<DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="B0151B36FE9CEEA0F667FF3A208AC994">
<Action>GetNextFragment</Action>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-54
c03.fm

Basic Communication Procedures

Message Fragmentation

3.7.2 Fragmentation of Provisioning Service Messages

3.7.2.1 Message Flow

In the following message flow example, the provisioning service sends data which is divided up
in 2 fractions. Please note that this is not a full interaction, but only the relevant section of an
interaction driven by the provisioning service.

All related configuration items must be sent in a single message.

>
Phone Provisioning Service
1 HTTPS Request
Reason for contact: solicited

2 HTTPS Response
Action: WriteItems
<configuration items to write>
3 HTTPS Request
Reason for contact: reply-to

4 HTTPS Response
Action: WriteItems
<configuration items to write>
5 HTTPS Request
Reason for contact: reply-to

6 HTTPS Response
Clean-up

3.7.2.2 XML Data Exchange

The XML messages in a fragmented message flow from the provisioning service have the
same structure as regular messages for phone configuration. For details, see Section 3.6.4,
"Modify Phone Settings".

A31003-S2000-R102-6-7620 26. August 2010

3-55 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Error Handling

3.8 Error Handling

In case the provisioning service should send erroneous write actions, the phone will answer
with appropriate error messages.
In this section, the error-handling by the phone is illustrated by three interaction examples.
Please note that the sequences of messages shown here start with the phone sending a mes-
sage to the provisioning service with ReasonForContact set to solicited. The contact-me
message from the provisioning server is omitted for brevity.

3.8.1 Example 1: Configuration Item Is Unknown At Phone

1. The phone initiates a connection to the provisioning service.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="104EBC8C863E0C5CA384D4D924C4B220"
maxItems="-1">
<ReasonForContact>solicited</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 80</Item>
<Item name="related-device-type">OpenStage 80</Item>
<Item status="failed" name="gigabit-ethernet"></Item>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="software-version">V1 R5.6.53</Item>
<Item name="related-software-version">V1 R5.6.53</Item>
<Item name="contact-me-uri">
http://192.168.233.195:8085/contact_dls.html/ContactDLS</Item>
<Item name="mac-addr">00:01:E3:25:E1:CB</Item>
<Item name="configuration-changed-flag">false</Item>
<Item name="part-number">Unknown</Item>
<Item name="sip-mobility-state">1</Item>
<Item name="e164">5419431261</Item>
<Item name="user-pwd">111111</Item>
<Item status="failed" name="user-pwd-unicode"></Item>
<Item name="basic-e164">5419431261</Item>
<Item name="mobility-enabled">true</Item>
</ItemList>
</Message>
</WorkpointMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-56
c03.fm

Basic Communication Procedures

Error Handling

2. The provisioning service attempts to write a configuration item that is unknown at the
phone.
<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="7FAA6353A4887BBFA14B78370FE99144">
<Action>WriteItems</Action>
<ItemList>
<Item name="socketed-headset-mode">0</Item>

</ItemList>
</Message>
</DLSMessage>
3. The phone responds with a configuration item status indicating the unknown item.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="9DD3EB02AA6A93A00CA63EE07B25ABF3" maxItems="-1"
fragment="final">
<ReasonForContact status="accepted" action="WriteItems">
reply-to</ReasonForContact>
<ItemList>
<Item status="unknown item"
name="socketed-headset-mode"></Item>

</ItemList>
</Message>
</WorkpointMessage>
4. The provisioning service terminates the interaction with a clean-up.
<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="CF8CDC3C82D1FC7966B6318537C6E0F6">
<Action>CleanUp</Action>
</Message>
</DLSMessage>

A31003-S2000-R102-6-7620 26. August 2010

3-57 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Error Handling

3.8.2 Example 2: Items Failed To Be Set At Phone

1. The phone initiates a connection to the provisioning service.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="104EBC8C863E0C5CA384D4D924C4B220"
maxItems="-1">
<ReasonForContact>solicited</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 80</Item>
<Item name="related-device-type">OpenStage 80</Item>
<Item status="failed" name="gigabit-ethernet"></Item>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="software-version">V1 R5.6.53</Item>
<Item name="related-software-version">V1 R5.6.53</Item>
<Item name="contact-me-uri">http://192.168.233.195:8085/
contact_dls.html/ContactDLS</Item>
<Item name="mac-addr">00:01:E3:25:E1:CB</Item>
<Item name="configuration-changed-flag">false</Item>
<Item name="part-number">Unknown</Item>
<Item name="sip-mobility-state">1</Item>
<Item name="e164">5419431261</Item>
<Item name="user-pwd">111111</Item>
<Item status="failed" name="user-pwd-unicode"></Item>
<Item name="basic-e164">5419431261</Item>
<Item name="mobility-enabled">true</Item>
</ItemList>
</Message>
</WorkpointMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-58
c03.fm

Basic Communication Procedures

Error Handling

2. The provisioning service attempts to write several settings.

<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="104EBC8C863E0C5CA384D4D924C4B220">
<Action>WriteItems</Action>
<ItemList>
<Item name="Canonical-dialing-international-prefix">0
</Item>
<Item name="Canonical-dialing-operator-code">0</Item>
<Item
name="Canonical-dialing-emergency-number">999,555</Item>
<Item name="Canonical-dialing-local-country-code">44
</Item>
<Item
name="Canonical-dialing-extension-initial-digits">1</Item>
<Item name="Canonical-dialing-external-access">9</Item>
<Item name="Canonical-dialing-local-node">943</Item>
<Item
name="Canonical-dialing-min-local-number-length">4</Item>
<Item name="Canonical-dialing-local-area-code">541
</Item>
<Item name="Canonical-dialing-national-prefix">0</Item>
<Item index="1"
name="Canonical-lookup-international-code">+44541</Item>
<Item index="1" name="Canonical-lookup-local-code">541</
Item>
<Item index="2"
name="Canonical-lookup-international-code">+44551</Item>
<Item index="2" name="Canonical-lookup-local-code">551
</Item>
<Item index="3"
name="Canonical-lookup-international-code">+44511</Item>
<Item index="3" name="Canonical-lookup-local-code">511
</Item>
<Item index="4" name="Canonical-lookup-international-
code">+44521</Item>
<Item index="4" name="Canonical-lookup-local-code">521
</Item>
<Item index="5"
name="Canonical-lookup-international-code">+44531</Item>
<Item index="5" name="Canonical-lookup-local-code">531
</Item>
<Item index="6"

A31003-S2000-R102-6-7620 26. August 2010

3-59 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Error Handling

name="Canonical-lookup-international-code">+44561</Item>
<Item index="6" name="Canonical-lookup-local-code">561
</Item>
</ItemList>
</Message>
</DLSMessage>
3. The phone responds with item status "failed" for any items it could not save.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="BFBD54B05B45E13F9E7E773F65CE3956" maxItems="-1"
fragment="final">
<ReasonForContact status="accepted" action="WriteItems">
reply-to</ReasonForContact>
<ItemList>
<Item status="failed"
name="Canonical-lookup-international-code" index="6"></Item>
<Item status="failed" name="Canonical-lookup-local-code"
index="6"></Item>
</ItemList>
</Message>
</WorkpointMessage>
4. The provisioning service terminates the interaction with a clean-up.
<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="C528BD461ABF3247D545E8BBF5A6D809">
<Action>CleanUp</Action>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-60
c03.fm

Basic Communication Procedures

Error Handling

3.8.3 Example 3: Configuration Item Is Read Only

1. The phone initiates a connection to the provisioning service.
<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="71E7F7FF699CE4467956071307E7478F"
maxItems="-1">
<ReasonForContact>solicited</ReasonForContact>
<ItemList>
<Item name="device-type">OpenStage 80</Item>
<Item name="related-device-type">OpenStage 80</Item>
<Item status="failed" name="gigabit-ethernet"></Item>
<Item name="software-type">Siemens SIP</Item>
<Item name="related-software-type">Siemens SIP</Item>
<Item name="software-version">V1 R5.6.53</Item>
<Item name="related-software-version">V1 R5.6.53</Item>
<Item name="contact-me-uri">
http://192.168.233.195:8085/contact_dls.html/ContactDLS</Item>
<Item name="mac-addr">00:01:E3:25:E1:CB</Item>
<Item name="configuration-changed-flag">false</Item>
<Item name="part-number">Unknown</Item>
<Item name="sip-mobility-state">1</Item>
<Item name="e164">5419431261</Item>
<Item name="user-pwd">111111</Item>
<Item status="failed" name="user-pwd-unicode"></Item>
<Item name="basic-e164">5419431261</Item>
<Item name="mobility-enabled">true</Item>
</ItemList>
</Message>
</WorkpointMessage>
2. The provisioning service attempts to write a data item that is read-only at the phone.
<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="71E7F7FF699CE4467956071307E7478F">
<Action>WriteItems</Action>
<ItemList>
<Item name="device-type">OpenStage 75</Item>
</ItemList>
</Message>
</DLSMessage>

A31003-S2000-R102-6-7620 26. August 2010

3-61 Asterisk - OpenStage Family, Developer’s Guide
 c03.fm
Basic Communication Procedures
Error Handling

3. The phone responds with item status "read-only".

<WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.siemens.com/DLS">
<Message nonce="930873879B353894AAB792E175847F39" maxItems="-1"
fragment="final">
<ReasonForContact status="accepted" action="WriteItems">
reply-to</ReasonForContact>
<ItemList>
<Item status="read only" name="device-type"></Item>
</ItemList>
</Message>
</WorkpointMessage>
4. Provisioning service terminates interaction with a clean-up.
<DLSMessage xmlns="http://www.siemens.com/DLS"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.siemens.com/DLS">
<Message nonce="34459A26CEBCF29550D72BE0ECB655C3">
<Action>CleanUp</Action>
</Message>
</DLSMessage>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 3-62
c03.fm

Basic Communication Procedures

Tracing and Debugging

3.9 Tracing and Debugging

Besides the error handling capabilities described above, the phone provides detailed tracing
information about the communication between phone and provisioning service. To enable this
functionality via the WBM, proceed as follows:
• Open the WBM in your browser, log in to the "Administor Pages", and navigate to "Diag-
nostics" > "Fault trace configuration".
• Under "Trace levels for components", set the trace level for "DLS client management", e.g.
"DEBUG", and set all other trace levels to "OFF".
• Confirm the changes by clicking "Submit".
• When the processes to be traced are finished, you can view the tracing data by clicking on
the link "Download trace file" under "Diagnostics" > "Fault trace configuration".
The tracing facility can also be configured and controlled by the provisioning service; see Sec-
tion 4.11.1, "Fault trace configuration".

A31003-S2000-R102-6-7620 26. August 2010

3-63 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Applications

4 Phone Parameters - Administration

This section provides a comprehensive survey of the configuration and control parameters in
the administration area. The structure and order in which the data are presented corresponds
to the web interface of the OpenStage phones. Accordingly, each input dialog, or screen, in the
web interface is represented by a parameter table in this section. For example, section Section
4.2.1, "IP configuration" is located under Section 4.2, "Network", which represents the naviga-
tion path "Network > IP configuration" in the web interface.
However, there are parameters which are only accessible via the provisioning service. These
will be added according to the functional area they belong to. Those parameters which are nei-
ther configurable via local/web interface nor associated with parameters configurable via local/
web interface are listed in Section 5, "Phone Parameters - Provisioning".
If not otherwise stated, the Items are available on all phone variants, that is, OpenStage 15/20/
40/60/80.
The syntax for each Item is <Item name="ItemName">Value</Item>.
Example: <Item name="e164">3290</Item>

4.1 Applications

Applications are available for OpenStage 60/80 only.

>
4.1.1 XML applications
The XML interface enables running server-based applications on the phone with a set of GUI
elements. The technologies commonly used in web applications can be used. For more infor-
mation, please refer to the following documentation:
• Administration Manual OpenStage Asterisk, available under
http://wiki.siemens-enterprise.com/index.php/OpenStage_and_Asterisk
• Developer’s Guide XML Applications, available under
http://wiki.siemens-enterprise.com/index.php/OpenStage_XML_Applications
By means of the index attribute, more than one application can be configured at once. The
count starts with 1.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-64
c04.fm

Phone Parameters - Administration

Applications

To determine what to do with an application, that is, create, modify, or delete it, the XML-app-
action item is used. For each indexed application, an individual action can be defined. As the
creation of an application is treated as a modification/update, two values are possible, delete
and update. In the following snippet, the application with the index number 1 is modified, or
created:
<Item name="XML-app-action" index="1">update</Item>
In order to assign the appropriate privileges, the phone must be informed whether the applica-
tion is an Xpressions application or a regular XML application. Xpressions is a special Unified
Communications application which uses the same XML interface as regular XML applications.
The information about the type of application is provided in the XML-app-special-
instance item. In the following snippet, the application with the index number 1 is defined as
a normal application, which is the default value:
<Item name="XML-app-special-instance" index="1">0</Item>

A31003-S2000-R102-6-7620 26. August 2010

4-65 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Applications

4.1.1.1 Add application

For regular (non-Xpressions, nonXMLPhonebook) applications, the XML-app-special-in-
stance item must be set to 0 (see Section 4.1.1, "XML applications").

WBM Name Item name Type Values Description

Display name XML-app- Text. Default: NULL Displayed in the applica-

display-name Max. 20 tions tab once the appli-
<index> charac- cation is configured.
ters
Application name XML-app-name Text. Cannot be empty. Used by the phone soft-
<index> Max. 20 Cannot contain ^ ware to identify the XML
charac- character. Must application running
ters be different to the on the phone.
Display Name as-
signed to other
applications.
Default: NULL
HTTP Server ad- XML-app- IP ad- Cannot be empty. IP address or domain
dress server-addr dress or Default: NULL name of the server which
<index> host- hosts the remote
name. program.
Max. 64
charac-
ters
HTTP Server port XML-app- Integer Port number. Number of the port used
server-port Cannot be empty. by the server to provide
<index> Default: NULL the XML application.
Protocol XML-app- Enumer- 0=HTTP; Communication protocol
transport ation 1=HTTPS; for data exchange with
<index> Default: 0 the server.
Program name XML-app-pro- Text. Cannot be empty. Relative path to the serv-
on server gram-name Max. 100 Default: NULL let or to the first XML page
<index> charac- of the application on
ters the server.
Use proxy XML-app- Boolean true/false Enables or disables the
proxy- Default: false use of a proxy for commu-
enabled nication with the server
<index> hosting the application.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-66
c04.fm

Phone Parameters - Administration

Applications

WBM Name Item name Type Values Description

XML Trace en- XML-app- Boolean true/false Enables or Disables the

abled remote-debug Default: true debugging function. If dis-
<index> abled, the phone will send
specific debug informa-
tion to a specified server.
Debug program XML-app- Text. Default: NULL The relative path to a spe-
on server debug-prog- Max. 100 cial service, or program,
name charac- that receives the debug
<index> ters. information created by
the phone.
Number of tabs XML-app-num- Integer 0-3 Number of internal tabs
tabs<index> Default: 0 for an XML application.
To make an application
with internal tabs work,
one of the application
names (Tab 1...3 Applica-
tion Name) must be the
same as the overall appli-
cation name.
Tab 1 Display XML-app- Text. Default: NULL Name to be displayed on
Name tab1- Max. 20 the first internal tab.
display- charac-
name<index> ters.
Tab 1 Application XML-app- Text. Default: NULL Internal application name
Name tab1- Max. 20 for the first tab, used by
name<index> charac- the phone software.
ters.
Tab 2 Display XML-app- Text. Default: NULL Name to be displayed on
Name tab2- Max. 20 the second internal tab.
display- charac-
name<index> ters.
Tab 2 Application XML-app- Text. Default: NULL Internal application name
Name tab2- Max. 20 for the second tab, used
name<index> charac- by the phone software.
ters.
Tab 3 Display XML-app- Text. Default: NULL Name to be displayed on
Name tab3- Max. 20 the third internal tab.
display- charac-
name<index> ters.

A31003-S2000-R102-6-7620 26. August 2010

4-67 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Applications

WBM Name Item name Type Values Description

Tab 3 Application XML-app- Text. Default: NULL Internal application name

Name tab3- Max. 20 for the third tab, used by
name<index> charac- the phone software.
ters.
Auto restart XML-app- Boolean true/false Indicates whether the ap-
restart Default: false plication is to be
<index> automatically stopped
and restarted in case an-
other application by the
same name is already
running.
XML-app- Enumer- 0=no mode key; Specifies which mode key
control-key ation 2=phonebook shall start the application.
mode key, like The following mode keys
the application can be used to start an
type "XMLPhone- XML application:
book"; u phonebook key
3=call log mode x messages key
key; w call log key
4=messages Available with firmware
mode key, like version V2.
the application
type "Xpres-
sions";
Default: 0
XML-app- Boolean true/false Determines whether the
auto-start application is automati-
cally started in the back-
ground or only when first
selected.
Available with firmware
version V2.
XML-app-all- Boolean true/false Determines whether all
tabs-start tabs of the application or
only the first tab is started
on application startup.
Only meaningful for appli-
cation with 2 or 3 tabs.
Available with firmware
version V2.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-68
c04.fm

Phone Parameters - Administration

Network

4.1.1.2 Modify application

For the provisioning interface, the modification of an application is the same procedure as the
creation. The XML-app-action item must be set to update, as in the following snippet:
<Item name="XML-app-action" index="1">update</Item>

4.1.1.3 Xpressions
For Xpressions applications, the XML-app-special-instance item must be set to 1 (see
Section 4.1.1, "XML applications").

4.1.1.4 XML Phonebook

This is a preconfiguration intended for a regular XML application with phonebook functionality.
When configured on the phone, a press on u will invoke this application, in place of the perso-
nal (local) or corporate (LDAP) phonebook. For Xpressions applications, the XML-app-
special-instance item must be set to 2 (see Section 4.1.1, "XML applications").

4.2 Network

4.2.1 IP configuration

WBM Name Item name Type Values Description

LLDP-MED En- lldp-enabled Boolean true/false If enabled, a VLAN ID and

abled / Disabled Default: false Quality of Service
parameters can be pro-
vided via LLDP-MED.
DHCP Enabled / dhcp Boolean true/false Enable or disable DHCP
Disabled Default: true discovery.

A31003-S2000-R102-6-7620 26. August 2010

4-69 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Network

WBM Name Item name Type Values Description

DHCP lease re- dhcp-reuse Boolean true/false If enabled, the phone will
use Default: false keep its DHCP-based IP
address even if the lease
expires. To prevent ad-
dress conflicts, the phone
will send ARP requests in
5 second intervals. Addi-
tionally, it will send dis-
covery messages periodi-
cally to obtain a new
DHCP lease.
Available with firmware
version V2R1.
IP address ipaddress IP IP address IP address for the phone.
address Default: NULL Only writable when not al-
ready defined by DHCP.
Subnet mask mask Subnet Subnet mask Network mask for the
mask Default: NULL phone.
Only writable when not al-
ready defined by DHCP.
Default route route IP IP address Default network route for
address Default: NULL the phone.
Only writable when not al-
ready defined by DHCP.
DNS domain dns-domain- Text Text DNS domain wherein the
name Default: NULL phone is residing.
Only writable when not al-
ready defined by DHCP.
Primary DNS dns-server- IP IP Primary DNS server ad-
addr address address dress.
Default: NULL Only writable when not al-
ready defined by DHCP.
Secondary DNS dns-server- IP IP Secondary DNS server
addr2 address address address.
Default: NULL Only writable when not al-
ready defined by DHCP.
Route 1 IP ad- route1 IP IP Specific route 1.
dress address address
Default: NULL

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-70
c04.fm

Phone Parameters - Administration

Network

WBM Name Item name Type Values Description

Route 1 gateway gw1 IP IP Gateway for specific

address address route 1.
Default: NULL
Route 1 mask mask1 Subnet Subnet mask Subnet mask for specific
mask Default: NULL route 1.
Route 2 IP ad- route2 IP IP Specific route 2.
dress address address
Default: NULL
Route 2 gateway gw2 IP IP Gateway for specific
address address route 2.
Default: NULL
Route 2 mask mask2 Subnet Subnet mask Subnet mask for specific
mask Default: NULL route 2.
VLAN discovery vlan-method Enumer- 0=Manual; VLAN discovery method.
ation 1=DCHP;
2=LLDP;
Default: 1
VLAN ID vlan-id Integer 0 to 4095 VLAN ID for the phone.
Default: NULL Only writable when not al-
ready defined by DHCP.
HTTP proxy http-proxy- IP ad- IP address or HTTP proxy to be used
addr dress or hostname. for XML aplications.
host- Default: NULL
name.
Max. 64
charac-
ters.

A31003-S2000-R102-6-7620 26. August 2010

4-71 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Network

4.2.2 Update Service

WBM Name Item name Type Values Description

DLS address dls-addr IP ad- IP address or IP address of the provi-

dress or hostname. sioning server.
host- Default: NULL Only writable when not al-
name. ready defined by DHCP.
Max. 64
charac-
ters.
DLS port dls-port Integer Default: 18443 Port the provisioning ser-
vice is listening at.
Only writable when not al-
ready defined by DHCP.
Contact gap dls-contact- Integer Default: 300 Minimum time interval in
interval seconds that must elapse
between responses to
contact-me requests.
Security mode Not relevant.

Parameters Only Accessible Via Provisioning Service

Item name Type Values Description

contact-me-uri URI Example: URI to which the provisioning

http:// server must send its contact-me
137.223.231. messages.
41:8085/ Read-only.
contact_dls.
html/
ContactDLS
configuration- Boolean true/false Set to true when the configura-
changed-flag tion has been changed, either via
local menu, or web interface, or
phone manager.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-72
c04.fm

Phone Parameters - Administration

Network

4.2.3 QoS

WBM Name Item name Type Values Description

Layer 2 qos-layer2 Boolean true/false Enable or disable QoS

Default: true layer 2.

Layer 2 voice l2qos-voice Integer 0 to 7 Sets the layer 2 CoS

Default: 5 (Class of Service) value
for voice data (RTP
streams).
Layer 2 signalling l2qos-sig- Integer 0 to 7 Sets the CoS (Class of
nalling Default: 5 Service) value for signal-
ing.
Layer 2 default l2qos- Integer 0 to 7 Sets the default CoS
default Default: 0 (Class of Service) value.
Layer 3 qos-layer3 Boolean true/false Activates or deactivates
Default: true QoS on layer 3.
Layer 3 voice l3qos-voice Enumer- 0=BE; Sets the layer 3 CoS
ation 10=AF11; (Class of Service) value
12=AF12; for voice data (RTP
14=AF13; streams).
18=AF21;
20=AF22;
22=AF23;
26=AF31;
28=AF32;
30=AF33;
34=AF41;
36=AF42;
38=AF43;
46=EF;
56=CS7;
Default: 46

A31003-S2000-R102-6-7620 26. August 2010

4-73 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Network

WBM Name Item name Type Values Description

Layer 3 signalling l3qos- Enumer- 0=BE; Sets the layer 3 CoS

signalling ation 10=AF11; (Class of Service) value
12=AF12; for signaling.
14=AF13;
18=AF21;
20=AF22;
22=AF23;
24=CS3;
26=AF31;
28=AF32;
30=AF33;
32=CS4;
34=AF41;
36=AF42;
38=AF43;
40=CS5;
46=EF;
56=CS7;
Default: 26

4.2.4 Port configuration

WBM Name Item name Type Values Description

SIP server reg-port Integer Port number Port of the SIP proxy
Default: 5060 server.
SIP registrar registrar- Integer Port number Port of the server at which
port Default: 5060 the phone registers.
SIP gateway sgnl- Integer Port number Port of the SIP gateway.
gateway- Default: 5060
port-user
SIP local phone-port Integer Port number Port used by the phone
Default: 5060 for sending and receiving
SIP messages.
Backup proxy backup-port Integer Port number Port of the backup proxy
Default: 5060 server.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-74
c04.fm

Phone Parameters - Administration

Network

WBM Name Item name Type Values Description

RTP base rtp-base- Integer Port number Base port number used
port Default: 5010 for negotiating the RTP
port.
Download server Not available in the provi-
(default) sioning interface.
LDAP server ldap-server- Integer Port number Port on which the LDAP
port Default: 389 server is listening for re-
quests.
HTTP proxy http-proxy- Integer Port number Port of the proxy used for
port Default: NULL XML applications.
LAN port speed port1 Enumer- 0=Automatic; Speed of the ethernet
ation 1=10 Mbit/s Half port connected to the
Duplex; LAN switch.
2=10Mbit/s Full
Duplex;
3=100 Mbit/s Half
Duplex;
4=100 Mbit/s Full
Duplex;
5=Gigabit/s Half
Duplex;
6=Gigabit/s Full
Duplex;
Default: 0
PC port speed port2 Enumer- 0=Automatic; Speed of the ethernet
ation 1=10 Mbit/s Half port connected to the PC.
Duplex:
2=10Mbit/s Full
Duplex;
3=100 Mbit/s Half
Duplex;
4=100 Mbit/s Full
Duplex;
5=Gigabit/s Half
Duplex;
6=Gigabit/s Full
Duplex;
Default: 0

A31003-S2000-R102-6-7620 26. August 2010

4-75 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Network

WBM Name Item name Type Values Description

PC port mode port2-mode Enumer- 0=Disabled; Controls the PC port.

ation 1=Enabled;
2=Mirror;
Default: 0
PC port port2-auto- Boolean true/false If enabled, the LAN port
autoMDIX mdix-enabled Default: false connected to the PC
switches automatically
between MDI and MDI-X.

4.2.5 LLDP-MED Operation

WBM Name Item name Type Values Description

Time to live (sec- lldp- Enumer- 40 In order to keep the

onds) timetolive ation 60 stored LLDP information
80 up-to-date, a specific TTL
100 (Time To Live) is speci-
110 fied. This value tells a de-
120 vice how long the re-
140 ceived information is
180 valid.
240
320
400

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-76
c04.fm

Phone Parameters - Administration

System

4.3 System

4.3.1 System Identity

WBM Name Item name Type Values Description

Terminal number e164 Text Default: NULL Number to be registered

at the SIP registrar.
Terminal name sip-name Text Default: NULL Used as a display name
in a SIP message.
Display identity display-id- Unicode Default: NULL When Enable ID is en-
unicode text. abled, this value is dis-
Max. 24 played in the phone’s sta-
charac- tus bar instead of the
ters. Terminal number or Ter-
minal name.
Enable ID use-display- Boolean true / false Enables the display of the
id Default: false Display identity.
Web name hostname Text Default: Based Default DNS hostname
on Phone Type for the phone.
and MAC ad- Available with firmware
dress version V2.
DNS name con- automatic- Enumer- 0=no DDNS host- Determines how the cust-
struction hostname- ation name; omised DNS host name
type 1=only host- for the phone is construct-
name; ed.
2=only number; Available with firmware
3=prefix number; version V2.
4=MAC based

Table 4-1

A31003-S2000-R102-6-7620 26. August 2010

4-77 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

4.3.2 SIP interface

WBM Name Item name Type Values Description

Outbound outbound- Boolean true / false If true, the SIP server will
proxy proxy-user Default: false resolve the domain in the
SIP request. Otherwise,
the phone will perform
this task.
Default OBP default-domain DNS DNS name If the number or name di-
domain name Default: Null aled by the user
does not provide a do-
main, this value will be
appended to the name or
number. Otherwise, the
domain of the Outbound
proxy will be appended.
SIP transport sip-transport- Enumer- 0=UDP; Transport protocol to be
user ation 1=TCP; used for SIP messages.
2=TLS;
Default: 0
Response transaction- Integer 3000 to 32000 A SIP response to an
timer (ms) timer (milliseconds) INVITE message must ar-
Default: 32000 rive within a timespan not
greater than this value.
NonCall trans transaction- Integer 3001 to 32000 A SIP response to a non-
(ms) timer-f (millisseconds) INVITE message must ar-
Default: 32001 rive within a timespan not
greater than this value.
On expiry, the phone at-
tempts to contact the
backup server, if config-
ured.
Reg. backoff registration- Integer 60 to 600 Maximum waiting time
(seconds) backoff-timer (seconds) before sending another
Default: 60 REGISTER message in
case the first attempt has
failed.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-78
c04.fm

Phone Parameters - Administration

System

WBM Name Item name Type Values Description

Connectivity voip- Integer 10 to 3600 When set to a non-zero

check timer connectivity- (milliseconds) value, test messages will
(seconds) check-interval 0 disables the be sent at the defined in-
check. terval to check the TLS
Default: 0 connection.

4.3.3 Registration

WBM Name Item name Type Values Description

SIP server ad- reg-addr IP ad- IP address or IP address or host name

dress dress or hostname. of the SIP proxy server.
host- Default: NULL
name.
Maxi-
mum of
64 char-
acters.
SIP registrar ad- registrar- IP ad- IP address or IP address or host name
dress addr dress or hostname. of the registration server.
host- Default: NULL
name.
Maxi-
mum of
64 char-
acters.
SIP gateway ad- sgnl- IP ad- IP address or IP address or host name
dress gateway- dress or hostname. of the SIP gateway.
addr-user host- Default: NULL
name.
Maxi-
mum of
64 char-
acters.

A31003-S2000-R102-6-7620 26. August 2010

4-79 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

WBM Name Item name Type Values Description

Session timer en- session- Boolean true/false Basic keep-alive mecha-

abled timer Default: false nism between 2 user
agents or phones. If en-
abled, the phone sends
periodic re-INVITEs to
keep the session alive. If
no re-INVITE is received
before the interval pass-
es, the session is consid-
ered terminated.
Session duration session- Integer Number of Expiration time for a SIP
(seconds) duration seconds. session timer.
Default: 3600
Registration timer reg-ttl Integer Number of Expiry time of a registra-
(seconds) seconds. tion.
Default: 3600
Server type server-type Enumer- 0=Other; Type of server the phone
ation 1=OpenScape will register to, or is regis-
Voice; tered at.
Default: 0
Realm realm Default: NULL Protection domain for au-
thentication at the SIP
server.
User ID sip-user-id Default: NULL Username required for an
authenticated registra-
tion.
Password sip-pwd Pass- Default: NULL Password required for an
word authenticated registra-
tion.
Backup registra- backup- Boolean true/false Determines whether or
tion allowed registration Default: true not the backup proxy is
used as a SIP registrar.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-80
c04.fm

Phone Parameters - Administration

System

WBM Name Item name Type Values Description

Backup proxy ad- backup-addr IP ad- IP address or IP address or hostname

dress dress or hostname. of the backup proxy
host- Default: NULL server.
name.
Maxi-
mum of
64 char-
acters.
Backup registra- backup-reg- Integer Number of Expiry time of the regis-
tion timer (sec- timer seconds. tration with the backup
onds) 0 or 11 to 4320. server in seconds.

Backup transport backup- Enumer- 0=UDP; Transport protocol to be

transport ation 1=TCP; used for messages to the
Default: 0 backup proxy.
Backup OBP flag backup- Boolean true/false Determines whether or
outbound- Default: false not the backup proxy is
proxy used as an outbound
proxy.

4.3.4 SNMP

WBM Name Item name Type Values Description

Trap sending en- snmp-traps- Boolean true/false Enables or disables the

abled active Default: false sending of a TRAP mes-
sage to the SNMP
manager.
Trap destination snmp-trap- IP ad- IP address or IP address or hostname
addr dress or hostname. of the SNMP manager
host- Default: NULL that receives traps.
name.
Max.64
charac-
ters.

A31003-S2000-R102-6-7620 26. August 2010

4-81 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

WBM Name Item name Type Values Description

Trap destination snmp-trap- Integer Port number Port on which the SNMP
port port Default: 162 manager is receiving
TRAP messages.
Trap community snmp-trap- Text Default: snmp SNMP community string
pwd for the SNMP manager
receiving TRAP
messages.
Queries allowed snmp- Boolean true/false Enables or disables que-
queries- Default: false ries from the SNMP
allowed manager.
Query password snmp-pw Text Any string except Password for the execu-
"public", "pri- tion of a query by the
vate", "PUBLIC", SNMP manager.
"Public", "puBlic"
and other case
related variants.
Diagnostic send- diagnostic- Boolean true/false Enables or disables the
ing enabled traps-active Default: false sending of diagnostic
data to the
SNMP manager.
Diagnostic desti- diagnostic- IP ad- IP address or IP address or hostname
nation trap-addr dress or hostname. of the SNMP manager re-
host- Default: NULL ceiving diagnostic
name. data.
Max. 64
charac-
ters.
Diagnostic desti- diagnostic- Integer Port number. Port on which the SNMP
nation port trap-port Default: 162 manager is receiving
diagnostic data.
Diagnostic com- diagnostic- Text Default: snmp SNMP community string
munity trap-pwd for the SNMP manager
receiving diagnostic
data.
Diagnostic to ge- diagnostic- Boolean true/false Enables or disables the
neric destina- snmp-active Default: false sending of QoS traps to a
tion generic destination.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-82
c04.fm

Phone Parameters - Administration

System

WBM Name Item name Type Values Description

QoS traps to qdc-qcu- Boolean true/false Enables or disables the

QCU active Default: false sending of TRAP mes-
sages to the QCU server.
QCU address qdc- IP ad- IP address or IP address or hostname
collection- dress or hostname. of the QCU server.
unit-addr host- Default: NULL
name.
Max. 64
charac-
ters
QCU port qdc- Integer Port number. Port on which the QCU
collection- Default: 12010 server is listening for
unit-port messages.
QCU community qdc-trap-pwd Text Default: QOSDC QCU community string.
QoS to generic qdc-snmp- Boolean true/false Enables or disables the
destination active Default: false sending of QoS traps to a
generic destination.

A31003-S2000-R102-6-7620 26. August 2010

4-83 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

4.3.5 Features

4.3.5.1 Configuration

WBM Name Item name Type Values Description

Emergency num- emergency-e164 Text Default: NULL If the phone is locked, a

ber clickable area for making
an emergency call is cre-
ated.
Voice mail num- voice-mail- Text Default: NULL Call number of the voice
ber e164 mail box.
Allow refuse refuse-call Boolean true/false Defines whether the
Default: true Refuse call feature is
available on the phone.
Allow transfer on transfer-on- Boolean true/false If enabled, a call can be
ring ring Default: true transferred after the user
has dialed the third partic-
ipant’s number, but be-
fore the third party has
answered the call.
Hot/warm phone hot-line-warm- Enumer- 1=noAction; The number specified in
line ation 2=Hotline; Hot/warm destination is
3=Warmline dialed immediately (hot
phone) or after a
configurable delay (warm
phone) when the user
goes off-hook.
Available with firmware
version V2.
Hot/warm desti- hot-line-warm- Text Call number. Number to be dialed
nation line-digits when Hot phone or Warm
phone is enabled.
Available with firmware
version V2.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-84
c04.fm

Phone Parameters - Administration

System

WBM Name Item name Type Values Description

Initial digit timer initial-digit- Integer Number of Timeout for entering the
(seconds) timer seconds. first digit after going off-
1 to 120. hook. On expiry, the
Default: 30 phone will change to idle
mode.
Available with firmware
version V2.
Not used timeout not-used-time- Integer Number of Timeout for the local user
(minutes) out minutes. and admin menu. When
1 to 5 the time interval is over,
Default: 2 the menu is closed and
the administrator/user is
logged out.
Transfer on unconditional- Boolean true/false This feature applies to the
hangup transfer Default: following scenario:
false While A is talking to B, C
calls A. A accepts the
call, so B is on hold and
the call between A and C
is active. If Transfer on
hangup is enabled,
and A goes on-hook, B
gets connected to C. If
disabled, C will be re-
leased when A hangs up,
and A has the possibility
to reconnect to B. By de-
fault, the feature is dis-
abled.

A31003-S2000-R102-6-7620 26. August 2010

4-85 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

WBM Name Item name Type Values Description

FPK program fpk-long- Enumer- 0=0; When an FPK is pressed

timer press-timer ation 1=1; for a time interval longer
2=2; than the value specified
3=3; here (in seconds), it en-
4=4; ters programming mode.
5=5 When set to 0, the FPK
Default: 2 will not enter program-
ming mode, no matter
how long the key is
pressed.
Relevant for OpenStage
15/40/60/80.
Available with firmware
version V2R1.
Group pickup group-pickup- Boolean true/false If enabled, an acoustic
tone allowed tone-allowed Default: true signal is created for in-
coming pickup group
calls.
Group pickup as group-pickup- Boolean true/false Determines whether the
ringer as-ringer Default: true current ringtone or an
alert beep is used.
Group pickup vi- group-pickup- Enumer- 0=Prompt; Defines the user action
sual alert alert-type ation 1=Notify; required to accept a pick-
Default: 0 up call.
BLF alerting blf-tone-type Enumer- 0=beep; Selects the sound for indi-
ation 1=ring tone cating an incoming call for
Default: 0 the monitored extension.
Available with firmware
version V2R1.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-86
c04.fm

Phone Parameters - Administration

System

4.3.5.2 Free Programmable Keys (FPK)

The function associated with a programmable feature key is represented by a feature id num-
ber. In the provisioning interface, this number is stored as content of the function-key-def
element. The key number is stored in the index attribute, starting from 1 for the first key.
The possible key numbers depend on the OpenStage model:
• OpenStage 15: 1 to 8
• OpenStage 40: 1 to 6
• OpenStage 60: 1 to 8
• OpenStage 80: 1 to 9
The shifted keys are indexed as follows:
• OpenStage 15: 1001 to 1008
• OpenStage 40: 1001 to 1006
• OpenStage 60: 1001 to 1008
• OpenStage 80: 1001 to 1009
In the following example, the repeat dialling function is assigned to the first key:
<Item name="function-key-def" index="1">3</Item>
<Item name="key-label-unicode" index="1">Repeat Dialling</Item>

Selected dialing
A predefined call number is dialed on key press.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Selected
mum of dialling
12 char-
acters.
function- Integer 1 Feature ID which defines
key-def the function.
<index>
Dial number select-dial Text Default: NULL Number to be dialed
<index> when pressing the key.

A31003-S2000-R102-6-7620 26. August 2010

4-87 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Repeat dialing
On key press, the call number that has been dialed lastly is dialed again.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Repeat
<index> Maxi- Dialling
mum of
12 char-
acters.
function- Integer 3 Feature ID which defines
key-def the function.
<index>

Forwarding
This is the phone’s built-in forwarding function. An incoming call is forwarded to the predefined
call number, depending on the forwarding type, that is, the current conditions at the phone.

With firmware version V2, server-side forwarding can be assigned to the phone’s
> fixed forwarding key; please refer to Section 4.3.5.3, "Fixed Keys".

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Forwarding
mum of
24 char-
acters.
function- Integer 6 Feature ID which defines
key-def the function.
<index>
Forwarding type forwarding- Enumer- 0=All calls; Call forwarding type.
type ation 1=No reply;
<index> 2=Busy;
Default: 0

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-88
c04.fm

Phone Parameters - Administration

System

WBM Name Item name Type Values Description

Destination forwarding- Text Default: NULL Destination for call for-

dest warding.
<index>

Ringer off
Turns off the ringtone. Incoming calls are indicated via LEDs and display only.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Ringer
<index> Maxi- off
mum of
12 char-
acters.
function- Integer 9 Feature ID which defines
key-def the function.
<index>

Hold
The call currently active is put on hold.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Hold
<index> Maxi-
mum of
12 char-
acters.
function- Integer 10 Feature ID which defines
key-def the function.
<index>

A31003-S2000-R102-6-7620 26. August 2010

4-89 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Alternate
Toggles between two calls; the previously active call is put on hold.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Alternate
mum of
12 char-
acters.
function- Integer 11 Feature ID which defines
key-def the function.
<index>

Move blind / Blind transfer

A call is transferred without consultation, as soon as the phone goes on-hook or the target
phone goes off-hook.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Move
<index> Maxi- blind
mum of
12 char-
acters.
function- Integer 12 Feature ID which defines
key-def the function.
<index>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-90
c04.fm

Phone Parameters - Administration

System

Join
Call transfer, applicable when there is one active call and one call on hold. The active call and
the held call are connected to each other, while the phone that has initiated the transfer is dis-
connected.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Join
<index> Maxi-
mum of
12 char-
acters.
function- Integer 13 Feature ID which defines
key-def the function.
<index>

Deflect
On key press, an incoming call is deflected to the specified destination.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Deflect
mum of
12 char-
acters.
function- Integer 14 Feature ID which defines
key-def the function.
<index>
Destination key-deflect- Text Default: NULL Destination for call deflec-
destination tion.
<index>

A31003-S2000-R102-6-7620 26. August 2010

4-91 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Shift
Shift the level for the program keys. When activated, the functions assigned to the shift level
are available on the program keys.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Shift
<index> Maxi-
mum of
12 char-
acters.
function- Integer 18 Feature ID which defines
key-def the function.
<index>

Conference
Establish a phone-based three-party conference from an active call and a call on hold.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Conference
mum of
12 char-
acters.
function- Integer 22 Feature ID which defines
key-def the function.
<index>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-92
c04.fm

Phone Parameters - Administration

System

Headset
Accept an incoming call via headset.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Headset
mum of
12 char-
acters.
function- Integer 24 Feature ID which defines
key-def the function.
<index>

Do Not Disturb
If this feature is activated, incoming calls will not be indicated to the user.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Do Not
<index> Maxi- Disturb
mum of
12 char-
acters.
function- Integer 25 Feature ID which defines
key-def the function.
<index>

A31003-S2000-R102-6-7620 26. August 2010

4-93 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Repertory dial
This feature is similar to the selected dialing function, but additionally, special calling functions
are possible. The desired number and/or function is selected via the Dial string parameter.
The following call functions are available:
• $Q Disconnect a call.
• ~ Start a consultation call. Example: ~3333$S
• $S Start a call. Example: 3333$S
• - Enter a pause, e. g. for exit-code or international dialing. Example: 0-011511234567$S

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Repertory
<index> Maxi- dial
mum of
12 char-
acters.
function- Integer 30 Feature ID which
key-def defines the function.
<index>
Dial string repertory- Text String with maximum Call number and/or
dial of 60 Unicode charac- special strings for
<index> ters. call control.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-94
c04.fm

Phone Parameters - Administration

System

Consult and transfer

When the phone is an active call, this function opens a dialing menu to make a consultation call.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default:
<index> Maxi- Consult and
mum of transfer
12 char-
acters.
function- Integer 50 Feature ID which defines
key-def the function.
<index>

Call waiting toggle

Enables or disables the Call waiting feature. If enabled, calls from a third party are allowed
during an active call.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Call
<index> Maxi- waiting
mum of toggle
12 char-
acters.
function- Integer 53 Feature ID which defines
key-def the function.
<index>

A31003-S2000-R102-6-7620 26. August 2010

4-95 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Server feature
Invokes a feature on the SIP server. The status of the feature can be monitored via the LED
associated to the key.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: Server
<index> Maxi- feature
mum of
12 char-
acters.
function- Integer 54 Feature ID which defines
key-def the function.
<index>
Feature code stimulus- String Default: NULL This code will be sent in a
feature- SIP INVITE to the SIP
code<index> server.
DTMF digits stimulus- String Default: NULL This code will be sent to
DTMF- the SIP server as a DTMF
sequence signal. As a precondition,
<index> an audio path which is
routed via the SIP server
must exist.
LED control stimulus- String Default: NULL This SIP URI will receive
led-control- the status notifications
uri<index> (SIP NOTIFY) from the
SIP server. The LED is
switched on or off
accordingly.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-96
c04.fm

Phone Parameters - Administration

System

BLF
Offers the possibility to monitor another phone, and to pick up calls for the monitored phone.
For the pickup function (firmware version V2R1 onwards), the appropriate code must be pro-
vided (see blf-code in Section 4.3.5.6, "Services").

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: BLF
<index> Maxi-
mum of
12 char-
acters.
function- Integer 59 Feature ID which defines
key-def the function.
<index>
Monitored phone stimulus- Text Default: NULL Call number (SIP URI) of
led-control- the monitored phone.
uri<index>
Audible alert blf-audible Boolean true/false If enabled, an alert beep
<index> Default: false or ring tone will indicate
an incoming call for the
monitored phone.
For determining whether
a beep or the ring tone is
used, blf-tone-type
is used (see Section
4.3.5.1, "Configuration").
Popup on alert blf-popup[ ] Boolean true/false If enabled, a popup win-
Default: false dow will indicate an in-
coming call for the moni-
tored phone.

A31003-S2000-R102-6-7620 26. August 2010

4-97 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

Start application
Starts an XML application.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: App:
<index> Maxi-
mum of
12 char-
acters.
function- Integer 60 Feature ID which defines
key-def the function.
<index>
Application name FPK-app- Text Default: NULL Name of the application
name<index> to be started.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-98
c04.fm

Phone Parameters - Administration

System

Send URL
With this function, the phone can send a specific HTTP or HTTPS request to a server. The func-
tion is available at any time, irrespective of registration and call state. Possible uses are HTTP-
controlled features on the SIP server, e. g. hunt group login/logout, or functions on a web server
that can only be triggered by HTTP/HTTPS request, e. g. login/logout for flexible working hours.
To define this function for a key, function-key-def must be set to 63.

This function is available with firmware version V2.

>
WBM Name Item name Type Values Description

Key label <n> key-label- Text Default: Send Label for the key.
unicode URL
<index>
Protocol send-url- Enumer- 0=TLSv1 Defines whether HTTP or
protocol ation (HTTPS); HTTPS is to be used for
<index> 3=TCP sending the URL to the
(HTTP); server.
Default: 3 For HTTPS, a certificate
especially for the send
URL function can be pro-
vided by the provisioning
service; please refer to
Section 5.12, "Certifi-
cates".
Web server ad- send-url- String Default: NULL IP address or DNS name
dress address of the remote server to
<index> which the URL is to be
sent.
Port send-url-port String Default: NULL Target port at the server
<index> to which the URL is to be
sent.
Path send-url-path String Default: NULL Server-side path to the
<index> desired function, i. e. the
part of the URL that fol-
lows the IP address or
DNS name.

A31003-S2000-R102-6-7620 26. August 2010

4-99 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

WBM Name Item name Type Values Description

Parameters send-url-query String Default: NULL One or more key/value

<index> pairs in the format
<key>=<value> to be
added to the request. If
there are more than one
parameters, they are sep-
arated by an ampersand
(&). Please note that, for
the WPI, the ampersand
must be represented by
&amp;.
Method send-url- Enumer- 0=get; HTTP method to be used.
method ation 1=post If GET is selected, the ad-
<index> ditional parameters and
the user id/password
are part of the URL. If
POST is selected, these
data form the body of the
message.
Web server user send-url-user- String Default: NULL User ID to be sent to the
ID id<index> web server, in case au-
thentication is required.
Web server pass- send-url- String Default: NULL Password to be sent to
word passwd the web server, in case
<index> authentication is required.
LED controller stimulus-led- String Default: NULL This SIP URI will receive
URI control-uri status notifications (SIP
<index> NOTIFY) from a SIP
server. The LED is
switched on or off accord-
ingly.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-100
c04.fm

Phone Parameters - Administration

System

Clear (no feature assigned)

No function is associated with this key.

WBM Name Item name Type Values Description

Key label <n> key-label- Unicode Unicode text Label for the key.
unicode text. Default: App:
<index> Maxi-
mum of
12 char-
acters.
function- Integer 0 Feature ID which defines
key-def the function.
<index>

A31003-S2000-R102-6-7620 26. August 2010

4-101 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

4.3.5.3 Fixed Keys

With software version V2R0, the forwarding key r can be modified. The underlying function-
ality and parameters are the same as those used in the server feature function for the program
keys (see Section 4.3.5.2, "Server feature").

Extended Funcionality With Version V1R2

With version V2R1, all function keys can be reprogrammed:
• Release key s (OpenStage 20/40/60/80)
• Forwarding key r (OpenStage 20/40/60/80)
• Voice dial key q (OpenStage 60/80)
• Redial key , (OpenStage 20/40)
For each of these keys, one of the following functions can be defined as an alternative to the
built-in function:
• Server feature (see Section 4.3.5.2, "Server feature")
• Send URL (see Section 4.3.5.2, "Send URL")
• Start XML application (see Section 4.3.5.2, "Start application")

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-102
c04.fm

Phone Parameters - Administration

System

Forwarding Key (V2R0)

The functionality of the forwarding key r can be modified to the server feature function; for
the function sepcific paramteres, pleaser see Section 4.3.5.2, "Server feature". Unless the key
functionality parameter is set to "unspecified", built-in forwarding will be disabled.

This function is available with firmware version V2 for all OpenStage phones except
> OpenStage 15, which has no forwarding key.

WBM Name Item name Type Values Description

Key functionality key- Enumer- 0="Toggle Call Controls the behaviour of

functionality ation Forwarding", the forwarding key.
index="4002" 1="Unspeci- "Toggle call forwarding":
fied Call For- On pressing the key, the
warding", user will be presented
2="Unspeci- with a prompt. When ac-
fied" cepted, the configured
feature code or DTMF se-
quence will be sent to the
external server. The for-
warding icon in the call
view screen will be con-
trolled by the SIP server,
just like the LED.
"Unspecified call forward-
ing": No prompt will be
presented to the user.
The configured feature
code or DTMF sequence
will be sent to the external
server immediately.
"Unspecified": No prompt
will be presented to the
user. The configured fea-
ture code or DTMF se-
quence will be sent to the
external server immedi-
ately. The phone’s built-in
forwarding is not dis-
abled.

A31003-S2000-R102-6-7620 26. August 2010

4-103 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

WBM Name Item name Type Values Description

function-key- 58=server fea- Feature ID which defines

def ture the function.
index="4002"

Forwarding Key (V2R1)

With software version V2R1, additional functions are available for the forwarding key.
For the forwarding key, the behaviour of the user interface is configurable:

WBM Name Item name Type Values Description

Key functionality key- Enumer- 0="Toggle Call For details, please refer
functionality ation Forwarding", to Section 4.3.5.3, "For-
index="4002" 1="Unspeci- warding Key (V2R0)".
fied Call For-
warding",
2="Unspeci-
fied"

• Send URL

WBM Name Item name Type Values Description

function-key- 63=send URL Feature ID which defines

def the function.
index="4002"

For the function specific parameters, please refer to Section 4.3.5.2, "Send URL".

• Start XML Application

WBM Name Item name Type Values Description

function-key- 60=start XML Feature ID which defines

def application; the function.
index="4002"

For the function specific parameters, please refer to Section 4.3.5.2, "Start application".

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-104
c04.fm

Phone Parameters - Administration

System

• Built-in Forwarding

function-key- 64=built-in for- Feature ID which defines

def warding the function.
index="4002"

Release Key (V2R1)

• Server Feature

WBM Name Item name Type Values Description

function-key- 58=server fea- Feature ID which defines

def ture the function.
index="4001"
• Send URL

WBM Name Item name Type Values Description

function-key- 63=send URL Feature ID which defines

def the function.
index="4001"

For the function specific parameters, please refer to Section 4.3.5.2, "Send URL".

• Start XML Application

WBM Name Item name Type Values Description

function-key- 60=start XML Feature ID which defines

def application; the function.
index="4001"

For the function specific parameters, please refer to Section 4.3.5.2, "Start application".

A31003-S2000-R102-6-7620 26. August 2010

4-105 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

• Built-in Release

function-key- 65=built-in re- Feature ID which defines

def lease the function.
index="4002"

Voice Dial Key (V2R1)

• Server Feature

WBM Name Item name Type Values Description

function-key- 58=server fea- Feature ID which defines

def ture the function.
index="4003"
• Send URL

WBM Name Item name Type Values Description

function-key- 63=send URL Feature ID which defines

def the function.
index="4003"

For the function specific parameters, please refer to Section 4.3.5.2, "Send URL".

• Start XML Application

WBM Name Item name Type Values Description

function-key- 60=start XML Feature ID which defines

def application; the function.
index="4003"

For the function specific parameters, please refer to Section 4.3.5.2, "Start application".

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-106
c04.fm

Phone Parameters - Administration

System

• Built-in Voice Dial

function-key- 66=built-in Feature ID which defines

def voice dial the function.
index="4003"

Redial Key (V2R1)

• Server Feature

WBM Name Item name Type Values Description

function-key- 58=server fea- Feature ID which defines

def ture the function.
index="4009"
• Send URL

WBM Name Item name Type Values Description

function-key- 63=send URL Feature ID which defines

def the function.
index="4009"

For the function specific parameters, please refer to Section 4.3.5.2, "Send URL".

• Start XML Application

WBM Name Item name Type Values Description

function-key- 60=start XML Feature ID which defines

def application; the function.
index="4009"

For the function specific parameters, please refer to Section 4.3.5.2, "Start application".

A31003-S2000-R102-6-7620 26. August 2010

4-107 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

• Built-in Redial

function-key- 67=built-in re- Feature ID which defines

def dial the function.
index="4009"

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-108
c04.fm

Phone Parameters - Administration

System

4.3.5.4 Key Module 1

The settings are the same as those for programmable keys on the phone (see Section 4.3.5.2,
"Free Programmable Keys (FPK)").

4.3.5.5 Key Module 2

The settings are the same as those for programmable keys on the phone (see Section 4.3.5.2,
"Free Programmable Keys (FPK)").

4.3.5.6 Services

WBM Name Item name Type Values Description

Message waiting mwi-e164 IP ad- IP address, host- Address or host name of

server address dress, name or NULL. the server that sends
host- Non-NULL=ex- message waiting notifica-
name or plicit subscription tions to the phone.
NULL. to service;
Max. 24 NULL = implicit
charac- subscription.
ters. Default: NULL
Conference URI conference- Text Default: NULL Call number/URI used for
factory-uri system based
conference.
Code for callback callback- Text Default: NULL Access code that is sent
busy busy-code to the server if the
line is busy.
Code for callback callback- Text Default: NULL Access code that is sent
no reply ring-code to the server if the callee
does not reply.
Code for callback callback- Text Default: NULL Access code for cancel-
cancel all cancel-code ing all callback requests
on the server.
BLF pickup code blf-code Test Default: NULL Code sent to the SIP
server for BLF call pickup.
Available with firmware
V2R1 onwards.

A31003-S2000-R102-6-7620 26. August 2010

4-109 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
System

4.3.5.7 Feature access

Services

WBM Name Item name Type Values Description

Enable Bluetooth enable- Boolean true/false Enables or disables the

interface bluetooth- Default: true Bluetooth interface. Read
interface only if locked by provi-
sioning service.

4.3.6 Security

WBM Name Item name Type Values Description

SIP server certifi- voip-server- Boolean true/false If enabled, the phone will
cate validation validation Default: false validate the server certifi-
cate sent by the SIP serv-
er in order to establish a
TLS connection.
Use secure calls voip- Boolean true/false If activated, the encryp-
payload- Default: false tion of outgoing calls is
security- enabled, and the phone is
allowed capable of receiving en-
crypted calls.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-110
c04.fm

Phone Parameters - Administration

File Transfer

4.4 File Transfer

Due to the organization of the file transfer parameters in the provisioning interface, the presen-
tation will differ from the other sections. However, the WBM names which correspond to the
parameters will be retained in order to make them more findable.
For in-deep information, see Section 3.6.7, "File Provisioning". Note that multiple file deploy-
ment is possible using the index attribute (see Section 3.6.7.3, "XML Data Exchange For Mul-
tiple File Deployment").

4.4.1 FTP/HTTPS Access Data

WBM Name Item name Type Values Description

Download Not applicable. The method is deter-

method mined by the presence or
absence of file-
server and file-
https-base-url.
FTP Server ad- file-server IP ad- IP address or IP address or hostname
dress <index> dress or hostname of the FTP/HTTPS server
host- Default: NULL in use.
name
FTP Server port file-port Integer Port number Port number of the FTP
<index> Default: 21 server in use.
FTP account file-account Text. Default: NULL Account at the server (if
<index> Max. 92 applicable).
charac-
ters.
FTP username file- Text. Default: NULL User name for accessing
username Max. 93 the server.
<index> charac-
ters.
FTP password file-pwd Text. Default: NULL Password corresponding
<index> Max. 24 to the user name.
charac-
ters
FTP path file-path Text Default: NULL Path of the directory con-
<index> taining the files.

A31003-S2000-R102-6-7620 26. August 2010

4-111 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
File Transfer

WBM Name Item name Type Values Description

HTTPS base file-https- Text. Default: NULL IP address or hostname

URL base-url Max. 255 of the HTTPS server in
<index> charac- use.
ters.

4.4.2 File Provisioning Data

Item name Type Values Description

file-type Text See Section 4.4.3, Type of file to be downloaded by the

<index> "Specifications For phone.
Media Files and
LDAP Templates".
file-action Text deploy/delete If set to deploy, the phone will
<index> Default: NULL download the file. If set to delete, the
specified file will be deleted. Used
for multiple file deployment.
file- Text ok/failed Indicates whether the last file de-
deployment- Default: NULL ployment has succeeded or failed.
status
<index>
file- Text Default: NULL Date of the last file deployment.
deployment-
date
<index>
file- Text Default: NULL Time of the last file deployment.
deployment-
time
<index>
file-priority Text normal/ Priority for the software (phone firm-
immediate ware) deployment. When set to
Default: immediate, the current status will
immediate be disregarded, and the software will
be deployed unconditionally.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-112
c04.fm

Phone Parameters - Administration

File Transfer

4.4.3 Specifications For Media Files and LDAP Templates

For non-software files, the file types are specified as content of the file-type tag.
Example: <Item name="file-type">LOGO</Item>
The file types are listed here:

WBM Name file-type Type/Extension Description

Hold music MOH WAV/.wav This sound file is played
MIDI/.mid when a call is put on hold.
MP3/.mp3 (OpenStage Recommended WAV speci-
60/80 only) fications: PCM; bit rate: 16
kB/sec; sampling rate: 8
kHz; quantization: 16 bit.
Recommended MP3 bit
rate: 48 kbit/sec.
Picture clip PIC JPEG/.jpg Small images used for dis-
PNG/.png playing a picture of a person
that is calling on a line.
The file size is limited to 300
kB.
OpenStage 60/80 only.
LDAP LDAP TXT/.txt Allocation list to assign di-
rectory server attributes to
input and output fields on an
LDAP client.
OpenStage 60/80 only.
Logo LOGO JPEG/.jpg (OpenStage Custom background image
60/80) for the telephony interface.
PNG/.png (OpenStage Ideal size for OpenStage 40:
60/80) width: 144px; height: 32 px.
BMP/.bmp (black/white, Ideal size for OpenStage 60:
for OpenStage 40) width: 240 px; height: 70 px.
Ideal size for OpenStage 80:
width: 480 px; height: 148
px.
OpenStage 40/60/80 only.

A31003-S2000-R102-6-7620 26. August 2010

4-113 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
File Transfer

WBM Name file-type Type/Extension Description

Screensaver SCREENSAVER JPEG/.jpg Images for a slideshow
PNG/.png which is displayed when the
phone is in idle mode.
Ideal resolution for Open-
Stage 60: 320x640
Ideal resolution for Open-
Stage 80: 640x480
OpenStage 60/80 only.
Ringer file RINGTONE WAV/.wav Custom Ringtones.
MIDI/.mid The file size for a ringer file
MP3/.mp3 (OpenStage is limited to 1 MB.
60/80 only) Recommended WAV speci-
fications: PCM; bit rate:
16kB/sec; sampling rate: 8
kHz; quantization: 16 bit.
Recommended MP3 bit
specifications: bit rate: 48 to
112 kbit/sec; length: up to 1
min; mono.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-114
c04.fm

Phone Parameters - Administration

Local functions

4.5 Local functions

4.5.1 Directory settings

These settings are relevant for OpenStage 60/80 only.

>
WBM Name Item name Type Values Description

LDAP Server ad- ldap-server- IP ad- Default: NULL IP address or hostname

dress address dress or of the LDAP server.
host-
name.
Max. 64
charac-
ters.
LDAP Server port ldap-server- Integer Port number. Port on which the LDAP
port Default: 389 server is listening for re-
quests.
Authentication ldap- Enumer- 0=Anony- Authentication method
authentication ation mous; used for connecting to the
1 =Simple; LDAP server.
Default: 0
User name ldap-user Text Default: NULL User name for authenti-
cation with the LDAP
server in the LDAP bind
request.

Password ldap-pwd Text Default: NULL Password used for au-

thentication with the
LDAP server.

A31003-S2000-R102-6-7620 26. August 2010

4-115 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Local functions

WBM Name Item name Type Values Description

Search trigger ldap-search- Enumer- 1/2/3/4/5/6/7/ The search string is sub-

timeout trigger- ation 8/9/10/60 mitted to the LDAP server
timeout (seconds) as soon as the OK key is
pressed, or when the
Search trigger timeout ex-
pires.
Available with firmware
version V2.

4.5.2 Messages settings

The indication of old and new messages on the display can be configured. There are 4 cate-
gories of voicemail messages: new, new urgent, old, and old urgent. For each category, the
message count can be shown or hidden, and a label for the category can be defined.
If a label configuration item is empty, the phone will show the default label.

These settings are available with firmware version V2.

>
WBM Name Item name Type Values Description

Alternative label MWI-new-label Text Default: NULL Label for new items.
Maxi-
mum
length of
17 char-
acters
New urgent items MWI-new- Boolean true/false Determines whether new
urgent-show Default: true urgent items are
indicated.
Alternative label MWI-new- Text Default: NULL Label for new urgent
urgent-label Maxi- items.
mum
length of
17 char-
acters

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-116
c04.fm

Phone Parameters - Administration

Local functions

WBM Name Item name Type Values Description

Old items MWI-old-show Boolean true/false Determines whether old

Default: true items are indicated.
Alternative label MWI-old-label Text Default: NULL Label for old items.
Maxi-
mum
length of
17 char-
acters
Old urgent items MWI-old- Boolean true/false Determines whether old
urgent-show Default: true urgent items are
indicated.
Alternative label MWI-old- Text Text Label for old urgent items.
urgent-label Maxi- Maximum
mum length of 17
length of characters
17 char-
acters

4.5.3 Locality

4.5.3.1 Canonical dial settings

WBM Name Item name Type Values Description

Local country Canonical-di- Text Default: NULL E.164 Country code, e.g.
code aling-local- "49" for Germany, "44" for
country-code United Kingdom.
National prefix Canonical-di- Text Default: NULL Prefix for national con-
digit aling- nections, e.g. "0" in Ger-
national-pre- many and United King-
fix dom.
Local national Canonical-di- Text Default: NULL Local area code or city
code aling-local- code, e.g. "89" for Mu-
area-code nich, "20" for London

A31003-S2000-R102-6-7620 26. August 2010

4-117 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Local functions

WBM Name Item name Type Values Description

Minimum local Canonical-di- Text Default: NULL Minimum number of digits

number length aling-min-lo- in a local PSTN number.
cal-number-
length
Local enterprise Canonical-di- Text Default: NULL Number of the company/
node aling-local- PBX wherein the phone is
node residing.
PSTN access Canonical-di- Text. Com- Default: NULL Access code used for di-
code aling- ma sepa- aling out from a PBX to a
external- rated if PSTN.
access multiple
values.
Max. 50
characters
International ac- Canonical-di- Text. Com- Default: NULL International prefix used
cess code aling- ma sepa- to dial to another country,
international rated if e.g. "00" in Germany and
-prefix multiple United Kingdom.
values.
Max. 50
characters
Operator codes Canonical- Text. Com- Default: NULL List of extension numbers
dialing- ma sepa- for a connection to the op-
operator-code rated if erator.
multiple
values.
Max. 50
characters
Emergency num- Canonical- Text. Com- Default: NULL List of emergency num-
bers dialing- ma sepa- bers to be used for the
emergency- rated if phone.
number multiple
values.
Max. 50
characters

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-118
c04.fm

Phone Parameters - Administration

Local functions

WBM Name Item name Type Values Description

Initial extension Canonical- Text. Com- Default: NULL List of initial digits of all
digit dialing- ma sepa- possible extensions in the
extension- rated if local enterprise network.
initial- multiple
digits values.
Max. 50
characters

A31003-S2000-R102-6-7620 26. August 2010

4-119 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Local functions

4.5.3.2 Canonical dial lookup

WBM Name Item name Type Values Description

Local code <n> Canonical- Text. Default: NULL Local enterprise code for
lookup-local- Max. 10 the node/PBX the phone
code charac- is connected to.
<index> ters. <n> can be a number
from 1 to 5, which en-
ables up to 5 entries, and
is represented in the in-
dex.
International Canonical- Text. Default: NULL Full canonical format for
code <n> lookup- Max. 30 the enterprise node.
international charac- <n> can be a number
-code<index> ters. from 1 to 5, which en-
ables up to 5 entries, and
is represented in the in-
dex.

4.5.3.3 Canonical dial

WBM Name Item name Type Values Description

Internal numbers Canonical- Enumer- 0=Local enter- Defines how dial strings
dialing-dial- ation prise form; for internal numbers are
internal-form 1=Always add generated.
node;
2=Use external
numbers;
Default: 0
External numbers Canonical- Enumer- 0=Local public Defines how dial strings
dialing-dial- ation form; for external numbers are
external-form 1=National pub- generated.
lic form;
2=International
form;
Default: 0

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-120
c04.fm

Phone Parameters - Administration

Local functions

WBM Name Item name Type Values Description

External access Canonical- Enumer- 0=Not required; Defines in which cases

code dialing-dial- ation 1=For external the external access code
needs-access- numbers; is added.
code Default: 1
International Canonical- Enumer- 0=Use national Defines whether the inter-
gateway code dialing-dial- ation code; national gateway code is
needs-intGW- 1=Leave as +; added.
code Default: 0

4.5.4 Energy Saving

WBM Name Item name Type Values Description

Backlight timeout pixelsaver- Enumer- 2=2; After the phone has been
(hours) timeout ation 3=3; inactive within the
4=4; timespan specified here,
5=5; the display backlight is
6=6; switched off.
7=7;
8=8;
Default: 3

A31003-S2000-R102-6-7620 26. August 2010

4-121 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Date and time

4.6 Date and time

WBM Name Item name Type Values Description

SNTP IP address sntp-addr IP ad- Default: NULL IP address or hostname

dress or of the SNTP server.
host-
name.
Max. 64
charac-
ters.
Timezone offset sntp-tz- Integer -12 to +12 Shift in hours in relation to
(hours) offset UTC.
Daylight saving daylight- Boolean true/false Enables or disables day-
save Default: false light saving time in con-
junction with Auto time
change.
Difference (min- daylight- Integer 60 Time difference in relation
utes) save-minutes to regular time when day-
light saving time is in ef-
fect.
Auto time change auto- Boolean true/false Enables or disables auto-
daylight- Default: false matic control of daylight
save saving time according to
the DST zone.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-122
c04.fm

Phone Parameters - Administration

Date and time

WBM Name Item name Type Values Description

DST zone daylight- Enumer- 0=Not set; World region in which the
save-zone-id ation 1=Australia 2007 phone is located. Used
(ACT, South Aus- for Auto time change.
tralia, Tasmania,
Victoria);
2=Australia 2007
(New South
Wales);
3=Australia
(Western Austra-
lia);
4=Australia
2008+ (ACT,
New South
Wales, South
Australia, Tasma-
nia, Victoria);
5=Brazil;
6=Canada;
7=Canada (New-
foundland);
8=Europe (PT,
UK);
9=Europe (AT,
BE, HR, DK, FR,
DE, HU, IT, LU,
NL, NO, PL, SK,
ES, SE, CH);
10=Europe (FI);
11=Mexico;
12=United
States;
Default: 0

A31003-S2000-R102-6-7620 26. August 2010

4-123 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Speech

4.7 Speech

4.7.1 Codec preferences

The settings for each codec are specified by assigning a corresponding index to a generic pa-
rameter. The following XML snippet allows the use of the G.729 codec, and assigns a 10ms
packet size as well as a selection rank of 2 to this codec.

The same packet size must be used for all codecs.

>
The index number 3 is assigned to the G.729 codec, which is identified internally by the code
number 2:
<Item name="codec-type" index="3">2</Item>
G.729 is allowed:
<Item name="codec-allowed" index="3">true</Item>
The packet size for G.729 is set to 10ms:
<Item name="codec-packet-size" index="3">0</Item>
G.729 has selection rank 2, that is, it will be second choice when the codec is negotiated:
<Item name="codec-rank" index="3">2</Item>

WBM Name Item name Type Values Description

Silence suppres- audio- Boolean true/false Suppression of data

sion silence- Default: false transmission on no con-
suppression versation.
Packet size codec- Enumer- 0=10 ms; Size of RTP packets in
packet-size ation 1=20 ms; milliseconds.
<index> 2=Automatic;
3=30ms;
Default: 2
codec-type Enumer- 0=G.711; Binds a codec type to a
ation 1=G.722; set of configuration items
2=G.729 using the index.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-124
c04.fm

Phone Parameters - Administration

Speech

WBM Name Item name Type Values Description

G.711 ranking codec-rank Integer 1 to number of Ranking for each codec.

G.729 ranking <index> codec types.
G.722 ranking Default:
1 for G.722;
2 for G.711;
3 for G.729
G.711 allowed codec- Boolean true/false Allows or disallows a co-
G.729 allowed allowed Default: dec.
G.722 allowed <index> false for G.722;
true for G.711;
true for G.729

A31003-S2000-R102-6-7620 26. August 2010

4-125 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Speech

4.7.2 Audio settings

The usage of microphone and speaker for speakerphone mode can be controlled by the provi-
sioning interface. Both microphone and loudspeaker can be switched on or off separately. By
default, both microphone and loudspeaker are switched on.

The microphone control is not valid for OpenStage 20E, as this model has no builtin
> microphone.

WBM Name Item name Type Values Description

Mute Settings > loudspeech- Boolean true Both microphone and

Microphone ON - enabled loudspeaker are switched
Loudspeaker ON disable- Boolean false on.
microphone
Mute Settings > loudspeech- Boolean true The microphone is
Microphone OFF enabled switched off, but the loud-
- Loudspeaker disable- Boolean true speaker is switched on.
ON microphone
Mute Settings > loudspeech- Boolean false Both microphone and
Microphone OFF enabled loudspeaker are switched
- Loudspeaker disable- Boolean true off.
OFF microphone

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-126
c04.fm

Phone Parameters - Administration

General information

4.8 General information

These parameters are read only.

>
WBM Name Item name Type Values Description

MAC address mac-addr Text. 17 Shows the phone’s MAC

charac- address.
ters
Software version software- Text. Displays the version of
version Max. 20 the phone’s firmware.
charac-
ters
Last restart Not applicable. Shows date and time of
the last reboot.

4.9 Authentication

4.9.1 Change Admin password

The Admin password is a write only item, and therefore cannot be read by the pro-
> visioning server.

WBM Name Item name Type Values Description

Old / New / Con- admin-pwd String. Default: 123456 Password for the admin
firm Password Mini- section in the local menu
mum of 6 and web interface.
charac-
ters.
Maxi-
mum of
24 char-
acters.

A31003-S2000-R102-6-7620 26. August 2010

4-127 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Authentication

4.9.2 Change User password

WBM Name Item name Type Values Description

Old / New / Con- user-pwd String. Default: NULL Password for the user
firm Password Mini- section in the local menu
mum of 6 and web interface.
charac-
ters.
Maxi-
mum of
24 char-
acters.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-128
c04.fm

Phone Parameters - Administration

Ringer Setting

4.10 Ringer Setting

This function is available with firmware version V2.

>
The SIP server may provide information which indicates a specific type of call within an incom-
ing call. The relevant information is carried as a string in the SIP Alert-Info header. When this
string matches a specific string stored on the phone (the "Name" parameter), the correspond-
ing ringer is triggered. In the Asterisk dial plan (extensions.conf), this is done by the
SIPAddHeader() function. The following example line from an extensions.conf, which pre-
cedes the line containing the Dial() function, adds the specific string alert-internal to
the SIP header for a specific number pattern:
exten => _3XXX,1,SIPAddHeader("Alert-Info:alert-internal")
Thus, in this example, the value for the "Name" parameter would be "alert-internal".
The parameters for distinctive ringing are encoded as a single string within one alert item,
with ^ as separation markers. In the following example, the SIP Alert-Info header string
alert-internal selects pattern melody 7, with pattern sequence 2, a duration of 60 sec-
onds, and the sound file Ringer2.mp3:
<Item name="alert" index="1">alert-internal^7^2^60^Ringer2.mp3</Item>

WBM Name Item name Type Values Description

Name alert Text Default: NULL String to be matched for

<index> Max. 50 selecting a particular ring-
(1st value) charac- tone.
ters
Ringer sound alert Text File name Name of the file
<index> Default: NULL containing the ringer
(5th value) sound. When the value is
NULL, a pattern (ringer
melody) is used.
All OpenStage phones
support WAV and MIDI
files; OpenStage 60/80
also support MP3 files.

A31003-S2000-R102-6-7620 26. August 2010

4-129 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Ringer Setting

WBM Name Item name Type Values Description

Pattern melody / alert Integer 0=silence; Selects a ringer melody

Audible <index> 1 to 8 from a variety of 8 melo-
(2nd value) dies. When the value is 0,
there will be no audible
alert.
Pattern sequence alert Enumer- 1=1 sec ON, 4 Selects a ringer se-
<index> ation sec OFF; quence conssisting of
(3rd value) 2=1 sec ON, 2 melody patterns and si-
sec OFF; lent periods.
3=0.7 sec ON,
0.7 sec OFF, 0.7
sec ON, 3 sec
OFF;
Duration (sec) alert Integer 0 (continuous Determines how many
<index> ring); seconds the phone will
(4th value) 1 to 300 ring on an incoming call.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-130
c04.fm

Phone Parameters - Administration

Diagnostics

4.11 Diagnostics

4.11.1 Fault trace configuration

Error tracing and logging can be configured separately for all services and applications running
on the OpenStage phone. The resulting files can be viewed in the WBM web pages over the
Download links.

WBM Name Item name Type Values Description

File size (bytes) trace-file- Count 65536 to Maximum size of the

size 4194304 (i.e. trace file.
64KB to 4MB)
Default: 65536
Trace timeout trace- Integer 0 to 999 Determines when to stop
(minutes) timeout Default: 60 writing to the trace file.
When the value is 0, no
trace file will be written.
Automatic clear trace- Boolean true/false If set to true, the existing
before start autoclear Default: false trace file will be deleted
on pressing the Submit
button, and a new, empty
trace file will be generat-
ed.
Administration trace-level Enumer- 0=NONE; Deals with the changing
<index=0> ation 1=FATAL; and setting of parameters
2=ERROR; within the phone data-
3=WARNING; base, from both the user
4=LOG; and admin menus.
5=TRACE;
6=DEBUG;
Default: 0

A31003-S2000-R102-6-7620 26. August 2010

4-131 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Diagnostics

WBM Name Item name Type Values Description

Application trace-level Enumer- As with "Adminis- All applications within the

framework <index=35> ation tration" phone, e.g. Call view, Call
log or Phonebook, are run
within the application
framework. It is responsi-
ble for the switching be-
tween different applica-
tions and bringing them
into and out of focus as
appropriate.
Application menu trace-level Enumer- As with "Adminis- This is where applications
<index=5> ation tration" to be run on the phone
can be started and
stopped.
Bluetooth service trace-level Enumer- As with "Adminis- Handles the Bluetooth in-
<index=40> ation tration" teractions between exter-
nal Bluetooth devices and
the phone.
Bluetooth is available
only on OpenStage 60/80
phones.
Call Log trace-level Enumer- As with "Adminis- The Call log application
<index=1> ation tration" displays the call history of
the phone.
Call View trace-level Enumer- As with "Adminis- Handles the representa-
<index=2> ation tration" tion of telephony calls on
the phone screen.
Certificate man- trace-level Enumer- As with "Adminis- Handles the verification
agement <index=6> ation tration" and exchange of certifi-
cates for security and ver-
ification purposes.
Communications trace-level Enumer- As with "Adminis- Involved in the passing of
<index=7> ation tration" call related information
and signaling to and from
the CSTA service.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-132
c04.fm

Phone Parameters - Administration

Diagnostics

WBM Name Item name Type Values Description

Component reg- trace-level Enumer- As with "Adminis- Handles data relating to

istrar <index=8> ation tration" the type of phone, e.g.
OpenStage 20/40 HFA/
SIP, OpenStage 60/80
HFA/SIP.
CSTA service trace-level Enumer- As with "Adminis- Any CSTA messages are
<index=9> ation tration" handled by this service.
CSTA messages are
used within the phone by
all services as a common
call progression and con-
trol protocol.
Data Access ser- trace-level Enumer- As with "Adminis- Allows other services to
vice <index=10> ation tration" access the data held with-
in the phone database.
Desktop trace-level Enumer- As with "Adminis- Responsible for the
<index=36> ation tration" shared parts of the phone
display. Primarily these
are the status bar
at the top of the screen
and the FPK labels.
Digit analysis ser- trace-level Enumer- As with "Adminis- Analyses and modifies
vice index=11> ation tration" digit streams which are
sent to and received by
the phone, e. g. canonical
conversion.
Directory ser- trace-level Enumer- As with "Adminis- Performs a look up for
vice <index=13> ation tration" data in the phonebook,
trying to match incoming
and outgoing numbers
with entries in the phone-
book.
DLS client man- trace-level Enumer- As with "Adminis- Handles interactions with
agement <index=14> ation tration" the provisioning service.

A31003-S2000-R102-6-7620 26. August 2010

4-133 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Diagnostics

WBM Name Item name Type Values Description

Health service trace-level Enumer- As with "Adminis- Monitors other compo-

<index=15> ation tration" nents of the phone for di-
agnostic purposes and
provides a logging
interface for the services
in the phone.
Help trace-level Enumer- As with "Adminis- Handles the help func-
<index=4> ation tration" tion.
Instrumentation trace-level Enumer- As with "Adminis- Used by the HPT (Husim
service <index=16> ation tration" Phone Tester) to ex-
change data with the
phone for remote control,
testing, and monitoring
purposes.
Java trace-level Enumer- As with "Adminis- Any Java applications
<index=37> ation tration" running on the phone will
be run in the Java sand-
box controlled by the
Java service.
Journal service trace-level Enumer- As with "Adminis- Responsible for saving
<index=17> ation tration" and retrieving call history
information, which is used
by the Call log applica-
tion.
Media control trace-level Enumer- As with "Adminis- Provides the control of
service <index=18> ation tration" media streams (voice,
tones, ringing etc. ) within
the phone.
Media processing trace-level Enumer- As with "Adminis- This is a layer of software
service <index=19> ation tration" between the media con-
trol service, the tone
generation, and voice en-
gine services. It is also in-
volved in the switching of
audio devices such as the
handset and loudspeak-
er.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-134
c04.fm

Phone Parameters - Administration

Diagnostics

WBM Name Item name Type Values Description

Mobility service trace-level Enumer- As with "Adminis- Handles the mobility fea-
<index=20> ation tration" ture whereby users can
log onto different phones
and have them config-
ured to their own profile.
OBEX service trace-level Enumer- As with "Adminis- Involved with Bluetooth
<index=21> ation tration" accesses to the phone.
Bluetooth is available
only on OpenStage 60/80
phones.
OpenStage cli- trace-level Enumer- As with "Adminis- Provides a means by
ent management <index=22> ation tration" which other services with-
in the phone can interact
with the database.
Phonebook trace-level Enumer- As with "Adminis- Responsible for the
<index=3> ation tration" phonebook application.
POT service trace-level Enumer- As with "Adminis- Takes over control of ba-
<index=23> ation tration" sic telephony if the call-
view application fails.
Password man- trace-level Enumer- As with "Adminis- Verifies passwords used
agement service <index=24> ation tration" in the phone.
Physical interface trace-level Enumer- As with "Adminis- Handles any interactions
service <index=25> ation tration" with the phone via the
keypad, mode keys, fixed
feature buttons, click-
wheel and slider.
Service frame- trace-level Enumer- As with "Adminis- This is the environment
work <index=38> ation tration" within which other phone
services operate. It is in-
volved in the starting and
stopping of services.
Service registry trace-level Enumer- As with "Adminis- Keeps a record of all ser-
<index=39> ation tration" vices currently running in-
side the phone.
Sidecar service trace-level Enumer- As with "Adminis- Handles interactions
<index=26> ation tration" between the phone and
any attached sidecars.

A31003-S2000-R102-6-7620 26. August 2010

4-135 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Diagnostics

WBM Name Item name Type Values Description

SIP call control trace-level Enumer- As with "Adminis- Contains the call model
<index=33> ation tration" for the phone and is asso-
ciated with telephony and
call handling.
SIP messages trace-level Enumer- As with "Adminis- Traces the SIP messages
<index=34> ation tration" exchanged by the phone.
SIP signalling trace-level Enumer- As with "Adminis- Involved in the creation
<index=32> ation tration" and parsing of SIP mes-
sages. This service com-
municates directly
with the SIP stack.
Team service trace-level Enumer- As with "Adminis- Primarily concerned with
<index=27> ation tration" keyset operation.
Tone generation trace-level Enumer- As with "Adminis- Handles the generation of
service <index=28> ation tration" the tones and ringers on
the phone.
Transport service trace-level Enumer- As with "Adminis- Provides the IP (LAN) in-
<index=29> ation tration" terface between the
phone and the outside
world.
vCard parser ser- trace-level Enumer- As with "Adminis- Handles parsing and
vice <index=42> ation tration" identification of VCard in-
formation while sending
or getting VCards via
Bluetooth.
Voice engine ser- trace-level Enumer- As with "Adminis- Provides a switching
vice <index=30> ation tration" mechanism for voice
streams within the phone.
This component is also
involved in QDC, Music
on hold and voice instru-
mentation.
Voice mail trace-level Enumer- As with "Adminis- Handles the voice mail
<index=43> ation tration" functionality.
Web server ser- trace-level Enumer- As with "Adminis- Provides access to the
vice <index=31> ation tration" phone via web browser.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-136
c04.fm

Phone Parameters - Administration

Diagnostics

WBM Name Item name Type Values Description

USB backup ser- trace-level Enumer- As with "Adminis- Used to make backup/re-
vice <index=44> ation tration" store to/from USB stick by
using password. This
item is available in the
phone GUI.
Voice recognition trace-level Enumer- As with "Adminis- Used by the voice dial fa-
<index=46> ation tration" cility for recognizing spo-
ken dialing commands.
802.1x service trace-level Enumer- As with "Adminis- Provides authentication
<index=45> ation tration" to devices attached to a
LAN port, establishing a
point-to-point connection
or preventing access from
that port if authentication
fails. The service is used
for certain closed wireless
access points.

A31003-S2000-R102-6-7620 26. August 2010

4-137 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Diagnostics

4.11.2 QoS Reports

4.11.2.1 Generation
The generation of QoS (Quality of Service) reports which are sent to a QCU server (see Section
is configured here.

WBM Name Item name Type Values Description

Report mode qdc-report- Enumer- 0=OFF; Sets the conditions for

mode ation 1=EOS generating a QoS report.
Threshold ex-
ceeded;
2=EOR
Threshold ex-
ceeded;
3=EOS (End of
Session);
4=EOR (End of
Report Interval);
Default: 0
Report interval qdc-report- Integer 10 to 3600. Time interval between the
(seconds) int Value must be an periodical observations.
integer multiple of
the "Observation
interval" value,
that is, a multiple
of 10.
Default: 60
Observation in- qdc-obs-int Integer 10 (only) During this time interval,
terval (seconds) the traffic is observed.
Minimum session qdc-session Integer 0 to 255 Depending on the report
length (100 milli- Default: 20 mode, a report can be
second units) created only if the dura-
tion of the conversation
exceeds this value.
Maximum jitter qdc-jitter- Integer 0 to 255 When the jitter exceeds
(milliseconds) buffer- Default: 20 this value, a report is gen-
threshold erated.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-138
c04.fm

Phone Parameters - Administration

Diagnostics

WBM Name Item name Type Values Description

Average round qdc-delay- Integer 0 to 5000 When the average round

trip delay (milli- thresh Default: 100 trip time exceeds this
seconds) value, a report is
generated.
Non-compress- qdc-ncc- Integer 0 to 255 When the number of lost
ing codec packet-loss- Default: 10 packets exceeds this
threshold values - threshold maximum value during
Lost packets (per the observation interval, a
1000 packets) report is created.
Non-compress- qdc-ncc- Integer 0 to 255 When the number of lost
ing codec consecutive- Default: 2 packets following one an-
threshold values - packet-loss other exceeds this maxi-
Consecutive lost mum value during the ob-
packets servation interval, a
report is created.
Non-compress- qdc-ncc- Integer 0 to 255 When the number of good
ing codec consecutive- Default: 8 packets following one an-
threshold values - good-packets other falls below this min-
Consecutive imum value, a report is
good packets created.
Compressing co- qdc-cc- Integer 0 to 255 When the number of lost
dec threshold val- packet-loss- Default: 10 packets exceeds this
ues - Lost pack- threshold maximum value during
ets (per 1000 the observation interval, a
packets) report is created.
Compressing co- qdc-cc- Integer 0 to 255 When the number of lost
dec threshold val- consecutive- Default: 2 packets following one an-
ues - Consecu- packet-loss other exceeds this maxi-
tive lost packets mum value during the ob-
servation interval, a
report is created.
Compressing co- qdc-cc- Integer 0 to 255 When the number of good
dec threshold val- consecutive- Default: 8 packets following one an-
ues - Consecu- good-packets other falls below this
tive good packets sminimum value, a report
is created.

A31003-S2000-R102-6-7620 26. August 2010

4-139 Asterisk - OpenStage Family, Developer’s Guide
 c04.fm
Phone Parameters - Administration
Diagnostics

WBM Name Item name Type Values Description

Resend last re- action- Integer true/false Set to true to invoke the
port submit- Default: false action and set back to
resend-last- false on completion of
qdc-reports the action.

4.11.2.2 View Report Data

QoS reports can be viewed using the phone’s web interface. The WBM path is Diagnostics >
QoS reports > View Session Data.

4.11.3 Miscellaneous

4.11.3.1 IP tests
This area is applicable only when using the web interface.

4.11.3.2 Memory information

This area is applicable only when using the web interface.

4.11.3.3 Core dump

WBM Name Item name Type Values Description

Enable core core-dump- Boolean true/false If enabled, a core dump

dump enabled Default: true will be initiated in case of
a severe error.
File size unlimit- core-dump- Boolean true/false When set to true, there
ed file-size- Default: false is no size limit for the core
unlimited dump file.
Limited file size core-dump- Enumer- 1=1; Maximum size for core
(MBs) file-size ation 5=5; dump files in MBytes.
10=10;
25=25;
50=50;
75=75; 100=100;
Default: 100
Delete core dump Not applicable.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-140
c04.fm

Phone Parameters - Administration

Maintenance

4.12 Maintenance

4.12.1 Remote trace

This area is applicable only when using the web interface.

4.12.2 Restart phone

The regular phone restart, which retains the phone’s settings, is triggered by a special Action,
whose content is Restart. For further information, see Section 3.6.5, "Restart Phone".

4.12.3 Factory reset

This procedure resets all parameters to factory settings and reboots the phone. To start a fac-
tory reset, the Action has to be set to Restart, as with the regular phone restart. Addition-
ally, the special, fixed password must be provided in the restart-password item, and the
restart-type item must be set to FactoryReset. See the following snippet:
<Item name="restart-password">124816</Item>
<Item name="restart-type">FactoryReset</Item>

4.12.4 Secure Shell

This function is available with firmware version V2.

>
The phone’s operating system can be accessed via SSH for special troubleshooting tasks.
Hereby, the administrator, or service technician, is enabled to use the phone’s built-in Linux
commands. As soon as SSH access has been enabled using the web interface, the system can
be accessed by the user "admin" for a specified timespan.
The provisioning service can define whether it shall be possible to enable SSH access. If dis-
abled, the Secure Shell input mask will not appear on the web interface.

WBM Name Item name Type Values Description

Secure Shell ssh-enable- Boolean true/false Determines whether SSH

allowed Default: true access can be enabled.

A31003-S2000-R102-6-7620 26. August 2010

4-141 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Date and Time

4 Phone Parameters - User

4.1 Date and Time

WBM Name Item name Type Values Description

Local time / Local time Numeric Unix Time Stamp Sets time and date, if not
date (day, month, provided by SNTP.
year) The Unix Time Stamp is
the number of seconds
elapsed since January
1st.
In messages from the
phone, 000 is appended
to the Unix Time Stamp
as the milliseconds part;
this part can be ignored.
Use daylight sav- daylight- Boolean true/false Enables or disables day-
ing save Default: false light saving time in con-
junction with Auto time
change.
Auto time change auto- Boolean true/false Enables or disables auto-
daylight- Default: false matic control of daylight
save saving time according to
the Time zone.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-64
c05.fm

Phone Parameters - User

Audio

4.2 Audio

WBM Name Item name Type Values Description

Ringer melody ringer- Enumer- 1 to 8 Selects a melody for the

melody ation Default: 2 ringer.
Ringer tone se- ringer-tone- Enumer- 1=1.0 seconds Defines the lengths of sin-
quence sequence ation ON, 4.0 seconds gular rings and the length
OFF; of pauses in between.
2=1.0 seconds
ON, 2.0 seconds
OFF;
3=0.7 seconds
ON, 0.7 seconds
OFF, 0.7 seconds
ON, 3.0 seconds
OFF;
Default: 2
Ring file ringer- Text Default: NULL Name of the ringtone file
audio-file to be used (WAV or, on
OpenStage 60/80, MP3).
Room Character Not applicable.
Open listening loudspeaker- Enumer- 0=Standard Country-specific setting
function- ation mode; for speakerphone mode.
mode 1=US mode;
Default: 1 if
Country = USA;
else 0

Headset socket socketed- Enumer- 0=Wired head- Type of headset resp.

headset-mode ation set=0; conference unit connect-
1=Cordless ed to the phone.
headset;
2=Conference
unit

A31003-S2000-R102-6-7620 26. August 2010

4-65 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Configuration

4.3 Configuration

4.3.1 Outgoing calls

WBM Name Item name Type Values Description

Autodial delay autodialtimer Integer 1 to 9 After this delay, which

(seconds) Default: 6 follows the last digit en-
tered, a number is di-
aled.
Allow callback: callback-busy- Boolean true/false Permits sending a call-
busy enabled Default: true back request to the
server when the user is
busy.
Allow callback: callback-ring- Boolean true/false Permits sending a call-
no reply enabled Default: true back request to the
server when the user
does not answer the
call.
Allow busy when busy-when- Boolean true/false If enabled, the phone
dialling dialling- Default: false switches to busy state
enabled when the user starts
dialing.
Allow transfer on call-join- Boolean true/false If enabled, it is possible
ring enabled Default: true to transfer a call to an-
other party without any
previous consultation
with this party.

4.3.2 Incoming calls

4.3.2.1 Deflecting

WBM Name Item name Type Values Description

Allow deflection call- Boolean true/false If enabled, the user can

deflection- Default: true deflect an incoming call.
enabled

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-66
c05.fm

Phone Parameters - User

Configuration

WBM Name Item name Type Values Description

Default deflect deflect- Text Default: NULL Target for deflected calls.
destination destination
Deflect to DSS dss-sip- Boolean true/false If enabled, a call can be
deflect Default: false deflected to a DSS num-
ber using the DSS key.

4.3.2.2 Forwarding

WBM Name Item name Type Values Description

Forwarding default- Text Default: NULL First forwarding destina-

Favourites - forwarding-1 tion.
Destination 1
Forwarding default- Text Default: NULL Second forwarding desti-
Favourites - forwarding-2 nation.
Destination 2
Forwarding default- Text Default: NULL Third forwarding destina-
Favourites - forwarding-3 tion.
Destination 3
Forwarding default- Text Default: NULL Fourth forwarding desti-
Favourites - forwarding-4 nation.
Destination 4
Forwarding default- Text Default: NULL Fifth forwarding destina-
Favourites - forwarding-5 tion.
Destination 5
Forward all calls cfu- Boolean true/false Allows unconditional for-
allowed activated Default: false warding.
to cfu-address Text Default: NULL Forward destination if
Forward all calls is active.
Forward on busy cfb- Boolean true/false Allows forwarding in case
allowed activated Default: false the user is engaged in an-
other call.
to cfb-address Text Default: NULL Forward destination if
Forward on busy is active.
Forward on no re- cfnr- Boolean true/false Allows forwarding in case
ply allowed activated Default: false the user does not reply.

A31003-S2000-R102-6-7620 26. August 2010

4-67 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Configuration

WBM Name Item name Type Values Description

to cfnr-address Text Default: NULL Forward destination if

Forward on nor reply is
active.
No reply delay cfnr-delay Integer 1 to 60 After this delay, the call
(seconds) Default: 16 will be forwarded, if the
user does not reply.
Visual alerts forwarding- Boolean true/false If true, prompts and
notification Default: true popups will provide full in-
-visual formation about parties
involved during the for-
warding. If false, only
information about ringing
and connected parties is
shown.
Audible alerts forwarding- Boolean true/false Enable or disable audible
notification Default: true alerts for call forwarding.
-audible
Forwarding party forwarding- Enumer- 0 = Display first; For incoming calls that
party- ation 1 = Display last have been forwarded by
display two or more parties, this
parameter determines
whether the first or the
last forwarding party is in-
dicated.
Available with firmware
version V2.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-68
c05.fm

Phone Parameters - User

Configuration

4.3.2.3 Handling

WBM Name Item name Type Values Description

Allow call waiting call- Boolean true/false If set to true, the user
waiting- Default: true can accept a second in-
enabled coming call in the course
of an ongoing call.
Allow DND call-dnd- Boolean true/false If set to true, the phone
enabled Default: true will not ring, and the caller
hears the busy signal.
Allow busy when busy-when- Boolean true/false If set to true, an incom-
dialling dialling- Default: false ing call received while the
enabled user is dialing is rejected.

A31003-S2000-R102-6-7620 26. August 2010

4-69 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Configuration

4.3.2.4 CTI calls

WBM Name Item name Type Values Description

Allow auto-an- auto-answer Boolean true/false If set to true, calls are

swer Default: false accepted and set up auto-
matically.
Allow beep on beep-on- Boolean true/false If set to true, an alert
auto-answer auto-answer Default: false beep sounds when a call
is automatically accepted.
auto- Boolean true/false If set to true, the user
reconnect Default: false can resume a held call
with either the CTI appli-
cation or phone.
Allow beep on beep-on- Boolean true/false If set to true, a beep
auto-reconnect auto- Default: false sounds when the user
reconnect toggles between an ac-
tive call and a held call.

4.3.3 Connected calls

WBM Name Item name Type Values Description

Allow call transfer call- Boolean true/false If set to true, call transfer
transfer- Default: true is enabled.
enabled
Allow call joining call-join- Boolean true/false If set to true, the user
enabled Default: true can join the first party with
the consulted party.
Allow exit confer- join- Boolean true/false Determines whether or
ence allowed-in- Default: false not the user’s call part-
conference ners are allowed to join
calls after the user has
exited the conference
call.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-70
c05.fm

Phone Parameters - User

Configuration

WBM Name Item name Type Values Description

Allow hold re- call-hold- Boolean true/false If set to true, the user
minder ringback- Default: true will be reminded that
enabled there is a call on hold after
a specified timespan.
Hold reminder holdringback Integer 3 to 15 Timespan, after which the
delay (minutes) -timer Default: 3 user will be reminded that
there is a call on hold.
Allow music on moh-enabled Boolean true/false Music is played back to
hold Default: true the user when the user is
placed on hold by another
party.
Allow conferenc- user- Boolean true/false Enables or disables local
es conference- Default: true conferences.
enabled
Allow secure call secure-call- Boolean true/false If set to true, an alert
alert alert Default: false tone will sound when the
voice connection chang-
es from secure to inse-
cure.
Toggle associate implicit- Boolean true/false When set to true, the fol-
call- Default: false lowing procedure will en-
association sue: The user has accept-
ed a second call, whereby
the first call is put to hold.
As soon as the user has
alternated back to the first
call, and then again to the
second call, he/she can
connect both calling par-
ties by going on-hook.
Available with firmware
version V2.

A31003-S2000-R102-6-7620 26. August 2010

4-71 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Configuration

4.3.4 Context menu

WBM Name Item name Type Values Description

Auto Show menu context- Boolean true/false When set to true, the con-
menu-auto- Default: true text menu for call han-
show dling will open automati-
cally as soon as a call is
established.
Relevant for OpenStage
40/60/80.
Available with firmware
version V2R1.
Auto hide time context- Enumer- 5=5; Timeout in seconds after
(sec.) menu-auto- ation 10=10; which the automatically
hide-time 20=20; opened context menu will
30=30; disappear.
60=60; Relevant for OpenStage
120=120; 40/60/80.
No auto Available with firmware
hide=context version V2R1.
menu will stay
open

4.3.5 Bluetooth

WBM Name Item name Type Values Description

Device address bt-local-bda Text. Same format as Bluetooth address of the

Char(17). MAC address phone. This value is read
only. OpenStage 60/80
only.
Phone name Not applicable
Status Not applicable
Active Not applicable
Discoverable Not applicable
Pairing mode Not applicable
PIN for pairing Not applicable

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-72
c05.fm

Phone Parameters - User

Configuration

WBM Name Item name Type Values Description

Last connected Not applicable

device - Device
address
Last connected Not applicable
device - Device
name
Last connected Not applicable
device - Device
class

A31003-S2000-R102-6-7620 26. August 2010

4-73 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Phone

4.4 Phone

4.4.1 Display

WBM Name Item name Type Values Description

Slider brightness Not applicable

Sidecar contrast Not applicable
Touchguide Not applicable
Skin display-skin Enumer- 0=Crystal Sea; Select the style for the
ation 1=Warm Grey; graphical display.
Default: 0

4.4.2 Screensaver

WBM Name Item name Type Values Description

Screensaver en- screensaver- Boolean true/false Enables or disables the

abled enabled Default: false screensaver.
OpenStage 60/80 only.
Start (minutes) inactivity- Enumer- 0=0 (no timeout); When there has been no
timeout ation 5=5; activity on the phone for
10=10; this timespan, the screen-
20=20; saver will start.
30=30; OpenStage 60/80 only.
60=60;
Default: 5
Transition delay screensaver- Enumer- Number of sec- Sets the intervals at
image- ation onds. which the screensaver
timeout 5=5; images change.
10=10; OpenStage 60/80 only.
20=20;
30=30;
60=60;
Default: 10

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-74
c05.fm

Phone Parameters - User

Phone

4.4.3 Program Keys

See Section 4.3.5.2, "Free Programmable Keys (FPK)".

4.4.4 Key Module 1

The settings for the first key module are the same as those for programmable keys on the
phone (see Section 4.3.5.2, "Free Programmable Keys (FPK)").
For the first key module, the key numbers represented by the index attribute are 301 to 312
for the first level, and 1301 to 1312 for the shift level.

4.4.5 Key Module 2

The settings for the second key module are the same as those for programmable keys on the
phone (see Section 4.3.5.2, "Free Programmable Keys (FPK)").
For the second key module, the key numbers represented by the index attribute are 401 to
412 for the first level, and 1401 to 1412 for the shift level.

4.4.6 OpenStage 15 Key Module

The settings for the key module 15 are the same as those for programmable keys on the phone
(see Section 4.3.5.2, "Free Programmable Keys (FPK)").
For this key module, the key numbers represented by the index attribute are 501 to 518 for
the first level, and 1501 to 1518 for the shift level.

A31003-S2000-R102-6-7620 26. August 2010

4-75 Asterisk - OpenStage Family, Developer’s Guide
 c05.fm
Phone Parameters - User
Locality

4.5 Locality

WBM Name Item name Type Values Description

Country country-iso 2 charac- See Section 6.2, Country wherein the

ter string "Country codes" phone resides.
Default: GB
Language language-iso 2 charac- See Section 6.3, Language for the user in-
ter string "Language terface.
Codes"
Default: en
Date format date-format Enumer- 0=DD.MM.YYYY; Display format for the cur-
ation 1=YYYY-MM-DD; rent date.
2=MM/DD/YYYY;
Default: 0
Time format time-format Enumer- 0=24 hour; Display format for the cur-
ation 1=12 hour (i.e. rent time.
with AM/PM or
language vari-
ants);
Default: 0

4.6 Authentication
See Section 4.9.2, "Change User password".

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 4-76
c05.fm

Phone Parameters - User

Authentication

A31003-S2000-R102-6-7620 26. August 2010

4-77 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
Provisioning Service Related

5 Phone Parameters - Provisioning

In this section, those parameters are listed which are neither configurable via local/web inter-
face nor associated with parameters configurable via local/web interface.

5.1 Provisioning Service Related

Item name Type Values Description

dcmp-enable Boolean true/false Determines whether the phone shall

Default: false wait for contact-me messages from
the provisioning service, or poll the
provisioning service resp. a special
proxy for new configuration data. For
further information, please refer to
Section 1.3.2, "Firewall And NAT".
dcmp-url Text (URL) Complete URL, port Relevant if dcmp-enable is set to
included true. The phone will poll this URL
Default: NULL for new configuration data.
dcmp-interval Integer 1 to 1440 (minutes) Relevant if dcmp-enable is set to
true. The phone will poll the provi-
sioning service resp. the proxy
periodically using this time interval.

5.2 Phone Specific, Hardware Related

Item name Type Values Description

related- Text. OpenStage 15; Sent to the provisioning service to

device-type Max. 50 OpenStage 20E; identify the phone variant. Value is
characters OpenStage 20; read only. The value is built up dur-
OpenStage 40; ing phone start up, querying the
OpenStage 60; hardware variant.
OpenStage 80

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-78
c06.fm

Phone Parameters - Provisioning

Phone Specific, Hardware Related

Item name Type Values Description

device-type Text. OpenStage 15; Sent to the provisioning service to

Max. 50 OpenStage 20E; identify phone variant. Value is read
characters OpenStage 20; only. Displayed in the web page ban-
OpenStage 40; ner. The value is built up during
OpenStage 60; phone start up, querying hardware
OpenStage 80 variant.
gigabit- Boolean true/false Sent to the provisioning service to
ethernet-en- identify valid LAN port configuration
abled values. Value is read only.
related- Text. Siemens SIP [SIP] Sent to the priovisioning service to
software-type Max. 30 identify phone software type. Value
characters is read only.
software-type Text. Siemens SIP Sent to the priovisioning service to
Max. 30 [SIP]; identify phone software type. Value
characters Siemens HFA is read only.
[HFA];

part-number Text. Sent to the priovisioning service in

Max. 25 inventory information. Value is read
characters only.
slk-modules Integer For OpenStage 20E Number of OpenStage Key Mod-
and OpenStage 20, ules. Sent to the provisioning service
the value is always in "ReadAllItems" message re-
0. sponse. Value is read only.
For OpenStage 15,
the value may be 0
or 1.
For OpenStage 40
to 80, the value may
be 0, 1 or 2.
blf-modules Integer For OpenStage SIP Number of BLF Modules. Sent to the
phones, the value is provisioning service in
always 0. "ReadAllItems" message response.
Value is read only.

A31003-S2000-R102-6-7620 26. August 2010

5-79 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
Phone Specific, Hardware Related

Item name Type Values Description

km15-modules Integer For OpenStage 10/ Number of OpenStage Key

20/60/80, the value Modules 15. Sent to the provisioning
is always 0. For service in "ReadAllItems" message
OpenStage 15/40, response. Value is read only.
the value may be 0 Available with firmware version V2.
or 1.
slk-module-1- Text Default: NULL Sent to the provisioning service in
hardware the "ReadAllItems" message re-
or sponse for each SLK key unit con-
slk-module-2- nected to phone. Not applicable for a
hardware. BLF key module unit. Value is read
only.
slk-module-1- Text. Default: NULL Software version of the SLK module.
version Max. 7 Sent to the provisioning service in
or characters "ReadAllItems" message response
slk-module-2- for each SLK key unit connected to
version phone. Not applicable for a BLF key
module unit. Value is read only.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-80
c06.fm

Phone Parameters - Provisioning

Network/DNS

5.3 Network/DNS

Item name Type Values Description

e164-hostname Boolean true/false If activated, the E.164 number is

Default: true used as the DNS host name for the
phone.

5.4 802.1x Security

Item name Type Values Description

802.1x- Enumera- 001= EAP-TLS; Type of 802.1x authentication.

authentication tion 002= PEAP;
003= EAP-TTLS
with digest/OTP;
004= EAP-TTLS
with MSCHAP;
005= EAP-FAST;
099= None;
255 = respond to all
types of challenge
where related cre-
dentials have been
installed;
Default: 255
radius-server- Boolean true/false If true, the certificate sent by the
validation Default: true RADIUS Server during the EAP-TLS
handshake is validated against the
CA certificates installed on the
phone. If false, this check is omit-
ted.
mschap- Text Default: NULL (For future)
identity Device name for MSCHAP-V2 when
using 802.1x authentication
methods PEAP or EAP-TTLS.

A31003-S2000-R102-6-7620 26. August 2010

5-81 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
USB

Item name Type Values Description

mschap-pw Text Default: NULL (For future)

Device password for MSCHAP-V2
when using 802.1x authentication
methods PEAP or EAP-TTLS. Re-
quires encrypted storage.
eap-ttls- Text Default: NULL (For future)
digest Digest for MD5 challenge when us-
ing 802.1x authentication method
EAP-TTLS.
eap-ttls-otp Text Default: NULL (For future)
One time password when using
802.1x authentication method
EAPTTLS.
eap-fastsecret Text Default: NULL (For future)
Shared secret when using 802.1x
authentication method EAP-FAST.

5.5 USB

Item name Type Values Description

usb-access- Boolean true/false Allows USB access (for all purpos-

enabled Default: true es) to be enabled or disabled from a
security perspective.
usb-backup- Boolean true/false Allows user data backup to a USB
enabled Default: true device and allows such backup data
to be restored.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-82
c06.fm

Phone Parameters - Provisioning

SIP/System

5.6 SIP/System

Item name Type Values Description

sgnl-route Enumera- 0=Server; SIP routing method.

tion 1=Gateway (not
supported current-
ly);
2=Direct (not sup-
ported currently),
Default: 0

5.7 Audio

Item name Type Values Description

line-rollover- Integer 1 to 8 Volume of the line rollover tone. Can

volume Default: 2 be adjusted by the user via the local
menu.

5.8 Feature Keys

Item name Type Values Description

locked- Boolean true/false If true, the provisioning service has

function-key Default: false locked down the key specified by the
<index> index. The assigned function and
any associated parameters cannot
be modified, neither by the user nor
Administrator, nor can the key be
moved.
locked-config- Boolean true/false If true, the function resp. menus
menus-<n> Default: false specified by <n> is locked for user
configuration. For details, please re-
fer to Section 6.4, "Locked Configu-
ration Menus".

A31003-S2000-R102-6-7620 26. August 2010

5-83 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
Passwords

5.9 Passwords

Item name Type Values Description

min-admin- Integer 6 to 24 Minimum length of the administrator

passw-length password.
min-user- Integer 6 to 24 Minimum length of the user pass-
passw-length word.

5.10 Provisioning Service Communication

Item name Type Values Description

dls-chunk-size Integer Default: 5492 Chunk size for transferring profile

data to/from the provisioning ser-
vice. When the XML message ex-
ceeds this size, the message is split
into fragments.

5.11 LDAP

Item name Type Values Description

ldap-transport Enumera- 0=TCP; Transport protocol for LDAP. Cur-

tion 1=TLS; rently, only TCP is supported.
Default: 0

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-84
c06.fm

Phone Parameters - Provisioning

Certificates

5.12 Certificates

Item name Type Values Description

application- PEM file Note: If the XML For HTTPS access to one or more
server-ca (single cer- item received from application servers (XML applica-
<index=0> tificate or the provisioning ser- tions). This certificate enables the
certificate vice is empty, the phone to verify the authenticity of an
chain) corresponding cer- application server. Certificates in the
tificate at the phone configuration item replace existing
will be deleted. certificates.
application- PEM file Note: If the XML To support transition in case the cer-
server-ca (single cer- item received from tificate on the application server
<index=1> tificate or the provisioning ser- should change to a certificate signed
certificate vice is empty, the by a new CA.
chain) corresponding cer-
tificate at the phone
will be deleted.
wbm-server- Pass- Note: If the XML For secure communication with
certificate phrase pro- item received from phone's web server. The optional
tected the provisioning ser- certificate is available for the Web
PKCS#12 vice is empty, the Browser to import. Also used for the
file (single corresponding cer- HTTPS connection with the provi-
certificate + tificate at the phone sioning service when listening for
private key will be deleted. contact-me requests.
+ optional
certificate of
signing CA
wbm-server- PEM file Note: If the XML Created from wbm-server-cer-
certificate- (single cer- item received from tificate (removing private key
info tificate) the provisioning ser- and optional CA certificate).
vice is empty, the
corresponding cer-
tificate at the phone
will be deleted.

A31003-S2000-R102-6-7620 26. August 2010

5-85 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
Certificates

Item name Type Values Description

voip-server-ca PEM file Note: If the XML SIP server CA certificate, used to se-
<index=0> (single cer- item received from cure TLS interface with SIP server.
tificate or the provisioning ser-
certificate vice is empty, the
chain) corresponding cer-
tificate at the phone
will be deleted.
voip-server-ca PEM file Note: If the XML Next server CA certificate, to support
<index=1> (single cer- item received from transition in case the certificate on
tificate or the provisioning ser- the SIP server should change to a
certificate vice is empty, the certificate signed by a new CA.
chain) corresponding cer-
tificate at the phone
will be deleted.
802.1x- Pass- Note: If the XML RADIUS supplicant credentials, for
certificate phrase pro- item received from 802.1x network access (using EAP-
tected the provisioning ser- TLS). Used to authenticate the
PKCS#12 vice is empty, the phone to RADIUS server. The certif-
file (single corresponding cer- icate subject has to match the ac-
certificate + tificate at the phone count for the phone in the authenti-
private key) will be deleted. cation server with which the RADIUS
server interacts.
802.1x-certif- PEM file Note: If the XML RADIUS supplicant certificate. Cre-
icate-info (single cer- item received from ated from 802.1x-certificate (remov-
tificate) the provisioning ser- ing private key).
vice is empty, this
means delete the
corresponding cer-
tificate at the phone.
radius-server- PEM file Note: If the XML Current RADIUS server CA certifi-
ca1 (single cer- item received from cate. For 802.1x network access
tificate or the provisioning ser- (using EAP-TLS, PEAP or EAP-
certificate vice is empty, this TTLS). To allow phone to verify cer-
chain means delete the tificate received from RADIUS serv-
corresponding cer- er. Stored as encrypted within DAS
tificate at the phone. only. Certificate Management knows
the decryption key.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-86
c06.fm

Phone Parameters - Provisioning

Certificates

Item name Type Values Description

radius-server- PEM file Note: If the XML Next RADIUS server CA certificate,
ca2 (single cer- item received from to support transition in case the cer-
tificate or the provisioning ser- tificate on the RADIUS server should
certificate vice is empty, this change toa certificate signed by a
chain means delete the new CA.
corresponding cer-
tificate at the phone.
send-url- PEM file Note: If the XML First certificate to enable a secure
server-ca[0] (single cer- item received from connection with the web server
tificate or the provisioning ser- specified for the "send URL" function
certificate vice is empty, this (see Section 4.3.5.2, "Send URL").
chain means delete the Available with firmware version V2.
corresponding cer-
tificate at the phone.
send-url- PEM file Note: If the XML Second certificate to enable a se-
server-ca[1] (single cer- item received from cure connection with the web server
tificate or the provisioning ser- specified for the "send URL" function
certificate vice is empty, this (see Section 4.3.5.2, "Send URL").
chain means delete the Available with firmware version V2.
corresponding cer-
tificate at the phone.
send-url- PEM file Note: If the XML Third certificate to enable a secure
server-ca[2] (single cer- item received from connection with the web server
tificate or the provisioning ser- specified for the "send URL" function
certificate vice is empty, this (see Section 4.3.5.2, "Send URL").
chain means delete the Available with firmware version V2.
corresponding cer-
tificate at the phone.

A31003-S2000-R102-6-7620 26. August 2010

5-87 Asterisk - OpenStage Family, Developer’s Guide
 c06.fm
Phone Parameters - Provisioning
Call Log

5.13 Call Log

Item name Type Values Description

clear-calllog Boolean true/false When the phone receives this pa-

Default: false rameter with the value set to true,
the call log will be deleted. In case
the value should be set to false,
the phone will ignore the parameter.
On a read request from the provi-
sioning server, the phone will always
return false.
Available with firmware version
V2R1.

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 5-88
c06.fm

Phone Parameters - Provisioning

Call Log

A31003-S2000-R102-6-7620 26. August 2010

5-89 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
XML Schemas

6 Appendix

6.1 XML Schemas

This sections provides the XML schemas to be associated with the message structures de-
scribed in Section 3, "Basic Communication Procedures".

6.1.1 Common Message Elements

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:dls="http://www.siemens.com/DLS"
targetNamespace="http://www.siemens.com/DLS"
elementFormDefault="qualified">
<xsd:annotation>
<xsd:documentation xml:lang="en">
Common types
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType name="ActionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ReadAllItems"/>
<xsd:enumeration value="ReadItems"/>
<xsd:enumeration value="WriteItems"/>
<xsd:enumeration value="Restart"/>
<xsd:enumeration value="FileDeployment"/>
<xsd:enumeration value="SoftwareDeployment"/>
<xsd:enumeration value="CleanUp"/>
<xsd:enumeration value="GetNextFragment"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="FragmentType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="next"/>
<xsd:enumeration value="final"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="ItemListType">
<xsd:sequence>
<xsd:element name="Item" type="dls:ItemType" nillable="true"
minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-90
c07.fm

Appendix
XML Schemas

<xsd:complexType name="ItemType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="name" type="xsd:string"/>
<xsd:attribute name="index" type="xsd:string"
use="optional"/>
<xsd:attribute name="type" type="xsd:string"
use="optional"/>
<xsd:attribute name="status" type="xsd:string"
use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:schema>

A31003-S2000-R102-6-7620 26. August 2010

6-91 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
XML Schemas

6.1.2 Phone Message

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:dls="http://www.siemens.com/DLS"
targetNamespace="http://www.siemens.com/DLS"
elementFormDefault="qualified">
<xsd:annotation>
<xsd:documentation xml:lang="en">
DLS upstream schema
</xsd:documentation>
</xsd:annotation>
<xsd:include schemaLocation="common.xsd"/>
<xsd:element name="WorkpointMessage"
type="dls:WorkpointMessageType" />
<xsd:complexType name="WorkpointMessageType">
<xsd:sequence>
<xsd:element name="Message" type="dls:WPMessageType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="WPMessageType">
<xsd:sequence>
<xsd:element name="ReasonForContact"
type="dls:ReasonForContactType"/>
<xsd:element name="ItemList" type="dls:ItemListType"
minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="nonce" type="xsd:hexBinary"/>
<xsd:attribute name="maxItems" type="xsd:int" use="optional"/>
<xsd:attribute name="fragment" type="dls:FragmentType"
use="optional"/>
</xsd:complexType>
<xsd:complexType name="ReasonForContactType">
<xsd:simpleContent>
<xsd:extension base="dls:ReasonType">
<xsd:attribute name="action" type="dls:ActionType"
use="optional"/>
<xsd:attribute name="status" type="dls:StatusType"
use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:simpleType name="ReasonType">
<xsd:restriction base="xsd:string">

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-92
c07.fm

Appendix
XML Schemas

<xsd:enumeration value="start-up"/>
<xsd:enumeration value="local-changes"/>
<xsd:enumeration value="inventory-changes"/>
<xsd:enumeration value="status"/>
<xsd:enumeration value="solicited"/>
<xsd:enumeration value="reply-to"/>
<xsd:enumeration value="clean-up"/>
<xsd:enumeration value="get-next-fragment"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="StatusType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="accepted"/>
<xsd:enumeration value="failed"/>
<xsd:enumeration value="busy"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>

A31003-S2000-R102-6-7620 26. August 2010

6-93 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
XML Schemas

6.1.3 Provisioning Service Message

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:dls="http://www.siemens.com/DLS"
targetNamespace="http://www.siemens.com/DLS"
elementFormDefault="qualified">
<xsd:annotation>
<xsd:documentation xml:lang="en">
DLS downstream schema
</xsd:documentation>
</xsd:annotation>
<xsd:include schemaLocation="common.xsd"/>
<xsd:element name="DLSMessage" type="dls:DLSMessageType"/>
<xsd:complexType name="DLSMessageType">
<xsd:sequence>
<xsd:element name="Message" type="dls:MessageType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="MessageType">
<xsd:sequence>
<xsd:element name="Action" type="dls:ActionClass"/>
<xsd:element name="ItemList" type="dls:ItemListType"
minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="nonce" type="xsd:hexBinary"/>
<xsd:attribute name="fragment" type="dls:FragmentType"
use="optional"/>
</xsd:complexType>
<xsd:complexType name="ActionClass">
<xsd:simpleContent>
<xsd:extension base="dls:ActionType">
<xsd:attribute name="status"
type="dls:ActionStatusType" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:simpleType name="ActionStatusType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ambiguous-phone-number"/>
<xsd:enumeration value="reg-addr-undefined"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-94
c07.fm

Appendix
Country codes

6.2 Country codes

• Argentina - AR
• Australia - AU
• Austria - AT
• Belgium - BE
• Brazil - BR
• Canada - CA
• Chile - CL
• China - CN
• Croatia - HR
• Czech Republic - CZ
• Denmark - DK
• Finland - FI
• France - FR
• Germany - DE
• Hungary - HU
• India - IN
• Ireland - IE
• Italy - IT
• Japan - JP
• Luxembourg - LU
• Mexico - MX
• Netherlands - NL
• New Zealand - NZ
• Norway - NO
• Poland - PL
• Portugal - PT
• Russian Federation - RU

A31003-S2000-R102-6-7620 26. August 2010

6-95 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
Language Codes

• Singapore - SG
• Slovakia - SK
• South Africa - ZA
• Spain - ES
• Sweden - SE
• Switzerland - CH
• Thailand - TH
• Turkey - TR
• United Kingdom - GB
• United States - US

6.3 Language Codes

• Brazilian (= Portuguese) - pt_Br
• Bulgarian - bg
• Catalan - ca
• Chinese - zh
• Croatian - hr
• Czech - cs
• Danish - da
• Dutch - nl
• English (GB) - en (will be interpreted as en-GB)
• English (GB) - en-GB
• English (US) - en-US
• Estonian - et
• Finnish - fi
• French - fr
• German - de
• Greek - el
• Hungarian - hu

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-96
c07.fm

Appendix
Locked Configuration Menus

• Indonesian - id
• Italian - it
• Japanese - ja
• Latvian - lv
• Lithuanian - lt
• Macedonian - mk
• Malayan - ms
• Norwegian - no
• Polish - pl
• Portuguese - pt
• Romanian - ro
• Russian (Cyrillic characters) - ru
• Serbian (Cyrillic characters) - sr_Ctyl
• Serbian (Latin characters) - sr_Latn
• Slovak - sk
• Slovenian - sl
• Spanish - es
• Swedish - sv
• Turkish - tr

6.4 Locked Configuration Menus

The following functions resp. menus can be locked, so that the user can not modify the settings.

6.4.1 Locale

Feature/Menu Item name Description

Country options locked-config- Select a country from a list to adapt the phone to
menus-01 country specific conditions.
Language locked-config- Set the language for the user menu.
menus-02

A31003-S2000-R102-6-7620 26. August 2010

6-97 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
Locked Configuration Menus

6.4.2 Display Settings

Feature/Menu Item name Description

Display Skin locked-config- Choose the display theme.
menus-65
Screen Saver locked-config- Activate and configure the phones’s screensaver.
menus-66
Call context menu locked-config- Control the behaviour of the call context menu.
menus-67

6.4.3 Clock Settings

Feature/Menu Item name Description

Date display format locked-config- Select date and time format.
menus-03
Daylight saving locked-config- Enable and configure daylight saving.
menus-14

6.4.4 Telephony Features

Feature/Menu Item name Description

Auto answer locked-config- Enable auto answer.
menus-32
Auto answer beep locked-config- Enable beep on auto answer.
menus-33
Auto reconnect locked-config- Enable auto reconnect.
menus-34
Auto reconnect locked-config- Enable beep on auto reconnect.
beep menus-35
Transfer on hangup locked-config- Enable transfer on hangup.
menus-57
Join in conference locked-config- Allow joining in a conference.
menus-63
Immediate dialling locked-config- Allow immediate dialling.
(hot keypad dialling) menus-48

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-98
c07.fm

Appendix
Locked Configuration Menus

Feature/Menu Item name Description

Call Deflection locked-config- Allow call deflection.
menus-04
Call Waiting locked-config- Allow call waiting.
menus-08
Call Transfer locked-config- Allow call transfer.
menus-09
Transfer on ring locked-config- Enable transfer on ring.
menus-53
Call Join locked-config- Enable call joining.
menus-10
Do Not Disturb locked-config- Enable Do Not Disturb (DND).
menus-19
Hold Ringback locked-config- Enable ringback for calls on hold.
menus-21
Busy when dialling locked-config- When enabled, the phone will send a busy signal
menus-52 to any calling party when the user is dialling.
Call back busy locked-config- Enable a callback request when the callee is busy.
menus-49
Call back on ring/no locked-config- Enable a callback request when the callee does
reply menus-50 not reply.
User conferencing locked-config- Enable local conferences.
enabled menus-23
Autodial timer locked-config- Configure the auto dial timer.
menus-15
Call Forwarding on locked-config- Set the delay for call forwarding on no reply.
No Reply delay menus-16
Hold Ringback timer locked-config- Set the time interval after which the user will be re-
(minutes) menus-17 minded of a held call.
Open Listening au- locked-config- Enable loudspeaker for open listening.
dio mode menus-61
Deflect default desti- locked-config- Set the default address for call deflection.
nation URI menus-43
Indication of for- locked-config- Enable a visual and acoustic alert when a call is
warded calls menus-62 being forwarded.
Secure call alert en- locked-config- Enable an alert on insecure calls.
abled menus-56

A31003-S2000-R102-6-7620 26. August 2010

6-99 Asterisk - OpenStage Family, Developer’s Guide
 c07.fm
Appendix
Locked Configuration Menus

Feature/Menu Item name Description

Call Forwarding locked-config- Control and configure call fowarding.
menus-05

6.4.5 Audio Settings

Feature/Menu Item name Description

Ringer locked-config- Set melody, tone sequence, and audio file for the
menus-60 ringer.
Music on Hold locked-config- Enable music on hold.
(MoH) menus-18

6.4.6 Busy Lamp Fields (BLF)

Feature/Menu Item name Description

BLF alert locked-config- Enable an audible and visible alert on an incoming
menus-68 call for the call number supervised by the BLF key.

6.4.7 Passwords

Feature/Menu Item name Description

Set user password locked-local- Set/modify the user password.
function-
menus-02

6.4.8 Phone Lock

Feature/Menu Item name Description

Phone lock locked-local- Lock the phone.
function-
menus-03

26. August 2010

Asterisk - OpenStage Family, Developer’s Guide 6-100
c07.fm

Appendix
Glossary

6.4.9 Bluetooth Settings

Feature/Menu Item name Description

Bluetooth locked-config- Control and configure Bluetooth.
menus-64

6.4.10 Call Recordings Settings

Feature/Menu Item name Description

Call recording locked-config- Control and configure call recording.
menus-55

6.5 Glossary

Term/Abbreviation Definition/Description
HTTP HyperText Transport Protocol. Used for contact-me messages
issued by the provisioning service.
HTTPS Hypertext Transfer Protocol over Secure Socket Layer. Used for
XML data exchange between provisioning service and
OpenStage phones.
SIP Session Initiation Protocol. Used for call signaling by
OpenStage phones.
TCP Transport Communication Protocol. Underlying protocol for
HTTP.
TLS Transport Layer Security. Used as a security layer between TCP
and HTTP to form HTTPS.
URI Universal Resource Indicator.
URL Universal Resource Locator.
VoIP Voice over IP. Implementation of telephony using IP networks
instead of traditional technologies applied in the PSTN.
WBM Web Based Management. Web interface for configuring the
phone. It is used via a standard web browser.
XML EXtensible Markup Language.

A31003-S2000-R102-6-7620 26. August 2010

6-101 Asterisk - OpenStage Family, Developer’s Guide