Skip to content

Portabilidade de Versões

A Portabilidade é o recurso do Console responsável pelo intercâmbio e migração de ativos entre diferentes projetos, ecossistemas ou instâncias da plataforma. Ela permite Exportar e Importar definições completas de fluxos e suas respectivas versões através de arquivos estruturados em formato JSON.


Embora a modelagem visual do fluxo seja construída e interpretada como um documento XML no Editor Visual, as operações de portabilidade envelopam esse XML dentro de um documento JSON abrangente.

Isso garante que, além do diagrama visual, todos os metadados de configuração e governança da versão possam ser transportados de forma unificada.

estrutura-do-arquivo.json
{
"tag": "1.0.0",
"comentario": "Versão inicial de integração de vendas",
"modelo_xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>...",
"variaveis": [ ... ],
"adaptadores": [ ... ],
"publicacoes": [ ... ],
"seguranca": { ... }
}
  • modelo_xml: Atributo do JSON que armazena a string bruta do XML com o desenho do diagrama BPMN, etapas e destinos.

  • Blocos Opcionais: Arrays e objetos contendo as configurações de variáveis de ambiente, adaptadores de entrada/saída, regras de segurança e publicações.


A funcionalidade de Exportação gera o pacote JSON com os dados da versão selecionada. Para garantir flexibilidade e evitar o vazamento involuntário de credenciais sensíveis ao migrar entre ambientes (ex: mover de Desenvolvimento para Produção), a jornada de exportação apresenta uma tela de seleção granulada.

O desenvolvedor pode marcar exatamente quais contextos devem ser incluídos no arquivo final através do formulário de exportação (formContextoExportacaoVersao):

Campo de Seleção Tipo Descrição do Conteúdo Exportado
modelo Boolean Inclui a estrutura do diagrama visual (propriedade modelo_xml com etapas e destinos).
adaptadores Boolean Inclui as configurações de adaptadores de Entrada (QUERY_PARAMS, BODY, AUTH, ASYNC) e Saída (ID_SESSAO, SESSAO, DATA, ERRO, STATUS_SUCESSO).
variaveis Boolean Inclui o mapeamento de variáveis de ambiente do tipo chave/valor associadas à versão.
seguranca Boolean Inclui as políticas de segurança cadastradas (hashes de API Keys e regras de CORS por ambiente).
publicacao Boolean Inclui os históricos e registros de ambientes onde a versão estava publicada.

O Console disponibiliza duas formas principais para instanciar novas versões utilizando mecanismos de portabilidade:

Permite carregar um arquivo JSON previamente exportado a partir de outra instância ou projeto.

  1. Processamento

    O Console faz a leitura do JSON, valida a estrutura do arquivo, extrai a string contida em modelo_xml para recriar as etapas e destinos, e aplica as configurações opcionais marcadas no arquivo (variáveis, adaptadores, segurança).

  2. Estado Inicial

    A nova versão criada a partir da importação assume automaticamente o estado DESENVOLVIMENTO (pois já possui modelo visual instanciado).

Permite duplicar uma versão existente dentro da própria plataforma sem a necessidade de baixar e subir arquivos manualmente.

  • Uso Típico: Criação de uma nova tag de versão (ex: criar a 1.1.0 a partir da 1.0.0 já consolidada) para iniciar um novo ciclo de melhorias mantendo o histórico anterior intocado.

  • Herança: A nova versão herda o modelo visual e todos os adaptadores e variáveis da versão de origem, ficando no estado DESENVOLVIMENTO para edição.


Backup e Versionamento Externo

Armazenar arquivos JSON das versões publicadas em repositórios de código externos (Git).

Promoção entre Ambientes sem Conexão Direta

Transportar fluxos entre redes isoladas (ex: ambientes de redes corporativas distintas) via arquivo JSON.

Distribuição de Módulos Padrão

Importar templates de fluxos pré-configurados para acelerar a criação de novas integrações na empresa.