The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.
| # | Surface | Action | Capability | Expected | Provenance |
|---|---|---|---|---|---|
| 1 | listQuickSearchFields | Request the available contact search fields. | CAP-PFM-QRY-017 | The evidenced response describes a standard field’s label, type and origin. | test services-platform:modules/quick-search/tests/e2e/quick-search-configurations.e2e.spec.js#offers a standard field with its label, data type and origin |
| 2 | replaceQuickSearchConfiguration | Add an eligible custom field to the second search tier and replace the configuration. | CAP-PFM-QRY-017 | The response identifies the rebuild job associated with the saved change. | test services-platform:modules/quick-search/tests/e2e/quick-search-configurations.e2e.spec.js#answers the rebuild job the change owes, so a client can watch it |
| 3 | rebuildQuickSearchIndex | Follow the rebuild until its replacement generation is published. | CAP-PFM-QRY-017 | The documented lifecycle marks the new generation ready after rebuilding while retaining the prior search generation. | documented services-platform:docs/quick-search.md#3.3 Rebuilds |
| 4 | /console/{tenantId} | Type a value from the added field, then enter phone digits in the search box. | CAP-PFM-QRY-016 | The proposed interaction finds contacts through the configured terms and normalized phone digits. | inferred services-platform:modules/quick-search/tests/unit/services/indexing/build-documents.spec.ts#searches a phone number as it is stored and by its digits, so a typed run of digits finds it |
| 5 | /console/{tenantId} | Enable inclusion of inactive records. | CAP-PFM-QRY-016 | The search filter permits both inactive and archived contacts. | observed react-console:lib/quick-search/search.ts:statusFilterFor |
| Path | From step | Condition | Path taken | Outcome | Provenance |
|---|---|---|---|---|---|
| alternate | 2 | An ineligible long-text field is included. | Reject the replacement and identify the unsupported field. | The configuration stays unchanged and no rebuild is admitted. | test services-platform:modules/quick-search/tests/e2e/quick-search-configurations.e2e.spec.js#refuses a field whose data type Quick Search cannot hold as a term |
| failure | 4 | The caller lacks permission to read contacts. | Refuse a search credential for that record type. | The caller receives no credential with which to query its index. | test services-platform:modules/quick-search/tests/e2e/quick-search-access.e2e.spec.js#refuses a caller holding the lookup but not the record type’s own permission |
| Id | Statement | Provenance |
|---|---|---|
01 | The documented rebuild lifecycle makes the changed field list available after publication. | documented services-platform:docs/quick-search.md#3.3 Rebuilds |
02 | The default status filter excludes archived contacts; the inactive-record option permits them. | observed react-console:lib/quick-search/search.ts:statusFilterFor |
End-to-end policy: optional: Service and unit evidence covers configuration, credential refusal and term normalization. A browser scenario should demonstrate publication of the changed field and a subsequent typed lookup.