View Configuration - Configuration Guide
Overview
Views in the Permitting System provide different ways to visualize and interact with entity records. This guide covers the configuration of four view types: Grid View, Kanban View, Dashboard View, and Form View. Each view type serves different purposes and can be configured with specific permissions to control access.
View Types Available
| View Type | Icon | Description | Best Used For |
|---|---|---|---|
| Grid | Grid3X3 | Tabular display of records with sortable columns | Data analysis, bulk operations, searching |
| Kanban | SquareKanban | Card-based board organized by a grouping field | Workflow management, status tracking |
| Dashboard | LayoutDashboard | Configurable widgets displaying charts and metrics | KPI monitoring, reporting, analytics |
| Form | ClipboardList | Data entry and record creation interface | Record creation, public submissions |
Prerequisites
Before configuring views, ensure:
- User has Entity Manager access permissions
- At least one Entity has been created
- Entity has fields configured (especially for Kanban views)
- User has appropriate role permissions for view management
Permission Requirements
| Action | Required Permission | Resource |
|---|---|---|
| Create View | CREATE | ENTITY_VIEW |
| Edit View | UPDATE | ENTITY_VIEW |
| Delete View | DELETE | ENTITY_VIEW |
| View Records | VIEW_ENTITY_RECORD | ENTITY_RECORD |
Understanding the View Architecture
Navigation Structure
Views in the Entity Manager are organized hierarchically:
- Sidebar Menu - Contains menu items (folders) that organize views
- Tab Views - Within each menu item, views are displayed as tabs
- Entity Independence - Any view can pull data from any entity, regardless of its location in the sidebar
Creating Views
There are two ways to create views:
Option 1: Create via Sidebar Plus (+) Button
Navigation: Entity Manager -> Sidebar -> Click + icon
This opens a menu with the following options:
| Option | Type | Description |
|---|---|---|
| Grid | grid | Create a new grid view |
| Dashboard | dashboard | Create a new dashboard |
| Kanban | kanban | Create a new kanban board |
| Form | form | Create a new form view |
| Folder | folder | Create a new sidebar menu item (folder) |
Note: Any option selected from the sidebar + button creates a new sidebar menu item. The view type you select (Grid, Dashboard, Kanban, or Form) becomes the first tabular view within that new menu item. Selecting "Folder" creates an empty menu item where you can add views later. Additional views can then be added as tabs within the menu item.
Option 2: Create via View Tabs
Navigation: Entity Manager -> Click on any Menu Item -> View Tabs -> + Add View
When inside a menu item, you can add additional views as tabs. These views are specific to that menu item but can source data from any entity.
Section 1: Grid View Configuration
1.1 Creating a Grid View
Grid views display entity records in a tabular format with sortable columns and advanced filtering capabilities.
Navigation:
- Sidebar -> Click + icon -> Grid, or
- Menu Item -> View Tabs -> + Add View -> Grid
1.2 Grid View Creation Steps
The grid view creation is a multi-step process:
Step 1: Basic Information
| Setting | Description | Required |
|---|---|---|
| View Name | Display name for the grid view | Yes |
| Entity | The entity this view displays records from | Yes |
Step 2: Column Selection
After naming and selecting the entity, you can configure which fields appear as columns:
- Remove Fields: Exclude specific fields from the view
Step 3: Filters, Sorts, and Pins
Configure the default view settings:
| Feature | Description |
|---|---|
| Filters | Set default filter conditions for the view |
| Sorting | Configure default sort order (ascending/descending) by field |
| Pinned Columns | Pin important columns to the left for visibility while scrolling |
1.3 Grid View Features
Column Configuration (After Creation)
Once the grid view is created, you can modify columns directly:
- Hide Field: Right-click column header -> Hide field (or use EyeOff icon)
- Field Description: Right-click column header -> Field Description to view field details
- Column Visibility: Toggle column visibility for the current session
Filtering Options
String Field Operators:
| Operator | Value | Description |
|---|---|---|
| contains | ilike | Case-insensitive substring match |
| equals | eq | Exact value match |
| does not equal | ne | Value does not match |
| is empty | is_null | Field has no value |
| is not empty | is_not_null | Field has a value |
Number Field Operators:
| Operator | Value | Description |
|---|---|---|
= | eq | Equal to |
!= | ne | Not equal to |
> | gt | Greater than |
>= | gte | Greater than or equal |
< | lt | Less than |
<= | lte | Less than or equal |
| is empty | is_null | No value |
| is not empty | is_not_null | Has value |
Date Field Operators:
| Operator | Value | Description |
|---|---|---|
| is | eq | Exact date match |
| date equals | date_eq | Date portion equals |
| is not | ne | Does not equal |
| is after | gt | After specified date |
| is on or after | gte | On or after date |
| is before | lt | Before date |
| is on or before | lte | On or before date |
Select/Dropdown Operators:
| Operator | Value | Description |
|---|---|---|
| is | eq | Equals selected value |
| is not | ne | Does not equal |
| is none of | nin | Not in list |
| is any of | in | In list |
Boolean Operators:
| Operator | Value | Description |
|---|---|---|
| is | eq | Equals True or False |
Available Boolean Options:
True(value:true)False(value:false)
Section 2: Kanban View Configuration
2.1 Creating a Kanban View
Kanban views display records as cards organized into columns based on a single-select field (Dropdown or Radio).
Navigation:
- Sidebar -> Click + icon -> Kanban, or
- Menu Item -> View Tabs -> + Add View -> Kanban
2.2 Kanban View Settings
| Setting | Description | Required |
|---|---|---|
| Kanban Name | Display name for the kanban view | Yes |
| Select Kanban Field | The field used to group cards into columns | Yes |
| Description | Optional description of the view | No |
2.3 Field Requirements
The Kanban grouping field must be one of:
- Dropdown field type
- Radio field type
Note: The dialog description states: "Pick a single-select field (Dropdown or Radio) -- this will be used to group participants in the Kanban view."
2.4 Kanban View Validation Rules
| Rule | Validation Message |
|---|---|
| Name required | "Kanban view name is required" |
| Minimum length | "Kanban view name must be at least 3 characters" |
| Maximum length | "Kanban view name must not exceed 50 characters" |
| Character format | "Kanban view name must contain only letters and spaces" |
| Field required | "Please select a field for Kanban View" |
2.5 Kanban Header Controls
The Kanban view header provides several controls for customizing the display:
| Control | Icon | Description |
|---|---|---|
| Search | Search | Filter cards by text search |
| Stacked By | SquareChevronDown | Change the grouping field |
| Filter | Filter | Apply advanced filters |
| Sort | Sort | Sort cards within columns |
| Customize | Settings (Gear) | Configure card display fields |
| Hide/Show | EyeOff | Hide or show specific columns |
2.6 Kanban Customization (Customize Button)
Navigation: Kanban View -> Click Customize button (gear icon) -> Configure card display
The Customize drawer allows you to configure what fields display on Kanban cards.
Customize Panel Features
| Feature | Description |
|---|---|
| Fields Selector | ComboBox to select which fields appear on cards |
| Drag & Drop Reorder | Drag fields to change their display order on cards |
| Show All Toggle | Switch to show all available fields on cards |
| Remove Fields | Click X to remove a field from card display |
| Live Preview | See changes reflected in the preview panel |
Configuration Steps
- Click the Customize button (gear icon) in the Kanban header
- The customization drawer opens on the right side
- Use the Fields dropdown to select fields to display on cards
- Reorder fields by dragging them in the preview list
- Toggle Show All to display all fields on cards
- Close the drawer to apply changes
Drawer Labels:
| Label | Value |
|---|---|
| Button Label | "Customize" |
| Drawer Title | "Customized your Card" |
| Subtitle | "Click to Add columns here to customize what shows on your cards" |
| Fields Label | "Fields" |
| Show All Toggle | "Show All" |
2.7 Stacked By (Change Grouping Field)
Navigation: Kanban View -> Click Stacked By button -> Select new field
You can change the field used to group cards into columns without recreating the view.
| Setting | Description |
|---|---|
| Select Field | Choose a dropdown or radio field to group by |
| Field Types | Only Dropdown and Radio fields are available |
Help Text: "Choose a field (dropdown, radio) to group participants in the Kanban view."
2.8 Hide/Show Columns
Navigation: Kanban View -> Click Hide/Show button (EyeOff icon)
Control which columns (stacking field values) are visible in the Kanban view.
| Feature | Description |
|---|---|
| Search | Search for specific columns by name |
| Toggle Visibility | Switch each column on/off |
| Hidden Count | Badge shows number of hidden columns |
2.9 Kanban View Layout
Dimensions:
| Element | Value | Description |
|---|---|---|
| Minimum Column Width | 364px | Minimum width per column |
| Minimum Card Width | 353px | Minimum width per card |
| Container Padding | 40px | Padding around container (20px each side) |
| Column Gap | 16px | Space between columns |
| Sidebar Width | 364px | Width of configuration sidebar |
| Drawer Width | 490px | Width of customize drawer |
2.10 Kanban Card Features
- Drag and Drop: Move cards between columns to update the grouping field value
- Field Display: Shows configured fields on each card (via Customize)
- Unassigned Column: Records without a grouping value appear in "Unassigned" column
- Field Limit: By default, cards show limited fields with "more fields" indicator
- Add New: Create new records directly in a column
Text Constants:
| Feature | Label |
|---|---|
| Add New Record | "Add New" |
| Unassigned Records | "Unassigned" |
2.11 Date Formatting
Kanban cards use the following date format:
- Full Format:
PPpp(e.g., "Dec 30, 2025 at 3:45 PM")
Section 3: Dashboard View Configuration
3.1 Creating a Dashboard View
Dashboard views provide configurable widgets for displaying charts, metrics, and data visualizations.
Navigation:
- Sidebar -> Click + icon -> Dashboard, or
- Menu Item -> View Tabs -> + Add View -> Dashboard
3.2 Dashboard View Settings
| Setting | Description | Required |
|---|---|---|
| Dashboard Name | Display name for the dashboard | Yes |
| Description | Optional description of the dashboard | No |
3.3 Widget Types
Available Chart/Widget Types:
| Widget Type | Value | Description |
|---|---|---|
| Number | number | Single numeric value with aggregation |
| Column | column | Vertical bar chart |
| Line | line | Line chart for trends |
| Pie | pie | Pie chart for proportions |
| Bar | bar | Horizontal bar chart |
| Table | table | Tabular data display |
| Candlestick | candlestick | Financial candlestick chart |
| Scatter | scatter | Scatter plot chart |
3.4 Widget Configuration Options
Data Source Configuration
| Setting | Description |
|---|---|
| Entity | Source entity for the widget data |
| Field | Field to aggregate or display |
| Field Type | Type of the selected field |
Aggregation Options
Number Field Aggregations:
| Aggregation | Value | Description |
|---|---|---|
| Sum | sum | Total of all values |
| Average | avg | Mean value |
| Count | count | Number of records |
| Max | max | Maximum value |
| Min | min | Minimum value |
| Variance | variance | Statistical variance |
| Standard Deviation | std_dev | Statistical std deviation |
Date Field Aggregations:
| Aggregation | Value | Description |
|---|---|---|
| Count | count | Number of records |
| Min | min | Earliest date |
| Max | max | Latest date |
| Distinct | distinct | Unique date count |
Text Field Aggregations:
| Aggregation | Value | Description |
|---|---|---|
| Count | count | Number of records |
| Distinct | distinct | Unique value count |
3.5 Date Granularity Options
For time-based charts, the following granularity options are available:
| Granularity | Value | Description |
|---|---|---|
| Day | day | Group by day |
| Week | week | Group by week |
| Month | month | Group by month |
| Quarter | quarter | Group by quarter |
| Year | year | Group by year |
3.6 Sort Options
| Option | Value |
|---|---|
| Ascending | asc |
| Descending | desc |
3.7 Top N Filtering
| Option | Value |
|---|---|
| Top 3 | 3 |
| Top 5 | 5 |
| Top 10 | 10 |
| Top 15 | 15 |
| Top 20 | 20 |
3.8 Number Widget Display Options
Label Position:
| Position | Value |
|---|---|
| Bottom | bottom |
| Top | top |
Unit Position:
| Position | Value |
|---|---|
| Left | left |
| Right | right |
Currency/Unit Options:
| Unit | Symbol |
|---|---|
| Dollar | $ |
| Euro | EUR |
| Pound | GBP |
| Percentage | % |
| Custom | User-defined |
3.9 Dashboard Layout Constraints
| Constraint | Value | Description |
|---|---|---|
| Grid Columns | 12 | Total columns in grid |
| Max Y Position | 1000 | Maximum vertical position |
| Max Widget Height | 50 | Maximum height units |
| Min Widget Width | 1 | Minimum width units |
| Max Widget Width | 12 | Maximum width (full row) |
| Min Widget Height | 1 | Minimum height units |
| Default Widget Width | 4 | Default width (3 per row) |
| Default Widget Height | 8 | Default height units |
| Widgets Per Row | 3 | Standard widgets per row |
3.10 Dashboard Features
- Edit Mode Toggle: Switch between view and edit modes
- Drag & Resize: Reposition and resize widgets in edit mode
- Full Screen Mode: Expand dashboard to full screen
- Export to PDF: Download dashboard as PDF document
Section 4: View Permissions
4.1 Visibility Options
Each view can have one of three visibility settings:
| Visibility | Value | Description |
|---|---|---|
| Personal | personal | Restricts access to the owner only |
| Public | public | Turn on read-only access to this base |
| Collaborator | collaborator | Grants access to specific collaborators only |
Default Visibility: personal
4.2 Managing View Permissions
Navigation: Views Header -> View Actions Menu -> Manage Permissions
Permission Dialog Configuration
The permission dialog allows you to:
- Set the view visibility level
- Add specific collaborators (for Collaborator visibility)
- Configure read/write access per collaborator
4.3 View Actions Menu
Available actions vary by view type. Right-click on a view tab or click the three-dot menu to access these options.
Grid View Actions:
| Action | Description |
|---|---|
| Pin | Pin view to top of list |
| Edit | Modify view name and settings |
| Rename | Rename the view |
| Duplicate | Create a copy of the view |
| Share | Share the view with others |
| Configure | Configure columns, filters, and display |
| View Parent Entity | Navigate to the source entity |
| View Details | View detailed view information |
| Delete | Remove the view |
Kanban View Actions:
| Action | Description |
|---|---|
| Pin | Pin view to top of list |
| Edit | Modify view name and settings |
| Rename | Rename the view |
| Duplicate | Create a copy of the view |
| Share | Share the view with others |
| Configure | Open Kanban configuration |
| View Parent Entity | Navigate to the source entity |
| View Details | View detailed view information |
| Delete | Remove the view |
Dashboard View Actions:
| Action | Description |
|---|---|
| Pin | Pin view to top of list |
| Edit | Modify dashboard settings |
| Rename | Rename the dashboard |
| Duplicate | Create a copy of the dashboard |
| Share | Share the dashboard with others |
| View Details | View detailed dashboard information |
| Delete | Remove the dashboard |
Form View Actions:
| Action | Description |
|---|---|
| Pin | Pin view to top of list |
| Edit | Modify form settings |
| Rename | Rename the form |
| Duplicate | Create a copy of the form |
| Share | Share the form (including public links) |
| View Parent Entity | Navigate to the source entity |
| View Details | View detailed form information |
| Delete | Remove the form |
Section 5: Form View Configuration
5.1 Creating a Form View
Form views are used for data entry and can be shared publicly for external submissions.
Navigation:
- Sidebar -> Click + icon -> Form, or
- Menu Item -> View Tabs -> + Add View -> Form
5.2 Form View Settings
| Setting | Description | Required |
|---|---|---|
| Form Name | Display name for the form | Yes |
| Description | Optional description | No |
5.3 Form View Features
- Public Sharing: Generate shareable links for external access
- Field Configuration: Control which fields appear on the form
- Validation Rules: Configure field-level validation
- Conditional Logic: Show/hide fields based on conditions
Troubleshooting
Common Issues
Cannot Create Kanban View
Check:
- Ensure you have created at least one Dropdown or Radio field on the entity
- Verify you have CREATE permission for ENTITY_VIEW
- Confirm the entity is selected before clicking Add View
Dashboard Widgets Not Loading
Check:
- Verify the source entity has records
- Check that the selected field exists and has data
- Ensure the aggregation type is compatible with the field type
View Permission Changes Not Taking Effect
Check:
- User must log out and log back in for permission changes to apply
- Verify the user's role has the appropriate base permissions
- Check that the view's visibility setting matches the intended access level
Grid View Filters Not Working
Check:
- Ensure the field type matches the filter operator being used
- Verify the filter value format (dates must be in correct format)
- Check that the field is not empty for "is not empty" filters
Related Documentation
Code Reference
Source Files
| File | Location | Purpose |
|---|---|---|
| Sidebar Plus Button | entity-manager-app/src/components/SidebarMenuPlusButton/const.ts | View type options (Grid, Dashboard, Kanban, Form, Folder) |
| View Types | entity-manager-app/src/components/CreateViewDialog/consts.ts | View type definitions |
| View Config | entity-manager-app/src/components/MainLayout/consts.ts | View configuration options |
| View Actions | entity-manager-app/src/components/MainLayout/ViewsHeader/RenderViewsList/const.ts | View action menu labels |
| Grid View Dialog | entity-manager-app/src/components/MainLayout/ViewsHeader/CreateView/CreateEditGridView/ | Grid view creation |
| Kanban Constants | entity-manager-app/src/pages/KanbanView/consts.ts | Kanban layout constants |
| Kanban Header | entity-manager-app/src/pages/KanbanView/KanbanHeader/consts.ts | Kanban header labels and options |
| Kanban Customize | entity-manager-app/src/pages/KanbanView/KanbanHeader/CustomizedField/ | Card customization component |
| Kanban Stacked By | entity-manager-app/src/pages/KanbanView/KanbanHeader/StackedBy/ | Grouping field selector |
| Kanban Hide Column | entity-manager-app/src/pages/KanbanView/KanbanHeader/HideColumn/ | Column visibility toggle |
| Dashboard Constants | entity-manager-app/src/pages/Dashboard/const.ts | Chart types and configurations |
| Permission Dialog | entity-manager-app/src/components/MainLayout/ViewsHeader/RenderViewsList/ManagePermissionDialog/const.ts | Visibility options |
| Filter Operators | entity-manager-app/src/pages/KanbanView/KanbanHeader/KanbanFilters/Filters/AdvancedFilter/OperatorTypes.ts | Filter operator definitions |
This guide is aligned with the entity-manager-app codebase as of December 2025.