Composição do arquivo

 Top  Previous  Next

 

Neste tópico será exemplificado a formação de arquivos de Operação de Transporte no formato .txt.

 

 

hmtoggle_arrow1        Registros

O arquivo de Operação de Transporte no formato .txt é composto por linhas - tratadas aqui como registros – que são identificadas por uma sequência numérica de 4 dígitos. Cada registro do arquivo representa um grupo de informações, que por sua vez é composto por um ou mais campos.

Na composição dos arquivos de Operação de Transporte, existem também registros aninhados, os quais não podem existir sem que anteriormente exista um registro “pai”. Por exemplo: um registro 2000 indica um grupo de informações mais abrangente, enquanto o registro 2100 representa um grupo de informações mais específicas, aninhado dentro do grupo 2000. Esta relação de grupo de informações pode ser observada com a indicação “Pai” que cada registro possui, onde é indicado o grupo de informações ao qual o registro pertence.

 

Importante:

✓Neste conceito de registros aninhados, é importante notar que quando um registro “pai” não for informado, os seus registros “filhos” não serão informados também, mesmo que estes constem como obrigatórios. Um registro “filho” não existe sem um registro “pai”.

 

Ainda em relação aos registros, deve-se observar a sua ocorrência. Esta indicação determina, resumidamente, o número de vezes que um registro deve/pode aparecer para cada Operação de Transporte, sendo:

o1 = O registro deve existir uma única vez na Operação de Transporte;

 

o1 - 5 = O registro deve existir ao menos uma vez na Operação de Transporte e, caso necessário, poderá ser repetido até cinco vezes;

 

o1 – N = O registro deve existir ao menos uma vez na Operação de Transporte e, caso necessário, poderá ser repetido tantas vezes for necessário;

 

o2 – N = O registro deve ser indicado ao menos duas vezes e, caso necessário, poderá ser repetido tantas vezes for necessário;

 

o0 – 1 = Não é obrigatória a existência do registro na Operação de Transporte;

 

o0 – N = Não é obrigatória a existência do registro. Nos casos em que o registro existir, poderá ser repetido tantas vezes for necessário.

 
hmtoggle_arrow1        Campos

Os campos devem conter os dados da Operação de Transporte e são separados por ponto e vírgula (;). Cada campo possui uma especificação de tipo, indicado na tabela através da coluna “Tipo”, podendo ser: N = numérico; C = caractere (texto); D = data. Há também uma especificação de tamanho do campo, indicado através do campo “Tam.”. Nos casos de campos com casa decimais, a coluna “Dec.” indica o número de casas decimais que deve haver após o separador ponto (.).

A coluna “Obr.” indica a obrigatoriedade de preenchimento do campo. Campos assinalados com “S” deverão, obrigatoriamente, ser preenchidos no arquivo. Os campos assinalados com “N” podem ter o seu preenchimento suprimido, mas ainda assim devem ser indicados no registro (vide exemplos).

 
hmtoggle_arrow1        Codificação

A codificação dos arquivos deve ser UTF-8. Caso o conteúdo do arquivo possua caracteres especiais, sua codificação deve ser Unicode.

 
hmtoggle_arrow1        Retorno para arquivos com falha de sintaxe

Os arquivos que forem processados pelo serviço do Agente poderão apresentar falhas na sua estrutura (falhas de sintaxe) que impeçam o seu correto processamento e, consequentemente, o correto envio para processamento no datacenter nddCargo. Para estes casos existirá um arquivo de integração específico que assim como os demais retornos, terá uma nomenclatura específica e será gravado no diretório de acordo com o tipo de operação. A nomenclatura será a seguinte:

 

Arquivos sem identificação de processo: caso seja colocado para processamento um arquivo em que a nomenclatura esteja fora do padrão, será gerado um arquivo de retorno conforme segue: Err[indefinido]_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de envio: ErrLote_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de cancelamento: ErrCanc_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de alteração: ErrAlte_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de encerramento: ErrEnce_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de impressão: ErrImpr_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de pagamento imediato de parcelas: ErrPimd_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de consulta de pagamentos: ErrPgto_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de resumo de operação de transporte: ErrResu_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de consulta de informações na ANTT: ErrAntt_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de consulta de status de viagem Via Fácil: ErrCsvf_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de consulta de recibo de viagem Via Fácil: ErrRbvf_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de consulta de eventos de efetivação de pagamento: ErrEvef_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de confirmação de pagamento: ErrCfpg_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de Download de Operação: ErrDowo_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de Consulta de saldo da contratante: ErrCsld_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de Consulta de portador do cartão: ErrCspc_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

 Arquivos de Reprocessamento de Pagamento: ErrRepg_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

Arquivos de Consulta de Roteirizador: ErrCrtz_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt

Arquivos de Documentos adicionais: ErrDoad_nomeDoArquivoOriginal_ddMMyyyyHHmmssfff.txt