Message catalogue - how to use it
On this page
This catalogue lists the messages SunPMS shows to users: pop-up message boxes, the small notices at the bottom right (snackbars), Yes/No confirmation boxes, inline notices on the guest portal and the sign-in pages, and the text the server sends back when it refuses a request. For each one it gives the exact text, the screen, the condition that triggers it and what to do.
How to look up a message
- Copy a few distinctive words from the message (leave out names, room numbers, dates and amounts, because those are filled in by the program).
- Find the module file for the screen where it appeared (list below). If you do not know it, search all files in this folder.
- Read the row: Screen tells you where it was raised, When it appears gives the rule in plain words plus the condition in the code, and What to do gives the fix.
- If the message is not found, it is probably a server-side message. Search the Server-side messages table of the module, then
99-general.md.
Reading the tables
- Text in angle brackets, for example
<room no>, is replaced at run time. - A row with (text returned by the server) means the screen shows whatever text the server returned. The wording depends on the rule that failed; look it up in the Server-side messages tables.
- "Condition in code" is written for support staff. Names such as
setting IS_...are property settings (Settings > Feature, Folio, Night Audit and so on);privilege Xis a role privilege. - Several places raising the same message on the same screen are merged into one row.
- ID scanners, signature pads and door locks are no longer set up in SunPMS screens (they are set up in SunHardware), so the messages of the former Scanner Integration, Signature Pad Integration and Door Lock Integration screens are not listed any more.
- The "Condition in code" texts and line numbers were generated from the program text and stay approximate for screens that were rebuilt; the message text, the screen and the advice are what matter.
Message types
| Kind | How it looks |
|---|---|
| Message box | Centred box with an OK button; you must close it. Used for errors and warnings. |
| Snackbar | Small bar at the bottom right that disappears after a few seconds (a green, orange or red edge shows success, warning or error). |
| Confirmation | Box with Yes and No (sometimes Cancel). Nothing happens until you answer. |
| Inline notice | Red or green text on the guest portal page. |
| Server-side message | Text created by the server or the database function and shown by the screen as it is. |
Module files
| File | Covers |
|---|---|
| 01-login-and-signup.md | SunAuth sign-up, sign-in, MFA, landing, sign-out, property creation |
| 02-property-configuration.md | Property detail, building, floor, room type, room, room status, amenities, tax |
| 03-configuration-masters.md | Rate type, document type, other charges, payment type, exchange rate, users, roles, privileges, policies, e-mail templates, IP white list |
| 04-settings.md | All Settings pages and integrations set-up pages |
| 05-extra-masters.md | Extra income and expense categories, non-rental rooms, room owners, DNR, deposit, notice, housekeeping tasks and groups |
| 06-views.md | Dashboard, register, calendar, quick search, header |
| 07a-group-checkin.md | Group Check-In screen |
| 07b-check-in.md | Check In screen |
| 07c-check-in-stay-details.md | Check-in: Stay Details tab |
| 07d-check-in-payment.md | Check-in: Payment tab |
| 07e-check-in-guest-details.md | Check-in: Guest Details tab |
| 07f-check-in-guest-documents.md | Check-in: Guest Documents tab |
| 07g-check-in-other-charges-and-misc-info.md | Check-in: Other Charge and Misc Info tabs |
| 07h-checkout-split-folio-late-checkout.md | Checkout, split folio and late checkout |
| 07i-edit-group-and-group-members.md | Edit Group and group member reservations |
| 07j-blocks-booking-and-room-change.md | Group blocks, booking transactions and change room |
| 07k-server-side-messages.md | Server-side messages for reservations and check-in |
| 08-reception-and-guest-ledger.md | Search reservation, guest ledger lists, guest search |
| 09-guest-services.md | Guest hub, online check-in, approvals, guest requests, guest portal |
| 10-housekeeping.md | Room status changes, assignment, block / unblock |
| 11-billing-and-night-audit.md | Batch folio, credit card authorisation, night audit, extra income / expense, shifts, FAS |
| 12-pricing-and-availability.md | Rate, flash, forecasting and restriction views |
| 13-guests.md | Lost and found, contacts, import guest |
| 14-sales-and-channels.md | Business sources, commissionable and creditable sales and channels, invoices |
| 15-utility.md | Undo / redo, import and unposted reservations, room owner payment |
| 16-sync-and-channel-manager.md | Sync reservation, statistics, inventory, bulk sync, OTA reconciliation |
| 17-reports.md | Reports, ledgers, charts |
| 18-integrations.md | SunHardware (ID scan, signature, key cards), SunParking, SunSpa, SunPOS room charge, payment gateway, document storage |
| 19-licences.md | Licence screens |
| 20-communication.md | Notification bell, team chat, groups, channels, attachments, cross-app (linked apps) chat and its delivery queue |
| 21-housekeeping-mobile.md | Housekeeping Mobile (phone module for housekeepers) |
| 99-general.md | Shared dialogs, services and server messages that do not belong to one module |
Messages that need special care
- "Something went wrong!. Please contact support team with Error ID:..." is the server's catch-all for an unexpected failure. The Error ID is the key to the server exception log; always ask the user for it.
- "Unauthorized: Your IP is not allowed to access this property" means the IP White List is on and the user's address is not listed.
- "Procedure failed." and "Something wrong, Please try again." mean a database call returned a failure code; the cause is only in the server log.