¶ Estudo para Levantamento de onde no Sistema Governa utiliza as informações da tabela de CBO
| Data de elaboração | 25/11/2024 |
| Responsável pelo estudo | Rodrigo Stefano Sales Nascimento (Assessor) |
| Equipe do estudo | TROPA DE ELITE |
| Alvo | Sistema Governa |
| Origem | Realizar um levantamento de onde no sistema Governa utiliza as informações da tabela de CBO |
| Objetivo | Identificar no sistema Governa onde CBO é utilizado |
¶ 1 - Do Objetivo
O objetivo deste estudo é identificar todos os pontos no sistema Governa onde a tabela de CBO (Classificação Brasileira de Ocupações) é utilizada. Essa análise é necessária porque foi constatado que a tabela possui registros duplicados, o que pode causar inconsistências no sistema. O levantamento permitirá mapear as referências no código que utilizam o ID do CBO ou outros dados da tabela, para que possamos:
- Avaliar o impacto da exclusão dos registros duplicados em diferentes áreas do sistema.
- Garantir que a exclusão não comprometa funcionalidades ou integridade dos dados.
¶ 2 - Verificação, Localização e Utilização no Sistema
No sistema Governa, a tabela CBO armazena informações relacionadas à Classificação Brasileira de Ocupações. Ocorre que, o cliente revelou que existem registros duplicados, apresentando o mesmo código ou descrição, o que pode causar:
- Problemas de Consistência: Ambiguidade em consultas e relatórios que dependem de registros únicos.
- Impacto Funcional: Erros em validações, associações incorretas, ou falhas no preenchimento de campos em formulários e listas.
- Riscos Operacionais: Comprometimento da integridade de dados e interrupções em processos dependentes do CBO.
¶ 2.1 - Verificação no Banco de Dados
Para identificar duplicidades e entender como a tabela CBO é utilizada no sistema, foram realizadas consultas específicas no banco de dados Governa. As buscas foram divididas em três etapas: duplicidade no código CBO, duplicidade na descrição, e identificação de tabelas que fazem referência à tabela CBO.
¶ 2.1.1 - Duplicidade no Código CBO
A duplicidade no campo cbo foi verificada utilizando a consulta abaixo. A lógica considera valores normalizados (removendo espaços em excesso e ignorando diferenças entre maiúsculas e minúsculas):
SELECT
UPPER(LTRIM(RTRIM(cbo))) AS cbo_repetido,
COUNT(*) AS quantidade
FROM
[Governa].rh.cbo
GROUP BY
UPPER(LTRIM(RTRIM(cbo)))
HAVING
COUNT(*) > 1
ORDER BY
quantidade DESC, cbo_repetido;
Resultado:
- Foram identificados 10 registros com duplicidade no campo
cboconforme observa-se no print abaixo:
¶ 2.1.2 - Duplicidade na Descrição
Para verificar duplicidade no campo descricao, foi utilizada a seguinte consulta:
SELECT
UPPER(LTRIM(RTRIM(descricao))) AS descricao_normalizada,
COUNT(*) AS quantidade
FROM
[Governa].rh.cbo
GROUP BY
UPPER(LTRIM(RTRIM(descricao)))
HAVING
COUNT(*) > 1
ORDER BY
quantidade DESC, descricao_normalizada;
Resultado:
- Foram identificados 25 registros com duplicidade no campo
descricaoconforme observa-se no print abaixo:
¶ 2.1.3 - Identificação de Tabelas que Fazem Referência à Tabela CBO
Para identificar todas as tabelas no banco de dados Governa que fazem referência à tabela CBO (via chaves estrangeiras), a consulta abaixo foi utilizada:
SELECT
fk.name AS foreign_key_name,
tp.name AS tabela_referenciada,
cp.name AS coluna_referenciada,
tr.name AS tabela_que_referencia,
cr.name AS coluna_que_referencia
FROM
[Governa].sys.foreign_keys AS fk
INNER JOIN
[Governa].sys.foreign_key_columns AS fkc ON fk.object_id = fkc.constraint_object_id
INNER JOIN
[Governa].sys.tables AS tp ON fkc.referenced_object_id = tp.object_id
INNER JOIN
[Governa].sys.columns AS cp ON fkc.referenced_object_id = cp.object_id AND fkc.referenced_column_id = cp.column_id
INNER JOIN
[Governa].sys.tables AS tr ON fkc.parent_object_id = tr.object_id
INNER JOIN
[Governa].sys.columns AS cr ON fkc.parent_object_id = cr.object_id AND fkc.parent_column_id = cr.column_id
WHERE
tp.name = 'cbo' AND SCHEMA_NAME(tp.schema_id) = 'rh'
ORDER BY
tabela_que_referencia, coluna_que_referencia;
Resultado:
- A consulta retornou apenas um resultado, informando que apenas a tabela
cargo_mensalutiliza registros da tabelacbopor meio da colunaid_cboconforme observa-se no print abaixo:
¶ 2.2 - Metodologia para Levantamento de Classes que Utilizam a Tabela CBO
Para identificar todas as classes que utilizam a tabela CBO no sistema Governa, foi adotada uma abordagem sistemática para análise do código-fonte. O objetivo é mapear os pontos de acesso à entidade Cbo, garantindo que todas as dependências sejam identificadas para avaliação de impactos.
¶ Metodologia Utilizada
-
Busca por Referências Diretas:
- Foi realizada uma busca no código-fonte por todas as ocorrências do termo
Cbo(nome da entidade) ecbo(caso de consultas SQL ou referências específicas no código). - Foi utilizada a ferramenta de busca da própria plataforma IDE IntelliJ Idea.
- Foi realizada uma busca no código-fonte por todas as ocorrências do termo
-
Análise de Classes Envolvidas:
- Foram inspecionadas as classes que contêm referências à entidade Cbo, como:
- Repositórios ou DAOs que fazem a persistência e recuperação de dados.
- Serviços que implementam lógica de negócios relacionada à tabela CBO.
- Controladores que expõem APIs ou funcionalidades dependentes da entidade.
- Beans Gerenciados (Managed Beans) utilizados em camadas de interface.
- Foram inspecionadas as classes que contêm referências à entidade Cbo, como:
¶ 2.3 - Classes Identificadas
Abaixo, estão as classes identificadas durante o estudo, que possuem relação com CBO:
- Arquivo:
manterContribuinteIndividual.xhtml- Caminho:
src/main/webapp/usuario/cadastro/manterContribuinteIndividual.xhtml. - Uso:
- Exibe a lista de CBOs para seleção nos formulários de criação, edição ou visualização de um contribuinte individual.
- A lista é alimentada por
cargoMensalMB.listaCbo, que busca os registros da tabela CBO.
- Elementos Relevantes:
- Campo de Seleção (
p:selectOneMenu):- Mostra a lista de CBOs carregada por
cargoMensalMB.listaCbo. - Cada item da lista exibe o código (
cbo) e a descrição do CBO (descricao).
- Mostra a lista de CBOs carregada por
- Botão de Atualização (
gov:botaoIconeAtualizar):- Invoca o método
cargoMensalMB.carregarListaCbo()para recarregar dinamicamente a lista de CBOs na interface.
- Invoca o método
- Link de Gerenciamento (
gov:botaoIconeLink):- Direciona para a página de manutenção de registros na tabela CBO.
- Campo de Seleção (
- Caminho:
- Classe:
CargoMensalMB- Caminho:
src/main/java/br/com/governa/rh/comum/negocio/managedbean/CargoMensalMB.java. - Uso:
- Contém o método
carregarListaCbo(), responsável por buscar todos os registros da tabela CBO através decboBO.buscarTodos()e armazená-los na listalistaCbo. - O método é invocado automaticamente no método
initialize()após a inicialização do bean.
- Contém o método
- Dependências:
cboBO: Classe que implementa a lógica do métodobuscarTodos()para recuperar registros de CBO.
- Caminho:
- Classe:
CargoMensalBO-
Caminho:
src/main/java/br/com/governa/rh/negocio/bo/CargoMensalBO.java. -
Uso: Implementa a lógica de negócios para a entidade CargoMensal, incluindo validações, salvamento, exclusão e consultas de registros relacionados.
-
Referência à Tabela CBO:
- A tabela CBO é referenciada como parte das validações e manipulação de registros de cargos mensais.
-
Métodos Relevantes:
salvar(CargoMensal cargoMensal):- Durante o processo de salvamento, valida se o atributo
cargoMensal.getCbo()é nulo ou inválido.
- Durante o processo de salvamento, valida se o atributo
validarCamposObrigatorios(CargoMensal cargoMensal):- Este método centraliza as validações obrigatórias, incluindo a verificação da relação com o CBO.
-
Impacto no Estudo:
- A classe interage indiretamente com a tabela CBO, validando a presença e integridade de registros associados como parte das operações de cargos mensais.
- Qualquer alteração nos registros da tabela CBO pode impactar os processos de salvamento e edição de cargos mensais.
-
- Interface:
ICboBO- Caminho:
src/main/java/br/com/governa/rh/comum/negocio/interfaces/ICboBO.java. - Uso: Define os contratos para manipulação da tabela CBO. Entre os métodos relacionados, destacam-se:
buscarTodos(): Recupera todos os registros da tabela CBO.salvar(Cbo cbo): Persiste novos registros na tabela.excluir(Cbo cbo): Exclui um registro, considerando as regras de integridade.
- Caminho:
- Classe:
CboBO- Caminho:
src/main/java/br/com/governa/rh/negocio/bo/CboBO.java. - Uso: Implementa a interface
ICboBOe fornece a lógica de negócio para manipulação da tabela CBO - Métodos Relevantes:
buscarTodos(): Utiliza o repositóriocboPersistpara buscar todos os registros ordenados por descrição.salvar(Cbo cbo): Verifica duplicidade antes de salvar um registro. Contém validação para não permitir duplicidade no campo cbo.excluir(Cbo cbo): Exclui um registro, garantindo integridade de dados.buscar(long id): Busca um registro específico por ID.buscarTodos(Cbo cbo): Realiza uma busca com filtros, utilizando descrição e código.
- Dependências:
cboPersist: Repositório responsável por realizar operações diretas com o banco de dados para a tabela CBO.
- Caminho:
- Classe:
ICboRepositorio- Caminho:
src/main/java/br/com/governa/rh/comum/negocio/interfaces/ICboBO.java. - Uso: Define os contratos para manipulação da tabela CBO. Entre os métodos relacionados, destacam-se:
buscarTodos(): Recupera todos os registros da tabela CBO.salvar(Cbo cbo): Persiste novos registros na tabela.excluir(Cbo cbo): Exclui um registro, considerando as regras de integridade.
- Caminho:
- Classe:
ICboRepositorio- Caminho:
src/main/java/br/com/governa/rh/persistencia/repositorio/ICboRepositorio.java. - Uso: Responsável por realizar operações diretas no banco de dados relacionadas à tabela CBO. Entre os métodos destacados, estão:
findByCbo(String cbo): Busca registros com o valor exato decbo(ignora maiúsculas e minúsculas) e os ordena pelo campocbo.findAllOrderByDescricao(): Retorna todos os registros ordenados pelo campodescricao.findByDescricaoLikeAndCboOrderByDescricao(String descricao, String cbo): Realiza buscas filtradas pordescricaoecbousandoLIKE, ordenando os resultados pela descrição.findUltimoCodigo(): Obtém o maior valor deidna tabela CBO.
- Caminho:
- Classe:
CboBuilder- Caminho:
src/main/java/br/com/governa/rh/teste/builder/CboBuilder.java. - Uso: Classe utilitária utilizada para criar instâncias de
Cbo, provavelmente em cenários de teste ou construção dinâmica de objetos. - Métodos Relevantes:
construir():- Cria e retorna uma instância de
Cbocom valores gerados dinamicamente:- Descrição (
descricao):"Descricao CBO " + time(timestamp atual concatenado). - Código (
cbo):"Cod " + substring do timestamp.
- Descrição (
- Cria e retorna uma instância de
- Impacto no Estudo:
- Esta classe não representa uma interação direta com o banco de dados ou lógica de negócios relacionada à tabela CBO, mas é útil para cenários de testes e validações.
- Caminho:
- Classe:
CboMB-
Caminho:
src/main/java/br/com/governa/rh/web/managedbean/CboMB.java. -
Uso: Gerencia a interação com a tabela CBO na interface do sistema, permitindo a criação, edição, visualização, pesquisa e exclusão de registros relacionados ao CBO.
-
Métodos Relevantes:
carregarListaCbo():- Carrega uma lista de CBOs com base em filtros definidos em
cboFiltrousando o métodocboBO.buscarTodos(Cbo cbo). - Exibe uma mensagem caso nenhum registro seja encontrado.
- Carrega uma lista de CBOs com base em filtros definidos em
abrirVisualizar(Cbo cbo):- Configura o CBO selecionado para visualização.
abrirNovo():- Prepara um novo objeto CBO para cadastro.
abrirEditar(Cbo cbo):- Configura um objeto CBO para edição, buscando os dados pelo ID via
cboBO.buscar(id).
- Configura um objeto CBO para edição, buscando os dados pelo ID via
salvar():- Valida permissões e salva um registro de CBO usando
cboBO.salvar(cbo), tratando exceções de duplicidade, permissões ou campos obrigatórios ausentes.
- Valida permissões e salva um registro de CBO usando
excluir():- Valida permissões e exclui um registro de CBO usando
cboBO.excluir(cbo), tratando exceções de integridade de dados e permissões.
- Valida permissões e exclui um registro de CBO usando
-
Dependências:
ICboBO: Interface que define os contratos para as operações de manipulação de registros da tabela CBO.- Propriedades:
listaCbo: Armazena a lista de CBOs carregados para exibição ou manipulação.cboFiltro: Objeto usado para definir os critérios de pesquisa de CBOs.
-
Impacto no Estudo:
- Esta classe é crucial para o gerenciamento direto da tabela CBO pela interface do sistema, permitindo a manipulação completa dos registros e sendo um ponto central de referência no sistema.
-
- Interface:
ISefipViewRepositorio-
Caminho:
src/main/java/br/com/governa/rh/persistencia/repositorio/ISefipViewRepositorio.java. -
Uso: Repositório para acessar os registros da visão SefipView, incluindo informações detalhadas de funcionários e dados relacionados.
-
Referência à Tabela CBO:
- A consulta SQL em
buscarRegistrosSefipViewinclui o camposefip.cbona seleção dos dados. Este campo é utilizado para obter o código CBO associado a um funcionário, permitindo que ele seja exibido ou processado em relatórios.
- A consulta SQL em
-
Método Relevante:
buscarRegistrosSefipView(...):- Recupera uma lista de registros da visão SefipView, incluindo o código CBO, com base em múltiplos parâmetros como
mesReferencia,empresaId,idAdministracao, e listas de classificação e vínculos. - Faz uso extensivo de filtros e agrupamento para otimizar a consulta.
- Recupera uma lista de registros da visão SefipView, incluindo o código CBO, com base em múltiplos parâmetros como
-
Impacto no Estudo:
- Esta interface utiliza o campo CBO para associar e exibir informações no contexto da visão SefipView. Alterações na tabela CBO podem impactar diretamente a exibição ou processamento desses dados.
-
- Classe:
RaisVisaoBuilder-
Caminho:
src/main/java/br/com/governa/rh/teste/visao/builder/RaisVisaoBuilder.java. -
Uso: Classe utilitária para construção de objetos da visão RaisVisao, provavelmente usada em testes ou geração de dados fictícios para validação.
-
Referência à Tabela CBO:
-
O campo CBO é atribuído como parte da construção de objetos da entidade
RaisServidorDetalheVisao. -
Código do trecho relevante:
servidor.setCbo(("" + new Random().nextInt()).replace(".", ""));- Esta atribuição gera um valor aleatório para o campo
cbo, simulando dados fictícios.
- Esta atribuição gera um valor aleatório para o campo
-
-
Métodos Relevantes:
-
construir():- Método principal que cria um objeto
RaisVisaocom cabeçalhos, servidores, e rodapés. No corpo do método, a lista de servidores é preenchida com objetos deRaisServidorDetalheVisao, incluindo valores simulados para o campocbo.
- Método principal que cria um objeto
-
construirLista(int i):- Cria instâncias de
RaisServidorDetalheVisaocom valores aleatórios, incluindo para o campo CBO.
- Cria instâncias de
-
-
Impacto no Estudo:
- Esta classe utiliza o campo CBO apenas para gerar dados fictícios em cenários de teste, sem interação direta com a tabela no banco de dados.
- Não há impacto direto no uso funcional da tabela CBO no sistema.
-
¶ 3 - Impacto no Sistema
A presença de registros duplicados na tabela CBO afeta diretamente a tabela dependente cargo_mensal, que utiliza a chave estrangeira fk_cargo_mensal_cbo para referenciar o campo id da tabela CBO.
¶ 3.1 - Impacto nas Operações
-
Confusão nas Listagens:
- Duplicidades no campo
descricaopodem gerar opções redundantes em interfaces como menus de seleção ou relatórios, dificultando a escolha correta do registro.
- Duplicidades no campo
-
Problemas em Tabelas Dependentes:
-
Registros duplicados em CBO podem causar ambiguidade na tabela
cargo_mensal, já que diferentes registros podem referenciar códigos CBO duplicados. -
A exclusão de registros duplicados na tabela CBO exige atualização cuidadosa da tabela
cargo_mensal, para evitar referências inválidas.
-
¶ 3.2 - Dificuldades na Manutenção
-
Correção de Dados:
- Identificar o registro correto na tabela CBO e ajustar todas as referências na tabela
cargo_mensalé um processo trabalhoso e suscetível a erros.
- Identificar o registro correto na tabela CBO e ajustar todas as referências na tabela
-
Integridade dos Dados:
- A falta de controle das duplicidades compromete a consistência da base de dados, dificultando análises confiáveis.
- A falta de controle das duplicidades compromete a consistência da base de dados, dificultando análises confiáveis.
¶ 4 - Proposta de Solução
Para resolver os problemas de duplicidade na tabela CBO e garantir a consistência dos dados no sistema Governa, propomos as seguintes soluções:
¶ 4.1 - Correção dos Dados Duplicados
¶ 4.1.1 - Identificação de Registros a Serem Mantidos:
-
Utilizar as consultas de duplicidade (código CBO, descrição, e combinação) para identificar registros duplicados.
-
Solicitar ao cliente que escolha qual registro será mantido.
¶ 4.1.2 - Atualização de Referências na Tabela cargo_mensal:
- Atualizar os registros da tabela cargo_mensal que fazem referência a duplicatas na tabela CBO.
¶ 4.1.3 - Remoção de Registros Duplicados:
- Excluir os registros duplicados:
¶ 4.2 - Implementação de Prevenção de Novas Duplicidades
-
Adição de Restrições de Unicidade no Banco de Dados:
- Configurar restrições de unicidade no banco de dados para os campos cbo e descricao. Isso garantirá que novas duplicidades sejam bloqueadas diretamente no nível do banco.
- Configurar restrições de unicidade no banco de dados para os campos cbo e descricao. Isso garantirá que novas duplicidades sejam bloqueadas diretamente no nível do banco.
-
Atualização da Entidade CBO:
- Garantir que o campo cbo seja único.
- Garantir que o campo descricao também seja único.
¶ 4.3 - Melhorias no Sistema
-
Refinamento do Método salvar(Cbo cbo) na Classe CboBO:
- Adicionar validações para verificar duplicidades nos campos cbo e descricao antes de salvar ou atualizar registros. Isso reforça as regras de unicidade já configuradas no banco.
- Adicionar validações para verificar duplicidades nos campos cbo e descricao antes de salvar ou atualizar registros. Isso reforça as regras de unicidade já configuradas no banco.
¶ 5 - Histórias de Usuário
¶ 5.1 - Identificação e Correção de Registros Duplicados
| História - O quê | Eu, dev, preciso identificar e corrigir duplicidades nos registros da tabela CBO. |
| Por quê? | Para garantir que os dados da tabela CBO sejam consistentes e para evitar ambiguidades na tabela cargo_mensal. |
| Regras e Validações | * Identificar registros duplicados nos campos cbo e descricao por meio de consultas no banco de dados. * Atualizar as referências na tabela cargo_mensal para apontarem para o registro correto antes de excluir os registros duplicados. |
¶ 5.2 - Prevenção de Novas Duplicidades
| História - O quê | Eu, dev, preciso implementar restrições de unicidade para os campos cbo e descricao na tabela CBO no banco de dados. |
| Por quê? | Para garantir que novos registros duplicados não sejam inseridos, mantendo a consistência dos dados. |
| Regras e Validações | * O banco de dados deve rejeitar a inserção ou atualização de registros com valores duplicados nos campos cbo ou descricao. * A restrição deve ser aplicada após a deduplicação dos registros existentes. |
¶ 5.3 - Atualização da Entidade CBO
| História - O quê | Eu, dev, preciso garantir que os campos cbo e descricao sejam únicos na entidade Cbo.java. |
| Por quê? | Para alinhar o modelo da aplicação às restrições do banco e reforçar a prevenção de duplicidades. |
| Regras e Validações | * Adicionar restrições de unicidade para os campos cbo e descricao na classe Cbo.java. * As alterações na entidade devem refletir as regras de unicidade já configuradas no banco. |
¶ 5.4 - Melhorias no Método que salva CBO
| História - O quê | Eu, dev, preciso aprimorar o método salvar da classe CboBO para validar duplicidades antes de salvar ou atualizar registros. |
| Por quê? | Para garantir que nenhuma duplicidade seja inserida no banco. |
| Regras e Validações | * O método deve verificar, antes de salvar ou atualizar, se já existem registros com o mesmo valor nos campos cbo ou descricao. * Caso seja identificada uma duplicidade, o sistema deve bloquear a operação e exibir uma mensagem de erro clara. |