File to Base64

1. Visão Geral

O componente File to Base64 (file-to-base64) converte um arquivo já disponível na mensagem para uma string em Base64, formato comumente usado para transportar arquivos dentro de JSON (por exemplo, ao enviar um anexo para uma API).

Use quando o fluxo precisa incluir o conteúdo de um arquivo diretamente dentro de um payload JSON. Não use para arquivos muito grandes — Base64 aumenta o tamanho dos dados em cerca de 33%.

2. Pré-requisitos

O arquivo precisa estar disponível na mensagem antes deste componente rodar.

3. Autenticação e Conexão

Não aplicável.

4. Configuração / Operações Suportadas

O componente tem uma única operação: converter um arquivo para Base64.

Campo	Obrigatório	Tipo	Descrição	Exemplo
file	Sim	Texto	Nome da propriedade da mensagem onde está o arquivo.	"comprovante"
includeMetadata	Não	Texto ("true"/"false")	Se true, inclui informações extras (tamanho, nome do arquivo, charset) na resposta. Valor padrão: "false".	"true"
charset	Não	Texto	Codificação de caracteres, informada apenas na resposta quando includeMetadata está ativado (não afeta a conversão em si).	"UTF-8"

5. Exemplos Práticos

Exemplo simples: converter um comprovante para Base64, para enviar dentro de um payload JSON a uma API.

Entrada:

{
  "comprovante": "<arquivo, disponibilizado por um passo anterior>"
}

Configuração do componente:

{
  "componentName": "file-to-base64",
  "configurations": {
    "file": "comprovante"
  }
}

Resposta:

{
  "base64": "JVBERi0xLjQKJcOkw7zDtsO..."
}

Exemplo avançado: converter o mesmo arquivo, mas incluindo metadados na resposta (útil para logs ou validações).

Configuração do componente:

{
  "componentName": "file-to-base64",
  "configurations": {
    "file": "comprovante",
    "includeMetadata": "true"
  }
}

Resposta:

{
  "base64": "JVBERi0xLjQKJcOkw7zDtsO...",
  "size": 45820,
  "fileName": "comprovante.pdf"
}

6. Erros Comuns e Troubleshooting

Erro / Sintoma	Causa provável	Como resolver
"A file parameter is required but has not been configured."	O campo file não foi preenchido.	Preencher file com o nome da propriedade que contém o arquivo.
"File [nome] not found inside the execution context."	O arquivo referenciado não está disponível na mensagem com esse nome.	Confirmar que um passo anterior disponibilizou o arquivo com esse nome exato.
"File [nome] does not exist."	A propriedade aponta para um arquivo que não existe mais no disco.	Verificar se o arquivo não foi removido antes deste passo.
"Invalid operation: [valor]. Supported: CONVERT"	O campo operation foi preenchido com um valor diferente de CONVERT.	Remover o campo operation ou usar o valor CONVERT.