2 Prerequisites
The following prerequisites are required to complete the steps in this guide.
The below software tools are required.
Table 2-1 Required Tools
| Tool | Description | Links |
| Github | A Github repository containing both Oracle Hospitality REST API specifications and accompanying Postman Collections. | |
| Postman Collections | In the postman-collections folder in Github, you can download and use the Postman Collections associated to the use cases explained in this guide. | |
| GraphiQL | To better visualize the streaming API, a playground application is available that uses a tool called GraphiQL. | |
| Node Reference Implementation | A reference implementation for the Streaming API in Node JS. | Tool |
Environment
The following environments and modules must be available to perform the Business Use Cases with the OPERA Cloud APIs.
| OPERA Cloud Platform Module | Description | Minimum Version |
| OPERA Cloud Services | The customer must have a subscription to OPERA Cloud Foundation. | 23.5.x.x |
| Oracle Hospitality Integration Platform (OHIP) |
For customers, OHIP is included in the subscription to OPERA Cloud Foundation. Partners need a subscription to Oracle Hospitality Integration Cloud Service. |
The latest released version. OHIP is a single version product. |
| OPERA Environment has Streaming API enabled | (Optional) This is needed when a partner or customer wants to retrieve Business Events through the Streaming BE option. | N/A |
Configurations
- The Function Guest Service Request must be enabled in OPERA Cloud under Administration / Enterprise / OPERA Controls / Room Management / Guest Service Status.
-
To retrieve the streaming Business Event, the partner system must subscribe to the GUEST SERVICE STATUS REQUEST Streaming Business Event.
More details on how to configure Streaming Business Events are available in the OHIP User Guide. See Streaming API in the OHIP User Guide to learn more.
The following are details about the OPERA Cloud behavior of the Housekeeping Service Status.
The OPERA Cloud user can manage the Housekeeping Service Status from the OPERA Cloud UI Housekeeping Board section under Inventory / Room Management / Housekeeping Board.
- The following Housekeeping Service Statuses are available: Make Up Room / Do Not Disturb / No status selected (no Service Status is set).
- OPERA Cloud users can also set the Do Not Disturb (DND) Guest Service Status from the Housekeeping Task Sheet Companion.
- The Housekeeping Service Status can only be set for rooms that are in "Occupied" status. For rooms in "Vacant" status (not checked-in), the Service Status cannot be set.
- For a reservation room move (meaning a guest moves from one room to another during the stay), the Do Not Disturb and/or MakeUpRoom service statuses are removed from the original room.
- A Make Up Room service status is removed during the End Of Day process. The Do Not Disturb service status is retained after the End Of Day process.
- For reservation check out, the Do Not Disturb and/or Make Up Room statuses are removed and the status is set to "No Status Selected."