PAR Ordering and Simphony Gen2 Configuration

Prerequisites

Create the Simphony Transaction Service (STS) API user in the Oracle Reporting and Analytics (R&A) site under Administration > System > API Accounts > Add API Account.

• Account name
• Email address
• Enterprise Short Name
• Authentication Server
• Client ID
• Account password
  
  The password must be set via email after the user has been created.

Once the password is set, note the values of these fields in the password dialog box as you will need them for the PAR Ordering Management Center configuration fields.

Payment Type Configuration in Simphony (Tender Information)

Custom Payment Types

Custom payment types can be configured in Simphony’s EMC (Enterprise Management Console) by navigating to the Tender/Media section.

Steps

1. Open the Simphony EMC and select the appropriate level (Enterprise, Property, or Revenue Center).

2. Navigate to Tender/Media, click the Configuration tab, and then select Tender/Media.

3. To insert new tender, click the Insert (plus) icon, enter a name for the new tender (e.g., “PAR Pay”), and then click OK.

4. Configure settings:

   • Double-click the new tender record.
   • General Tab
     • Key Type to 1 - Payment.
     • Report Group (e.g., 105 Other Payments)
     • Select the appropriate Print Class for receipts (e.g., Receipt/Guest Check)
   • Options Tab
     • 8 - Print Customer Receipt
     • 21 - Print Summary Totals
     • 22 - Print Check Trailer
     • 22 - Print Check on Demand
   • Ops Behavior
     • Amount Options
       • 3 - Assume Paid in Full
     • Security Options
       • 68 - Mask Account Number
       • 82 - Prompt for Reason
     • Tender Options
       • 85 - Not Allowed With Incomplete Meals (Meals with Placeholders)
     • General Options
       • 5 - Reference Entry Required
       • 48 - Item is Shareable
     • Tender Media Hold Types
       • Hold Type -/-0 - Fire Order
   • Charge Tip Options
     • 11 - Post Amount to Charged Receipts on Tip Reports
     • 36 - On = Charge Tip Must Be Less Than Payment; Off = Any Amount
   • Miscellaneous Options
     • 18 - Enable HALO

   This is used to enable tipping in the Tender with the tip assigned to the employee associated with the check.

   Simphony assigns tip amount as a service charge for reporting purposes.

   • Option 1 (ON = Open): Enable this so the API can send a variable dollar amount.
   • Options → Charge Tip Options Tab: Select the following options to allow tip processing:
     • 10 - Post Amount to Gross Receipts on Tip Reports. Adds the total sales amount of the check to the employee's taxable/tippable sales total on tip reports.
     • 11 - Post Amount to Charged Receipts on Tip Reports: Ensures the tip is properly tracked against the tender's gross receipts.

5. Save settings.

Service Charge Setup To Enable Tips in Custom Tenders

Configure Pay at Store Setup (Cash Payment)

1. Deselect Option 2 (Amount Required): Allows the system to accept a blank or $0.00 entry.
2. Deselect Option 3 (Assume Paid in Full): Prevents the system from automatically filling in the remaining balance and closing the check.
3. Result: When both are OFF, the system records a $0.00 entry, keeping the check open for further activity.

Required Fields

• Simphony integration requires a tenderIdfor this custom payment type.
• tenderId is mapped from the incoming payload's payments[].tender_idfield.

Tender List Endpoint →  
{{basePath}}/tenders/collection?OrgShortName={{orgShortName}}&LocRef={{locRef}}&RvcRef={{rvcRef}}

//Response Body  
{  
    "items": [  
        {  
            "tenderId": 101,
            "name": "Cash",
            "type": "payment"
        },
    ],
    "orgShortName": "opn",
    "locRef": "p400045",
    "rvcRef": 31
}

The tenderId is required in the submit check API.

Service Charges Configuration

1. Go to Enterprise > Configuration > Service Charges.

2. Insert a new record and give it a descriptive name.

3. Set the Consumer Display Name. This is the name exposed through the STS Gen2 API and visible in responses.

4. Choose whether the charge is Open or Preset (Option 1):

   • Open: The caller provides the amount or percentage at the time of the transaction.
   • Preset: The value is fixed in EMC and applied automatically.

5. Choose whether the charge is an Amount or Percentage (Option 2), and enter the corresponding value.

6. Set a Tax Class if the fee should be taxable, or leave at 0 for non-taxable.

7. Click Save.

8. Note the Object Number from the table view. This is required for integration.

Employee Configuration

Steps to find EmployeeCheckRef

Steps to configure an employee for online ordering:

1. Log in to the Oracle Reporting and Analytics portal for the enterprise.

2. Click the application navigation icon (hamburger menu in the top-left corner).

3. Select People from the side menu.

4. Click Add Person at the top-right corner.

5. Add Employee with System Administrator Enterprise Role and Corporate Enterprise Level.

6. POS Object Number = EmployeeCheckRef

Order Type Configuration

Finding orderTypeReference in EMC

The orderTypeReference value is the Object Number of an Order Type record in Simphony. To find it:

1. Go to Enterprise → Setup → Order Type Parameters
2. The table view will show all configured order types with their Object Numbers in the # column — that integer is your orderTypeReference

Out of the box, Simphony Essentials comes with two: Dine In and Take Out. Additional types like Drive Thru, Delivery, etc., get added by the Simphony admin.

Configuring a new Order Type (if one you need doesn't exist):

1. Go to Enterprise → Descriptors → Order Types and add the name (e.g., "Delivery")
2. Then go to Enterprise → Setup → Order Type Parameters to configure its behavior (tax mask, print options, routing, etc.) and mark it Active
3. Optionally set it as the default for a specific RVC via RVC → Setup → RVC Parameters → Default Order Type

Discounts Configuration

Creating Open $ Discount in EMC

1. Define the Discount Record.

   1. Navigate to Configuration > Sales > Discounts.

   2. Click the Insert (+) icon to create a new record.

   3. On the General tab, set the following:

      • Name: Enter a name (e.g., Open $ Disc).
      • Activation Type: Select 0 - Manual.
      • Condiment Discountability: Select 0 - Use MI Class Options.
      • Max Amount: 0.00
      • Enabled: Ensure this box is checked.

2. Configure "Open" and "Dollar" Settings.

   1. In the Options section (still on the General tab), toggle these specific flags:
   2. Option 1 (Open): Set to ON. (This triggers the POS to ask for a dollar amount).
   3. Option 2 (Amount): Set to ON. (This defines the input as a Dollar ($) value instead of a percentage).
   4. Click Save to commit these settings.

Notes:

• Number 501 is the discount Id in this case.
• Our current integration supports Open $ discounts.

Configuring PAR Ordering Management Center

Navigate to MC > All Stores > Configurations > Store Groups > Store group with integration purpose > Integration > Integration Type

Integration Type

Make sure that POS NEXT is selected in the Integration Type drop-down list.

Clear POS Sync Cache

Click to clear stored POS menu data in Ordering for all locations in this store group. The next sync, whenever it runs, pulls fresh data from the POS. See more Sync Settings below.

POS NEXT Settings

SIMPHONY-GEN2 Settings

Field Name	Description	Where To Find Value
POS Location ID	Simphony Location Reference (LocRef) Example value: LocRef	EMC > Setup > Enterprise Configuration > Properties Then Choose location config details General > Oracle MICROS Reporting and Analytics > Edit Value: Location Reference
POS Base URL	Base URL for the Simphony STS G2 API endpoint Example value: https://xyz-sts.oraclecloud.com	EMC > Setup > Enterprise Parameters >Applications Tab> Transaction Services Generation 2 Services
POS Auth URL	Endpoint to generate Auth Token using OAuth Flow Example value: https://your-base-url	After STS API User is created R&A Portal > Hamburger Menu Administration > System > API Accounts Select Type: Simphony Transaction Services > Search Select Assigned API User Value: Authentication Server
POS Unit ID	Client ID for Simphony OAuth Endpoint Example value: clientId	After STS API User is created R&A Portal > Hamburger Menu > Administration > System > API Accounts Select Type: Simphony Transaction Services > Search Select Assigned API User Value: Client ID
POS Meta ID	Simphony Revenue Center Reference (RvcRef) Example value: revenue-center-id	EMC > Setup > Property Configuration > RVC Configuration Value: # (Do not use Revenue Center ID value)
POS Org ID	Simphony Organization Reference (OrgShortName) Example value: OrgShortName	Short value ID used in all Simphony logins
POS Employee ID	EmployeeCheckRef See: Employee Configuration	R&A Portal > Hamburger Menu > People Select Type: Online Ordering Employee previously set up Point of Sale Tab Value: POS Object Number
POS Key ID	Username for Simphony OAuth Endpoint Example value: username	After STS API User is created R&A Portal > Hamburger Menu > Administration > System > API Accounts Select Type: Simphony Transaction Services > Search Select Assigned API User Value: Account Name
POS Secret	Password for Simphony OAuth Endpoint Example value: password	Password set for user above

Order Type Settings

Surcharge Settings

Aggregator Settings

Sync Settings

Common Integration Settings

Setup to Enable Future Orders

Future Orders are enabled at Revenue Center level → Configuration Guide

To enable Begin Future Order:

1. Select the revenue center, click Setup, and then click RVC Parameters.

2. Click the Autofire tab, and then configure the fields as described in the following:

   
   1. Autofire Employee → Employee Used for Online Ordering
   2. Autofire Workstation → Workstation to Fire Order
   3. Default Autofire Tender/Media → Tender Information
   4. Backup Autofire Delay (Mins) → Enter the amount of time (in minutes) that the Future Orders workstation must try to fire the orders.
   5. Maximum Days → Enter the maximum number of days for which workstation operators can schedule orders to fire automatically.
   6. Print Guest Check at Time of Autofire → Select this option if you want a guest check to print when an order automatically fires to order devices.
   7. Enable Autofire in this Revenue Center → Select this option to allow the revenue center to create orders that fire automatically.

3. Save Settings.

4. Navigate to Order Type Parameters.

   1. Select the Order Type we want to set up Future Order

   2. Add the Service Level Time for the Order Type

      

   3. Service level time [Required] → Minimum time required to prepare the order. Value = 1.

Troubleshooting and Maintenance

STS API User Password Maintenance in Oracle R&A Portal

The API user password needs to be updated regularly before it expires. Otherwise, you risk system-wide order failures.

Update Password

Please pay special attention to the password reset instructions regarding forced API user password expiration every 45 days.

Reset Expired Password

Reset the API user password.

Oracle forces all STS user passwords to expire after 45 days. At this time, this cannot be changed. An integration can exceed the need to change the password every 45 days by regularly obtaining new tokens under the original authorization session, but when the session terminates for whatever reason, a new API user password will need to be set and the integration configuration will need to be updated with the new password.
When this situation occurs, ALL STS transactions will fail until a new password is reset and the integration uses the new password to obtain a fresh the API token.

To reset an existing API user password:

1. Log out of the Oracle Reporting and Analytics (R&A) portal for the brand.

2. From the R&A login screen, click Can't sign in?

   

3. Enter the API username and enterprise name

   

4. From the assigned email address, complete the password reset.

   

The API User account cannot log into R&A or EMC, so there is no way to confirm the correct password for the account except via STS API calls.