Como configurar uma integração para gerar documentos
A partir de um template, é possível efetuar a criação automática de documentos nos formatos PDF ou DOCX. Esses documentos podem, inclusive, receber informações de valores informados em determinados campos de uma solicitação.
Para utilizar o recurso no sistema, em primeiro lugar, é necessário criar uma integração que efetue a chamada da API REST responsável por gerar os documentos. Sendo assim:
Acesse o menu Administração / Construir / Integrações;
Clique em Novo;
Será carregado o formulário para criação da integração. Informe o nome desejado e selecione o tipo "RESTful / JSON".
Após a seleção do tipo, novos campos serão apresentados para configuração.
Endereço de definição do serviço: https://<endereço de seu ambiente Zeev>/api/2/files/createfile
Cabeçalho (header) da requisição HTTP: Authorization: Bearer <token do usuário>
Método: POST
Parâmetros / Corpo: aqui deverá ser colocado o JSON da requisição. Veja mais informações na próxima seção.
Mapeamento de campos acessórios: preencha com o identificador do campo de formulário que receberá o documento gerado. Exemplo: identificadorDoCampo => $.result
Também é possível preencher outras informações, como os nodos e dados relacionados ao cache.
Preenchimento do campo Parâmetro / Corpo
O parâmetro / corpo do JSON da requisição deverá ser preenchido conforme a documentação descrita em Gerar documentos.
Na documentação estão discriminados os parâmetros obrigatórios e opcionais do body de requisição, assim como quais retornos possíveis uma requisição pode apresentar.
Selecionando um template
Para utilização desta API é obrigatório informar o caminho onde o seu template está armazenado.
Caso você possua acesso ao servidor basta incluir o arquivo com o template embaixo do seguinte caminho: <pasta de instalação>/Attachments/Templates. O caminho, juntamente com o nome do arquivo deverá ser informado no JSON da requisição.
Caso você não possua acesso ao servidor de instalação, também é possível efetuar a inclusão de um template para uso no seu aplicativo. Para isso, siga os passos abaixo:
1- Acesse o menu Administração / Construir / Aplicativos
2- Efetue a pesquisa pelo nome do aplicativo que fará a geração de documentos
3- Clique no nome do documento. Será apresentada a página de configurações e informações do aplicativo.
4- Na seção "Anexos padrão", inclua um novo anexo, selecionando o arquivo de template armazenado no seu computador. Não é necessário exibir esse arquivo no aplicativo.
5- Edite novamente o arquivo recém-inserido e copie o valor apresentado no campo "Caminho do arquivo"
6- Na integração criada para consumir a API de createFile, preencha o caminho copiado. Informe somente o valor presente após a partir do texto "/attachments". Exemplo:
"templatePath": "/attachments/100/modeloTemplate_20210914172152359162.docx"
Demonstração prática
Nos vídeos abaixo você poderá acompanhar o passo-a-passo de como criar uma integração que consome a API RESTful/JSON responsável pela criação de documentos. Também será demonstrado como você configura uma atividade de Serviço dentro do seu aplicativo, responsável por chamar a API e efetuar a criação do documento:
Atualizado