Difference between revisions of "Fias"

From HSYCO
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Oracle’s FIAS (Fidelio Interface Application Specification) is a protocol specification used by different Hospitality PMS systems to
+
Oracle's FIAS (Fidelio Interface Application Specification) is a protocol specification used by different hospitality PMS systems to
 
exchange data.
 
exchange data.
  
Line 99: Line 99:
 
|-
 
|-
  
|msg
+
|msg.<type>
|<message>
+
|<JSON object>
 +
|R
 +
|FIAS message of type &lt;type&gt; received from the system with reported parameters formatted as JSON object (requires "rawmessages" option set to "false")
 +
 
 +
|-
 +
 
 +
|rowspan="2"|msg
 +
|rowspan="2"|<message>
 
|R
 
|R
 
|Raw FIAS message received from the system (requires "rawmessages" option set to "true")
 
|Raw FIAS message received from the system (requires "rawmessages" option set to "true")
 +
|-
 +
|W
 +
|Send the specified raw FIAS message to the system
  
 
|}
 
|}
 +
 +
=== JSON objects format ===
 +
 +
The following sections show the format of the "guest.*" datapoints' JSON values. The textual and numeric values of the attributes are implementation-dependant and vary from system to system. The only required attributes are "reservationNumber", "room", and "share"; all other attributes are optional.
 +
 +
==== Guest check-in and booking change ====
 +
 +
<pre>
 +
{
 +
  "reservationNumber": <number>,
 +
  "room": <text>,
 +
  "name": <text>,
 +
  "firstName": <text>,
 +
  "date": <date - YYMMDD>,
 +
  "time": <time - HHMMSS>,
 +
  "share": <true|false>,
 +
  "arrivalDate": <date - YYMMDD>,
 +
  "departureDate": <date - YYMMDD>,
 +
  "classOfService": <0-3>,
 +
  "profileNumber": <text>,
 +
  "groupNumber": <text>,
 +
  "language": <text>,
 +
  "title": <text>,
 +
  "vip": <number>,
 +
  "minibarRights": <text>,
 +
  "tvRights": <text>,
 +
  "videoRights": <text>,
 +
  "workstationId": <text>
 +
}
 +
</pre>
 +
 +
==== Guest check-out ====
 +
 +
<pre>
 +
{
 +
  "reservationNumber": <number>,
 +
  "room": <text>,
 +
  "date": <date - YYMMDD>,
 +
  "time": <time - HHMMSS>,
 +
  "share": <true|false>,
 +
  "workstationId": <text>
 +
}
 +
</pre>
  
 
== Release Notes ==
 
== Release Notes ==

Latest revision as of 15:28, 15 March 2023

Oracle's FIAS (Fidelio Interface Application Specification) is a protocol specification used by different hospitality PMS systems to exchange data.

This driver interprets check-in and check-out events and optionally exposes all received raw FIAS messages to be used in custom logic.

HSYCO Configuration

Add a FIAS I/O Server in the I/O Servers section of the Settings and set its parameters:

Communication

  • IP Address: the IP address of the FIAS server instance;
  • Port: TCP port of the FIAS server instance;

High Availability

  • Shutdown when inactive: defaults to true.

Options

ID Default Values Description
rawmessages false true generate the "msg" datapoint
false do not generate the "msg" datapoint

Datapoints

ID Value R/W Description
connection online R connection established
offline R HSYCO can't connect to the system
guest.in <JSON object> R Guest check-in event with reported details (see below)
guest.in.dbswap <JSON object> R Past check-in event generated because of a database synchronisation request
guest.out <JSON object> R Guest check-out event with reported details (see below)
guest.out.dbswap <JSON object> R Past check-out event generated because of a database synchronisation request
guest.change <JSON object> R Guest booking change event with reported details (see below)
guest.change.dbswap <JSON object> R Past booking change event generated because of a database synchronisation request
msg.<type> <JSON object> R FIAS message of type <type> received from the system with reported parameters formatted as JSON object (requires "rawmessages" option set to "false")
msg <message> R Raw FIAS message received from the system (requires "rawmessages" option set to "true")
W Send the specified raw FIAS message to the system

JSON objects format

The following sections show the format of the "guest.*" datapoints' JSON values. The textual and numeric values of the attributes are implementation-dependant and vary from system to system. The only required attributes are "reservationNumber", "room", and "share"; all other attributes are optional.

Guest check-in and booking change

{
  "reservationNumber": <number>,
  "room": <text>,
  "name": <text>,
  "firstName": <text>,
  "date": <date - YYMMDD>,
  "time": <time - HHMMSS>,
  "share": <true|false>,
  "arrivalDate": <date - YYMMDD>,
  "departureDate": <date - YYMMDD>,
  "classOfService": <0-3>,
  "profileNumber": <text>,
  "groupNumber": <text>,
  "language": <text>,
  "title": <text>,
  "vip": <number>,
  "minibarRights": <text>,
  "tvRights": <text>,
  "videoRights": <text>,
  "workstationId": <text>
}

Guest check-out

{
  "reservationNumber": <number>,
  "room": <text>,
  "date": <date - YYMMDD>,
  "time": <time - HHMMSS>,
  "share": <true|false>,
  "workstationId": <text>
}

Release Notes

3.8.0

  • initial release


Oracle is a registered trademark of Oracle Corporation