Adapter - UCE
This page describes version 2.0.8 of the adapter.
Overview
This adapter is used as a connector between the Workflow Engine and the UCE/OW5000 system.
Dates in the UCE command are normally represented in the yyyyMMdd[HH[mm[ss]]] format unless otherwise noted.
For connections to Microsoft SQL server from the linux docker environment your MSSQL server must be using the latest Service Pack. For example MSSQL 2008R2 SP3 or above. Older versions of MSSQL do not supported the needed protocols for DB connections from the linux docker environment.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| platformServer |
Platform Server |
True |
The name of the UCE platform server. |
string |
|
|
|
1024 |
1 |
| uc700ServiceUri |
UC700 Service Address |
True |
The URL to UC700 web services. |
string |
https:// |
|
|
1024 |
1 |
| connectionString |
UCE Database Connection String |
False |
The UCE SQL database connection string. |
string |
|
|
|
2048 |
1 |
| xmppUser |
The jabber id to login to XMPP |
False |
Format: user@domain.com. |
string |
|
|
|
1024 |
1 |
| xmppPassword |
XMPP account password |
False |
The password to log in to the XMPP server. |
password |
|
|
|
1024 |
1 |
| receiveXmppMessages |
Select this option if you wish to receive messages for configured XMPP account. |
False |
|
boolean |
false |
|
|
|
|
| xmppServer |
XMPP Server Address |
False |
Specify the address of the XMPP server. |
string |
|
|
|
1024 |
1 |
| xmppPort |
XMPP Server Port |
False |
Specify the port number of the XMPP server. |
integer |
5222 |
65535 |
1 |
|
|
Commands
Get Presence (getPresence)
Get the presence of a UCE user.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| userId |
User ID |
UCE LoginId of the user. |
True |
string |
Response Properties
| Name |
Description |
Type |
| presence |
The presence for the user. |
string |
| code |
The presence code for the user. |
string |
| codedisplay |
The display for the presence code. |
string |
Set Presence (setPresence)
Set presence of a UCE user.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| userId |
User ID |
UCE LoginId of the user. |
True |
string |
| presence |
Presence |
The presence value (e.g. Busy). |
True |
string |
| comment |
Comment |
Optional User Comment. |
False |
string |
Make Call (makeCall)
Make a call
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| officeCode |
Office Code |
Office Code of the Pbx to be used to make the call. |
True |
string |
| callingNumber |
Calling Number |
Number or extension making the call. |
True |
string |
| calledNumber |
Called Number |
Extension or Number being called. |
True |
string |
Send XMPP (sendXmpp)
Sends an XMPP message.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| to |
To |
XMPP Message Recipient. |
True |
string |
| message |
Message |
XMPP Message to be sent. |
True |
string |
| htmlMessage |
HTML Message |
HTML part of the message. |
False |
string |
Send Panic XMPP Message (sendPanicXmppMessage)
Sends an XMPP message when Panic button is pressed.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| to |
To |
XMPP Message Recipient. |
True |
string |
| playSound |
Play Sound |
Whether to play a sound on smart device or not when XMPP message is sent (true/false). |
False |
string |
| panicButtonId |
Panic Button Id |
Unique button id of the device for which the panic button is pressed. |
True |
string |
| personId |
Person Id |
OW5000 Person Id of the person with whom the panic device is associated. |
True |
string |
| title |
Title |
Title of the XMPP Message |
False |
string |
| body |
Body |
Body of the XMPP Message |
False |
string |
| telephoneNumberId |
Telephone Number Id |
OW5000 TelephoneNumber Id associated with the person who pressed panic button. |
False |
string |
| numberToCall |
Number To Call |
Security number that should be called |
True |
string |
Group Notify Test (groupNotifyTest)
Group Notify Test.
Response Properties
| Name |
Description |
Type |
| test |
Test Result. |
string |
Group Notification Send (groupNotifySend)
Send a group notification.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| subject |
Subject |
Subject of Group Notification. |
True |
string |
| message |
Message |
Group Notification Message. |
True |
string |
| sendingUserId |
Sending User Id |
User Id (UCE Login ID) of the notification sender. |
True |
string |
Set Avatar (setAvatar)
Set Avatar or profile picture for a UCE User.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| userId |
User ID |
UCE Login ID of the user. |
True |
string |
| avatar |
Avatar |
The image to be set as avatar. |
True |
string |
Hotel Set Avatar (hotelSetAvatar)
Set avatar of a Hotel Room.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| room |
Room |
Hotel Room for which avatar needs to be updated. |
True |
string |
| avatar |
Avatar |
The image to be set as avatar. |
True |
string |
Response Properties
| Name |
Description |
Type |
| success |
true/false |
string |
Add Patient (addPatient)
Add a patient to UCE database.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| firstName |
First Name |
First Name of the patient. |
True |
string |
| lastName |
Last Name |
Last Name of the patient. |
True |
string |
| subjectId |
Subject ID |
Subject Id from Neoface - Stored as Patient Number in UCE. |
True |
string |
| mobileNumber |
Mobile Number |
Mobile Number Contact Method value for the patient. |
False |
string |
Response Properties
| Name |
Description |
Type |
| personId |
The person id of the patient. |
string |
Find Patient (findPatient)
Find a patient in UCE database.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| patientId |
Patient ID |
Patient ID to search for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| personId |
The person id of the patient. |
string |
Reserve DID Number (reserveDIDNumber)
Reserve a DID Number in UCE.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| didGroupId |
DID Group ID |
The unique identifier from the UCE database of the DID Group where the DID number should be reserved. This parameter can be left blank or set to "-1". In this case the DID number will be reserved in the default DID Group in the UCE system. |
False |
string |
Response Properties
| Name |
Description |
Type |
| didNumber |
The DID number that was just reserved, or 00000 in case that a DID number couldn't be reserved. |
string |
Patient Operations (patientOperations)
Command to support different Patient Operations. As of now, Admit and Discharge are supported.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| operationType |
Operation Type |
Allowed Values - AdmitPatient, DischargePatient. |
True |
string |
| patient_FirstName |
First Name |
First Name of the patient. |
False |
string |
| patient_MiddleName |
Middle Name |
Middle Name of the patient. |
False |
string |
| patient_LastName |
Last Name |
Last Name of the patient. |
True |
string |
| patient_BirthDate |
Birth Date |
Patient Birth Date. |
False |
string |
| patient_Gender |
Gender |
Gender of the patient. Usually it takes the "M" or "F" values but it is not limited to these ones. It is actually a free-form field. |
False |
string |
| patient_StreetAddress |
Street Address |
Patient Street address. |
False |
string |
| patient_City |
City |
Patient City. |
False |
string |
| patient_County |
County |
Patient County. |
False |
string |
| patient_ZipCode |
Zip Code |
Patient Zipcode. |
False |
string |
| patient_HomePhone |
Home Phone |
Patient Home Phone Number. |
False |
string |
| patient_WorkPhone |
Work Phone |
Patient Work Phone Number. |
False |
string |
| patient_PatientNumber |
Patient Number |
This is a value that uniquely identifies a person in the respective health care unit. It is generated with the occasion of the first patient visit in the respective health care unit and never changes. |
False |
string |
| patient_Account |
Account |
This is a value that uniquely identifies a person in the respective health care unit, during the current visit. It is re-generated each time when the patient makes a new visit in the respective health care unit. |
False |
string |
| patient_AdmitDate |
Admit Date |
Date on which Patient was admitted. |
True |
string |
| patient_DischargeDate |
Discharge Date |
Represents the date when the last visit of the patient in the respective health care unit has ended or will end. If this parameter is empty or it is set to 1/1/1970 then the discharge date is not yet known. |
False |
string |
| patient_AssignedLocation |
Assigned Location |
The patient's assigned location, formatted as Unit |
Room_Nr |
Bed_Nr |
| patient_PatientVisitID |
Patient Visit Id |
The visit ID of the patient. |
False |
string |
| patient_Confidentiality |
Confidentiality Status |
Patient Confidentiality Status. |
False |
string |
| patient_Visitors |
Visitors |
Patient Visitors. |
False |
string |
| patient_PhoneService |
Phone Service |
Phone Service data / Can have values Y/N or 1-15. |
False |
string |
| patient_DIDNumber |
DID Number |
The DID Number. |
False |
string |
Response Properties
| Name |
Description |
Type |
| result |
The result. |
string |
Find Guest By Folio (findGuestByFolio)
Find a guest in UCE database by Folio Number.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| folio |
folio |
Guest Folio number to search for. |
True |
string |
Response Properties
| Name |
Description |
Type |
| firstName |
Guest First Name |
string |
| lastName |
Guest Last Name |
string |
| hotel |
Guest Hotel Name |
string |
| room |
Room assigned to guest |
string |
| status |
Guest Reservation Status |
string |
| checkinDate |
Guest CheckIn Date |
string |
| checkoutDate |
Guest CheckOut Date |
string |
Guest Check In (guestCheckIn)
Add or update a Guest into UCE system and assign one of the 2 statuses - DueIn or CheckIn
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| firstName |
First Name |
First Name of Guest. |
True |
string |
| lastName |
Last Name |
Last Name of Guest. |
True |
string |
| folioNumber |
Folio Number |
Folio Number for Guest. |
True |
string |
| hotelName |
Hotel Name |
Guest Hotel Name. |
True |
string |
| roomName |
Room Name |
The name of the room where the Guest needs to be checked in. When specified, the adapter will try to check in the guest in this particular room. When not specified, the adapter will first try to find an available room for check in. |
False |
string |
| guestStatus |
Guest Status |
Status of the guest being added / updated - duein / checkin. If nothing is specified, checkin is default. |
False |
string |
| notes |
Guest Notes |
Additional information about guest that needs to be stored in UCE |
False |
string |
Response Properties
| Name |
Description |
Type |
| response |
The response. |
string |
| status |
Status of the command - 1/0 |
string |
| room |
Room number assigned to guest. |
string |
Guest Check Out (guestCheckOut)
Checkout the Guest from UCE system.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| folioNumber |
Folio Number |
Guest Folio Number. |
True |
string |
| hotelName |
Hotel Name |
Guest Hotel Name. |
True |
string |
Response Properties
| Name |
Description |
Type |
| response |
The response. |
string |
CheckIn Existing Guest (checkInExistingGuest)
CheckIn a guest who is already in the UCE system.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| folioNumber |
Folio Number |
Guest Folio Number. |
True |
string |
Response Properties
| Name |
Description |
Type |
| response |
The response detail. |
string |
| status |
Status of the command - 1/0 |
string |
| room |
Room number assigned to guest. |
string |
Get User Details By Extension (getUserDetailsByExtension)
Get user details from UCE database by looking up assigned extension.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| extension |
Extension |
Extension to look up in Uce database. |
True |
string |
| officecode |
Office Code |
Office Code of PBX to which extension belongs. |
True |
string |
Response Properties
| Name |
Description |
Type |
| firstname |
User's First Name. |
string |
| lastname |
User's Last Name. |
string |
| telephonenumberid |
Telephone number (OW5000 database) ID of the given extension. |
string |
| personid |
Person ID of the user to whom the extension is assigned to. |
string |
| userroleid |
User Role ID of the user. |
string |
| email |
Email of the user. |
string |
| loginid |
Unique UCE Login ID of the user. |
string |
| acdid |
ACD ID. |
string |
| acdlogin |
User's ACD Login - if applicable. |
string |
| jabberid |
User's Jabber Id - if applicable. |
string |
Get User Details By Custom Field (getUserDetailsByCustomField)
Get user details from UCE database by looking up custom field value assigned to Person.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| fieldName |
Field Name |
Custom Field Heading Name |
True |
string |
| fieldValue |
Field Value |
Custom Field Value |
True |
string |
Response Properties
| Name |
Description |
Type |
| firstname |
User's First Name. |
string |
| lastname |
User's Last Name. |
string |
| telephonenumberid |
Telephone number (OW5000 database) ID of the given extension. |
string |
| personid |
Person ID of the user to whom the extension is assigned to. |
string |
| userroleid |
User Role ID of the user. |
string |
| email |
Email of the user. |
string |
| loginid |
Unique UCE Login ID of the user. |
string |
| jabberid |
User's Jabber Id - if applicable. |
string |
Events
XMPP Message Received (xmppMessage)
XMPP Message notification for Broadcast and Chat messages
Event Properties
| Name |
Display |
Description |
Type |
| to |
To |
The recepient of XMPP message. |
string |
| from |
From |
The XMPP message sender. |
string |
| subject |
Subject |
The subject of XMPP message. |
string |
| type |
Type |
The type of XMPP message. |
string |
| body |
Body |
The body of XMPP message. |
string |
| isdelayed |
Is Delayed |
Boolean indicating if the message is delayed or not. True for offline messages. |
string |
| timestamp |
Timestamp |
The UTC time when the XMPP message is sent. |
string |
| messageerror |
Message Error |
Error message(if any) set by XMPP server. |
string |
| necemergencygroupnotification |
NEC Emergency Group Notification |
Boolean set to tru if the message is an emergency group notification. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
|
|
| 2.0.7 |
Bug fixes
Maintenance |
Fixed security issue and problem connecting to UC700 web service.
Updated third-party components and improved maintainability. |
NAP-19777
NAP-11518 |
|
| 2.0.8 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-23945 |
2022-12-01 |
Categories