Integration Settings Portal User Guide

Navigation & Using the Portal

Access to the portal can be found by navigating the following path:

Admin Portal > Groups > Groups dropdown > Integrations Portal
Groups dropdown menu in Admin Portal with the Integrations Portal option highlighted in a red box

Home Page

Integrations Portal ALL tab showing register dropdown, Home icon, Help icon, ACTIVE/ALL tabs, and a Solutions section listing External Kitchen Systems and SMS

  • Home icon: Takes the user back to the portal landing page.

  • Dropdown: List of all locations available based on your group configuration.

  • Help Icon (question mark): Links to help/documentation.

  • ACTIVE tab: All active integrations for a selected location.

  • ALL tab: All integrations available on POS for configuration - checkmark next to list item if the integration is active for your location.
    Close-up of the ALL tab Solutions list showing checkmarks next to External Kitchen Systems and SMS, indicating those integrations are active for the location

  • AUDITS tab: Displays an audit trail of changes made to integrations (additions, deletions, and edits to existing integrations). When an "Event" is selected, the portal displays the integration's previous values beside the new, updated values.
    AUDITS tab showing an audit trail table with Entity Collection, Entity Name, Event, User Id, and Timestamp columns for PaymentDevice and ContactlessPayment entries Audit event detail view showing Entity Collection, User Id, Event, and Sent fields above a Property/Old Value/New Value table for a ContactlessPayment Added event

  • Contents: provides a quick link to access active integrations
    Integrations Portal ACTIVE tab showing the External Kitchen Systems section with QSR Automations listed, and a Contents panel on the right

Using the Portal

Adding New Integrations

  1. Select the ALL tab on the portal home page
  2. Select the integration to add from the Hardware & Devices or Solutions section
  3. Click the plus sign icon to add an integration to an active list of integrations
  4. Populate required/desired fields - see Configuration sections for optional/required values:
    1. External Kitchen Configuration
    2. Third-Party SMS Provider Configuration
    3. Loyalty Configuration
    4. Payment Device Configuration
    5. External Payment Processor Configuration
    6. Comp Cards
  5. Click SAVE to save changes and publish to the register, or CANCEL to return to the home page
  6. If errors are encountered, changes may be republished by selecting the Upload icon
ACTIVE tab showing a green

IMPORTANT: Payment Devices must be linked to registers through the following steps:

  1. Navigate to the ACTIVE tab on the portal Home Page
  2. Select Peripherals in the Registers section
  3. Choose a device from the Payment Device dropdown to link it to a register
    Peripherals section showing Register Name, Number, and Payment Device fields for three registers, with Payment Device dropdowns set to Test, None, and Test

Editing Active Integrations

  1. Navigate to the ACTIVE tab on the portal home page
  2. Select the integration to be edited
  3. Make the necessary changes to the integration and click SAVE

Deleting Integrations

  1. Navigate to the ACTIVE tab on the portal home page
  2. Select the integration to be deleted
  3. Click the REMOVE button on the top right-hand corner of the screen
  4. Select CONTINUE when prompted to remove the integration
Confirmation dialog reading
Previous
5.16 Features Quick Reference Guide
Next
External Kitchen Configuration