Antylogic
DemoApp login

399 operational guides

Docs sections
DocsFloor plan setup
Device

Use the Floor Plan Setup Guide

Use the floor plan setup guide to create or complete Harbor Soho's physical room layout: create or open a plan, define table types, draw zones, place tables and add table combinations.

In this article

The setup guide is the guided route for turning a location into an operational room plan. It appears on the floor plans list and can open either an existing preferred plan or a new editable plan.

For Harbor Demo Group at Harbor Soho, use it to complete the same physical layout that later reservation planning and TPV service operations share.

Before you start

  • Harbor Demo Group and Harbor Soho are selected.
  • Open /:orgId/:locationId/location/layouts?setupGuide=layout, or start from the First steps side card task Floor plan.
  • The operator has layout:view to view floor plans and the guide. Creating, editing and saving require layout:manage.
  • For GB demo captures, maestro-env.json provides ORG_ID, LOCATION_ID, APP_DEEPLINK_BASE and SETUP_LAYOUT_SOURCE_LAYOUT_ID.

Instructions

  1. 1.

    Open the setup guide

    Open Harbor Soho's floor plans page with setupGuide=layout. The page shows a guide banner above the floor plan list with the recommended setup order: plan, table types, zones, tables and combinations.

  2. 2.

    Open or create a plan

    Use the guide's primary action. If a preferred floor plan already exists, Antylogic opens it. If not, the action opens a new floor plan editor; view-only users can inspect existing plans but cannot create or save one.

  3. 3.

    Follow the new-plan guide

    In a new editable plan, follow the interactive overlay as it moves focus through the plan name, table type form, zone tool, table tool and combination controls. The overlay only appears in creation mode, outside read-only routes, for users who can manage layouts.

  4. 4.

    Complete the plan elements

    Enter a clear plan name, add table types if useful, draw at least one zone and place at least one table inside a zone. Add combinations when tables can be joined for larger parties; combinations count towards the guide but are not required to save a valid plan.

  5. 5.

    Continue an existing plan

    When the guide opens an existing plan, the editor shows a setup banner rather than the new-plan overlay. Use the banner actions to jump to unfinished areas such as table types, zones, tables or combinations.

  6. 6.

    Save the plan

    Save only after the required structure is ready. Antylogic persists the layout through the layout create or update endpoint; after a successful new-plan save from the setup guide, setupGuide is removed and the operator returns to the floor plan list.

Validations and limits

  • setupGuide is normalised before use; unrecognised values behave like the normal floor plan list.
  • The organisation and location context must be present before the floor plan list can render.
  • Without layout:view or layout:manage, the screen does not render the guide and shows the no-permission state.
  • A saved floor plan needs a name, at least one zone and at least one table.
  • Table type names, zone names and table names must be present and unique where those entities are used.
  • Each zone must contain at least one table, table capacities must be valid and any selected table type must exist in the same layout.
  • Combinations must reference tables from one zone and use valid capacity settings.
  • The backend validates the submitted layout again and replaces the layout's table types, zones, tables and combinations with the submitted version.
  • The current analysis did not prove that the floor plan list response always includes enough nested layout data to mark every guide milestone complete from the list alone.

Expected result

Harbor Soho has a saved floor plan structure that can be reused by reservation planning and TPV service operations, and the setup guide is cleared after a successful new-plan save.