Base64

Conheça o componente e saiba como utilizá-lo.

Micaella Mazoni avatar
Escrito por Micaella Mazoni
Atualizado há mais de uma semana

IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Base64 atualizada no nosso novo portal de documentação.


O Base64 realiza a codificação e a decodificação de/para campos, payloads e arquivos no formato base64 string.

Dê uma olhada nos parâmetros de configuração do componente:

  • Operation:

- Encode Fields: codifica os campos de JSON.

- Decode Fields: decodifica os campos de JSON.

- Encode Payload: codifica o payload recebido.

- Decode Payload: decodifica o payload recebido.

- Encode File: codifica o arquivo recebido.

- Decode File: decodifica o arquivo recebido.

  • JSON Field: caminho do JSON a ser codificado ou decodificado. Os campos precisam ser separados por vírgula (ex.: field1,field2).

  • Preserve Original: se habilitada, a opção preserva campos originais e modifica prefixos adicionando o caractere underline (_).

  • Payload: campo para informar diretamente o payload que terá o seu conteúdo codificado/decodificado (ex: body, data, {{ message.payload }}).

  • Result As File: se habilitada, a opção salva o resultado da codificação ou da decodificação em um arquivo (válido somente para as operações “encode_payload” e “decode_payload”).

  • File Name: nome do arquivo a ser comprimido.

  • Output File Name: nome do arquivo de saída após a codificação/decodificação de um arquivo (válido somente para as operações “encode_file” e “decode_file").

  • Fail On Error: se a opção estiver habilitada, 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".


    Importante: Os campos 'File Name' e 'Output File Name', devem receber valores diferentes, caso os valores sejam iguais, produzirá um erro (uma exceção).


Alguns dos parâmetros acima aceitam Double Braces. Para entender melhor como funciona essa linguagem, leia o nosso artigo clicando aqui.

Fluxo de mensagens

Entrada

Para as operações “encode_fields” e “decode_fields”, o componente espera receber um JSON contendo os campos configurados na propriedade JSON Field.

Exemplo:

Configuração

JSON Field = field1,field2

O JSON esperado deve conter pelo menos:

{
"field1": "SOMETHING",
"field2": "SOMETHING"
}

Para as operações “encode_payload” e “decode_payload”, você deve configurar o campo “Payload” para poder codificar/decodificar.

Exemplo:

Configuração

Payload = {{ message.field1 }}

O JSON esperado deve conter pelo menos:

{
"field1": "SOMETHING"
}

Para as operações “encode_file” e “decode_file”, você deve configurar o arquivo que será codificado/decodificado e o arquivo resultante dessa operação.

Exemplo:

File Name = input.csv

Output File Name = outputfile.csv

Saída

Para as operações “encode_fields” e “decode_fields”:

{
"field1": "SOMETHING ENCODED/DECODED",
"field2": "SOMETHING ENCODED/DECODED",
"_field1": "ORIGINAL VALUE",
"_field2": "ORIGINAL VALUE",
}

Para as operações “encode_fields” e “decode_fields”, caso a mensagem de entrada seja preservada:

{
"field1": "SOMETHING ENCODED/DECODED",
"field2": "SOMETHING ENCODED/DECODED",
"_field1": "ORIGINAL VALUE",
"_field2": "ORIGINAL VALUE",
}

Para as operações “encode_payload” e “decode_payload”, caso a saída seja um arquivo:

{
"success": "true",
"fileName": "file.csv"
}

Para as operações “encode_payload” e “decode_payload”, caso a saída seja uma string:

{
"success": "true",
"result": "SOMETHING ENCODED/DECODED"
}

Para as operações “encode_file” e “decode_file”:

{
"success": "true",
"fileName": "file.csv",
"outputFileName": "file.csv"
}

Respondeu à sua pergunta?