RTN’s SpecificationSynchronization
| 1 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION
Restaurant Menu
Industry standard for delivering multiple, complex menu systems for smooth third-party consumption.
RESTAURANT TECHNOLOGY NETWORK | 2 | Introduction This Restaurant Menu Synchronization Software Specification and related technical materials were created by RTN’s ThirdParty Delivery Workgroup. The workgroup included restaurant operators and technology solution providers who defined the need for a single, comprehensive solution to deliver multiple, complex menu systems to various systems, partners, and distributors that consume this information. www.restauranttechnologynetwork.com Copyright 2020 Restaurant Technology Network (RTN). All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopy, recording or information storage and retrieval systems, without express written permission from the publisher. RTN is a wholly owned subsidiary of EnsembleIQ, with principal headquarters at 8550 W. Bryn Mawr Ave., Suite 200, Chicago, IL 60631. Staff ABBY LORDEN VP and Brand Director, HT Co-Founder, alorden@ensembleiq.com973.607.1358RTN ANGELA DIFFLY Co-Founder, angela@restauranttechnologynetwork.com404.550.7789RTN ROBERT FIRPO-CAPPIELLO Editor in Chief, HT rfirpo-cappiello@ensembleiq.com917.208.7393 ANNA WOLFE Senior Editor, HT awolfe@ensembleiq.com207.773.1154 KATHERINE WARE Senior Account Executive, HT & RTN kware@ensembleiq.com785.424.7392 NOELL DIMMIG Account Executive, HT & RTN ndimmig@ensembleiq.com973.607.1370 PATRICK DUNPHY CIO, HTNG & RTN patrick@restauranttechnologynetwork.com312.690.5039 MOLLY MCLOONE Brand Marketing Manager, HT & RTN mmcloone@ensembleiq.com908.433.2796 TAMMY HANSON Membership Manager, RTN tammy@restauranttechnologynetwork.com314.570.4798 CODY CZMYR Director of Marketing, Communications and Membership, cczmyr@ensembleiq.comRTN
| 3 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Table of Contents Introduction 2 Menu Synchronization Software Specification at a Glance 4 System Roles 5 Verification/Audit Between Menu Publisherand Menu Subscribers ...........................................................................................6 Menu Setup .................................................................................................................................. 8 Location Setup ......................................................................................................................... 10 New Menu Item 11 86 Items (Removing Items) 12 Limited Time Offer 14 Full Menu Synchronization ................................................................................................... 16 Key Contributors...................................................................................................................... 18 RTN Mission The Restaurant Technology Network (RTN) is a membership community solely dedicated to the restaurant technology industry. Through access to valuable benefits and powerful connections, our members shape industry standards and share technical guidance to help restaurateurs run successful businesses and better serve their customers.
TECHNICALRESTAURANTFILESSPECIFICATIONINCLUDE:DETAILSORDERRESOURCESMENURESOURCESRESOURCES(all)
RESTAURANT TECHNOLOGY NETWORK | 4 | Menu AtSoftwareSynchronizationSpecificationAGlance
Used together, RTN’s Menu Synchronization Software Specification and companion documents enable restaurant operators and solutions providers to integrate systems vital to any restaurant menu technology ecosystem. The use cases contained here are not exhaustive, but are meant to provide implementing companies and additional guidance.
The use cases and system roles described in this document are companion documentation to the following materials.
developers
Provides product formulation, nutrition analysis, recipe analysis, virtual government-compliantexperimentation,labeling
Food & Nutrition Analysis software (ESHA)
MENU SYSTEMMAPPING
NA
Maps product IDs from disparate systems to one another, for example: matching an item ID in a POS to an Item ID in a third party system
Provides additional detail, photo, video around an individual menu item.
A software system that contains a product catalog, including a name, pricing, description, nutrition, options, availability, tax, images, location, meal periods, order channels.
Food cost, vendor management, inventory availability NA
MENU PUBLISHER
ONLINE SYSTEMSORDERING
NA
A software system that subscribes to the menu system and is notified of any change.
Digital ordering and delivery enablement
The following system roles are used throughout this specification.
POS, Menu Management System, Online Ordering Providers, Content Manager
Third-Party Delivery Providers, Kiosks, Online ordering systems
MANAGEMENTRECIPE
MANAGEMENTINVENTORY
System Roles
EXAMPLE
Pushes out changes from a centralized location to all thirdparty delivery companies as well as additional restaurant infrastructure that can accept these changes (i.e. menu boards)
MENU SUBSCRIBER
MENU PUBLISHERCONTENT
| 5 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION
ROLE NAME DEFINITION
• The updated customer-facing menu is available on ordering platforms for restaurant consumers.
• Menu publishing system is online.
• Restaurant addresses the issue on the location’s POS (This is sometimes handled manually, and across multiple endpoints).
• Menu publisher has the ability to connect with a location’s POS to retrieve menu data.
ALTERNATIVE PATHS
• Menu health check
• Menu subscribers are integrated with the menu publishing system.
• Menu publisher notifies the restaurant if any items or modifiers have been 86’d during the menu health check.
BASIC COURSE OF EVENTS
PRE-CONDITIONS
• Customer-facing menu is ready for retrieval by menu subscribers or scheduled pushes to ordering platforms.
EXCEPTION PATH
• Menu publisher checks the health of a menu again 30 minutes prior to a location opening to pick up any POS changes made by the restaurant as a result of the first menu health check.
POST-CONDITIONS
• A restaurant’s customer facing menu has been curated in the menu publishing system and is active.
• If an item or modifier is not found on the POS or multiple versions exist, menu publisher automatically 86’s the entity on the menu.
• Menu subscribers can communicate with the menu publishing system.
• Retrieve menus once all systems are online.
• Menu publisher checks the health of a menu 2 hours prior to a location opening.
• Validates that all items & modifiers on the customer facing menu can be found on a location’s POS.
• Retrieves updated pricing for items & modifiers.
RESTAURANT TECHNOLOGY NETWORK | 6 |
UseandBetweenVerification/AuditMenuPublisherMenuSubscribersCase
• The menu publisher is not able to connect to a location’s POS.
• A restaurant’s POS is online.
TRIGGER
ASSUMPTIONS
• The menu subscriber is not able to connect to the menu publisher.
| 7 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Message Flows The following is an example message flow with methods that demonstrate operations against each system. VERIFICATION/AUDIT 3: publishItemUpdates()2: getMenuItemsAndPrices() 5: correctMenu() User (Restaurant) 4: notifyMenuDiscrepency() : menuSubscriber : POS 1: menuHealthCheck() : menuPublisher
• The user adds the item to a menu.
• The menu publisher is not able to connect to subscribers or subscribers are not able to reach the publisher because they are offline.
ASSUMPTIONS
TRIGGER
• The user sets price for the item (multiple prices may be set based on need).
• The menu publisher makes the menu available to all subscribers.
BASIC COURSE OF EVENTS
• The updated customer-facing menu is available on ordering platforms for restaurant consumers.
EXCEPTION PATH
ALTERNATIVE PATHS
• The user adds other information such as description, display titles, images, nutritional information, etc. to the item.
• The user adds additional modification options to the item.
The following use cases describe an example process for initial menu setup and synchronization between two systems.
PRE-CONDITIONS
RESTAURANT TECHNOLOGY NETWORK | 8 |
• The menu publisher has the ability to connect to all subscribers through an API or menu subscribers are able to listen for updates.
• The menu publishing system must be online and connected to the subscribers to share menu updates, or the menu subscribers are able to reach out earlier and download the changes to local cache.
• The user selects meal period where this menu will apply.
• The user selects brand/locations /store where this menu will apply.
Menu Setup
Use Case
• The user can also go directly to each subscriber and manually create a menu.
POST-CONDITIONS
• The user creates a new item.
• The restaurant is onboarding for the first time, or the restaurant is republishing an existing menu.
• The users selects date and time restrictions for LTO if applicable.
| 9 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Message Flows MENU SETUP UserUser : menuPublisher:menuPublisher : menuSubscriber : menuSubscriber 8: newItem() 1: 3:2.createItem()setPrices()addDetails() 4: mapItemToMenu() 5: 5:6:mapItemToBrandsAndSites()mapItemToCalendarClock()7:publishItem()1:createItem()2.setPrices()3:addDetails()4:mapItemToMenu()mapItemToBrandsAndSites()6:mapItemToCalendarClock()7:publishItem() User : menuPublisher : +++++++menuItemidpricesdescriptiondisplayTitlesimagesnutrtionalinformationmodificationoptions:menuSubscriberpublishItem() : menu id + id + items + brands + locations + mealPeriods + ItoDetails : +:+:+locationidmealPeriodid:LTO+id+startDateTime+endDateTimebrandidcreateItem()
BASIC COURSE OF EVENTS
Message Flows UserUser : menuPublisher:menuPublisher : menuSubscriber : menuSubscriber 8: newLocation() 1: createLocation() 2. setWorkingHours() 3:5:4:setOrderChannels()setGPSLocation()setDeliveryZone() 6: mapSubscriberLocation()7:publishLocation()1:createLocation()2.setWorkingHours()3:setOrderChannels()4:setGPSLocation()5:setDeliveryZone() 6: mapSubscriberLocation()7:publishLocation() LOCATION SETUP
• The user adds GPS coordinates for the location.
• The location is available on the subscriber for ordering.
ALTERNATIVE PATHS
POST-CONDITIONS
• The user can also go directly to each subscriber and manually add locations.
The following use case describes how to set up a location to consume menu data. Typical scenarios may include a new unit added to a chain, virtual stores, or ghost kitchens.
• The publisher has the ability to connect to all subscribers through an API or subscribers are able to listen for updates.
• The publisher is not able to connect to subscribers or subscribers are not able to reach the publisher because they are offline.
• The use maps the internal location id to subscriber location ID.
TRIGGER
ASSUMPTIONS
Use
RESTAURANT TECHNOLOGY NETWORK | 10 |
• The publishing system must be online and connected to the subscribers to share updates, or the subscribers are able to reach out earlier and download the changes to local cache.
• The restaurant is onboarding for the first time or a new location is added to an existing chain restaurant.
• The user creates a new location.
Location Setup
PRE-CONDITIONS
• The user adds address, working hours, order channels to the location.
• The user adds KML file for delivery zone (optional).
• The user publishes the location to the subscribers.
EXCEPTION PATH
Case
• The new product is created in the system of record. The product is named, attributes are added (such recipe items in the example of Boss Burger, One White Bun, Chicken Patty, Tomato, Mayo, etc.).
• The precondition is not met of connection at the event time. A pull request generated from the edge to receive all updates or full menu for that date and time.
ALTERNATIVE PATHS
• The updates to the edge are received, the application level adds, edits and publishes on the edge. This step may include manual intervention.
Use MessageCaseFlows UserUser : menuPublisher:menuPublisher : menuSubscriber : menuSubscriber 8: newItem() 1: 3:2.createItem()setPrices()addDetails() 4: mapItemToMenu() 5:5:6:mapItemToBrandsAndSites()mapItemToCalendarClock()7:publishItem()1:createItem()2.setPrices()3:addDetails()4:mapItemToMenu()mapItemToBrandsAndSites()6:mapItemToCalendarClock()7:publishItem() MENU SETUP
| 11 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION
BASIC COURSE OF EVENTS
• The item creation and associated actions such as time and date.
ASSUMPTIONS
• Complete menu pull request from the edge to the system of record.
• The system must be live and connected to the edge points to share menu updates. The system must be able to connect to the edge at any point of time to trigger the change in the menu.
EXCEPTION PATH
New Menu Item
• The menu publisher will add a new item to the system, tag a date and time for when it’s live, add any attributes; the restaurant(s), channel(s), images. Based on the criteria, the system will push the changes.
TRIGGER
PRE-CONDITIONS
POST-CONDITIONS
• The restaurant is out of stock of a particular item, or temporarily removing an item from sale, or any arbitrary reason to remove an item from a menu from any menu subscriber.
86 Items (Removing Items)
• The items can no longer be ordered at selected subscribers. The items are either disabled or hidden from the ordering menu.
• The menu publisher is able to replace the menu completely at all subscribers if it is not able to update individual items on the menu. The user can also go directly to each subscriber menu and manually remove the items from the menu.
• As the inventory system is updated with additional order the menu publisher resets the selected item back to available.
The following use case describes an example process that removes an item for an arbitrary reason and/or timeframe. This process can be used in situations such as, but not limited to: lack of inventory, recalls, availability by a particular order channel (in-store, online, third-party, etc.).
RESTAURANT TECHNOLOGY NETWORK | 12 |
• The menu publishing system must be online and connected to the subscribers to share menu updates, or the menu subscribers are able to reach out earlier and download the changes to local cache.
BASIC COURSE OF EVENTS
PRE-CONDITIONS
• The menu publisher updates the item availability to all subscribers.
POST-CONDITIONS
ALTERNATIVE PATHS
ASSUMPTIONS
• The user identifies an item that is out of stock or low in inventory.
EXCEPTION PATH
Use Case
• The user uses the menu publisher to set the selected item(s) to zero for one or all menu subscribers.
TRIGGER
• The user selects brand/location/store where this change will apply.
• The menu publisher is not able to connect to subscribers or subscribers are not able to reach the publisher because they are offline.
• The menu publisher has the ability to connect to all subscribers through an API or menu subscribers are able to listen for updates.
| 13 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Message Flows 86 ITEMS UserUser : menuPublisher:menuPublisher : menuSubscriber : menuSubscriber 2: updateItem()1: adjustAvailability() 1: adjustAvailability() User : menuPublisher : menuSubscriber1: adjustAvailability() 2: publishFullMenu()
BASIC COURSE OF EVENTS
• The item(s) become visible at the designated start date and time, and is hidden at the designated end date and time.
RESTAURANT TECHNOLOGY NETWORK | 14 |
Limited Time Offer
TRIGGER
• The menu publishing system must be online and connected to the subscribers to share menu updates, or the menu subscribers are able to reach out earlier and download the changes to local cache.
EXCEPTION PATH
The following use case describes a potential implementation of a limited time offer (LTO), which is essentially a temporary menu item, temporary price, or other aspect of a saleable item.
• The user identifies an item for a LTO.
• If the offer is recurring by day of week or time day, the user adds those conditions.
ASSUMPTIONS
• The menu publisher can replace the full menu at all subscribers if it is not able to update individual items on the menu. The user can also go directly to each subscriber menu and manually add and remove the items from the menu.
• The user selects brand/location/store where this change will apply.
POST-CONDITIONS
• The restaurant is running a temporary promotion like LTO or happy hour.
• The menu publisher is not able to connect to subscribers or subscribers are not able to reach the publisher because they are offline.
• The menu publisher has the ability to connect to all subscribers through an API or menu subscribers are able to listen for updates.
• The menu publisher updates the item availability to all subscribers.
Use Case
PRE-CONDITIONS
• The user uses the menu publisher to set the start date, time and end date and time.
• If the LTO is recurring, the item automatically becomes visible or hidden based on date and time range.
ALTERNATIVE PATHS
| 15 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Message Flows LIMITED TIME OFFER UserUser : menuPublisher:menuPublisher : menuSubscriber : menuSubscriber 4: updateItem() 1: createLTO() 2: addTimeDetails() 3: mapLTOToBrandsAndSites()1:createLTO()2:addTimeDetails() 3: mapLTOToBrandsAndSites()
• The menu publishing system must be online and connected to the subscribers to share menu updates.
PRE-CONDITIONS
• Once updates are published, the data can be manipulated in each subscriber system by using the application admin. For this reason, it’s advisable to implement an audit between systems, checked against the master (menu publisher) at regular intervals and an admin notified of any anomalies.
• Should support real-time menu changes, rather than just scheduled changes.
Full Menu Synchronization
• The menu publisher system(s) are assumed to have full API publishing capabilities of the known data points of a menu update as well as enterprise level management for different company configurations. The menu subscriber(s) are assumed to have full API ingestion capabilities of the known data points of a menu update.
BASIC COURSE OF EVENTS
POST-CONDITIONS
RESTAURANT TECHNOLOGY NETWORK | 16 |
TRIGGER
Use Case
• Menu publisher initiates a publishing event to the menu subscriber(s) at a scheduled day/time to push a change set of data for updating ordering channels.
EXCEPTION PATH
This business scenario describes a full menu update that could occur on a campaign/ rollout schedule, or on a more frequent basis. Menu publishers often include either a third-party platform for menu management or direct from the brand’s own data source. Various brand departments are involved in a menu update that often include culinary, finance, operations, marketing and IT. The goal is to coordinate with all stakeholders what needs to be updated on the various menus and then apply those changes to the menu publisher system of record to publish changes to the menu subscribers.
ASSUMPTIONS
• A receipt is obtained from the systems signaling a successful transaction of data or exceptions that must be remedied.
• The precondition is not met at the time of the update. The user then goes into each subscriber application and makes the updates within the application admin. This is the non-preferred method, and may include manual intervention.
• Changes are configured in the menu publisher system(s) of record.
• The use case starts when menu decisions are finalized by marketing, culinary, operations, finance and franchisees regarding what changes to initiate.
ALTERNATIVE PATHS
OVERVIEW
Teams work together to update the system of record where the menu publisher at a given time/day will publish the changes by menu subscriber channel.
• A restaurant company has a menu update on a scheduled basis, often referred to as a campaign or rollout. Updates often include new items, deleting items, modifications to existing items, item modifiers for menu item names, descriptions, prices, photos, nutrition and allergen content, availability, tax, channel management and meal periods.
• Bidirectional link allowing the subscriber to pull a complete menu and a delta report, created by the menu publisher to note the differences for updating the endpoint.
| 17 | RTN’S RESTAURANT MENU SYNCHRONIZATION SPECIFICATION Message Flows FULL MENU SYNCHRONIZATION UserUser : menuPublisher : menuPublisher : menuSubscriber : menuSubscriber 1: defineMenuUpdates() 2:2:scheduleMenuUpdates()3:initiatePublish()1:defineMenuUpdates()scheduleMenuUpdates()3:initiatePublish() 4: publishMenus() 5: sendReceiptAndExceptions()
CHRISTY TRINKLER Sr. Dir., Product Marketing & Strategic Partnerships Trabon
Principal
STUART PRILLAMAN Architect
GEORGE HUTTO Sr. BI Developer MOD Super Fast Pizza
ROBERT PETERSON VP of Sales Qu
DevelopmentSoftware QSR Automations
BRIAN WHITNEY VP of Sales
SUSAN LUCAS Sr. VP of Technology Cooper’s Hawk
RESTAURANT TECHNOLOGY NETWORK | 18 | www.restauranttechnologynetwork.com RTN Vision In an industry built on service and entrepreneurial spirit, purpose-built technology fuels success. The Restaurant Technology Network aspires to help restaurant professionals and solution providers work together to solve problems large and small and inspire bold ideas for the future. Join Us If you have a vested interest in the restaurant technology industry, join us. Collectively, our members shape the industry by creating and disseminating technology standards and technical guidance to benefit members. Through our cornerstone virtual think-tank workgroup meetings, our members solve industry challenges and prosper inside a unique, collaborative environment. + VIEW OUR MEMBERS Key Contributors
MOHINDROOROHINEE Founder Dyjit
JOSHUA NORD VP,
DAVID JONES VP, Major Accounts & Channels HungerRush
PARIJAT JAUHARI VP, Product Management
SHAUN SHANKEL CEO Fresh(ToGoTechnologyTech)
TOM FOX Chief Business Officer Omnivore
SKIP KIMPEL CIO 4 Rivers Restaurant Group
CHRISTOPHER SEBES Partner RTS
Additional Contributions
LUCY LOGAN CEO FoodCalc
Appetize
Appetize
Qu
