Antylogic
DemoApp login

399 operational guides

Docs sections
DocsPOS settings
Device

Enable or Disable KDS

Allow or block the kitchen display system for Harbor Soho from POS settings. The checkbox only stages the change until Save changes writes the full POS settings snapshot.

In this article

Use this guide when a location manager needs to pause or restore KDS access for Harbor Soho without changing services, tickets or existing output jobs.

The saved setting controls whether the KDS board can load and whether KDS output devices participate in kitchen routing.

Before you start

  • You are signed in to Harbor Demo Group with Harbor Soho selected.
  • You can open POS settings at /:orgId/:locationId/location/tpv.
  • You have tpv:manage to change and save the setting. Users with tpv:view can see the screen, but the checkbox and save action stay disabled.
  • POS settings and POS output devices have loaded, so the current KDS value and kitchen output selection are accurate.
  • You have KDS access if you want to verify the result on the KDS page.

Instructions

  1. 1.

    Open POS settings

    Open Harbor Soho POS settings and stay on the General tab. Find the Enable KDS row in the behaviour settings.

  2. 2.

    Review the current state

    A selected Enable KDS checkbox means the KDS board is allowed for the location. A cleared checkbox means the KDS board will be blocked after saving. If the location has no saved POS settings yet, KDS starts enabled by default.

  3. 3.

    Change Enable KDS

    Select Enable KDS to allow the board, or clear it to disable KDS for Harbor Soho. The change is pending only. When disabling KDS, if the current kitchen output is a KDS device, the app clears that output selection and removes KDS devices from the kitchen output selector.

  4. 4.

    Save changes

    Press Save changes and wait for the Settings saved confirmation. The app saves the full POS settings snapshot, including the KDS value and any kitchen output change.

  5. 5.

    Verify the KDS result

    Open the KDS page for Harbor Soho. When KDS is disabled, the page shows that KDS is disabled in POS settings instead of loading the live board. When KDS is enabled and the user has KDS permissions, the board can load normally.

  6. 6.

    Re-enable KDS if needed

    Return to POS settings, select Enable KDS and save. If a KDS kitchen output device was cleared while disabling KDS, choose the required kitchen output again after re-enabling.

Validations and limits

  • If no organisation or location is selected, the app shows the select-location state instead of the settings form.
  • If the user has neither tpv:view nor tpv:manage, the app shows a no-permission state.
  • PUT /api/app/{orgId}/{locationId}/tpv-settings requires tpv:manage.
  • The save can fail if the payload is invalid, if a referenced output device or payment method belongs to another location, or if billing settings in the full snapshot are not valid for the location.
  • Disabling KDS blocks KDS production status changes and KDS routing, but it does not close services, alter open tickets or delete existing output jobs.
  • Re-enabling KDS does not automatically restore a previously cleared KDS kitchen output device.

Expected result

Harbor Soho stores the KDS state in tpv_settings.enable_kds. When it is false, KDS board access and KDS routing are blocked; when it is true, users with KDS permissions can load and operate the board.

Related articles