Difference between revisions of "Fias"

From HSYCO
Jump to navigation Jump to search
(Created page with "Oracle Hospitality FIAS Category:I/O Server == HSYCO Configuration == Add a FIAS I/O Server in the I/O Servers section of the Settings and set i...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Oracle Hospitality FIAS
+
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.
  
 
[[Category:I/O Server]]
 
[[Category:I/O Server]]
Line 7: Line 10:
  
 
=== Communication ===
 
=== Communication ===
−
*'''IP Address''': the IP address assigned to Iono Pi, leave blank for a local installation;
+
*'''IP Address''': the IP address of the FIAS server instance;
−
*'''Port''': TCP port configured on Iono Pi, leave blank for a local installation;
+
*'''Port''': TCP port of the FIAS server instance;
  
 
=== High Availability ===
 
=== High Availability ===
Line 50: Line 53:
 
|offline
 
|offline
 
|R
 
|R
−
|HSYCO can't connect to the device
+
|HSYCO can't connect to the system
  
 
|-
 
|-
  
−
|rowspan="3" |driverstate
+
|guest.in
−
|init
+
|<JSON object>
 
|R
 
|R
−
|Sfera driver is initializing
+
|Guest check-in event with reported details (see below)
 +
 
 
|-
 
|-
−
|quit
+
 
 +
|guest.in.dbswap
 +
|<JSON object>
 
|R
 
|R
−
|Sfera driver quit
+
|Past check-in event generated because of a database synchronisation request
 +
 
 
|-
 
|-
−
|running
+
 
 +
|guest.out
 +
|<JSON object>
 
|R
 
|R
−
|Sfera driver is running (normal state)
+
|Guest check-out event with reported details (see below)
  
 
|-
 
|-
  
−
|rowspan="4" |led
+
|guest.out.dbswap
−
|rowspan="2" |0
+
|<JSON object>
 
|R
 
|R
−
|LED L1 is off
+
|Past check-out event generated because of a database synchronisation request
 +
 
 
|-
 
|-
−
|W
+
 
−
|turn LED L1 off
+
|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.&lt;type&gt;
 +
|<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" |1
+
 
 +
|rowspan="2"|msg
 +
|rowspan="2"|<message>
 
|R
 
|R
−
|LED L1 is on
+
|Raw FIAS message received from the system (requires "rawmessages" option set to "true")
 
|-
 
|-
 
|W
 
|W
−
|turn LED L1 on
+
|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 16: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

Retrieved from "https://wiki.hsyco.com/3.8/index.php?title=Fias&oldid=10869"