GDMS User Guide
GDMS User Guide
User Guide
COPYRIGHT
The latest electronic version of this guide is available for download here:
https://www.grandstream.com/support
Grandstream is a registered trademark and Grandstream logo is the trademark of Grandstream Networks,
Inc. in the United States, Europe, and other countries.
Version 1.0.10.23
Table of Content
CHANGELOG ............................................................................................................... 25
WELCOME ................................................................................................................... 30
GETTING STARTED..................................................................................................... 34
Prerequisites ................................................................................................................................. 36
Version 1.0.10.23
Connect with GDMS ............................................................................................................................ 39
Overview .............................................................................................................................................. 40
Overview ....................................................................................................................................... 43
Overview ....................................................................................................................................... 43
Delete Account.............................................................................................................................. 55
Export Account.............................................................................................................................. 56
Version 1.0.10.23
Edit Device .................................................................................................................................... 71
Dashboard ........................................................................................................................................... 83
Overview .............................................................................................................................................. 86
Extension ............................................................................................................................................. 86
Delete Account.............................................................................................................................. 89
Export Extension........................................................................................................................... 90
Version 1.0.10.23
Add Device ................................................................................................................................... 92
Version 1.0.10.23
VoIP Device........................................................................................................................................ 129
Version 1.0.10.23
Delete CFG File .......................................................................................................................... 151
Version 1.0.10.23
ALERT MANAGEMENT ............................................................................................. 176
Version 1.0.10.23
Edit Subordinate Channel Customer .......................................................................................... 199
Version 1.0.10.23
Cancel Sharing Organization ............................................................................................................. 220
Version 1.0.10.23
API DEVELOPER ....................................................................................................... 251
Table of Tables
Table 1: GDMS Technical Specifications .................................................................................................... 32
Version 1.0.10.23
Table 20: Import UCM Device Template ..................................................................................................... 95
Version 1.0.10.23
Table 46: MFA Device Standards .............................................................................................................. 245
Version 1.0.10.23
Table of Figures
Version 1.0.10.23
Figure 25: Delete Account ........................................................................................................................... 56
Version 1.0.10.23
Figure 51: Virtual Device Interface .............................................................................................................. 78
Figure 62: UCM Devices That Have Not Synced Extensions ..................................................................... 87
Version 1.0.10.23
Figure 77: UCM List .................................................................................................................................. 100
Figure 91: Custom UCM Remote Access Domain Name ......................................................................... 110
Version 1.0.10.23
Figure 103: Storage & Backup .................................................................................................................. 119
Version 1.0.10.23
Figure 129: Edit Model Template .............................................................................................................. 142
Version 1.0.10.23
Figure 155: Search Task ........................................................................................................................... 164
Version 1.0.10.23
Figure 181: View Storage Space .............................................................................................................. 196
Figure 191: Copy and Paste Multiple MAC Addresses ............................................................................. 203
Version 1.0.10.23
Figure 207: Share Organization ................................................................................................................ 218
Figure 215: UCM Device -> Enable Cloud IM Service .............................................................................. 228
Figure 231: UCM Cloud Storage Add-on Plan Expiration ......................................................................... 239
Version 1.0.10.23
Figure 233: Download Invoice .................................................................................................................. 240
Version 1.0.10.23
DOCUMENT PURPOSE
This document introduces the GDMS platform and how to use it to manage various Grandstream products.
Currently, GDMS supports the GXV33xx series, WP820, WP810, GRP series, GXP21xx series, HT8xx
series, DP7xx series, and GVC3210.
To learn more information about the GDMS platform, please visit the link www.grandstream.com to get more
information.
• Product Overview
• Getting Started
• Device Management
• Account Management
• Device Configuration
• Site Management
• Task Management
• Device Diagnostics
• Alert Management
• Channel Management
• User Management
• Organization Management
• Value-Added Services
• Multi-Factor Authentication
• API Developer
• About GDMS
Version 1.0.10.23
CHANGELOG
Version 1.0.10.23
• Added to share organizations between enterprises. Organizations can be managed by the other
associated enterprises. [Share Organization]
• Added UCM-related alert types and App notification setting module. [Alert Notification Settings]
• Added an option to apply the changes to all devices when editing the “By Model” template. Added an
option to remember the current setting for option “Auto Provision to Devices in”, and the option will be
set following the setting for the previous model template when the user creates a new one. [Add
Template]
• Optimized the “UCM Devices” interface and added the feature to apply for the free trial plan. [Add
Device]
• Optimized the “My Plans” interface and added the feature to apply for the Cloud IM service. [Enable
Service]
• Optimized interface according to the specifications of the UCM RemoteConnect plans. [VALUE-ADDED
SERVICES]
Version 1.0.9.13
• Unified the account login center. Users do not need to select US regional server or EU regional server
for login. [GDMS Account Registration]
• VoIP System is classified by supporting VoIP Device and GXW45XX Device. [Supported Device Models]
Version 1.0.8.16
• Assigned permissions to separate the different subsystems in the GDMS platform. [Sub Systems]
• Added UCMRC system module and the navigation structure has been updated. Added Dashboard
module and Overview module and added displaying more UCM device status information. [UCMRC
SYSTEM]
• Optimized the UCM device list. Added Overview module and Plan Details information module in Device
Details module. [Figure 74: UCM Device Details]
Version 1.0.10.23
• Added a new default site when adding a new UCM device to the GDMS platform. [Add SIP Server]
• Added supporting remote access to the UCMRC, UCM permissions settings, and supporting accessing
the UCM Web UI without entering a password through the GDMS platform. [UCMRC SYSTEM]
• Added managing SIP server address for UCM devices, and support configuring the advanced settings
of SIP servers. [Add SIP Server]
• Added to support Spanish, Latin Spanish, French, Greek, and Arabic languages in the GDMS
platform. [languages]
Version 1.0.7.11
• Supported Host/Spare functionality for UCMRC services. Users can view the Host/Spare associations
in the GDMS platform and disassociate the relationship. [View/Disassociate Host/Spare UCM Device]
• Supported to allow users to diagnose UCMRC services availability. [UCM Device Diagnosis]
• Supported access to the Web UI of the VoIP devices remotely. [Remote Access to Device Web UI]
• Added time and date format settings in Personal Settings. [Time Format] [Date Format]
• Added the ability to convert configuration files. Supported converting the configuration file of UCM62xx
to the configuration file of UCM63xx. [Convert Configuration File]
• Added to display VPN IP address in VoIP Device Details interface. [View Device Details]
Version 1.0.6.10
Version 1.0.5.5
• Added support to synchronize UCM devices' alert notifications to the GDMS platform. [Synchronize
UCM Device Alert to GDMS]
• Added support to restore UCM backup files remotely through the GDMS platform. [Restore UCM
Backup File Remotely]
• Added support to diagnose UCM devices through the GDMS platform. [UCM Device Diagnosis]
Version 1.0.10.23
• Added to authorize Grandstream Support to manage devices. [Manage Device via GDMS Support]
Version 1.0.4.9
• Added Call Statistics module for VoIP devices. The SIP accounts in the devices which are using the
UCM Remote Connect service plan will report the call quality and statistical report. [Call Statistics]
• Added support to upload UCM device backup file to GDMS platform. [Upload Backup File]
• Added SMS Notification function in the GDMS platform. [APP Notification Settings]
• Added to allow users to add UCM devices to the GDMS platform with the original password. [Add
Device]
• Added support to configure multiple SIP servers for a single SIP account. [Add SIP Account]
• Added to allow users to set sending time for UCM daily statistical report. [Set Daily Report Receiving
Mailbox]
Version 1.0.3.4
• Added to support network diagnosis and system diagnosis functions in the device diagnosis module.
[DEVICE DIAGNOSTICS]
• Added to support to configure the concurrent upgrading devices amount for concurrent upgrade
tasks. [Supported Devices and Requirements]
Version 1.0.2.8
• Supported adding UCM63xx to the GDMS platform. Added PBX Device module: Remote access to
UCM63xx, restart UCM63xx, upgrade UCM63xx, view UCM63xx device details, data statistics report,
synchronize SIP accounts in the UCM63xx to GDMS platform, etc. [UCM Device Management
• Supported to view statistics report of UCM63xx device. The system can send the daily report to the
configured mailbox. [UCM Device Diagnosis]
• Supported viewing the enterprise/UCM cloud storage space usage. Users can receive alert
messages through a configured mailbox. [View Storage Space]
Version 1.0.10.23
• Supported notifying users when the plan will expire soon or has already expired. The alert notification
can be sent to the user through a configured mailbox. [View My Plans]
Version 1.0.1.16
• Added device local configuration synchronization function. Users can synchronize the SIP accounts
and parameters to the GDMS platform. [Synchronize Device Local Configuration]
• Added “Disable Push Configuration” function. Users can disable pushing the configuration to the
device through the GDMS platform. [Disable Push Configuration]
• Added file type “Others” in the Resources Management module. There is no file type limit if the user
selects the file type as “Others”. [Other Resources Management]
• Added to allow users to manage devices with GDMS mobile application. Users can use the
application to scan the bar code of the device to add the device to the GDMS platform, configure SIP
accounts and view alert messages, etc.
Version 1.0.1.3
• Added Custom Ringtone configuration and involved settings. [Configure Resource Files]
Version 1.0.0.65
• Added operation logs for different users and record the operation logs for each device. [SYSTEM LOG]
Version 1.0.10.23
• Support repeating tasks. [Repeating]
• Supported Multi-Factor Authentication function in GDMS platform to provide higher security protection
for GDMS account. [MULTI-FACTOR AUTHENTICATION]
• Supported copying and pasting the data from other organizations when users try to create a new
organization. [Clone Organization]
• Supported dividing group templates into multiple series templates, which is easier for users to
configure devices in different groups. [By Group]
• Supported filtering the devices in the specific city on the Device Distribution Map. [Search]
Version 1.0.0.42
Version 1.0.10.23
WELCOME
GDMS is a cloud-based solution that provides the ability to easily manage Grandstream products before,
during, and after deployment. GDMS separates subsystems independently based on different product lines:
VoIP phone systems, PBX systems, network systems, and gateway systems.
Version 1.0.10.23
PRODUCT OVERVIEW
Feature Highlights
• Intuitive deployment and management: GDMS’s easy-to-navigate web portal and batch operation
support allow users to easily deploy and manage Grandstream devices located on several sites.
• All-in-one solution: GDMS offers a complete package that offers convenient management of
devices and SIP server accounts on multiple sites, real-time monitoring and alerts, task scheduling
and tracking, and device diagnostics.
• One-click debugging: Easily collect system logs, network captures, and traceroutes with a click of
a button.
• Supports UCM device’s remote management and synchronizes SIP accounts to the GDMS
platform in real-time. All devices/SIP account one-stop management.
• Supports value-added services - UCM Remote Management Plan in GDMS platform. Supports
remote external network communication for UCM clients.
• Supports value-added services – Cloud Storage Space in GDMS platform. UCM users can store
more data and do not need to worry about storage space.
• Channel customer support: Allows automatic association of Grandstream ERP devices, allowing
for the establishment of channel relationships and quick device allocation.
• Powerful API integration features: GDMS is compatible with ERP/CRM/OA platforms to improve
workflow efficiency.
Version 1.0.10.23
GDMS Technical Specifications
• Account Management
• Device Configuration
• Firmware Upgrade
• Device Monitoring
• Intelligent Alarm
• Statistical Analysis
• Channel Management
• Task Management
• PBX Backup
Authentication • The key information of devices is encrypted and stored so that the key
• The account password is encrypted and stored with the sha256 algorithm
devices.
Version 1.0.10.23
• No limitations on the number of devices and SIP accounts that can be
Enterprise Features
managed.
• GXP series (Supported GXP21XX only, pending for other GXP models)
Supported Device
• GXV series (Supported GXV3370/GXV3380/GXV3350)
Models
• GRP series
• DP series
• WP series
• GVC series (Supported GVC3210 only, pending for other GVC models)
GDMS platform)
• UCM series
• HT series
Version 1.0.10.23
GETTING STARTED
GDMS Overview
For different models, users can select to use different systems in the GDMS platform.
Users can select to access the different sub-systems depending on the different managed device models
by clicking the system selection options on the left upper corner. As the screenshot shows below:
• VoIP System: Users can remotely manage IP phones such as GRP, GXP, GXV, WP, and DP
models, and the system provides unified configuration, real-time monitoring, scheduling/executing
tasks functions, etc.
• UCMRC System: Users can remotely manage UCM63xx devices and corresponding extensions,
and the system provides remote access, monitoring, upgrade functions, etc. The UCMRC system
provides a large cloud storage space, and it allows remote calls through external networks.
Version 1.0.10.23
Import Devices and Management
Users need to import the devices into the GDMS platform first to view the status and configuration of the
devices and monitor the devices on the GDMS platform.
Channel vendors could acquire devices directly through ERP, and the channel vendors need to submit
relevant certificates to Grandstream customer support.
Users could import a batch of SIP accounts with Excel files and allocate the batch of SIP accounts to
devices. Users could complete all accounts configuration for all devices by importing a batch of SIP
accounts to a batch of devices.
Configure Devices
• Configure devices by model: Once the device is associated with the GDMS platform, the device
will be allocated with the configuration parameters according to the device model and located site.
• Configure devices by group: Manage the devices by certain rules and groups, and the GDMS
supports pushing configuration files to all devices under a group.
• Configure a single device: Modify a specific device configuration in the Device list directly.
• Configure devices by configuration file: Users could upload the configuration file of the device into
the GDMS platform directly.
Firmware Upgrade
GDMS platform supports upgrading a batch of devices’ firmware by device model, site, firmware version
range, and other conditions. It also supports upgrading the devices’ firmware by a batch of MAC addresses
of the devices.
Schedule Tasks
Users could schedule certain tasks for a certain period. For example, users could schedule a firmware
upgrade task and execute the task in the early morning, so that the task will not affect the device owners.
In case of malfunction or dangerous operation of the devices, the administrator will be alerted. The GDMS
platform supports to allow administrators to diagnose faults of some devices to locate and resolve problems
Version 1.0.10.23
quickly.
Prerequisites
• Endpoint devices are in the supported device list of the GDMS platform.
If using GDMS for the first time, an administrator will need to register for a GDMS account using the
following steps:
Version 1.0.10.23
2. Click on Sign Up option to enter the registration page, and then fill in the following information:
Customer Type Select the customer type of the user. Available options are Provider, Reseller,
System Integrator, and Enterprise User.
Email Enter the email address that will be associated with the account. Account
activation and password reset emails will be sent to this address.
Username Enter the login name of the GDMS platform. The username is unique and will be
used to log in to the GDMS platform.
Password Enter the password that will be used to log into GDMS
Confirm Password Re-enter the password that will be used to log into GDMS
Version 1.0.10.23
Verification Code Enter the captcha displayed on the right of this field.
3. Once registration is complete, an account activation email will be sent to the configured email address.
Follow the instructions in the email to activate the account and complete registration.
The current GDMS platform version supports the following device models.
DP7XX
GRP26XX
WP810
WP820
GSC36XX, GSC35XX
Gateway GXW45XX
Device
IP-PBX UCM63XX
Version 1.0.10.23
Connect with GDMS
The devices must be upgraded to the firmware versions that are compatible with the GDMS platform.
Otherwise, the devices will not be able to connect to GDMS. When the devices connect to the Internet, and
the user has added this device to the GDMS account, the device will connect to GDMS automatically.
Version 1.0.10.23
VOIP SYSTEM
Overview
Device Statistics
• Total Accounts
• Total Devices
• Total Sites
• Accounts status
• Device status
• Device Type
• Site statistics
• Model statistics
Figure 4: Overview
Version 1.0.10.23
Table 4: Overview Labels
Module Description
Total Accounts Displays the total number of SIP accounts configured on GDMS.
Account Status Displays the total number of accounts currently registered, unregistered, and
unallocated.
• Normal: All devices which use this account are registered successfully.
Devices Status Displays the total number of devices currently online and offline.
Device type Displays the total number of devices in each category: audio, video, and
conferencing.
Site Statistics Displays the total number of devices assigned to each site and the allocation of
Model Statistics Displays the total number of each device model, the percentage of total devices
that each model makes up, and the distribution of different firmware per model.
Version 1.0.10.23
Figure 5: Model Statistics
Device Distribution
This menu will show the distribution map of the devices which have been associated with the enterprise.
• The dark blue area on the map shows that area has more associated devices, and the light blue
area shows the area has fewer devices.
• Users could leave the cursor on the area to check the number of devices in that area.
• If a certain city has the devices, it will be marked with a green dot , and users could leave the
cursor on the city to check the amount he devices in that city. The user can click on the dot to see
the devices list in this city.
Version 1.0.10.23
Overview
The Overview page displays all VoIP device statistics information in the current organization.
Account Management
Overview
On the SIP Account page, users can manage SIP accounts across all configured SIP servers in GDMS,
import a list of accounts for quick setup, and export a list of all accounts configured on GDMS.
Status Description
Status Normal: All devices using the account are registered, and the account is working normally.
Abnormal: At least one device using this account is not registered. Possible reasons include:
• The device is unable to register successfully.
• The account was modified through other means such as through the endpoint
device web portal or provisioning.
Unassigned: No devices are using this account.
From
UCM : This represents the SIP accounts are synchronized from the UCM device. If the user
modifies the SIP accounts in the UCM device, the updates will be synchronized to the GDMS
platform. The user can only edit the SIP server, assign a device, and cannot edit other
Version 1.0.10.23
information.
Operation Descriptions
Sorting Click on the buttons to sort the list in ascending/descending order based on a specific
column.
Custom
Users could customize the displaying options on the list by clicking on on the right
Display
Option side of the list to select the display hidden options.
Filter and Filter accounts by status, site, and search for specific accounts by entering in their user
Search IDs, account names, or display names.
The SIP Server page shows all of the SIP servers added to GDMS.
Version 1.0.10.23
Server Name Specifies an identity name for the SIP server. (Required)
SIP Server This is a necessary option. Specifies the URL or IP address, and port of the SIP
server. This should be provided by a VoIP service provider (ITSP).
Outbound Proxy Configures the IP address or the domain name of the primary outbound proxy, media
gateway, or session border controller. It is used by the phone for firewall or NAT
penetration in different network environments. If a symmetric NAT is detected, STUN
will not work and only an outbound proxy can provide a solution.
Secondary Sets IP address or domain name of the secondary outbound proxy, media gateway,
Outbound Proxy or session border controller. The phone system will try to connect the Secondary
outbound proxy only if the primary outbound proxy fails.
Voice Mail Access Sets if the phone system allows users to access the voice messages by pressing the
Number MESSAGE key on the phone. This ID is usually the VM portal access number. For
example, in UCM6xxx IPPBX, *97 could be used.
DNS Mode Defines which DNS service will be used to look up the IP address the for SIP server’s
hostname. There are three modes:
• A Record
• SRV
• NATPTR/SRV
To locate the server by DNS SRV set this option to "SRV" or "NATPTR/SRV".
NAT Traversal Specifies which NAT traversal mechanism will be enabled on the phone system. It
can be selected from the dropdown list:
• NAT NO
• STUN
• Keep-alive
• UPnP
• Auto
• VPN
Version 1.0.10.23
If the outbound proxy is configured and used, it can be set to “NAT NO”.
If set to "STUN" and the STUN server is configured, the phone system will periodically
send STUN message to the STUN server to get the public IP address of its NAT
environment and keep the NAT port open. STUN will not work if the NAT is
asymmetric type.
If set to “Keep-alive”, the phone system will send the STUN packets to maintain the
connection that is first established during the registration of the phone. The “Keep-
alive” packets will fool the NAT device into keeping the connection open and this
allows the host server to send SIP requests directly to the registered phone.
If the firewall and the SIP device behind the firewall are both able to use UPnP, it can
be set to “UPnP”. Both parties will negotiate to use which port to allow SIP through.
Proxy-Require Adds the Proxy-Required header in the SIP message. It is used to indicate proxy-
sensitive features that must be supported by the proxy. Do not configure this
parameter unless this feature is supported on the SIP server.
Additional Users could add the custom fields below. Some custom fields are only available for
Settings certain device models:
(4) Primary IP
(5) Backup IP 1
(6) Backup IP 2
Version 1.0.10.23
(11) Tel URI
For detailed filing rules, please refer to the User Guide of the devices.
Upon adding the SIP server, it will appear in the SIP Server list. Entries in the list can be edited or deleted.
The SIP Account page shows all the SIP accounts added to GDMS.
Account Name This is a necessary option. Specifies an identity name for the SIP account.
Version 1.0.10.23
SIP User ID This is a necessary option. Configures user account information provided by your
VoIP service provider (ITSP). It is usually in the form of digits similar to a phone
number or a phone number.
SIP Authentication This is a necessary option. Configures the SIP service subscriber's Authenticate ID
ID used for authentication. It can be identical to or different from the SIP User ID.
Password This is a necessary option. Configures the account password required for the phone
to authenticate with the ITSP (SIP) server before the account can be registered.
After saving, it will appear hidden for security purposes.
Name Configure the display name of the SIP account. This option will be used for the
Caller ID display. The configured content will be included in the From, Contact, and
P-Preferred-Identity header of the SIP INVITE message
Voicemail Access If the SIP Server also configures this item, this configuration will prevail.
Number
SIP Server This is a necessary option. Users need to select the SIP server for the SIP account.
If there is no available SIP server for the current SIP account, users could click on
the “Add Server” option to add a new SIP server for the SIP account.
Add Server If the user needs to configure multiple SIP server addresses for a single SIP
account, such as the UDP/TLS protocol server address (The UCM63xx device
which purchases the UCM Remote Connect plan can synchronize multiple protocol
server addresses to the GDMS platform), the user can configure it and assign to
devices separately.
Assign device This option will allow to assign a specific device to this account.
Allocate to Devices:
To associate devices currently in GDMS with the new SIP account, click on the Add button at the bottom
of the screen and enter the following information:
Version 1.0.10.23
Figure 11: Assign Device
Site This option is used to set which site this device belongs to.
Select Device This is a necessary option. Users need to select the device model to which the
Model account will be allocated.
Select Device This is a necessary option. Users need to select the device MAC address to which
MAC Address the account will be allocated.
Select Account This is a necessary option. Users need to select the account index to which the
Index account will be allocated (e.g., Account 1 – Account 16). If the account location has
a configured account, the account number will be displayed.
Select Server This is a necessary option. Users can select the SIP Server address for the device,
Address such as the UDP server address or UCM Remote Connect server address.
Notes:
• Assigning accounts to DP devices and HT devices from this page are currently not supported.
Please use the account importing feature or the Device Management page to manage SIP accounts
on DP devices and HT devices.
Version 1.0.10.23
• If a device is not on GDMS, users will be unable to allocate SIP accounts to it.
GDMS platform supports allows users to import a batch of SIP accounts and SIP servers to the system and
allocate them to the devices via Excel files.
1. On the SIP Account page, click on the Import Account button. The following window will appear:
2. Click on either the Download General Device Template button, Download DP Device Template, or
Download HT Device Template button to get a template that will be used to import account and server
information.
Version 1.0.10.23
Figure 14: Import Account Template – DP Device Template
Account Name This is an optional option. Users need to set the identity name for the SIP account.
SIP Server This is a necessary option. Users need to input the SIP server address. If the SIP
server does not exist in the GDMS platform, the GDMS platform will create the SIP
server in the system.
SIP User ID This is a necessary option. Configures user account information provided by your
VoIP service provider (ITSP). It is usually in the form of digits similar to a phone
number or a phone number.
SIP This is a necessary option. Configures the SIP service subscriber's Authenticate ID
Authentication ID used for authentication. It can be identical to or different from the SIP User ID.
SIP This is a necessary option. Configures the account password required for the phone
Authentication to authenticate with the ITSP (SIP) server before the account can be registered. After
Password saving, it will appear hidden for security purposes.
Display Name Configure the display name of the SIP account. This option will be used for the Caller
ID display. The configured content will be included in the From, Contact, and P-
Preferred-Identity headers of the SIP INVITE message.
Device MAC Input the device MAC address: e.g., 00-15-65-1A-2B-3C; 00:15:65:1a:2b:3c;
Address 0015651a2B3c
Account Index Users need to select the account index to which the account will be allocated (e.g.,
Account 1 – Account 16). If the current account location has a configured account,
the configured account will be replaced with the new account information.
Version 1.0.10.23
Profile For DP devices and HT devices only. Enter the profile that the account will use (e.g.,
Profile1, Profile2, etc.). If multiple different SIP servers use the same profile, the
import will fail.
HS Mode For DP devices only. Enter the HS mode for the account. Available options are
“Circular”, “Linear”, “Parallel”, and “HSx”, where x can be 1 to 5.
HS1-HS5 For DP devices only. Users could configure the Line for each handset from Line 1 to
Line 10. Each SIP account can be allocated to different handsets.
Port Type This option is valid only for HT devices. Input the port type which will be assigned to
(FXS/FXO) the device. Users could select FXO port type or FXS port type.
Port Serial This option is valid only for HT devices. Input the port serial number which will be
Number assigned to the device. Users could input the port serial number from Port 1 to Port
10.
Search Group This option is valid only for HT devices. Users could select the search group between
None (default), Active, and other port serial numbers beside your own.
3. Once the template is filled out, drag, and drop the file to the upload window or select the file
from your PC. Click on the Import button to confirm the import.
4. When the Excel file is imported into the GDMS platform successfully, the GDMS platform will
prompt the execution result. If there is data that failed to be imported, the user could export
the failed data and re-edit the Excel file.
Examples:
1. If the user wants to allocate 1 SIP account to multiple devices, the 1 st SIP account information will be
the correct information to allocate to the devices. Please see the example below, the SIP account display
name “Sqhuang” will be allocated to the involved devices:
2. For the existing SIP account, if the user wants to allocate this SIP account to another device, here is
the example: Account 100 has been allocated to Device 1, and the user wants to allocate the SIP account
100 to Device 2 (00:aa:bb:cc:dd:ee).
Version 1.0.10.23
3. If the user wants to allocate multiple SIP accounts to a single device, here is an example:
4. If the user wants to allocate multiple SIP accounts to a single DP device, here is the example:
Incorrect examples:
1. If the user wants to allocate multiple SIP accounts to a single device, the account index cannot be the
same.
2. Different SIP server addresses cannot be allocated to the same Profile in the same DP device.
3. If the user wants to allocate the SIP accounts to the same DP device, the different SIP accounts cannot
be allocated to the same HS Line.
Allocate Device
Users could allocate the SIP accounts to the devices by adding SIP accounts, editing SIP accounts, or
importing a batch of SIP accounts to the GDMS platform. Each SIP account can be allocated to multiple
devices.
Edit Account
Users could edit the SIP account information and allocated devices on the Edit Account configuration page.
1. Click on the button for the SIP account you want to modify.
Version 1.0.10.23
Figure 23: Edit Account
2. Click on the Save button to finalize changes. All associated devices will receive the updated account
information.
3. Click on the button to unallocated devices from the account. The SIP account will be removed from
unassigned devices.
Notes:
• If the device is offline at the time, its SIP account information will be updated when it is online again.
• If the SIP server is synchronized from the UCM server, it cannot be edited, and it can only be
assigned to the device.
Users can batch modify the SIP server of the SIP accounts, e.g., Modify the SIP protocol of the SIP server
from UDP to TCP.
1. On the “SIP Account” interface, select the SIP accounts that need to be modified.
Note:
The user can select the SIP accounts by searching the items. E.g., If the user wants to modify the SIP
server for 250 SIP accounts, the user can set the page to display 250 SIP accounts at once from 10 SIP
accounts per page and select all SIP accounts on the page.
Version 1.0.10.23
2. Click on the “Modify SIP Server” button at the top of the interface.
3. Select the target SIP server, which can be searched by the server name.
4. After clicking the “OK” button, the SIP server corresponding to the SIP accounts will be modified
immediately. Then, the updated account information will be assigned to the corresponding VOIP devices.
Note:
If the SIP accounts are synchronized from the UCM device, the accounts’ information will be synchronized
after the SIP server is modified.
Delete Account
To delete SIP accounts on GDMS, click on the button for a single account or the Delete button in the
top-left corner for multiple accounts. Associated devices will automatically remove deleted SIP account
information.
Users could delete 1 single SIP account or a batch of SIP accounts on the GDMS platform:
Version 1.0.10.23
Figure 25: Delete Account
Note:
If the SIP account is synchronized from the UCM server, this will only delete the data in the GDMS platform,
and the data in the UCM server will not be deleted.
Export Account
Users can export all existing SIP accounts in GDMS to a file by clicking on the Export Account button in
the top-right corner of the SIP Account page.
Users can edit SIP server information by clicking on the button for the desired SIP server. Changes
Note: If the SIP server is synchronized from UCM server, it cannot be edited.
Users can delete selected SIP servers by selecting them in the SIP server list and clicking on the Delete
button in the top left corner of the SIP Server page.
Version 1.0.10.23
Figure 26: Delete SIP Server
Note:
If the SIP server is synchronized from UCM server, this will only delete the data in the GDMS platform, and
the data in UCM server will not be deleted.
Device Management
The Device page shows all the associated VOIP devices and GXW45XX devices. Users can view the
information and status of the devices, the allocated account information, etc. GDMS platform allows users
to configure parameters, upgrade firmware, reboot/factory reset devices, view device details, device
diagnostics, and other operations.
Version 1.0.10.23
Status Descriptions
Status
The device is offline. The current account status is the last reported status before
Indicator
the device is offline.
The device network penetration (NAT) is abnormal, the GDMS server cannot
connect to the device, but the device can periodically obtain the configuration.
Account Normal: The allocated accounts from the GDMS platform to the devices are registered
Status successfully, and all accounts can be used normally.
Abnormal: Some of the device’s allocated accounts are unregistered. This may be due
to the following reasons:
No Account: GDMS platform does not allocate any account to the device.
Last Config Synchronizing: If the account and device parameters were modified, the changes will
Time immediately be pushed to the device. This status will be shown while this is happening.
HS Status
The SIP account is configured on the handset.
Version 1.0.10.23
Operation Description
Sorting
Click on the sorting buttons to sort the list by various columns in
ascending/descending order.
Custom Display
Click on the button on the top right corner of the list to select the columns
Option
to show and/or hide.
Search In addition to being able to search for devices with the search bar near the top-
right corner of the page, users can further refine search results by clicking on
the Filter button by specifying account status, device status, site, city, and
firmware version.
Add Device
To add a new device to GDMS, click on the Add Device button. The following window will appear:
Version 1.0.10.23
Device Name (Optional) This option is used to set the name of the device so that the users could
identify this device. The maximum number of the input characters is up to 64.
MAC (Required) This option is used to enter the MAC address of the device. (Locate the MAC
address on the MAC tag of the unit, which is on the underside of the device, or the
package)
Serial Number (Required) This option is used to enter the serial number of the device. (Locate the Serial
Number on the MAC tag of the unit, which is on the underside of the device, or the
package)
Select Site (Required) This option is used to set which site this device belongs to. The default setting
is the “Default” site.
Notes:
• Each device can only be associated with only one GDMS account.
• Users can use the search bar on the Device page to find added devices via device name, MAC
address, and sites.
Users can import multiple devices by uploading a file. Click on the Import Devices button on the Device
page to get started. The following window will appear:
Version 1.0.10.23
Figure 30: Import VOIP Device
1. Click on the button to download the template. Users must follow the
instructions to enter the required information.
MAC Address Users need to fill in the MAC address of the device in this field (Required). For instance,
000B82E21234, and supports filling” and “-” characters in this field.
SN Users need to fill in the serial number of the device in this field (Required).
Version 1.0.10.23
Device Name This option is used to set the name of the device so that the users could identify this device
(Optional). The maximum number of the input characters is up to 64.
Site Name Enter the site to assign this device to (Required). If the site is under more than one level,
all site levels must be included in the site name (e.g.,
first_level/second_level/…/new_site). If the site level does not exist, it will be automatically
created. The maximum character limit is 64.
3. Users can drag the file to the pop-up window, or they can click the upload button to select a file
from their PC to import.
4. Once the file is imported into GDMS, the result window will appear. If any data failed to import
successfully, users can export the problematic data, re-edit, and attempt to import them into GDMS
again.
Notes:
• If an existing device on GDMS is imported, the device’s existing information will be replaced with
the newly imported information.
• If a device’s MAC address and serial number are invalid, the import will fail.
Users can configure SIP accounts for each device from the Device page.
1. In the devices list, click on the icon corresponding to the account to access the Account
configuration page.
2. After clicking the button, users will see the Account configuration page as the figure shows below:
Version 1.0.10.23
Figure 32: Configure SIP Account
3. On this Account Configuration page, users can select the SIP accounts created in the SIP
Account page to assign to the device.
4. Users could also select to replace the existing SIP account for a specific account or delete the
existing accounts.
5. Click on the Save and Apply button. The accounts will then be assigned to the device.
Notes:
• If a device is offline during the account assignment, GDMS will synchronize any changes to it the
next time it goes online.
• Settings configured via other means (e.g., endpoint device web portals, Zero Config provisioning,
etc.) will not be synchronized to GDMS.
Users could configure SIP accounts and lines for DP devices. GDMS platform allows users to view the
existing SIP accounts for current devices and edit/delete the accounts.
1. In the devices list, click on the icon corresponding to the account to access the Account
configuration page.
Version 1.0.10.23
2. After clicking the button, users will see the figure as shown below:
User ID Allocated: This SIP account has already been allocated to other devices;
Unallocated: This SIP account has not been allocated to any device.
HS Mode If this field is not filled, the default setting is “Circular” mode.
Version 1.0.10.23
3. To configure the lines for each HS mode, click on the Line Configuration tab.
Note:
Set up a line account for each handset and select the SIP accounts from the configured accounts in the
device.
4. Select the desired SIP accounts to use for each line and handset.
5. Click on the button Save and Apply to allocate the SIP accounts or lines to the devices.
Notes:
• If a device is offline during the account assignment, GDMS will synchronize any changes to it the
next time it goes online.
• Settings configured via other means (e.g., endpoint device web portals, Zero Config provisioning,
etc.) will not be synchronized to GDMS.
• For device-specific configuration rules, please refer to the DP device user guide.
Version 1.0.10.23
Device Parameters Configuration
1. In the device list, click on the button to go to the Device Parameters Configuration page,
as shown in the figure below:
a) Clicking on the Select All button will select every option on the current page. Clicking on it
again will deselect all the options.
b) Clicking on the Reset Settings button will restore all settings on the current page to default
values.
c) Clicking on the button following the account, users can copy and paste the current
account configuration to other accounts.
d) When users try to configure the device wallpaper or screensaver image, users can select a
picture from the resources list, or upload the local picture to GDMS and configure it to the
device.
Version 1.0.10.23
Figure 36: Ringtone Configuration
2. Modify the desired settings on the page or click on the Switch to GUI Editor to configure device
settings via text editing (i.e., p-values).
a. The format requirement is key=value. The Key can be either a P-value or an alias.
b. Users can enter the latest parameters and values of a device in the text editor even if the
GDMS configuration page does not display the configuration options.
3. Click on the Save and Apply button to finalize changes. Only settings that are checked will be
pushed to the device.
Notes:
• If the device is not connected to the GDMS platform currently, the device cannot be synchronized
with the GDMS platform. When the device is connected to the GDMS platform, the allocated
accounts will be synchronized on the device immediately.
Version 1.0.10.23
• The SIP accounts which are configured manually on the device will not be synchronized to the
GDMS platform.
• For the configuration rules, please refer to the User Guide of the devices.
Users can configure custom ringtone and language for devices (Supported models: GXP/DP series).
1. On the Device list, click on the button to go to the Device Parameters Configuration →
Resource Configuration page, as shown in the figure below:
2. On the “Custom Ringtone” page, for Ringtone 1 to Ringtone N, select a ringtone file from the
resources for each ringtone index.
3. On the “Language Configuration” page, select a language pack from the resources for the device.
4. Click on the “Save and Apply” button, and the device will download the selected resources from the
firmware path.
Note:
For each device model, the size and duration of each ringtone are different. If the duration and size exceed
Version 1.0.10.23
the limit, the system will intercept the resource file to the maximum limit automatically.
Before the device is configured, the user can synchronize the device’s local configuration to the GDMS
server.
1. Select a specific device, click the icon, and select the option “Synchronize Device Local
Configuration”.
2. Click “OK” to confirm synchronization on the pop-up window. Then, the GDMS server will synchronize
all the account configuration and parameters of the current device to the GDMS server.
Notes:
• If the device's parameter configuration conflicts with the server's configuration, the device's local
configuration prevails.
• If the account on the device does not exist on the GDMS server, the SIP account and server are
automatically created on the GDMS server.
If the user does not want to push any configuration to the device through the GDMS server, please follow
the steps below:
1. Select a specific device, click the icon and select the option “Disable Push Configuration”.
2. Click “OK” to confirm the operation, the account configuration or parameters will not be pushed to the
device through the GDMS server anymore, including the scheduled tasks. The configuration that has not
been pushed to the device will not be pushed to the device anymore.
Notes:
If the user wants to resume pushing the configuration or parameters to the device, the user can click the
“Enable Push Configuration” option to operate in the GDMS server.
Click on the button to view a specific device’s system information and account status.
Version 1.0.10.23
Figure 39: View VoIP Device Details
The device details include System information, Network information, Account status, etc.
Note:
The information on this page is obtained from the device in real-time. If the device is offline, the details page
will be inaccessible.
Version 1.0.10.23
Edit Device
Users could edit the Device name and which site the device belongs to.
1. In the device list, click on the button which is following the device, and select Edit Device
to access to the device editing page.
2. Users will see the device editing page as the figure shows below:
Version 1.0.10.23
3. Click on Save button to apply the changes on the GDMS platform.
Users could view all operation logs for a specific device on the GDMS platform.
1. On the Device List, select the menu button following the specific device, and click on the
“Operation Log” button.
2. Access to the Operation Log menu of the device, the menu includes the operation logs of device SIP
account configuration, updating configuration parameters, device rebooting, device upgrading/downgrading,
device factory reset, device diagnostics, etc.
Note:
Users could only view the device operation logs for the last 30 days.
Users could view all task histories in the subsystem for a specific device on the GDMS platform, including
immediate tasks and timed tasks.
1. On the Device List, select the menu button following the specific device and click on the “Task
History” button.
2. Access the Task management page, and search for all tasks of the specific device.
Version 1.0.10.23
Figure 44: View VoIP Device Task History
Firmware Upgrade
Users could upgrade firmware for a batch of devices to a specific firmware version.
1. In the device list, check multiple devices, and then click on the button Upgrade Firmware on the
top of the Device page.
3. Task Time: Select when to start the firmware upgrade. Users can choose to upgrade immediately
or to schedule the firmware upgrade for a specific time.
Version 1.0.10.23
4. Click on the Save button to create the task. Users can check the status of the upgrade by navigating
to the Task Management page.
Notes:
• Users cannot batch upgrade different device models or models on different firmware.
• If the desired firmware is not available, users will need to contact their GDMS administrator.
Site Assignment
Users could edit the site of a batch of devices on the GDMS platform. The default site is “default”.
1. Select the desired devices and click on the Site Assignment button.
3. Click on the Save button, and all selected devices will be transferred to the selected site.
Note:
Move Device
Version 1.0.10.23
Figure 47: Move Device
3. The user needs to select whether to clone the SIP account and server which have been configured
in the devices. If the user selects “No”, only the device data are transferred to the new organization,
and the configured SIP accounts become empty after moving the devices.
On the GDMS platform interface, even though the VoIP device is under the internal network, the user can
remotely access the VOIP device Web UI through the external network for viewing data and configuration.
Note:
This function is only supported in GRP260x firmware version 1.0.3.x and above.
1. Go to VoIP Device interface, click the “More” settings for a VoIP device → Remote access to Device
Web UI, as the screenshot shows below:
Version 1.0.10.23
Figure 48: VoIP Device List
2. Go to the Web UI, and log in to the VoIP device through the username and password. As the screenshot
shows below:
Version 1.0.10.23
Remote Access to Device Interface
On the GDMS platform interface, even though the VOIP device is under the internal network, the user can
remotely access the VOIP device Interface through the external network for viewing data and configuration.
Note:
This function is only supported in GRP260x firmware version 1.0.3.x and above.
1. Go to VoIP Device interface, click the “More” settings for a VoIP device → Remote access to Device
Interface, as the screenshot shows below:
2. Enter the virtual device interface, the user can control the virtual buttons on the device and the LCD
screen, as the screenshot shows below:
Version 1.0.10.23
Figure 51: Virtual Device Interface
Reboot Device
Users could reboot one device or a batch of devices on the GDMS platform.
2. Task Time: Select when to start the device reboot. Users can choose to reboot immediately or to
schedule the reboot for a specific time.
3. Click on the Save button to create the task. Users can check the status of the reboot by navigating
to the Task Management page.
Version 1.0.10.23
Factory Reset
Users could factory reset one device or a batch of devices on the GDMS platform.
2. Task Time: Select when to factory reset the device. Users can choose to factory reset the device
immediately or to schedule the factory reset for a specific time.
3. Click on the Save button to create the task. Users can check the status of the reboot by navigating
to the Task Management page.
Note:
Factory resetting a device will erase all existing settings on it such as accounts, call history, contacts, etc.
The device will synchronize with GDMS the next time it goes online after the factory reset.
Delete Device
Users could delete one device or a batch of devices on the GDMS platform.
Version 1.0.10.23
Figure 54: Delete Device
2. Click on the OK button on the pop-up window to confirm deleting the devices, and the selected
devices will be deleted immediately from the GDMS platform. The timing tasks involve the deleted
devices will be canceled either.
Export Device
To export the entire device list, click on the button in the top-right corner of the device list
page. The exported list includes all device and account information.
Version 1.0.10.23
Manage Device via GDMS Support
If the user's device is abnormal and wants Grandstream Support to troubleshoot the problem, the user can
enable to manage the device through GDMS Support.
After the authorization is assigned, Grandstream Support can diagnose the device and assign parameters
to the device.
1. On the VoIP Device list, click the “More” button following the device and select to access the
“Authorization Management” interface, as the screenshot shows below:
2. Enter the authorization duration, which can be set between 1 to 9999 minutes, according to the time
required for problem troubleshooting.
3. Once the user clicks the “Authorization” button, Grandstream Support can only manage the device
within the authorization period. Once the authorization period ends, Grandstream Support cannot manage
the device.
1. When the problem is confirmed, the user can end authorization manually. The user can click the “More”
button following the device, and select to access the “Authorization Management” interface, as the
screenshot shows below:
Version 1.0.10.23
Figure 57: Stop Authorizing Manually
2. The user can click the “Stop Authorizing” button to stop managing the device immediately, then
Grandstream Support cannot manage the device.
Version 1.0.10.23
UCMRC SYSTEM
Dashboard
Device Statistics
• Total Devices
• Alert Management
Module Description
Total • UCM Device: Display the number of all UCM devices in the enterprise.
Version 1.0.10.23
• VOIP Device: Display the number of VoIP devices that use the UCM
Alert Display the latest 5 high and medium-level alert messages of the UCM devices in
VoIP Device Status Display the number of devices that are currently online, offline, and network
restricted:
• Online: The network connection between the device and the GDMS
platform is normal.
VoIP Device Type Display the number of devices in each category: audio and video.
UCM Real-time Status Display the real-time status of all UCM devices in the current GDMS platform:
• Current Calls: Display the number of current calls and the remote calls.
• SIP Extension Status: Display the number of the extensions which have
• Trunk: Display the number of total trunks, the number of the trunks in
• UCMRC Plan: Display the UCMRC plans status, which is valid, almost
Version 1.0.10.23
expired, and expired.
• Storage Space: Display the storage space details of UCM local and
Note:
Only UCM devices firmware version 1.0.11.X or higher version support displaying
Call Statistics
The Call Statistics module displays all UCM devices’ call statistics information in the current system.
The user can select up to 3 UCM devices at one time to view the call statistics information in the latest 7/30
days.
The call statistics information contents include the number of total calls, the number of total remote calls,
and the number of maximum concurrent remote calls.
Device List
The Device List module displays all devices listed in the UCMRC system of the current enterprise account,
including the VoIP devices and PBX devices. Users can search devices by MAC addresses of the devices.
Version 1.0.10.23
Figure 60: Device List
Overview
The Overview module displays the overview information of each organization, including the Device
Statistics and Call Statistics.
Device Statistics
This module displays the same information in the UCMRC system → Dashboard → Device Statistics.
Call Statistics
This module displays the same information in the UCMRC system → Dashboard → Call Statistics.
Extension
The module displays the extension information of all UCM devices in the selected organization.
Version 1.0.10.23
Figure 61: Extension Management Interface
If the extensions in the UCM device have not been synchronized to the GDMS platform yet, the user can
click to view the UCM devices which have not synchronized the extensions and the corresponding reasons
on the GDMS platform. Please see the screenshot below:
Note:
⚫ If the user has not purchased a UCMRC plan with the corresponding feature, the user cannot
Version 1.0.10.23
synchronize the extensions in the UCM device to the GDMS platform account.
⚫ If the user has purchased a UCMRC plan which contains the extension synchronization feature, the
user needs to access the UCM device management platform to enable the “SIP Extension
Synchronization” feature.
The user can click button to access the UCM device Web UI to edit the extensions. As the screenshot
shows below:
Note:
If the UCM device is currently offline, the user cannot access the UCM device web UI.
Assign Account
The user can click button to assign accounts to the VoIP devices in the current system.
Version 1.0.10.23
Notes:
• Users cannot edit SIP User ID, Authentication ID, Authentication Password, Display Name,
Voicemail Access Number, and Email options.
• The SIP servers are synchronized from the UCM devices and the remote service addresses of the
UCM devices. The SIP Server field cannot be edited.
• The devices that can be assigned are the same as the devices in the VoIP system.
Delete Account
1. Select an extension to delete, click button or button to delete the extension. The
user can select to delete one extension or select multiple extensions to batch delete the extensions.
2. Click on the “OK” button, the deleted extensions will be disassociated from the corresponding UCM
devices.
Users can modify the SIP server of one or multiple extensions in this module.
Version 1.0.10.23
1. Select the extension that the user wants to modify the SIP server.
3. Click on “OK” button to apply the changes. Once the SIP server is modified, the new SIP server settings
will be assigned to the associated device.
Export Extension
Users can click the “Export Extension” button on the right upper corner of the Extension module to export
the extensions in the current enterprise in the GDMS platform.
Note:
Users cannot add extensions in this module, and all extensions are synchronized from UCM devices.
The UCM Device menu shows all associated UCM devices. Users can view the firmware version numbers,
IP addresses, plans, and other information of the UCM devices. It also allows users to access the device,
upgrade firmware, reboot the devices remotely, etc.
Version 1.0.10.23
Figure 67: UCM Device Management interface
Status Descriptions
The device network penetration (NAT) is abnormal, the GDMS server cannot
connect to the device, but the device can periodically execute
Firmware
This icon indicates device firmware version is too low, and the device cannot be
version too low
used normally with GDMS.
Plan expiring
This indicator means the plan is expiring soon or already expired.
Operation Description
Sorting
Click on the sorting buttons to sort the list by various columns in
Version 1.0.10.23
ascending/descending order.
Custom Display
Click on the button on the top right corner of the list to select the columns
Option
to show and/or hide.
Search In addition to being able to search for devices with the search bar near the top-
right corner of the page, users can further refine search results by clicking on
the Filter button by specifying device status, site, city, and firmware version.
Add Device
To add a new UCM device to the GDMS platform, users can click on the Add Device button. Please see
the screenshot below:
Device Name (Optional) This option is used to set the name of the device so that the users could
Version 1.0.10.23
identify this device. The maximum number of the input characters is up to 64.
MAC Address (Required) This option is used to enter the MAC address of the device. (Locate the MAC
address on the MAC tag of the unit, which is on the underside of the device, or the
package. Or the address can be viewed on the UCM Web GUI → System Status →
System Information → Network interface (LAN MAC address).
Initial (Required) This option is used to enter the Initial Password of the device. The original
Password password can be viewed on the UCM’s case or LCD.
Select Site (Required) This option is used to set which site this device belongs to. The newly created
site name is the same as the name of the UCM device, as the first level site. The user
can also select another site.
Notes:
• Currently, users can only add UCM63xx devices to the GDMS platform.
• When the device is added to the GDMS platform successfully, the SIP accounts in UCM63xx will
be synchronized to the GDMS platform by default. If the user wants to turn off the synchronization
function, please refer to the UCM63xx RemoteConnect Guide for details.
• Each device can only be associated with only one GDMS account.
• Users can use the search bar on the Device page to find added devices via device name, MAC
address, and sites.
After clicking the “Save” button, the device will be added to the GDMS platform successfully, and the user
can apply for a UCMRC advanced plan free trial for this device.
Version 1.0.10.23
Figure 70: Added Device Successfully
Note:
⚫ Each UCM device only can apply for a UCMRC advanced plan free trial once for 3 months. If the user
purchased a UCMRC plan before or applied for a UCMRC plan free trial before, the user cannot apply
for another free trial anymore.
⚫ If the user has not applied for a UCMRC plan free trial before, the user can apply for it on the “UCM
Devices” list.
Users can import multiple devices by uploading a file. Click on the Import Devices button on the Device
page to get started. The following window will appear:
Version 1.0.10.23
Figure 71: Import UCM Device
• Click on the button to download the template. Users must follow the
instructions to enter the required information.
MAC Address Users need to fill in the MAC address of the device in this field (Required). For instance,
000B82E21234, and supports filling” and “-” characters in this field.
Original Users need to fill in the original password of the device in this field (Required). The original
Password password can be viewed on the UCM’s case or LCD.
Device Name This option is used to set the name of the device so that the users could identify this device
(Optional). The maximum number of the input characters is up to 64.
Site Name Enter the site to assign this device to (Required). If the site is under more than one level,
all site levels must be included in the site name (e.g.,
first_level/second_level/…/new_site). If the site level does not exist, it will be automatically
created. The maximum character limit is 64.
• Users can drag the file to the pop-up window, or they can click the upload button to select a file
from their PC to import.
Version 1.0.10.23
• Once the file is imported into GDMS, the result window will appear. If any data failed to import
successfully, users can export the problematic data, re-edit, and attempt to import them into GDMS
again.
Notes:
• Currently, users can only add UCM63xx devices to the GDMS platform.
• When the device is added to the GDMS platform successfully, the SIP accounts in UCM63xx will
be synchronized to the GDMS platform by default. If the user wants to turn off the synchronization
function, please refer to the UCM63xx Remote Connect Guide for details.
• If an existing device on GDMS is imported, the device’s existing information will be replaced with
the newly imported information.
• If a device’s MAC address and serial number are invalid, the import will fail.
In the UCMRC system, the user can quickly view all SIP server addresses in the Device List. For a certain
SIP server address, the user can quickly view the advanced settings of the SIP server, including all
advanced settings of the SIP server in the VoIP system.
Version 1.0.10.23
Figure 73: UCM Device Details
Note:
The information on this page is obtained from the device in real-time. If the device is offline, the details page
Version 1.0.10.23
will be inaccessible.
Select the plan for a specific UCM device to view the plan of the device, expiration date, currently used
cloud storage space, and total cloud storage space.
Access This is used to configure Wave phones so that Wave users can connect to the UCM
Server server and make calls at anytime, anywhere on any network.
If the user wants to configure the remote service address on the terminals for remote
calls, the user can enable the button and obtain the remote service address.
Storage Refer to the current storage space used by the UCM device, and the total storage space
Space of the UCM device. If there is not enough space, the backup files cannot be stored.
⚫ Used storage space by cloud storage (excluding the space allocated to the Cloud IM
service)
Version 1.0.10.23
Device Plan Refer to the current plan and add-on plan of the device. If the plan has expired, the user
can only use the Basic plan as the current plan.
After adding the device to the GDMS platform, the user can apply for a UCMRC advanced plan free trial
Notes:
• When the plan has expired, the user can only use the Basic plan as the current plan, some functions
will be unavailable.
• When the plan has expired, the files exceeding the storage space will be deleted after 7 days.
Please download the backup file in advance or renew the plan.
• When the plan has expired, the UCM custom address will be deleted after 7 days.
• If the user has purchased a UCMRC plan before or applied for a free trial before, the user cannot
apply for another UCMRC plan free trial anymore. The duration of the free trial is 3 months. When
the free trial expires and the user has never purchased any plan for the UCM device, the plan of
the UCM device will be downgraded to the Basic plan.
On the GDMS platform interface, even though the UCM is under the internal network, the user can remotely
access the UCM Web UI through the external network for viewing data and configuration.
Version 1.0.10.23
1. Go to Device Management → UCM Device interface, click on the button of the specific UCM
2. Go to the UCM Web UI, log in to the UCM device through the username and password, as the
screenshot shows below:
3. After logging in, the user can operate this UCM remotely by accessing the UCM device under the local
network, as the screenshot shows below:
Version 1.0.10.23
Figure 79: UCM Home Page
Note:
• Users do not need to configure the external network for UCM devices and access the UCM devices
with encryption through the GDMS platform. However, the network environment of the UCM
devices is allowed access through external networks.
• Users can assign permission that remote access to UCM Web UI without entering a password.
Once the permission is assigned, the user can remotely access the UCM Web UI through the
GDMS platform without entering the UCM password.
Version 1.0.10.23
Figure 80: Remote Password Access
On the UCM Device list, users can click the Diagnosis button following the UCM device to diagnose
UCM device, including UCMRC Connection, Ping/Traceroute, Syslog, Capture Trace, Network Diagnostics,
and System Status.
If the UCM device which is using the UCMRC services has any problems, the user can diagnose the UCM
device and troubleshoot the problems remotely. The user can try to fix the problems based on the
suggestions and click on the “Feedback” button to send the logs and descriptions to our technical support.
Version 1.0.10.23
Figure 82: Diagnostic Details
View Statistics
Daily Report
Prerequisite: The UCM plan contains the permission for this function.
The UCM device collects the data report of the day and sends it to the GDMS user or the configured email
box.
Please refer to the screenshot below for the daily report email:
Version 1.0.10.23
Figure 83: UCM Statistics Report
The time of sending the data is displayed according to the local time zone
Statistics Time
of the UCM device.
Version 1.0.10.23
Firmware Version The current firmware version number.
Running Time The running time displays the deadline for reporting the data.
By the reporting data time, it displays the usage of the local storage space
Storage Space of the device. If the usage reaches 80%, the indicator will be marked in
red.
By the reporting data time, it displays the cloud storage space usage of
Cloud Storage Space
the device. If the usage reaches 80%, the indicator will be marked in red.
Total Remote Calls The total number of calls made by the remote users on the reported day.
Max Remote Sessions The maximum number of concurrent remote calls on the reported day.
Call Type Statistics The distribution of all call types on the reported day.
Max Allowed UCMRC The maximum number of remote registered extensions on the reported
Registrations day.
The maximum call duration of the single remote call on the reported day.
Max Time Per Remote
If the maximum call duration of the single remote call reaches 90% of the
Call/Meeting
plan limitation, the value will be marked in red.
The total remote call duration on the reported day. If the total remote call
Aggregate Time for
duration reaches 90% of the plan limitation, the value will be marked in
Remote Calls/Meetings
read.
Notes:
• Some data are only available for data statistics in the premium plan.
• The daily report sending time is according to the 0 a.m. of the UCM local time zone.
Prerequisite: The UCM plan contains the permission for this function.
Version 1.0.10.23
1. Go to Device Management → UCM Device interface, click on the button of the specific UCM
2. Users can only view the statistics report for the last 30 days. The reports will be sorted by the local
time zone of the UCM devices, as the screenshot shows below:
3. Click on the button to view the type and amount of the connected device on the current day to
the UCM device:
4. Click on the button to view the call type statistics of the current day:
Version 1.0.10.23
Figure 86: View Call Type Statistics
5. Click on the button to view chart statistics of the number/type of calls in the last 7
days or last 30 days, as the screenshot shows below:
Prerequisite: The UCM plan contains the permission for this function.
GDMS platform will send a daily report email of the UCM device every day. Click on the button
Version 1.0.10.23
Figure 88: Set Daily Report Receiving Mailbox
Daily Email This is used to configure whether the user wants to send the daily report to the mailbox
Notification every day. If not, no mail notification will be sent, and users can view the statistics report
on the GDMS platform.
Time Zone This is used to set the time zone of the daily report.
Send Time This is used to set the sending time of the daily report.
Repeating This is used to set the repeating sending time of the statistical report. Once this
configuration is set, the statistical report will be sent to the configured email box
periodically.
Receiving Supports entering any email address. Users can click “Add Email Address” to add
Email Address multiple email addresses to receive the daily report.
Prerequisite: The UCM plan contains the permission for this function.
Users can view all operation logs on the GDMS platform for the UCM devices.
Version 1.0.10.23
1. On the UCM Device List, select the menu button following the specific device, and click on the
“Operation Log” button.
2. Operation logs include Remote accessing UCM Web UI logs, restarting logs, and firmware upgrading
logs.
Note:
Users could only view the device operation logs for the last 30 days.
Remote Access Domain Name is used to configure Wave application so that Wave application can connect
to UCM server and make calls at any time, anywhere under any network environment.
Prerequisite: The UCM plan contains the permission for this function.
You can also customize your domain to access Wave Web RTC page/ UCM portal.
1. Go to Device Management → UCM Device interface, click the Edit Device option for the specific UCM
device, and access to “Device Edit” menu.
2. If the user wants to configure this address on the soft terminals for remote calls, the user can click the
button and customize the remote domain address. Please see the screenshot below:
Version 1.0.10.23
Figure 90: Device Edit Menu
3. Click on the “Personal URL” field, and enter the preferred URL, such as
{yourdomain}.zoneb.gdms.cloud
4. If the plan has a custom domain name function, the user can click on the “Custom Domain” option and
enter the server address with the private domain name, and the user also needs to enter the custom
certificate of the domain name.
Note:
The custom address needs to be resolved to the existing default server address (e.g.,
xxxxxxxx.zonea.gdms.cloud), otherwise the custom address cannot be recognized, and Wave users cannot
connect to the UCM device through the custom address.
Version 1.0.10.23
Figure 92: Enter Private Domain Name and Certificate
5. If the user needs to modify the information, the user can click on the button to add a new custom
server address.
6. Click on the “Save” button to apply the settings. Then, both the default server address and the new
custom server address can be used.
Note:
If the user modifies the custom server address, the phones or Wave applications that use the previous
custom server address need to be re-configured with the new custom server address. Otherwise, the
service cannot be used normally.
Only the advanced UCM Remote Control plans support synchronizing UCM device alerts to the GDMS
platform. For UCM Remote Control plans details, please refer to our official website.
1. Users need to enable UCM alert notifications on the management platform of the UCM device. For
details, please refer to the UCM User Guide on the UCM product page.
2. The alerts generated in the UCM device will be synchronized to the GDMS platform.
3. Users can view all UCM alert notifications in the GDMS platform, and set the alert notification methods:
Email Notification, Message Notification, or SMS Notification.
Version 1.0.10.23
Reboot Device
Users can reboot UCM devices from GDMS instantly or set up a schedule to reboot the UCM devices.
1. Select a UCM device from the GDMS → Device → UCM Device page, and click on “Reboot Device”.
Or select multiple UCM devices by clicking More → Reboot Device.
2. The users can select to reboot the device immediately or set up a schedule to reboot the device. For a
scheduled reboot, please select the start and end times of the task. Reboot will be performed during this
period.
3. After saving the reboot configuration, users can view the status of this task from the GDMS → Task page.
Note:
If the task is failed, the GDMS platform will send the system notification to the user.
Upgrade Firmware
Upgrading UCM firmware via GDMS is supported. Please note there must have UCM official firmware or
customized firmware available on the GDMS platform first.
1. Select a UCM device from GDMS → Device → UCM Device and click on “Upgrade Firmware” as
shown in the below picture. Users can also select multiple UCM devices and then click on “Upgrade
Firmware” to perform a batch upgrade for all selected UCMs.
Version 1.0.10.23
Figure 94: UCM Devices Listed in GDMS
2. Select upgrade immediately or set up a schedule to perform the upgrade. For scheduled upgrades,
please select the start and end times of the task. Upgrade will be performed during this period.
3. Save the configuration. Then the users can view the task status under the GDMS Task page.
Note:
If the task is failed, the GDMS platform will send the system notification to the user.
Edit Device
Users could edit the UCM Device name and which site the device belongs to.
1. In the device list, click on the button to Edit Device to access the device editing page.
Version 1.0.10.23
Figure 96: Edit UCM Device Option
2. Users will see the device editing page as the figure shows below:
3. Users can modify the GDMS server region by clicking on the drop-down menu of the “Zone” option.
When the device is online for the first time, the GDMS platform system will set the region based on the
nearest region to the device automatically.
Version 1.0.10.23
4. If the plan has the custom server address function, the user can click “Personal URL”; If the plan has
the permission to custom private domain name function, the user can click on the “Custom Domain”
option to configure it.
5. Click on the “Save” button to apply the changes on the GDMS platform.
Note:
After modifying the GDMS server region, the GDMS platform system will generate a new Access Server
address, and the Wave users and the phones which are not connected to the GDMS platform need to be
configured with the new Access Server address manually. If the user is using the Custom Domain, the user
does not need to update the address.
UCMRC Settings
Prerequisite: The user has the corresponding UCMRC plan including this function.
The user can remotely access the PBX device to set the plan of the UCMRC service.
1. In the UCM Device list, the user can select the UCM device which the user prefers to access and click
Version 1.0.10.23
2. After clicking the UCMRC Settings button, the user will be directed to the UCM Web UI remotely.
3. The user will be directed to the UCM Web UI → UCM Remote Connect → Plan Settings interface. As
the screenshot shows below:
Prerequisite: The user has the corresponding UCMRC plan including this function.
The user can remotely access the UCM device Web UI to customize the enterprise logo.
1. In the UCM Device list, the user can select the UCM device which the user prefers to customize the
Version 1.0.10.23
Figure 100: Custom Wave Logo Interface
2. After clicking the custom logo button, the user will be directed to the UCM device Web UI.
3. The user will be directed to the UCM Web UI → UCM Remote Connect → Custom Logo to customize
the enterprise logo. As the screenshot shows below:
Version 1.0.10.23
Back up UCM Data
Prerequisite: The user has the corresponding UCMRC plan including this function.
The user can remotely access the UCM device to enable the UCM data backup function.
1. On the UCM Devices list, the user can select the UCM device, click the button to access the UCM
Web UI, and set the UCM data backup function for the GDMS platform account.
2. After clicking the UCM data backup button, the user will be directed to the UCM device Web UI.
3. The user will be directed to the UCM Web UI → UCM Remote Connect → Plan Settings→Storage &
Backup interface and set to back up the UCM data to the GDMS platform account. Please see the
screenshot below:
Version 1.0.10.23
Figure 103: Storage & Backup
Users could edit the site of a batch of UCM devices on the GDMS platform. The default site is “default”.
1. Select the desired devices and click on the ”Site Assignment” button.
3. Click on the” Save“ button, and all selected devices will be transferred to the selected site.
Note:
Version 1.0.10.23
Each device can only be allocated to one single site.
Prerequisite: The user has the corresponding UCMRC plan including this function.
Users can view Host/Spare UCM devices in the UCM devices list, the Host/Spare icon will be marked
following the MAC address, and users can view the corresponding MAC address of the Host/Spare devices.
When the Host/Spare association is established, and once the Host UCM server is down, the Spare UCM
device can still get connected through the Host UCM device’s UCMRC domain name.
The user can click “Remove Relationship” to remove the UCMRC Host/Spare relationship. However, the
local Host/Spare relationship configuration in the UCM devices is still retained. If the user also wants to
remove this relationship, the user needs to go to the UCM management platform to disassociate the
relationship.
Note:
⚫ If the user only purchases one UCMRC plan which contains the HA service for one of the UCM devices,
the HA features for the UCM devices cannot be used normally.
⚫ To ensure that the UCM devices can be used normally under the HA mode, the user needs to purchase
two UCMRC plans with the same specifications and both plans contain the HA service.
Delete Device
Users could delete one UCM device or a batch of UCM devices on the GDMS platform.
2. Select a UCM device from GDMS → Device → UCM Device and click on “Delete Device”. Users
can also select multiple UCM devices and then click on More → Delete to perform a batch delete
for all selected UCMs.
Version 1.0.10.23
3. Click on the” OK“ button on the pop-up window to confirm deleting the devices, and the selected
devices will be deleted immediately from the GDMS platform. The timing tasks involving the deleted
devices will be canceled either.
Export Device
To export the entire device list, click on the button in the top-right corner of the device list
page. The exported list includes all device information.
GDMS platform administrator can configure the parameters of UCM Remote Connect for the device
remotely. Once the device has been configured following the methods below, the device can use the UCM
Remote Connect functions.
Method 1:
1. GDMS platform administrator can go to VoIP Account → SIP Account interface, select the SIP
accounts which will be assigned to the device, click on the edit button to access the account
editing interface:
Version 1.0.10.23
Figure 107: Edit Account
2. Click Add Server option and select the external network server address reported by the UCM Remote
Connect.
3. Assign the SIP server to the device and enter the device MAC address and Account index, then select
the SIP server of the UCM Remote Connect.
4. Click to save and apply the changes for UCM Remote Connect for the device.
Method 2:
Users can select multiple SIP accounts, click the “Modify SIP Server” option on the top of the interface, and
then select the server address of UCM Remote Connect to modify the SIP server address (internal network)
to the server address of UCM Remote Connect for a batch of devices.
Version 1.0.10.23
Figure 108: Modify SIP Server Address
Note:
1. When the user configures the server address of UCM Remote Connect for the device, the following
settings will be assigned to the device automatically to ensure the UCM Remote Connect service can
be used successfully:
• STUN server setting will be changed to the TURN server address of UCM Remote Connect.
2. When the UCM Remote Connect account is deleted from the device, the STUN server setting will be
removed automatically from the device.
Storage
For backup files generated from UCM manually or automatically, they can be stored in GDMS cloud storage.
On the GDMS platform, users can view all backup files.
1. Go to the UCM Backup page, all backup files available for connected UCM devices will be displayed.
The file type includes CDR files, config files, etc.
Note:
It only displays all the backup files of the UCM devices under the current organization. Users can switch
the organization to view the backup files of the UCM devices under other organizations.
2. Click the searching box at the top of the interface to search the backup files by device MAC address,
backup file type, and device model.
Version 1.0.10.23
Figure 109: View Backup File
Note:
• If the storage space of the UCM device is insufficient, the backup file cannot be stored. Please
clear the storage space or renew the plan to get more storage space.
• Users can subscribe to the email notifications so that the alert message will be sent to the
configured email box by default when the device storage space is insufficient.
Users can upload the backup file and recover the backup file on UCM.
1. Go to the UCM Backup page, click on the “Upload File” button in the right upper corner to access the
interface:
Version 1.0.10.23
Figure 110: Upload File
File Click to select the backup file from the local PC or drag the backup file to this field to
upload the backup file. The backup file can be the configuration file of the device.
MAC Address Enter the MAC address of the UCM device for uploading this backup file.
Note: The UCM device must be in the current organization, otherwise, the backup file
cannot be uploaded.
File Type Enter the file type of the backup file so that the UCM device can obtain the backup file
accordingly by the file type.
Note:
If the UCM device does not have enough storage space, the backup file cannot be uploaded. The user can
clean up the cloud storage space file for this UCM or purchase an additional plan.
1. On the ”UCM Backup“ page, click the button following the backup file to download the file.
Version 1.0.10.23
Notes:
• Users can view the backup files and restore the UCM device quickly without downloading.
• Users can download the backup file manually and restore the UCM device.
Users can restore backup files for UCM devices remotely through the GDMS platform.
1. On the “UCM Backup” interface, select a UCM backup file and click the “Restore” button to restore
2. Once the user clicks the “OK” button, the UCM backup file will be assigned to the UCM device to restore
the UCM device.
3. It may take several minutes to restore the backup file for the UCM device. The user can refresh the
interface to view the results next to the MAC address of the UCM device on the interface. As the screenshot
shows below:
: Restored successfully. The user can leave the cursor on the icon to view the last restoring time.
: Restored failed. The user can leave the cursor on the icon to view the last restoring operation time.
Version 1.0.10.23
Figure 112: View Results
If the user wants to clean up the storage space of the UCM device, the user can delete the backup files in
the UCM device.
1. On the” UCM Backup“ page, click the button following the resource file to delete the backup file.
Users can also select multiple backup files and click the Delete button on the top of the page to batch delete
the backup files.
2. When the user confirms to delete, the selected files will be deleted from the GDMS platform.
Note:
Please note that when the backup file is deleted, it cannot be restored.
If the user has upgraded the UCM device model, the user can use this function to convert the configuration
file of UCM62xx/UCM65xx to the configuration file of UCM63xx.
1. Go to the UCMRC → UCM Backup interface, the user can click the “Convert Config File” button to
access the conversion interface, as the screenshot shows below:
Version 1.0.10.23
Figure 113: Convert Config File
2. The user can click to upload or drag the configuration file of UCM62xx/UCM65xx to the uploading area.
3. Select the target model to be converted, which means the model of your new UCM device.
4. Select the converted configuration file and save it to the cloud storage space of the new UCM device.
5. The converting duration will last for several minutes. When the conversion is done, the user can
download the converted configuration file on the UCM Backup interface. Or the user can click to download
the converted configuration file directly to the local PC. The user can also restore the configuration file in
the new UCM device directly.
Version 1.0.10.23
Figure 114: Converted File Successfully
Note:
The original configuration file format needs to be a .tar file, and the file size limit is 10GB.
VoIP Device
For more details, please refer to the VoIP System -> VoIP Device module.
Call Statistics
Statistics Overview
The interface below displays the call quality reported by the device on the GDMS platform.
Prerequisites: The device must use the SIP account in the UCM server which has the UCM Remote
Connect service so that the device can report the call quality to the GDMS platform. This function is
supported in some of the UCM Remote Connect plans, not all plans. Please refer to the official website for
plan descriptions.
Version 1.0.10.23
Figure 115: Statistics Overview
Module Description
Total VoIP Devices Display the number of VoIP devices reported by the current organization (only
display the statistics report for the current filter time)
Total Calls Display the number of calls reported by the current organization (only display the
statistics report for the current filter time)
Call Quality Display the call quality ratio and average values for the reported call history by
the current organization (only display the statistics report for the current filter time)
Call Type Display the call types for the reported call history by the current organization (only
display the statistics report for the current filter time)
Note:
⚫ The user needs to purchase the advanced UCMRC plan which contains this service before using the
features. If the phone which has been associated with the GDMS platform has registered the
extension which was synchronized from the UCM device to the GDMS platform (assigned through
the GDMS platform), the phone will report the call quality to the GDMS platform (the audio will not be
collected).
Version 1.0.10.23
Call Quality Record
GDMS platform displays all reported call quality records on the Call Quality interface.
2. GDMS platform supports search call quality records by site, device model, call quality, and call type.
3. GDMS platform supports to search of call quality records by device MAC address, device name, and
SIP Account.
4. Click the Call Statistics button to view the statistical report of the filtered call
quality records.
Version 1.0.10.23
Figure 118: Call Quality Record Report
Users can enable/disable reporting call quality on the GDMS platform. If the user does not want to view the
call quality report, the user can disable this function on the GDMS platform.
On the Call Quality interface, the user can click the Phone reports the call quality button
Version 1.0.10.23
Figure 119: Enable/Disable Call Quality Reporting
Version 1.0.10.23
DEVICE CONFIGURATION
The Device Configuration page allows users to create templates that can be used to provision devices of
the same model or in the same group. Additionally, users can upload configuration files for individual devices
and manage them individually.
Note:
Users can only manage the devices in the current organization of the current system.
By Model
Users could customize the configuration template and classify the templates by device model and site.
Users could also configure a batch of devices on the GDMS platform, which means users could create a
configuration template for all same models of devices or create multiple templates for different sites.
When a device is added to GDMS for the first time, it will automatically obtain and use the configuration
template for its model.
To manually push the configuration to specific device models, click on the button of the desired
models.
Version 1.0.10.23
Figure 120: Manual Configuration Push
Note:
If a device’s setting has not been modified on the Device Management → Device → Set Parameters
page, GDMS will automatically update the device with the template settings created on the Device
Configuration page.
Example:
For GXV3370 devices, all sites are using the same configuration template, and all the devices under site A
– D will acquire the same configuration template – GXV3370 Config Template.xml.
For DP720 devices, different sites have different configuration templates. The DP720 in site A will acquire
the DP720 configuration file - Config Template -1.xml; the DP720 in site B will acquire the DP720
configuration file - Config Template -2.xml.
Version 1.0.10.23
Figure 121: Example – GXV3370
Add Template
To add a configuration template for a specific device model, click on the Add Template button on the By
Model page and enter the following information:
Version 1.0.10.23
Table 24: Add Template
Name Enter the name of the template. This name must be unique and has a maximum character
limit of 64.
Select Site Select the site for which the template will be used.
All Sites: All devices in all sites will use this template.
Select Site: All devices in the selected sites will use this template. Multiple sites can be
selected.
None:
⚫ GDMS platform will not allocate the template to any device. The user could allocate
the template to the device manually.
⚫ The default setting is “All Sites”. If the user wants to modify the default setting, the
user can adjust the setting and enable the option “Remember Current Setting” before
saving the configuration. When the user edits/creates the model template, the default
setting is the previously saved setting.
Description Users could input the descriptions of the template and the purpose.
Once complete, users will be redirected to the Set Parameters page to modify the device settings of the
template.
Notes:
• For the new associated device, when the device first time connects to the GDMS platform, it will
acquire the configuration template according to the device model and site automatically. Users do
not need to push the configuration template manually.
• Devices already on GDMS will not automatically obtain the settings from newly added
configuration templates. Users will need to update these devices manually.
Important Note:
If the GDMS platform has the model configuration template for the current device, and the user does not
Version 1.0.10.23
modify the configuration parameters from the Device Management → Device → Set Parameters menu,
the GDMS platform will push the default model configuration template to the device when the device is
online. Otherwise, if the user updates the device configuration on the “Set Parameters” menu on the GDMS
platform and pushes it to the device, the device will use this configuration as the default configuration.
Set Parameters
2. Clicking on the Select All button will select every option on the current page. Clicking on it again will
deselect all the options.
3. Clicking on the Reset Settings button will restore all settings on the current page to default values.
4. Clicking on the button following the account, users can copy and paste the current account
configuration to other accounts.
5. When users try to configure the device wallpaper or screensaver image, users can select a picture
from the resources list, or upload the local picture to GDMS and configure it to the device.
Version 1.0.10.23
Figure 124: Ringtone Configuration
6. Modify the desired settings on the page or click on the Switch to Text Editor to configure device
settings via text editing (e.g., p-values). The Key can be either a P-value or an alias.
7. After setting the parameters, the user can click the “Save” button to save the changes. The user can
select to apply the template configuration to all same model devices on the corresponding site. The
user can click the option “Provision to Selected Devices” to select the devices to which the user wants
to push the parameters to. The user can also click the button “Apply All” to push the parameters to all
devices.
Notes:
• The available settings for each model template are different. For more details on acceptable
configuration values, please refer to the user guide for each device model.
• When the user adds a new model configuration template to the GDMS platform, the GDMS platform
will not push the template to the existing devices in the GDMS platform, and the GDMS platform
will only push the newly added template automatically to the new associated devices in the system.
Version 1.0.10.23
• When the settings of a template are modified, the changes will not be automatically applied to
related devices. Users will need to manually push the configuration to devices.
• For the newly added devices, the devices will acquire the updated configuration template
automatically.
• If a scheduled task involves a modified template, the task will use the template settings at the time
of scheduling, not the newly modified settings.
• Users can use the Search function to find the needed parameter.
Users can configure custom ringtones and language for devices (Supported models: GXP/DP series).
1. To configure these model-specific settings, click on the button of the desired template to go
to the Parameters Configuration → Resource Configuration page, as shown in the figure below:
2. On the “Custom Ringtone” page, for Ringtone 1 to Ringtone N, select a ringtone file from the
resources for each ringtone index.
3. On the “Language Configuration” page, select a language pack from the resources for the device.
4. After clicking the “Save” button, the device of this model will download the resource file from the
firmware path once the device is connected to the GDMS platform for the first time.
5. Or users can click the “Push” button to push the template of the model to the device. Then, the
device will download the resource file from the firmware path.
Version 1.0.10.23
Note:
For each device model, the size and duration of each ringtone are different. If the duration and size exceed
the limit, the system will intercept the resource file to the maximum limit automatically.
Push Update
1. Select a specific configuration template, and click on the button following the template.
2. Users could select any device in this device model to push the configuration template, the device will
be updated with the configuration template.
3. Users can either push the configuration template immediately or schedule the configuration push for a
specified time. If the latter is selected, users will need to enter a name and time for the scheduled push.
Version 1.0.10.23
4. Click on the Save button to finalize the task. Users can check the task status on the Task Management
page.
Edit Template
To edit the configuration template’s name, site, and description, click on the button for the desired
template.
To download the configuration template of a device model, click on the button for the desired
template.
Delete Template
To delete configuration templates from GDMS, select the desired templates and click on the Delete button
in the top left corner of the By Model page.
Version 1.0.10.23
Note:
If a scheduled task involves a deleted template, the task will still use a temporary copy of the template
saved at the time of scheduling. A scheduled task will not fail due to deleted templates.
By Group
Users could customize the configuration template by the group. Users could configure a group and update
the configuration template by the group. For example, users could classify a batch of devices into a group
and configure/manage the devices in the group. Users could push the configuration template to the group
members on the GDMS platform.
Users could view the group configuration template, and the devices list in each group.
Users could modify the configuration parameters, push the configuration to the devices, edit the group and
members, and download the configuration template by the group.
Version 1.0.10.23
Add Group
1. Click on the Add Group button at the top right of the By Group page.
Group Name Enter the name of the group to easily identify it. Names must be unique and have a
maximum character limit of 64.
• GRP series: Use the configuration template for the GRP series.
• GXP series: Use the configuration template for the GXP21xx series.
Version 1.0.10.23
• GXV series: Use the configuration template for the GXV33xx series.
Description Enter the detailed description and purpose of the configuration template.
2. Once complete, users will be redirected to the device selection page to add devices to the group. Users
can either select devices from the list or manually enter the MAC addresses of the devices. Selected
devices will be moved to the Selected Device list on the right of the page.
3. Users could click on the “Prev” button to go back to the group configuration page to re-edit the group
information.
4. Click on the Save button to complete group member selection. Users will then be redirected to the Set
Parameters page.
Note:
Users need to set the parameters of the configuration template for the newly added group.
Set Parameters
Users could set the unique parameters of the devices in the group in the configuration template to push the
unique parameters to the devices in the group.
Version 1.0.10.23
1. Select a specific group, and click on the button to access the group member parameters
configuration page.
b. Clicking on the Select All button will select every option on the current page. Clicking on it again
will deselect all the options.
c. Clicking on the Reset Settings button will restore all settings on the current page to default
values.
d. Clicking on the button following the account, users can copy and paste the current account
configuration to other accounts.
e. When users try to configure device wallpaper or screensaver image, users can select a picture
from the resources list, or upload the local picture to GDMS and configure it to the device.
2. Modify the desired settings on the page or click on the Edit Configuration File to configure device settings
via text editing (i.e., p-values). The Key can be either a P-value or an alias.
Notes:
• The available settings for each model template are different. For more details on acceptable
configuration values, please refer to the user guide for each device model.
• When the user adds a new model configuration template to the GDMS platform, the GDMS
platform will not push the template to the existing devices in the GDMS platform, and the GDMS
platform will only push the newly added template automatically to the new associated devices in
the system.
• When the settings of a template are modified, the changes will not be automatically applied to
related devices. Users will need to manually push the configuration to devices.
• For the newly added devices, the devices will acquire the updated configuration template
automatically.
Version 1.0.10.23
• If a scheduled task involves a modified template, the task will use the template settings at the time
of scheduling, not the newly modified settings.
Users can configure custom ringtones and language for devices (Supported models: GXP/DP series).
1. Select a specific group, and click on the button to access the group member parameters
configuration page.
2. On the “Custom Ringtone” page, for Ringtone 1 to Ringtone N, select a ringtone file from the
resources for each ringtone index.
3. On the “Language Configuration” page, select a language pack from the resources for the device.
4. After clicking the “Save” button, the configured parameters and resources will be saved in the
system. When the user clicks the “Push” button to push the template to the device, the device will
download the resource file from the firmware path.
Note:
For each device model, the size and duration of each ringtone are different. If the duration and size exceed
the limit, the system will intercept the resource file to the maximum limit automatically.
Version 1.0.10.23
Push Update
Users could push the group configuration template to the device manually.
2. In addition to being able to push the configuration template to all or select members of the group,
users can also push it to non-members.
3. Users can either push the configuration template immediately or schedule the configuration push for
a specified time. If the latter is selected, users will need to enter a name and time for the scheduled
push.
4. Click on the Save button to finalize the task. Users can check the task status on the Task
Management page.
Edit Group
Users could edit the group name, descriptions, and group members.
Version 1.0.10.23
2. Modify the desired settings and click on the Save button to finalize changes.
Note:
New members of an existing group will not automatically obtain the group configuration template. The
template must be manually pushed to the new member devices.
Users can download the group configuration template by clicking on the button for the desired group.
Delete Group
Users can delete groups by selecting the desired groups and clicking on the Delete button in the top-left
corner of the By Group page.
Note:
The existing timing tasks involving the group configuration template will be reserved, and the timing task
will be executed with the original group configuration template.
By CFG
Users can import configuration files for specific devices. Settings in these uploaded files will be used for
their specified device.
Version 1.0.10.23
Upload CFG File
Users could upload the custom configuration file to the GDMS platform and push the custom configuration
file to the device.
1. Click on the Import Configuration File button at the top-right corner of the By CFG page. The following
window will appear:
2. Drag and drop the file to the window or click on the upload icon to select a file from your PC.
Note:
The uploaded file must be named as the device’s MAC address (e.g., 000b82afd0b0.xml).
4. The following window will appear asking the user to either push the configuration to the specified device
immediately or to cancel the configuration push.
Version 1.0.10.23
Notes:
• Only XML file format is supported for the uploaded custom configuration file.
• If the file name does not meet MAC address format requirements, the import will fail.
• When uploading another configuration file for an existing device, the previous configuration file will
be overwritten.
Push Update
Click on the button for the desired device to manually push the configuration to it.
Click on the button for the desired device to get its configuration file.
To delete uploaded configuration files from GDMS, select the desired devices in the list and click on the
Delete button at the top left of the By CFG page.
Version 1.0.10.23
SITE MANAGEMENT
Site Management allows users to organize their devices by sites and categories.
Add Site
1. Click on the Add Site button at the top right of the Site Management page. To quickly add a subsite
under a specific site, click on the button next to the desired site. Users can create a total of 7 different
levels of sites.
Version 1.0.10.23
Figure 145: Add Site
Site Name Enter a name for the site to easily identify it. Sites on the same level cannot have the
same name.
Superior Site The parent level of the site. This field can be left blank if the created site is a top-level
site.
2. Once the site is created, users can then assign devices to it.
1. Click on the Import Site button at the top right corner of the Site Management page. The following
window will appear:
Version 1.0.10.23
Figure 146: Import Site
2. Click on the Download button to get a template that will be used to import site information.
Version 1.0.10.23
Table 27: Site Template Options
Site Name Enter the name of the site. If the site is the child of another site, users must enter the entire
path (e.g., top-level site/second-level site/third-level site/…new site name).
3. Once the template is filled out, drag, and drop the file to the upload window or select the file from your
PC. Click on the Import button to confirm the import.
4. When the Excel file is imported into the GDMS platform successfully, the GDMS platform will prompt
the execution result. If there is data that failed to be imported, the user could export the failed data and
re-edit the Excel file.
Note:
If an imported site has the same name as another site on the specified level, the import will fail.
Edit Site
Users could edit the information of the site on the GDMS platform.
2. Edit the desired fields and click on the Save button to finalize changes.
Version 1.0.10.23
Figure 148: Edit Site
Delete Site
To remove a site from GDMS, click on the button next to the desired site.
Note:
If the selected site has devices assigned to it, the site cannot be deleted unless the devices are assigned
to another site beforehand.
View Devices
To view all the devices under a specific site, click on the desired site in the Site Management list.
Version 1.0.10.23
Transfer Site
Users can select devices on a site and move them to another site by clicking on the Move button.
Clicking on the Save button will finalize the move to the specified site.
Version 1.0.10.23
TASK MANAGEMENT
The Task Management page displays all queued and completed tasks in the current organization and
system of the GDMS platform account such as configuration pushes, firmware upgrades, reboots, and
factory resets. Users can add, edit, and delete tasks from this page.
Note:
Users can only manage the devices in the current organization of the current system. If the user does not
have the permissions on the device, the user cannot manage tasks on the device.
Add Task
Task Type • Immediate: The task will be run immediately. If the task is not run after 5
minutes, GDMS will automatically close it.
• Scheduled: Schedule the task to run at a specified time. The task will end
at the specified end time, even if there are still devices queued up to run the
task.
Version 1.0.10.23
• Repeating: Users could reserve the recurring tasks such as daily, weekly,
monthly, and Nth week of each month, and perform a certain task.
Upgrade Method This option is available only when Upgrade Firmware is selected as the Task Type.
• Sequential Upgrade: Devices are upgraded one by one in a sequence.
Recommended to minimize network traffic.
• Concurrent Upgrade: All devices are upgraded simultaneously. This option
may cause heavy network traffic. To ensure network quality, the user can
also limit the maximum number of concurrent devices, such as upgrading 10
devices at the same time.
Version This option is available only when Firmware Upgrade is selected as the Task Type.
Requirement Devices will be upgraded only if they meet certain requirements:
• All: Upgrade all devices regardless of their current firmware version.
• Specific Firmware Version: Upgrade devices on the specified firmware
version.
• Firmware Version Range: For the selected devices, only the devices in a
specified firmware version range (Lowest firmware version ≤ x ≤ Highest
firmware version) will be upgraded.
Execution Device Select the devices to run this task for. Users can search for devices by their model,
assigned site, or MAC address.
Click on the Save button to finalize the task creation. Users can view this task in the Task Management
list.
Version 1.0.10.23
Figure 152: Task Management List
Notes:
• If there are multiple tasks for 1 device, they will be queued up to run in order of their configured
start time.
• If a device is offline, pending tasks associated with the device will be run the next time the device
is offline.
• Certain tasks and device setting changes can cause a device to reboot.
• Firmware upgrade tasks may require more time to run due to the size of some firmware files.
• The latest configuration files or firmware will be generated for each cycle of the recurring tasks, and
the system will collect all devices of this specific model, then execute the corresponding task.
• If the task is created in a specific sub-system, the user can view the task only in the corresponding
sub-system, and other sub-system users cannot view it.
Version 1.0.10.23
View Task Status
Users can see the status of all completed and pending tasks by looking at the Status column.
Timeout The task was not executed when it arrives at the ending time.
Ended The task was ended before it could be completed. Some of the involved devices may not
have run the task before it ended.
To view more details about a task, click on the button for the desired task. Users can view the task
status of each device involved.
Version 1.0.10.23
Figure 154: Task Status
Timeout The task has been sent to the device, but the device has not responded yet.
Success The task has been completed successfully for this device, but it was completed later than
(Timeout) the specified time.
Canceled The task has been canceled before the starting time.
Ended The task was ended before it could be completed. Some of the involved devices may not
have run the task before it ended.
Users could re-create tasks for the executed failed devices or all devices. If the user re-creates tasks for
certain devices, all attributes of the task and all executed devices information will be logged on the “Re-
create Task” page.
Version 1.0.10.23
Start Scheduled Tasks
Users can start pending scheduled tasks immediately by clicking on the button.
To cancel a pending task, click on the button for the desired task. The task status will be changed to
Cancelled. To run the task again after it is completed, click on Task Details → Run Again for the desired
task.
If the task is recurring, users could select whether to cancel the entire recurring task or just cancel the single
task.
End Task
If the device has already executed the task (e.g., Reboot Device), the device will finish the task; if the device
does not start to execute the task, the device will not execute the task anymore.
Search Task
Users can search for specific tasks by using the search bar and filters at the top-right of the top right corner
of the Task Management page.
Version 1.0.10.23
Figure 155: Search Task
Delete Task
Users can delete tasks at any time. Select one or more tasks and click on the Delete button at the top of
the page to delete them.
Note:
When deleting ongoing tasks, GDMS will automatically suspend and delete them. Any changes made
before the task was suspended cannot be undone.
Version 1.0.10.23
DEVICE DIAGNOSTICS
Device Diagnostics allows users to check devices on GDMS for issues, view device information, obtain
network captures and Syslog, and conduct traceroutes.
Note:
The user can view the diagnosis status of the device in the current organization of the current system. If
the user does not have the relevant permissions, the user cannot diagnose the corresponding device.
Start Diagnostics
1. Enter the device’s MAC address and click on the Start Diagnostics button.
2. Each device will generate one diagnostics history. Click on the button for the desired device
in the list to diagnose the device.
To view the diagnostic details of a device, click on the button for the desired device.
Version 1.0.10.23
Figure 157: View Diagnostics Details
Notes:
• If the device is offline, users cannot diagnose this device on the GDMS platform, , and users can
only view the previous diagnosis records.
• Except for capturing the packets Syslog, multiple users can perform diagnosis operations on one
device at the same time.
Click on the button on the right of the Device Diagnostics page to view information about the
device.
Version 1.0.10.23
Figure 158: View Device Details
On the Diagnostics Details page, users can quickly perform operations on the devices, including restarting
the devices, factory resetting the devices, updating the configuration, and upgrading the devices. Users
can also view the detailed information of the device, including device name, MAC address, public/private
IP address, device model, and device type on this page.
Click on the button next to the diagnosis record to view the specific diagnosis result of the device.
Version 1.0.10.23
Figure 159: View Diagnosis Result
Note:
• The UCM series and GXW45XX devices do not support resetting to the factory settings and
updating configuration files through the GDMS platform.
• In the diagnosis record, it only displays the diagnosis data of the device in the last 30 days.
• If the device is offline, the user still can view the diagnosis record of the device.
UCMRC Connection
Users can diagnose the current UCMRC connection status in the GDMS platform.
Click on the button “Start Diagnosis” and wait for the GDMS platform to diagnose the device. The GDMS
platform will display the diagnosis result of the UCMRC connection.
Version 1.0.10.23
Figure 160: UCMRC Connection Diagnosis
If the UCM device which is using the UCMRC services has any problems, the user can diagnose the UCM
device and troubleshoot the problems remotely. The user can try to fix the problems based on the
suggestions and click on the “Feedback” button to send the logs and descriptions to our technical support.
Note:
It only displays the UCMRC connection diagnosis records of the device in the last 30 days.
Ping/Traceroute
Clicking on the Ping/Traceroute tab on the Device Diagnostics page will show the following:
Version 1.0.10.23
Figure 161: Ping/Traceroute
Operation • Ping: Checks the connection status and speed between the device and the target
Method host. Results include packet loss information, maximum/minimum data packet size,
and the round-trip time of the packets.
• Traceroute: Displays the route and transit delays of packets from the device to the
target host. Up to 30 hops can be monitored.
Users could click on the “Start” button, wait for the GDMS system to diagnose the device, and the GDMS
platform will print out the results of the diagnostics.
Each operation prints the diagnostics result once, and users could operate the diagnostics multiple times.
Note:
• It only displays the Ping/Traceroute records of the device in the last 30 days.
Version 1.0.10.23
Syslog
1. To start a capture, click on the Start button on the Syslog page. At any time during the capture, users
2. Clicking on the End button will stop the capture, and the Syslog will be saved to GDMS.
Notes:
• For UCM devices, the Syslog download function is temporarily not available.
• It only displays the Syslog data of the device in the last 30 days.
Capture Trace
The Capture Trace tool allows users to get a network packet capture of a device.
Version 1.0.10.23
2. Click on the Stop button to end the packet capture.
Notes:
• GDMS can only capture up to 5 minutes. An ongoing capture will end automatically after 5 minutes.
Network Diagnostics
Users can perform network diagnostics on a specific device, including local network status, network packet
loss rate, latency, uplink/downlink network rates, etc.
Version 1.0.10.23
Figure 164: Network Diagnostics
System Status
Users can view the system status of a specific device through the GDMS platform to diagnose the device
problems, including storage space, CPU, memory information, etc.
1. Click the “Start to get” button to get the system status from the device in real-time.
Version 1.0.10.23
Figure 165: System Status
End Diagnostics
Click on the End Capture button on the Device Diagnostics page to end diagnostics for the device. All
diagnostic processes will stop.
Note:
Since GDMS does not allow multiple users to diagnose the same device simultaneously, please make sure
that a diagnosis is properly ended by clicking on the End Diagnostics button.
Diagnostics Records
Users can view the entire diagnostic history of all devices associated with the current account.
Version 1.0.10.23
Figure 166: Diagnostics Records
2. In the Diagnosis records, each device will display one diagnosis record. The user can click on the
button to access the device diagnostics page to continue the specific operations.
3. View the diagnostic history of a specific device by using the search bar on the top right of the
Diagnostic Records page.
4. Users can delete records by selecting one or more items and clicking on the Delete button.
Note:
If the device is offline, the user still can access the device diagnostics page. However, the device diagnostic
function cannot be operated, the user can only view the diagnosis records of the device.
Version 1.0.10.23
ALERT MANAGEMENT
GDMS has an alert system that will trigger when certain conditions are fulfilled. There are 3 alert levels:
High, Medium, and Low.
Users can view and receive alert notifications in two ways: Message Notification and Email Notification.
This displays the alert as a notification under the icon in the top right corner of the GDMS page.
1. To manage message alert notifications, click on the Message Notification Settings button
Version 1.0.10.23
Table 32: Message Notification Settings
Alert Details VoIP devices alert and UCM devices alert. Users can click Tab and select the alert
contents, respectively.
Alert Details Users can specify what alerts to receive. The following alert priority levels are available:
High Level:
▪ Device Offline
▪ Disk Usage
▪ Memory Usage
▪ System Reboot
▪ System Crash
▪ Fail2ban Blocking
▪ Remote Login
Version 1.0.10.23
▪ Network port traffic alert
▪ Flood attack
Medium Level:
▪ Task Run Failure (users can specify the tasks they want notifications for)
▪ System Upgrade
Note: Only the UCM devices that have UCM RemoteConnect advanced plans can report
the alert contents and send the alert notifications.
Subscriber Select the users that will be alerted. Only sub-users created by the current user can be
selected.
Note:
If a scheduled task fails to run, the alert notification will be sent only to the task creator.
2. When there are unread alerts, and a user subscribed to alerts logs in, the icon will shake.
Hovering over the icon will show the unread messages. Clicking on these messages will show more details
about the alerts.
Version 1.0.10.23
Email Notification Settings
1. To manage email alert notifications, click on the button on the top-right corner
Alert Details VoIP devices alert and UCM devices alert. Users can click Tab and select the alert
contents, respectively.
Version 1.0.10.23
Alert Details Users can specify what alerts to receive. The following alert priority levels are available:
High Level:
▪ Device Offline
▪ Disk Usage
▪ Memory Usage
▪ System Reboot
▪ System Crash
▪ Fail2ban Blocking
▪ Remote Login
▪ Flood attack
Version 1.0.10.23
Medium Level:
▪ Task Run Failure (users can specify the tasks they want notifications for)
▪ System Upgrade
Note: Only the UCM devices that have UCM Remote Control advanced plans can report
the alert contents and send the alert notifications.
Subscriber Select the users that will be alerted. Only sub-users created by the current user can be
selected.
Note:
If a scheduled task fails to run, the alert notification will be sent only to the task creator.
2. When the subscriber receives the alarm notification, the GDMS platform will send an email to inform the
subscriber. To avoid the alarm notification emails disturbing the subscriber, the GDMS platform only can
send one alarm notification email to the subscriber’s email box per hour.
Version 1.0.10.23
APP Notification Settings
The alerts can be pushed to the subscribers through the App notifications.
1. The user can click the button to access the App notification settings interface.
Alert Details VoIP devices alert and UCM devices alert. Users can click Tab and select the alert
contents, respectively.
Alert Details Users can specify what alerts to receive. The following alert priority levels are available:
High Level:
▪ Device Offline
Version 1.0.10.23
▪ CPU Traffic Control
▪ Disk Usage
▪ Memory Usage
▪ System Reboot
▪ System Crash
▪ Fail2ban Blocking
▪ Remote Login
▪ Flood attack
Medium Level:
▪ Task Run Failure (users can specify the tasks they want notifications for)
▪ System Upgrade
Note: Only the UCM devices that have UCM Remote Control advanced plans can report
Version 1.0.10.23
the alert contents and send the alert notifications.
Subscriber Select the users that will be alerted. Only sub-users created by the current user can be
selected.
2. The user can select the alert types to which the user wants to subscribe and click the “Save” button to
apply the changes. After logging in to the GDMS application, the user will be notified through the app
notifications.
UCM devices that have a UCM Remote Connect service plan can use the SMS Notification function. This
function is only supported by some of the UCM Remote Connect plans.
1. To manage email alert notifications, click on the button on the top-right corner of
the Alert Management page.
Version 1.0.10.23
Table 35: Notification Settings
Alert Details Users can specify what alerts to receive. The following alert priority levels are available:
High Level:
▪ Device Offline
▪ Disk Usage
▪ System Reboot
▪ Remote Login
Note: Only the UCM devices that have UCM Remote Control advanced plans can report
the alert contents and send the alert notifications.
Receiving Enter the phone numbers which will receive the notification message. The phone numbers
Number can be added or deleted.
When the number is entered, the user needs to click the “Send Captcha” option and enter
the received verification code to finish adding the receiving number.
The Alert Management page shows all alerts that have been generated by GDMS.
Note:
Users can be limited by their privileges on the alerts they can view on the Alert Management page. Please
refer to the User Management section for more details.
Version 1.0.10.23
Figure 173: View Alert Notification
• Search: Users can find specific alerts by using the filter and search features in the top right corner
of the Alert Management page.
• Latest alarm notification: If the alarm notification includes a red dot at the beginning of the item,
it means the alarm notification is unread. Users could click on the button to
mark all unread notifications as “Read.”
• View Details: Users could click on the button following the alert notification to view the alert
notification details, and the red dot will disappear if the user has viewed the alert notification details.
• Device Diagnostics: For the device which has a fault, the user could click on the option to
access the Device Diagnostics page to diagnose the device.
• Delete Alerts: Users can delete notifications by selecting one or more items and clicking on the
Delete button.
Version 1.0.10.23
RESOURCE MANAGEMENT
Firmware Management
Custom Firmware·
Users could upload the firmware of the devices to upgrade the associated devices on the GDMS platform.
Note:
It is recommended to download the device’s firmware from Grandstream’s Official website to avoid device
failure.
2. Either drag and drop the firmware file to the upload area or enter the firmware file path.
Upgrade Path • Upload File: Upload the firmware file directly. Users could drag the firmware
file to the uploading area or click on the uploading area to select the
uploading firmware.
• Enter File Path: File path of the firmware. Please make sure that this file
Version 1.0.10.23
path can be accessed by your devices.
Firmware Name This is used to identify the firmware file name. The limit is 1 - 64 characters.
Version Number Fill in the actual version number of the uploaded firmware.
3. Once the firmware is uploaded successfully, it will appear in the custom firmware list. Devices will be
able to select the firmware when upgrading via GDMS.
Official Firmware
The official firmware page lists the latest official firmware for every supported device. This list is maintained
and updated by Grandstream.
Version 1.0.10.23
Figure 176: Official Firmware
Note:
Official firmware cannot be edited or deleted, and users can only download or push the firmware to upgrade
the devices.
Users can subscribe to firmware update email notifications to keep up to date with the latest firmware
releases.
1. Click on the New Version Notification Settings button at the top of the Firmware page. The following
window will appear:
Version 1.0.10.23
Figure 177: Firmware Update Notification Settings
2. Users can select the device models they want firmware update notifications for.
Users could push the upgraded firmware to the devices directly, or the devices in a range of firmware
versions.
Version 1.0.10.23
1. Click on the button for the desired firmware. The following window will appear:
2. Select the devices to push the firmware to. Users can search for specific devices by entering a MAC
address or name or filter devices by specific sites.
3. Click on Update Now to immediately push the firmware upgrade to devices or Schedule Config Update.
4. Click on the Save button to create the task. Users can check the status of the firmware upgrade on the
Task Management page.
Edit Firmware
Users could edit the firmware name, firmware version, and other information on the GDMS platform.
Users could also re-upload the firmware into the GDMS platform. Click on the button to access the
Note:
If the firmware file is changed, existing scheduled tasks involving that firmware will still use the original file,
not the newly uploaded file.
Version 1.0.10.23
Download Firmware
Note:
If a firmware on GDMS is using a configured file path, that path will be used when downloading it.
Delete Firmware
Users can delete firmware by selecting them in the firmware list and clicking on the Delete button in the
top-left corner of the list.
Note:
If the firmware is deleted, scheduled tasks associated with it will continue as normal anyway. Once all
associated scheduled tasks are completed, the firmware file will automatically be removed from GDMS.
Users can upload the resource files (such as ringtone files, wallpapers, language packs, etc.) to the GDMS
platform so that users can configure or assign the resource files to devices at any time.
Upload Resource
1. On Resource Management → Other Resources page, click on the resource files uploading button.
2. Users can drag or click to upload ringtone files, pictures, language packs, and other files, as the figure
shows below:
Version 1.0.10.23
Figure 179: Custom Firmware
File Users could drag the file to the uploading area or click on the uploading area to select
the file.
File size limit: Bin file/Ringtone – 128KB; Picture/Language pack – 500KB; Other –
5MB.
File Name This is used to identify the file name. The limit is 1 - 64 characters.
File Type This is used to identify the file type, such as ringtone, picture, language pack, and
Others.
3. Click the “OK” button to save the file to the GDMS server.
Notes:
• When the resource file is uploaded to the GDMS server, users can configure the resource file for
the device on the “Set Parameters” page.
• Only some specific models support configuring custom ringtones and language packs, and the
supported file sizes are different.
Version 1.0.10.23
View Resource List
Users can view all resources on Resource List under the enterprise, including the uploaded resources.
1. Users can go to Resource Management → Other Resources to view the resources list.
2. Users can also search the resources by resource type or file name on the resources list.
1. On Resource Management → Other Resources page, click the button following the resource
file to copy the resource URL.
2. Copy the file URL and paste it to another file download path.
Download Resource
1. On Resource Management → Other Resources page, click the button following the resource
file to download the resource.
Version 1.0.10.23
Modify Resource
1. On Resource Management → Other Resources page, click the button following the resource
file to modify the resource.
Note:
If the user wants to re-upload the resource file, the device using this file URL may download and use the
new resource file.
Delete Resource
1. On Resource Management → Other Resources page, click the button following the resource
file to delete the resource. Users can also select multiple resource files and click the Delete button on the
top of the page to batch delete the resource files.
2. When the user confirms to delete the resource file, the selected file will be deleted from the GDMS
platform.
Note:
When the file is deleted from the GDMS platform, the device uses the URL pointing to that specific file, the
user can still use the downloaded resource file in the device locally.
All resource files are stored in the enterprise's storage space. This interface shows the storage space
occupied and the total storage space:
1. On the” Resource Management“ → ”Storage Space“ interface, go to the Storage Space statistics
page. This interface shows the storage space taken up by the custom firmware and the other resource files.
Version 1.0.10.23
Figure 181: View Storage Space
If the current storage space is less than 10% or full, the user can upgrade the plan or clean up the
storage space to get more available storage space.
Version 1.0.10.23
CHANNEL MANAGEMENT
Channel customers and service providers can obtain a list of purchased devices from Grandstream ERP.
This list will allow the channel customer or service provider to:
1. Quickly assign devices to sub-channel customers. These customers will then be able to log into
GDMS to manage the devices.
Note:
Channel customers and service providers will need to contact Grandstream support to associate their
GDMS account with an ERP account.
If a superior channel wants to assign devices to the user, the superior channel needs to add the user’s
GDMS account as a subordinate channel.
The user needs to copy and send the binding address to the superior channel.
1. Click on the link at the top of the Channel page “View my binding channel address,” as the figure
shows below:
2. View my superior channel binding address, users could reset/copy the binding address.
Version 1.0.10.23
Figure 183: Superior Channel Binding Address
• Reset Address: Generate another address. The previous link will be invalid.
Add Sub-channel
Users can add sub-channels to GDMS accounts at any time. Once added, the user can assign devices to
the sub-channels. To properly add a sub-channel:
Obtain the bind address from sub-channels to add their GDMS accounts.
1. On the Channel Management page, click on the Add Sub-channel button. The following window will
appear:
2. Enter the provided bind address from the sub-channel into the Link Address field.
Version 1.0.10.23
3. Add a description or comment for this sub-channel.
5. Once the sub-channel is added, users can now assign devices to it via the Trace Devices tab.
Notes:
• Each user could be the subordinate channel customer for multiple GDMS users.
• Each user could be the superior channel distributor for multiple GDMS users.
• Users could only add subordinate channel customers which are in the same region (If the user is
in the region of the United State, the user could only add the enterprises in the United State region
as the subordinate channel customers).
After adding a sub-channel, users can only edit the Remarks field for it. To edit it, click on the button
To remove sub-channels from GDMS, select the desired sub-channels and click on the Disassociate button.
Devices can no longer be assigned to this sub-channel.
Version 1.0.10.23
Figure 186: Disassociate Sub-channel
Track Device
View Device
To view all devices assigned to the account, click on the Track Device tab.
Resource Where the device originated from. Currently, there are two values:
• ERP Order – The device’s data was synchronized from Grandstream ERP.
• Main Channel – The device was added by the main channel.
Version 1.0.10.23
Warehousing The date/time the device was assigned to the account.
Time
Status Allocated: The device has been assigned to a sub-channel and cannot be assigned
to other sub-channels.
Unallocated: The device is not allocated to any sub-channel yet.
Outgoing Time The date/time the device was assigned to a sub-channel. The company name of the
sub-channel will also be displayed.
Users can search for specific devices by using the filter and search options in the top-right of the Channel
Management page.
Note:
Users cannot directly upgrade the firmware or update the configuration file of the devices from this list.
Please refer to Configure Device section.
When devices are assigned to an account, the icon will show a notification. Clicking on the
notification will show the list of assigned devices.
Device Assignment
For the devices which have been sold to the subordinate channel customer, the user could allocate the
devices to them. The subordinate channel customer could log in to the GDMS platform to view and manage
the devices.
1. Click on the button for the desired device. The following window will appear:
Version 1.0.10.23
Figure 188: Assign Single Device to Subordinate Channel
1. Click on the Device Operation button at the top-right of the Channel Management page.
2. Click on Assign to Subordinate Channel on the Track Device page. The user will be redirected to the
batch device assignment page.
Version 1.0.10.23
Figure 190: Assign Multiple Devices to Subordinate Channel
Device Select the devices to assign to the sub-channel from the list or enter the
MAC addresses of the devices.
4. Click the Save button to finalize changes and the assignment. The sub-channel will then be notified of
the device assignment.
Notes:
• The device which has been allocated to a customer cannot be allocated to any customer else.
• When the device is allocated, the user cannot acquire back the device. If the device is allocated to a
Version 1.0.10.23
customer incorrectly, the user could contact the subordinate channel customer to allocate the device
back to the user.
Configure Device
To manage devices from the Channel Management device list, users must first import the devices to
GDMS Device Management.
1. Click on the button for the desired device. The following window will appear:
Version 1.0.10.23
USER MANAGEMENT
The User Management page allows users to view, add, and edit users and manage role privileges. By
default, GDMS has one administrator, which has all available privileges. Roles are sets of privileges that
admins can assign sub-users.
Add Role
To add a role with specific privileges, click on the Add Role button at the top right of the User Management
→ Role page and enter the following information:
Role Name Users need to input the name of the role in this field.
Description Users need to input the description of the role in this field.
Note:
If a role does not have the privilege of a feature, the GDMS portal will not show it.
Version 1.0.10.23
Edit Role
To edit a role’s name, description, and privileges, click on the button for the desired role.
Note:
Delete Role
To delete a role, click on the button for the desired role. If the role includes some sub-users accounts,
the role cannot be deleted.
Add Sub-user
To add a sub-user to the GDMS account, click on the Add Sub-user button and enter the following
information:
Name Users need to input the name of the sub-user in this field.
Email Address Users need to input the email address of the sub-user. The sub-user will use this to verify
and activate this account, log into GDMS, and receive email notifications.
Version 1.0.10.23
Role Users need to select the role of the sub-user.
Manageable Assign the manageable organization to the user, and the administrator could select the
Organization manageable organizations from the existing organizations in two different regional
servers.
Upon creating the sub-user, an activation email will be sent to the configured email address. The sub-user
must click on the provided link to activate the account.
Edit User
To edit a verified sub-user’s role, click on the button for the desired sub-user and select the new role.
The sub-users other information cannot be modified even by an administrator.
For unverified sub-users, administrators can modify the name, email address, and role. Additionally, they
can send an account activation email to the configured email address.
Delete User
To delete user accounts, click on the button for the desired user. Deleted users cannot log into GDMS.
Version 1.0.10.23
User Settings
Users can view and edit their personal information on GDMS by clicking on their name in the top-right
corner of the GDMS portal and clicking on User Settings.
Main Region This option displays the primary region of the current GDMS account. This can be
deleted. After deleting the main region, the data in the current regional server cannot be
restored.
Name This option shows the display name for the account.
Email Address This option shows the email address associated with the account. To modify this email
address, the user will need to enter the current login password.
Login Name This option shows the username for the account. This is used for logging into GDMS,
and it can be modified. The user needs to enter the password and new login name for
authentication. The new login name must be unique.
Password The login password is editable. The user needs to input the original login password to
modify the current login password.
Version 1.0.10.23
Country This option shows the country of the user.
Time Zone This option shows the time zone of the user.
Time Format Users can modify the time format to 12 hours or 24 hours on the interface.
Date Format Users can modify the date format to MM/DD/YYYY, DD/MM/YYYY, or YYYY/DD/MM on
the interface.
Role Info This option shows the current role of the user.
Sign Out
Log out of the account by clicking on the username in the top-right corner of the GDMS portal and clicking
Sign Out.
If the user does not want to use the GDMS platform to manage devices anymore, the user can delete the
GDMS account and all sub-accounts of the enterprise.
Note:
After deleting the GDMS account, all data of the GDMS account will be deleted.
1. Click the “Personal Information” option on the name menu at the upper right corner of the main page
to enter the personal information configuration page.
2. Click the “Delete business account” button at the top of the page to delete the current GDMS account.
If the enterprise GDMS administration account is deleted, all sub-accounts under the main GDMS account
Version 1.0.10.23
will also be deleted.
Version 1.0.10.23
Associated Company Management
Users can add associated companies for management in the GDMS platform. After establishing the
association relationship, users can select the associated companies and share the organizations with the
associated companies for management.
After adding the associated company, the user can select the associated company and share the
organization with the company, so that the user and the associated company can manage the organization
together or assign the management permission to the associated company for management.
The user can obtain the binding address from the company with which the user wants to establish the
association relationship.
1. The user can access User Management -> Associate Company page, and click the “Add Associated
Company” button to add the associated company. Please see the screenshot below:
2. Enter the binding address of the associated company in the field “My Company Associating Address”.
4. The user can click the “Save” button to add the associated company. Once done, the user can view
the associated company name, remarks, and association time on the “Associated Companies” list.
Please see the screenshot below:
Version 1.0.10.23
Figure 200: Associated Companies List
On the “Associated Companies” list, the user can click the button to access the “Edit Associated
Disassociate Company
If the user wants to disassociate the relationship with the associated company, the user can select the
Version 1.0.10.23
Figure 202: Disassociate Company
Note:
After disassociating the association relationship, the shared organizations will not be affected, the
organization can also be managed by the previously associated company.
Version 1.0.10.23
ORGANIZATION MANAGEMENT
If users want to manage devices in multiple subordinate organizations, users could create multiple
organizations (such as customer enterprises, sub-companies), and assign the devices to multiple users to
manage separately. The devices, SIP accounts, and other parameters are separated between different
organizations. The data in a specific organization can only be viewed and managed by the administrator
who has permission.
SIP Task、
Alert SIP Task、
Account Site Alert SIP Task、
Account Site Alert
Account Site
System
Mangement
Switch Organization
If the user has permissions for multiple organizations, the user could switch to manage different
organizations.
1. Click the drop-down box of the Organizations menu at the upper left corner of the page to select the
organization the user wants to manage.
2. After switching the organization, the user only could view/edit the Device, SIP Account, Template, and
other data under the organization.
Version 1.0.10.23
Figure 204: Switch Organization
Add Organization
1. On the menu on the right side of the page, select System Management → User Management, and select
the “Organization” tab, click the “Add Organization” button in the upper right corner.
Version 1.0.10.23
Figure 205: Add Organization
Assign User Select the users who will have permission to manage the organization.
Clone Organization This is used to select to copy data from other organizations, the data include SIP
accounts, model templates, group templates, sites, etc. When the organization is
created successfully, the data under the specific organization will be copied to the
current organization.
Owned Subsystem Select the subsystems that the current organization belongs to, including the VoIP
system and UCMRC system. If it belongs to multiple systems, the relevant data
such as site data, VoIP device, and SIP account information can be shared across
systems in the organization.
3. Click the Save button to save the organization on the GDMS platform.
4. The system will switch to the newly created organization by default, and the user could add devices to
the newly created organization for management.
Version 1.0.10.23
Edit Organization
1. On the menu on the right side of the page, select System management → User Management, and select
the “Organization” tab to view all organizations under the account.
2. Click on the button following the organization name to access the editing page. The user could
edit the organization name, the administrator of the organization, owned subsystems, and descriptions, as
the figure shows below:
Delete Organization
1. On the menu on the right side of the page, select System management → User Management, and
select the “Organization” tab to view all organizations under the account.
2. Click on the Delete button following the organization name, the organization will be deleted
completely after confirmation, including the SIP accounts, templates, tasks, diagnostics histories,
and other data under the organization.
Note:
If there are devices in the organization, the organization cannot be deleted. Please transfer the devices to
other organizations before deleting the organization.
Version 1.0.10.23
Share Organization
The user can select to share the organizations with the associated companies. There are 2 methods of
sharing permissions: Co-management and Authorized Management.
1. On the “Organization” management interface, the user can select the organization that the user wants
to share with another company for management and click the button to access the “Share”
organization interface. Please see the screenshot below:
Share Permission There are 2 methods of sharing permissions to another company: Co-
management and Authorized Management.
Co-management: After sharing the organization, the user can manage the
organization with the associated company together. The associated company can
manage all devices in the shared organization and view the related data.
Note:
⚫ If the user has shared the organization with one associated company for
management, the user cannot share the organization again with any other
company.
Version 1.0.10.23
company, the user can fully authorize the management permissions to the
associated company for management, and the user does not have permission to
manage this organization anymore.
Note:
⚫ If the user sets to “Authorized Management”, the user cannot make any
operation to this organization, and the organization information will be
removed from the user’s “Organization” list. The data in the organization will
be transferred to the associated company for management.
Associate The user needs to select the associated company with which the user wants to
Company share the organization.
2. The user can select the “Share Permission”: “Co-management” or “Authorized Management”.
3. Select the associated company to which the user wants to share the organization.
4. After clicking the “Save” button, the selected organization will be shared with the selected associated
company.
5. After the operation steps above, the user can view the organizations which were shared from other
associated companies and shared with other associated companies on the “Organization” list. Please
Version 1.0.10.23
see the screenshot below:
: The label indicates the organization has been shared with another associated company for
management together.
: The label indicates the organization is shared with another associated company for management
together.
Note:
⚫ The organization can only be shared between the companies in the same region. If the selected
associated company does not enable the service in the current region, the user needs to inform the
associated company to enable the service in the current region so that the organization can be shared
with the associated company.
⚫ The user can access the User Management -> Associated Companies interface to add the associated
companies.
The user can cancel sharing the organization with the associated company.
1. On the “Organization” list, the user can select the organization with which the user wants to cancel
sharing with the associated company and click the button to cancel sharing with the organization.
Please see the screenshot below:
Version 1.0.10.23
Figure 210: Cancel Sharing Organization
2. After canceling sharing the organization, the user will get the organization management permission
back, and the associated company cannot manage this organization anymore.
Note:
⚫ After canceling sharing an organization, the user can share the organization again with another
associated company.
⚫ The user can cancel sharing the organization only if the user sets the “Co-management” method when
sharing the organization. If the user sets the method to “Authorized Management”, the user does not
have any management permission after sharing the organization with the associated company.
Return Organization
After receiving the shared organization, the associated company can return the management permission
to the user.
1. On the “Organization” list, the user can view the received shared organizations and select the
organization to which the user wants to return it by clicking the button as the screenshot shows
below:
Version 1.0.10.23
Figure 211: Return Organization
2. After returning the organization, the organization will be removed from the “Organization” list of the
associated company, and the associated company will lose the management permission the
organization.
Version 1.0.10.23
SYSTEM LOG
Users could view all operation logs of the system, including the login/logout logs of the user, adding new
devices, deleting devices, adding SIP accounts, deleting SIP accounts, firmware upgrading/downgrading
logs, updating configuration files for devices, devices factory reset logs, devices diagnostics logs, creating
model template logs, etc.
On the menu on the right side of the page, select System management → System Log, and users could
view all operation logs of the system. Users could also search the operation logs by level, operation contents,
operators, and time.
Note:
Users could only view the system logs for the last 30 days.
Version 1.0.10.23
VALUE-ADDED SERVICES
Users can click on the button in the top right corner to view the value-added services provided by the GDMS
platform. The following two value-added services are available in the GDMS platform:
Supports only for UCM63xx. When the user adds the UCM63xx device to the GDMS platform, the user
can apply for a UCMRC advanced plan for a free trial.
Complete NAT penetration mechanism. Users can use it directly without complicated configuration, so
that it can ensure the remote communication requirements through external networks (including Wave
application in mobile phones/desktop clients for registration/communication through external networks).
UCM Remote Management: There are 3 levels according to the plans, including View device
information (e.g., Firmware version), SIP accounts synchronization, remote restarting UCM device,
upgrading UCM, and remote access to the UCM Web UI.
GDMS Cloud Storage service is provided with bonus cloud storage space. This is used for backup
configuration files and user data for UCM.
UCM data statistics report is provided and sent to the administrator through email.
UCM Cloud IM Plan provides cloud IM communication services for UCM devices. After purchasing this
plan, Wave users can use the cloud IM system, and the chat data will be stored in the cloud system.
Note:
⚫ Users can view the details of different plans on the official website.
⚫ Users can only apply for the free trial of the UCMRC advanced plan once for each UCM device that is
associated with the GDMS platform. If the user purchases a UCMRC plan which is different from the
free trial plan, the current free trial will expire and the purchased UCMRC plan will take effect
immediately.
⚫ Please refer to UCM63xx User Guide on the official website for details about Using the remote call
function on UCM/Wave application, backup files to GDMS cloud storage space, restoring backup files,
and viewing the details of remote call records.
Version 1.0.10.23
UCM Cloud IM Service
UCM Cloud IM service is an add-on service of the UCM RemoteConnect plan, and it provides cloud IM
communication services for UCM devices. After purchasing a UCMRC plan that contains the Cloud IM
service, the Wave user can use the cloud IM system, and the chat data will be stored in the cloud system.
Provides cloud communication service with high performance, large storage, and multi-function.
Starts to use UCM Cloud IM service, which is not limited by the performance and storage space of
UCM devices. Phone calls and messages are not affected by each other.
Note:
1. The user needs to purchase the UCM RemoteConnect plan which contains the Cloud IM service. After
purchasing the plan, the user needs to enable the service on the GDMS platform before using the service.
2. After enabling the UCM Cloud IM plan in the UCM device, all chat data will be stored in the cloud
system. The local chat history will not be viewable.
3. Each UCM Cloud IM plan can be bound to the multiple UCM devices in a certain enterprise so that the
users of the multiple UCM devices can send IM messages, create groups, send meeting notifications to
each other, etc.
4. When the UCM RemoteConnect plan which contains the Cloud IM service expires, the Wave user
cannot log in to the account. The chat data will also be deleted. Please renew the UCM Cloud IM plan in
time.
Enable Service
Prerequisite: The UCM plan contains the permission for this function.
1. The user can click the button to access the “My Plans” list, select a UCM
RemoteConnect plan which contains the Cloud IM service, and enable the Cloud IM service on the
GDMS platform.
Version 1.0.10.23
Figure 213: My Plans
2. The user can click the button to access the “Edit Cloud IM” interface. Please see the screenshot
below:
Version 1.0.10.23
Table 45: Edit Cloud IM
Enable Cloud IM After purchasing a UCMRC plan that contains the Cloud IM service, the user needs
Note:
If the user wants to disable the Cloud IM service which is currently in use and will
no longer use it, the data in the Cloud IM server will be cleared after disabling it.
Region US Region / EU Region
Note:
⚫ If the user switches to another region, the data in the Cloud IM server will be
cleared.
Enterprise Name The user can customize the name of the enterprise which will use the Cloud IM
service.
Cloud IM Maximum The user can edit the maximum available storage space for the Cloud IM service.
Storage Space
Note:
⚫ The user needs to allocate some space from the cloud storage space for Cloud
IM service usage.
⚫ The configured storage space must be larger than the space currently used by
the Cloud IM service and smaller than the available cloud storage space.
Note:
⚫ On the UCM Devices list, the user can click to view the plan information of the selected device and
Version 1.0.10.23
Figure 215: UCM Device -> Enable Cloud IM Service
3. Click the “Save” button to get the UCM Cloud IM Service, and the user can view the Cloud IM
service domain name, service ID, and Key.
4. The user can quickly bind the UCM device for the Cloud IM service so that the UCM device can
start to apply the Cloud IM service quickly.
Version 1.0.10.23
Figure 217: Bind UCM Device
Note:
⚫ The user can also copy the service ID and service key and bind the UCM device to the UCM device
management platform. The user can go to the UCM Web UI → System Settings → Cloud IM interface
and enter the Cloud IM involved information in the blanks. The corresponding IM data are placed in
the Cloud IM external server.
Version 1.0.10.23
Figure 218: Bind UCM Device on Web UI
⚫ The bound UCM device also needs the UCMRC plan which contains the Cloud IM service.
⚫ For the Cloud IM service in the UCMRC plan free trial, when the free trial expires, the user cannot use
the Cloud IM service on the GDMS platform, and if the user wants to use the UCM device data in the
Cloud IM service in the UCMRC plan free trial, the user needs to transfer the data to the newly
purchased Cloud IM service.
In the “My Plans” interface, the user can view the details of the UCMRC plan corresponding to the Cloud
IM service, the user can click the icon to view the service domain name, service ID, and Key of this
plan.
Version 1.0.10.23
Figure 219: View Service ID and Key
Note:
If the storage space of this plan is full, the user cannot send files and pictures.
1. In the My Plan interface, find the UCM Cloud IM Service, and click the icon .
2. View the UCM devices which are bound to the UCM Cloud IM plan. It allows users to add/delete devices.
Please see the screenshot below:
Version 1.0.10.23
Department Name Enter the name of the department using this UCM device so that the contact details
in the Wave application can be viewed.
UCM MAC Address Enter the MAC address of the UCM that uses the UCM Cloud IM plan. It only
supports the UCM devices which have been associated with the GDMS platform.
Note:
⚫ For the UCM devices which have not been associated with the GDMS platform,
the user can only log in to the UCM management platform to configure the
Cloud IM services.
⚫ The bound UCM device also needs the UCMRC plan which contains the Cloud
IM service.
Dial Prefix The dial prefix required to dial this UCM device must be the same as the trunk dial
prefix configured in the UCM. Please refer to the UCM Administration Guide for
more details.
For example, there are UCM A, UCM B, and UCM C. If the configured prefix of
UCM B and C to dial A is 99 (configured trunk), then when the user adds UCM A,
the user needs to configure the dial prefix to 99.
Note:
If the user adds/deletes/edits department names, the status will show as the icon until the UCM is
1. In the My Plan interface, find the UCM Cloud IM Service, and click the icon .
2. The user can modify the name of the enterprise, and the new name will be applied immediately.
Version 1.0.10.23
Figure 223: Edit Company
Note:
Currently, the company name is only used to remark the UCM Cloud IM plan, and it will not be displayed
elsewhere.
1. In the “My Plans” interface, find the UCM Cloud IM Service, and click the icon .
2. The user can modify the maximum storage space of the Cloud IM service. The configured Cloud IM
service usage storage space must be smaller than the currently available storage space and larger than
the currently used storage space.
Version 1.0.10.23
Figure 225: Cloud IM Maximum Storage Space
Note:
⚫ The user needs to allocate some space from the cloud storage space for the Cloud IM service usage.
⚫ If there is no more available cloud storage space, the user can contact the device distributor to upgrade
the UCM RemoteConnect plan to a higher-level plan or purchase an add-on storage space plan to
obtain more cloud storage space.
For the Cloud IM service in the UCMRC plan free trial, when the free trial expires, the user cannot use the
Cloud IM service on the GDMS platform, and if the user wants to use the UCM device data in the Cloud IM
service in the UCMRC plan free trial, the user needs to transfer the data to the newly purchased Cloud IM
service.
Version 1.0.10.23
Figure 226: Cloud IM Service Free Trial
1. The user can click the button to access the “My Plans” interface, select the
previous Cloud IM service on the list of the plans, click the button and select the newly
purchased Cloud IM service so that the UCM device data in the previous Cloud IM service will be
Version 1.0.10.23
Figure 227: Sync UCM Data
2. The user needs to select the main plan which contains the Cloud IM service, click the button
to access the Cloud IM service editing interface, and the user can customize the enterprise name, and
Version 1.0.10.23
Figure 228: Sync UCM Data - Edit Cloud IM
3. After clicking the “Save” button, the UCM device data in the previous Cloud IM service will be transferred
Note:
⚫ If the newly purchased Cloud IM service has been enabled and there are some existing data in
the service, after transferring the UCM data to the Cloud IM service, the data in the newly
purchased Cloud IM service will be cleared.
⚫ If the previous Cloud IM service has expired over 1 month, the synchronized UCM data will not
contain the chat history and files, and it will only synchronize the UCM device information.
Purchase Service
If the user wants to purchase a UCM RemoteConnect plan, the user needs to contact the device distributor
to learn more details about the plan and purchase the plan. The GDMS platform does not provide the
purchasing service online.
Note:
If the user cannot contact the device distributor, the user can access the “UCM Devices” list -> Plans or
click the “Order History” button to view the “My Plans” list and click the button
to access purchasing interface. Then, the user can click the “Help” button so that the GDMS platform will
inform the device distributor to contact the user as soon as possible.
Version 1.0.10.23
Figure 229: Purchase Service
View My Plans
Click on the Order History to access the My Plans interface. This page displays all purchased plans by
the current enterprise.
• Active
Version 1.0.10.23
• Expired
Note:
If the user can see an icon , it means the Add-on Plan will expire soon.
1. If the user can see the icon , it indicates that the plan will expire soon. Please renew or
On the My Plans interface, select a specific plan and click on the button to view all order history of
this device.
• Users could check the order ID, Plan, Transaction Type (upgrade/renew/purchase), Subscription
Time, and Expiration Time.
• The user can view all the additional plans under the current plan, as well as the record of orders of
the additional plans.
• The plan details contain the main plan and the add-on plan.
Version 1.0.10.23
Figure 232: View Plan Details
Download Invoice
Users can download the invoices for all orders. If the purchasing behavior passes the verification, the user
could download the invoice.
2. Select a specific plan, and click the icon to view all order history of the plan.
Note:
• If the user purchases the plan from the distributor, please contact the distributor to get the invoice.
Version 1.0.10.23
Renew Plan
If the user wants to renew the current UCM Remote Connect plan, the user needs to contact the device
distributor to learn more details about the plan and renew the plan.
Note:
If the user cannot contact the device distributor, the user can access the “My Plans” interface, select the
UCM device which the user wants to renew the plan for, and click the button to access the
purchasing page.
After clicking the “Help” button, the GDMS platform will inform the device distributor to contact the user as
soon as possible.
Upgrade Plan
If the user wants to upgrade the current UCM Remote Connect plan, the user needs to contact the device
distributor to learn more details about the plan and upgrade the plan.
Note:
If the user cannot contact the device distributor, the user can access the “My Plans” interface, select the
UCM device which the user wants to upgrade the plan for, and click the button to access the
purchasing page.
After clicking the “Help” button, the GDMS platform will inform the device distributor to contact the user as
Version 1.0.10.23
soon as possible.
If the plan in the account will be expired after 15 days or already expired, the user will receive a notification
through registered email.
Version 1.0.10.23
Figure 236: Plan Expiration Notice
Note:
• Once the plan expires, the files that exceed the maximum storage space will be deleted after 7
days. Please download the files as soon as possible or renew them in advance.
• Once the plan expires, if the user configures a custom access server address for the UCM device,
the custom access server address will be deleted after 7 days.
• If the previous Cloud IM service has expired over 1 month, the synchronized UCM data will not
contain the chat history and files, and it will only synchronize the UCM device information. If the
user renews the UCMRC plan which contains the Cloud IM service within 1 month, the chat history
and files will be preserved.
Version 1.0.10.23
MULTI-FACTOR AUTHENTICATION
GDMS Multi-Factor Authentication (MFA) is the simple and best security practice method that adds extra
protection to account username and password. When MFA is enabled, the user will be required to enter the
login username and password (the first security method) and an authentication code (the second security
method) from the MFA device when they log on to the GDMS platform. These multiple methods will improve
the security of the settings and resources of your GDMS account.
Users can purchase supported physical devices or virtual MFA devices to enable MFA for GDMS accounts.
Virtual MFA Device is an application that runs and simulates physical devices on mobile phones or other
devices. The virtual MFA device will generate a six-digit code based on a one-time time-synchronized
cryptographic algorithm.
When logging into the GDMS platform, the user must type in a valid code from the specific device. Each
virtual MFA device assigned to the user must be unique. The user cannot type in the code with another
user's virtual MFA device code for authentication. Since the virtual MFA device may be executed on an
unsafe mobile device, it may not provide the same level of security as a physical MFA device.
A physical MFA Device is a device that can generate a six-digit code based on a one-time time-synchronized
cryptographic algorithm.
When logging into the GDMS platform, the user must type in a valid code from the specific device. Each
physical MFA device assigned to the user must be unique. The user cannot type in the code with another
user's physical MFA device code for authentication.
Version 1.0.10.23
MFA Device Standards
Physical Device Use your smartphone/tablet/PC The physical device supports open
Standard which can execute applications that TOTP standards. It is recommended to
support open TOTP standards to use the devices from the Microcosm
install a virtual MFA device manufacturer.
Function Support multiple tokens on a single The financial service institutions and IT
device enterprises use the same model of the
device.
Install the virtual MFA application for your smartphone/tablet/PC from your device’s app store. The following
table lists some applications that are suitable for multiple kinds of smartphones.
To enhance security, it is recommended that users can configure Multi-Factor Authentication (MFA) to help
protect GDMS resources. Users can enable MFA for GDMS accounts.
Version 1.0.10.23
Enable Virtual MFA Device
Prerequisite: Users need to install a virtual MFA application on the smartphone/tablet/PC before enabling
a virtual MFA device.
1. Log in to the GDMS platform with your account number, click on the name at the upper right corner,
and access the personal information page:
2. Click to enable the “Multi-Factor Safety Authentication” option and select to use “Virtual MFA Device”
on the pop-up window, then click the “Next” option to continue.
3. Then, it will generate and display the configuration information of the virtual MFA device, including QR
code graphics. This figure represents the configuration of the virtual MFA device as a secret key, users
can scan the QR code to finish setting the virtual MFA device. Users can also input the secret key
manually into the smartphone/tablet/PC to finish setting virtual MFA devices if your
smartphone/tablet/PC does not support scanning QR codes.
Version 1.0.10.23
Figure 238: Scan QR Code
4. Open the virtual MFA application in your smartphone/tablet/PC, ensure that the application in your
smartphone/tablet/PC supports scanning QR codes, and then perform one of the following actions
below:
a. If the MFA application in the smartphone/tablet/PC supports scanning QR codes, the user can
use the application to scan QR codes to finish setting the virtual MFA device. For example, the
user can select the camera icon or scanning QR code option to use the device's camera to scan
the QR code.
b. If the smartphone/tablet/PC does not support scanning QR codes, the user can click on the
“Show secret key” option and input the private secret key manually in the MFA application.
Note: If a virtual MFA application supports multiple virtual MFA devices or accounts, the user can select
the appropriate options to create new virtual MFA devices or accounts.
5. When the operations above are completed, users can use the virtual MFA device to generate one-
time passwords.
In the MFA secret code box Code 1, the user enters the one-time password which is displayed in the
virtual MFA device currently. Then, wait for 30 seconds so that the virtual MFA device will generate a
new one-time password, the user enters the second one-time password in the MFA secret code box
Code 2.
Version 1.0.10.23
Figure 239: Input MFA Secret Code
6. Click on the “Start Verification” option to start verifying the password. When the verification is passed,
the GDMS account and the virtual MFA device have been bound successfully. When the user tries to
log in to the GDMS platform, the user must input the MFA device code.
Notes:
• When the secret code is generated, the user needs to use the secret code to proceed verification
process immediately. If the user does not submit the secret code and waits for a too long time,
the one-time secret code (TOTP) may be expired. Then, the user may need to start the
verification process again from the beginning.
• The user can only bind the virtual MFA device to a single account.
Prerequisite: The user needs to purchase the physical MFA device before using this verification function.
1. Log in to the GDMS platform with your account number, click on the name at the upper right corner,
and access the personal information page.
2. Click to enable the “Multi-Factor Safety Authentication” option and select to use “Physical MFA
Device” on the pop-up window, then click the “Next” option to continue.
3. Enter the interface below to bind the physical MFA device with the GDMS account:
Version 1.0.10.23
Figure 240: Hardware MFA Device Authentication
4. Input the secret key of the device. Please contact the manufacturer for the secret key.
Note:
The key format is required to be “DEFAULT HEX SEEDS” (seeds.txt), or “BASED32 SEEDS”.
Examples:
5. In the MFA secret code box Code1, the user enters the six-digit one-time password which is displayed
on the physical MFA device currently. The user needs to press the button on the front of the physical
MFA device to display the secret code. Then, wait for 30 seconds and press the display button on the
front of the physical MFA device again, so that the MFA device will generate the second six-digit one-
time password. The user needs to enter the second one-time password in the MFA secret code box
Code 2.
Version 1.0.10.23
6. Click on the “Start Verification” option to start verifying the password. When the verification is passed,
the GDMS account and the physical MFA device have been bound successfully. When the user tries to
log in to the GDMS platform, the user must input the MFA device code.
Notes:
• When the secret code is generated, the user needs to use the secret code to proceed verification
process immediately. If the user does not submit the secret code and waits for a too long time,
the one-time secret code (TOTP) may be expired. Then, the user may need to start the
verification process again from the beginning.
• The user can only bind the physical MFA device to a single account.
If the user does not need to proceed with MFA verification, the user can remove the MFA device and restore
the normal login authentication method.
1. Log in to the GDMS platform with your account number, click on the name at the upper right corner,
and access the personal information page.
2. Click the “Remove” button to remove the MFA Authentication function for the current GDMS account.
If your MFA device is lost or does not work properly, you can remove the MFA device first and then re-
enable the new MFA device.
Method 1: If your GDMS account is a sub-account, you can contact the main GDMS account to remove
your multi-factor authentication from the User management page. After removal, you can log in to the
GDMS platform with the password, and then re-enable the new MFA device.
Method 2: If your GDMS account is the main GDMS account and you cannot log in to the GDMS platform,
you can contact our Technical Support, provide your relevant information to our Technical Support, and they
will help you remove the multi-factor authentication (Our Technical Support will send the removal email to
the user and the user needs to input account password and check removal).
Version 1.0.10.23
API DEVELOPER
GDMS platform opens API interfaces for public users. Users can apply for API Developer to use the services.
Users can click to view the details about API interfaces.
1. Click on “API Developer” on the menu on the left side and click to apply for API Developer.
2. Click on “Apply for API Developer”, the GDMS platform will assign the API Client ID and secret key to
the GDMS account, and the GDMS account can use the API Client ID and secret key to invoke the API
interfaces.
Version 1.0.10.23
3. If the user wants to disable the API Developer feature, the user can click on “Disable API Developer” to
stop invoking the API interfaces.
Notes:
• If your GDMS account is in the US region, the {gdms_domain} can be filled with www.gdms.cloud
• If your GDMS account is in the EU region, the {gdms_domain} can be filled with eu.gdms.cloud
2. When the API Developer is disabled, the previous API secret key will be invalid, the user cannot invoke
the GDMS interfaces. If the user tries to re-apply for the API Developer feature, the system will assign
another secret key to the GDMS account.
Version 1.0.10.23
ABOUT GDMS
Users can view GDMS system information, supported device models, and firmware requirements for device
models by clicking on System Management → About GDMS.
Version 1.0.10.23
EXPERIENCING GDMS.CLOUD SYSTEM
Please visit our product website at https://www.grandstream.com for the latest release, features instructions,
FAQs, latest documentation, and latest product information.
We encourage you to browse our product-related documentation, FAQs, and User and Developer Forum
for answers to your general questions. If you have purchased our products through a Grandstream Certified
Partner or Reseller, please contact them directly for immediate support.
Our technical support staff is trained and ready to answer all your questions. Contact a technical support
member or submit a trouble ticket online to receive in-depth support.
Thank you again for using the Grandstream GDMS system, it will be sure to bring convenience to both
your business and personal life.
Version 1.0.10.23