Adapter - AMS
This page describes version 2.0.8 of the adapter.
Overview
This adapter is used as a connector between the Application Message Service (AMS) that runs on a UCE/OW5000 system, and the Workflow Engine.
This adapter makes connections to the OW5000 Database to fetch data that may be needed in the Workflow.
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 |
|---|---|---|---|---|---|---|---|---|---|
| amsServer | AMS Server Address | True | The address to connect to the AMS server. | string | 1024 | 1 | |||
| amsPort | AMS Server Port | False | The port number to connect to the AMS server. | integer | 5425 | 65535 | 1 | ||
| connectionString | UCE Database Connection String | True | The UCE SQL database connection string. | string | 2048 | 1 |
- amsServer is the name or the IP Address of the UCE/OW5000 Server in most cases. However, there also are some deployment scenarios for AMS where it runs on a different server than the UCE/OW5000 Server. Be sure to always confirm the machine name or the IP address where AMS runs with the UCE system administrators.
- connectionString is normally in the following format:
Data Source=<sql_server_name_or_ip_address>[\\<sql_instance_name>];Initial Catalog=<ow5000_database_name>;Persist Security Info=True;User ID=<db_user_name>;Password=<db_user_password>;Connection Timeout=1; - sql_server_name_or_ip_address: The name or the IP address of the SQL server that hosts the OW5000 database
- sql_instance_name: The SQL Server instance that hosts the OW5000 database.
- If using the default instance, do not add this part
- If using a SQL Express server, specify SQLEXPRESS as the instance name.
- ow5000_database_name: Name of the OW5000 database. Typically, OW5000
- db_user_name: User name to connect to the OW5000 database. Typically, openworxdb
- db_user_password: Password used to to connect to the OW5000 database. Not listed here for security purposes. The UCE system administrators will always be able to provide it.
Example: Data Source=172.16.57.241\SQLEXPRESS;Initial Catalog=OW5000;Persist Security Info=True;User ID=openworxdb;Password=(not shown);Connection Timeout=1;
Commands
Register Event for a User (registerEvent)
Register event for receiving AMS notifications for a User.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| userId | User ID | UCE LoginId of the User. | True | string |
Unregister Event for a User (unregisterEvent)
Unregister an event for receiving AMS notifications for a User.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| userId | User ID | UCE LoginId of the User. | True | string |
Register ACD Split (registerAcdSplit)
Register event to receive notifications for an ACD Split.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| tenantNumber | Tenant Number | Tenant number associated with the ACD split. | True | string |
| splitNumber | Split Number | Split number of the ACD split. | True | string |
| acdName | ACD Name | Name of ACD on which split exists. | True | string |
Unregister ACD Split (unregisterAcdSplit)
Unregister event to stop receiving notifications for an ACD Split.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| tenantNumber | Tenant Number | Tenant number associated with the ACD split. | True | string |
| splitNumber | Split Number | Split number of the ACD split. | True | string |
| acdName | ACD Name | Name of ACD on which split exists. | True | string |
Register Event for All Users (registerAllEvent)
Register event for receiving AMS notifications for all Users.
Unregister Event for all Users (unregisterAllEvent)
Unregister an event for receiving AMS notifications for all Users.
Events
AMS Connected (amsConnected)
The connection to AMS has been established.
No properties defined
Presence Changed (presenceChanged)
User Presence change notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| userId | User ID | The unique ID of the user. | string |
| status | Status | The new presence status of the user. | string |
Hook State Changed (hookStateChanged)
User hook state change notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| userId | User ID | The unique ID of the user. | string |
| hookState | Hook State | The hook state of the user (OnHook/OffHook). | string |
| officeCode | Office Code | The office code where the hook state change occurred. | string |
| extension | Extension Number | The extension telephone number that generated the hook state change. | string |
| tenant | Tenant | The tenant number of the extension. | string |
| countryCode | Country Code | The country code of the extension. | string |
| e1164Number | E164 Number | The E164 number of the extension. | string |
| contactMethodCode | Extension Contact Method Type Code | The contact method type code assigned to the extension. | string |
Incoming Call (incomingCall)
Incoming call notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| userId | User ID | The unique ID of the user who has received the incoming call. | string |
| aniTextFull | Caller ANI Text Full | The Full ANI Text of the person that has made the call. | string |
| callerFirstName | Caller First Name | The First name of the person that has made the call. | string |
| callerLastName | Caller Last Name | The Last name of the person that has made the call. | string |
| callerFullName | Caller Full Name | The full name of the person that has made the call. | string |
| callerNumber | Caller Number | The phone number from which the call was made. | string |
| callerOfficeCode | Caller Office Code | The office code from which the call was made. | string |
| callerTenant | Caller Tenant | The tenant of the station from which the call was made. | string |
| callerTrunk | Caller Trunk | The trunk number from which the call was made. | string |
| callerRoute | Caller Route | The route number from which the call was made. | string |
| station | Station | The Station number that has received the incoming call. | string |
| officeCode | Office Code | The office code that has received the incoming call. | string |
| extension | Extension | The extension number that has received the incoming call. | string |
Outgoing Call (outgoingCall)
Outgoing call notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| userId | User ID | The unique ID of the user that has made the outgoing call. | string |
| calledName | Called Name | The name of the person that has received the call. | string |
| calledNumber | Called Number | The phone number that was dialed. | string |
| extension | Extension | The extension number from which the call was made. | string |
Guest Check In (guestCheckIn)
Guest check in notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| room | Room | The hotel room where the guest has been checked-in. | string |
Emergency Call (emergencyCallNotification)
Emergency call notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| eventType | Event Type | The type of the event (Call Started / Call Ended). | string |
| ANI | ANI | The ANI (i.e. the caller ID). | string |
| dialedNumber | Dialed Number | The number dialed by the caller (usually 911). | string |
| callDateTime | Call Date Time | The moment when the call has started, formatted as yyyy-MM-dd HH:mm:SS. | string |
| callDuration | Call Duration | The call duration, in seconds. | string |
| callerFullName | Caller Full Name | The caller's full name formatted according to OW5000 name formatting rules (usually: LastName, FirstName). | string |
| callerExtension | Caller Extension | The caller's extension number. | string |
| callerPbx | Caller PBX | The PBX that holds the caller's extension. | string |
| callerLocationFQHN | Caller Location FQHN | The FQHN of the location from where the call was made. | string |
| callerRouteTrunkInfo | Caller Route/Trunk Info | Information about the Emergency Route/Trunk used by the call. | string |
Acd Statistics (acdStatistics)
Acd Split Statistics notification - Requires ACD split subscription.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| acdSplitId | ACD Split ID | The OW5000 unique ID of the ACD Split. | string |
| speedOfServiceSecs | Speed Of Service Seconds | Speed Of Service Seconds. | string |
| speedOfServiceTimespan | Speed Of Service Timespan | Speed Of Service TimeSpan. | string |
| gradeOfService | Grade Of Service | Grade Of Service. | string |
| totalAbandons | Total Abandons | Total Abandons. | string |
| totalCalls | Total Calls | Total Calls. | string |
Agent Active Call Change (agentActiveCallChange)
Agent Active Call Change.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| modificationType | Modification Type | AMS Notification Modification Type - Create/Update/Delete. | string |
| agentActiveCallId | Agent Active Call Id | OW5000 unique Agent Active Call Id. | string |
| activeCallId | Active Call Id | OW5000 unique Active Call Id. | string |
| userRoleId | User Role Id | OW5000 unique User Role Id. | string |
| logInId | Login Id | OW5000 unique Login Id for a user. | string |
| personId | Person Id | OW5000 unique Person Id. | string |
| calledNumber | Called Number | Called number for the active call. | string |
| callingPartyNumber | Calling Party Number | Calling party number for the active call. | string |
| ctiInformation | CTI Information | CTI information for the active call. | string |
| splitName | Split Name | Active call's split name. | string |
| splitNumber | Split Number | Active call's split number. | string |
| pilotName | Pilot Name | Active call's pilot name. | string |
| pilotNumber | Pilot Number | Active call's pilot number. | string |
| callStatus | Call Status | Call Status - Queued/Connected. | string |
| totalQueueTime | Total queue Time | Total queue time for the active call. | string |
Active Call (activeCall)
Active Call Notification - Requires ACD split subscription.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| modificationType | Modification Type | AMS Notification Modification Type - Create/Update/Delete. | string |
| acdSplitId | ACD Split Id | OW5000 unique ACD Split Id. | string |
| activeCallId | Active Call Id | OW5000 unique Active Call Id. | string |
| contactInfoNumber | Contact Info Number | Contact Information Number. | string |
| contactInfoSource | Contact Info Source | Contact Source - Phone/Web Activity etc. | string |
| contactInfoName | Contact Info Name | Contact Information Name. | string |
| contactInfoPersonId | Contact Info Person Id | Contact Information Person Id. | string |
| calledNumber | Called Number | Called number for the active call. | string |
| callingPartyNumber | Calling Party Number | Calling party number for the active call. | string |
| ctiInformation | CTI Information | CTI information for the active call. | string |
| splitName | Split Name | Active call's split name. | string |
| splitNumber | Split Number | Active call's split number. | string |
| pilotName | Pilot Name | Active call's pilot name. | string |
| pilotNumber | Pilot Number | Active call's pilot number. | string |
| callStatus | Call Status | Call Status - Queued/Connected. | string |
| totalQueueTime | Total queue Time | Total queue time for the active call. | string |
ACD Split Active Call (acdSplitActiveCall)
ACD Split Active Call Notification - Requires ACD split subscription.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| modificationType | Modification Type | AMS Notification Modification Type - Create/Update/Delete. | string |
| acdSplitId | ACD Split Id | OW5000 unique ACD Split Id. | string |
| activeCallId | Active Call Id | OW5000 unique Active Call Id. | string |
| callsInQueue | Calls In Queue | Numbers of calls Queued for split. | string |
| contactInfoSource | Contact Info Source | Contact Source - Phone/Web Activity etc. | string |
| contactInfoNumber | Contact Info Number | Contact Information Number. | string |
| contactInfoName | Contact Info Name | Contact Information Name. | string |
| contactInfoPersonId | Contact Info Person Id | Contact Information Person Id. | string |
| calledNumber | Called Number | Called number for the active call. | string |
| callingPartyNumber | Calling Party Number | Calling party number for the active call. | string |
| ctiInformation | CTI Information | CTI information for the active call. | string |
| splitName | Split Name | Active call's split name. | string |
| splitNumber | Split Number | Active call's split number. | string |
| pilotName | Pilot Name | Active call's pilot name. | string |
| pilotNumber | Pilot Number | Active call's pilot number. | string |
| callStatus | Call Status | Call Status - Queued/Connected. | string |
| totalQueueTime | Total queue Time | Total queue time for the active call. | string |
ACD Active Call Party (acdActiveCallParty)
ACD Active Call Party Notification - Requires ACD split subscription.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| modificationType | Modification Type | AMS Notification Modification Type - Create/Update/Delete. | string |
| acdSplitId | ACD Split Id | OW5000 unique ACD Split Id. | string |
| activeCallId | Active Call Id | OW5000 unique Active Call Id. | string |
| calledNumber | Called Number | Called number for the active call. | string |
| callingPartyNumber | Calling Party Number | Calling party number for the active call. | string |
| ctiInformation | CTI Information | CTI information for the active call. | string |
| splitName | Split Name | Active call's split name. | string |
| splitNumber | Split Number | Active call's split number. | string |
| pilotName | Pilot Name | Active call's pilot name. | string |
| pilotNumber | Pilot Number | Active call's pilot number. | string |
| callStatus | Call Status | Call Status - Queued/Connected. | string |
| totalQueueTime | Total queue Time | Total queue time for the active call. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | NAP-25404 | |
| 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 |