Manual do Usuário
Aplicações de Transmissão Automática de Arquivos
Versão 1.0
Índice
1. Objetivo ...3
2. Introdução...3
3. Arquivos das aplicações ...3
4. Aplicação de configuração e monitoração das aplicações ...4
4.1 Configuração Remessa ...5
4.2 Configuração Retorno ...6
4.3 Monitoração Remessa ...8
4.4 Monitoração Retorno ...9
5. Aplicação de transmissão automática de arquivos de remessa ...10
5.1 Utilização ...10
5.2 Funcionamento ...11
6. Aplicação de recepção automática de arquivos de retorno ...13
6.1 Utilização ...13
6.2 Funcionamento ...14
Apêndice I – Tabela de prefixos para os nomes dos arquivos de remessa na transmissão automática ...17
Apêndice II – Arquivo de configuração das aplicações...18
Manual do Usuário das Aplicações de Transmissão Automática de Arquivos
1. Objetivo
Este documento tem como objetivo descrever as aplicações distribuídas junto com o Kit
“Aplicação de Transmissão Automática” disponível para download no Site Cliente do WebTA (site do Net Empresa, opção Transferência de Arquivos - WebTA).
2. Introdução
O WebTA fornece um conjunto de aplicações que implementam a funcionalidade de transmissão automática de arquivos do WebTA, tanto para arquivos de remessa como para arquivos de retorno. Na transmissão automática de arquivos do WebTA, trafegam apenas arquivos criptografados, utilizando-se a infra-estrutura de criptografia fornecida pelo WebTA.
Para maior segurança da empresa, a transmissão automática de arquivos de remessa só poderá ser utilizada para os serviços que estiverem configurados com Aprovação de Remessa habilitada.
Estas aplicações foram desenvolvidas na plataforma Java J2SE 5.0, acessando os métodos do Web Service do WebTA e utilizando a biblioteca de Criptografia do WebTA. Logo, é pré- requisito para executá-las a instalação do ambiente de execução Java 5 ou superior (JRE – Java Runtime Environment).
Esta funcionalidade está distribuída em 3 aplicações, que executarão no ambiente da empresa cliente do WebTA:
• Aplicação de configuração e monitoração local das aplicações;
• Aplicação de transmissão automática de arquivos de remessa criptografados;
• Aplicação de recepção automática de arquivos de retorno criptografados.
Posteriormente explicaremos com maiores detalhes cada uma destas.
3. Arquivos das aplicações
O conjunto de arquivos disponibilizados para download destas aplicações é composto dos seguintes arquivos:
- IniciaWebTAClienteTransmissao.bat e IniciaWebTAClienteTransmissao.sh: são os scripts para execução da aplicação de transmissão automática de arquivos de remessa,
respectivamente para os ambientes Windows e Unix;
- webtaTransferencia-remessa.v.1.0.0.jar: aplicação de transmissão automática de arquivos;
- IniciaWebTAClienteRecepcao.bat e IniciaWebTAClienteRecepcao.sh: são os scripts para execução da aplicação de recepção automática de arquivos de retorno, respectivamente para os ambientes Windows e Unix;
- webtaTransferencia-retorno.v.1.0.0.jar: aplicação de recepção automática de arquivos;
- IniciaWebTAClienteConfigMonitoracao.bat e IniciaWebTAClienteConfigMonitoracao.sh: são os scripts para execução da aplicação de configuração e monitoração;
- webtaTransferencia-configuracao.v.1.0.0.jar: aplicação de configuração e monitoração;
- webtaTransferencia-comum.v.1.0.0.jar: biblioteca auxiliar utilizada pelas aplicações;
- WebTACliente.properties: arquivo de configurações das aplicações;
- diretório lib: neste diretório estão as bibliotecas externas às aplicações, mas que são necessárias para suas execuções:
- webta-cripto-v.1.3.jar: biblioteca de criptografia e compressão do WebTa;
- webtaTransferencia.v.1.0.0.jar: biblioteca que encapsula as funcionalidades de transmissão e recepção automática de arquivos (maiores informações vide documento Manual_Desenv_Trans_Autom.pdf);
- wswebta-client-v.1.0.jar: biblioteca para acesso ao Web Service gerado a partir de seu arquivo WSDL utilizando o framework Axis*;
- axis.jar, commons-discovery-0.2.jar, commons-logging-1.0.4.jar, jaxrpc.jar, saaj.jar e wsdl4j-1.5.1.jar: são as bibliotecas utilizadas pelo framework Axis;
- log4j-1.2.15.jar: biblioteca de geração de logs, utilizada pelas aplicações do WebTA.
(*) Axis: framework para desenvolvimento de Web Services.
4. Aplicação de configuração e monitoração das aplicações
Esta aplicação é a responsável pela configuração e monitoração das demais.
Esta aplicação possui uma interface gráfica cujas funcionalidades estão segmentadas em 4 abas:
• Configuração Remessa;
• Configuração Retorno;
• Monitoração Remessa;
• Monitoração Retorno.
As funcionalidades de configuração referem-se à manipulação do arquivo de configuração WebTACliente.properties (vide Apêndice II).
As funcionalidades de monitoração permitem verificar o funcionamento/execução das aplicações de transmissão e recepção automática.
Para executar esta aplicação, abra uma console (shell ou cmd.exe) e de acordo com o Sistema Operacional utilize uma das linhas de comando abaixo:
Windows: IniciaWebTAClienteConfigMonitoracao.bat <ENTER>
UNIX: IniciaWebTAClienteConfigMonitoracao.sh <ENTER>
4.1 Configuração Remessa
A primeira aba refere-se à configuração dos parâmetros de caminhos necessários para a execução da aplicação de transmissão de arquivos de remessa:
• Caminho dos arquivos para transmissão: é onde a aplicação de transmissão buscará os arquivos de remessa para transmiti-los ao Servidor WebTA. Lembrando que estes arquivos deverão estar criptografados no formato WebTA e que os nomes dos mesmos deverão ter um prefixo padrão, conforme detalhado no Apêndice I.
• Caminho dos arquivos transmitidos: após a transmissão efetuada com sucesso de cada arquivo, a aplicação de transmissão o move para um subdiretório deste caminho. Este subdiretório tem seu nome representando a data da transmissão, no formato aaaammdd, onde aaaa = ano, mm = mês e dd = dia. Ou seja, os arquivos transmitidos de cada dia são agrupados em subdiretórios cujo nome representa a data da transmissão.
• Caminho dos arquivos com erro na transmissão: se houver qualquer tipo de inconsistência no arquivo a ser enviado ao Servidor WebTA, seja ela detectada pela aplicação de transmissão ou pelo próprio Servidor WebTA, a aplicação de transmissão deverá movê-lo para um subdiretório deste caminho. Este subdiretório terá o nome representando a data da tentativa de transmissão, no formato aaaammdd, onde aaaa = ano, mm = mês e dd = dia.
• Caminho dos Logs do processamento de remessa: os arquivos de logs da aplicação de transmissão serão gerados neste caminho e serão diários. Existem dois arquivos de log:
- remessa.log: armazena os registros de log de execução da aplicação, o que inclui eventuais mensagens de erro;
- trace_remessa.log: armazena os registros das chamadas executadas aos métodos do Web Service do WebTA pela aplicação;
Para cada mudança de dia são gerados novos arquivos, os anteriores são renomeados para remessa.log.aaaammdd e trace_remessa.log.aaaammdd, onde aaaa = ano, mm = mês e dd = dia e somente remessa.log para o dia corrente.
Para configurar estes parâmetros, preencha cada campo com o caminho desejado ou clique no botão “...” para selecionar o diretório desejado e o campo será preenchido automaticamente.
Após configurar com os valores desejados, o usuário deve clicar no botão Salvar para que os valores sejam atualizados no arquivo de configuração.
Se a aplicação de transmissão estiver em execução, ela deverá ser reiniciada para que os novos valores sejam utilizados.
Quando o programa de configuração e monitoração é iniciado, ele irá apresentar nos campos os valores atuais existentes no arquivo de propriedades. Se os caminhos configurados não existirem no sistema de arquivos ou o usuário não tiver permissão de escrita ou leitura nesses diretórios, os mesmos serão apresentados na cor vermelha.
4.2 Configuração Retorno
A segunda aba refere-se à configuração dos parâmetros de caminhos necessários para a execução da aplicação de recepção de arquivos de retorno:
• Caminho dos arquivos recebidos: caminho que conterá os arquivos de retorno recebidos do Servidor WebTA pela aplicação de recepção. Os arquivos são gravados no formato criptografado do WebTA. O arquivo que ainda estiver em processo de recepção tem seu nome composto da extensão “.RX”; ao término da recepção do arquivo, esta é retirada.
• Caminho dos Logs do processamento de retorno: os arquivos de logs da aplicação de recepção serão gerados neste caminho e serão diários. Existem dois arquivos de log:
- retorno.log: armazena os registros de log de execução da aplicação, o que inclui eventuais mensagens de erro;
- trace_retorno.log: armazena os registros das chamadas executadas aos métodos do Web Service do WebTA pela aplicação;
Para cada mudança de dia são gerados novos arquivos, os anteriores são renomeados para retorno.log.aaaammdd e trace_retorno.log.aaaammdd, onde aaaa = ano, mm = mês e dd = dia e somente retorno.log para o dia corrente.
Para configurar estes parâmetros, preencha cada campo com o caminho desejado ou clique no botão “...” para selecionar o diretório desejado e o campo será preenchido automaticamente.
Após configurar com os valores desejados, o usuário deve clicar no botão Salvar para que os valores sejam atualizados no arquivo de configuração.
Se a aplicação de recepção estiver em execução, ela deverá ser reiniciada para que os novos valores sejam utilizados.
Quando o programa de configuração e monitoração é iniciado, ele irá apresentar nos campos os valores atuais existentes no arquivo de propriedades. Se os caminhos configurados não existirem no sistema de arquivos ou o usuário não tiver permissão de escrita ou leitura nesses diretórios, os mesmos serão apresentados na cor vermelha.
4.3 Monitoração Remessa
A terceira aba refere-se à monitoração da aplicação de transmissão de arquivos de remessa:
O usuário poderá monitorar os parâmetros:
• Total de arquivos pendentes para transmissão: quantidade de arquivos que ainda não foram processados pela aplicação;
• Total de arquivos transmitidos com sucesso: quantidade de arquivos transmitidos com sucesso no dia (total de arquivos existentes no diretório de transmitidos do dia);
• Total de arquivos com erro na transmissão: quantidade de arquivos com erro do dia (total de arquivos existentes no diretório do dia de arquivos com erro na transmissão);
• Log do processamento de remessa: permite visualizar os registros de log gerados pela aplicação no dia. Dentre estes registros estarão aqueles que informam erros detectados pela aplicação e aqueles com mensagens informativas do envio de arquivos.
A aplicação de transmissão de arquivos atualiza periodicamente o arquivo de logs com mensagens indicando que a aplicação está em execução. Quando não existem arquivos
para transmissão, é gravada uma mensagem informando a operação de busca de arquivos: “Inicia busca de arquivos.”. Se a aplicação estiver transmitindo um arquivo, é gravada a mensagem “Iniciando a transmissao do arquivo: ...”. Caso o arquivo de logs não esteja sendo atualizado, é necessário verificar se a aplicação está em execução, se existe alguma mensagem de erro que a fez encerrar sua execução, corrigir o problema e reiniciá-la.
Atenção: Deve-se garantir que haja apenas uma instância da aplicação de transmissão de arquivos executando.
Para atualizar as informações exibidas nesta aba, o usuário deve clicar no botão Atualizar.
4.4 Monitoração Retorno
A quarta aba refere-se à monitoração da aplicação de recepção de arquivos de retorno:
O usuário poderá monitorar os parâmetros:
• Total de arquivos recebidos: quantidade de arquivos de retorno recebidos com sucesso do Servidor WebTA; este contador apresentará o número total de arquivos de retorno existentes no diretório. Se o sistema da empresa mantiver os arquivos recebidos nesse diretório, esse número estará sempre aumentando. Sugere-se implementar uma política de limpeza periódica nesse diretório.
• Log do processamento de retorno: permite visualizar os registros de log gerados pela aplicação. Dentre estes registros estarão aqueles que informam erros detectados pela aplicação e aqueles com mensagens informativas que indicam se a aplicação está ativa.
A aplicação de recepção de arquivos atualiza periodicamente o arquivo de logs com mensagens indicando que a aplicação está em execução. Quando não existem arquivos para recepção, é gravada uma mensagem informando a operação de busca de arquivos:
“Inicia busca de arquivos”. Se a aplicação estiver recebendo um arquivo é gravada a
mensagem “Iniciando a recepcao do arquivo: ...”. Caso o arquivo de logs não esteja sendo atualizado, é necessário verificar se a aplicação está em execução, se existe alguma mensagem de erro logada que fez a aplicação encerrar sua execução, corrigir o problema e reiniciá-la.
Atenção: Deve-se garantir que haja apenas uma instância da aplicação de recepção de arquivos executando.
Para atualizar as informações exibidas nesta aba, o usuário deve clicar no botão Atualizar.
5. Aplicação de transmissão automática de arquivos de remessa
Atualmente, o sistema da empresa gera um arquivo de remessa em formato texto. Um usuário específico acessa o Site Cliente do WebTA e transmite o arquivo de remessa ao Servidor WebTA.
Com as bibliotecas e o Web Service fornecidos pelo WebTA, a empresa poderá alterar sua aplicação para realizar a automação do processo de transmissão de arquivos de remessa, ou ainda utilizar a aplicação fornecida.
5.1 Utilização
O primeiro passo para a utilização desta aplicação é adequar seu Sistema para que gere arquivos de remessa no formato criptografado do WebTA. No site cliente do WebTA estão disponíveis duas versões do componente de criptografia do WebTA (Java e Windows) que permite que o Desenvolvedor de sua aplicação faça a alteração.
A utilização de arquivos criptografados tem como objetivo garantir a confidencialidade do conteúdo dos arquivos de remessa no ambiente da empresa. Ao adequar sua aplicação para gerar arquivos criptografados, garantirá que durante todo o processo de envio do arquivo, em nenhum momento o mesmo tenha seu conteúdo mantido “em aberto”.
Com a aplicação de configuração, altere o caminho dos arquivos para transmissão, para aquele no qual sua aplicação gerará os arquivos de remessa. O nome de cada arquivo deverá ser gerado de acordo com um prefixo que determina qual o tipo de serviço a que ele se refere (vide Apêndice I).
Abra uma console (shell ou cmd.exe) para executar a aplicação e, de acordo com o Sistema Operacional, utilize uma das linhas de comando abaixo:
Windows: IniciaWebTAClienteTransmissao.bat <ENTER>
UNIX: IniciaWebTAClienteTransmissao.sh <ENTER>
Na console será exibida a mensagem “Informe o Caminho Chave:”, o usuário deverá informar o caminho completo (diretório e nome do arquivo) do arquivo da chave de criptografia para comunicação da transferência automática. Este é um dos arquivos que foram gerados no Ambiente Gerencial do WebTA durante a habilitação da Criptografia, seu nome tem o formato transferenciaaaaammddHHMM.bin, onde aaaammddHHMM representam a data e hora da criação do arquivo chave.
Preenchido o caminho completo, tecle <ENTER>, será exibida a mensagem “Informe a Senha Chave:”, o usuário deverá informar a mesma senha usada na geração das chaves de criptografia e teclar <ENTER>. Por questões de segurança, o valor da senha não é exibido na tela.
Se estes valores forem informados corretamente, a aplicação será iniciada. Utilize a aplicação de monitoração para verificar o funcionamento da aplicação de transmissão automática.
5.2 Funcionamento
Neste ponto é apresentada uma visão geral do funcionamento da aplicação:
1. Inicialmente a aplicação efetua a validação dos parâmetros do arquivo de configuração (WebTACliente.properties). A maioria dos parâmetros de configuração da aplicação são os caminhos no sistema de arquivos. Sugere-se a seguinte estrutura:
Raiz | -- WebTA |
-- Remessa | |
| -- arquivosParaTransmissao | |
| -- arquivosTransmitidos | |
| -- arquivosComErro |
-- Retorno |
-- logs
2. A aplicação busca por arquivos de remessa para transmissão no caminho configurado;
3. Se não encontrou arquivo para transmissão, a aplicação aguarda pelo tempo configurado (parâmetro frequencia_remessa do arquivo de configuração) e volta para o item 2;
4. A aplicação encontrou um arquivo para transmissão, então renomeia o arquivo inserindo um caractere “_” (underline) na frente de seu nome. No item 2, quando é feita a busca por arquivos de remessa, o arquivo com este prefixo tem a prioridade para transmissão, pois trata-se do reinício (restart) do envio do arquivo;
5. É feita autenticação com o Servidor WebTA, criando-se uma sessão para realizar a comunicação;
6. A aplicação transmite o arquivo selecionado no item 2, tratando o reinício(restart), se necessário. Isto só acontece se a aplicação for finalizada no meio da transmissão de
um arquivo. Ao iniciar novamente a aplicação, a mesma irá finalizar a transmissão que foi interrompida anteriormente.
Vale a pena salientar que a transmissão manual de arquivos continua disponível para a empresa no site do WebTA, podendo ser utilizada, se necessário, desde que os arquivos de remessa estejam criptografados.
7. Se o arquivo foi transmitido com sucesso, ele é movido para um diretório nomeado com a data corrente aaaammdd dentro do “Caminho de arquivos transmitidos”. Se durante a transmissão ocorrer um erro do tipo:
• erro de comunicação: a aplicação aguarda dois minutos e reinicia a transmissão do arquivo;
• erro de sessão: a aplicação autentica-se novamente com o Servidor e reinicia a transmissão;
• quaisquer outros tipos de erros: a aplicação move o arquivo para um diretório nomeado com a data corrente aaaammdd dentro do “Caminho dos arquivos com erro de transmissão”, registra a mensagem de erro no arquivo de logs e reinicia o processo de busca de arquivo para transmissão (item 2).
Durante a sua execução, a aplicação gera no caminho configurado para os logs, os arquivos:
- remessa.log: arquivo do dia corrente com registros de mensagens de execução da aplicação e de erros;
- trace_remessa.log: arquivo do dia corrente com registros das chamadas aos métodos do Web Service (trace de comunicação).
Só deve ser executada uma instância desta aplicação, porque haverá concorrência no tratamento dos arquivos, comprometendo o seu funcionamento.
Vale a pena salientar que todos os arquivos de remessa transmitidos automaticamente ficarão pendentes de aprovação, ou seja, só serão processados pelo Banco depois que forem aprovados pelo(s) representante(s) legal(ais) da empresa, no site WebTA (Net Empresa, opção Transferência de Arquivos – WebTA).
Notas:
• Caso a empresa deseje executar esta aplicação em uma máquina acessando a Internet via proxy, esta configuração deverá ser feita fora da aplicação, ou seja, deve-se habilitar o proxy na configuração da JVM (Java), ou então utilizar um proxy-client.
• A empresa poderá trocar as chaves de criptografia utilizadas pelo WebTA periodicamente, no Ambiente Gerencial (link na página de Configurações do WebTA / Aprovação de Remessa). Nesse processo, são gerados dois arquivos:
um com a chave para a criptografia dos arquivos e outro com a chave utilizada na autenticação do processo de transmissão automática de arquivos. Ao trocar as chaves no Ambiente Gerencial, as chaves anteriores tornam-se inválidas. A empresa deverá passar a utilizar as novas chaves imediatamente. As aplicações de transmissão e recepção automáticas do WebTA precisarão ser reiniciadas.
Portanto, antes de trocar as chaves, deve-se garantir que não haja arquivos de remessa criptografados e pendentes de transmissão e também arquivos de retorno criptografados recebidos e não processados pelo sistema da empresa.
6. Aplicação de recepção automática de arquivos de retorno
Para obter os arquivos de recepção, normalmente um usuário habilitado da empresa acessa a funcionalidade de Retorno do Site Cliente do WebTA. Ele preenche o filtro de consulta, seleciona os arquivos que deseja receber e efetua o download.
Esta aplicação do WebTA executa a recepção automática de arquivos de retorno. Esta aplicação foi desenvolvida utilizando as bibliotecas e o Web Service do WebTA. O uso desta aplicação não é obrigatório, o usuário pode desenvolver a sua própria, ou ainda continuar efetuando o download manual.
A aplicação disponibilizará somente os arquivos nunca recebidos; para receber arquivos novamente, deve-se utilizar o Site Cliente manualmente.
Lembrando que ao ativar a criptografia e transmissão automática, os arquivos de retorno recebidos do servidor WebTA virão no formato criptografado.
6.1 Utilização
Configure a aplicação direcionando para o diretório onde deseja receber os arquivos de retorno.
Abra uma console (shell ou cmd.exe) para executar a aplicação e, de acordo com o Sistema Operacional, utilize uma das linhas de comando abaixo:
Windows: IniciaWebTAClienteRecepcao.bat <ENTER>
UNIX: IniciaWebTAClienteRecepcao.sh <ENTER>
Na console será exibida a mensagem “Informe o Caminho Chave:”, o usuário deverá informar o caminho completo (diretório e nome do arquivo) do arquivo da chave de criptografia para comunicação da transferência automática. Este é um dos arquivos que foram gerados no Ambiente Gerencial do WebTA durante a habilitação da Criptografia, seu nome tem o formato transferenciaaaaammddHHMM.bin, onde aaaammddHHMM representam a data e hora da criação do arquivo chave.
Preenchido o caminho completo, tecle <ENTER>, será exibida a mensagem “Informe a Senha Chave:”, o usuário deverá informar a mesma senha usada na geração das chaves de criptografia e teclar <ENTER>. Por questões de segurança, o valor da senha não é exibido na tela.
Se estes valores forem informados corretamente, a aplicação será iniciada. Utilize a aplicação de monitoração para verificar o funcionamento da aplicação de recepção automática.
Adeque seu Sistema para utilizar o componente de Criptografia do WebTA e assim possa efetuar a leitura dos arquivos de retorno recebidos.
6.2 Funcionamento
Neste ponto é apresentada uma visão geral do funcionamento da aplicação:
ERP / Sistema da Empresa
Biblioteca de Criptografia do WebTA
Diretório para recepção de arquivos de retorno Aplicação de recepção
automática de arquivos de retorno Servidor WebTA
Bradesco Arq
uivo d reto e criptog rno
rafado HTTPS
1. Inicialmente a aplicação efetua a validação dos parâmetros do arquivo de configuração (WebTACliente.properties). A maioria dos parâmetros de configuração da aplicação são os caminhos no sistema de arquivos. Sugere-se a seguinte estrutura:
Raiz | -- WebTA |
-- Remessa | |
| -- arquivosParaTransmissao | |
| -- arquivosTransmitidos | |
| -- arquivosComErro |
-- Retorno |
-- logs
2. É feita autenticação com o Servidor WebTA, criando-se uma sessão para realizar a comunicação;
3. A aplicação utiliza um arquivo de controle chamado RETORNO.CTL, onde são gravadas as informações do arquivo em recepção. Este arquivo de controle é utilizado pela aplicação quando existe a necessidade de reiniciar(restart) a recepção de um arquivo que não foi finalizada.
Quando a aplicação inicia a recepção de um arquivo, ela o recebe adicionando a extensão “.RX” no nome do arquivo.
4. A aplicação acessa o servidor WebTA pedindo por um bloco de um arquivo para recepção. O pedido pode ser de um arquivo que já tinha sua recepção iniciada, ou para que o servidor envie o primeiro bloco de um novo arquivo.
5. O servidor retorna um bloco do arquivo, a aplicação grava-o em disco e atualiza o arquivo de controle. Se este bloco não for o último do arquivo, a aplicação retorna ao item 4.
Se o servidor não retornou arquivo para recepção, a aplicação encerra a sessão com o servidor, aguarda por alguns instantes (valor padrão mínimo de 5 minutos) e retorna ao item 2.
6. Se a aplicação recebeu o último bloco do arquivo, limpa o conteúdo do arquivo de controle e renomeia o arquivo retirando a extensão “.RX”.
Cada arquivo transmitido com sucesso pelo servidor tem seu status alterado para arquivo já consultado, indisponibilizando-o para a recepção automática. Se houver necessidade de recebê-lo novamente, o cliente deverá fazê-lo de modo manual, ou seja, acessar a opção “Recepção de Arquivos de Retorno” do site cliente do WebTA, preencher o filtro de busca, remover a opção “Apresentar apenas arquivos não recebidos”, executar a consulta e selecionar o arquivo que deseja receber novamente.
7. Se durante o processo de recepção ocorrer um erro do tipo:
• erro de comunicação: a aplicação aguarda dois minutos e reinicia a recepção do arquivo (item 3);
• erro de sessão: a aplicação autentica-se novamente com o Servidor e reinicia a recepção (item 2);
• quaisquer outros tipos de erros: apaga o arquivo em recepção “.RX” e limpa o conteúdo do arquivo de controle. Retorna ao item 4, para solicitar a recepção de arquivo.
Durante a sua execução, a aplicação gera no caminho configurado para os logs, os arquivos:
- retorno.log: arquivo do dia corrente com registros de mensagens de execução da aplicação e de erros;
- trace_retorno.log: arquivo do dia corrente com registros das chamadas aos métodos do Web Service (trace de comunicação).
Só deve ser executada uma instância desta aplicação, porque haverá concorrência no tratamento dos arquivos, comprometendo o seu funcionamento.
Notas:
• Caso a empresa deseje executar esta aplicação em uma máquina acessando a Internet via proxy, esta configuração deverá ser feita fora da aplicação, ou seja, deve-se habilitar o proxy na configuração da JVM (Java), ou então utilizar um proxy-client.
• A empresa poderá trocar as chaves de criptografia utilizadas pelo WebTA periodicamente, no Ambiente Gerencial (link na página de Configurações do WebTA / Aprovação de Remessa). Nesse processo, são gerados dois arquivos:
um com a chave para a criptografia dos arquivos e outro com a chave utilizada na autenticação do processo de transmissão automática de arquivos. Ao trocar as chaves no Ambiente Gerencial, as chaves anteriores tornam-se inválidas. A empresa deverá passar a utilizar as novas chaves imediatamente. As aplicações de transmissão e recepção automáticas do WebTA precisarão ser reiniciadas.
Portanto, antes de trocar as chaves, deve-se garantir que não haja arquivos de remessa criptografados e pendentes de transmissão e também arquivos de retorno criptografados recebidos e não processados pelo sistema da empresa.
Apêndice I – Tabela de prefixos para os nomes dos arquivos de remessa na transmissão automática
A tabela abaixo apresenta quais prefixos devem ser utilizados para nomear os arquivos de remessa que serão enviados para o Servidor WebTA pela aplicação de transmissão automática de arquivos de remessa. O prefixo do nome do arquivo será utilizado pelo WebTA para identificar de qual serviço o arquivo pertence (apenas na transmissão automática). O tamanho máximo do nome do arquivo, incluindo o prefixo, não poderá ultrapassar 20 caracteres.
Nome do Serviço Prefixo Exigido
DEBITO AUTOMATICO DBAT
COBRANCA COBN
PAGAMENTO FORNECEDOR PFEB
FOLHA DE PAGAMENTO - 200 CREC
PAGTO ELETRONICO TRIBUTOS PTRB
CARTAO SALARIO CASA
DEB.AUT.GERENCIADOR DEBITOS DBAM
CHEQUES CUSTODIA CHQC
VENDOR EMFI
FOLHA EXERCITO - 240 CREE
FUNDOS RECEBIVEIS 240 FREC
FUNDOS RECEBIVEIS 400 FRE1
COBRANCA *** TESTE *** COTT
COMPROVANTE SALARIAL - HPAG HPAG
BRADESCO EXPRESSO BIBC
DESCONTO DE TITULOS COBD
FUNDOS RECEBIVEIS - 240 TESTE MRE1 FUNDOS RECEBIVEIS - 400 TESTE MREC
DP06-DEP.IDENT.NUMERICA TRPW
FOLHA DE PAGAMENTO 240 CREG
CARTAO EMPRESA SBIW
FIDC Consig/Arrecad-Aquisição FREA FIDC Consig/Arrecad-Ocorrência FREO FIDC Consig/Arrecad-Pagamentos FREP
CLUBE DE INVESTIMENTO SIAW
FIDC - PAGAMENTOS FRE5
EMPRESTIMO CONSIGNADO EMPF
FOLHA DE PAGAMENTO TESTE 200 CRET FOLHA DE PAGAMENTO TESTE 240 CREI
DEBM - DEBTO EM CONTA DEBT
DEBC - DEBTO EM CONTA DEBW
FUNDO DE GARANTIA FUGW
FREC SEGURO DE CREDITO FRSC
SATT NUMERARIO SATW
SISBACEN DI SICW
COMPROVANTE SALARIAL - 100 HPAW
CRED IMOB REMESSA 328 FBN2
CARTÃO DE VISITA - CAVI CAVW
CRED IMOB REMESSA 175 FBNW
CASH MANAGEMENT CASH
Apêndice II – Arquivo de configuração das aplicações
O arquivo WebTACliente.properties contém as configurações necessárias para a execução das aplicações de transmissão automática de arquivos de remessa e recepção automática de arquivos de retorno.
Este arquivo está em formato texto, podendo ser editado facilmente. Alguns dos parâmetros contidos no arquivo, não é recomendável a alteração, já os parâmetros que descrevem os caminhos que as aplicações utilizam durante o processamento, podem ser editados diretamente ou através da aplicação de configuração e monitoração.
Abaixo um exemplo de arquivo de configuração para o ambiente Windows:
config_endPoint=https\://www.webtatransferenciadearquivos.bradesco.com.br/webta/services/WSWEBTA
#AppRemessa
path_log_remessa=C\:\\webta\\logs
path_remessa=C\:\\webta\\Remessa\\arquivosParaTransmissao path_sucesso_remessa= C\:\\webta\\Remessa\\arquivosTransmitidos path_erro_remessa= C\:\\webta\\Remessa\\arquivosComErro
frequencia_remessa=1
#AppRetorno
path_log_retorno= C\:\\webta\\logs path_retorno=C\:\\webta\\Retorno frequencia_retorno=5
A seguir descreve-se cada parâmetro do arquivo:
• config_endPoint: url de acesso ao Web Service do WebTA;
• #AppRemessa: seção onde estão agrupados os parâmetros utilizados pela aplicação de transmissão automática de arquivos de remessa:
- path_log_remessa: caminho onde serão armazenados os arquivos de log da aplicação;
- path_remessa: caminho onde deverão ser colocados os arquivos para transmissão;
- path_sucesso_remessa: caminho onde serão movidos os arquivos transmitidos com sucesso. Neste serão criados subdiretórios nomeados com a data aaaammdd onde estarão agrupados os arquivos transmitidos de cada dia;
- path_erro_remessa: caminho onde serão movidos os arquivos com erro de transmissão. Neste serão criados subdiretórios nomeados com a data aaaammdd onde estarão agrupados os arquivos com erro de cada dia;
- frequencia_remessa: intervalo em minutos que a aplicação varrerá o caminho path_remessa para enviar arquivos ao Servidor WebTA. O valor padrão é 1, ou seja de 1 em 1 minuto a aplicação busca por arquivos para transmissão.
Este parâmetro não está disponível na aplicação de configuração, para alterá-lo o usuário deverá utilizar um editor de texto. Lembrando que a configuração de grandes valores provocará intervalos maiores para busca de arquivos para transmissão.
• #AppRetorno: seção onde estão agrupados os parâmetros utilizados pela aplicação de recepção automática de arquivos de retorno:
- path_log_retorno: caminho onde serão armazenados os arquivos de log da aplicação;
- path_retorno: caminho onde deverão ser armazenados os arquivos de retorno recebidos do Servidor pela aplicação;
- frequencia_retorno: intervalo em minutos que a aplicação acessará o Web Service do WebTA em busca de arquivos de retorno. O valor padrão é 5, ou seja de 5 em 5 minutos a aplicação acionará o Web Service. Este parâmetro não está disponível na aplicação de configuração, para alterá-lo o usuário deverá utilizar um editor de texto. Lembrando que a configuração de grandes valores provocará intervalos maiores para busca de arquivos.
