Configuring Opera PMS and Adapter
Some of the Kiosk features need certain configuration in Opera PMS. If the necessary PMS side configuration is missing or it is done incorrectly, then the Kiosk features will not work as designed.
There are also some Opera PMS Adapter properties that need to be configured according to the PMS configuration.
The following provides:
- a check list for verifying whether the PMS is well configured for the Kiosk features
- a guideline on how to properly set up the PMS to work with Kiosk
Opera PMS Configuration
Creating the KIOSK Channel
Warning
This configuration is necessary for all Kiosk features. The application may still work, partially, even when the KIOSK channel is not created, but with unpredictable results.
You need to explicitly create the KIOSK channel in the PMS if not already created. This channel is used by the Opera PMS Adapter to make requests to the Opera WS API.
To see the channels list, open the Opera Configuration app, then use the Channels > Channel Setup menu. The dialog below is shown:
- If the KIOSK channel already appears in the upper list, then you only need to verify its settings.
- Click the upper Edit button to open up the dialog below (data may vary):
- In this dialog, make sure that Override Y/N is checked, and Session Control is not checked
- Any other settings can remain the same
- Click OK, then Close to save the changes
- Click the upper Edit button to open up the dialog below (data may vary):
- Otherwise, you need to create it.
- Click the upper New button to open up a dialog looking exactly like the one above but w/o any data populated
- Set both the Channel and the Name fields to KIOSK
- Make sure that that Override Y/N is checked, and Session Control is not checked
- Anything else can be entered like in the above example or as advised by Opera system administrator
- Click OK, then Close to save the changes
Mask Credit Card for Opera WS API Responses
The Kiosk needs to know if a credit card is on the reservation in the result returned from the find reservation command.
For this purpose, a parameter named MASK CC FOR WSRESPONSE needs to be configured at channel level. When this is set to Y, then credit card numbers are returned, masked, in the WS API call results.
To access this parameter, open the Opera Configuration app, then use the Channels > Channel Property Parameters menu. The dialog below is shown:
In this dialog, do the following:
- Uncheck the "Property" check box
- Select Channel = KIOSK
- Make sure that "Parameters" is checked and not "Settings"
- Identify the list item named MASK CC FOR WSRESPONSE. Select it then press Edit, or double click it
- Set the value to Y in the new "Edit" dialog that opens up
- Click Close twice to save the changes
- Close the Configuration app
Unmask ID Document Numbers for Opera WS API Responses
Info
This configuration is necessary for Kiosk to be able to look up reservations by document numbers, or to prevent same guest to have multiple reservations checked in at the same time.
By default, the passport numbers are masked when returned by the Opera WS API calls. For example, if the original document number was DL776534, then the API returns XXXXXX34 (same length as the original number, with all characters but the last 2 converted to X). The odds of encountering such a situation in real life is very high so we cannot conclude that a reservation using a masked document number XXXXXX34 was made using one or the other document.
The Opera WS API calls are able to return the "unmasked" document numbers, so that we can compare the scanned document number with the document numbers already associated with the reservations.
For this purpose, a parameter named MASK PII FOR WSRESPONSE needs to be configured at channel level. When this is set to N, then all document numbers are returned in their original form in the WS API call results.
To access this parameter, open the Opera Configuration app, then use the Channels > Channel Property Parameters menu. The dialog below is shown:
In this dialog, do the following:
- Uncheck the "Property" check box
- Select Channel = KIOSK
- Make sure that "Parameters" is checked and not "Settings"
- Identify the list item named MASK PII FOR WSRESPONSE. Select it then press Edit, or double click it
- Set the value to N in the new "Edit" dialog that opens up
- Click Close twice to save the changes
- Close the Configuration app
Allow Modifying Reservations That Already Have a Room Number
Info
This configuration is necessary if this hotel wants the Kiosk to be configured to have the Kiosk create accompanying guests as Sharer guest type instead of Additional guest type.
If the hotel does not plan to have the Kiosk create all accompanying guests as Sharer guests, then this parameter does not need to be set.
Setting this parameter to Y is necessary in order to allow modifying an existing reservation via Opera WS API. When the sharer guests' option is used, typically we need to update an existing reservation with the correct number of guests (adults/children) if the main guest chose to add additional sharers to the guests which are already part of the reservation. If the reservation already has a room assigned, having this option not set to Y will result in being unable to modify the reservation.
Getting an Opera PMS ready for Invoice PDF generation via Opera WS API
Info
This configuration is necessary if your particular KIosk installation needs to be able to generate invoices in PDF format.
Report Templates
The templates that are used by Opera PMS are typically stored in the customizable_reports folder which is typically located atD:\MICROS\OPERA\production\customizable_reports
Warning
Opera system admins may relocate this folder to be in line with the particular site security demands etc. Consult with an Opera system admin to learn the actual path to the customizable_reports folder.
For generating invoices in PDF format, the following files must exist in the customizable_reports folder:
Consult your Opera system admins if they are not present in the folder.
Warning
It is important to have them set up like this otherwise you will not be able to configure the reports setup for Invoices.
Report Setup
All reports can be set up via Opera Configuration app menu Setup > Report Setup > Reports. Using this menu will result in opening the following window:
Enter %folio% in the Name input field then press Search. Identify the entry named sample folio and select Edit.
Make sure that all data is configured as below:
Click on the Data button. Make sure that Data Source Type = Data Template and Data Source = sample_folio like below.
Press OK multiple times until you are again on the Reports Configuration window.
Report Server Paths in web.config
You also need to tweak the Opera WS API config file which is typically located at C:\Program Files (x86)\Micros Systems\OEDS\OWS_WS\5.1\Web.config
Warning
Opera system admins may relocate Opera installation to be in line with the particular site security demands etc. Consult with an Opera system admin to learn the actual path to the Web.config file.
- Open the Web.config file in a text editor such as Notepad or Notepad++.
- Mind that you have to run the text editor app as an Administrator otherwise you will not be allowed to save the file.
- Look for the reportFormat key
- Make sure that reportFormat and the following 5 settings are set up like below:
Warning
Opera system admins may relocate the reports output folder to be in line with the particular site security demands etc. Consult with an Opera system admin to learn the actual path to the reports output folder and set the value for reportLocalPath accordingly.
- When done, save the web.config file.
- Then from a command prompt, in Administrator mode, issue an iisreset command.
Creating / Configuring a Loyalty Rewards Membership
If you intend to have guests automatically enrolled in hotel's loyalty rewards membership program, it is required to configure the PMS to generate a Guest Membership Card on request, for each enrolled guest.
To generate such a card, some information is required to be provided to the PMS:
- the membership type, which in this case would be the hotel loyalty membership type.
- the member's name as it will appear on the card.
- the card (membership) number.
- membership level (in this case will be the entry level for the loyalty membership type; etc.
The membership type, member name and membership level are all known in the moment the card is generated but the system will also need a card (membership) number, which should follow some rules defined in the PMS.
The best method to be sure the card number is respecting the PMS' rules is to make the PMS auto-generate the card number for each guest enrollment.
Enable the PMS to auto generate the membership number
To be able to autogenerate the membership numbers, the PMS should have enabled:
- the ENROLLMENT function.
- the AUTO GENERATE MEMBERSHIP NO parameter.
This function & parameter may be found accessing the PMS Configuration / Setup / Application Settings menu as presented below:
The next step required is the setup of the Hotel Loyalty membership in the hotel PMS.
Setup the hotel loyalty membership in PMS
The Hotel Loyalty membership is defined in the Configuration / Profile / Membership menu of the PMS.
If the hotel does not have the Loyalty Membership already defined, the steps to configure it are presented below.
Check the Loyalty membership class existence
Access the Configuration / Profile / Memberships / Classes menu and create a Loyalty class, checking the Loyalty Program checkbox.
Select or create the loyalty membership type
Accessing the Configuration / Profile / Memberships / Types menu, select the Edit button on the Loyalty Type if it exists or create it by clicking on the New button.
An edit type dialog is opened. By default, in the Points Managed options (from the upper right area of the dialog, see below), the Local option is selected.
To allow the Loyalty membership setup,the Central option should be selected and, by doing this, the dialog layout will change (see below):
- In the newly opened dialog, select the correct loyalty class (defined in the previous step) in the Membership Class dropdown box, in the upper left area of the dialog.
- Fill in the type Description (upper middle area of the dialog).
- Select the Main tab and check the Primary Y/N checkbox.
Warning
There may only be one primary membership type!
If another membership is already defined as primary, an error message will pop up when trying to check the Primary Y/N checkbox (see below).
In the picture below, the BA type is set as primary and when trying to set another type (AS) as primary the following error is received:
-
in the right menu click on the Sequence button; Select the Sequence Type, check the Random Generation checkbox and in the Format text box, type in the chosen format for the membership number (see below); click Ok.
-
Setup the Rules, Reference and Levels information to implement the hotel's requirements.
-
in the middle lower area of the dialog set the From/To Range for the card number generation.
-
in the lower left area of the dialog select/set the validation rule
The Validation Rule from the lower left area of the dialog (see below)
should be valid (the Formula button, in the right menu, should be enabled, if any validation method is selected, except No Validation).
Warning
If there is no valid formula validation rule (see below image), the auto generation of the membership numbers will fail.
-
After finishing all the above setup click on Save and on Ok.
If all these steps were followed the membership (card) number auto-generation should work and any call to the FetchNextCardNumberAsync API method should return an auto-generated membership (card) number.
Opera PMS Adapter set up
The adapter parameters are described in several places in the KIOSK and UIP documentation, but none of these places are actually linking them to the related Opera settings and where you can find these settings.
| Property name | Explanation | How to determine the setting value | Visual hint |
|---|---|---|---|
| URL parameters | One URL to connect to Opera WS API | By default, the URL to enter is like this:
|
n/a |
| User name Password |
Credentials to connect to Opera WS API. Typically used:
|
Ask Opera system administrator | n/a |
| Domain | Domain name to login to Opera WS API |
|
n/a |
| Secure Mode | Check if Opera runs in Secure Mode | Do not confuse Secure Mode with HTTPS, they are different things:
|
 |
| Cloud Authentication | Check this box when connecting to Opera Cloud Services | (In general, you know whether this is the case or not). If you are connecting to a cloud system, then the Secure Mode setting is overruled, a cloud system always runs in Secure Mode. | |
| Resort Code | Usually equal to the Property Name from Opera | Open Opera Configuration app, menu Property > Property Details; If there are multiple properties in the list, make sure you select the correct one. Use the value under the Property column as Resort Code |  |
| Host Code | Usually equal to the Hotel Code from Opera | Open Configuration app, menu Property > Property Details; If there are multiple properties in the list, make sure you select the correct one. Click Edit, then General tab, use the value in the Hotel Code field |  |
| Chain Code | Usually equal to the Chain Code from Opera | Open Configuration app, menu Property > Property Details; If there are multiple properties in the list, make sure you select the correct one. Click Edit, then Channel tab, identify the KIOSK channel in the list, use the value in the Chain Code column |  |
| Default Guarantee Type for New Reservations | Open Configuration app, menu Reservation > Codes > Reservation Types. Make sure you check Property, not Template. You can use any of the address types appearing in the list, which does not require specifying anything on creation time (Arrival time, CC, Phone, Deposit, Address) and it's not marked inactive. Ask the Opera system administrator which of the codes that matches the criteria should be used. The codes are usually hotel specific, and they are different from one system to another. If you are leaving the setting empty, the system assumes "COMPANY". This may not be applicable for all systems. The codes are usually hotel specific, and they are different from one system to another. |  |
|
| Default Rate Plan Code for New Reservations | Open Configuration app, menu Rate Management > Rate Classifications > Rate Codes. Ask the Opera system administrator which of these codes to use. The codes are usually hotel specific, and they are different from one system to another. |  |
|
| Default Address Type | The address type to use when adding addresses to existing profiles. Since in most cases Kiosk uses the address on the ID document, this would be the home address. | Open Configuration app, menu Profile > Address Types. You can use any of the address types appearing in the list. Ask the Opera system administrator which address type should be used. If you are leaving the setting empty, the system assumes "HOME" (Home Address). This may not be applicable for all systems; some hotels may use another code for home address. |  |
| Use Country and Nationality 3 Letters Codes | Opera can use country codes and nationality codes either as defined in standard ISO3166, with 2 or 3 letter length | Open Configuration app, menu Profile > Geographical Data > Nationalities. If the codes in that list are 3-letters long, then you need to check the box in the Opera PMS adapter configuration. |  |
| Default Language Code | Language code to set for the new created profiles | Open Configuration app, menu Profile > Geographical Data > Languages. You can use any of the codes appearing in the list - but confirm which one is matching the hotel business case. If you are leaving the setting empty, the system assumes "E" (English). This may not be applicable for all systems; some hotels may need a different default language. |  |
| TimeZone | Property time zone | Open Configuration app, menu Property > Property Details; If there are multiple properties in the list, make sure you select the correct one. Click Edit, then General tab, use the value in the Time Zone Region field |  |