This guide is designed to help you get started with connecting your ResDiary to Simphony. Here, you’ll find details of the onboarding process, including the steps you'll need to take and guidance on key values required for mapping.
Pre-Requisites
Before beginning the integration, ensure the following:
- You have an active ResDiary account with admin access.
- You are using Oracle Simphony POS (version 19.2+).
- You have access to Oracle’s Transaction Services Gen2 (STSG2) API
Integration Steps
Step 1: Contact ResDiary Support
- Email support@resdiary.com to request activation of the Simphony POS integration.
Step 2: Configure Simphony API Access
- Ensure your Simphony POS is configured to allow external API access.
- Work with your Oracle representative to:
- Enable STSG2 API for front-of-house transactions.
- Confirm access to Reporting and Analytics.
- Obtain your API credentials (Client ID, Secret, Endpoint URL)
Step 3: Provide Simphony API credentials to ResDiary support.
- For us to connect, please provide the below details:
Field | Description |
| API Account - Username | Username for Simphony API access |
| API Account - Password | Password for Simphony API access |
| Enterprise Short Name | Identifier for your Simphony enterprise |
| ClientID | OAuth client ID for authentication |
| Authentication URL | URL used to authenticate API requests |
| STSGen2 API Base URL | Base URL for Simphony Transaction Services Gen2 |
| Location Reference | Simphony location identifier |
| Revenue Centre IDs | List of revenue centre's to map with ResDiary. |
| Employee ID | ID of the employee to associate actions with (can be a dedicated “ResDiary” user). Note the name of this user will appear on printed bills |
| Order Type | Name of the order type used to open checks |
| Check Tender | Name of the check tender used to open checks |
Step 4: Enable integration
- Once all required credentials and configuration details have been provided, the ResDiary team will activate the Simphony POS integration for your venue.
- Validate that the connection to Simphony is successful
Step 5: Test the integration
| Test | Result |
| Create a test booking in ResDiary for the current time. Update the booking to Fully Seated | A corresponding check opens on Simphony |
| Add items to the check | Spend is updated on corresponding booking in ResDiary |
| Close the check | Corresponding booking in ResDiary is closed |
| Open a new check on a table in Simphony that is available in ResDiary | A corresponding walk-in reservation opens on ResDiary |
Important Note on Mapping Table Numbers and Meal statuses
Tables
To ensure accurate syncing between ResDiary and Simphony POS, table numbers must match exactly between the two systems.
- Each Revenue Centre (RVC) in Simphony must use table numbers that correspond directly to the table numbers configured in the ResDiary account it is linked to.
- Table numbers must be unique across all Revenue Centres connected to one ResDiary account.
Example: If ResDiary Table 12 is mapped to Simphony RVC “Main Dining,” then Simphony must also have a Table 12 in that RVC. You cannot have another Table 12 in a different RVC connected to the same ResDiary account.
Meal Status
ResDiary updates the booking status as the meal progresses (e.g., Drinks, Starters, Mains). We can only update the meal status if the item tags match one of the expected status categories, as this is how we determine the diner’s current stage in the meal.
How We Determine Meal Status
Detecting Changes in Simphony
- When the polling process detects changes in a check, we retrieve item details from the check.
- We then call Simphony GetMenu to obtain menu details for those items.
Inferring the Course
- Simphony does not explicitly provide the course (e.g., Starter, Main), so we infer it by checking:
- Tag Group: Does the major category match “Starters”?
- Family Group: Does this field contain “Starters”?
- SLU (Sub-Level Unit): Does it match “Starters”?
- If any of these match, the item is classified as a Starter.
- We repeat this process for all items on the check.
- Simphony does not explicitly provide the course (e.g., Starter, Main), so we infer it by checking:
Determining the Latest Course
- We take the latest course present in the meal:
- If only drinks exist → Meal Status = Drinks
- If a starter is present → Meal Status = Starters
- If a main is present → Meal Status = Mains
- We take the latest course present in the meal:
Expected Tag Categories
To ensure accurate status updates, item tags should match one of the following categories:
- Drinks: “Drink”, “Drinks”, “Beverage”
- Starters: “Starter”, “Starters”, “Appetizer”, “Appetizers”
- Mains: “Main”, “Entrée”, “Entrees”
- Desserts: “Dessert”, “Desserts”