Qual a finalidade deste documento?

Este guia foi preparado para auxiliar os desenvolvedores na integração do Sistema Hiper com outros sistemas de informação de qualquer natureza, através do aplicativo HiperConnection, integrante do conjunto de ferramentas do Sistema Hiper.

As informações descritas aqui devem ser utilizadas para a finalidade exclusiva de integração entre os sistemas, podendo causar efeitos inesperados se aplicadas para outros propósitos.

Entendendo os conceitos utilizados no guia

Por se tratar de um documento técnico, na sua elaboração foram utilizados termos e abreviações específicas, as quais são detalhadas a seguir.

Colunas das tabelas de layout

Tipos de dados (Tipo)

Cada campo mencionado neste layout está relacionado a um tipo de dado que representará o conjunto de caracteres que são aceitos para os dados do referido campo, conforme detalhado na tabela abaixo.

Sigla Descrição
C Campo para valores alfanuméricos
N Campo para valores numéricos
B Campo de afirmação ou negação.Os valores aceiros são:1 – Para representar afirmação, positividade, concordância

0 – Para representar negação, não concordância

D Campo para data (sem horas)Informar somente números, sem qualquer símbolo ou letra.Exemplo:

Para a data e hora: 25/12/2011 20:15:10

Informar: 25122011

T Campo para data e horaInformar somente números, sem qualquer símbolo ou letra.Exemplo:

Para a data e hora: 25/12/2011 20:15:10

Informar: 25122011201510

 

Tamanho (Tam) e Decimais (Dec)

A coluna tamanho “Tam” representa a quantidade de dígitos que são aceitos para o campo do layout.

Quando se tratar de campos correspondentes a valores numéricos, e estes aceitarem casas decimais, a quantidade de dígitos aceitos para as casas decimais será informada na coluna “Dec”, para representar um número com Tam = 5 e Dec = 3 o conteúdo deverá estar separado por ponto “.” conforme exemplo: 99999.999

Obrigatoriedade do campo (Obr)

Alguns campos são opcionais, outros obrigatórios. Existem ainda os campos que são obrigatórios de acordo com a operação que se deseja realizar.

Na tabela a seguir são especificadas as siglas que representam as condições de obrigatoriedade dos campos. Quando as condições forem combinadas, as siglas serão separadas por hífen “-“.

Sigla Descrição
I Campo obrigatório apenas para a operação de inclusão
A Campo obrigatório apenas para a operação de alteração
E Campo obrigatório apenas para a operação de exclusão
* Campo obrigatório em todas as situações
Campo opcional, seu preenchimento não é obrigatório

 

Regras de validação

Antes do processamento do arquivo o HiperConnection vai realizar a validação do conteúdo do arquivo.

Caso ocorra algum erro na etapa de validação será gerado no diretório de saída, o arquivo de retorno com o registro 0000 contendo no campo Situação de processamento o valor 2 (Arquivo rejeitado) e no campo Texto descritivo da ocorrência de sucesso ou erro, o motivo da rejeição e número da linha do arquivo onde foi identificado o erro.

Os motivos para rejeição do arquivo são:

  • Ausência do registro de abertura do arquivo;
  • Situação de processamento inválido;
  • Código do registro inválido;
  • Seqüência do registro inválida;
  • Quantidade de campos do registro inválido;
  • Ausência de registro filho obrigatório;
  • Número de linhas diferente do registro 9999; e
  • Ausência do registro de encerramento do arquivo;