Gerar documento É uma ação do PDF4me para o Zapier que realiza uma mala direta: ela recebe um modelo em Word, HTML ou PDF, além de um arquivo de dados JSON ou XML, e retorna o documento preenchido. Um Zap pode monitorar uma pasta, mesclar cada registro e salvar todos os resultados sem que ninguém precise abrir o Word.
Todos os tutoriais de mala direta que você encontrar partem do princípio de que a pessoa está sentada no Word, clicando em um assistente. Isso funciona uma vez. Não funciona quando é preciso gerar cem faturas regularmente ou quando os dados vêm de um sistema em vez de uma planilha no computador de alguém. Este artigo aborda a sintaxe do modelo e o Zap que executa a mala direta automaticamente.
Crie campos de mesclagem em um documento do Word usando a sintaxe de colchetes angulares duplos. Mantenha esse modelo em uma pasta do Dropbox e envie os dados para outra. Um Zap coleta os dados, envia ambos os arquivos para a ação "Gerar Documento" do PDF4me e salva o resultado mesclado. Escolha a ação "Único" para um documento por execução ou a ação "Múltiplos" quando uma matriz de dados precisar gerar vários documentos.
Perguntas e respostas baseadas no "porquê".
Por que usar um modelo do Word em vez de construir o documento em código? Porque as pessoas que detêm o controle sobre o texto raramente são as mesmas que detêm o controle sobre o código. Um modelo do Word pode ser editado por quem redige o texto da fatura, e a próxima execução o utiliza sem necessidade de implantação ou envolvimento de um desenvolvedor.
Por que usar JSON ou XML em vez de uma planilha? Esses são os formatos que um sistema emite. A mala direta no Word lê uma planilha porque um humano a exportou. Quando o gatilho é um pedido sendo feito ou um formulário sendo enviado, os dados já estão estruturados e a mala direta deve aceitá-los nesse formato.
Por que existem duas ações "Gerar Documento"? A opção "Gerar Documento Único" mescla um registro e retorna um arquivo. A opção "Gerar Documentos Múltiplos" recebe um array e retorna um arquivo para cada elemento. A escolha da opção errada é o motivo mais comum para um Zap gerar um único documento quando se esperava um lote.
Por que manter o modelo em uma pasta separada? O gatilho monitora a pasta de dados. Se o modelo estiver junto com os dados, o upload de um modelo revisado acionará o Zap e tentará uma mesclagem com o modelo como se fosse um registro.
O que você receberá
Entrada: Um modelo do Word contendo campos de mesclagem, além de um registro JSON ou XML. Saída: O documento consolidado, salvo novamente no armazenamento em nuvem, está pronto para ser enviado ou arquivado.
Do que você precisa
- Zapier. Abra o aplicativo PDF4me no Zapier.Um Zap com várias etapas requer um plano pago do Zapier.
- Chave da API PDF4me. Obtenha sua chave de APIConecte-o na primeira vez que adicionar uma ação do PDF4me.
- Armazenamento em nuvem Com uma pasta para modelos e uma pasta separada para dados recebidos.
- Um modelo do Word com campos de mesclagem escritos na sintaxe PDF4me abaixo.
O que é uma mala direta, em um parágrafo?
A função de mala direta lê valores de uma fonte de dados e os insere no espaço reservado correspondente em um modelo. Você precisa manter duas coisas: um modelo contendo os campos de mesclagem e uma fonte de dados fornecendo os valores. O mecanismo de mesclagem os combina e retorna um documento finalizado, uma vez por registro.
O PDF4me aceita Word, HTML e PDF modelos. O Word é o mais completo dos três, pois sua sintaxe suporta condições, tabelas, seções repetidas, imagens e HTML embutido, em vez de uma simples função de localizar e substituir.
Como criar um modelo do Word?
Os campos de mesclagem usam colchetes angulares duplos em torno do nome do campo:
<<[FieldName]>>
Insira esse valor em um documento do Word, no local correspondente. O nome entre colchetes corresponde a uma chave no seu registro JSON ou XML.
Referência de sintaxe de modelos do Word
| Você quer | Documentação |
|---|---|
| A sintaxe completa, do início ao fim. | Visão geral |
| Declarações condicionais | Controles de texto |
| Tabelas que crescem com os dados | Tabelas |
| Repetição de parágrafos e seções | Repita os parágrafos |
| Inserir imagens | Inserir imagens |
| Inserindo HTML bruto | Inserir HTML |
| Formatação de números e datas | Formatação |
| Variáveis e listas | Variáveis |
Um modelo de fatura de exemplo usando uma tabela e condições. A linha da tabela se repete uma vez para cada item de linha nos dados.
Como criar o Zap "Gerar Documento"?
O Zap possui quatro partes móveis: algo para iniciá-lo, o modelo, a mesclagem e um local para colocar o resultado.
- Acionar. Selecione o gatilho que corresponde ao local onde seus dados chegam. Com o Dropbox, isso é... Novo arquivo na pasta apontou para sua pasta de dados.
- Obtenha o modelo. O gatilho carrega apenas o arquivo que acabou de chegar, então leia o modelo separadamente. Isso é comum no Dropbox. Localizar arquivo, apontou para a pasta do modelo com o nome exato do arquivo do modelo.
- Fusão. Adicione o PDF4me Gerar documento ação e mapear ambos os arquivos nela.
- Salvar. Adicionar Carregar arquivo para gravar o resultado de volta. Se a mesclagem retornou vários documentos, coloque isso dentro de um Criar loop a partir de itens de linha passo de Looping por Zapier Assim, ele é executado uma vez por documento.
Parâmetros de geração de documento
| Parâmetro | Obrigatório | O que faz |
|---|---|---|
| Arquivo de modelo | Obrigatório | O próprio modelo, mapeado a partir da etapa que o obteve. |
| Tipo de arquivo de modelo | Obrigatório | Que tipo de modelo você forneceu: Word, HTML ou PDF? |
| Tipo de formato de dados de entrada | Obrigatório | Independentemente de os dados chegarem em formato de texto ou de arquivo. |
| Texto de dados ou arquivo de dados | Obrigatório | O registro. Qual você preenche depende da linha acima. |
| Tipo de dados de entrada | Obrigatório | O formato dos dados: JSON ou XML. |
| Nome do arquivo de modelo | Opcional | Nomeia o modelo para a ação, incluindo a extensão. |
| Tipo de documento de saída | Opcional | O formato do documento gerado. |
| Manter PDF editável | Opcional | Deixa os campos do formulário editáveis na saída. |
| Metadados | Opcional | Valores extras foram passados para a mesclagem. |
Dica. O tipo de arquivo de modelo e o tipo de dados de entrada são os pares que as pessoas mais frequentemente confundem. Se a saída retornar com os espaços reservados ainda visíveis, verifique esses dois antes de qualquer outra coisa: a mesclagem foi executada, mas não reconheceu nada para mesclar.
Simples versus múltiplo, e quando o loop é necessário.
| Único vs. Múltiplo | Gerar documento único | Gerar vários documentos |
|---|---|---|
| Formato dos dados | Um registro | Um array, um objeto por documento. |
| Devoluções | Um documento | Um documento por elemento de matriz |
| Precisa de um loop depois dele. | Não | Sim, para salvar cada resultado. |
| Uso típico | Uma fatura por pedido. | Um conjunto de declarações de uma exportação. |
O resultado final da fusão. Todos os marcadores de posição do modelo foram substituídos e a tabela foi expandida para uma linha por item.
Execute o Zap e verifique
- Publicar o Zap.
- Adicione um registro de exemplo à pasta de dados e aguarde o gatilho ser acionado.
- Abrir Zap corre e confirme se a etapa Gerar Documento retornou um arquivo em vez de um erro.
- Abra o arquivo de saída e verifique duas coisas: se não há espaços reservados visíveis e se a tabela repetida tem o número correto de linhas.
O que você construiu exatamente? Uma fábrica de documentos cujo texto pertence a quem edita o modelo, não a quem mantém o Zap. Altere o modelo e a próxima execução o utilizará. O mesmo padrão funciona no Make, n8n e Power Automate com a mesma ação.
Variações comuns que você pode adicionar sem reconstruir
Perguntas frequentes
O que é uma mala direta?
A ação "Gerar Documento" consiste em ler valores de uma fonte de dados e inserir cada um no espaço reservado correspondente em um modelo, gerando um documento finalizado por registro. O Word popularizou o termo com seu assistente, mas a operação em si não tem relação com o Word: qualquer mecanismo que entenda um modelo e um formato de dados pode realizá-la, e é exatamente isso que a ação "Gerar Documento" faz.
Como faço para usar a mala direta no Word?
Se você quer dizer o assistente de desktopSe você estiver se referindo a mesclar um modelo do Word sem esse assistente, você escreve os campos usando a sintaxe de colchetes angulares duplos acima e, em seguida, fornece o modelo e um registro JSON ou XML para a opção "Gerar Documento". O modelo ainda é um arquivo do Word; nada abre o Word para produzir a saída.
Posso fazer mala direta sem usar o Word?
Sim. A mesclagem é feita através da API do PDF4me, portanto, nenhuma cópia do Word é envolvida em nenhum momento. Você precisa do Word, ou de qualquer editor que escreva arquivos .docx, apenas para criar o modelo inicialmente, e o PDF4me também aceita modelos HTML e PDF caso você prefira não usar o Word.
Como faço para gerar vários documentos a partir de um único modelo?
Usar Gerar vários documentos e forneça um array, um objeto por documento. Ele retorna um documento por elemento. Em seguida, coloque a etapa de upload dentro de um Criar loop a partir de itens de linha ação para que cada resultado seja salvo individualmente, em vez de apenas o primeiro.
Solução de problemas
Os dados nunca corresponderam ao modelo. Verifique se o Tipo de Dados de Entrada corresponde ao formato real do registro, se o registro é válido e se os nomes das chaves correspondem ao que está dentro dos colchetes angulares, incluindo maiúsculas e minúsculas.
Ou a ação "Única" foi usada onde a ação "Múltipla" era necessária, ou a etapa de upload está fora do loop. Ambas as situações geram exatamente um arquivo salvo, independentemente da quantidade de registros inseridos.
A região repetida não foi marcada no modelo. Uma tabela que cresce precisa da sintaxe de repetição em torno da linha, e não apenas da mesclagem de campos dentro dela. Consulte a documentação sobre parágrafos repetidos.
O modelo está localizado dentro da pasta monitorada. Mova-o para uma pasta própria e direcione a etapa de busca para lá.
Próximos passos
O mesmo padrão de quatro etapas (monitorar, buscar o modelo, mesclar, salvar) lida com qualquer automação do tipo "entrada de dados, saída de documento personalizado".