Adapter - NEC DT Terminal
This page describes version 2.0.18 of the adapter.
Overview
This adapter can be used to connect to and control NEC DT terminals.
Hot Desking
Currently only the commands for requesting/releasing Hot Desking are available. These commands offer the possibility for a user to assign or release his own extension in a flexible desk environment. With other words, after a desk reservation, the DT terminal related to a desk will automatically get the user's extension assigned. Or, after a desk release, the extension is removed from the DT terminal.
The following picture illustrates how it works:
- the user selects a free desk and the reservation application will issue a command towards the adapter to assign the SV terminal on that desk his number
- The adapter will create a configuration file on the FTP server specific for that terminal
- The adapter will instruct the terminal on that desk to issue a download request for the newly created configuration file
- The terminal will download the new configuration file from the FTP server
- The terminal reboots and will have the user's extension assigned
Supported SV-Platforms and DT-Terminals
The following SV-Platforms are being supported by this adapter:
- SV9100, SV9300 and SV9500
- SV8100, SV8300 and SV8500
There is a limitation on the SV9100 and SV8100, when extension is moved to a terminal that has been used before with another extension number, the terminal will ask for confirmation to override the previous used extension.
The following DT-Terminal series are supported by this adapter:
- DT700 series
- DT730G/DT770G series
- DT800 series (version from 3.0.0 and higher)
- DT900 series
Prerequisites Hot Desking
License
The Adapter requires to have a valid license (Integration Platform Hot Desking) installed on the UIP system. Without a valid license, starting the Adapter will fail and a failure reason will be shown to indicate that a license is required.
Network Access
The Adapter requires to have network access to all terminals used for Hot Desking in order to send a download request to terminal to download the required configuration file. The Adapter requires also to have network access to an FTP server and a MongoDB database, configured for the Adapter.
DT-Terminal configuration file preparations
In order to do Hot Desking on a SV platform some preparations are needed for automatically assigning an extension number to a DT-terminal. Using the IP Phone Manager tool you need to create full configuration files for every DT-Terminal series meant to be used for Hot Desking. These configuration file are needed in order to specify the IP address and port of the SV-Platform. The configuration files need to be present in the FTP folder that is being configured in the Adapter (see 'Path' property within the Properties paragraph below).
To make a configuration file, use Auto Config option of the IP Phone Manager. In there select the type of the terminal and Full config. Within the Auto config setup, make sure you fill in the following settings:
- SIP Settings -> 1st Server Address & URI -> 1st Server Address
- SIP Settings -> SIP Server Port -> 1st Server port
- SIP Settings -> SIP User -> User ID, Password, Extension Number: select the 'Parameter Update' flag to make possible overwriting these fields with the extension number and password when terminal logs in or out.
Consult DT Resource Terminal manual for detailed information about creating the configuration files. The extension related config files will be derived from these 'master' config file.
If you have an SV-Platform (named A) that has DT700 series, DT730G/DT770G series, DT800 series and DT900 series then you're required to create 4 full configuration files for that SV-Platform: A_DT700_Terminal.gz, A_DT7G_TerminalCfg.gz, A_DT800_TerminalCfg.gz and A_DT900_TerminalCfg.gz.
These configuration files are to be created for every SV-Platform in your network that is being used for Hot Desking. So if you have SV-Platforms named A, B and C which also have the same DT series as mentioned before you will get the following 12 full configuration files:
- A_DT700_Terminal.gz, A_DT7G_TerminalCfg.gz, A_DT800_TerminalCfg.gz and A_DT900_TerminalCfg.gz
- B_DT700_Terminal.gz, B_DT7G_TerminalCfg.gz, B_DT800_TerminalCfg.gz and B_DT900_TerminalCfg.gz
- C_DT700_Terminal.gz, C_DT7G_TerminalCfg.gz, C_DT800_TerminalCfg.gz and C_DT900_TerminalCfg.gz
Warning: When you change a 'master' DT-Terminal configuration file it will have no effect on the existing derived extension configuration files. To make sure the extension related config files will have the changes of the 'master' DT-Terminal configuration file you must do the following:
- Stop the adapter.
- Remove all the from 'master' DT-Terminal configuration file derived extension configuration files from the FTP server.
- Start the adapter again!
HTTPS server is configured as file server in the configuration file or DT-terminal
If you want to use the HTTPS protocol on the DT-terminal to download the config files, you need to select "Use HTTPS as download protocol" in the adapter. Checking this checkbox means that the Adapter will tell the DT-Terminal to use HTTPS protocol for downloading the configuration file.
The adapter does not support a mix of download protocols. So for HTTPS all DT-terminals controlled by the adapter need to support HTTPS.
In case of HTTPS, the adapter still requires an FTP server to manipulate the configuration files. It is mandatory that the FTP server is installed on the HTTPS server machine. The FTP server needs to be configured to address the same folder where the DT-Terminals get their configuration files from. This means the path for HTTPS folder and FTP folder needs to be equal. The login name and password for HTTPS and FTP must also be the same.
Note: In case you don't have an FTP server, there are many free (open source) FTP servers. For example, if you have a Windows server, you can use IIS or FileZilla Server. If you have a Linux server, you can use vsftpd. These FTP servers are easy to use and have been successfully tested. The vsftpd FTP server can handle at least 25 Hot Desk requests/second and the FileZilla FTP server can handle at least 15 Hot Desk requests/second.
FTP Server remarks
- FTPS is not supported.
- FTP folder needs to have read, write and delete permissions for the configured login user in the Adapter.
- Make sure the FTP server is configured to have no speed limits for upload as well as for download.
- It is recommended to use vsftpd FTP server when high performance is required.
MongoDB database remarks
An instance of a MongoDB server must be available to keep track of licensed terminals. The adapter uses a database named "dtTerminalAdapter" on this server. By default a MongoDB server is configured with security disabled and this implies that it is not required to configure a username and password.
In case security is enabled, a username and password must be configured for the Adapter. This user must be added with access to the "dtTerminalAdapter" database. Use a 'mongo' shell and issue the next commands:
db.getSiblingDB('dtTerminalAdapter')db.createUser( { user: 'username', pwd: 'password', roles: [ { role: "readWrite", db: "dtTerminalAdapter" } ] } )
The first command selects the database that is used. It is mandatory to use "dtTerminalAdapter" as its name. The second command creates a user with a username and password with access-rights to this database. This 'username' and 'password' need to be configured in the adapter as "Database Server login name" and "Database Server login password".
Adapter configuration and commands
Before the adapter can be used, first it needs some configuration-data (see Properties below). To locate the FTP Server, the hostname or IP-address and port-number must be configured. For authorization on the FTP Server, a login name and password are required. Specify also the path to the DT-Terminal configuration files.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| hostname | FTP Server Hostname or IP Address | True | Hostname or IP Address of the FTP Server | string | 1024 | ||||
| serverport | FTP Server Port Number | True | IP port-number of the FTP Server | integer | 21 | 5 | |||
| path | FTP Server Path | False | The path name the FTP Server uses to store the config files | string | / | 1024 | |||
| loginname | FTP Server login name | False | Login name of the FTP Server | string | 1024 | ||||
| password | FTP Server login password | False | Login password of the FTP Server | password | 1024 | ||||
| usehttpsprotocol | Use HTTPS as download protocol | False | When selected, the DT Terminal will use HTTPS to download config files else FTP | boolean | false | ||||
| dbhostname | Database Server Hostname or IP Address | True | Hostname or IP Address of the database server used for licensing | string | 1024 | ||||
| dbport | Database Server Port Number | True | IP port number of the database server used for licensing | integer | 27017 | 5 | |||
| dbusername | Database Server login name | False | Login name of the Database Server used for licensing | string | 1024 | ||||
| dbpassword | Database Server login password | False | Login password of the Database Server used for licensing | password | 1024 | ||||
| daystokeep | Number of days to keep terminals checked-in (0 = unlimited) | True | Terminals, checked-in longer than this number of days, will be checked-out automatically | integer | 30 | 3 | |||
| utcoffset | Offset of timezone compared to UTC time | False | Offset (in hours and minutes), like -5:00 for New York or +9:00 for Tokyo (empty = 00:00) | string | 6 | ||||
| sendWait | Terminal messages sending interval (ms) | False | Terminal message sending interval in milliseconds (0 = no wait, default = 350) *Do not set a value unless instructed by NEC. | integer | 350 | 1000 | 0 |
Commands
Get Hot Desk phone (getHotDeskPhone)
Requests a hot desk session on a phone.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| extension | Extension number | The extension number for the phone. | True | string |
| siploginname | SIP login name | The extension's SIP login name required for hot desking | True | string |
| sippassword | SIP login password | The extension's SIP password required for hot desking | True | string |
| configfilename | Configuration filename | Name of the file that stores the hot desking phone configuration on the FTP or HTTPS server | True | string |
| terminaladdress | Terminal address | The address of the terminal used for hot desking | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| configfilestatus | The terminal configuration file was successfully created | boolean |
| configfileerror | The terminal configuration file creation has failed | string |
| terminalcontrolstatus | The terminal configuration file was downloaded successfully | boolean |
| terminalcontrolerror | The terminal configuration file download has failed | string |
| resultCode | 0 indicates success, all other values indicate a failure | string |
| resultMessage | Description of the Result-code | string |
| remainingLicenses | Number of available licenses after execution of this command | string |
Release Hot Desk phone (releaseHotDeskPhone)
Releases a hot desk session on a phone.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| extension | Extension number | The extension number for the phone. | True | string |
| siploginname | SIP login name | The extension's SIP login name required for hot desking | True | string |
| sippassword | SIP login password | The extension's SIP password required for hot desking | True | string |
| configfilename | Configuration filename to download | The filename to be used to download to the phone to release hot desking | True | string |
| terminaladdress | Terminal address | The address of the terminal used for hot desking | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| configfilestatus | The terminal configuration file was successfully created | boolean |
| configfileerror | The terminal configuration file creation has failed | string |
| terminalcontrolstatus | The terminal configuration file was downloaded successfully | boolean |
| terminalcontrolerror | The terminal configuration file download has failed | string |
| resultcode | 0 indicates success, all other values indicate a failure | string |
| resultmessage | Description of the Result-code | string |
| remainingLicenses | Number of available licenses after execution of this command | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.10 | Bug fix | Don't start adapter when ftp- or db-server are not started | NAP-13203 | |
| 2.0.12 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.14 | Maintenance | Support DT800/DT900 IPM interface encryption | NAP-21460 | |
| 2.0.15 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-30 |
| 2.0.16 | Bug fix | Adapter was not loading framework properly due to name casing. | NAP-24721 | 2023-01-13 |
| 2.0.17 | Bug fix | Occure timeout error on terminal interface sometimes | NAP-25953 | 2023-06-12 |
| 2.0.18 | Bug fix | Change default value for the Terminal messages sending interval property | NAP-26368 | 2023-07-12 |