Skip to content

Document Record Grouping and Inventory Segments - #1483

Open
gtagle wants to merge 2 commits into
mainfrom
rod/sc-18067/document-record-grouping-and-inventory-segments
Open

Document Record Grouping and Inventory Segments#1483
gtagle wants to merge 2 commits into
mainfrom
rod/sc-18067/document-record-grouping-and-inventory-segments

Conversation

@gtagle

@gtagle gtagle commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

Shortcut: sc-18067

What and why?

Documents the two capabilities from epic 16787 — Record Grouping / Inventory Segments (Release 26.09):

Summary of changes

  • New page: Manage inventory segments — admin task guide covering adding segments, defining conditions (including the Inventory Record Type condition), publishing, editing, unpublishing/archiving/deleting, the seeded All Inventory Records example segment, applying segments as inventory filter rules, and using published segments as analytics datasets. Added to the Setting up the inventory listing and the guide sidebar.
  • Group By on listings — new "Group records" section in Working with the inventory and a "Group artifacts" section in View and filter artifacts: single-field grouping, collapsible headers with counts, Expand All / Collapse All, the Grouped by chip, Clear grouping, the table-view constraint, and the field-deleted fallback notice.
  • Saved views now mention groupingCustomize inventory layout, Customize artifact layouts, and the shared _personal-table-views.qmd include (inventory and artifacts branches only — workflow timelines are untouched, as they have no grouping).
  • Shared filter include — Segment added as an inventory filter rule option in _work-with-filters.qmd.
  • Analytics — Inventory Segments dataset added to _create-a-visualization.qmd.
  • Inventory FAQ — "Can the inventory be customized?" now covers grouping and segments.
  • Chatbot product map — refreshed the frontend snapshot and regenerated the map; pointed the artifact keyword at the current /guide/validation/ pages (it previously surfaced legacy template docs for the /artifacts and /validation-issues listings) added a segment keyword, and taught the generator to resolve copy()-driven SettingLink/SettingGroup titles and rank related docs by keyword specificity — the /settings/segments route now maps to the new guide page (with unit tests).

The docs deliberately distinguish Group By (listing layout), saved views (personal/shared table configuration), and segments (named organization-wide filters) — a callout on the new page spells out the difference.

How to test

Try the live preview (allow time for the PR preview deploy to finish):

All changed pages render cleanly with quarto render --profile development (only pre-existing warnings).

What needs special review?

  • UI labels were verified against frontend code, not live UI: Group By / Grouped by / Clear grouping / Expand All / Collapse All from frontend#2782 (merged), and the Segments strings (Add Segment, Edit Segment Conditions, Publish Segment, statuses, confirm buttons) from the feature/inventory-segments branch copy dictionary. Please re-verify against the live UI once frontend#2774 deploys.
  • Permissions wording: creating segments requires the Add Inventory Segment permission (Customer Admin by default); all roles can see and use published segments. Sourced from backend#3419.
  • No screenshots yet — screenshots for Group By, the grouped table, the Segments settings page, and the segment filter rule are a follow-up before or shortly after this merges.

Dependencies, breaking changes, and deployment notes

Release notes

Added documentation for grouping inventory, artifact, and validation issue listings into collapsible sections with Group By, and for creating, publishing, and applying Inventory Segments — named, reusable filters that span every inventory record type. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

🤖 Generated with Claude Code

Adds a Manage inventory segments task page and documents the Group By
control on the inventory, artifact, and validation issue listings,
including the table-view constraint and saved-view persistence.
Updates the shared saved-view and filter includes, the inventory FAQ,
the analytics dataset options, and the chatbot product map.

sc-18067

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@gtagle gtagle added the documentation Improvements or additions to documentation label Aug 27, 2026
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Refreshes the chatbot product map from frontend main now that the
Segments UI is merged. The map generator now resolves SettingLink and
SettingGroup titles that come from the frontend copy dictionary, and
ranks related docs by keyword specificity so the most relevant page
survives the six-entry cap.

sc-18067

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants