UC00118 - Cadastro de histórico contábil

Atores

• Usuário

Pré-requisitos

• Considerar documento Padrões de desenvolvimento.
• No projeto da rotina, em confsrc > META-INF > messages > view.properties definir o nome como Histórico contábil. Este nome será utilizado para criar a página no Wiki.
• Esta rotina só poderá ser visível no menu para usuários que possuem acesso a mesma em empresas cuja senha possui o módulo de contabilidade.

Resultado esperado

• Cadastrar no sistema contas contábeis a serem utilizada nas rotinas de contabilidade.

Diagrama de classes

Fluxo de eventos

Fluxos principais

Fluxo 1: Usuário acessa Menu > Cadastros > Contabilidade > Histórico contábil.

• Sistema exibe ao usuário a tela de pesquisa da rotina conforme regra de negócio RN01.

Fluxo 2: Usuário aciona o botão [Adicionar histórico contábil].

• Sistema exibe ao usuário a tela de manutenção conforme regra de negócio RN02.

Fluxo 3: Usuário informa os dados do histórico contábil e aciona o botão [Salvar].

• Sistema cadastra o histórico contábil e emite ao usuário uma mensagem com esta informação.

Fluxos alternativos

Fluxo 1: Na tela de pesquisa, usuário digita no filtro o nome ou parte do nome da(s) conta(s) que deseja consultar.

• Através do mecanismo lucene o sistema repopula o grid com resultados pertinentes ao filtro digitado.

Fluxo 2: Quando incluindo ou alterando um histórico contábil usuário seleciona as opções de natureza para o mesmo.

• Sistema habilita/desabilita os campos de conta de crédito ou débito de acordo com a natureza selecionada conforme regra de negócio RN02.

Fluxo 3: Quando incluindo ou alterando um histórico contábil usuário informa no campo do código da conta contábil de débito ou crédito o código completo ou o código reduzido de uma determinada conta.

• Sistema pesquisa as contas cadastradas de natureza coerente com a do campo em questão através do seu código e também do código reduzido.
• Se uma conta for encontrada com código digitado (completo ou reduzido) seus dados serão automaticamente preenchidos no campo em questão.
• Se nenhuma conta for encontrada com o código informado, o balão informando que o dado digitado é invalido será exibido conforme padrões de desenvolvimento.
• Caso mais de um resultado seja encontrado, estes serão listados ao usuário para que ele selecione o registro desejado.

Fluxos de exceção

Fluxo 1: Usuário informa na descrição do histórico contábil o caractere $ seguido de um ou mais caracteres que não constam na tabela informativa ao lado, onde são listadas as orientações sobre utilização de coringas. Em seguida usuário aciona o botão [Salvar].

• Sistema aborta a operação e exibe ao usuário a seguinte mensagem de alerta: O coringa utilizado na descrição do histórico não é válido. Verifique as orientações sobre a utilização de coringas listadas na tela e tente novamente.

Fluxo 2: Em modo de inclusão ou alteração, apesar do sistema não listar/pesquisar nos campos de contas contábeis uma conta cuja natureza não condiz com a natureza do campo, usuário informa o código de uma conta de natureza diferente da natureza do campo e aciona o botão [Salvar].

• Sistema aborta a operação e emite ao usuário a seguinte mensagem de alerta: No campo XXXX só poderão ser informadas contas cuja natureza seja YYYY. Onde XXXX corresponde ao nome do campo e YYYY à natureza do mesmo.

Regras de negócio

RN01 - Tela de pesquisa

Exibirá os históricos já cadastrados no sistema em um grid com as seguintes colunas:

1. ATIVO
2. DESCRIÇÃO
3. NATUREZA
4. CONTA DE DÉBITO
5. CONTA DE CRÉDITO

    
    O grid utilizará o mecanismo de consulta lucene.

RN02 - Tela de manutenção

1. Ativo: Define se um determinado histórico está ativo para uso ou não.
2. Descrição: Campo (input) onde deverá ser informada, obrigatoriamente, a descrição do histórico contábil (até 100 caracteres).
3. Natureza: Campo (combobox) onde deverá ser selecionada a natureza do histórico. As opções serão as seguintes:
   • Débito: Indica que o histórico estará associado somente a movimentações que irão gerar débito. Caso esta natureza seja selecionada, será habilitado logo abaixo o campo Conta de débito.
   • Crédito: Indica que o histórico estará associado somente a movimentações que irão gerar crédito. Caso esta natureza seja selecionada, será habilitado logo abaixo o campo Conta de crédito.
   • Indiferente: Indica que o histórico estará associado tanto a movimentações de crédito quanto movimentações de débito, de acordo com a escolha do usuário. Com esta natureza selecionada serão habilitados abaixo os campos Conta de débito e Conta de crédito.
4. Conta de débito: Desabilitado por padrão este campo só estará ativo quando selecionadas as naturezas Débito ou Indiferente no histórico. Nele somente poderão ser informadas contas contábeis cadastradas com a natureza Débito.
5. Conta de crédito: Desabilitado por padrão este campo só estará ativo quando selecionadas as naturezas Crédito ou Indiferente no histórico. Nele somente poderão ser informadas contas contábeis cadastradas com a natureza Crédito.

    
    As contas contábeis poderão ser informadas pelo código ou pela descrição a exemplo de como ocorre hoje nas rotinas onde são informadas as contas caixa. 
    Para contas contábeis haverá uma funcionalidade extra que permitirá ao usuário buscar contas também pelo código reduzido, digitando-o no mesmo lugar onde é informado 
    o código convencional.

Utilização de coringas

À direita dos campos com os dados do histórico, será exibido um quadro com informações sobre a utilização de coringas conforme segue abaixo:

No histórico de caixa poderão ser inseridos coringas, que dependendo de onde o histórico será utilizado e do(s) coringa(s) selecionado(s), diferentes informações serão automaticamente acrescentadas em sua descrição. Os coringas deverão ser inseridos na própria descrição do histórico no ato de seu cadastro identificados pelo caractere $ seguido de um dos caracteres listados na tabela abaixo.

CORINGA	FUNÇÃO
$N	Este coringa será substituído pelo número do documento contábil, que será exigido do usuário no momento em que o histórico for utilizado.
$OBS	Este coringa será substituído por uma observação/texto livre, que será exigido do usuário no momento em que o histórico for utilizado.
$DMA	Este coringa será substituído pelo dia/mês/ano da movimentação do documento no qual seu histórico foi utilizado.
$DOC	Este coringa será substituído pelo número do documento no qual o histórico em questão foi utilizado.

Atenção!

O histórico contábil comporta até 100 caracteres. Ao utilizar coringas, certifique-se de que a descrição cadastrada no histórico e os dados que serão inseridos no lugar do coringa não excederão os 100 caracteres. O sistema irá descartar quaisquer informações presentes no histórico após o centésimo caractere.