# Unidade Federativa - UF
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Unidade Federativa - UF tem como objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de visualização, cadastro, edição e exclusão de Unidades Federativas no sistema.
# FINALIDADE
Nesta funcionalidade devemos realizar as seguintes ações:
Visualização: Consulte os detalhes das Unidades Federativas cadastradas.
Cadastro: Adicione novas Unidades Federativas ao sistema.
Edição: Modifique as informações das Unidades Federativas existentes.
Exclusão: Remova Unidades Federativas.
Abaixo podemos acompanhar o caminho de acesso e o fluxo de cada validação feita pelo sistema ou definição feita pelo usuário.
# PRINCIPAIS CAMINHOS
Login ou acesso ao sistema > Página Inicial > Workspace Enterprise > Dashboard > Segmentação Geográfica > Estados > Unidade Federativa.
# FUNCIONALIDADES
Ao acessar o item "Estados" no menu do workspace de Enterprise, você visualizará a tela de Unidade Federativa, que apresenta as seguintes estruturas e ações:
# Lista de Unidades Federativas
# Sem Resultados
Caso nenhum estado seja encontrado, o sistema exibirá a mensagem: "Nenhuma UF disponível para exibição." Isso indica que não há estados cadastrados. Para iniciar o processo, clique em "Novo" para acessar a tela de cadastro de unidade federativa.
# Com Resultados
Ao clicar em "Unidade Federativa - UF", será exibido a tela com a lista das Unidades Federativas cadastradas, apresentando os seguintes dados de visualização: Código do IBGE, sigla e nome da UF.
Para localizar uma UF específica, clique no botão "Adicionar Filtro" na tabela e aplique os critérios desejados. Os resultados serão atualizados na lista conforme os filtros aplicados.

# Novo – Cadastro de UF
Ao clicar no botão “Novo” na tela de "Lista de Unidades Federativas (UF)", será exibido uma janela de formulário de cadastro para adicionar uma nova Unidade Federativa ao sistema. Este formulário contém os seguintes campos:
Código do IBGE: Digite o número do código. O campo permite até 2 caracteres.
Sigla: Digite a sigla da Unidade Federativa. O campo permite até 2 caracteres. Ex: SP, PE etc.
Nome da UF: Digite o nome da nova Unidade Federativa. O campo permite até 40 caracteres.
Se algum campo obrigatório não for informado, no momento de salvar os dados do cadastro “Erros validação” será apresentada com a relação de obrigatoriedades não cumpridas nos respectivos campos.
Após preencher todos os campos, clique no botão “Salvar”. Em seguida, o sistema exibirá uma caixa de diálogo de confirmação do cadastro com as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cadastro será efetuado.
Confirmar: Se optar por "Confirmar", o sistema concluirá o cadastro.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro realizado com sucesso!".
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Unidade Federativa, já com a UF cadastrada na lista.

# Ações - UF
# Editar
Selecione a Unidade Federativa na tabela: Basta marcar a caixa de seleção disponível na tabela;
Acesse as Ações: Clique no botão "Ações".
Escolha Editar: Selecione a opção "Editar" na lista de valores exibida após clicar em ações.
Unidade Federativa: Após clicar em editar será exibido a tela de formulário do cadastro em modo edição contendo as opções “Cancelar” e “Salvar”. Nesta tela, os dados da Unidade Federativa selecionada já estarão preenchidos, permitindo que você altere as informações conforme necessárias.
Ao inserir novas alterações, clique em "Salvar" para efetivar as mudanças. Em seguida, o sistema exibirá uma caixa de diálogo de confirmação do cadastro com as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma alteração será efetuada.
Confirmar: Se optar por "Confirmar", o sistema concluirá a alteração cadastral.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro realizado com sucesso!".
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Unidade Federativa, já com a UF editada na lista.

# Excluir
# Exclusão permitida – Sem Relacionamentos
Selecione a Unidade Federativa na tabela: Basta marcar a caixa de seleção disponível na tabela;
Acesse as Ações: Clique no botão "Ações".
Escolha Excluir: Selecione a opção "Excluir" na lista de valores exibida após clicar em ações.
Caixa de dialógo: Uma caixa de diálogo será exibida para confirmar a exclusão, informando que os dados não poderão ser recuperados após a exclusão. A caixa de diálogo conterá as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma exclusão será efetuada.
Confirmar: Se optar por "Confirmar", o sistema concluirá a exclusão da UF do sistema.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro excluído com sucesso!".
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Unidade Federativa, já com a UF excluída na lista.

# Exclusão não permitida
Selecione a Unidade Federativa na tabela: Basta marcar a caixa de seleção disponível na tabela;
Acesse as Ações: Clique no botão "Ações".
Escolha Excluir: Selecione a opção "Excluir" na lista de valores exibida após clicar em ações.
Caixa de dialógo: Se a exclusão não for permitida, será exibido uma caixa de dialógo com a mensagem: "Exclusão não permitida. Atenção! Não é possível excluir este item, pois ele possui relacionamento ativo com outros itens." A caixa de diálogo conterá a opção "Fechar”.
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de atenção, o sistema retornará à tela de Unidade Federativa, sem efetuar a exclusão da Unidade Federativa selecionada.
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
# Botão Novo: Botão de ação para incluir uma nova Unidade Federativa no sistema.

# Botão Ações: Botão de ação que permite a edição e exclusão da Unidade Federativa selecionada.

# Adicionar Filtro: Localizado na tabela, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca na tabela de UF. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.

# Caixa de Seleção: Ao marcar a caixa de seleção na tabela, o usuário ativa o botão de ações, permitindo a execução de operações relacionadas à linha selecionada.

# Navegação Tabela: Localizado no rodapé da tabela, o usuário pode selecionar o número de linhas a serem exibidas por página e navegar entre as páginas.

# Botão Fechar: Ao clicar no botão 'Fechar', o usuário será redirecionado para a tela/caminho anterior.
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante a solicitação de Equipamentos de Medição:
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Enterprise | Poderá incluir uma nova Unidade Federativa no sistema (UF) |
| Poderá visualizar as Unidades Federativas cadastradas | |
| Poderá aplicar filtros específicos e refinar a lista de UFs exibida. | |
| Poderá editar UFs já cadastradas | |
| Poderá excluir Unidades Federativas desde que estas não possuam relacionamentos ativos, como vínculos com Municípios, bairros, logradouros, ou qualquer outro tipo de item cadastrado. |
# TECLAS DE ATALHO
# [Mapeamento das teclas de atalhos utilizados na funcionalidade]
| AÇÃO/FUNÇÃO | PORTUGÊS | INGLÊS | ESPANHOL |
|---|---|---|---|
# RELATÓRIO DE INCIDÊNCIAS
Seção destinada a resolução de problemas e erros que podem ocorrer e como pode ser solucionado.
| PROBLEMA | CAUSA | SOLUÇÃO |
|---|---|---|
# DOCUMENTOS RELACIONADOS
| TÍTULO | VERSÃO | LINK |
|---|---|---|
| Unidade Federativa (UF) | 1º | - |
# CONTATOS
Fale com a gente e tire suas dúvidas!
Email: <Variáveis parametrizáveis a serem definidas>
Telefone: <Variáveis parametrizáveis a serem definidas>
Área Responsável: <Variáveis parametrizáveis a serem definidas>