This guide explains how Salesforce Administrators build Workspace Configurations in the Squivr Workspace Builder, including navigation, components, the config header and footer, and publishing.
1. Assign Permissions
Assign the correct permission set(s) for Workspaces:
| Permission Set | Access Level |
|---|---|
| Squivr Workspace Base | Standard create/edit access |
| Squivr Workspace Base Lite | Standard create/edit access (no Squivr Application access) |
| Squivr Workspace Base Read Only | View-only access |
| Squivr Workspace View All | Read all records (extension for a Base permission set) |
| Squivr Workspace Modify All | Full org-wide access (extension for a Base permission set) |
2. Open the Workspace Builder
- Open the Squivr Admin tab
- The Builder loads the Workspace Configurations landing page, a searchable grid of all existing configurations
- System configurations (shipped with the package) show a lock icon and cannot be edited; create a new one from a recipe or scratch to customize
From the landing page you can:
- Click New Configuration to start from scratch
- Click Create from Recipe to start from a preset bundle of nav items and components
- Click any admin-authored card to open that configuration in the Builder
- Use the search box to filter by name or object
3. Set the Configuration Properties
With a configuration open, the top of the Builder shows the Configuration Properties panel:
- Name, the configuration's display name
- Scope Type,
Global,Object, orRecordType - Object, appears when Scope Type is
ObjectorRecordType; pick the Sobject - Record Type, appears when Scope Type is
RecordType; pick a record type on the selected object - Nav Color, a named color token for the left rail
- Nav Collapsible, allows end users to collapse the nav rail
- Default Collapsed, the nav rail starts collapsed when the workspace loads
- Active, Draft when false, Published when true
- Description, optional admin notes (up to 5000 characters)
Scope determines where the Workspace renders:
- Global, appears as a tab in the Squivr app navigator with no record context
- Object, renders on record pages for the selected object
- RecordType, renders on record pages only when the record's RecordType matches
4. Add Navigation Items
The left pane's Navigation section manages the entries in the left rail.
- Click + Add Nav Item
- Fill in the modal:
- Label
- Icon (SLDS icon picker)
- Tooltip (optional)
- Is Default (only one nav item can be default; this is the nav item selected when the workspace opens)
- Click Add
Once added, each nav item in the tree supports:
- Drag the handle to reorder
- The edit icon to open the inline edit panel and change Label, Icon, Tooltip, or Is Default
- Up/Down arrows to move by one position
- The delete icon to remove the nav item (and all its components)
5. Pick a Layout Template for a Nav Item
Select a nav item in the left rail. Above the canvas, click the layout chip to open the template picker and choose one:
| Template | Regions |
|---|---|
| Full Width | Header, Main, Footer (all full width) |
| Left Sidebar + Main | Header, Sidebar (4), Main (8), Footer |
| Main + Right Sidebar (default) | Header, Main (8), Sidebar (4), Footer |
| Two Equal Columns | Header, Left (6), Right (6), Footer |
| Header + Main | Header, Main (no footer) |
| Main Only | Main only |
Changing the layout on a nav item that already has components placed will prompt you to Move & Continue so the Builder can relocate orphaned components into the new layout's regions.
6. Add Components
The left pane's Components palette lists every component available in the Builder's registry, grouped by category:
- Data Display (Highlights, Related List, Notes, Record Detail, Record Banner, Header Panel, Card Color Legend, Whitespace Summary, Whitespace Analysis)
- Actions (Actions Bar)
- Visualizations (Org Chart, Gantt Chart, Timeline, Arc Groups, Quadrants, Action Plan)
- Automation (Flow)
- External (Visualforce Page)
- Containers (Tab Set, Accordion)
- Custom (Custom LWC, Custom Aura Component, for any exposed component not in the registry)
To add a component:
- Select the target nav item so the canvas shows its layout
- Drag a palette tile into a region on the canvas (Header, Main, Sidebar, Left, Right, Footer, depending on the layout), or click a tile to open the Add modal and pick a region
- The Add modal opens with the component's parameters
- Fill in the parameters (each component has its own set, see the Nav Items and Components Reference article for the full list)
- Click Add
Components on the canvas can be dragged between regions, reordered within a region, selected, or deleted. Selecting a component opens the Inspector in the right pane, where you can edit every parameter without reopening the Add modal.
7. Add Config-Level Header and Footer Components (Optional)
The canvas always shows two extra regions outside the per-nav-item layout:
- Config Header, renders at the top of every nav item in the workspace
- Config Footer, renders at the bottom of every nav item in the workspace
Drag components into these regions to create persistent surfaces like a workspace-wide Actions Bar, a Record Banner at the top of every tab, or a shared header panel.
8. Save and Publish
The Builder tracks unsaved changes and shows an "Unsaved changes" warning below the status badge while you work.
- Click Save at any time to persist changes; the configuration stays in its current Draft or Published state
- Click Publish to activate the configuration (a confirmation modal appears)
- Click Unpublish to return a live configuration to Draft without deleting it
A configuration must have at least one navigation item, or at least one config header/footer component, before it can be saved or published.
Admin Notes
- Workspace Configurations are resolved at runtime and the first Published match wins
- Nav Item and Component changes apply to every user as soon as the configuration is saved and they reload the page
- Unpublish (Active = false) to hide a configuration without deleting it
- The Builder persists the last-opened configuration in the browser session so refreshing returns you to the same configuration