Sentinel complete workflow manual
This manual describes 97 workflows for Sentinel, organised by role and domain. It covers current behaviour, including API-only operations and incomplete handoffs. Use the role guides to find your starting point, then follow the numbered procedures and linked evidence.
Baseline and verification
Reviewed repository: anthonyraudino/sentinel. Baseline: 57cfc40423f60ac87e66988fb8e82169c5de7d90, captured from main at the start of this work on 27 October 2026. Application source, contracts, worker logic and related test source were inspected. Application tests, live provider calls, production changes and end-to-end UI journeys were not executed for this documentation audit.
The coverage register maps all 458 discovered Express operations and 78 UI route/presentation entries; finite endpoint expansion plus internal FastAPI and Swagger entries yields 504 API register rows. Counts are declarations, not a claim that every route is production-ready. Evidence and validation records the method and limits; gaps separates incomplete or unverified behaviour from working procedures.
Read the manual
Role guides and permission matrix · Coverage register · Machine-readable coverage · Gap register · Evidence and validation
Status vocabulary
| Label | Meaning |
|---|---|
| Implemented | The current source implements the documented path and guards; runtime success was not verified here. |
| Feature-gated | Implemented behaviour requires explicit server, client or tenant enablement in addition to dependencies/permissions. |
| Demonstrative | Seeded/example data or illustrative presentation; not operational proof. Any environment using seed data must be treated accordingly. |
| Incomplete | A concrete missing handoff, preview boundary or UI/API mismatch prevents claiming a complete workflow. |
| Unverified | The relevant environment, external service or runtime evidence was not inspected/executed; see the gap. |
Conventions and recovery
- Workflow IDs are stable references. Section headings provide purpose, actors/access, prerequisites, entry point, numbered steps, outcome, exceptions/recovery and pinned source evidence. A role guide is a reading path, not a permission grant.
- UI labels are described in English. Available actions depend on authentication mode, permissions, feature flags, record state and deployment services. An API-only operation is identified as such rather than presented as an invented button.
- Tenant context comes from authentication. Records, directory choices and evidence must belong to that tenant. Platform operator sessions, tenant platform:admin override, integration credentials and internal service authentication are different boundaries.
- On 401, renew the correct session. On 403, correct permissions/provider/policy with an authorised administrator. On 404, check tenant, ownership, expiry, feature availability and identifier without attempting to bypass access.
- On 409, inspect the current state/revision and reconcile; preserve unsaved work privately before reload. Do not blindly repeat a mutation that may already have succeeded. On 422, correct the supplied data or missing required decision. Usage-limit failures and throttling require allowance review or waiting as indicated.
- On a provider/storage/worker error, distinguish accepted work from completed work. Check the recorded job/request ID, restore dependencies, and use supported retries with the original idempotency context. Review every per-item result after bulk actions.
- Published definitions and submitted reviews have immutable histories. Changes usually require a successor draft, linked correction, independent review or new version. Permanent delete is separate from archive/retire and has no documented undo.
- Examples must not include credentials, private conversations or customer content. Read acknowledgements, quiz results, review scores and measured improvement are separate evidence types.
Maintenance
When functionality changes, update the affected workflow, role/access notes, coverage rows and gap status in the same review. Re-extract method registrations and UI definitions against the new commit; account for added/removed handlers and generic aliases. Validate links, explicit workflow anchors and Mermaid blocks. Record runtime verification separately with its exact environment/date/results. Do not convert historical test text or a previous plan completion checkbox into a fresh test-pass claim.
Workflow index
| ID | Purpose | Status |
|---|---|---|
| ACC-01 | Sign in, check tenant access and sign out | services/api/src/identity/routes.ts,services/api/src/identity/authenticator.ts,apps/web/src/features/auth/login.tsx |
| ACC-02 | Invite members, revoke invitations and accept an invitation | services/api/src/identity/member-routes.ts,services/api/src/identity/account-flows.ts,services/api/src/identity/routes.ts,apps/web/src/features/settings/users.tsx |
| ACC-03 | Request or initiate a password reset | services/api/src/identity/routes.ts,services/api/src/identity/member-routes.ts,services/api/src/identity/account-flows.ts |
| ACC-04 | Find members and inspect their details | services/api/src/identity/member-routes.ts,apps/web/src/features/settings/users.tsx,apps/web/src/features/settings/member-detail.tsx |
| ACC-05 | Create and maintain member profiles, roles and account status | services/api/src/identity/member-routes.ts,services/api/src/identity/owner-transition-guard.ts,apps/web/src/features/settings/member-detail.tsx |
| ACC-06 | Import, export and bulk-maintain members | services/api/src/identity/member-routes.ts,apps/web/src/features/settings/member-import.tsx,apps/web/src/features/settings/users.tsx |
| ACC-07 | Create teams, maintain memberships and archive or restore teams | services/api/src/teams/routes.ts,apps/web/src/features/settings/teams.tsx,packages/contracts/src/teams.ts |
| ACC-08 | Maintain companies and divisions | services/api/src/companies/routes.ts,apps/web/src/features/settings/companies.tsx |
| ACC-09 | Configure workspace behaviour and retention | services/api/src/app.ts,apps/web/src/features/settings/workspace.tsx,docs/transcriber-managed-policy.md |
| ACC-10 | Set personal preferences | services/api/src/user-preferences/routes.ts,apps/web/src/features/preferences/preferences.tsx,packages/contracts/src/user-preferences.ts |
| INT-01 | Find and review an interaction | services/api/src/interactions/routes.ts,services/api/src/search/routes.ts,apps/web/src/features/interactions/interactions.tsx |
| INT-02 | Upload call audio for transcription | services/api/src/transcription-jobs/upload-route.ts,apps/web/src/features/interactions/interactions.tsx,services/api/src/transcription-jobs/result-lifecycle.ts |
| INT-03 | Ingest completed chat or email conversations | services/api/src/conversations/routes.ts,services/api/src/conversations/ingest.ts,packages/contracts/src/conversations.ts |
| INT-04 | Import conversation files and manage import profiles | services/api/src/interaction-imports/routes.ts,apps/web/src/features/interactions/interaction-import.tsx,packages/contracts/src/interaction-imports.ts |
| INT-05 | Import phone transcripts and attach matching audio | services/api/src/interaction-imports/routes.ts,apps/web/src/features/interactions/phone-call-import.tsx |
| INT-06 | Authorise, complete and read artifact uploads | services/api/src/artifacts/routes.ts,services/api/src/artifacts/upload-authorization.ts |
| INT-07 | Monitor transcription work and cancel eligible jobs | services/api/src/transcription-jobs/routes.ts,apps/web/src/features/transcription-jobs/transcription-jobs.tsx |
| INT-08 | Review and approve a transcription draft | services/api/src/transcription-jobs/routes-review.ts,services/api/src/transcription-jobs/result-lifecycle.ts,apps/web/src/features/transcription-jobs/transcription-review.tsx |
| INT-09 | Assign or unassign an interaction | services/api/src/interactions/routes.ts,services/api/src/identity/assignee.ts,apps/web/src/features/interactions/interactions.tsx |
| INT-10 | Archive, restore, delete or correct processing status | services/api/src/interactions/routes.ts,services/api/src/interactions/repository.ts,apps/web/src/features/interactions/interactions.tsx |
| INT-11 | Inspect analysis and request bounded reanalysis | services/api/src/interaction-analyses/routes.ts,services/api/src/interaction-analyses/reanalysis.ts,docs/journey-intelligence-runbook.md |
| EVA-01 | Browse and create published Atoms | services/api/src/atoms/routes.ts,services/api/src/atoms/lifecycle.ts,apps/web/src/features/atoms/atoms.tsx |
| EVA-02 | Revise, publish, retire, archive and delete Atoms | services/api/src/atoms/routes.ts,services/api/src/atoms/lifecycle.ts,apps/web/src/features/atoms/atoms.tsx |
| EVA-03 | Create and edit a Molecule draft | services/api/src/molecules/routes.ts,services/api/src/molecules/lifecycle.ts,apps/web/src/features/molecules/editor.tsx |
| EVA-04 | Publish and maintain Molecule versions | services/api/src/molecules/routes.ts,services/api/src/molecules/lifecycle.ts,apps/web/src/features/molecules/molecules.tsx |
| EVA-05 | Author and edit scorecard drafts | services/api/src/scorecards/routes.ts,packages/contracts/src/scorecards.ts,apps/web/src/features/scorecards/builder.tsx |
| EVA-06 | Publish, revise and delete scorecards | services/api/src/scorecards/routes.ts,apps/web/src/features/scorecards/scorecards.tsx |
| EVA-07 | Assign and resolve a published scorecard | services/api/src/scorecards/routes.ts,packages/contracts/src/scorecards.ts,apps/web/src/features/scorecards/scorecards.tsx |
| EVA-08 | Generate a scorecard proposal and create its draft | services/api/src/scorecard-suggestions/routes.ts,services/api/src/scorecard-suggestions/generator.ts,apps/web/src/features/scorecards/scorecards.tsx |
| EVA-09 | Generate and save evidence-backed Atom suggestions | services/api/src/atoms/routes.ts,services/api/src/atoms/suggestions.ts,apps/web/src/features/atoms/atoms.tsx |
| EVA-10 | Generate a Molecule composition proposal | services/api/src/molecules/proposals.ts,apps/web/src/features/molecules/molecules.tsx |
| EVA-11 | Review, apply, retry or discard an AI enrichment proposal | services/api/src/ai-enrichments/service.ts,apps/web/src/features/ai-enrichments/proposal-panel.tsx,packages/contracts/src/ai-enrichments.ts |
| QMS-01 | Queue, claim, assign and reassign manual reviews | services/api/src/audits/routes.ts,services/api/src/app.ts,apps/web/src/features/administration/assignment.tsx,apps/web/src/features/audits/audit-queue.tsx |
| QMS-02 | Draft a review with evidence and knowledge selection | services/api/src/audits/routes.ts,services/api/src/audits/knowledge-selection.ts,apps/web/src/features/audits/audit-workbench.tsx |
| QMS-03 | Review AI suggestions and generate a findings summary | services/api/src/ai-suggestions/routes.ts,services/api/src/ai-suggestions/queue.ts,apps/web/src/features/audits/audit-workbench.tsx |
| QMS-04 | Submit a review and inspect its official result | services/api/src/audits/routes.ts,services/api/src/audits/scoring.ts,apps/web/src/features/audits/audit-workbench.tsx |
| QMS-05 | Record a manager correction | services/api/src/corrections/routes.ts,apps/web/src/features/administration/assignment.tsx |
| QMS-06 | Assign and complete independent re-review | services/api/src/re-reviews/routes.ts,apps/web/src/features/re-reviews/re-review-workbench.tsx,apps/web/src/features/re-reviews/re-review-queue.tsx |
| QMS-07 | Perform an independent calibration | services/api/src/calibrations/routes.ts,services/api/src/calibrations/comparison.ts,apps/web/src/features/audits/audit-workbench.tsx |
| QMS-08 | Configure calibration sampling | services/api/src/calibration-sampling/routes.ts,services/api/src/calibration-sampling/selection.ts,services/api/src/audits/routes.ts,apps/web/src/features/administration/assignment.tsx |
| QMS-09 | Adjudicate calibration disagreements | services/api/src/adjudications/routes.ts,services/api/src/calibrations/routes.ts,apps/web/src/features/adjudications/adjudications.tsx |
| QMS-10 | Create a manual calibration reference and distribute it | services/api/src/manual-calibrations/routes.ts,apps/web/src/features/audits/manual-calibration-workbench.tsx |
| QMS-11 | Complete a manual calibration assignment | services/api/src/manual-calibrations/routes.ts,apps/web/src/features/audits/manual-calibration-workbench.tsx |
| QMS-12 | Finalise and publish manual calibration results | services/api/src/manual-calibrations/routes.ts,services/api/src/manual-calibrations/alignment.ts,apps/web/src/features/audits/manual-calibration-workbench.tsx |
| KNO-01 | Find published knowledge and inspect pinned sections | services/api/src/knowledge/routes.ts,services/api/src/knowledge/article-sections.ts,apps/web/src/features/knowledge/knowledge.tsx |
| KNO-02 | Create, edit and preview a knowledge draft | services/api/src/knowledge/routes.ts,apps/web/src/features/knowledge/knowledge.tsx |
| KNO-03 | Publish, restore, archive or delete knowledge | services/api/src/knowledge/routes.ts,apps/web/src/features/knowledge/knowledge.tsx |
| KNO-04 | Upload, use and remove knowledge assets | services/api/src/knowledge/routes.ts,services/api/src/knowledge/attachment-usage.ts,apps/web/src/features/knowledge/knowledge-rich-content.tsx |
| KNO-05 | Maintain categories, tags and article owners | services/api/src/knowledge/routes.ts,apps/web/src/features/knowledge/knowledge.tsx |
| KNO-06 | Enrich a knowledge draft with reviewed AI changes | services/api/src/knowledge/routes.ts,services/api/src/knowledge/enrichment.ts,apps/web/src/features/knowledge/knowledge.tsx |
| KNO-07 | Announce published knowledge and remind managers | services/api/src/knowledge/routes.ts,services/api/src/knowledge/announcement-repository.ts,apps/web/src/features/knowledge/knowledge-announcements.tsx |
| LRN-01 | Follow recommended knowledge and record progress | services/api/src/learning/routes.ts,apps/web/src/features/learning/learning.tsx,packages/contracts/src/learning-progress.ts |
| LRN-02 | Author, publish, revise and archive a training program | services/api/src/training/routes.ts,apps/web/src/features/learning/training-workspace.tsx,packages/contracts/src/training.ts |
| LRN-03 | Assign training and monitor learner completion | services/api/src/training/routes.ts,apps/web/src/features/learning/training-assignment-manager.tsx |
| LRN-04 | Complete assigned content and quizzes | services/api/src/training/routes.ts,apps/web/src/features/learning/training-workspace.tsx |
| LRN-05 | Create or duplicate a coaching plan | services/api/src/coaching-plans/routes.ts,apps/web/src/features/coaching/coaching-plans.tsx |
| LRN-06 | Activate coaching, measure outcomes and close the plan | services/api/src/coaching-plans/routes.ts,packages/contracts/src/coaching-plans.ts,apps/web/src/features/coaching/coaching-plans.tsx |
| LRN-07 | Complete a personal coaching milestone | services/api/src/coaching-plans/routes.ts,apps/web/src/app.tsx |
| JNY-01 | Configure canonical reasons, troubleshooting processes and actions | services/api/src/journey-config/routes.ts,services/api/src/journey-config/validation.ts,apps/web/src/features/journey-config/journey-config.tsx |
| JNY-02 | Review AI suggestions for journey configuration items | services/api/src/journey-config/routes.ts,packages/contracts/src/journey-config-enrichment.ts,apps/web/src/features/journey-config/journey-config.tsx |
| JNY-03 | Approve, merge or dismiss candidate discoveries | services/api/src/candidate-reviews/routes.ts,apps/web/src/features/candidate-reviews/candidate-reviews.tsx,apps/web/src/features/journey-config/journey-config.tsx |
| JNY-04 | Inspect journeys, canonical paths and journey analytics | services/api/src/journeys/routes.ts,apps/web/src/features/journeys/journeys.tsx,docs/journey-intelligence-rollout.md |
| JNY-05 | Create and progress an improvement opportunity | services/api/src/workspace/routes.ts,apps/web/src/features/operations/operations.tsx |
| JNY-06 | Capture comparable baseline and pilot measurements | services/api/src/workspace/routes.ts,packages/contracts/src/operations.ts,apps/web/src/features/operations/operations.tsx |
| JNY-07 | Review journey-informed coaching suggestions | services/api/src/journeys/routes.ts,apps/web/src/features/journeys/journeys.tsx,docs/journey-intelligence-rollout.md |
| JNY-08 | Record and inspect correlated survey responses | services/api/src/workspace/routes.ts,packages/contracts/src/operations.ts,apps/web/src/features/operations/operations.tsx |
| INS-01 | Use the Command Centre and follow work signals | services/api/src/app.ts,services/api/src/command-centre.ts,apps/web/src/features/command-centre/command-centre.tsx |
| INS-02 | Filter reports, inspect audit/knowledge results and export CSV | services/api/src/reports/routes.ts,apps/web/src/features/reports/reports.tsx,packages/contracts/src/reports.ts |
| INS-03 | Save and manage personal filters and report views | services/api/src/saved-views/routes.ts,packages/contracts/src/saved-views.ts,apps/web/src/features/reports/reports.tsx |
| INS-04 | Investigate performance and compliance risk | services/api/src/alerts/routes.ts,apps/web/src/features/compliance/compliance-risk.tsx,apps/web/src/features/intelligence/intelligence.tsx |
| INS-05 | Triage, assign, acknowledge and resolve alerts | services/api/src/alerts/routes.ts,services/api/src/alerts/dedupe.ts,apps/web/src/features/intelligence/intelligence.tsx |
| INS-06 | Create and maintain alert rules | services/api/src/alert-rules/routes.ts,services/api/src/alert-rules/evaluation-handler.ts,apps/web/src/features/alert-rules/alert-rules.tsx |
| INS-07 | Read notifications and inspect personal work | services/api/src/notifications/routes.ts,services/api/src/work/my-work-routes.ts,apps/web/src/features/notifications/notifications.tsx |
| INS-08 | Inspect the tenant mutation trail | services/api/src/mutation-events/routes.ts,services/api/src/mutation-events/trail.ts,apps/web/src/features/activity/activity.tsx |
| ASK-01 | Ask a grounded question and manage private conversations | services/api/src/ask-sentinel/routes.ts,services/api/src/ask-sentinel/tools.ts,apps/web/src/features/ask-sentinel/ask-sentinel.tsx |
| ASK-02 | Confirm or cancel an Ask Sentinel action proposal | services/api/src/ask-sentinel/routes.ts,services/api/src/ask-sentinel/actions.ts,apps/web/src/features/ask-sentinel/ask-sentinel.tsx |
| ASK-03 | Rate answers and conduct tenant/platform quality review | services/api/src/ask-sentinel/routes.ts,services/api/src/platform/routes.ts,apps/web/src/features/ask-sentinel/quality-review.tsx |
| ASK-04 | Review AI learning signals and activate tenant guidance | services/api/src/ai-learning/routes.ts,apps/web/src/features/ai-learning/ai-learning.tsx,packages/contracts/src/ai-learning.ts |
| ASK-05 | Run paired evaluations and approve or roll back a tenant AI pilot | services/api/src/ai-evaluation/routes.ts,apps/web/src/features/ai-learning/ai-learning.tsx,packages/contracts/src/ai-evaluation.ts |
| ASK-06 | Use live assist and record suggestion feedback | services/api/src/live-assist/routes.ts,services/api/src/live-assist/integration-routes.ts,apps/web/src/features/live-assist/live-assist.tsx |
| OPS-01 | Onboard, validate, rotate and deactivate a generic integration | services/api/src/integrations/management-routes.ts,services/api/src/transcription-results/routes.ts,apps/web/src/features/settings/integrations.tsx |
| OPS-02 | Connect providers and map source attribution | services/api/src/connectors/routes.ts,services/api/src/connectors/catalogue.ts,apps/web/src/features/settings/integrations.tsx |
| OPS-03 | Import provider conversations/calls and sync CRM outcomes | services/api/src/connectors/routes.ts,services/api/src/connectors/intercom-jobs.ts,services/api/src/connectors/salesforce.ts,apps/web/src/features/settings/integrations.tsx |
| OPS-04 | Configure outbound work notifications and reporting feeds | services/api/src/connectors/routes.ts,services/api/src/connectors/outbound.ts,apps/web/src/features/settings/integrations.tsx |
| OPS-05 | Manage LLM connections, defaults and test jobs | services/api/src/llm-connections/routes.ts,services/api/src/tenant-llm-settings/routes.ts,apps/web/src/features/settings/llm-connections.tsx,apps/web/src/features/labs/llm-testing.tsx |
| OPS-06 | Inspect tenant AI usage, limits and model pricing | services/api/src/llm-usage/routes.ts,services/api/src/llm-prices/routes.ts,apps/web/src/features/settings/usage.tsx,apps/web/src/features/settings/pricing.tsx |
| OPS-07 | Manage tenants, local members and platform activity | services/api/src/platform/routes.ts,services/api/src/platform/auth.ts,apps/web/src/features/platform/platform.tsx |
| OPS-08 | Manage platform models, price versions and tenant usage budgets | services/api/src/platform/routes.ts,services/api/src/llm-prices/resolver.ts,services/api/src/llm-usage/limits.ts,apps/web/src/features/platform/pricing.tsx |
| OPS-09 | Maintain global and tenant transcriber policy | services/api/src/platform/routes.ts,services/api/src/transcriber-policy/resolver.ts,docs/transcriber-managed-policy.md,apps/web/src/features/platform/transcriber-policy.tsx |
| OPS-10 | Inspect service health and recover queued processing | services/api/src/ai-jobs/outbox-publisher.ts,services/api/src/jobs/internal-worker.ts,services/api/src/jobs/routes.ts,services/ai-runtime/src/sentinel_ai/main.py,services/ai-runtime/src/sentinel_ai/dispatcher.py,services/ai-runtime/src/sentinel_ai/worker.py |
| OPS-11 | Apply retention and inspect cleanup failures | services/api/src/retention/cleanup.ts,services/api/src/server.ts,docs/transcriber-managed-policy.md |
| OPS-12 | Request a retrieval-index rebuild | services/api/src/retrieval/routes.ts,services/api/src/retrieval/embedding-index.ts,services/api/src/server.ts |
| OPS-13 | Inspect preview workspaces and supporting report records | services/api/src/workspace/routes.ts,apps/web/src/features/operations/operations.tsx,packages/contracts/src/operations.ts |
| XFN-01 | Trace an interaction from ingestion to measured improvement | services/api/src/app.ts,services/api/src/audits/routes.ts,services/api/src/coaching-plans/routes.ts,services/api/src/workspace/routes.ts |
| XFN-02 | Prepare a tenant for controlled operational use | README.md,services/api/src/app.ts,docs/journey-intelligence-rollout.md |
| XFN-03 | Connect published knowledge to scoring and learning | services/api/src/knowledge/routes.ts,services/api/src/audits/knowledge-selection.ts,services/api/src/reports/routes.ts |
| INT-12 | Create interaction metadata through the ingestion API | services/api/src/interactions/routes.ts,packages/contracts/src/interactions.ts |