Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- ajuda:inserir_municipio [01/07/2015 18:36] – a edivaldo.alves
+++ ajuda:inserir_municipio [01/04/2019 19:17] (atual) – [Funcionalidade dos botões] tadeu.sarmento
@@ Linha 1: / Linha 1: @@
-[[:ajuda|{{ :ajuda:gsan-atendimento.png?nolink&200|}}]]
+[[ajuda:cadastro|{{ :ajuda:gsan-cadastro.png?nolink&200|}}]]
 ====== Inserir Município ======
+<columns>
+Esta opção do sistema permite a inserção de um novo município na base de dados. A funcionalidade pode ser acessada via **Menu de Sistema**, no caminho **[[:ajuda:pagina_inicial|GSAN]] > [[:ajuda:Cadastro]] > [[:ajuda:Geográfico]] > Inserir Municipio**.
+</columns>
+Feito isso, o sistema exibe a tela a seguir:
-Esta opção do sistema permite a inserção de um município na base de dados, podendo ser acessada no caminho [[:ajuda:pagina_inicial|GSAN]] > [[:ajuda:Cadastro]] > [[:ajuda:Geográfico]] > Inserir Municipio.
+==== Observação ====
+^Informamos que os dados exibidos nas telas a seguir são fictícios, e não retratam informações de clientes.^
+<WRAP center round box 100%>
+{{  :ajuda:wmunicipio_inserir.jpg?nolink  |}}
+</WRAP>
-Verifica existência de dados
+<columns>
-  * Caso não exista a tabela na base de dados, será exibida a mensagem "Tabela <xxxxx> inexistente" e cancela a operação.
+**Atenção**: tanto os campos da tela acima, quanto a obrigatoriedade do seu preenchimento, podem variar de acordo com a parametrização de cada empresa. Dito isso, no exemplo, informe os campos obrigatórios **Código do Município**, **Nome do Município**, **Código do DDD**, **Unidade da Federação**, **Microrregião**, **Região de Integração**, **CEP Inicial**, **CEP Final** e clique em {{:ajuda:inserir.png?nolink|}} (para detalhes sobre o preenchimento dos campos clique **[[=ajuda:inserir_municipio#preenchimento_dos_campos|AQUI]]**).
-  * Caso a tabela esteja sem dados, será exibida a mensagem "Tabela <xxxxx> sem dados para seleção" e cancela a operação.
-Verifica preenchimento dos campos
+O sistema efetua algumas validações:
-  * Caso o usuário não informe ou não selecione o conteúdo de algum campo necessário à inclusão do município, será exibida a mensagem "Informe <xxxxxxxxxxxxxx>".
-Verifica existência do Município
+  * Verificar existência de dados:
-  * Caso o código do município já exista no sistema, será exibida a mensagem "Município já existe no cadastro".
+    * Caso não exista a tabela na base de dados, o sistema exibe a mensagem: //Tabela <xxxxx> inexistente// e cancela a operação.
+    * Caso a tabela esteja sem dados, o sistema exibe a mensagem: //Tabela <xxxxx> sem dados para seleção// e cancela a operação.
+  * Verificar preenchimento dos campos:
+    * Caso o usuário não informe ou não selecione o conteúdo de algum campo necessário à inclusão do município, o sistema exibe a mensagem: //Informe <xxxxxxxxxxxxxx>//.
+  * Verificar existência do Município:
+    * Caso o código do município já exista no sistema, o sistema exibe a mensagem: //Município já existe no cadastro//.
+  * Verificar sucesso da transação:
+    * Caso o código de retorno da operação efetuada no banco de dados seja diferente de zero, o sistema exibe a mensagem conforme o código de retorno.
+  * Validar CEP:
+    * Caso o CEP Inicial seja superior ao CEP Final informado, o sistema exibe a mensagem: //CEP Inicial deve ser anterior ou igual ao CEP Final//.
+  * Validar Data:
+    * Caso a Data informada não seja uma data válida, o sistema exibe a mensagem: //Data Inválida//.
+  * Data Fim anterior a Data Início:
+    * Caso a Data Início da Concessão seja superior à Data Fim da Concessão informada, o sistema exibe a mensagem: //Data Início da Concessão deve ser anterior ou igual à Data Fim da Concessão//.
+  * Validar Cliente:
+    * O sistema verifica se o cliente informado existe; caso não exista, o sistema exibe a mensagem: //Código de cliente responsável informado não cadastrado//.
+    * Caso o tipo de pessoa associado ao cliente informado não corresponda à pessoa jurídica, o sistema exibe a mensagem: //Cliente informado não corresponde à pessoa de natureza jurídica//.
+    * Caso o nome do cliente informado não corresponda a //PREFEITURA//, o sistema exibe a mensagem: //Cliente informado como responsável do município não corresponde a prefeitura//.
+</columns>
-Verifica sucesso da transação
-  * Caso o código de retorno da operação efetuada no banco de dados seja diferente de zero, será exibida a mensagem conforme o código de retorno.
-Valida CEP
+====== Tela de Sucesso ======
-  * Caso o CEP Inicial seja superior ao CEP Final informado, será exibida a mensagem "CEP Inicial deve ser anterior ou igual ao CEP Final".
-Valida Data
+<WRAP center round box 100%>
-  * Caso a Data informada não seja uma data válida, será exibida a mensagem "Data Inválida".
+{{  :ajuda:ts_inserir_municipio.jpg?nolink  |}}
+</WRAP>
-Data Fim anterior a Data Início
-  * Caso a Data Início da Concessão seja superior à Data Fim da Concessão informada, será exibida a mensagem "Data Início da Concessão deve ser anterior ou igual à Data Fim da Concessão".
-Valida Cliente
-  * O sistema verifica se o cliente informado existe, caso não exista, será exibida a mensagem "Código de cliente responsável informado não cadastrado".
-  * Caso o tipo de pessoa associado ao cliente informado não corresponda a pessoa jurídica, será exibida a mensagem "Cliente informado não corresponde a pessoa de natureza jurídica".
-  * Caso o nome do cliente informado não corresponda a 'PREFEITURA', será exibida a mensagem "Cliente informado como responsável do município não corresponde a prefeitura".
-{{:ajuda:cad_-_inserir_municipio.png?nolink|}}
 \\
 ====== Preenchimento dos campos ======
+^Campo^Orientações para Preenchimento^
+|Código do Município|Campo obrigatório. Informe o código do município a ser incluído com até 4 dígitos.\\ **Regra associada**: Deve ser um código ainda inexistente na base de dados. No caso de se informar um código de município existente, o sistema apresenta a mensagem: //Município com esse código já existe no cadastro//. Para pesquisar o código clique em {{:ajuda:operacional:lupa.gif?nolink|}} **[[=ajuda:pesquisar_municipio|Pesquisar Município]]**.|
+|Nome do Município|Campo obrigatório. Informe por extenso o nome do município que está sendo cadastrado com até 30 caracteres.|
+|Código DDD|Campo obrigatório. Informe o código do DDD (Discagem Direta à Distância) do município que está sendo cadastrado com até 3 dígitos.|
+|Unidade da Federação|Campo obrigatório. Selecione, na lista apresentada ao lado do campo, o nome da unidade da federação à qual o município pertence.|
+|Microrregião|Campo obrigatório. Selecione, na lista apresentada ao lado do campo, o nome da microrregião à qual o município pertence.|
+|Região de Integração|Campo obrigatório. Selecione, na lista apresentada ao lado do campo, o nome da região de desenvolvimento à qual o município pertence.|
+|CEP Inicial|Campo obrigatório. Informe a numeração inicial do CEP (Código de Endereçamento Postal) do município que está sendo cadastrado, com oito dígitos.|
+|CEP Final|Campo obrigatório. Informe a numeração final do CEP (Código de Endereçamento Postal) do município que está sendo cadastrado.\\ **Regra associada**: O CEP Final deve ser maior, ou igual ao CEP Inicial. Caso contrário, o sistema apresenta a seguinte mensagem: //CEP Inicial deve ser anterior, ou igual, ao CEP Final//.|
+|Data de Início da Concessão|Informe a data de início da concessão da gestão para a companhia.\\ **Regra associada**: Você tem duas opções para informar a data: **Digitando-a no campo** - Neste caso, não precisa se preocupar com a as barras de separação, pois o sistema as coloca automaticamente. A data deve ser informada no formato: DD/MM/AAAA, onde DD é o dia, MM, o mês e AAAA, o ano. O dia e o mês devem ser informados, obrigatoriamente, com dois dígitos e o ano com quatro. **Pesquisando-a em um calendário** - Neste caso, clique no botão  {{:ajuda:calendario.gif?nolink|}}, link **[[:ajuda:pesquisar_calendario|Pesquisar Data - Calendário]]**, existente ao lado do campo, que será apresentada uma tela onde você pode selecionar uma data no calendário.|
+|Data de Fim da Concessão|Informe a data de término da concessão da gestão para a companhia.\\ **Regra associada**: Você tem duas opções para informar a data: **Digitando-a no campo** - Neste caso não precisa de preocupar com a as barras de separação, pois o sistema as coloca automaticamente. A data deve ser informada no formato: DD/MM/AAAA, onde DD é o dia, MM, o mês e AAAA, o ano. O dia e o mês devem ser informados, obrigatoriamente, com dois dígitos e o ano com quatro. **Pesquisando-a em um calendário** - Neste caso, clique no botão {{:ajuda:calendario.gif?nolink|}}, link **[[:ajuda:pesquisar_calendario|Pesquisar Data - Calendário]]**, existente ao lado do campo, que será apresentada uma tela onde você pode selecionar uma data no calendário. A data de fim da concessão deve ser superior, ou igual, à data início da concessão. Caso contrário, o sistema apresenta a seguinte mensagem: //Data de Início da Concessão deve ser anterior, ou igual, à Data de Fim da Concessão//.|
+|Código do IBGE|Informe o código atribuído pelo IBGE ao município com até dez caracteres.|
+|Indicador de Uso Relacionamento Quadra&Bairro|Informe //Sim// para tornar o cadastramento do bairro obrigatório; caso contrário, marque //Não//. \\ **Regra associada**: marcando //Sim//, você indica ao sistema que para o município sendo cadastrado deve ser utilizado a informação da quadra associada ao bairro.|
+|Contrato de Adesão de Serviços|Selecione o tipo de contrato de adesão de serviço da lista disponibilizada pelo sistema.|
+|Indicador de Logradouro Bloqueado Durante a Atualização Cadastral|Campo visualizado dependendo da empresa. Selecione uma das opções //Sim// ou //Não//. Por solicitação da Compesa, este indicador foi retirado durante a atualização cadastral.|
+|Prefeitura - Cliente Responsável|Campo visualizado dependendo da empresa. Campo obrigatório. Informe o código do cliente responsável, ou clique no botão {{:ajuda:lupa.gif?nolink|}} para selecionar a opção desejada. O nome do cliente será exibido no campo ao lado. Para apagar o conteúdo do campo, clique no botão {{:ajuda:borracha.gif?nolink|}} ao lado do campo em exibição.|
+|Indicador se a Prefeitura do Município Possui Débito em Cobrança Judicial|Campo visualizado dependendo da empresa. Selecione uma das opções //Sim// ou //Não//.|
+|Indicador se a Parcela do Débito da Prefeitura do Município é Paga com ICMS|Campo visualizado dependendo da empresa. Selecione uma das opções //Sim// ou //Não//.|
+|Indicador se a Prefeitura do Município Possui Convênio de Repavimentação com a Compesa.|Campo visualizado dependendo da empresa. Selecione uma das opções //Sim// ou //Não//.|
-Campo^^ Orientações para Preenchimento^
-|Código do Município(*)|Campo obrigatório - Informe o código do município a ser incluído.\\ Deve ser um código, ainda, inexistente na base de dados.\\ No caso de se informar um código de município existente, o sistema apresentará a mensagem: "Município com esse código já existe no cadastro."|
-|Nome do Município(*)|Campo obrigatório - Informe o nome do município que está sendo cadastrado.|
-|Código DDD(*)|Campo obrigatório - Informe o código do DDD (Discagem Direta à Distância) do município que está sendo cadastrado.|
-|Unidade da Federação(*)|Campo obrigatório - Selecione, na lista apresentada ao lado do campo, o nome da unidade da federação, à qual, o município pertence.|
-|Microrregião(*)|Campo obrigatório - Selecione, na lista apresentada ao lado do campo, o nome da microrregião, à qual, o município pertence.|
-|Região de Integração(*)|Campo obrigatório - Selecione, na lista apresentada ao lado do campo, o nome da região de desenvolvimento, à qual, o município pertence.|
-|CEP Inicial(*)|Campo obrigatório - Informe a numeração inicial do CEP (Código de Endereçamento Postal) do município que está sendo cadastrado.|
-|CEP Final(*)|Campo obrigatório - Informe a numeração final do CEP (Código de Endereçamento Postal) do município que está sendo cadastrado.\\ O CEP Final deve ser maior, ou igual ao CEP Inicial.\\ Caso contrário, o sistema apresentará a seguinte mensagem: "CEP Inicial deve ser anterior, ou igual, ao CEP Final".|
-|Data de Início da Concessão|Informe a data de início da concessão da gestão para a companhia.\\ Você tem duas opções para informar a data:\\ **Digitando-a no campo** - Neste caso, não precisa de preocupar com a as barras de separação, pois o sistema as coloca automaticamente. A data deve ser informada no formato: DD/MM/AAAA, onde DD é o dia, MM, o mês e AAAA, o ano. O dia e o mês devem ser informados, obrigatoriamente, com dois dígitos e o ano com quatro.\\ **Pesquisando-a num calendário** - Neste caso, clique no botão "Calendário" {{:ajuda:calendario.gif?nolink|}}, link [[:ajuda:pesquisar_calendario|Pesquisar Data - Calendário]], existente ao lado do campo, que será apresentada uma tela onde você poderá selecionar uma data no calendário.|
-|Data de Fim da Concessão|Informe a data de término da concessão da gestão para a companhia.\\ Você tem duas opções para informar a data:\\ **Digitando-a no campo** - Neste caso não precisa de preocupar com a as barras de separação, pois o sistema as coloca automaticamente. A data deve ser informada no formato: DD/MM/AAAA, onde DD é o dia, MM, o mês e AAAA, o ano. O dia e o mês devem ser informados, obrigatoriamente, com dois dígitos e o ano com quatro.\\ **Pesquisando-a num calendário** - Neste caso, clique no botão "Calendário" {{:ajuda:calendario.gif?nolink|}}, link [[:ajuda:pesquisar_calendario|Pesquisar Data - Calendário]], existente ao lado do campo, que será apresentada uma tela onde você poderá selecionar uma data no calendário.\\ A data de fim da concessão deve ser superior, ou igual, à data início da concessão. Caso contrário, o sistema apresentará a seguinte mensagem: "Data de Início da Concessão deve ser anterior, ou igual, à Data de Fim da Concessão".|
-|Código do IBGE|Informe o código atribuído pelo IBGE.|
-|Indicador de Uso Relacionamento Quadra&Bairro|Informe "Sim" para tornar o cadastramento do bairro obrigatório, caso contrário, marque "Não".|
-|Indicador de Logradouro Bloqueado Durante a Atualização Cadastral|Selecione uma das opções "Sim" ou "Não".\\ Por solicitação da Compesa, este indicador foi retirado durante a atualização cadastral.|
-|Prefeitura - Cliente Responsável(*)|Campo obrigatório - Informe o código do cliente responsável, ou clique no botão {{:ajuda:lupa.gif?nolink|}} para selecionar a opção desejada. O nome do cliente será exibido no campo ao lado.\\ Para apagar o conteúdo do campo, clique no botão {{:ajuda:borracha.gif?nolink|}} ao lado do campo em exibição.|
-|Indicador se a Prefeitua do Município Possui Débito em Cobrança Judicial|Selecione uma das opções "Sim" ou "Não".|
-|Indicador se a Parcela do Débito da Prefeitura do Município é Paga com ICMS|Selecione uma das opções "Sim" ou "Não".|
-|Indicador se a Prefeitura do Município Possui Convênio de Repavimentação com a Compesa.|Selecione uma das opções "Sim" ou "Não".|
 \\
-.1 Funcionalidade dos botões:
+====== Funcionalidade dos botões ======
+^Botão^Descrição das funcionalidades^
+|{{:ajuda:lupa.gif?nolink|}}|Ao clicar neste botão, o sistema permite consultar um dado na base de dados.|
+|{{:ajuda:borracha.gif?nolink|}}|Ao clicar neste botão, o sistema apaga o conteúdo do campo em exibição.|
+|{{:ajuda:calendario.gif?nolink|}}|Ao acionar este botão, o sistema abre uma tela para que você selecione a data a partir de um calendário.\\ Clique em **[[:ajuda:pesquisar_calendario|Pesquisar Data - Calendário]]** para obter a ajuda da tela do calendário.|
+|{{:ajuda:inserir.png?nolink|}}|Utilize este botão para solicitar ao sistema a inserção do município na base de dados. Neste caso, é necessário que todos os campos estejam preenchidos corretamente. Caso exista alguma inconsistência, o sistema emite a mensagem de crítica correspondente.|
+|{{:ajuda:cobranca:b_desfazer_manam.jpg?nolink|}}|Utilize este botão para limpar o conteúdo da tela, voltando ao seu estado inicial de exibição.|
+|{{:ajuda:relatorios:botao_cancelar_relatorio.jpg?160|}}|Utilize este botão para fazer com que o sistema encerre, sem salvar, o que está sendo feito, e volte para a tela principal.|
-{table}
+===== Referências =====
-Botão|Descrição da Funcionalidade
- {image:Lupa.gif}|Ao clicar neste botão, o sistema permite consultar um dado nas bases de dados. \\
- {image:Borracha.gif}|Ao clicar neste botão, o sistema apaga o conteúdo do campo em exibição. \\
-{image:calendario.gif}|Ao acionar este botão, o sistema irá abrir uma tela para que você selecione a data a partir de um calendário.\\[Clique aqui>AjudaGSAN.calendario] para obter a ajuda da tela do calendário.
-{image:inserir.jpg}|Utilize este botão para solicitar ao sistema a inserção do setor comercial na base de dados. Neste caso, é necessário que todos os campos estejam preenchidos corretamente.\\Caso exista alguma inconsistência, o sistema emitirá a mensagem de crítica correspondente.
-{image:Limpar.jpg}|Utilize este botão para limpar o conteúdo da tela,  voltando ao seu estado inicial de exibição.
-{image:cancelar.jpg}|Utilize este botão para fazer com que o sistema encerre, sem salvar, o que está sendo feito, e volte para a tela principal.
-{table}
-.1 Tela de Sucesso:
+**[[=postgres:cadastro:uc0001|Inserir Município]]**
-A tela de sucesso será apresentada após clicar no botão {image:inserir.jpg}, e não houver nenhuma inconsistência no conteúdo dos campos da tela.
-O sistema apresentará a  mensagem abaixo, quando a inclusão do município tiver sido realizada com sucesso.
+==== Termos Principais ====
-"Município ~~(nome do município)~~ inserido com sucesso."
+**[[=ajuda:geografico|Município]]**
-O sistema apresentará três opções após a inserção do município.\\Escolha a opção desejada clicando em algum dos "~~hyperlinks~~" existentes na tela de sucesso:
-* Menu Principal: Para voltar à tela principal.
-* Inserir outro Município: Para inserir outro município.
-* Atualizar o Município Inserido: Para efetuar a atualização do município, recentemente, inserido.
 \\
 \\
-\\
+Clique **[[:ajuda|aqui]]** para retornar ao Menu Principal do GSAN.
-Clique [[:Ajuda|aqui]] para retornar ao Menu Principal do GSAN