Visão Geral
O Extrator de Arquivos é um objeto LATROMI responsável por extrair um ou mais arquivos de uma origem informada. Neste tópico conterá a introdução sobre as características e funcionamentos desse objeto.
Seções
No canto esquerdo da janela do objeto, conterá algumas opções separadas por finalidades.
Configurações
Aqui estão as configurações que ditarão diversos comportamentos ao objeto, ao selecioná-la poderá visualizar as seguintes opções:
| Nome | Descrição |
|---|---|
| Interromper o processo se ocorrer erro | Ao habilitar este campo, em qualquer ocorrência de erro o processo de extração do(s) arquivo(s) será interrompida. |
| Cache HTTP (segundos) | Informe um valor em segundos para ser informado ao navegador quanto tempo deve armazenar o arquivo extraído em cache. De 0 à 31536000. |
Segurança
Esta seção define opções de segurança quando o arquivo for usado para renderização no navegador do usuário. Oferece maior controle sobre as ações que um arquivo renderizado tem autorização para executar.
Parâmetros
Os parâmetros são valores que serão informados quando ocorrer uma chamada para o Extrator de Arquivo criado. Eles podem ser usados para repassar dados no contexto da requisição para a operação solicitada ao objeto.
Os tipos de dados possível para os parâmetros são:
| Tipo | Descrição |
|---|---|
| String | Tipo de dados Alfanumérico. |
| Number | Tipo de dados numérico, sendo inteiros ou decimais. |
| Date | Tipo de dados para data e hora. |
| Boolean | Tipo de opção binária (Verdadeiro/Falso). |
Fontes de Dados
As fontes de dados permite adicionar uma query SQL para carregar dados para o contexto durante uma requisição ao objeto. Os registros capturados podem ser usados para levar informações para as Origens.
Origens
Nessa sessão será configurando onde e como o Extrator de Arquivos deverá capturar os arquivos e devolver ao solicitante. Aqui poderá encontrar as seguintes informações:
| Nome | Descrição |
|---|---|
| Nome | Defina um nome para a origem adicionada na seção ‘Origens’. |
| Descrição | Descreva a função da origem, que está sendo adicionada. |
| Fonte de Dados | Selecione uma Fonte de Dados para ser consumido pela origem. |
| Tipo | Defina o tipo de extração a ser executado. |
A extração é configurável para diversos tipos de origem, a seguir iremos apresentar os tipos possíveis. Para mais informações sobre como utilizar um determinado tipo acesse sua respectiva documentação:
| Nome | Descrição |
|---|---|
| Caminho [Link] | Informe um caminho de diretório/arquivo, no servidor ou na rede em que o servidor se encontra. |
| Texto Plano [Link] | Informe um conteúdo em texto plano para gerar um arquivo para extração. |
| Binário [Link] | Informe o conteúdo em Bytes do arquivo. |
| Web API [Link] | Consuma uma API que retorne arquivos. |
| FTP [Link] | Consuma um servidor FTP. |
| URL [Link] | Consuma uma URL estática. |
| Objeto [Link] | Consuma uma objeto do tipo Consulta do LATROMI, para extrair os dados em um arquivo. |
Visualizando o resultado
Existem diferentes maneiras de visualizar ou consumir o resultado de uma extração. Por exemplo, caso o seu Extrator de Arquivos esteja configurado para retornar imagens, você pode vincular o objeto criado diretamente a um campo do tipo ImageView dentro de um Formulário.
Para realizar testes rápidos ou validar o retorno do arquivo durante a fase de desenvolvimento, você pode acessar os endpoints da API diretamente pelo navegador. Para montar a URL, basta adicionar os caminhos abaixo logo após o diretório raiz da sua aplicação (geralmente após a rota /web):
- Baixar arquivos:
/api/fileextractors/<Codigo do Extrator>/downloadfile/?<parametro1>=<valor do "parametro1">
- Visualizar o arquivo:
/api/fileextractors/<Codigo do Extrator>/getfile/?<parametro1>=<valor do "parametro1">
Primeiro Extrator de Arquivos
Para começar rapidamente e quebrar a clássica “maldição” do primeiro código, vamos construir um exemplo prático passo a passo. Siga as instruções abaixo:
- Na aba Desenvolvimento, acesse o menu Extrator de Arquivos e inicie a criação de um novo objeto.
- Preencha o nome do objeto como Quebrando a maldição.
- Na seção Parâmetros, clique com o botão direito e adicione um novo membro.
- Nomeie o parâmetro como “traduzir” e selecione o Tipo Boolean.
- Na seção Fontes de Dados, clique com o botão direito, adicione um novo membro e selecione o tipo Banco de Dados.
- No editor de código SQL da fonte de dados, insira o comando abaixo:
--#if {?PARAM.traduzir}
SELECT
'Olá mundo!' as content
--#else
SELECT
'Hello World!' as content
--#endif
- Em seguida, vá para a seção Origens, clique com o botão direito e adicione um novo membro.
- Na caixa de seleção Fonte de Dados, selecione a fonte de dados criada anteriormente.
- Na caixa de seleção Tipo, seleciona a opção Texto Plano.
- Em Conteúdo do Arquivo, selecione a coluna Content da fonte de dados.
- Na caixa de texto Nome do Arquivo, informe o nome “quebra_maldicao.txt”.
- Salve o objeto para concluir a criação.
Por fim, vamos visualizar o resultado da extração. Use os caminhos relativos abaixo:
- Parâmetro traduzir como
true:
/web/api/fileextractors/<Codigo do Extrator>/getfile/?traduzir=true
- Parâmetro traduzir como
false:
/web/api/fileextractors/<Codigo do Extrator>/getfile/?traduzir=false