Adapter - Micros Fidelio PMS
This page describes version 2.0.7 of the adapter.
Overview
The Micros/Fidelio PMS adapter is used in hospitality vertical markets to connect the Workflow Engine to a Micros/Fidelio PMS systems over a TCP/IP interface.
The adapter facilitates both ways communication. Messages will be sent to PMS by means of adapter commands, while PMS notifications will be reported to WFE via adapter events.
A permanent TCP connection is maintained between this adapter and the PMS.
All the commands for this adapter are "fire & forget" command types. That means that a command is sent and the PMS will respond using events, if necessary. That results in having no response parameters for commands. Request parameters may exist or not depending on the command.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| hostName | PMS Host Name | True | Defines the host name, or the IP address where the Micros/Fidelio PMS is running. | string | 1024 | 1 | |||
| portNumber | PMS Port Number | True | Defines the port number on which the PMS is listening for incoming connections. | integer | 5010 | 65535 | 1 | ||
| systemReconnectInterval | System Reconnect Interval | False | Defines the number of seconds to wait for a (re)connection attempt after losing the PMS connection. | integer | 180 | 3600 | 1 | ||
| pmsRetryInterval | Connection Retry Interval | False | Defines the number of seconds to wait between 2 successive PMS connection attempts. | integer | 10 | 3600 | 1 | ||
| pmsNumberOfRetries | Connection Retries Number | False | Defines the maximum number of PMS connection attempts. | integer | 3 | 10 | 1 | ||
| microsKeepAliveTime | Keep Alive Interval | False | Defines number of seconds on which the adapter sends a Link Active (LA) message to the PMS in order to keep the TCP connection alive. | integer | 120 | 180 | 60 | ||
| microsCheckInterfaceAvailableTime | Check Interface Available Interval | False | Defines number of seconds on which the adapter checks if the PMS is still up and running by sending a Link Start (LS) message. Necessary in case that the PMS restarted and lost the subscription list, so that the handshake procedure is reinitialized | integer | 420 | 840 | 60 | ||
| microsWaitForLeMessageTime | LE Message Waiting Interval | False | Defines number of seconds to wait for a Link End (LE) notification from PMS. | integer | 3 | 10 | 1 | ||
| microsRoundedBracketsIssue | Use Rounded Brackets for Guest Name | False | Defines a flag to be used when processing the guest name in PMS notification messages. If the PMS in China sends CN() instead of CN, this flag is used to trim the rounded brackets from the message when applicable. | boolean | false | ||||
| microsTransmitLRC | Use LRC byte | False | Defines a flag to indicate if the PMS messages are post-fixed with a redundancy check byte or not, according to the PMS configuration | boolean | false | ||||
| lrSubscriptions | LR message subscriptions | True | Defines an escaped JSON string containing a list of PMS subscription messages to be used during the handshake procedure. | string | { "GI":"G#RNGSA0A1A2A3A4A9GAGDGFGGGLGNGTGVSFTI", "GO":"G#RNGSSFTI", "GC":"G#RNGSA0A1A2A3A4A9GAGDGFGGGLGNGTGVROTI", "XM":"G#RNMIRTDATI", "XL":"G#MIMTRN$JDATI", "XT":"G#MIMTRNDATI", "XD":"G#MIRNDATI", "RE":"RNG#ML" } | 65536 | 1 |
The default list of PMS message subscriptions contains the complete list of PMS messages that can be processed by this adapter. Adding extra message subscriptions will not change anything in the adapter's capabilities.
The list of PMS subscription messages is a JSON formatted string.
Commands
Connect (connect)
Connects to a Micros/Fidelio PMS.
Disconnect (disconnect)
Disconnects from the Micros/Fidelio PMS.
Start Data Synchronization (startDataSynchronization)
Start data synchronization with the PMS. When this command is sent, the PMS starts sending events for all the entity types that were subscribed for during the handshake process.
Stop Data Synchronization (stopDataSynchronization)
Stops data synchronization with the PMS.
Add Text Message (addTextMessage)
Adds a new text message for an existing guest.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest's reservation number. | True | string |
| textMessage | Text Message | The text message to add for the guest | True | string |
| roomNumber | Room Number | The guest's room number | True | string |
| externalId | External ID | The unique Id of the text message in the external system sending it | True | string |
Delete Text Message (deleteTextMessage)
Deletes a specific message for a guest.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest's reservation number. | True | string |
| messageNumber | Message Number | The unique message number | True | string |
| roomNumber | Room Number | The guest's room number | True | string |
Download Text Messages (downloadTextMessages)
Downloads all the text messages for a guest.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest's reservation number. | True | string |
| roomNumber | Room Number | The guest's room number | True | string |
Events
PMS Connection Status Changed (pmsConnectionStatusChanged)
Raised whenever the PMS connection status has changed.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| status | PMS Connection Status Changed | New PMS connection status. | string |
Guest Check In (guestCheckInEvent)
Raised when a new guest has checked in.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| FirstName | Guest's First Name | The guest's first name. | string |
| LastName | Guest's Last Name | The guest's last name. | string |
| Room | Guest's Room Number | The guest's room number. | string |
| GroupName | Group Name | The guest's group name, if any. | string |
| IsShared | Guest's Share Flag | The guest's share flag | boolean |
| UDF1 | User Defined Field 1 | The first user defined field. | string |
| UDF2 | User Defined Field 2 | The second user defined field. | string |
| UDF3 | User Defined Field 3 | The third user defined field. | string |
| UDF4 | User Defined Field 4 | The fourth user defined field. | string |
| UDF5 | User Defined Field 5 | The fifth user defined field. | string |
| ArrivalDate | Arrival Date | The guest's arrival date in 'yyMMdd' format. | string |
| ArrivalTime | Arrival Time | The guest's arrival time in 'HHmmss' format. | string |
| DepartureDate | Departure Date | The guest's departure date in 'yyMMdd' format. | string |
| PreferredLanguage | Preferred Language | The guest's preferred language. | string |
| Title | Guest's Title | The guest's title. | string |
| IsVIP | VIP | The guest's VIP status flag. | string |
Guest Change (guestChangeEvent)
Raised when information has changed for an existing guest.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| FirstName | Guest's First Name | The guest's first name. | string |
| LastName | Guest's Last Name | The guest's last name. | string |
| Room | Guest's Room Number | The guest's room number. | string |
| GroupName | Group Name | The guest's group name, if any. | string |
| IsShared | Guest's Share Flag | The guest's share flag | boolean |
| UDF1 | User Defined Field 1 | The first user defined field. | string |
| UDF2 | User Defined Field 2 | The second user defined field. | string |
| UDF3 | User Defined Field 3 | The third user defined field. | string |
| UDF4 | User Defined Field 4 | The fourth user defined field. | string |
| UDF5 | User Defined Field 5 | The fifth user defined field. | string |
| ArrivalDate | Arrival Date | The guest's arrival date in 'yyMMdd' format. | string |
| ArrivalTime | Arrival Time | The guest's arrival time in 'HHmmss' format. | string |
| DepartureDate | Departure Date | The guest's departure date in 'yyMMdd' format. | string |
| PreferredLanguage | Preferred Language | The guest's preferred language. | string |
| Title | Guest's Title | The guest's title. | string |
| IsVIP | VIP | The guest's VIP status flag. | string |
| IsRoomChange | Is Room Change | Flag indicating if the guest's room has been changed or not | string |
Guest Checkout (guestCheckOutEvent)
Raised when a guest has checked out
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| Room | Room Number | The guest's room number. | string |
| IsShared | Guest's Share Flag | The guest's share flag | boolean |
| DepartureDate | Departure Date | The guest's departure date in 'yyMMdd' format. | string |
| DepartureTime | Departure Time | The guest's departure time in 'HHmmss' format. | string |
Text Message Added (textMessageAddedEvent)
Raised when a new text message has been added for a guest.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| MessageId | Message ID | The unique's message Id. | string |
| Room | Room Number | The guest's room number. | string |
| TakenDate | Taken Date | The message taken date in 'yyMMdd' format. | string |
| TakenTime | Taken Time | The message taken time in 'HHmmss' format. | string |
| MessageText | Message Text | The message's body. | string |
Text Message Deleted (textMessageDeletedEvent)
Raised when an existing text message has been deleted for a guest.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| MessageId | Message ID | The unique's message Id. | string |
| Room | Room Number | The guest's room number. | string |
| TakenDate | Message Taken Date | The message taken date in 'yyMMdd' format. | string |
| TakenTime | Message Taken Time | The message taken time in 'HHmmss' format. | string |
Text Message Availability (textMessageAvailabilityEvent)
Raised when the text message availability for a guest has changed.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| FolioNumber | Folio Number | The guest's unique reservation number. | string |
| Room | Room Number | The guest's room number. | string |
| HasTextMessages | Has Text Messages | The flag indicating if the guest has text messages or not. | boolean |
Room Info (roomInfoEvent)
Raised to inform about room existence.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| Room | Room Number | The room number. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-12-21 |