¶ System Configuration
At a Glance
Module purpose: Document-flow and accounting-period machinery — approval workflows, accounting periods, dimensions, document numbering, app config, menu · Audience: Sysadmin, Workflow Administrator, Finance (period close) · Key entities/tables:tb_workflow,tb_period,tb_dimension,tb_config_running_code,tb_application_config,tb_menu· Sub-pages: 11
¶ 1. Overview
System Configuration is the umbrella for the document-flow and accounting-period machinery that every transactional module depends on. Workflows define multi-stage approval routing with per-stage actions, recipients, and field visibility. Periods define the accounting calendar and gate which dated postings are allowed. Dimensions are the user-extensible custom-field system threaded through every transactional table. Running codes drive document numbering. Application config is the generic key-value escape hatch. The menu registry feeds the app shell.
The six entities here sit between master-data (the static catalogues — units, vendors, currencies) and the runtime access-control layer (users, roles, permissions). Where master data answers what a transaction is referencing, system configuration answers how it should flow, when it should post, and what extra dimensions it should carry. Most rows are owned and edited by Sysadmin; a few — workflow stages and dimension catalogues in particular — see day-to-day adjustment from a designated Workflow Administrator.
All six entities live in the tenant schema. None of them have a platform counterpart — they describe per-property document flow, so each tenant gets its own copy.
¶ 2. Audience
Sysadmin. Workflow definition may be delegated to a Workflow Administrator persona (typically the Finance Manager or Procurement Manager) for day-to-day stage / approver maintenance. Finance owns period close.
¶ 3. Entity List
| Entity | Purpose | Managed by |
|---|---|---|
| workflow | Multi-stage approval workflows with per-stage actions, recipients, field visibility | Sysadmin / Workflow Admin |
| period | Accounting periods (open/closed/locked) and per-period inventory snapshots | Sysadmin / Finance |
| dimension | User-defined custom fields with per-place display matrix | Sysadmin |
| running-code | Document-number patterns per document type | Sysadmin |
| application-config | Tenant-wide key-value settings + per-user preference overrides | Sysadmin |
| menu | Navigation registry rendered by the app shell | Sysadmin |
| query-dataset | SQL Workbench — author tenant views, stored procedures, and functions as reusable data sources | Sysadmin |
| dashboard-dataset | Read-only catalog of code-registered data feeds available to dashboard widgets | Sysadmin |
| config-email | Per-BU SMTP profile for outbound system email — workflow notifications, scheduled reports, password reset | Sysadmin |
| document | Tenant-scoped file-storage registry — upload, list, download, and delete for documents attached to transactional records | Sysadmin |
| doc-version | Optimistic-concurrency doc_version guard — clients echo the version on save or get a 409 |
Engineering |
¶ 4. Cross-Module Dependencies
- purchase-request requires system-config/workflow (PR approval routing), system-config/running-code (PR number), system-config/dimension (PR header/detail tagging).
- purchase-order requires system-config/workflow (PO approval routing where policy demands it), system-config/running-code (PO number), system-config/dimension (PO header/detail tagging).
- good-receive-note requires system-config/period (posting-date guard), system-config/running-code (GRN number), system-config/dimension (GRN header/detail tagging), system-config/workflow (optional approval).
- store-requisition requires system-config/workflow (SR approval routing — canonical multi-stage workflow), system-config/running-code (SR number), system-config/dimension (issue tagging — project / event).
- inventory-adjustment requires system-config/period (posting-date guard), system-config/running-code (IA / SI / SO numbers), system-config/dimension (stock-in / stock-out tagging), system-config/workflow (optional approval).
- inventory requires system-config/period (period boundaries on every movement) and system-config/dimension (cost-centre allocation on transfer).
- costing requires system-config/period (the cost-close engine writes
tb_period_snapshot). - physical-count requires system-config/period (count documents are frozen against a period), system-config/running-code (count document number), system-config/workflow (variance approval).
- spot-check requires system-config/running-code (document number), system-config/workflow (variance approval).
- vendor-pricelist requires system-config/running-code (pricelist reference), system-config/workflow (optional publish-approval), system-config/dimension (pricelist tagging).
- system-config/application-config and system-config/menu are referenced by every module — application-config tunes feature toggles and defaults, menu controls navigation visibility.
¶ 5. References
- Prisma tenant:
../carmen-turborepo-backend-v2/packages/prisma-shared-schema-tenant/prisma/schema.prisma. - carmen/docs:
../carmen/docs/workflow-permissions-system.md(workflow role types and the permission matrix consumed by system-config/workflow). - Seed data:
../carmen-turborepo-backend-v2/packages/prisma-shared-schema-tenant/prisma/seed-data-a01/—tb_workflow.json,tb_config_running_code.json,tb_application_config.json. - Design spec:
.specs/2026-05-16-master-config-design.md. - Plan:
.specs/2026-05-16-master-config-plan.md.