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)
 
(40 edições intermediárias de um usuário não apresentadas)
Linha 9: Linha 9:
 
*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.
 
*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.
 
*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 [[media:CorrelacaoTributacao CNAExCTISS.xls|tabela]].
+
*Ter cadastrados no banco de dados do sistema todos os códigos e descrições de CNAE conforme esta [[media:CorrelacaoTributacao CNAExCTISS.xls|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.
  
 
= Resultado esperado =
 
= Resultado esperado =
Linha 15: Linha 15:
  
 
= Diagrama de classes =
 
= Diagrama de classes =
−
[[File:Produto.png|400px]]
+
[[File:TributacaoServicos.png|400px]]
  
 
= Fluxo de eventos =
 
= Fluxo de eventos =
 
== Fluxos principais ==
 
== Fluxos principais ==
−
'''Fluxo 1:'''  
+
'''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 - Descrição dos campos e funcionalidades da tela de pesquisa | RN01]].
 +
 
 +
 
 +
'''Fluxo 2:''' Usuário aciona o botão <Adicionar CNAE>.
 +
*Sistema exibe a tela de manutenção da rotina conforme [[#RN01 - Descrição dos campos e funcionalidades da tela de manutenção | RN02]].
 +
 
 +
 
 +
'''Fluxo 3:''' Usuário informa os dados do CNAE e aciona o botão <Salvar>.
 +
*Sistema cadastra novo CNAE na base de dados.
  
 
== Fluxos alternativos ==
 
== Fluxos alternativos ==
−
'''Fluxo 1:'''  
+
'''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: <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:'''  
+
'''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 à(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.
  
 +
 +
'''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: <font color=#008B00>''O código do CNAE deve ter pelo menos 7 dígitos.''</font>
 +
 +
= Regras de negócio =
 
== RN01 - Descrição dos campos e funcionalidades da tela de pesquisa ==
 
== RN01 - Descrição dos campos e funcionalidades da tela de pesquisa ==
 
#'''Adicionar CNAE:''' Botão que quando acionado exibe a tela de manutenção da rotina em questão.
 
#'''Adicionar CNAE:''' Botão que quando acionado exibe a tela de manutenção da rotina em questão.
Linha 33: 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.
−
#*'''CÓDIGO LOCAL:''' Código local de um determinado município que corresponde ao CNAE, o [http://resulthweb.com/wikiJava/index.php/CTISS CTISS] em Belo Horizonte por exemplo.
 
−
#*'''DESCRIÇÃO LOCAL:''' Descrição da atividade correspondente ao código local.
 
 
#*'''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.
  
−
     Apesar de serem gravadas no banco de dados sem formatação, os códigos das atividades listadas no grid deverão
+
     <font face="Arial">
−
    fazer uso da seguinte máscara: ####-#/##-##.  
+
    O sistema não fará uso de máscaras para os códigos de CNAE.
−
   
+
−
    Exemplo: 6190-6/01-00
+
  
−
= Layouts sugeridos =
+
== RN02 - Descrição dos campos e funcionalidades da tela de manutenção ==
−
<gallery>
+
#'''Ativo:''' Campo que determina se um CNAE está ativo para uso ou não.
−
File:Tabela-de-preço.png|Tabela de preço '''tela de manutenção'''
+
#'''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).
−
</gallery>
+
#'''Descrição CNAE:''' Campo onde deverá ser informada a descrição do CNAE.
  
 
= Quadro de dados =
 
= Quadro de dados =
Linha 52: Linha 92:
 
|'''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'''  
 
|-
 
|-
−
|Ativo || Não || Checkbox || Marcado/Desmarcado || || Marcado ||
+
|Ativo || Sim || Checkbox || Marcado/Desmarcado || || Marcado, quando em inclusão. ||  
−
|-
+
−
|Descrição || Sim || Input || Alfanuméricos || 40 || Vazio ||
+
−
|-
+
−
|Descrição abreviada || Não || Input || Alfanuméricos || 15 || Vazio ||  
+
 
|-
 
|-
−
|Validade || Não || Input || Numéricos || || Vazio ||
+
|Código CNAE || Sim || Input || Alfanuméricos || 9 || Vazio ||
 
|-
 
|-
−
|Desconto máximo || Não || Input || Numéricos || || Vazio ||
+
|Descrição CNAE || Sim || Input || Alfanuméricos || 200 || 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