Skip to content

CON-PFM-QRY-005Search Index

Markdown

CON-PFM-QRY-005

Search Index

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-QRY-06
Owned by
MOD-PFM-QRY
Acted on by
CAP-PFM-QRY-016, CAP-PFM-QRY-017
Visible to
ACT-PFM-013, ACT-PFM-007, ACT-PFM-012
Not to be confused with
An ordinary query or record-list execution against the source store, The demonstration data on the standalone Search page, CRM duplicate-detection work

Design

Specified by
DOM-PFM-QRY-005

KindKey conceptProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Definition
The search index is a derived collection of searchable contact and organization information maintained outside the record store for fast typed discovery.
Synonyms
Quick SearchThe search box

Relationships

ToStatementProvenance
CON-PFM-QRY-001Search documents are projected from the contact and organization query datasets.documented

Lifecycle

StateMeaningHow it changes
unprovisionedThe workspace record type has no indexing configuration yet.Initial use provisions defaults and requests population.
populating or rebuildingA replacement generation is being prepared while an existing one can continue answering.Validation permits the replacement generation to become active.
readyThe current generation serves search while change events maintain its documents.Configuration changes request replacement work and workspace purge removes the resources.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.