PAR POS Order Ready Board Configuration Guide

Version 01

What is the PAR POS Order Ready Board

A new customer-facing display, the Order Ready Board, has been introduced for installation inside the store, near the front counter. This screen provides real-time order status updates to guests, eliminating the need for staff to manually communicate order progress.

Each order displayed on the board includes the order number, guest name, and order destination.

Order Status

• In Progress -- The order has been received and is currently being prepared by the kitchen.
• Now Serving -- The order has been completed, bagged, and is ready for guest pickup.

Connection Status

Shown in the bottom left corner of the screen, indicating connectivity to the Primary Register.

• Green = ORB is online and communicating with the Primary Register
• Red = ORB is offline and is not communicating with the Primary Register
• Yellow = Limited connectivity, meaning the MQTT server is online, but unable to communicate with register 1

Current Version

The current version of the ORB is displayed in the bottom left corner of the ORB screen.

Current Time

The system time is displayed in the bottom right corner of the ORB screen.

Supported Order Types (Destinations)

The Order Ready Board supports orders placed through the following channels:

• In-store register
• Self-service kiosk
• Digital ordering platforms
• Third-party delivery applications (e.g., DoorDash, Uber Eats)

Communication

The Order Ready Board (ORB) listens to events being broadcast from the Primary register using the In-store API MQTT service.

Order Ready Board (ORB) Requirements

Hardware Requirements

Software Requirements

Network / Whitelisting Requirements

Refer to the PAR POS Network Connectivity guide for the full list of required URLs and ports.

Configuration

There are two configuration files to consider when setting up the ORB:

• C:\Brink\ORB\appsettings.json -- This application configuration file (how the ORB runs)
• c:\Brink\ORB\ORBUIConfigurations.json -- The User Interface setup (how the ORB looks)

Setting up the appsettings.json File

Logging -- This section is automatically configured and requires no changes.

App Config -- Core settings

MQTT settings

Connection settings for the Message Queue Telemetry Transport protocol used to receive live order events.

IncludedEvents

This setting controls which events the ORB listens to. Add or remove events based on your setup:

ExcludedDestinations

By default, the ORB displays orders from all destinations. Add destination IDs here for any destinations you want to hide from the ORB.

• Example: Adding your Drive Thru destination ID will prevent drive-thru orders from appearing, since most customers only want to display orders for guests entering the store.

How to find a Destination ID:

1. Log in to the Admin Portal.
2. Click Configuration > Settings Editor > Destinations.
3. Click the desired destination.
4. The ID is listed in the ID field on the Details tab.

App Config -- IncludedKitchenQueueIds

The kitchen queue ID(s) that the ORB monitors to determine when an order is complete. When the specified queue is bumped, the order automatically moves from In Progress to Now Serving.

• Example: The Front Counter Expo is typically the last screen to be bumped, signaling that the order is bagged and ready for the customer.

How to find Kitchen Queue IDs:

If you do not have Admin Portal access, contact Support or reach out to the person who manages your menu updates -- they typically have Admin access.

If you have Admin access:

1. Log in to the Admin Portal.
2. Access your Lab location.
3. Click the dropdown on the location > Tools > Download Settings > Download.
4. Open the downloaded Settings.zip file (format: Settings - Location Name.zip).
5. Open Settings.xml using Notepad (format: Settings - Location Name.xml).
6. Press Ctrl+F and search for KitchenQueues.
7. Locate the ID in the result -- for example: <KitchenQueue Id="4004617" Name="Expo" ...>
   • The number in the Id field is what you'll enter here.
   • Name="Expo" -- This is the name of the Kitchen Queue that is set up in Settings Editor.

App Config -- BlacklistedCharacters

Characters entered here will be automatically stripped from customer order names.

• Example: Entering 0123456789- will convert John-123 to John.

Application -- Order Removal Settings

This section controls when orders are automatically removed from the ORB:

The Mock sections and the BMS Upgrade Patch Configuration sections should be left at default settings.

Localization Configuration

This area of the file controls the display language for the ORB screen. The following languages are currently supported:

Setting up the ORBUIConfiguration.json File

This section lists all keys in the ORBUIConfiguration.json file, their possible values, and their purposes. If any field is removed, misspelled, or incorrectly set, the default value will apply automatically.

ViewTemplate

This setting controls the overall layout mode of the ORB screen. All other display settings are driven by the value set here.

ShowHeader

Controls whether the header is displayed on the ORB screen. This setting works independently of the ViewTemplate -- header visibility remains consistent in both column and grid view.

ShowFooter

Controls whether the footer is displayed on the ORB screen. This setting works independently of the ViewTemplate -- footer visibility remains consistent in both column and grid view.

Header

Defines the appearance and the content of the ORB header. All fields below can be overridden.

Footer

Defines the appearance of the ORB footer. All fields below can be overridden.

GridViewSettings

Defines the appearance of the ORB when ViewTemplate is set to "grid". All fields below can be overridden.

GridViewSettings -- Status Badges

Status badges are used in grid view to visually indicate the state of an order. Each badge maps one or more system order statuses to a single visual badge displayed on the order card.

The ORB includes two default status badges:

"StatusBadges": {
  "InProgress": {
    "Id": "In-Progress",
    "BadgeColor": "#2F3452",
    "BadgeText": "In Progress",
    "OrderStatuses": [ "InProgress", "OrderSent" ]
  },
  "OrderReady": {
    "Id": "Ready",
    "BadgeColor": "#257469",
    "BadgeText": "Ready",
    "OrderStatuses": [ "OrderReady", "Ready" ]
  }
}

Columns

Defines the column layout when ViewTemplate is set to "column". Each entry in the array represents one column rendered on the ORB screen. A maximum of 3 columns is supported.

The ORB includes two default column configurations:

"Columns": [
  {
    "Id": "in-progress",
    "Title": "In Progress",
    "OrderStatuses": [ "InProgress", "OrderSent" ],
    "BackgroundColor": "#f5f5ff",
    "HeaderTextColor": "#2F3452",
    "CardBackgroundColor": "#FFFFFF",
    "CardTextColor": "#2F3452",
    "CardSubTextColor": "#2F3452",
    "CardBorderColor": "#E0E0E0",
    "AccentColor": "#2F3452",
    "HeaderFontFamily": "Manrope-Regular.ttf",
    "OrderNumberFontFamily": "Manrope-Regular.ttf",
    "CardTextFontFamily": "Manrope-Regular.ttf",
    "CardSubTextFontFamily": "FlameSans-Regular.ttf"
  },
  {
    "Id": "ready",
    "Title": "Now Serving",
    "OrderStatuses": [ "OrderReady", "Ready" ],
    "BackgroundColor": "#2F3452",
    "HeaderTextColor": "#FFFFFF",
    "CardBackgroundColor": "#FFFFFF",
    "CardTextColor": "#2F3452",
    "CardSubTextColor": "#2F3452",
    "CardBorderColor": "#E0E0E0",
    "AccentColor": "#257469",
    "HeaderFontFamily": "Manrope-Regular.ttf",
    "OrderNumberFontFamily": "Manrope-Regular.ttf",
    "CardTextFontFamily": "Manrope-Regular.ttf",
    "CardSubTextFontFamily": "FlameSans-Regular.ttf"
  }
]

Available Fonts

When overriding any FontFamily field, you must use one of the following supported fonts:

• All color values must be provided as a 6-character hexadecimal color code (e.g., "#FFFFFF"). If any field is omitted, misspelled, or set to an invalid value, the default will apply automatically.

Name of ORB Sections

Version History