Exportar e importar um projeto no Jitterbit Studio

Introdução

O Studio permite importar componentes de projeto entre organizações e ambientes. Você pode exportar projetos como arquivos JSON ou trabalhar diretamente com projetos no mesmo ambiente.

Juntas, as funcionalidades de exportação e importação permitem transferir projetos e seus componentes para outras organizações conforme necessário.

As exportações de projeto do Studio estão em formato de arquivo JSON. Depois de ter uma exportação de projeto JSON, você pode importá-la em qualquer organização.

Exportar um projeto

As opções Exportar ou Exportar Projeto estão acessíveis nestes locais:

• A página Projetos (consulte Visualização em cards ou Visualização em lista em Projetos).
• A barra de ferramentas do projeto (consulte Menu de ações do projeto em Barra de ferramentas do projeto).

Além disso, a tela de exportação do projeto está acessível usando o link Exportar na parte inferior da tela Configurações do Projeto (consulte Editar configurações do projeto em Criação e configuração de projeto).

Ao selecionar Exportar ou Exportar Projeto, a tela de exportação do projeto abre, onde você escolhe as opções de exportação e gera o projeto como um arquivo JSON:

• Incluir Credenciais: Inclui no projeto exportado os valores especificados nos campos de credenciais das telas de configuração de componentes do projeto.

  Nota

  Esta opção pode estar desabilitada dependendo da política de organização Permitir que credenciais sejam exportadas.

  Os campos de configuração específicos tratados como campos de credenciais variam por componente do projeto. Frequentemente incluem campos como senhas ou tokens de segurança. Desenvolvedores de conectores personalizados usando o Connector SDK podem designar tais campos com um destes atributos:

  • "secret": "true": Designa apenas que o campo é tratado como um campo de credenciais. O valor do campo é criptografado na exportação do projeto.

  • "widgetHint": "password": Designa que o campo é tratado como um campo de credenciais e também mascara o valor na interface do Studio substituindo cada caractere por um ponto preto. O valor do campo é criptografado na exportação do projeto.

  Os valores das variáveis de projeto em si não são tratados como credenciais, mesmo se a opção Ocultar Valor estiver selecionada na interface (consulte Variáveis de projeto). Em vez disso, se os valores das variáveis de projeto são incluídos é controlado pela seleção Incluir Valores de Variáveis de Projeto.

  Se uma variável de projeto for usada em um campo de credenciais (independentemente de Incluir Valores de Variáveis de Projeto estar selecionado), o "value" do campo de credenciais é o valor criptografado da representação da sintaxe de colchetes do nome da variável de projeto e qualquer outra entrada, se presente.

  Quando Incluir Credenciais não está selecionado, o "value" do campo de credenciais não é incluído na exportação do projeto, exceto se uma variável de projeto for usada em um campo de credenciais. Nesse caso, a entrada de texto simples não criptografada do campo de credenciais é incluída. Isso pode ser uma preocupação se o campo de credenciais usar qualquer outra entrada junto com a variável de projeto, embora este caso de uso seja incomum. Por exemplo, uma entrada de campo de [pv_password]1234suffix seria incluída na exportação do projeto como [pv_password]1234suffix.

• Incluir Notificações por Email: Inclui notificações por email no projeto exportado. Esta opção se aplica a todas as notificações por email em um projeto, independentemente de estarem configuradas com ações de operação para executar em caso de sucesso, falha ou falha SOAP ou se forem referenciadas em um script.

• Incluir Valores de Variáveis de Projeto: Inclui os valores padrão das variáveis de projeto no projeto exportado.

  Os valores das variáveis de projeto configuradas com a opção Ocultar Valor (consulte Variáveis de projeto) são criptografados na exportação do projeto.

• Incluir Agendamentos: Inclui agendamentos de operação no projeto exportado.

• Exportar: Gera e baixa o projeto como um arquivo JSON. Por padrão, o nome do arquivo JSON usa o nome do projeto.

  Nota

  Um projeto exportado não retém o histórico do projeto.

Importar

Você pode importar projetos e componentes usando uma destas duas opções:

1. Importar um projeto: Esta opção (acessível na página Projetos) permite importar um projeto inteiro de um arquivo JSON para sua organização.

2. Importação seletiva: Esta opção (acessível no menu de ações do projeto em um projeto) permite importar componentes especificados de outro projeto no mesmo ambiente ou de um arquivo JSON de projeto para um projeto existente.

Importar um projeto

Você pode importar um projeto clicando em Importar na página Projetos:

Na próxima tela, você importa o projeto:

• Arquivo de projeto: Use o botão Procurar para navegar até um arquivo JSON de projeto que foi exportado do Studio.

  Dica

  Se o projeto usar conectores personalizados, eles devem existir na organização antes de importar o projeto. Para exportar um conector do Connector Builder e importá-lo em outra organização, consulte Exportações e importações do Connector Builder. Para instalar um conector do Connector SDK em outra organização, consulte Implementando um Conector Harmony.

  Ao selecionar um arquivo, estes campos ficam disponíveis:

  • Nome do projeto: O nome do projeto é preenchido automaticamente a partir do arquivo JSON. Para usar um nome diferente, você pode editá-lo aqui. O nome do projeto deve atender a estes critérios:

    • Ser único para cada ambiente.

    • Não pode estar já em uso como nome de projeto do Design Studio no mesmo ambiente.

    Nota

    Se um projeto com o mesmo nome já existe na nuvem Harmony, acesse o Console de Gerenciamento > página Projetos para gerenciar o projeto implantado.

  • Organização: Use o menu suspenso para selecionar a organização para a qual você deseja importar o projeto. Se você tiver apenas uma organização, ela será selecionada por padrão.

  • Ambiente: Use o menu suspenso para selecionar o ambiente para o qual você deseja importar o projeto.

    Atenção

    Se o projeto de origem usar conectores disponíveis apenas em agentes privados, você não poderá importá-lo para um ambiente associado a um grupo de agentes na nuvem. Esses ambientes ainda aparecem no menu suspenso Ambiente, mas não podem ser selecionados.

  • Incluir Notificações por Email: Por padrão, se notificações por email foram incluídas como parte do projeto quando foi exportado, elas serão incluídas quando o projeto for importado. Esta opção se aplica a todas as notificações por email em um projeto, independentemente de estarem configuradas com ações de operação para executar em caso de sucesso, falha ou falha SOAP ou se forem referenciadas em um script. Para excluir notificações por email da importação, desmarque a caixa de seleção.

    Cuidado

    Referências a um componente de notificação por email em um script não são removidas mesmo se as notificações por email forem excluídas, portanto você pode precisar corrigir quaisquer referências quebradas após excluir emails.

  • Incluir Agendamentos: Por padrão, se agendamentos de operação foram incluídos como parte do projeto quando foi exportado, eles serão incluídos quando o projeto for importado. Para excluir agendamentos da importação, desmarque a caixa de seleção.

  • Endpoints globais: Qualquer endpoint global usado pelo projeto sendo importado é listado e deve ser adicionado ao ambiente selecionado usando uma destas opções:

    

    • Usar endpoint global existente: Visível apenas quando o endpoint global já existe na organização. Selecione para adicionar um endpoint de ambiente a um endpoint global existente para o ambiente selecionado. Use o menu para selecionar o endpoint global existente:

      

      Se o endpoint global existente já tiver um endpoint de ambiente para o ambiente selecionado, o endpoint de ambiente existente será usado para o projeto importado. Se o endpoint global existente não tiver um endpoint de ambiente para o ambiente selecionado, as credenciais fornecidas no projeto importado serão usadas (se aplicável). Caso contrário, o endpoint de ambiente precisará ser configurado após a importação.

    • Criar novo endpoint global: Selecione para criar um novo endpoint global para a organização:

      

      Quando o projeto for importado, o endpoint global será adicionado ao ambiente selecionado e precisará ser configurado após a importação.

• Importar: Clique para importar o projeto. Se o projeto foi importado com sucesso, o projeto importado abre na tela de design. Além disso, o novo projeto fica disponível na página Projetos.

  Após a importação do projeto, ele ainda não foi implantado. Quando estiver pronto para implantar, consulte Implantação de projeto.

Importação seletiva

Para importar apenas componentes especificados em um projeto existente, use o menu de ações do projeto e clique em Importar do Projeto. Você pode importar componentes de um arquivo JSON de projeto ou de outro projeto no mesmo ambiente.

Etapa 1: Opções de importação

Selecione ou carregue um projeto:

• Escolha carregar um arquivo local: Você pode fornecer um arquivo JSON de projeto da zona de upload. Você pode arrastar e soltar um arquivo JSON de projeto na zona de upload ou selecionar um arquivo manualmente.

  Quando clicado, uma caixa de diálogo de seleção de arquivo é aberta. Selecione o arquivo e clique em Carregar:

  

• Ou selecione um projeto existente do seu ambiente: Selecione um projeto existente do ambiente do projeto atualmente acessado.

• Próximo: Clique para continuar para a próxima etapa.

• Cancelar: Clique para cancelar o processo de importação e retornar ao projeto.

Etapa 2: Escolher componentes

Selecione os componentes a importar:

• Importar do projeto: Este painel exibe o nome do projeto de origem e os componentes disponíveis para importação.

• Importar para o projeto: Este painel exibe o nome do projeto sendo acessado e todos os componentes no projeto.

  • Mostrar / Ocultar itens não afetados: Mostra (padrão) ou oculta componentes não afetados pela importação.

• Componentes do projeto: Cada categoria de componente disponível em um projeto é exibida ao lado de um número entre parênteses indicando quantos componentes estão na categoria. Os componentes em uma categoria de componente são listados em ordem alfabética. No painel Importar do projeto, use as caixas de seleção para selecionar os componentes a serem importados para o projeto sendo acessado.

• Seleção automática de dependências: Alterne esta opção para controlar como as dependências de componentes são tratadas durante a importação. Quando ativada (padrão), selecionar um componente seleciona automaticamente todas as suas dependências obrigatórias, que não podem ser desmarcadas individualmente. Quando desativada, você pode selecionar componentes individuais sem incluir automaticamente suas dependências.

• Pesquisa: Use a caixa de pesquisa para inserir uma palavra-chave única ou uma sequência de palavras-chave. A sequência de palavras-chave fica destacada em azul no nome do componente:

  

• Expandir / Recolher todas as categorias: Expande ou recolhe todas as categorias de componentes do projeto.

• Mover para o projeto: Ativado quando um componente é selecionado no painel Importar do projeto. Após clicar, os componentes selecionados e suas dependências são adicionados ao painel Importar para o projeto. Os componentes adicionados ao projeto são indicados com um ícone azul Novo:

  

• Adicionar componentes importados a um novo fluxo de trabalho: Selecione esta opção para importar qualquer operação em um novo fluxo de trabalho. O fluxo de trabalho é nomeado Importado e inclui a data e hora da importação no formato YYYY-MM-DD HH:MM:SS (por exemplo, Importado 2025-10-15 08:30:00). Esta opção fica indisponível até que você selecione pelo menos uma operação para importação.

• Conflitos: Quando um componente importado compartilha o mesmo nome de um componente na mesma categoria de componente, ocorre um conflito:

  

  Quando presentes, os conflitos devem ser resolvidos para concluir a importação. Use as setas para cima e para baixo para navegar até cada conflito.

  Os endpoints com conflitos têm estas ações:

  

  • Usar endpoint existente: Selecione para usar um endpoint configurado no projeto sendo acessado. Use o menu para selecionar o endpoint existente.

    • Substituir ou copiar componente: Se o endpoint existente do projeto e o endpoint importado tiverem o mesmo tipo de atividade com nomes correspondentes, estas opções ficam disponíveis:

      • Substituir: Selecione para substituir o tipo de atividade existente pelo tipo de atividade sendo importado.

      • Manter ambos: Selecione para manter ambos os tipos de atividade do endpoint como componentes independentes. O nome do componente sendo importado é acrescido de um número incrementado entre parênteses.

  • Criar novo endpoint: Selecione para criar um novo endpoint no projeto sendo acessado. Use o menu para selecionar Global (consulte Endpoints Globais) ou Nível do projeto.

  Todos os componentes com conflitos (exceto endpoints) têm estas ações:

  • Substituir: Substitui o componente existente pelo componente sendo importado. Os componentes importados sendo usados como substituição são indicados com um ícone roxo Substituir:

• Manter ambos: Mantém ambos os componentes. O nome do componente sendo importado recebe um número incrementado entre parênteses. Esses componentes são indicados visualmente com um ícone azul Novo:

  

Para componentes em conflito que incluem diferenças de conteúdo ou configuração, um botão Visualizar alterações aparece ao lado do conflito. Clique em Visualizar alterações para abrir uma visualização de diferenças que mostra o conteúdo ou a configuração do componente no projeto sendo acessado em comparação com o componente recebido. A visualização de diferenças permanece acessível antes e depois de confirmar as resoluções de conflito, e fica disponível novamente se você clicar em Editar alterações. O botão aparece apenas quando existem diferenças.

A barra de título da visualização de diferenças exibe o tipo e o nome do componente (por exemplo, "Decision: Decision" ou "Operation: Bulk Insert"). Os seguintes controles estão disponíveis na barra de título:

• Abrir em nova janela: Abre a visualização de diferenças em uma nova janela pop-up. Clique novamente para retorná-la à posição inline.
• Maximizar / Restaurar: Expande a visualização de diferenças para preencher o espaço disponível na tela ou a retorna ao seu tamanho padrão.
• Fechar: Fecha a visualização de diferenças.

Você pode arrastar a visualização de diferenças pela sua barra de título para reposicioná-la em qualquer lugar da tela e redimensioná-la arrastando suas bordas ou cantos. Uma barra de rolagem vertical fica disponível quando a visualização de diferenças contém muitas alterações.

A visualização de diferenças usa um dos seguintes formatos, dependendo do tipo de componente:

• Visualização de diferenças de código: Usada para scripts e transformações. Mostra dois painéis lado a lado:

  • Painel esquerdo: Mostra o conteúdo do componente no projeto sendo acessado. Linhas removidas são destacadas em vermelho.

  • Painel direito: Mostra o conteúdo do componente recebido. Linhas adicionadas são destacadas em verde.

  Para transformações, cada regra de mapeamento alterada aparece como uma seção recolhível rotulada com o caminho do campo (por exemplo, "Mapping rule json/isActive"). Clique na seta para expandir ou recolher seções individuais.

• Visualização de diferenças de comparação de campos: Usada para ferramentas, notificações por email, operações (incluindo seus agendamentos, ações e opções), variáveis de projeto, endpoints de conector e atividades de conector. Mostra uma tabela com as colunas Nome, Antes e Depois listando cada campo alterado:

  

  Uma linha alterada é tingida de vermelho na coluna Antes e de verde na coluna Depois, e os caracteres ou palavras específicos que mudaram dentro de um valor são destacados mais fortemente. Campos relacionados são agrupados sob cabeçalhos de seção, como as condições individuais de uma ferramenta Decision, os grupos de opções aninhados de um endpoint de conector ou as etapas de uma operação. Um campo cujo valor faz referência a uma variável de projeto ou variável global é exibido como uma referência vinculada mostrando o nome da variável em vez de seu valor literal. Um campo de credencial, como uma senha ou token de segurança, é mascarado nas colunas Antes e Depois.

  Um campo cujo nome ou valor é muito longo para ser exibido na tabela, ou cujo valor é um objeto ou array (mostrado como uma string JSON), inclui um ícone de expansão. Clique no ícone para abrir uma visualização de diferenças inline do conteúdo desse campo, mostrada como uma visualização de diferenças de código com linhas removidas destacadas em vermelho e linhas adicionadas destacadas em verde.

  Para uma atividade de conector que consulta ou recupera dados, um campo Response pode mostrar o esquema de resposta como uma árvore expansível. Campos adicionados ao esquema são destacados em verde.

  Para um conflito de endpoint de conector, essa mesma visualização de diferenças de comparação de campos está disponível no botão Visualizar alterações ao lado da atividade listada em Substituir ou copiar componente (descrito acima).

Uma linha Steps lista as atividades usadas por uma operação, e uma linha Operation lista a operação referenciada por uma ferramenta Decision ou Invoke Operation. Quando uma atividade ou operação referenciada compartilha um nome com um componente já existente no projeto sendo acessado, "(source project)" é adicionado ao seu nome na coluna After para distinguir o componente recebido do existente com o mesmo nome.

Se uma atividade ou operação referenciada é em si um conflito e você o resolve reutilizando o componente existente no projeto, a coluna After é atualizada para mostrar o nome que o componente recebido terá após a importação.

Estas ações são habilitadas apenas quando há alterações em conflitos:

• Replace All: Clique para selecionar em massa Replace (descrito acima) para todos os conflitos de componentes.

• Keep All: Clique para selecionar em massa Keep both (descrito acima) para todos os conflitos de componentes.

• Confirm changes: Habilitado apenas quando uma ação é selecionada para todos os conflitos. Clique para salvar as ações de conflito selecionadas. Após clicar, o botão Finish é habilitado.

• Edit changes: (Visível após clicar em Confirm changes.) Clique para editar as resoluções de conflito.

• Reset all: Redefine o projeto para seu estado original, removendo qualquer componente novo ou substituído do painel Import to project.

• Cancel: Clique para cancelar o processo de importação e retornar ao projeto.

• Prev / Next:

• Import: Clique para importar os componentes e retornar ao projeto. Os componentes importados são categorizados em um grupo personalizado chamado Imported seguido pela data e hora da importação (no formato YYYY-MM-DD HH:MM:SS):