Antylogic
DemoApp login

399 operational guides

Docs sections
DocsFloor plans
Device

List floor plans

Review the active floor plans for Harbor Soho, search within the loaded list, move through local pages, and open management actions when the signed-in user has the right permissions.

In this article

Use the Floor plans page when you need to compare the active layouts for a selected location before service. The list stays scoped to the current organisation and location, so Harbor Soho only shows its own active layouts.

This guide covers the listing surface only. Creating, editing, copying and deleting plans are available from the same table when permitted, but those changes belong to separate floor-plan actions.

Before you start

  • Signed in to Antylogic with Harbor Demo Group and Harbor Soho selected.
  • Location permission `layout:view` to load the list from `GET /api/app/{orgId}/{locationId}/layouts`.
  • Location permission `layout:manage` to show `New floor plan` and the row actions `Edit`, `Copy` and `Delete`.
  • Operational roles should include `layout:view` even when they also have `layout:manage`, because the backend list endpoint enforces `layout:view`.

Instructions

  1. 1.

    Open Floor plans

    Open Harbor Soho's Floor plans page. Antylogic loads the active layouts for the selected location and does not call the layouts API when the organisation or location context is missing.

  2. 2.

    Check access

    A user with `layout:view` can consult the list. A user with `layout:manage` sees writing controls, but the list still depends on backend view access.

  3. 3.

    Read the table

    Compare plans by `Name`, `Default`, `Tables`, `Max. diners` and `Updated`. The default plan is marked with a badge; non-default rows show a dash.

  4. 4.

    Search locally

    Use `Search by name or version` to narrow the already-loaded list. The search term is stored in the route query, compared in lowercase against the plan name and version, and resets the page to `1`.

  5. 5.

    Use pages and refresh

    Move through local pages when there are more rows than fit in one view, or refresh the section to reload the active layouts from the API.

  6. 6.

    Open or manage a plan

    Select a row to open the layout editor. With view-only access the editor opens without management capability; with `layout:manage`, the list also shows `New floor plan`, `Edit`, `Copy` and `Delete`.

  7. 7.

    Use the setup guide entry

    When `setupGuide=layout` is present, the same listing surface can show the setup guide banner and open the preferred existing plan, or start a new plan when no suitable plan exists and the user can manage layouts.

Validations and limits

  • If the user has neither `layout:view` nor `layout:manage` in the frontend permission check, the page shows the no-access state.
  • Deleted layouts are excluded from the standard list, and the backend filters by the active location ID.
  • `page`, `page_size` and `pageSize` are parsed as positive integers; invalid values fall back and values below `1` are raised to `1`.
  • If a requested page is outside the available range, the page is adjusted and the route parameters are updated.
  • Search and pagination are local to the downloaded active layouts list; there is no separate server-side search, sort or status filter on this page.
  • The current inspected screen does not include a direct row action to mark a plan as default, even though older wiki text mentions one.
  • Search by version is present in the UI wording and frontend logic, but the inspected backend list model may not expose a version value in current data.

Expected result

The operator has a current, location-scoped view of Harbor Soho's active floor plans, can find the right plan quickly, and can open the appropriate management path without treating the list action itself as a mutation.

Related articles