UC00103 - Cadastro de CNAE

De Wiki Java - Interno
(Diferença entre revisões)
Ir para: navegação, pesquisa
(→‎RN01 - Descrição dos campos e funcionalidades da tela de pesquisa)
(→‎Fluxos de exceção)
 
(13 edições intermediárias de um usuário não apresentadas)
Linha 53: Linha 53:
 
'''Fluxo 6:''' Na tela de manutenção, em modo de consulta, usuário aciona o botão <Excluir>.
 
'''Fluxo 6:''' Na tela de manutenção, em modo de consulta, usuário aciona o botão <Excluir>.
 
*Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.
 
*Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.
 +
 +
 +
'''Fluxo 7:''' Em modo de inclusão, usuário cadastra um novo CNAE com código de 7 a 9 dígitos cujos mesmos já existem dentre os CNAE´s já cadastrados.
 +
*Sistema emite ao usuário a seguinte mensagem de confirmação: <font color=#008B00>''O(s) CNAE(s) XXXXXXXX já cadastrado(s) no sistema possui(em) código(s) igual(is) ou semelhante(s) ao código informado. Deseja realmente cadastrar o novo CNAE?''</font>. Caso usuário clique em sim, sistema cadastra o novo CNAE, caso contrário a gravação é abortada.
  
 
== Fluxos de exceção ==
 
== Fluxos de exceção ==
 
'''Fluxo 1:''' Na tela de pesquisa ou de manutenção usuário tenta excluir um CNAE que já foi relacionado a uma lista de serviço.
 
'''Fluxo 1:''' Na tela de pesquisa ou de manutenção usuário tenta excluir um CNAE que já foi relacionado a uma lista de serviço.
−
*Sistema aborta a exclusão e emite ao usuário a seguinte mensagem de alerta:  <font color=#008B00>''Este registro está relacionado à lista de serviços X, e portanto sua exclusão não é permitida.''</font>. Onde X corresponde à descrição da lista de serviço.
+
*Sistema aborta a exclusão e emite ao usuário a seguinte mensagem de alerta:  <font color=#008B00>''Este registro está relacionado à(s) lista(s) de serviços X, e portanto sua exclusão não é permitida.''</font> Onde X corresponde à descrição da lista de serviço.
  
  
Linha 63: Linha 67:
  
  
−
'''Fluxo 3:''' Em modo de inclusão, na seção de detalhe, usuário aciona o botão <Adicionar> sem informar nenhum ou alguns dados.
+
'''Fluxo 3:''' Em modo de inclusão, usuário tenta cadastrar um novo CNAE cujo código '''é menor''' que 7 dígitos.
−
*Sistema aborta a inclusão no grid e emite ao usuário uma mensagem de alerta informando quais campos são obrigatórios de acordo com o [[#Quadro de dados|quadro de dados]].
+
*Sistema aborta a gravação e emite ao usuário a seguinte mensagem de alerta: <font color=#008B00>''O código do CNAE deve ter pelo menos 7 dígitos.''</font>
−
 
+
−
 
+
−
'''Fluxo 4:''' Em modo de inclusão, na seção de detalhe, usuário informa uma cidade e uma atividade econômica local já adicionados no grid e aciona o botão <Adicionar>.
+
−
*Sistema aborta a inclusão do registro no grid e emite ao usuário uma mensagem de alerta com a não conformidade.
+
  
 
= Regras de negócio =
 
= Regras de negócio =
Linha 77: Linha 77:
 
#*'''CÓDIGO:''' Código nacional da atividade econômica (CNAE).
 
#*'''CÓDIGO:''' Código nacional da atividade econômica (CNAE).
 
#*'''DESCRIÇÃO:''' Descrição do CNAE.
 
#*'''DESCRIÇÃO:''' Descrição do CNAE.
−
#*'''ALIQ. ISSQN:''' Alíquota do ISSQN.
 
 
#*'''ATIVO:''' Informa se um determinado registro está ativo para uso no sistema ou não.
 
#*'''ATIVO:''' Informa se um determinado registro está ativo para uso no sistema ou não.
  
Linha 84: Linha 83:
  
 
== RN02 - Descrição dos campos e funcionalidades da tela de manutenção ==
 
== RN02 - Descrição dos campos e funcionalidades da tela de manutenção ==
−
=== Mestre ===
 
 
#'''Ativo:''' Campo que determina se um CNAE está ativo para uso ou não.
 
#'''Ativo:''' Campo que determina se um CNAE está ativo para uso ou não.
−
#'''Código CNAE:''' Campo onde deverá ser informado o código nacional da atividade econômica. À medida que o usuário digitar o código o sistema deverá formatá-lo automaticamente na máscara de CNAE.  
+
#'''Código CNAE:''' Campo onde deverá ser informado o código nacional da atividade econômica. Este código deverá ter o tamanho '''mínimo de 7''' dígitos e '''máximo de 9'''. O campo não deverá permitir que o usuário informe mais que 9 dígitos (sem máscara).
 
#'''Descrição CNAE:''' Campo onde deverá ser informada a descrição do CNAE.
 
#'''Descrição CNAE:''' Campo onde deverá ser informada a descrição do CNAE.
−
#'''Alíquota ISSQN:''' Campo onde deverá ser informada a alíquota de ISS do CNAE.
 
−
#'''Base ISSQN:''' Campo onde deverá ser informada a base de calculo do ISSQN do CNAE.
 
−
 
−
=== Detalhe ===
 
−
#'''Cidade:''' Campo que lista todas as cidades cadastradas no sistema para que o usuário selecione uma a ser utilizada com o código local da atividade econômica.
 
−
#'''Código local da atividade econômica:''' Código específico da cidade selecionada que corresponde ao código do CNAE.
 
−
#'''Descrição atividade econômica local:''' Descrição específica da atividade econômica correspondente à cidade selecionada.
 
−
#'''Alíquota ISSQN:''' Campo onde poderá ser informada a alíquota de ISSQN específica para a cidade selecionada.
 
−
#'''Base ISSQN:''' Campo onde poderá ser informada a base de cálculo de ISSQN juntamente com a alíquota para a cidade selecionada.
 
−
#'''Botão <Adicionar>:''' Inclui no grid abaixo a cidade, o código e descrição local informados acima.
 
−
#'''Grid:''' Lista as cidades com seus respectivos códigos/descrições de atividade econômica nas seguintes colunas.
 
−
#*'''CIDADE:''' Nome da cidade.
 
−
#*'''CÓD. LOCAL:''' Código da atividade econômica naquela cidade.
 
−
#*'''DESC. LOCAL:''' Descrição da atividade econômica naquela cidade.
 
−
#*'''<EXCLUIR>:''' Botão que quando acionado exclui do grid o registro em questão.
 
−
 
−
    Uma determinada cidade e atividade econômica (código+descrição) só podem existir no grid uma única vez. A cidade poderá ser
 
−
    adicionada no grid mais de uma vez desde que a atividade econômica não se repita. Da mesma forma a atividade econômica poderá
 
−
    repetir, mas com cidades diferentes.
 
  
 
= Quadro de dados =
 
= Quadro de dados =
 
== Tela de manutenção ==
 
== Tela de manutenção ==
−
=== Mestre ===
 
 
{|class="wikitable"
 
{|class="wikitable"
 
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''  
 
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''  
Linha 116: Linha 94:
 
|Ativo || Sim || Checkbox || Marcado/Desmarcado || || Marcado, quando em inclusão. ||  
 
|Ativo || Sim || Checkbox || Marcado/Desmarcado || || Marcado, quando em inclusão. ||  
 
|-
 
|-
−
|Código CNAE || Sim || Input || Alfanuméricos || 9 || Vazio || Este campo deverá fazer uso da máscara ####-#/##-##.
+
|Código CNAE || Sim || Input || Alfanuméricos || 9 || Vazio ||
 
|-
 
|-
 
|Descrição CNAE || Sim || Input || Alfanuméricos || 200 || Vazio ||  
 
|Descrição CNAE || Sim || Input || Alfanuméricos || 200 || Vazio ||  
−
|-
 
−
|Alíquota ISSQN || Sim|| Input || Numéricos || De 0 até 9.999,00 || Vazio ||
 
−
|-
 
−
|Base ISSQN || Sim || Input || Numéricos || De 0 até 9.999,00 || Vazio ||
 
−
|-
 
−
|}
 
−
 
−
=== Detalhe ===
 
−
{|class="wikitable"
 
−
|'''NOME''' || '''OBRIGATÓRIO''' || '''TIPO DE ENTRADA''' || '''VALORES POSSÍVEIS''' || '''TAMANHO''' || '''VALOR PADRÃO''' || '''OBSERVAÇÃO'''
 
−
|-
 
−
|Cidade || Não || Combobox || Cidades cadastradas || || Vazio ||
 
−
|-
 
−
|Código local da atividade econômica || Sim, se uma cidade foi informada || Input || Alfanuméricos || 9 || Vazio || Este campo deverá fazer uso da máscara ####-#/##-##.
 
−
|-
 
−
|Descrição atividade econômica local || Sim, se o código foi informado || Input || Alfanuméricos || 200 || Vazio ||
 
−
|-
 
−
|Alíquota ISSQN || Sim || Input || Numéricos || De 0 até 9.999,00 || Vazio ||
 
−
|-
 
−
|Base ISSQN || Sim, se a alíquota foi informada || Input || Numéricos || De 0 até 9.999,00 || Vazio ||
 
 
|-
 
|-
 
|}
 
|}

Edição atual tal como às 09h04min de 18 de fevereiro de 2014

Conteúdo

[editar] Objetivo

  • Manter cadastro de CNAE.

[editar] Atores

  • Usuário

[editar] Pré-requisitos

  • Considerar documento Padrões de desenvolvimento.
  • No projeto da rotina, em confsrc > META-INF > messages > view.properties definir o nome como CNAE. Este nome será utilizado para criar a página no Wiki.
  • Utilizar grid com pesquisa por contexto (lucene) paginado.
  • Ter cadastrados no banco de dados do sistema todos os códigos e descrições de CNAE conforme esta tabela. Por padrão todos os CNAE´s deverão ser cadastrados como inativos, fazendo com que o usuário ative somente aqueles que irá de fato utilizar.

[editar] Resultado esperado

  • Cadastrar no sistema códigos nacionais de atividades econômicas (CNAE).

[editar] Diagrama de classes

TributacaoServicos.png

[editar] Fluxo de eventos

[editar] Fluxos principais

Fluxo 1: Usuário acessa a rotina Menu -> Cadastros -> Faturamento -> Item -> Imposto -> CNAE.

  • Sistema exibe a tela de pesquisa da rotina em questão conforme RN01.


Fluxo 2: Usuário aciona o botão <Adicionar CNAE>.

  • Sistema exibe a tela de manutenção da rotina conforme RN02.


Fluxo 3: Usuário informa os dados do CNAE e aciona o botão <Salvar>.

  • Sistema cadastra novo CNAE na base de dados.

[editar] Fluxos alternativos

Fluxo 1: Na tela de pesquisa, usuário digita no campo de pesquisa (lucene) pelo menos 3 dígitos do código ou da descrição do CNAE desejado.

  • Sistema repopula o grid listando somente resultados pertinentes ao filtro informado.


Fluxo 2: Na tela de pesquisa, usuário aciona o botão <Consultar> na última coluna do grid para um determinado registro.

  • Sistema exibe a tela de manutenção da rotina com os dados do registro cujo botão <Consultar> foi acionado em modo de consulta.


Fluxo 3: Na tela de pesquisa, usuário aciona o botão <Alterar> na última coluna do grid para um determinado registro.

  • Sistema exibe a tela de manutenção da rotina com os dados do registro cujo botão <Consultar> foi acionado em modo de alteração.


Fluxo 4: Na tela de pesquisa, usuário aciona o botão <Excluir> na última coluna de um determinado registro.

  • Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.


Fluxo 5: Na tela de manutenção, em modo de consulta, usuário aciona o botão <Alterar>.

  • Sistema habilita os campos da tela permitindo ao usuário alterar os dados do registro em questão.


Fluxo 6: Na tela de manutenção, em modo de consulta, usuário aciona o botão <Excluir>.

  • Se o registro é passível de ser excluído, sistema exibe mensagem de confirmação ao usuário perguntando se ele deseja realmente excluí-lo. Caso usuário clique em sim, o registro é permanentemente excluído. Caso contrário a exclusão é abortada.


Fluxo 7: Em modo de inclusão, usuário cadastra um novo CNAE com código de 7 a 9 dígitos cujos mesmos já existem dentre os CNAE´s já cadastrados.

  • Sistema emite ao usuário a seguinte mensagem de confirmação: O(s) CNAE(s) XXXXXXXX já cadastrado(s) no sistema possui(em) código(s) igual(is) ou semelhante(s) ao código informado. Deseja realmente cadastrar o novo CNAE?. Caso usuário clique em sim, sistema cadastra o novo CNAE, caso contrário a gravação é abortada.

[editar] Fluxos de exceção

Fluxo 1: Na tela de pesquisa ou de manutenção usuário tenta excluir um CNAE que já foi relacionado a uma lista de serviço.

  • Sistema aborta a exclusão e emite ao usuário a seguinte mensagem de alerta: Este registro está relacionado à(s) lista(s) de serviços X, e portanto sua exclusão não é permitida. Onde X corresponde à descrição da lista de serviço.


Fluxo 2: Em modo de inclusão, usuário informa no campo Código CNAE um código já cadastrado.

  • Sistema emite ao usuário uma mensagem de alerta informando que o código em questão já está cadastrado e mantem o foco no campo em questão.


Fluxo 3: Em modo de inclusão, usuário tenta cadastrar um novo CNAE cujo código é menor que 7 dígitos.

  • Sistema aborta a gravação e emite ao usuário a seguinte mensagem de alerta: O código do CNAE deve ter pelo menos 7 dígitos.

[editar] Regras de negócio

[editar] RN01 - Descrição dos campos e funcionalidades da tela de pesquisa

  1. Adicionar CNAE: Botão que quando acionado exibe a tela de manutenção da rotina em questão.
  2. Pesquisa (lucene): Campo localizado no canto superior direito da tela, que permite ao usuário digitar qualquer informação referente ao CNAE (listada em colunas do grid) para filtrar um determinado registro.
  3. GRID: Lista todos os CNAE´s cadastrados no sistema exibindo seus dados nas seguintes colunas:
    • CÓDIGO: Código nacional da atividade econômica (CNAE).
    • DESCRIÇÃO: Descrição do CNAE.
    • ATIVO: Informa se um determinado registro está ativo para uso no sistema ou não. 
     
    O sistema não fará uso de máscaras para os códigos de CNAE.

[editar] RN02 - Descrição dos campos e funcionalidades da tela de manutenção

  1. Ativo: Campo que determina se um CNAE está ativo para uso ou não.
  2. Código CNAE: Campo onde deverá ser informado o código nacional da atividade econômica. Este código deverá ter o tamanho mínimo de 7 dígitos e máximo de 9. O campo não deverá permitir que o usuário informe mais que 9 dígitos (sem máscara).
  3. Descrição CNAE: Campo onde deverá ser informada a descrição do CNAE.

[editar] Quadro de dados

[editar] Tela de manutenção

NOME OBRIGATÓRIO TIPO DE ENTRADA VALORES POSSÍVEIS TAMANHO VALOR PADRÃO OBSERVAÇÃO
Ativo Sim Checkbox Marcado/Desmarcado Marcado, quando em inclusão.
Código CNAE Sim Input Alfanuméricos 9 Vazio
Descrição CNAE Sim Input Alfanuméricos 200 Vazio
Disponível em "http://wiki.atsinformatica.com.br/wikijavainterno/index.php?title=UC00103_-_Cadastro_de_CNAE&oldid=2468"
Ferramentas pessoais
Espaços nominais

Variantes
Visualizações
Ações
Navegação
Ferramentas