Os módulos controlam quais áreas do GovFrame estão disponíveis para cada empresa. A configuração pertence ao tenant e é aplicada em duas camadas:
- Frontend: oculta rotas, acessos rápidos e componentes que não correspondem.
- Backend: rejeita consultas e mutações do módulo desativado.
Os dados existentes não são excluídos automaticamente ao desativar um módulo; ficam fora da operação visível até que o módulo seja ativado novamente, de acordo com a política da empresa.
Catálogo atual
| Módulo | Chave | Grupo | O que habilita | Dependências declaradas |
|---|---|---|---|---|
| Termos de negócio | businessTerms |
Governança | Glossário, definições e relações semânticas. | — |
| Papéis de governança | governanceRoles |
Governança | Responsáveis pelos dados, Curadores de dados e perfis de responsabilidade do catálogo. | — |
| Regras de qualidade | qualityRules |
Governança | Regras, dimensões, validações e SQL SELECT gerado. | Dicionário técnico, Repositórios |
| Políticas | policies |
Governança | Políticas, processos, procedimentos, versões e evidências. | — |
| Objetivos e KPI | kpis |
Governança | Objetivos, KPI/Key Results, medições, revisões e vínculos. | — |
| Dicionário técnico | technicalDictionary |
Arquitetura | Tabelas, campos, descrições e associações com atributos. | Repositórios |
| Repositórios de dados | dataRepositories |
Arquitetura | Bancos de dados ou plataformas analíticas/operacionais, conexões e metadados. | — |
| Sistemas | systems |
Arquitetura | Sistemas de origem, consumo ou suporte do ecossistema. | — |
| Dados não estruturados | unstructuredData |
Arquitetura | Fontes e ativos não estruturados associados à taxonomia. | — |
| Ativos de dados | dataAssets |
Arquitetura | Datasets, APIs, relatórios e outros ativos governáveis. | — |
| Produtos de dados | dataProducts |
Entrega | Produtos compostos por ativos, contratos e responsabilidades. | Ativos de dados, Contratos |
| Contratos de dados | dataContracts |
Entrega | Compromissos, atributos, regras, campos, termos, sistemas e consumidores. | Ativos de dados, Dicionário técnico, Regras de qualidade |
| Workflows de governança | workflows |
Governança | Casos, etapas, tarefas, aprovações, SLA, evidências e exceções. | — |
| Explorador de relações | relationshipExplorer |
Experiência | Visão geral, Impacto e Detalhe técnico do ecossistema. | Termos, Regras de qualidade, Dicionário técnico |
A configuração usa true/false por chave. Os módulos são criados ativos por padrão na configuração inicial, a menos que a empresa estabeleça outra política durante a criação.
Dependências e ordem recomendada
Para uma implementação progressiva:
1. Taxonomia e acesso
2. Repositórios de dados
3. Dicionário técnico
4. Termos de negócio
5. Regras de qualidade
6. Ativos e Produtos
7. Contratos
8. Workflows e solicitações
9. KPI, políticas e Explorador de relações
Relações importantes:
- Não há Dicionário técnico útil sem um Repositório registrado.
- As Regras de qualidade podem existir sem SQL gerado, mas, para gerar SQL, exigem associações válidas a campos físicos e um dialeto configurado.
- Um Contrato pode armazenar atributos, regras, campos, termos e sistemas; por isso, convém ativar os módulos relacionados.
- Um Produto é composto por Ativos e pode estar relacionado a Contratos.
- O Explorador pode ser aberto com uma taxonomia, mas sua visão técnica agrega mais valor quando existem Termos, Regras e Dicionário técnico.
O que acontece ao desativar um módulo
| Situação | Comportamento esperado |
|---|---|
| Rota direta do módulo | A aplicação exibe um estado de módulo desativado e não permite operar. |
| Menu ou acesso rápido | O acesso desaparece; nenhum bloco vazio sem função é exibido. |
| Consulta tRPC do módulo | O backend a rejeita por meio da validação do módulo. |
| Mutação do módulo | O backend a rejeita mesmo que haja uma tentativa de invocá-la manualmente. |
| Dados criados anteriormente | São preservados; a tela de administração informa o impacto antes da confirmação. |
| Dependência desativada | A função que depende dela pode ficar oculta, limitada ou rejeitar operações, de acordo com o contrato do procedimento. |
| Reativação | A visibilidade e a operação voltam a estar disponíveis, sujeitas a papéis, escopo e estado dos dados. |
Desativar um módulo não revoga, por si só, os papéis do tenant, mas uma alteração sensível de papel ou escopo deve invalidar sessões conforme a política de segurança.
Configurar módulos
A gestão é feita na administração de empresas:
- Selecione a empresa ativa.
- Abra Módulos.
- Revise o grupo e a descrição de cada módulo.
- Consulte o impacto: a plataforma mostra quantos registros ficarão ocultos.
- Confirme a alteração.
- Verifique o menu, as rotas e as respostas do módulo.
A pessoa que configura módulos deve ter capacidade de administração da plataforma ou autorização equivalente. O usuário final não pode ativar um módulo alterando parâmetros no navegador.