[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)[Frappe](/kb/frappe/)Portal Views

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

FrappePortal Views

Use list-mode web forms with sidebar navigation to show logged-in users their own records in a portal.

UpdatedMar 13, 2026

Tagsfrappeweb-formsportalwebsite

Reading time4 min

On this page[Purpose](#purpose)[File Structure](#file-structure)[JSON Configuration](#json-configuration)[Server-Side Context (get_context)](#server-side-context-get_context)[How List Filtering Works](#how-list-filtering-works)[Website Sidebar](#website-sidebar)[List Columns](#list-columns)[Client-Side Enhancements](#client-side-enhancements)[Nested Portal Routes](#nested-portal-routes)[Integration with Web Forms](#integration-with-web-forms)[Checklist](#checklist)

Authenticated list-mode web forms that present a filtered table of records to logged-in users, combined with sidebar navigation for a portal experience.

## Purpose

Portal Views expose a "my documents" list to logged-in users (e.g., guardians viewing their players' applications). They use the same Web Form infrastructure but in list mode, applying per-user document permissions so each user sees only their own records.

## File Structure

```text
mymodule/web_form/my_portal_view/
├── my_portal_view.json    # Web form definition (show_list: 1, login_required: 1)
├── my_portal_view.py      # Server-side get_context() for list filtering, sidebar
└── my_portal_view.js      # Client-side enhancements (optional)
```

## JSON Configuration

Key settings that distinguish a portal view from a normal web form:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"doctype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Web Form"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-portal-view"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"doc_type"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Player Application"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"route"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"portal/applications"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"module"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Module"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"is_standard"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"published"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"login_required"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"show_list"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_edit"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"allow_multiple"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"apply_document_permissions"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">1</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"list_columns"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"player_full"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"paid"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Check"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Paid"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ],</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"breadcrumbs"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"[{</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">label</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Home</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">,</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">route</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">},{</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">label</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Portal</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">,</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">route</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">portal</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">}]"</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

| Property                        | Purpose                                            |
| ------------------------------- | -------------------------------------------------- |
| `login_required: 1`             | Redirect unauthenticated users to login            |
| `show_list: 1`                  | Display records as a list instead of a single form |
| `apply_document_permissions: 1` | Respect doctype-level `has_permission`             |
| `list_columns`                  | Columns to show in the list table                  |

## Server-Side Context (get_context)

The server hook filters the list to only records the current user should see:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.query_builder </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> DocType</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_context</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(context):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># 1. Require login</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.session.user </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Guest"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        frappe.throw(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Please log in to view this page."</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, frappe.PermissionError)</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># 2. Website sidebar for portal navigation</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    context.show_sidebar </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    context.sidebar_items </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Website Sidebar Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">filters</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"parent"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Parent Portal"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">fields</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"route"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"group"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">order_by</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"idx"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    )</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># 3. Filter list to current user's records</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> context.get(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"is_list"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        context.list_filters </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> get_user_filters()</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_user_filters</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">():</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"""Return filters that restrict the record list to the current user's family."""</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    Contact </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> DocType(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Contact"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    Guardian </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> DocType(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Family Guardian"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    Player </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> DocType(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Find players linked to the current user</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    player_names </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        frappe.qb.from_(Contact)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .join(Guardian).on(Guardian.guardian </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Contact.name)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .join(Player).on(Player.family </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Guardian.parent)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .select(Player.name)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .where(Contact.email_id </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">==</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.session.user)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        .run(</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">as_list</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    )</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    flat </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> [p[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">] </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">for</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> p </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">in</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> player_names]</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> flat:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"in"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, flat]}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">else</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Return impossible filter to show empty list</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"="</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"__none__"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]}</span>
```

### How List Filtering Works

Frappe applies `context.list_filters` as additional WHERE clauses on the list query. This works in conjunction with `apply_document_permissions: 1` for defense-in-depth:

**`apply_document_permissions`** – Frappe checks `has_permission()` on each record

**`list_filters`** – Pre-filters the query so only relevant records are fetched

Use both together. `list_filters` improves performance by narrowing the query, while `apply_document_permissions` ensures no unauthorized access slips through.

## Website Sidebar

Portal navigation is defined in a **Website Sidebar** document. Each item links to a portal route:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">context.show_sidebar </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">context.sidebar_items </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.get_all(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Website Sidebar Item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">filters</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"parent"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Parent Portal"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">fields</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"route"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"group"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">order_by</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"idx"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
```

This renders a sidebar with links like:

My Players → `/portal/players`

Applications → `/portal/applications`

Payments → `/portal/payments`

The sidebar is shared across multiple portal views by referencing the same Website Sidebar parent.

## List Columns

Define which columns appear in the list table:

```
<span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"list_columns"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"player_full"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Data"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Player"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Link"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"options"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Season"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Select"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldname"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"paid"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"fieldtype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Check"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"label"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Paid"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]</span>
```

Columns should match fields that are on the underlying doctype. Link fields render as plain text in the list view.

## Client-Side Enhancements

Minimal client-side code for list-mode views, but `frappe.ready()` still runs:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">ready</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> () {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Customize list page title</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">heading</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> document.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">querySelector</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">".web-form-title h1"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (heading) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        heading.textContent </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Applications"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">});</span>
```

## Nested Portal Routes

Portal views can be nested under a common prefix to group related views:

```text
play/portal/applications    → Player Application list
play/portal/players         → Player list
play/portal/payments        → Payment history
```

The `breadcrumbs` configuration maintains navigation context:

```
<span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"breadcrumbs"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"[{</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">label</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Home</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">,</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">route</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">/</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">},{</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">label</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">Portal</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">,</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">route</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">:</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">portal</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">\"</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">}]"</span>
```

## Integration with Web Forms

A portal view and a web form can target the **same doctype**:

| Concern                  | Configuration                                                        |
| ------------------------ | -------------------------------------------------------------------- |
| **Public entry form**    | `login_required: 0`, `show_list: 0`                                  |
| **Authenticated portal** | `login_required: 1`, `show_list: 1`, `apply_document_permissions: 1` |

This allows a two-pronged approach: a public form for new submissions, and a portal for existing users to review their records.

## Checklist

Set `login_required: 1` for portal views

Set `show_list: 1` and `apply_document_permissions: 1`

Implement `list_filters` in `get_context()` for per-user filtering

Configure `list_columns` to show relevant fields

Create a Website Sidebar document for portal navigation

Set `context.show_sidebar = True` in `get_context()`

Add `breadcrumbs` for navigation context

Test as both the target user and another user to verify filtering

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

[← PreviousGrandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Next →Project Structure & Hooks](/kb/frappe/project-structure-hooks/)

CC0This article is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Purpose](#purpose)
- [File Structure](#file-structure)
- [JSON Configuration](#json-configuration)
- [Server-Side Context (get_context)](#server-side-context-get_context)
- [How List Filtering Works](#how-list-filtering-works)
- [Website Sidebar](#website-sidebar)
- [List Columns](#list-columns)
- [Client-Side Enhancements](#client-side-enhancements)
- [Nested Portal Routes](#nested-portal-routes)
- [Integration with Web Forms](#integration-with-web-forms)
- [Checklist](#checklist)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
