.. index:: ! Brink Brink POS ========= Contents: This guide will show you how to setup NovaDine and Brink to communicate for online ordering .. toctree:: :maxdepth: 2 Request NovaDine access to Locations ------------------------------------ Before starting the POS setup, you will need to request that Brink give NovaDine access to all POS Data and receive the API tokens for your locations (this allows us to pull in your menu and settings from Brink). The request needs to come directly from the customer to the support team. Please send an email to support.brinksoftware@partech.com and apisupport2full@partech.com using the following format: “I [Name of authorized user], authorize NovaDine to access all POS data and receive the API Tokens for [Concept] for the following locations:” *Then list all of your locations that NovaDine will need access to, including any labs.* Overview -------- Once you have requested the access from Brink, you will need to gather the required information and provide to NovaDine and configure settings in Brink, as outlined below, in order to allow NovaDine to communicate with your POS: * :ref:`Send Menu ID to NovaDine ` * :ref:`Send Tender IDs to NovaDine ` * :ref:`Send Destination IDs to NovaDine ` * :ref:`Send Comment Item ID to NovaDine ` * :ref:`Send Open Item ID to NovaDine ` * :ref:`Send Section ID to NovaDine ` * :ref:`Configure Brink for Online Orders ` * :ref:`Publish Changes in Brink ` * :ref:`Enable Tips (Optional) ` * :ref:`Delivery Configuration ` * :ref:`Coupon Setup ` Brink Setup ----------- .. _MenuID: Menu ID ``````` In order for NovaDine to pull the menu from Brink, we will need to know the appropriate Menu ID(s) to pull. If you have not previously setup a Menu in Brink, you will need to create one and add all of your items to this Menu for NovaDine to import. The Menu ID value is not exposed in the Brink Admin Portal, so the information must be found in the Changeset Log Details. This can be found in any Changeset Log in which Menu updates for the appropriate menu were made. To locate your Menu ID in Brink: 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Menus* in the lefthand menu 4. Click the pencil icon to the left of the Menu that you need to find the Menu ID for 5. Make any change under 'Edit Menu' (add a menu category or remove a menu category - you can revert your changes after you retrieve the Menu ID) 6. Since there is no ID field for the Menu ID, once the changeset is published, you will need to find the Menu ID in the logs. The ID will be listed under in the Changeset Details (see screenshot) .. image:: images/Brink/Menu_ID.jpg 7. Copy the Menu ID and send it to NovaDine .. note:: If you will utilize seperate menus in Brink, please create unique menu categories for each menu to avoid import issues. .. _BrinkTender: Tender IDs `````````` You can create a Tender Type in Brink for each Payment Type that you wish to differentiate for online ordering for reporting purposes. These could include Gift Cards, Grubhub, DoorDash, etc. To locate your Tender IDs in Brink: 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Tenders* in the lefthand menu 4. Click the pencil icon to the left of the first Tender that you will be using with NovaDine and copy the ID number listed 5. Select *External* in the 'Tender Type' dropdown 6. Repeat the above steps for each Tender Type that will need to be available for online ordering 7. Send the copied IDs to NovaDine labeled with the appropriate Tender Type .. image:: images/Brink/Tender_ID.jpg .. _BrinkDestination: Destination IDs ``````````````` You can create a Destination in Brink for each Service Type that you plan to offer online. These could include Online Ordering Pick-up, Online Ordering Catering Pick-up, Online Ordering Delivery, Online Ordering GrubHub, etc. You will need a Destination for Pickup and Delivery at a minimum, assuming you are using both 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Destinations* in the lefthand menu 4. Click the pencil icon to the left of the first Destination that you will be using with NovaDine and copy the ID number listed 5. Repeat the above steps for each Destination that will be available for online ordering 6. Send the copied IDs to NovaDine labeled with the appropriate Destination .. note:: If the Destination will be used for DaaS or self-delivery, you will need to check the 'Delivery' box under the Delivery Tab to allow the POS to receive the customer's delivery address. If this is not done, orders will be rejected with an error of 'Delivery details required' .. image:: images/Brink/Destination_ID.jpg .. _BrinkComment: Comment Item ID ``````````````` You will need an item called 'Comment' in order to receive order-level comments in the POS. If a comment item does not exist in the remote system, it must be created with *Ask Name* enabled. To locate the 'Comment' Item ID: 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Items* in the lefthand menu 4. Click the pencil icon to the left of the Comment Item, ensure that *Ask Name* is enabled, and copy the ID number listed 5. Send the copied ID to NovaDine labeled 'Comment Item ID' .. image:: images/Brink/Comment_ID.jpg .. note:: For Curbside Check-in, a notification of customer arrival will be sent to the POS as an order comment item and print in the kitchen. In order for the notification to print, print routing must be configured for the order comment item. .. _BrinkOpenItem: Open Item ID ```````````` An 'Open Item' with *Ask Name* and *Ask Price* must be created/enabled in Brink to allow orders to push to the POS, even when an item error occurs (Ex: item is marked as unavailable in the POS while customer is placing an order online. Open item allows order to send through to the POS successfully). To create an 'Open Item': To locate the 'Open Item' ID: 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Items* in the lefthand menu 4. Click the pencil icon to the left of the Open Item, ensure that *Ask Name* and *Ask Price* is enabled, and copy the ID number listed 5. Send the copied ID to NovaDine labeled 'Open Item ID' .. image:: images/Brink/Open_item_ID.jpg .. _BrinkSection: Section ID `````````` NovaDine will need a Section ID configured for us to send online orders to the Brink system. To locate the Section ID: 1. Log in to the Brink Admin Portal 2. Click on *Configuration* and then open the *Settings Editor* 3. Click on *Sections* in the lefthand menu 4. Click the pencil icon to the left of the appropriate Section and copy the ID number listed 5. Send the copied ID to NovaDine labeled *Section ID* .. image:: images/Brink/Sections_ID.jpg .. _Configure: Configure Brink to accept Online Orders from NovaDine ````````````````````````````````````````````````````` Associate the Online Ordering Menu: 1. In the Brink Admin Portal, click on *Configuration* and then open the *Settings Editor* 2. Click on *Options* in the lefthand menu 3. Select the *Online Ordering* Tab, then the *General* sub-tab 4. Select the menu that will be used for online ordering in the *Menu* drop-down .. image:: images/Brink/Associate_menu.jpg .. _PublishBrink: Publish Changes ``````````````` Before NovaDine can pull the changes, you will need to publish the updates that you just made in Brink: 1. After making any changes in the *Settings Editor*, select *Save* .. image:: images/Brink/Publish1.jpg 2. Select *Ok* on the *Save Changeset* pop-up window .. image:: images/Brink/Publish2.jpg 3. Select *Publish* from the top menu 4. Make any necessary notes and click *OK* .. image:: images/Brink/Publish3.jpg Optional Features ````````````````` .. _Tips: Enable Tips ........... If you will be allowing tips on online orders, they will need to be enabled in Brink. To enable, follow the below steps: 1. In the Brink Admin Portal, click on *Configuration* and then open the *Settings Editor* 2. Click on *Options* in the lefthand menu 3. Select the *Online Ordering* Tab, then the *General* sub-tab 4. Enable the checkbox next to *Allow Tips* 5. Enter suggested tips, if applicable .. image:: images/Brink/Tips.jpg 6. You will also need to enable tips under the appropriate Tender Type by selecting *Tenders* in the lefthand menu 7. Click the pencil to the right of the tender type that will be used for online ordering 8. Enable the checkbox next to *Allow Tips* and any other options that you need .. image:: images/Brink/Tips1.jpg .. .. _Delivery: Delivery Configuration (for Self-delivery or DaaS) .................................................. You will need to configure a few extra settings to allow Brink to accept Delivery orders from NovaDine, whether it be orders for the store to deliver or DaaS orders. Please complete the following steps: .. Enable Delivery in Destination ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In order for your Brink POS to accept a delivery address from NovaDine, Delivery has to be enabled in the Delivery Destination or the order will be rejected. 1. Create a destination for 'Delivery' or create a destination for each Delivery Service Type and/or DSP (ex: Online Delivery, Uber DaaS Delivery, Postmates DaaS Delivery, etc), as explained in :ref:`Destination IDs` 2. Ensure that 'Delivery' is enabled under the Delivery Tab of any Destination that will require a delivery address 3. Leave the Delivery Time field set at '0' 4. Provide the Delivery Destination ID to NovaDine .. image:: images/Brink/Del_Dest.jpg Setup Delivery Surcharge ~~~~~~~~~~~~~~~~~~~~~~~~ In order for NovaDine to pass down a Delivery Fee to your POS, you must create a Delivery Surcharge in Brink or the order will be returned to NovaDine with the delivery fee removed. 1. In the Brink Admin Portal, click on *Configuration* and then open the *Settings Editor* 2. Click on *Surcharges* in the lefthand menu 3. Click 'Add New Surcharge' 4. Setup a new Surcharge with the following, as shown in screenshot: * **Name:** Delivery Surcharge * **Automatically Apply:** leave unchecked * **Surcharge Style:** Service Charge * **Method:** Fixed Per Order * **Prompt:** checked .. image:: images/Brink/Delivery_surcharge.jpg 5. There is no ID field for the surcharge, so once the changeset is published, you will need to find the ID in the logs. The ID will be listed under in the logs (see screenshot) .. image:: images/Brink/Changeset_Surcharge.jpg 6. Copy the new Surcharge ID and send it to NovaDine .. _Brinkcoupons: Coupon Setup ............ In order for NovaDine to successfully send discounts/coupons to Brink, you will need to add a Discount in Brink for each discount type you plan to offer. To setup the Discount in Brink: 1. In the Brink Admin Portal, click on *Configuration* and then open the *Settings Editor* 2. Click on *Discounts* in the lefthand menu 3. Click *Add New Discount* 4. Enter the following information, specific to your discount: - Name - Enable the *Active* checkbox - Select *Comp* from the Type drop-down - Select *Order* from the Granularity drop-down - Enable the *Must Enter Name* checkbox - Enable the *Must Enter Amount* checkbox 5. Copy the ID number listed 6. Send the copied ID to NovaDine labeled *Coupon ID* 7. Click *OK* .. image:: images/Brink/Coupons.jpg .. _trouble-Brink: Troubleshooting --------------- Error Messages `````````````` * **POS Error:** This event is logged on the Event Logging Tab in management when NovaDine encounters an error communicating with the POS. These errors will begin with *Error sending order to POS:* followed by the specific error from Brink. Order Errors ............ - *Error sending order to POS: Error Code 1 - Unknown error* - This error could be one of many things. Below is a list of things to check: + Confirm that the :ref:`BrinkComment` is setup and configured properly - *Error sending order to POS: 'pickup_destination_id'* - Please confirm the following: + The correct Destination ID was provided to NovaDine + The destination is set as *Active* for the location in Brink - *Error sending order to POS: Error Code 103 - Ordering not allowed* - Please confirm the following: + :ref:`Brink is configured to accept Online Orders` from NovaDine - *Error sending order to POS: Error Code 104 - Invalid payment type* - Please confirm the following: + The Tender Type is set to *External* in the Brink Portal. Settings editor -> Tenders -> Edit Tender -> Change Tender Type to *External* - *Error sending order to POS: Error Code 104 - Invalid tip amount specified for payment* - Please confirm the following: + :ref:`Tips` have been enabled in Brink - *Error sending order to POS: Error Code 104 - Delivery details required* - Please confirm the following: *Delivery* is selected for the current destination in Brink and the cooresponding Service Type in NovaDine is not sending a delivery address. Please contact your NovaDine Rep to troubleshoot the issue further. - *Error Code 104 - Delivery details provided for non-delivery destination* - *Delivery* is not selected for the current destination in Brink and the cooresponding Service Type in NovaDine is sending a delivery address for the order. + Please enable delivery for the destination in Brink. - *Unable to check-in: Master terminal is offline (0)* - This means that NovaDine is unable to connect to the master terminal, typically due to Register 1 (or your Primary Register) losing power or connection to the network. + Please check connection Menu Issues ........... - *Error sending order to POS: Error Code 104 - ItemId 2xxxx5 is invalid* - An item on the order is being identified as invalid when being sent to the POS. + If the item should be active, confirm that it is configured correctly for the location's menu in Brink. + If the item is inactive, deploy the changes for this location from Brink. This will automatically trigger a menu import for the location. .. .. _Brinkerrors: .. __ Brinkerrors_ .. no Menus have been defined in Brink. .. The panels for in-store POS are defined, Menus, Menu Categories and Menu Items need to be created/defined in Brink. You can see this in the Settings Editor, if you click Menus, it's empty. Defining these should go quick hopefully, you can add items to Menu Items, and then you add those to Menu Categories, and the Menu Categories to the Menu. This is actually a very nice feature in Brink, because you can include only what you want to show online in this Menu, and once you do this, we can import it into NovaDine as is, and it'll be ready to go. You can even enter descriptions of items and we'll pick those up as well.