BroadSoft Partner Configuration Guide Gigaset Maxwell 10

BroadSoft Partner Configuration Guide
Gigaset Maxwell 10
June 2017
Document Version 1.4
9737 Washingtonian Boulevard, Suite 350
Gaithersburg, MD USA 20878
Tel +1 301.977.9440
WWW.BROADSOFT.COM
BroadWorks® Guide
Copyright Notice
Copyright© 2017 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and
confidential and is considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only. No
part of this publication may be duplicated without the express written permission of
BroadSoft, Inc., 9737 Washingtonian Boulevard, Suite 350, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.
Trademarks
Any product names mentioned in this document may be trademarks or registered
trademarks of BroadSoft or their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 2 OF 52
Document Revision History
Version
Reason for Change
1.1
Introduced document for Gigaset Maxwell 10 version 80_1_2.2.128 validation with BroadWorks
Release 21.sp1.
1.2
Edited and published document.
1.3
Updated section 5 Device Management in the document.
1.4
Edited changes and published document.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 3 OF 52
Table of Contents
1
Overview..........................................................................................................................................7
2
Interoperability Status ..................................................................................................................8
2.1
2.2
Verified Versions...........................................................................................................................8
Interface Capabilities Supported..................................................................................................8
2.2.1
SIP Interface Capabilities ....................................................................................................9
2.2.2
Other Interface Capabilities .............................................................................................. 14
2.3 Known Issues ............................................................................................................................ 15
3 BroadWorks Configuration....................................................................................................... 17
3.1
BroadWorks Device Profile Type Configuration ...................................................................... 17
3.2 BroadWorks Configuration Steps ............................................................................................. 18
4 Maxwell 10 Configuration.......................................................................................................... 19
4.1
Configuration Method ................................................................................................................ 19
4.2
System and Subscriber Level Configuration ............................................................................ 19
4.3
4.4
4.5
4.2.1
Configure Network Settings ............................................................................................. 19
4.2.2
Configure Subscriber and SIP Interface Settings ........................................................... 22
4.2.3
Configure Service Settings............................................................................................... 29
Redundancy Support ................................................................................................................ 33
SIP Advanced Feature Configuration....................................................................................... 34
4.4.1
Shared Call Appearance Configuration........................................................................... 34
4.4.2
Busy Lamp Field Configuration........................................................................................ 34
4.4.3
Feature Key Synchronization Configuration ................................................................... 35
4.4.4
Call Center Feature Configuration ................................................................................... 36
4.4.5
Call Recording Feature Configuration ............................................................................. 36
4.4.6
Security Classification Feature Configuration ................................................................. 36
4.4.7
Emergency Call Configuration ......................................................................................... 36
4.4.8
Advice of Charge Configuration ....................................................................................... 36
4.4.9
Conference Event Configuration ..................................................................................... 36
Xtended Services Interface (Xsi) Feature Configuration ......................................................... 36
4.6 Instant Message and Presence Configuration......................................................................... 36
5 Device Management ................................................................................................................... 37
5.1
Device Management Capabilities Supported .......................................................................... 37
5.2
Device Management Configuration .......................................................................................... 38
5.2.1
Configure BroadWorks Tags ........................................................................................... 39
5.2.2
Configure BroadWorks Device Profile Type ................................................................... 40
5.2.3
Create Device Profile Instance ........................................................................................ 44
5.2.4
Configure BroadWorks User ............................................................................................ 45
5.2.5
Customize Tags ................................................................................................................ 45
5.2.6 Configure Gigaset Maxwell 10 ......................................................................................... 46
Appendix A: Reference Maxwell 10 Configuration File ............................................................. 50
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 4 OF 52
References .......................................................................................................................................... 52
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 5 OF 52
Table of Figures
Figure 1 Device Identity/Profile Type ....................................................................................................... 18
Figure 2 Gigaset Maxwell 10 – IP Configuration .................................................................................... 21
Figure 3 Gigaset Maxwell 10 – Connections (part 1) ............................................................................. 28
Figure 4 Gigaset Maxwell 10 – Connections (part 2) ............................................................................. 29
Figure 5 Gigaset Maxwell 10 – Voicemail Services................................................................................ 30
Figure 6 Gigaset Maxwell 10 – Languages for Menus and Dialogues .................................................. 31
Figure 7 Gigaset Maxwell 10 – Local Settings ........................................................................................ 33
Figure 8 Gigaset Maxwell 10 – Function Keys ....................................................................................... 35
Figure 9 System Default Tag Settings..................................................................................................... 39
Figure 10 Device Type-specific Tag Settings ......................................................................................... 40
Figure 11 Device Access FQDN.............................................................................................................. 41
Figure 12 BWMACADDRESS.xml File Settings ................................................................................... 43
Figure 13 BroadWorks User Language Definition .................................................................................. 44
Figure 14 Device Profile Instance ............................................................................................................ 45
Figure 15 Web Login ................................................................................................................................ 46
Figure 16 Phone System Screen............................................................................................................. 47
Figure 17 Security Screen........................................................................................................................ 48
Figure 18 Auto Provision Screen ............................................................................................................. 49
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 6 OF 52
1
Overview
This guide describes the configuration procedures required for the Gigaset Maxwell 10 for
interoperability with BroadWorks.
The Maxwell 10 is an Android Desktop phone that uses the Session Initiation Protocol
(SIP) to communicate with BroadWorks for call control.
This guide describes the specific configuration items that are important for use with
BroadWorks. It does not describe the purpose and use of all configuration items on the
Maxwell 10. For those details, see the Maxwell 10 Administration [1] supplied by Gigaset.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 7 OF 52
2
Interoperability Status
This section provides the known interoperability status of the Gigaset Maxwell 10 with
BroadWorks. This includes the version(s) tested, the capabilities supported, and known
issues.
Interoperability testing validates that the device interfaces properly with BroadWorks via
the SIP interface. Qualitative aspects of the device or device capabilities not affecting the
SIP interface such as display features, performance, and audio qualities are not covered
by interoperability testing. Requests for information and/or issues regarding these aspects
should be directed to Gigaset.
2.1
Verified Versions
The following table identifies the verified Gigaset Maxwell 10 and BroadWorks versions
and the month/year the testing occurred. If the device has undergone more than one test
cycle, versions for each test cycle are listed, with the most recent listed first.
Compatible Versions in the following table identify specific Maxwell 10 versions that the
partner has identified as compatible so should interface properly with BroadWorks.
Generally, maintenance releases of the validated version are considered compatible and
may not be specifically listed here. For any questions concerning maintenance and
compatible releases, contact Gigaset.
NOTE: Interoperability testing is usually performed with the latest generally available (GA)
device firmware/software and the latest GA BroadWorks release and service pack at the time the
testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software
versions, customers can mitigate their risk by self-testing the combination themselves using the
BroadWorks SIP Phone Interoperability Test Plan [5].
Verified Versions
2.2
Date (mm/yyyy)
BroadWorks Release
Maxwell 10 Verified
Version
Maxwell 10
Compatible Versions
01/2017
Release 21.sp1
80_1_2.2.128
None.
Interface Capabilities Supported
This section identifies interface capabilities that have been verified through testing as
supported by Gigaset Maxwell 10.
The Supported column in the tables in this section identifies the Gigaset Maxwell 10’s
support for each of the items covered in the test plan, with the following designations:

Yes
Test item is supported

No
Test item is not supported

NA
Test item is not applicable to the device type

NT
Test item was not tested
Caveats and clarifications are identified in the Comments column.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 8 OF 52
2.2.1
SIP Interface Capabilities
The Gigaset Maxwell 10 has completed interoperability testing with BroadWorks using the
BroadWorks SIP Phone Interoperability Test Plan [5]. The results are summarized in the
following table.
The BroadWorks test plan is composed of packages, each covering distinct
interoperability areas, such as “Basic” call scenarios and “Redundancy” scenarios. Each
package is composed of one or more test items, which in turn are composed of one or
more test cases. The test plan exercises the SIP interface between the device and
BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks
feature set.
NOTE: DUT in the following table refers to the Device Under Test, which in this case is the
Gigaset Maxwell 10.
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Basic
Call Origination
Yes
Call Termination
Yes
Session Audit
Yes
Session Timer
Yes
Ringback
Yes
Forked Dialog
Yes
181 Call Being Forwarded
Yes
Dial Plan
Yes
DTMF – Inband
Yes
DTMF – RFC 2833
Yes
DTMF – DTMF Relay
Yes
Codec Negotiation
Yes
Codec Renegotiation
Yes
Third-Party Call Control – Basic
Yes
Third-Party Call Control – Advanced
No
Voice Message Deposit/Retrieval
Yes
Message Waiting Indicator –
Unsolicited
Yes
Message Waiting Indicator – Solicited
Yes
Message Waiting Indicator – Detail
Yes
Voice Portal Outcall
Yes
Advanced Alerting – Ringing
Yes
Advanced Alerting – Call Waiting
No
Advanced Alerting – Ring Splash
No
BroadWorks Services
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
20-BD5537-00
PAGE 9 OF 52
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
DUT Services –
Call Control Services
DUT Services –
Registration and
Authentication
DUT Services –
Emergency Call
Test Plan Package Items
Supported
Advanced Alerting – Silent Alerting
No
Calling Line ID
Yes
Calling Line ID with Unicode
Characters
Yes
Connected Line ID
Yes
Connected Line ID with Unicode
Characters
Yes
Connected Line ID on UPDATE
Yes
Connected Line ID on Re-INVITE
Yes
Diversion Header
Yes
History-Info Header
Yes
Advice of Charge
No
Meet-Me Conferencing
Yes
Meet-Me Conferencing – G722
Yes
Meet-Me Conferencing – AMR-WB
Yes
Meet-Me Conferencing – Opus
NT
Collaborate – Audio
Yes
Collaborate – Audio – G722
Yes
Collaborate – Audio – Opus
Yes
Call Decline Policy
Yes
Call Waiting
Yes
Call Hold
Yes
Call Transfer
Yes
Does not support Blind Transfer
feature.
Three-Way Calling
Yes
Does not support Three-Way
Call Before Answer feature.
Network-Based Conference
No
Register Authentication
Yes
Maximum Registration
Yes
Minimum Registration
Yes
Invite Authentication
Yes
Re-Invite/Update Authentication
Yes
Refer Authentication
Yes
Device Authenticating BroadWorks
No
Emergency Call
No
Emergency Call with Ringback
No
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
This feature is not included in
Release 21.0 test plan.
20-BD5537-00
PAGE 10 OF 52
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Supported
Comments
DUT Services – PAccess-Network-Info
Header
REGISTER with P-Access-NetworkInfo Header
NT
This feature is not included in
Release 21.0 test plan.
INVITE with P-Access-Network-Info
Header
NT
This feature is not included in
Release 21.0 test plan.
Do Not Disturb
Yes
Call Forwarding Always
Yes
Call Forwarding Always Diversion
Inhibitor
No
Anonymous Call
Yes
Anonymous Call Block
No
Remote Restart Via Notify
No
DUT Services –
Miscellaneous
Advanced Phone
Services – Busy
Lamp Field
Advanced Phone
Services – Feature
Key Synchronization,
Private Line
Advanced Phone
Services – Feature
Key Synchronization,
Shared Line
Does not support below
features:
Busy Lamp Field
Yes
Call Park Notification
No
Do Not Disturb
No
Do Not Disturb Ring Splash
No
Call Forwarding
No
Call Forwarding Always Ring Splash
No
Call Forwarding Always Diversion
Inhibitor
No
Call Center Agent Logon/Logoff
No
Call Center Agent Unavailable Code
No
Executive – Call Filtering
No
Executive-Assistant – Call Filtering
No
Executive-Assistant – Diversion
No
Call Recording
No
Security Classification
No
Do Not Disturb
No
Do Not Disturb Ring Splash
No
Call Forwarding
No
Call Forwarding Always Ring Splash
No
Call Forwarding Always Diversion
Inhibitor
No
Security Classification
No
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
 BLF Modify Monitored User
List with Unicode.
 BLF NOTIFY of User Busy,
Multi-Dialog.
 BLF NOTIFY of Terminating
User Busy: Directed Call
Pickup.
20-BD5537-00
PAGE 11 OF 52
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
Advanced Phone
Services – Missed
Calls Display
Synchronization
Advanced Phone
Services – Shared
Call Appearance
using Call Info
Advanced Phone
Services – Call Park
Notification
Advanced Phone
Services – Call Center
Advanced Phone
Services – Call
Recording Controls
Advanced Phone
Services – Call
Recording Video
Advanced Phone
Services – Security
Classification
Advanced Phone
Services –
Conference Event
Redundancy
Test Plan Package Items
Supported
Missed Calls Display Sync
No
Line-Seize
No
Call-Info/Lamp Management
No
Public Hold
No
Private Hold
No
Hybrid Key System
No
Multiple Call Arrangement
No
Bridge Active Line
No
Bridge Active Line – Silent Monitor
No
Call Park Notification
No
Call Park Notification
No
Hold Reminder
No
Call Information
No
Hoteling Event
No
Status Event
No
Disposition Code
No
Emergency Escalation
No
Customer Originated Trace
No
Pause/Resume
No
Start/Stop
No
Record Local Conference
No
Record Network Conference
No
Basic Call
No
Record Local Conference
No
Record Network Conference
No
Security Classification
No
Network-Based Conference Creator
No
Network-Based Conference
Participant
No
Meet-Me Conference Participant
No
DNS SRV Lookup
Yes
Register Failover/Failback
Yes
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
Does not support Register
Failback.
20-BD5537-00
PAGE 12 OF 52
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
SBC/ALG - Basic
SBC/ALG –
Failover/Failback
Video – Basic Video
Calls
Video – BroadWorks
Video Services
Video – BroadWorks
Video Conference
Video – BroadWorks
WebRTC Client
TCP
IPV6
Test Plan Package Items
Supported
Invite Failover/Failback
No
Bye Failover
No
Register
Yes
Outgoing Invite
Yes
Incoming Invite
Yes
Register Failover/Failback
No
Invite Failover/Failback
No
Call Origination
Yes
Call Termination
Yes
Call Hold
Yes
Call Waiting
Yes
Call Transfer
Yes
Auto Attendant
Yes
Auto Attendant – HD
No
Voice Messaging
Yes
Voice Messaging – HD
No
Custom Ringback
No
Network-based Conference
No
Network-based Conference – HD
No
Collaborate – Video
No
Collaborate – Video – HD
No
Call from WebRTC Client
No
Call to WebRTC Client
No
Register
Yes
Outgoing Invite
Yes
Incoming Invite
Yes
Call Origination
Yes
Call Termination
Yes
Session Audit
Yes
Ringback
Yes
Codec Negotiation/Renegotiation
Yes
Voice Message Deposit/Retrieval
Yes
Call Control
Yes
Registration with Authentication
Yes
Busy Lamp Field
Yes
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
20-BD5537-00
PAGE 13 OF 52
BroadWorks SIP Phone Interoperability Test Plan Support Table
Test Plan Package
2.2.2
Test Plan Package Items
Supported
Redundancy
No
SBC
Yes
Video
Yes
Dual Stack with Alternate
Connectivity
No
Comments
Other Interface Capabilities
The Gigaset Maxwell 10 may have implemented support for the following:

BroadWorks Xtended Services Interface (Xsi)

Extensible Messaging and Presence Protocol (XMPP) (BroadCloud/BroadWorks
Collaborate Instant Messaging and Presence [IM&P])
Support for these interfaces is demonstrated by completing the BroadWorks SIP Phone
Functional Test Plan [6]. Support for these interfaces is summarized in the following table.
BroadWorks Xtended Services Interface (Xsi) and BroadCloud IM&P Support Table
Interface
Feature
Supported
Xsi Features –
Authentication
Authenticate with SIP Credentials
No
Authenticate with BroadWorks User
Login Credentials
No
Authenticate with BroadWorks User
Directory Number
No
Remote Office
No
BroadWorks Anywhere
No
Simultaneous Ringing
No
Caller ID Blocking
No
Call Forwarding Always
No
Call Forwarding Busy
No
Call Forwarding No Answer
No
Do Not Disturb
No
Enterprise Directory
No
Enterprise Common Phone List
No
Group Directory
No
Group Common Phone List
No
Personal Phone List
No
Search All Directories
No
Placed Calls
No
Received Calls
No
Missed Calls
No
Xsi Features –
User Service
Configuration
Xsi Features –
Directories
Xsi Features –
Call Logs
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
20-BD5537-00
PAGE 14 OF 52
BroadWorks Xtended Services Interface (Xsi) and BroadCloud IM&P Support Table
Interface
Xsi Features –
Visual Voice Mail
XMPP Features –
Contact/Buddy List
XMPP Features –
Presence
2.3
Feature
Supported
All Calls
No
Sort by Name
No
View Messages
No
Listen to Audio Message
No
Watch Video Message
No
Mark Message Read/Unread
No
Delete Message
No
Mark All Messages Read/Unread
No
Contacts
No
Favorites
No
Groups
No
Non-XMPP Contacts
No
Conferences
No
Login Invisible
No
Presence State
No
Presence Status
No
Contact’s Presence State
No
Comments
Known Issues
This section lists the known interoperability issues between BroadWorks and specific
partner release(s). Issues identified during interoperability testing and known issues
identified in the field are listed.
The following table provides a description of each issue and, where possible, identifies a
workaround. The verified partner device versions are listed with an “X” indicating that the
issue occurs in the specific release. The issues identified are device deficiencies or bugs,
and are typically not BroadWorks release dependent.
The Issue Number is a tracking number for the issue. If it is a Gigaset issue, the issue
number is from Gigaset’s tracking system. If it is a BroadWorks issue, the issue number is
from BroadSoft’s tracking system.
For more information on any issues related to the particular partner device release, see
the partner release notes.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 15 OF 52
Issue Description
AFM-913
Basic Call Control with ALLOW-EVENT Header.
Partner Version
80_1_2.2.128
Issue Number
For the basic call control feature, the device generates180 Ringing
with “talk” and “hold” included in ALLOW-EVENT header. The
ALLOW-EVENT header with talk and hold should not be generated
for basic call control.
Workaround: None.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 16 OF 52
3
BroadWorks Configuration
This section identifies the required BroadWorks device profile type for the Gigaset Maxwell
10 as well as any other unique BroadWorks configuration required for interoperability with
the Maxwell 10.
3.1
BroadWorks Device Profile Type Configuration
This section identifies the device profile type settings to use when deploying the Gigaset
Maxwell 10 with BroadWorks.
Create a device profile type for the Gigaset Maxwell 10 with settings as shown in the
following example. The settings shown are recommended for use when deploying the
Gigaset Maxwell 10 with BroadWorks. For an explanation of the profile parameters, see
the BroadWorks Device Management Configuration Guide [2].
Model
Number of Lines
Maxwell 10
12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 17 OF 52
Figure 1 Device Identity/Profile Type
3.2
BroadWorks Configuration Steps
There are no additional BroadWorks configuration steps required.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 18 OF 52
4
Maxwell 10 Configuration
This section describes the configuration settings required for the Maxwell 10 integration
with BroadWorks, primarily focusing on the SIP interface configuration. The Maxwell 10
configuration settings identified in this section have been derived and verified through
interoperability testing with BroadWorks. For configuration details not covered in this
section, see the Maxwell 10 Administration [1] for Maxwell 10.
4.1
Configuration Method
Gigaset Maxwell 10 can be configured through the web interface (GUI), directly on the
phone, via a provisioning server, or by directly importing a configuration file. The web
interface address for the phone is http(s)://<IPv4 address of the phone> or
http://[IPv6_address]:8080, or https://[IPv6_address]:443. The default password for the
web interface is password. The username is not required for web interface login.
Configuration Files
4.2
Maxwell 10 Configuration Files
Level
Description
master.bin
System
Contains all the information about the
firmware files, language files, and siu
files for this device.
baselines.bin
System
Contains all the information about the
software version.
siu_555.bin
System
Contains all the information about the
location of the configuration files and
the naming used.
”Softwareversion”_maxwell_10user_firmware_enc.zip
System
Device firmware file.
profile.xml
Subscriber
Contains configurable parameters
that apply to an individual device in a
deployment. The naming can be
different and it depends on the
siu_555.bin file settings.
System and Subscriber Level Configuration
This section describes system-wide and subscriber related configuration items that are
generally required for each Maxwell 10 to work with BroadWorks.
4.2.1
Configure Network Settings
Network settings can be configured from the configuration file profile.xml.
Step
Step 1
Command
Description
Set the DHCP or static IP address
<B_USE_DHCP value=""
class="boolean" />
Enable or disable using DHCP.
Example:
<B_USE_DHCP value="true"
class="boolean" />
False: Disable DHCP.
Values:
True: Enable DHCP.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 19 OF 52
Step
Step 2
Command
Set the IP address
<S_IP value="" class="string"
/>
Description
Set static IP address if DHCP is not
enabled.
<S_IP value="10.10.10.10"
class="string" />
Step 3
Set the subnet mask
<S_SUBNET_MASK value=""
class="string" />
Set the subnet mask in IPv4.
Example:
<S_SUBNET_MASK
value="255.255.255.240"
class="string" />
Step 4
Set the standard gateway
<S_DEFAULT_ROUTER value=""
class="string" />
Set the IPv4 address of default router.
Example:
<S_DEFAULT_ROUTER
value="10.10.10.1"
class="string" />
Step 5
Set the preferred DNS server
<S_DNS_SERVER_1 value=""
class="string" />
Set the IPv4 address of the preferred
DNS server.
Example:
<S_DNS_SERVER_1 value="8.8.8.8"
class="string" />
Step 6
Set the alternate DNS server
<S_DNS_SERVER_2 value=""
class="string" />
Set the IPv4 address of the alternate
DNS server.
<S_DNS_SERVER_2 value="8.8.4.4"
class="string" />
Step 7
Set VLAN tagging
<I_VLAN_ACTIVATE
class="boolean" value=""/>
Values:
Step 8
Set the VLAN ID
<I_VLAN_ID class="integer"
value=""/>
Set the VLAN ID. The value of the VLAN
ID ranges from 1 to 4094.
Step 9
Set the VLAN priority
<I_VLAN_LAN_PRIORITY
class="integer" value=""/>
Set the VLAN priority. The value of the
VLAN priority ranges from 0 to 7.
0x0: disable VLAN tagging
0x1: enable VLAN tagging
The network setting can be also configured from device web interface Settings → Network
and Connections → Local Area Network (LAN) screen.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 20 OF 52
Figure 2 Gigaset Maxwell 10 – IP Configuration
4.2.1.1
Configure IPV6 Settings
Step
Step 1
Command
Description
Enable IPv6
<I_NETWORK_TYPE value=""
class="integer" />
Set value to 0: disable IPv6. IPv4 is
enabled.
Step 2
Set the prefix length of the IPv6 address
<I_PREFIX_LENGTH value=""
class="integer" />
Set the prefix length of the IPv6 address.
Step 3
Set a default gateway
<S_DEFAULT_ROUTER value=""
class="string" />
Set the IPv6 address of default gateway.
Step 4
Set DNS server address
<S_DNS_SERVER_1 value=""
class="string" />
Set the IPv6 address of DNS server.
Step 4
Set alternate DNS server address
Command:
Set the IPv6 address of alternate DNS
server.
Set value to 1: Enable IPv6. IPv4 is
disabled.
<S_DNS_SERVER_2 value=""
class="string" />
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 21 OF 52
4.2.2
Configure Subscriber and SIP Interface Settings
Subscriber and SIP interface settings can be configured from the configuration file
profile.xml.
Step
Step 1
Command
Set an account name
<S_SIP_ACCOUNT_NAME_N
class="string" value=""/>
Description
Maximum 16 characters.
N stands for a number of an account.
Possible N value: 1-12
Example:
<S_SIP_ACCOUNT_NAME_1
class="string"
value="Broadsoft"/>
Step 2
Enable or disable an account
<B_SIP_ACCOUNT_IS_ACTIVE_N
class="boolean" value=""/>
Example:
<B_SIP_ACCOUNT_IS_ACTIVE_1
class="boolean" value="1"/>
Step 3
Set the authentication name
<S_SIP_LOGIN_ID_N
class="string" value=""/>
Example:
<S_SIP_LOGIN_ID_1
class="string"
value="2417779999"/>
Step 4
Step 5
0 – inactive
1 – active (default)
N stands for a number of an account.
Possible N value: 1-12
The field has maximum 32 characters. It
must match SIP authentication user
name configured for the user on
BroadWorks.
N stands for a number of an account.
Possible N value: 1-12
Set the authentication password
<S_SIP_PASSWORD_N
class="string" value=""/>
The field has maximum 32 characters. It
must match SIP authentication password
configured for the user on BroadWorks.
Example:
<S_SIP_PASSWORD_1
class="string"
value="abcd1234"/>
Possible N value: 1-12
Set the user name
<S_SIP_USER_ID_N class="string"
value=""/>
The field has maximum 32 characters.
Example:
<S_SIP_USER_ID_1 class="string"
value="2417779999"/>
Step 6
Values can be:
Set the display name
<S_SIP_DISPLAYNAME_N
class="string" value=""/>
N stands for a number of an account.
N stands for a number of an account.
Possible N value: 1-12
The field must match the user part of
line/port configuration on BroadWorks.
Maximum 32 characters.
N stands for a number of an account.
Possible N value: 1-12
Example:
<S_SIP_DISPLAYNAME_1
class="string"
value="Reception"/>
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 22 OF 52
Step
Step 7
Command
Description
Set the domain
<S_SIP_DOMAIN_N class="string"
value=""/>
Example:
Maximum 64 characters.
Set the Proxy Server address
<S_SIP_SERVER_N class="string"
value=""/>
Maximum 64 characters.
N stands for a number of an account.
Possible N value: 1-12
<S_SIP_DOMAIN_1 class="string"
value="as.iop1.broadworks.net"/
>
Step 8
N stands for a number of an account.
Possible N value: 1-12
Example:
<S_SIP_SERVER_1 class="string"
value="as.iop1.broadworks.net"/
>
Step 9
Set the Proxy Server port
<I_SIP_SERVER_PORT_N
class="integer" value=""/>
Value has to be in range: 1025 ‒ 65535
N stands for a number of an account.
Possible N value: 1-12
Example:
<I_SIP_SERVER_PORT_1
class="integer" value="5060"/>
Step 10
Set the Registration Server address
<S_SIP_REGISTRAR_N
class="string" value=""/>
Maximum 64 characters.
N stands for a number of an account.
Possible N value: 1-12
Example:
<S_SIP_REGISTRAR_1
class="string"
value="as.iop1.broadworks.net"/
>
Step 11
Set the Registration Server port
<I_SIP_REGISTRAR_PORT_N
class="integer" value=""/>
Value has to be in range: 1025 ‒ 65535
N stands for a number of an account.
Possible N value: 1-12
Example:
<I_SIP_REGISTRAR_PORT_1
class="integer" value="5060"/>
Step 12
Set the registration refresh time
<I_RE_REGISTRATION_TIMER_N
class="integer" value=""/>
Value has to be in range: 60 ‒ 9999s.
N stands for a number of an account.
Possible N value: 1-12
Example:
<I_RE_REGISTRATION_TIMER_1
class="integer" value="180"/>
Step 13
Enable or disable using of STUN server
<B_SIP_USE_STUN_1
class="boolean" value=""/>
Values:
0 – disabled (default)
1 – enabled
N stands for a number of an account.
Possible N value: 1-12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 23 OF 52
Step
Step 14
Step 15
Step 16
Step 17
Step 18
Step 19
Command
Description
Set STUN server address
<S_STUN_SERVER_N class="string"
value=""/>
Maximum 64 characters.
Set STUN server port
<I_STUN_SERVER_PORT_N
class="integer" value=""/>
Value has to be in range: 1025-65535.
Set STUN refresh time
<I_RE_STUN_TIMER_N
class="integer" value=""/>
Value has to in range: 0-9999.
Set NAT refresh time
<I_NAT_REFRESH_TIME_N
class="integer" value=""/>
Value has to in range: 0-9999.
Set Outbound Proxy mode
<I_OUTBOUND_PROXY_MODE_N
class="integer" value=""/>
Values:
Example:
N stands for a number of an account.
<I_OUTBOUND_PROXY_MODE_1
class="integer" value="0"/>
Possible N value: 1-12
Set Outbound Proxy address
<S_OUTBOUND_PROXY_N
class="string" value=""/>
Maximum 64 characters.
N stands for a number of an account.
Possible N value: 1-12
N stands for a number of an account.
Possible N value: 1-12
N stands for a number of an account.
Possible N value: 1-12
N stands for a number of an account.
Possible N value: 1-12
0:Never (default)
1:Always
2:Automatic
N stands for a number of an account.
Possible N value: 1-12
Example:
<S_OUTBOUND_PROXY_1
class="string" value=""/>
Step 20
Set Outbound Proxy port
<I_OUTBOUND_PROXY_PORT_N
class="integer" value=""/>
Example:
<I_OUTBOUND_PROXY_PORT_1
class="integer" value="5060"/>
Step 21
Set DTMF negotiation mode
<B_AUTOMATIC_DTMF_N
class="boolean" value=""/>
Value has to be in range: 1025-65535.
Default = 5060
N stands for a number of an account.
Possible N value: 1-12
Values:
0 – disabled (default)
1 – automatic
N stands for a number of an account.
Possible N value: 1-12
Step 22
Set DTMF method
<I_DTMF_TX_MODE_BITS_N
class="integer" value=""/>
Values:
1:Audio
2:RFC 2833
3:Audio + RFC 2833
4:Sip Info
5:Audio + Sip Info (default)
6:RFC 2833 + Sip Info
7:Audio + RFC 2833 + Sip Info
N stands for a number of an account.
Possible N value: 1-12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 24 OF 52
Step
Step 23
Command
Set Enable incoming calls counting
<B_MISSED_ACCEPTED_COUNT_N
class="boolean" value=""/>
Description
Values:
0 – disabled
1 – enabled (default)
N stands for a number of an account.
Possible N value: 1-12
Step 24
Enable or disable Call Waiting
<B_CALL_WAITING_N
class="boolean" value=""/>
Values:
0 – disabled
1 – enabled (default)
N stands for a number of an account.
Possible N value: 1-12
Step 25
Set the main ringtone
<S_RINGER_MELODIES_(N)
class="integer" value=""/>
Values:
0: Individual (only available when N is
equal to "0")
1~21: 21 selectable types as present in
MMI
1: 01_call1 (default)
2: 02_call2
3: 03_call3
4: 04_call4
5: 05_call5
6: 06_gigaset
7: 07_balance
8: 08_Plug2010
9: 09_Key_Pad
10: 10_Dunken
11: 11_Sonic
12: 12_set
13: 13_tone_one
14: 14_phone
15: 15_green_tea
16: 16_slippin_c
17: 17_spliss
18: 18_MInd Moon
19: 19_hello
20: 20_Guitar
21: 21_piano
22: 22_beep
First account indication, “_(N)” is not
necessary for this parameter.
N stands for a number of an account.
Possible N value: 2-12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 25 OF 52
Step
Step 26
Command
Set the ringtone for external calls
<I_RINGER_MELODIES_EC_(N)class=
"integer" value=""/>
Description
Values:
1: 01_call1
2: 02_call2
3: 03_call3
4: 04_call4
5: 05_call5
6: 06_gigaset (default)
7: 07_balance
8: 08_Plug2010
9: 09_Key_Pad
10: 10_Dunken
11: 11_Sonic
12: 12_set
13: 13_tone_one
14: 14_phone
15: 15_green_tea
16: 16_slippin_c
17: 17_spliss
18: 18_MInd Moon
19: 19_hello
20: 20_Guitar
21: 21_piano
22: 22_beep
First account indication, "_(N)" is not
necessary for this parameter.
N stands for a number of an account.
Possible N value: 2-12
Step 27
Set the ringtone for internal calls.
<I_RINGER_MELODIES_IC_(N)
class="integer" value=""/>
Values:
1: 01_call1
2: 02_call2
3: 03_call3
4: 04_call4
5: 05_call5
6: 06_gigaset (default)
7: 07_balance
8: 08_Plug2010
9: 09_Key_Pad
10: 10_Dunken
11: 11_Sonic
12: 12_set
13: 13_tone_one
14: 14_phone
15: 15_green_tea
16: 16_slippin_c
17: 17_spliss
18: 18_MInd Moon
19: 19_hello
20: 20_Guitar
21: 21_piano
22: 22_beep
First account indication, “_(N)” is not
necessary for this parameter.
N stands for a number of an account.
Possible N value: 2-12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 26 OF 52
Step
Step 28
Command
Set the ringtone for group calls
<I_RINGER_MELODIES_GC_(N)
class="integer" value=""/>
Description
Values:
1: 01_call1
2: 02_call2
3: 03_call3
4: 04_call4
5: 05_call5
6: 06_gigaset
7: 07_balance
8: 08_Plug2010
9: 09_Key_Pad
10: 10_Dunken
11: 11_Sonic
12: 12_set
13: 13_tone_one
14: 14_phone
15: 15_green_tea
16: 16_slippin_c
17: 17_spliss
18: 18_MInd Moon
19: 19_hello
20: 20_Guitar
21: 21_piano
22: 22_beep
First account indication, “_(N)” is not
necessary for this parameter.
N stands for a number of an account.
Possible N value: 2-12
The Subscriber and SIP Interface configuration can be also configured from device web
interface Settings → Connections screen.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 27 OF 52
Figure 3 Gigaset Maxwell 10 – Connections (part 1)
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 28 OF 52
Figure 4 Gigaset Maxwell 10 – Connections (part 2)
4.2.3
4.2.3.1
Configure Service Settings
Voice Mail
This section provides configuration instructions to configure Voice Mail and Message
Waiting Indicator (MWI) notification with BroadWorks.
Voice Mail settings can be configured from the configuration file profile.xml.
Step
Step 1
Step 2
Command
Description
Set the Voice Mail number
<S_VOIP_NET_AM_NUMBER_(N)
class="string" value=""/>
Maximum 32 phone digits (0-9,*,#,R,P).
Enable or disable Voice Mail
<B_VOIP_NET_AM_ENABLED_(N)
class="boolean" value=""/>
Values:
Note that the Voice Mail account must not
be empty if the Voice Mail is enabled.
N= [2-12]
0: No (default)
1: Yes
The Voice Mail configuration can be also configured from device web interface Settings →
Telephony → Voicemail Services screen.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 29 OF 52
Figure 5 Gigaset Maxwell 10 – Voicemail Services
4.2.3.2
Device Language, Country Settings
This section provides configuration instructions to configure a device to be used in the
different countries.
4.2.3.2.1
Web Interface Language
Web interface language settings can be configured from the configuration file profile.xml.
Step
Step 1
Command
Set the web interface menu language
<I_WEB_LANGUAGE class="integer"
value=""/>
Description
Values:
1: German (default)
2: English
3: Spanishl
4: Italian
5: Dutch
6: French
7: Danish
8: Polish
9: Swedish
10: Turkish
Web interface language settings can be also set from the device web interface. It can be
set right after the device web interface address is entered from a browser.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 30 OF 52
Figure 6 Gigaset Maxwell 10 – Languages for Menus and Dialogues
4.2.3.2.2
Local Settings for Telephony Service
Local settings can be configured from the configuration file profile.xml.
Step
Step 1
Command
Set country
<I_AREA_COUNTRY class="integer"
value=""/>
Description
Values:
0:Albania
1: Argentina
2: Australia
3: Austria
4: Bahrain
5: Belarus
6: Belgium
7: Bolivia
8: Bosnia and Herzegovina
9: Brazil
10: Bulgaria
11: Canada
12: Chile
13: China
14: Colombia
15: Costa Rica
16: Croatia
17: Cyprus
18: Czech Republic
19: Denmark
20: Ecuador
21: Egypt
22: Estonia
23: Finland
24: France
25: Germany
26: Greece
27: Hong Kong
28: Hungary
29: Iceland
30: India
31: Indonesia
32: Ireland
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 31 OF 52
Step
Command
Description
33: Israel
34: Italy
35: Japan
36: Jordan
37: Korea, Republic of
38: Kuwait
39: Latvia
40: Lebanon
41: Liechtenstein
42: Lithuania
43: Luxembourg
44: Macedonia
45: Malaysia
46: Mexico
47: Morocco
48: Netherlands
49: New Zealand
50: Norway
51: Pakistan
52: Panama
53: Paraguay
54: Peru
55: Philippines
56: Poland
57: Portugal
58: Puerto Rico
59: Romania
60: Russia
61: Saudi Arabia
62: Serbia
63: Singapore
64: Slovakia
65: Slovenia
66: South Africa
67: Spain
68: Sweden
69: Switzerland
70: Taiwan
71: Thailand
72: Turkey
73: United Arab Emirates
74: United Kingdom
75: United States of America
76: Uruguay
77: Venezuela
78: Vietnam
79: Namibia
80: Palestine
81: Montenegro
82: Other Country
Step 2
Set the prefix for international calls
<S_AREA_INTERL_PREX
class="string" value=""/>
Maximum 4 phone digits (0-9,*,#,R,P)
default: 00
Step 3
Set the Country Code
<S_AREA_INTERL_AREA
class="string" value=""/>
Maximum 4 phone digits (0-9,*,#,R,P)
default: 49
Step 4
Set the local prefix
<S_AREA_LOCAL_PREX class="string"
value="">
Maximum 4 phone digits (0-9,*,#,R,P)
default: 0
Step 5
Set the Area Code
<S_AREA_LOCAL_AREA class="string"
value=""/>
Maximum 8 phone digits (0-9,*,#,R,P)
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 32 OF 52
Step
Step 6
Command
Set tone scheme
<I_TONE_SCHEME class="integer"
value=""/>
Description
Values:
2 Austria
3 Canada
4 Czech Republic
5 Denmark
6 Egypt
7 Finland
8 France
9 Germany (default)
10 Greece
11 Netherlands
12 Poland
13 Portugal
14 Romania
15 RSA - South Africa
16 Russian Federation
17 Saudi Arabia
18 Slovakia
19 Spain
20 Sweden
21 Switzerland
22 United Arab Emirates
23 United Kingdom of Great Britain
24 USA
The local setting can be also configured from device web interface Settings → Local
Settings screen.
Figure 7 Gigaset Maxwell 10 – Local Settings
4.3
Redundancy Support
This section identifies the device-specific redundancy related parameters. The Gigaset
Maxwell 10 uses the DNS SRV according to RFC 3263 to locate SIP servers in case of
redundancy.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 33 OF 52
The redundancy can be configured from the configuration file profile.xml.
Step
4.4
Command
Description
Step 1
Remove Proxy Server port
<I_SIP_SERVER_PORT_N
class="integer" value=’""’/>
To use DNS SRV query for Proxy Server
addresses, remove the proxy server port
settings by configuring an empty field.
Step 2
Remove Registration Server port
<I_SIP_REGISTRAR_PORT_N
class="integer" value=’""’/>
To use DNS SRV query for Registration
Server addresses, remove the proxy
server port settings by configuring an
empty field.
Step 3
Remove Outbound Proxy port
<I_OUTBOUND_PROXY_PORT_N
class="integer" value=’""’/>
To use DNS SRV query for Outbound
Proxy addresses, remove the proxy
server port settings by configuring an
empty field.
SIP Advanced Feature Configuration
This section provides configuration instructions for advanced SIP features supported by
the phone including but not limited to Shared Call Appearance, Busy Lamp Field, Feature
Key Synchronization, Call Center, Emergency Call, Advice of Charge, Call Recording, and
Security Classification.
4.4.1
Shared Call Appearance Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.2
Busy Lamp Field Configuration
The Busy Lamp Field implementation provides an attendant console function.
Configuration of the phone to enable Busy Lamp Field from configuration file profile.xml is
described in the following table.
Step
Step 1
Command
Set BLF function key
<I_FUNCTION_KEY_TYPE_(N)
class="integer" value=""/>
Example:
<I_FUNCTION_KEY_TYPE_(N)
class="integer" value="3"/>
Step 2
Select VoIP account for BLF
<I_FUNCTION_KEY_CONNECTION_KEY_(N
) class="integer" value=""/>
Example:
<I_FUNCTION_KEY_CONNECTION_KEY_(N
) class="integer" value="0"/>
Description
Values:
0: default init (NULL) entry (end of list)
1: Park + Orbit
2: SpeedDial
3: BLF (this should be chosen)
4: Call Divert
5: DTMF
6: None (entry within the list with no
function assigned)
Values:
0: Connection 1
1: Connection 2
11: Connection 12
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 34 OF 52
Step
Step 3
Command
Set BLF username
<S_FUNCTION_KEY_NUM_(N)
class="string" value=""/>
Description
This field has maximum 63 characters. It
must match the user’ BroadWorks BLF
list configuration.
Example:
<S_FUNCTION_KEY_NUM_(N)
class="string"
value="blf1@as.iop1.broadworks.
net"/>
Step 4
Set the BLF softkey name
<S_FUNCTION_KEY_NAME
class="string" value=""/>
This field assigns a name for BLF softkey
(that is, “Sales”).
Maximum 64 characters.
Example:
<S_FUNCTION_KEY_NAME
class="string" value="Sales"/>
Step 5
Set the Call Pick-up code
<S_DIRECTED_PICKUP_CODE (N)
class="string" value=""/>
Maximum 4 characters: 0, 1~9, * and #
(default = **)
Example:
<S_DIRECTED_PICKUP_CODE (N)
class="string" value="*97"/>
The Busy Lamp Field setting can be also configured from device web interface → Settings
→ Function Keys screen.
Figure 8 Gigaset Maxwell 10 – Function Keys
4.4.3
Feature Key Synchronization Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 35 OF 52
4.4.4
Call Center Feature Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.5
Call Recording Feature Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.6
Security Classification Feature Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.7
Emergency Call Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.8
Advice of Charge Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.4.9
Conference Event Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.5
Xtended Services Interface (Xsi) Feature Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
4.6
Instant Message and Presence Configuration
Currently this feature is not supported by Gigaset Maxwell 10.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 36 OF 52
5
Device Management
The BroadWorks Device Management feature provides the capability to automate
generation of device configuration files to support mass deployment of devices. This
section identifies the Device Management capabilities supported by the Gigaset Maxwell
10 and the configuration steps required. For Device Management configuration details not
covered here, see the BroadWorks Device Management Configuration Guide [2] and the
BroadWorks CPE Kit Usage Guide [8].
5.1
Device Management Capabilities Supported
The Gigaset Maxwell 10 has completed Device Management interoperability testing with
BroadWorks using the BroadWorks Device Management Interoperability Test Plan [7].
The results are summarized in the following table.
The BroadWorks test plan is composed of packages, each covering distinct
interoperability areas. Each package is composed of one or more test items, which in
turn, are composed of one or more test cases. The test plan exercises the Device
Management interface between the device and BroadWorks with the intent to ensure
interoperability.
The Supported column in the following table identifies the Gigaset Maxwell 10 ’s support
for each of the items covered in the test plan packages, with the following designations:

Yes
Test item is supported

No
Test item is not supported

NA
Test item is not applicable

NT
Test item was not tested
Caveats and clarifications are identified in the Comments column.
NOTE: DUT in the following table refers to the Device Under Test, which in this case is the
Gigaset Maxwell 10.
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
HTTP File
Download
HTTP Download Using XSP IP Address
Yes
HTTP Download Using XSP FQDN
Yes
HTTP Download Using XSP Cluster
FQDN
Yes
HTTP Download With Double Slash
Yes
HTTPS Download Using XSP IP Address
Yes
HTTPS Download Using XSP FQDN
Yes
HTTPS Download Using XSP Cluster
FQDN
Yes
HTTPS Download with Client
Authentication Using XSP FQDN
No
HTTPS Download with Client
Authentication Using XSP Cluster FQDN
No
HTTPS File
Download
HTTPS File
Download with
Client
Authentication
Supported
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
Comments
20-BD5537-00
PAGE 37 OF 52
BroadWorks Device Management Interoperability Test Plan Support Table
Test Plan Package
Test Plan Package Items
Time Zone
Mapping
Inspect Time Zone Setting
Yes
Language
Mapping
Inspect Language Setting
Yes
File Inspection
Inspect System Config File
No
Inspect Device-Specific Config File
Yes
Inspect Other Config Files
No
Inspect Static Files
No
Inspect SIP Settings
Yes
Inspect Line Settings
Yes
Inspect Service Settings
No
HTTP Upload Using XSP IP Address
No
HTTP Upload Using XSP FQDN
No
HTTP Upload Using XSP Cluster FQDN
No
Register with Authentication
Yes
Call Origination
Yes
Call Termination
Yes
Remote Restart
No
Shared Line Origination
No
Shared Line Termination
No
Shared Line Status
No
Busy Lamp Field
Yes
Network-Based Conference
No
Association via Voice Portal
No
Association via Phone
No
Provision via DHCP Options Field
No
No Touch Provision via DM redirect
No
No Touch Provision via Vendor redirect
Yes
Device Inspection
HTTP File Upload
Call Processing
Sanity Tests
Flexible Seating
No Touch
Provisioning
5.2
Supported
Comments
Device Management Configuration
This section identifies the steps required to enable the Gigaset Maxwell 10 for device
management. For Device Management configuration details not covered here, see the
BroadWorks Device Management Configuration Guide [2] and the BroadWorks CPE Kit
Usage Guide [8].
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 38 OF 52
5.2.1
Configure BroadWorks Tags
The template files in Device Management use tags to represent the data stored on
BroadWorks. When a configuration changes for a user, Device Management parses the
template files and replaces the Device Management tags with the associated data stored
on BroadWorks. There are default tags defined in the Device Management software and
there are custom tags that the service provider can create and define via the web portal for
use by Device Management. There are two types of custom tags that can be defined:
system-default tags that are common to all devices on the system and device type-specific
tags that are common to Gigaset device models only.
The Gigaset Maxwell 10 makes use of custom tags which can be configured by a
BroadWorks administrator as either system default or device type-specific tags. This
section identifies the required tags.
5.2.1.1
Create System Default Tags
Browse to System → Resources → Device Management Tag Sets and select the System
Default tag set. The Gigaset configuration templates make use of the tags in the following
table. Add the tags if they do not already exist.
Tag Name
Valid Settings
Description
%SBC_ADDRESS%
IP address/FQDN
SBC SIP address.
%SBC_PORT%
Port
SBC SIP port. The port should
be set if the defined session
border controller (SBC) address
is an IP address. If the SBC
address is an FQDN, then the
SBC port should not be set.
Example System Default Tag Settings
Figure 9 System Default Tag Settings
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 39 OF 52
5.2.1.2
Create Device Type-specific Tags
Browse to System → Resources → Device Management Tag Sets and then click Add to
add a new tag set. Configure the tag set name using the device name appended by Tags:
Gigaset_Maxwell10_Tags. Add the device type specific tags in the following table to the
device tag set. If the tag set already exists, make sure the following tags are defined.
Tag Name
Valid Settings
Description
%ACCESS_PROTOCOL%
http or https
The protocol used by device to
download DM configuration file.
Example Device Type-specific Tag Settings
Figure 10 Device Type-specific Tag Settings
5.2.2
Configure BroadWorks Device Profile Type
The device profile type is a system-level structure that defines how the device interfaces
with BroadWorks. It also identifies the default configuration files and other files, such as
firmware, which are required for the device to operate correctly. The device profile type is
created by the system administrator. Group administrators use the device profile type to
create a device profile. The device profile is an instance of the device profile type that is
associated with a physical device.
There are two BroadWorks device profile configuration methods described: import and
manual. The import method takes a DTAF as input and builds the BroadWorks device
profile type(s) automatically. The manual method takes the administrator through the
steps to manually add and configure the device profile type(s).
The import method should be used if all of the following prerequisites are met:

The BroadWorks Release is 17.0 or later.

The device profile type(s) being imported do not already exist on the system. (If either
a previous import or manual configuration was done, then the import fails.)

There is a DTAF file available for import with a BroadWorks release level that is the
same as or prior to the release to which it is being imported. If the DTAF file is at a
release level later than the release being imported to, then the import can fail.
Otherwise, use the manual method.
For more detailed instructions, refer to the BroadWorks CPE Kit Usage Guide [8] and the
BroadWorks Device Management Configuration Guide [2].
5.2.2.1
Configuration Method 1: Import
This section identifies the steps necessary to make use of the Device Management import
feature to configure BroadWorks to add the Gigaset Maxwell 10 as a Device
Management-enabled device type. Also, see the BroadWorks CPE Kit Usage Guide [8].
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 40 OF 52
Download the Gigaset Maxwell 10 CPE kit from BroadSoft Xchange at
xchange.broadsoft.com. Extract the DTAF file(s) from the CPE kit. These are the import
files. Repeat the following steps for each model you wish to import.
1)
Log in to BroadWorks as an administrator.
2)
Browse to System → Resources → Identity/Device Profile Types and then click
Import.
3)
Select Browse to find the extracted DTAF file for the model and then click OK to start
the import.
After the import finishes, complete the following post-import configuration steps:
4)
Browse to System → Resources → Identity/Device Profile Types.
5)
Perform a search to find the imported Gigaset device profile type,
Gigaset_Maxwell_10.
6)
Browse to the Profile page and change the Device Management Device Access
FQDN to your Xtended Services Platform (XSP) or XSP cluster address.
Figure 11 Device Access FQDN
7)
Click the Files and Authentication link and then select the option to rebuild all the
system files.
8)
After importing the DTAFs, restart the Application Server to load the TimeZoneAlias
files TimeZoneAliasLabels_Gigaset_Maxwell-10.properties.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 41 OF 52
5.2.2.2
Configuration Method 2: Manual
This section identifies the basic steps necessary for an administrator to manually configure
BroadWorks to add the Gigaset Maxwell 10 as a Device Management-enabled device
type. This method should not be used except in special cases as described in the opening
to section 5.2.2 Configure BroadWorks Device Profile Type.
For more detailed instruction on manual configuration, refer to the BroadWorks CPE Kit
Usage Guide [8] and the BroadWorks Device Management Configuration Guide [2].
The steps in this section can also be followed to update previously imported or configured
device profile type with new configuration file.
5.2.2.2.1
Create or Modify Device Profile Type
This section identifies the BroadWorks device profile type settings relevant to Device
Management for the Gigaset Maxwell 10.
Browse to System → Resources → Identity/Device Profile Types and perform a search to
find the Gigaset device profile type(s) created in section 3.1 BroadWorks Device Profile
Type Configuration or add the device profile type for each model using the settings from
section 3.1 BroadWorks Device Profile Type Configuration if they do not exist.
Configure the device profile type Signaling Address Type, Standard and Advanced options
settings to match the settings in section 3.1 BroadWorks Device Profile Type
Configuration.
Configure the device profile type Device Management options as shown in section 5.2.2.1
Configuration Method 1: Import.
The following subsections identify the required settings specific to Device Management.
5.2.2.2.2
Define Device Profile Type Files
This section describes the BroadWorks Device Management configuration necessary to
identify the configuration file that the Gigaset Maxwell 10 downloads.
Configuration file template used by the Maxwell 10 must be uploaded to BroadWorks.
Download the Gigaset Maxwell 10 CPE kit from BroadSoft Xchange at
xchange.broadsoft.com. Extract the configuration files from the Configuration Files folder
of CPE kit.
The following table identifies the Gigaset configuration files distributed with the 2.4.9 CPE
kit.
File Name
CPE Kit Template File Name
File Type
Description
BWMACADDRESS
.xmo
%BWMACADDRESS%.xml.t
emplate
Device-specific
This file contains all the
configuration that the device needs
to load.
TimeZoneAliasLab
els_Gigaset_Maxw
ell-10.properties
TimeZoneAliasLabels_Gigase
t_Maxwell-10.properties
Time Zone Alias
The time zone alias file is a
BroadWorks Device Management
file used to map time zone
identifiers between BroadWorks
and Gigaset devices.
Examples
Browse to System → Resources → Identity/Device Profile Types → Files and
Authentication to add the file as described in the following subsections.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 42 OF 52
5.2.2.2.2.1
BWMACADDRESS.xml
Add the BWMACADDRESS.xml file to the device profile type with the settings shown in
Figure 12.
After creating the device profile type file, upload BWMACADDRESS.xml, which is
extracted from the CPE kit obtained from Gigaset. Use the Browse button on the file
definition screen. Be sure to click Apply after uploading the file.
Figure 12 BWMACADDRESS.xml File Settings
5.2.2.2.3
Time Zone Mapping
The CPE kit contains a time zone properties file for each device model. This file maps the
BroadWorks user’s time zone settings to the device’s time zone settings.
This time zone mapping file TimeZoneAliasLabels_Gigaset_Maxwell-10.properties must
be added to the /usr/local/broadworks/bw_base/conf/dms directory on the Application
Server.
You must restart the Application Server for the TimeZoneAlias files to be picked up by the
system.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 43 OF 52
5.2.2.2.4
Language Mapping
To enable Device Management control of the phone language for languages other than
English, the languages defined on the BroadWorks Application Server must be mapped to
the device profile type Gigaset_Maxwell_10 definitions.
To perform the mapping, select the device profile type and from there select the
Languages link. The defined BroadWorks languages will be listed in a table. If languages
other than English do not appear, they have not yet been defined on the BroadWorks
Application Server.
The supported languages and required mapping are:
BroadWorks Language Identifier
Maxwell 10 Language Mapping
English (US)
1
English (BR)
1
French
5
German
0
Spanish (CALA)
2
Spanish (Spain)
2
Swedish
8
The language applied to an individual phone is determined by the language defined for the
user on the BroadWorks User’s Profile page (see Figure 13).
Figure 13 BroadWorks User Language Definition
5.2.3
Create Device Profile Instance
The previous sections defined the device profile type such that the system is ready to
mass deploy device profiles. A device profile is an instance of the device profile type and
defines the BroadWorks interface to an individual Gigaset device.
Browse to the BroadWorks <group> → Resources → Identity/Device Profiles page and
then select Add to add a new Gigaset Maxwell 10 device profile. Configure the device
profile as shown in the Figure 14 example.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 44 OF 52
Figure 14 Device Profile Instance
5.2.4
Configure BroadWorks User
Configure the user with the desired BroadWorks configuration and services. Any services
that require a specific configuration on the device are managed via Device Management
and are defined in the device configuration files, if the template files are created with the
correct Device Management tags.
The device profile created in the previous section must be assigned to the BroadWorks
user. Assigning the device profile to the user automatically causes the Device
Management feature to generate the device configuration files for this user’s device.
To assign the device profile to the user, browse to the BroadWorks <user> → Addresses.
5.2.5
Customize Tags
This section identifies custom tags used by the Maxwell 10 that may need to be
customized at the group or device profile. Customizing a tag at the group level overrides
the setting on the device profile type for the device profiles created within the group.
Customizing a tag at the device profile level overrides the setting at the device profile type
and/or group level for the individual device profile.
5.2.5.1
SBC Address Customization for Edge Device
In many deployments, an edge device, such as an enterprise SBC or application layer
gateway, is deployed on the enterprise edge. The edge device’s SIP server or outbound
proxy setting is configured with the service provider’s SBC IP address or FQDN. If there is
no edge device, the customization below does not apply.
To integrate the edge device with Device Management, the SBC address tag
(%SBC_ADDRESS%) defined in section 5.2.1.1 Create System Default Tags must be
overridden at the group level with the LAN address of the edge device. To do so, perform
that following steps.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 45 OF 52
1)
At the Group → Utilities → Configure Device page, select the Gigaset device profile
(for example, <partner-model>).
2)
Click on the Custom Tags tab.
3)
Click Add.
4)
For the tag, enter “SBC_ADDRESS”.
5)
For the value, enter the edge device LAN IP address.
6)
To save the tag data, click OK.
Repeat these steps for each Gigaset model provisioned in the group.
5.2.6
Configure Gigaset Maxwell 10
This section describes the steps necessary to manually configure the Gigaset Maxwell 10
to integrate with BroadWorks Device Management.
1)
Log in to the web user interface (UI) for the device. The default password is “admin”.
There is no default username for the web login.
Figure 15 Web Login
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 46 OF 52
2)
Go to Network and Connections → Phone System screen, and select Broadsoft from
Connected with phone system list.
Figure 16 Phone System Screen
3)
Go to System → Security screen, type the HTTP digest username and password.
The username and password must match the BroadWorks Device Access username
and password configured in section 5.2.3 Create Device Profile Instance.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 47 OF 52
Figure 17 Security Screen
4)
Go to System → Auto Provisioning screen, input BroadSoft Device Management
provisioning .xml file URL for Maxwell 10 at Start auto provisioning field, for example,
http://xsp1.iop1.broadworks.net:80/dms/Gigaset_Maxwell_10/%BWMACADDRESS.x
ml. Press Save and Start, and the auto provisioning starts. From this point, rebooting
the device also triggers provisioning.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 48 OF 52
Figure 18 Auto Provision Screen
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 49 OF 52
Appendix A: Reference Maxwell 10 Configuration File
The following is a reference configuration for the Maxwell 10 configured for use with
BroadWorks.
Device-specific File: profile.xml
NOTE: This is an example file and it should be used for reference only.
# SIP Device-specific Configuration File
<?xml version="1.0" encoding="ISO-8859-1"?>
<ProviderFrame xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="profile.xsd">
<Provider>
<MAC_ADDRESS value="filled out by the ap script"/>
<PROFILE_NAME class="string" value="Broadsoft"/>
<S_AREA_LOCAL_PREX class="string" value="0"/>
<I_AREA_COUNTRY class="integer" value="25"/>
<I_CALL_RECORD class="integer" value="2"/>
<B_RANDOM_PORT class="boolean" value="0"/>
<S_DIRECTED_PICKUP_CODE_1 class="string" value="*97"/>
<I_NAT_REFRESH_TIME_1 class="integer" value="20"/>
<S_VIDEO_RESOLUTION_EXTERNAL class="integer" value="0"/>
<S_SIP_PASSWORD_1 class="string" value="abcd1234"/>
<S_AREA_INTERL_AREA class="string" value="49"/>
<I_SIP_TRANSPORT class="integer" value="0"/>
<S_SIP_ACCOUNT_NAME_1 class="string" value="Broadsoft"/>
<I_SIP_PORT class="integer" value="5060"/>
<I_TONE_SCHEME class="integer" value="9"/>
<I_VOICE_QUALITY_1 class="integer" value="0"/>
<B_AUTO_SYNC_TIME class="boolean" value="1"/>
<I_RTP_PACKET_SIZE_1 class="integer" value="2"/>
<S_AREA_INTERL_PREX class="string" value="00"/>
<B_ACCEPT_NON_SRTP class="boolean" value="1"/>
<B_SIP_USE_STUN_1 class="boolean" value="0"/>
<B_CALL_WAITING_1 class="boolean" value="1"/>
<I_FUNCTION_KEY_CONNECTION_KEY_1 class="integer" value="0"/>
<I_RE_REGISTRATION_TIMER_1 class="integer" value="180"/>
<S_VIDEO_RESOLUTION class="integer" value="0"/>
<S_SIP_USER_ID_1 class="string" value="2417779999"/>
<I_PHONE_SYSTEM class="integer" value="2"/>
<I_SIP_PORT_1 class="integer" value="5060"/>
<I_OUTBOUND_PROXY_MODE_1 class="integer" value="0"/>
<S_SIP_SERVER_1 class="string" value="as.iop1.broadworks.net"/>
<B_SIP_ACCOUNT_IS_ACTIVE class="boolean" value="1"/>
<B_MISSED_ACCEPTED_COUNT_1 class="boolean" value="1"/>
<I_SIP_SERVER_PORT_1 class="integer" value="5060"/>
<S_SIP_REGISTRAR_1 class="string" value="as.iop1.broadworks.net"/>
<S_SIP_DISPLAYNAME_1 class="string" value="Reception"/>
<I_FUNCTION_KEY_TYPE_1 class="integer" value="5"/>
<S_SIP_PREFERRED_VIDEOCODER_1 class="string" value="0,1,2"/>
<I_RTP_PORT class="integer" value="49153"/>
<B_VOIP_NET_AM_ENABLED_1 class="boolean" value="1"/>
<B_HTTP_PROXY_ACTIVATE class="boolean" value="0"/>
<I_DEFAULT_ACCOUNT class="integer" value="0"/>
<S_TIME_NTP_SERVER class="string" value="ntp.org"/>
<S_VOIP_NET_AM_NUMBER_1 class="string" value="9999"/>
<I_RINGER_MELODIES class="integer" value="19"/>
<S_FUNCTION_KEY_NUM_1 class="string" value="1234"/>
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 50 OF 52
<S_SIP_LOGIN_ID_1 class="string" value="2417779999"/>
<B_DAYLIGHT_SAVING class="boolean" value="1"/>
<S_SIP_DOMAIN_1 class="string" value="as.iop1.broadworks.net"/>
<B_SRTP class="boolean" value="0"/>
<B_REMOTE_MANAGEMENT class="boolean" value="0"/>
<B_ICE class="boolean" value="0"/>
<I_TIME_ZONE class="integer" value="13"/>
<S_VOIP_PROVIDER_1 class="string" value="Broadsoft"/>
<I_RINGER_MELODIES_GC class="integer" value="5"/>
<B_AUTOMATIC_DTMF_1 class="boolean" value="1"/>
<I_RINGER_MELODIES_IC class="integer" value="19"/>
<I_RTP_PORT_1 class="integer" value="49500"/>
<I_RINGER_MELODIES_EC class="integer" value="9"/>
<I_SIP_REGISTRAR_PORT_1 class="integer" value="5060"/>
</Provider>
</ProviderFrame>
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 51 OF 52
References
[1] Gigaset Communications GmbH. 2014. Maxwell 10 Administration, A31008-N4001R102-1-7620. Available from Gigaset at wiki.gigasetpro.com.
[2] BroadSoft, Inc. 2017. BroadWorks Device Management Configuration Guide,
Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[3] BroadSoft, Inc. 2016. BroadWorks Redundancy Guide, Release 22.0. Available
from BroadSoft at xchange.broadsoft.com.
[4] BroadSoft, Inc. 2016. BroadWorks SIP Access Interface Interworking Guide,
Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[5] BroadSoft, Inc. 2017. BroadWorks SIP Phone Interoperability Test Plan, Release
22.0. Available from BroadSoft at xchange.broadsoft.com.
[6] BroadSoft, Inc. 2017. BroadWorks SIP Phone Functional Test Plan, Release 22.0.
Available from BroadSoft at xchange.broadsoft.com.
[7] BroadSoft, Inc. 2017. BroadWorks Device Management Interoperability Test Plan,
Release 22.0. Available from BroadSoft at xchange.broadsoft.com.
[8] BroadSoft, Inc. 2016. BroadWorks CPE Kit Usage Guide, Release 22.0. Available
from BroadSoft at xchange.broadsoft.com.
BROADSOFT PARTNER CONFIGURATION GUIDE – GIGASET MAXWELL 10
2017 BROADSOFT INC.
©
20-BD5537-00
PAGE 52 OF 52
Download PDF
Similar pages