> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/html-to-pdf.md). # HTML to PDF Descubra mais sobre o componente HTML to PDF e como usá-lo na Digibee Integration Platform. O componente **HTML to PDF** permite a criação de arquivos no formato PDF a partir de um HTML. O componente utiliza *templates* Apache FreeMaker para gerar o HTML através da mensagem JSON do *pipeline*. ## Parâmetros Dê uma olhada nas opções de configuração do componente. Parâmetros suportados por [expressões *Double Braces*](/documentation/connectors-and-triggers/pt-br/double-braces/overview.md) estão marcados com `(DB)`.

Parâmetro	Descrição	Valor padrão	Tipo de dado
File Name `(DB)`	Nome do arquivo PDF que será gerado na saída da execução do componente.	file.pdf	String
Template (HTML) `(DB)`	Template em HTML a ser interpretado para gerar o arquivo PDF. Este campo suporta o template FreeMarker.	N/A	String
Fail On Error	Se a opção estiver ativada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".	False	Booleano
Secured PDF	Se a opção estiver ativada, é permitida a inclusão de senha no arquivo PDF para gerar um documento protegido.	False	Booleano
Password `(DB)`	Senha para proteger o arquivo PDF.	N/A	String
Custom permissions	Se a opção estiver ativada, opções de permissão customizadas para o arquivo PDF ficam disponíveis; do contrário, nenhum dos parâmetros a seguir ficam disponíveis, e o arquivo PDF será gerado com todas as permissões.	False	Booleano
Read only	Permissão de acesso que define o arquivo PDF como "somente leitura". Se a opção estiver ativada, todas as outras permissões de acesso serão desativadas.	False	Booleano
Assemble document	Permite que páginas sejam adicionadas, rotacionadas ou removidas do arquivo.	False	Booleano
Modify	Permite modificar o arquivo.	False	Booleano
Modify annotations	Permite adicionar ou modificar anotações de texto no arquivo.	False	Booleano
Extract content	Permite extrair textos e imagens do arquivo.	False	Booleano
Extract for accessibility	Permite extrair textos e imagens do arquivo para fins de acessibilidade.	False	Booleano
Print	Permite a impressão do arquivo.	False	Booleano
Print degraded	Permite a impressão degraded do arquivo.	False	Booleano
Fill in Form	Permite o preenchimento de formulários com campos interativos.	False	Booleano

## Fluxo de Mensagens ### Entrada O componente aceita qualquer mensagem de entrada, podendo utilizá-la por meio de *Double Braces*. ### Saída * **Com sucesso** ``` { "success": true, "fileName": "pdf_gerado.pdf", } ``` * **Sem sucesso** ``` { "success": false, "message": "Could not generate the pdf file", "error": "java.net.IOException" } ``` ### Exemplo de resposta de requisição contendo erro ``` { "success": false, "message": "Could not generate the pdf file", "error": "java.net.IOException:" } ``` * **success:** `“false”` quando a operação falha. * **message:** mensagem sobre o erro. * **exception:** informação sobre o tipo de erro ocorrido. **Exemplo:** * **Body** ```markup

We have these animals: <#list animals as animal>
${animal.name} ${animal.price} Euros
``` Portanto, na mensagem de entrada é recebido um *array* de objetos que contêm as propriedades `“name”` e `“price”`: ``` [ { "name": "Dog", "price": 100}, { "name": "Cat", "price": 100}, { "name": "Bird", "price": 30}, ] ``` O *template* fará a iteração nesse *array* recebido e preencherá o HTML: ```markup

We have these animals:

Dog $100 Euros
Cat $100 Euros
Bird $30 Euros
``` ## Outras aplicações ### **SVG** Para utilizar o SVG como *tag* HTML, aplique a seguinte propriedade dentro da *tag* SVG `xmlns="`[`http://www.w3.org/2000/svg`](http://www.w3.org/2000/svg)`"`: ```markup ``` ### **CSS** Não há suporte para versões acima de 2.1. ### **Imagens** A utilização de imagens em formato base64 dentro de *tags* HTML não é suportada. **Exemplo:** ` ``` No exemplo acima, deve existir um arquivo de imagem exatamente com o nome especificado dentro da *tag* src (image.jpg) #### **Imagem Remota** ```markup ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/connectors/tools/html-to-pdf.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.