Adapter - DECT Messaging
This page describes version 2.0.7 of the adapter.
Overview
This adapter is used as a connector between the DECT Messaging and Location Service (DMLS) and the Workflow Engine. The communication is done via TCP/IP.
Adapter Configuration
To use this adapter, you need to specify the IP address and the port number on which the DMLS application is 'listening'. Optionally, specify one or more extensions, or an extension range, to monitor for incoming messages. Then define a workflow trigger to receive these incoming messages and use them in a workflow.
You need to configure these settings with the following parameters:
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| dmlsAddress | DMLS (DECT Messaging and Location Service) Address | True | Host Name or IP-address of the DMLS | string | 253 | ||||
| dmlsPort | DMLS (DECT Messaging and Location Service) Port | True | Port number of the DMLS | integer | 2010 | 65535 | 1 | ||
| confirmation | Automatic Confirmation | True | Send 'message accepted' as automatic response to an urgent or very urgent message | boolean | true | ||||
| extensions | List of extensions to monitor | False | Comma-separated, use dash for ranges. Example: 1200,1400-1799 | string | 1024 |
Commands
Send Message (sendMessage)
Sends a DECT message to a DECT extension
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| fromExtension | From extension | Extension number of the message originator | True | string |
| toExtension | To extension | Extension number of the message receiver | True | string |
| text | Text | The message text (only the first 160 characters will be sent) | True | string |
| callbackDestination | Callback extension | By receiving the message the destination device can directly call this number pressing the Call button. | False | string |
| messageType | Message type | The message type (normal = 0, urgent = 1, very urgent = 2) | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| isRejected | The message is rejected by the destination. | boolean |
Send Confirmation (sendConfirmation)
Sends confirmation for urgent or very urgent message
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| messageId | Incoming message identification | The ID of the incoming (very)urgent message | True | string |
| rejected | Reject message | Reject the incoming (very)urgent message. true or false. Blank value assumes false. | False | boolean |
Get Radio Location (getRadioNumber)
Collects the last known radio number that the DECT handset used for location detection.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| extension | Extension Number | The Extension number of the device to locate. | True | string |
| poll | Poll for updated data | Poll the server for updated data if older than 10 seconds. True or false, blank assumes false. | False | boolean |
Response Properties
| Name | Description | Type |
|---|---|---|
| radioPosition | The radio position number last used by the device indicating location of the device. | string |
Events
Receive message event (messagereceived)
The event that is fired when a DECT message is received
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| source | Message From | Extension number of the message originator | string |
| destination | Message To | Extension number of the message receiver | string |
| text | Message text | The message text | string |
| messagetype | Message type | The message type (normal = 0, urgent = 1, very urgent = 2) | string |
| messageid | Message identification | The ID of the received message | string |
Timeout values
When sending commands and waiting for responses, there are a few timeout values to be taken into account:
- DMLS timeout 'Handset message Ack', default 13 secs - configured in DMLS, specifying how long the DMLS waits for a handset to acknowledge a message
- DMLS timeout 'User message Ack', default 30 secs - configured in the DMLS, specifying how long the DMLS waits for a user to confirm an urgent message
- The adapter waits up to 30 secs for the DMLS to answer to a command. When this period expires and no answer is received, the command fails with 'Timeout' result.
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.6 | Feature | Add getppinfo command | NAP-21115 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |