JSON to CSV V2

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 JSON to CSV V2 atualizada no nosso novo portal de documentação.

O JSON to CSV V2 permite a criação de arquivos e estruturas CSV a partir de um JSON de entrada.

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

  • Output as File: se a propriedade estiver ativada, o CSV gerado será salvo como arquivo; do contrário, o resultado será um array de strings e cada um dos seus índices corresponde a uma linha do CSV.

  • Headers: headers do CSV, separados por vírgula. Ex: header1,header2,...,headerN. Os headers devem possuir o mesmo nome das chaves do objeto JSON.

  • Delimiter: delimitador que será usado para gerar o CSV.

  • Body: JSON de entrada a partir do qual será gerado o CSV. O JSON deve ser um array de objetos.

  • Show Headers: se a propriedade estiver ativada, os headers serão informados no CSV; do contrário, o CSV não apresentará os headers.

  • Generate Columns With Quotes: se a propriedade estiver ativada, todos os valores das colunas de todas as linhas serão gerados com aspas; do contrário, as colunas não serão geradas com aspas, exceto se for necessário escapar algum caractere especial (aspas e o delimitador dentro do valor da coluna).

  • Coalesce: se a propriedade estiver ativada, será gerado qualquer tipo de objeto JSON como string com valor do CSV; do contrário, será lançada uma exceção se o valor for um objeto ou um array.

  • Append: se a propriedade estiver ativada, os dados serão acrescentados a um arquivo existente (arquivos inexistentes serão criados); do contrário, será criado sempre um novo arquivo a cada execução. Essa opção será exibida somente quando a opção Output as File estiver ativada.

  • End Of Line Policy: política de quebra de linha dentro do arquivo (LINUX = \n e WIDOWS = \r\n). Essa opção será exibida somente quando a opção Output as File estiver ativada.

  • File Name: nome do arquivo CSV a ser gerado. Essa opção será exibida somente quando a opção Output as File estiver ativada.

  • 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".

Fluxo de mensagens

Entrada

É necessário informar um array de objetos no campo Body e informar no campo Headers os headers correspondentes às chaves desses objetos. Exemplo:

Headers: header1,header2,header3

Body:

[

{
"header1": "some_value",
"header2": "some_value",
"header3": "some_value"
}

]

Saída

Caso a opção Output as File esteja habilitada:

{
"success": true,
"fileName": FILE_NAME
}

  • success: propriedade que indica se a execução foi bem sucedida ou não

  • fileName: nome do arquivo gerado

Caso a opção Output as File esteja desabilitada:

{
"success": true,
"data": [
"header1,header2,header3",
"some_value,some_value,some_value"
]
}

  • success: propriedade que indica se a execução foi bem sucedida ou não

  • data: CSV gerado como um array de strings

Para entender melhor o fluxo das mensagens na Plataforma, clique aqui e leia o nosso artigo.

Respondeu à sua pergunta?