Histórico da Página

...

02. SITUAÇÃO/REQUISITO

...

Com a nova funcionalidade de exportação e importação de históricos através de arquivo, faz-se necessário a criação de uma documentação para padronizar o formato em que o arquivo de importação/exportação se encontrará.

03. SOLUÇÃO

O layout de importação será o mesmo de exportação, e será o seguinte:

Na exportação, algumas das linhas do arquivo serão cabeçalhos, para facilitar a visualização dos dados do histórico. No momento da importação esses cabeçalhos podem ser informados ou omitidos sem problemas, pois caso informados, o processo de importação automaticamente irá desconsiderar eles.

O primeiro campo de cada linha será uma string, um código com valores pré-estabelecidos, e que servem para identificar o tipo de linha.
Os valores códigos possíveis são:

HC: Linha de cabeçalho do topo do histórico
CC: Linha de cabeçalho das partidas do histórico
EC: Linha de cabeçalho das empresas do histórico
MC: Linha de cabeçalho dos módulos do histórico

H: Linha com as informações de topo do histórico
C: Linha com as informações das partidas do histórico, tanto as partidas fiscais quanto as gerenciais
P: Linha com as informações dos parâmetros das partidas do histórico
E: Linha com as informações das empresas em que o histórico é aceito
M: Linha com as informações dos módulos em que o histórico é aceito

Linhas Linha do tipo H:

A linha com identificador H que deve informar as informações do topo do histórico.
É importante notar deve haver apenas  um histórico por arquivo, então por consequência o arquivo terá apenas uma linha do tipo H.

Campos:

Regras de negócio:

RNH1: O codigo reduzido informado será usado pelo sistema de importação para identificar se o histórico do arquivo já existe na base (nesse caso, a operação a ser realizada será a atualização dos dados do histórico já existente), ou então se o arquivo do histórico é um novo histórico (nesse caso, a operação a ser realizada será a de cadastramento desse histórico na base).
RNH2: O campo seqrateiodinamico só deve ser informado quando o campo tiporateio for 'D', e nesse caso, a informação a ser colocada aqui é o id da configuração de rateio dinâmico. Caso contrario, o campo deve ser deixado vazio.
RNH3: O campo lancamentoperiodico só pode ser informado como 'S' caso o campo tipoRateio for diferente de 'N'.


Linhas do tipo C - Informações da partida:

As linhas com identificador C trazem as informações das partidas do histórico, e é obrigatório que o histórico tenha pelo menos uma partida de débito e uma de crédito.Linhas do tipo C:

Campos:

Regras de negócio:

RNHC1: o campo porcentagem Só deve ser preenchido caso tiporateio seja 'S' e se esse for o caso, a soma das porcentagens das partidas de um mesmo tipo (débito ou crédito) deve ser igual a 100. Caso contrário, o campo deve ser deixado vazio. 
RNHC2: O campo critério só deve ser informado caso o tiporateio  seja 'D' e se esse for o caso, deve ser informado a descrição de um critério pertencente à configuração de rateio dinâmico referenciada no campo seqrateiodinamico.


Linhas do tipo C - Informação dos parâmetros:

Nas linhas de partida também ficam as informações dos parâmetros de cada partida, sendo que a cada linha de partida pode ter de 0 a 6 parâmetros. As informações de parâmetro são dispostas em forma de colunasLinhas do tipo P:

Campos:

Regras de negócio:

RNHP1: O cadastro de histórico em tela possibilita a criação de uma partida com 1 ou mais parâmetros em cada nível, como por exemplo podemos ver nessa imagem. Na importação, não é possível informar dois ou mais parâmetros de um mesmo tipo em uma mesma linha, então o que deve ser feito é informar duas linhas de partida, onde a informação da partida é igual, mas a informação dos parâmetros é diferente. Com isso a aplicação entenderá que os dois parâmetros pertencem a uma mesma partida. Um exemplo de como isso seria feito pode ser visto nessa imagem.
RNHP2: Como o nível dos parâmetros não é informado de maneira explicita, através de um campo específico, a ordem que os parâmetros são informados no arquivo é utilizada para definir o nível dos mesmos. Assim sendo, o primeiro parâmetro, da esquerda para a direita, será o parâmetro de nível 1; o segundo, nível 2, e assim por diante.
RNHP3: O campo porcentagem só deve ser preenchido caso o campo tiporateio  seja 'S' ou 'D'.
RNHP4: Caso tiporateio  seja 'S', a soma das porcentagens de parâmetros de um mesmo nível e

...

pertencentes a um mesmo parâmetro/partida pai deve ser

...

igual ao valor de porcentagem desse pai (valor da porcentagem da partida caso os parâmetros sejam de nível 1, ou valor da porcentagem do parâmetro pai caso os parâmetros sejam do nível 2 ou maior).

...

RNHP5: Caso tiporateio  seja 'D', a soma das porcentagens de parâmetros de um mesmo nível e

...

pertencentes a um mesmo parâmetro/partida pai deve ser igual

...

deve ser 100. Isso para que possam representar 100% do valor da porcentagem dinâmica da partida (caso estejamos falando de parâmetros de nível 1) ou do parâmetro pai (caso estejamos falando de parâmetros de nível 2 ou maior).

...

Linhas do tipo E:

Campos:

Regras de negócio:

RNHE1: O histórico deve estar ativo para pelo menos uma empresa.

Linhas do tipo M:

Campos:

Regras de negócio:

RNHM1: O histórico deve estar ativo para pelo menos um módulo.

Exemplo:
Arquivo: historico_csv

04. DEMAIS INFORMAÇÕES

Disponível a partir da versão 24.07.

...