Módulo XLSX

Definição

O módulo ferramental “XLSX”, módulo padrão do Skyone Studio para uso em qualquer fluxo, foi criado para converter dados entre os formatos JSON e XLSX (Excel), utilizando arquivos em formato Base64.

O módulo “XLSX” é composto por duas operações:

  • Converter JSON para XLSX

  • Converter XLSX para JSON


Configuração do módulo XLSX

O módulo “XLSX” aparece na opção Ferramentas da edição de um fluxo. Ao ser adicionado em um fluxo, ele oferece duas operações:

  • Converter JSON para XLSX: converte um conteúdo em JSON para um arquivo XLSX, retornando o resultado em Base64.

  • Converter XLSX para JSON: converte um arquivo XLSX em Base64 para o formato JSON.


Operação Converter JSON para XLSX

Esta operação permite que você converta um conteúdo em JSON (como respostas de APIs, listas de produtos, clientes, etc.) para o formato XLSX, possibilitando a geração de planilhas Excel a partir de dados estruturados.

Como utilizar

  1. Entre no seu fluxo de integração

  2. Selecione a operação “Converter JSON para XLSX”.

  3. Clique em Salvar.

  4. Ao editar o módulo, será exibida a área de configuração das variáveis.


Campos de configuração

Nome da planilha

Informe o nome que será atribuído à planilha XLSX gerada.

JSON

Informe o conteúdo em formato JSON que deverá ser convertido.

Se preferir, clique no sinal de mais ( + ) para configurar uma SMOP ou utilizar dados vindos de outro módulo do fluxo (ex: resposta de API).

XLSX convertido (Base64)

Após clicar no botão Validar, será exibido o arquivo XLSX gerado no formato Base64.

circle-info

O módulo não disponibiliza download direto do arquivo XLSX. O resultado é sempre gerado em Base64.


Uso do Base64 gerado

O Base64 retornado pode ser:

  • Salvo para uso posterior;

  • Utilizado diretamente no retorno da aplicação;

  • Convertido em arquivo físico utilizando:

    • JSONata

    • Transformações no módulo Transformação de Dados

    • Implementações externas que consumam Base64

Exemplo de uso no retorno do fluxo:

  • Arraste o parâmetro gerado pelo módulo XLSX para o módulo de Retorno.

  • Defina um nome para o campo.

  • O Base64 estará disponível como saída da API.


Operação Converter XLSX para JSON

Esta operação permite a conversão de um arquivo XLSX em Base64 para o formato JSON, possibilitando a leitura e manipulação dos dados de planilhas dentro do fluxo.

Como utilizar

  1. Selecione a operação “Converter XLSX para JSON”.

  2. Clique em Salvar.

  3. Ao editar o módulo, será exibida a área de configuração das variáveis.


Campos de configuração

Nome da planilha

Informe o nome da planilha que será utilizada na leitura do arquivo XLSX.

XLSX (Base64)

Informe o conteúdo do arquivo XLSX codificado em Base64.

Este campo aceita apenas Base64, inclusive arquivos gerados pelo próprio módulo XLSX.

XLSX convertido para JSON

Após clicar em Validar, o conteúdo da planilha deverá ser exibido no formato JSON.


Parâmetros

Cada operação do módulo XLSX possui um parâmetro correspondente ao resultado da conversão:

  • Converter JSON para XLSX → retorna um Base64 XLSX

  • Converter XLSX para JSON → retorna um JSON

Esses parâmetros:

  • Ficam disponíveis no lado esquerdo do modal de configuração;

  • Podem ser utilizados em módulos posteriores do fluxo;

  • Podem ser manipulados pelo módulo Transformação de Dados ou por SMOPs.


Considerações finais

O módulo XLSX foi desenvolvido para facilitar a conversão entre JSON e Excel, seguindo o padrão de utilização de Base64 adotado pelo Skyone Studio.

Atualmente:

  • JSON → XLSX

  • XLSX → JSON

Para finalizar a configuração do módulo, clique em Salvar.

Atualizado

Isto foi útil?