Modules control which areas of GovFrame are available to each company. The configuration belongs to the tenant and is applied in two layers:
- Frontend: hides routes, quick access links, and components that do not apply.
- Backend: rejects queries and mutations for the deactivated module.
Existing data is not automatically deleted when a module is deactivated; it remains outside visible operation until the module is activated again, according to the company's policy.
Current catalog
| Module | Key | Group | What it enables | Declared dependencies |
|---|---|---|---|---|
| Business Terms | businessTerms |
Governance | Glossary, definitions, and semantic relationships. | — |
| Governance Roles | governanceRoles |
Governance | Owners, Stewards, and catalog responsibility roles. | — |
| Quality Rules | qualityRules |
Governance | Rules, dimensions, validations, and generated SQL SELECT. | Technical Dictionary, Repositories |
| Policies | policies |
Governance | Policies, processes, procedures, versions, and evidence. | — |
| Objectives and KPI | kpis |
Governance | Objectives, KPI/Key Results, measurements, reviews, and links. | — |
| Technical Dictionary | technicalDictionary |
Architecture | Tables, fields, descriptions, and associations with attributes. | Repositories |
| Data Repositories | dataRepositories |
Architecture | Analytical/operational databases or platforms, connections, and metadata. | — |
| Systems | systems |
Architecture | Source, consumption, or support systems in the ecosystem. | — |
| Unstructured Data | unstructuredData |
Architecture | Unstructured sources and assets associated with the taxonomy. | — |
| Data Assets | dataAssets |
Architecture | Datasets, APIs, reports, and other governable assets. | — |
| Data Products | dataProducts |
Delivery | Products composed of assets, contracts, and responsibility. | Data Assets, Contracts |
| Data Contracts | dataContracts |
Delivery | Commitments, attributes, rules, fields, terms, systems, and consumers. | Data Assets, Technical Dictionary, Quality Rules |
| Governance Workflows | workflows |
Governance | Cases, stages, tasks, approvals, SLA, evidence, and exceptions. | — |
| Relationship Explorer | relationshipExplorer |
Experience | Overview, Impact, and Technical Detail of the ecosystem. | Terms, Quality Rules, Technical Dictionary |
The configuration uses true/false by key. Modules are created active by default in the initial configuration, unless the company establishes a different policy during setup.
Dependencies and recommended order
For a phased implementation:
1. Taxonomy and access
2. Data Repositories
3. Technical Dictionary
4. Business Terms
5. Quality Rules
6. Assets and Products
7. Contracts
8. Workflows and requests
9. KPI, Policies, and Relationship Explorer
Important relationships:
- The Technical Dictionary is not useful without a registered Repository.
- Quality Rules can exist without generated SQL, but generating SQL requires valid associations with physical fields and a configured dialect.
- A Contract can store attributes, rules, fields, terms, and systems; therefore, it is advisable to activate the related modules.
- A Product is composed of Assets and can be related to Contracts.
- The Explorer can be opened with a taxonomy, but its technical view provides more value when Terms, Rules, and the Technical Dictionary exist.
What happens when a module is deactivated
| Situation | Expected behavior |
|---|---|
| Direct module route | The application displays a deactivated-module state and does not allow operations. |
| Menu or quick access | The access link disappears; no empty, non-functional block is left behind. |
| Module tRPC query | The backend rejects it through module validation. |
| Module mutation | The backend rejects it even if an attempt is made to invoke it manually. |
| Previously created data | It is retained; the administration screen reports the impact before confirmation. |
| Deactivated dependency | The function that depends on it may be hidden, limited, or have operations rejected, according to the procedure contract. |
| Reactivation | Visibility and operation become available again, subject to roles, scope, and data status. |
Deactivating a module does not, by itself, revoke tenant roles, but a sensitive change to a role or scope must invalidate sessions in accordance with the security policy.
Configure modules
Module management is performed from company administration:
- Select the active company.
- Open Modules.
- Review the group and description for each module.
- Review the impact: the platform shows how many records will be hidden.
- Confirm the change.
- Verify the menu, routes, and module responses.
The person configuring modules must have platform administration capability or equivalent authorization. The end user cannot activate a module by modifying parameters in the browser.