Ir para o conteúdo

Configuração do Usuário do Connector Builder

Introdução

Após a publicação de um conector personalizado, os membros da organização Harmony onde ele foi publicado terão acesso para configurar e usar o conector em projetos do Cloud Studio. Esta página descreve onde um usuário final pode encontrar conectores personalizados e como usá-los.

Acesse um Conector Personalizado

Em um projeto do Cloud Studio, os conectores personalizados são acessados na paleta de componentes de design. Eles têm a mesma aparência de qualquer outro conector, exceto pelo fato de terem um fundo de pasta roxo e a imagem do conector fornecida durante a criação do conector:

conectores com anotação personalizada pp

Nota

Os usuários finais devem usar um agente da versão 10.0 ou superior para usar conectores criados com o Connector Builder.

Configurar uma Conexão

Um conector fornece a interface para inserir entradas fornecidas pelo usuário, como credenciais, para criar uma conexão autenticada.

Uma nova conexão personalizada é criada usando o conector personalizado de um destes locais:

Uma conexão personalizada existente pode ser editada nestes locais:

Os campos fornecidos para configuração são diferentes para cada conector personalizado e dependem de como o criador do conector configurou o conector. Elementos comuns de configuração de conexão são abordados abaixo.

conexão personalizada

Dica

Campos com ícone de variável variável 2 suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.

  • Nome do Endpoint: Insira um nome a ser usado para identificar a conexão personalizada. O nome deve ser exclusivo para cada conexão personalizada e não deve conter barras (/) ou dois pontos (:). Como uma conexão específica e suas atividades são chamadas de endpoint, esse nome também é usado para identificar o endpoint personalizado.

  • URL de autenticação: Este campo estará presente se o conector personalizado tiver sido configurado para usar autenticação básica e este campo não tiver sido ocultado pelo criador do conector. Se presente, você pode editar o URL a ser testado com as credenciais inseridas abaixo.

    Cuidado

    Se estiver editando o URL de autenticação, observe que o método de teste de autenticação não fica visível. Verifique com o criador do conector se o novo URL de teste corresponde ao método configurado pelo criador do conector.

  • URL base: Este campo estará presente se não tiver sido ocultado pelo criador do conector. Se presente, você poderá editar a URL base usada para todas as atividades configuradas pelo usuário final. Não inclua nenhum parâmetro ou caminho de consultar, a menos que eles sejam usados para todas as atividades (você pode especificar caminhos e parâmetros exclusivos durante a configuração da atividade).

  • Credenciais: Os campos para inserir credenciais estarão presentes se o conector personalizado tiver sido configurado para usar autenticação básica. Isso inclui campos de nome de usuário e senha, cujos rótulos de campo correspondem àqueles configurados como Nomes para exibição durante a criação do conector.

  • Cabeçalhos de solicitação: Se o conector personalizado tiver sido criado com cabeçalhos de solicitação globais, campos adicionais definidos durante a criação do conector estarão presentes. Insira um valor ou edite o valor padrão (se fornecido) para o cabeçalho.

  • Teste: Este campo estará presente se o conector personalizado tiver sido configurado para usar autenticação básica. Clique neste botão para testar a conexão com o URL de autenticação configurado usando as credenciais fornecidas.

  • Salvar alterações: Clique para salvar e fechar a configuração da conexão.

  • Descartar alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem solicita que você confirme que deseja descartar as alterações.

  • Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (consulte Dependências, exclusão e remoção de componentes).

Configurar Atividades

Depois de configurar uma conexão personalizada, você pode configurar uma ou mais atividades associadas a essa conexão para usar como origem ou destino em uma operação. As atividades disponíveis são definidas durante a criação do conector.

Se a atividade pode ser usada como origem ou destino depende do serviço web específico e das estruturas de solicitação e resposta, se presentes. Para obter mais informações sobre o que determina se uma atividade pode ser usada como origem ou destino, consulte Partes de uma operação em Criação e configuração de operação.

Use o menu suspenso Mostrar para filtrar Endpoints e, em seguida, clique no bloco de conexão personalizada para exibir atividades que estão disponíveis para uso com uma conexão personalizada:

atividades personalizadas de endpoints

Para criar uma atividade que possa ser configurada, arraste o bloco de atividade da paleta para a operação.

Para obter mais informações sobre as partes de uma operação e como adicionar atividades às operações, consulte Criação e configuração de operações.

A tela de configuração da atividade fornece uma série de etapas para um usuário configurar, que são diferentes para cada conector customizado e dependem de como o criador do conector configurou o conector.

A primeira etapa normalmente exige que o usuário insira informações básicas, como um nome, e configure os campos conforme definido durante a criação do conector:

custom get step 1 get jira issue

Dica

Campos com ícone de variável variável 2 suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.

  • Nome: Insira um nome a ser usado para identificar a atividade do conector personalizado. O nome deve ser exclusivo para cada tipo de atividade associada à conexão e não deve conter barras (/) ou dois pontos (:).
  • Parâmetros de caminho, Parâmetros de string de consulta e Cabeçalhos de solicitação: Se o conector personalizado foi criado com parâmetros de caminho, parâmetros de string de consultar ou cabeçalhos de solicitação para a atividade, campos adicionais conforme definido durante criação de conector estão presentes. Insira um valor, edite o valor padrão (se fornecido) ou faça as seleções apropriadas conforme necessário para o conector específico.
  • Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.
  • Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não é salva até que você clique no botão Concluído na última etapa.
  • Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

A segunda etapa exibe quaisquer esquemas de dados de solicitação ou resposta fornecidos durante a criação do conector para a atividade específica:

esquema de dados da etapa 2 de obtenção personalizado

  • Esquema de dados: Os esquemas de dados de solicitação e/ou resposta são exibidos. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente posteriormente durante o mapeamento da transformação, onde você pode mapear campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e muito mais.

  • Atualizar: Clique no ícone de atualização atualizar 2 ou a palavra Atualizar para regenerar esquemas do design do conector do Connector Builder. Esta ação também regenera o esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

  • Descartar alterações: Após fazer as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos

Depois de configurar uma atividade personalizada do Connector Builder, você poderá usá-la em uma operação conforme descrito abaixo. Você também pode configurar a fragmentação de dados para dividir os dados em partes menores para processamento.

Conclua a Operação

Depois de configurar uma atividade customizada do Connector Builder, conclua a configuração da operação incluindo e configurando outras atividades, transformações ou scripts como etapas de operação. Você também pode definir as configurações de operação de uma operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

Depois que uma atividade personalizada do Connector Builder for criada, as ações de menu para essa atividade estarão acessíveis no painel do projeto nas guias Workflows ou Componentes e na quadro de design. Consulte Menu Ações de Atividade para detalhes.

Os padrões de operação com os quais as atividades do Custom Connector Builder podem ser usadas dependem de a atividade fornecer dados (como origem) ou receber dados (como destino) em uma operação, conforme descrito abaixo em Usado como origem e Usado como alvo.

Quando estiver pronto, implantar e execute a operação e valide o comportamento verificando oslogs de operação.

Usado Como Fonte

As atividades do Custom Connector Builder usadas como origem podem ser usadas com estes padrões de operação:

Outros padrões não são válidos usando atividades do Connector Builder usadas como origem.

Um caso de uso típico é usar uma atividade Custom Connector Builder no Transformação Pattern. Neste exemplo, a atividade personalizada Obter problema do Jira (Obter solicitação de problema do Jira ) fornece dados dentro da operação, que são então passados para a transformação (Jira para variável). A atividade Variable Write (Write Response) é usada como alvo, recebendo dados dentro da operação:

fonte personalizada da operação

Usado Como Alvo

As atividades do Custom Connector Builder usadas como destino podem ser usadas com estes padrões de operação:

Outros padrões não são válidos usando atividades do Connector Builder usadas como destino.

Um caso de uso típico é usar uma atividade Custom Connector Builder no Transformação Pattern. Neste exemplo, a atividade de leitura de variável (Solicitação de leitura) fornece dados dentro da operação, que são então passados para a transformação (Variável para Jira). A atividade personalizada Criar problema do Jira (Create Jira Issue Response) é usada como destino, recebendo dados dentro da operação:

alvo personalizado da operação

Usar Fragmentação

Muitas APIs de serviços da web têm limitações de tamanho. Se você estiver enfrentando limites de registro impostos pela API, talvez queira usar a fragmentação de dados para dividir os dados de origem em várias partes. A transformação é então executada em cada pedaço separadamente, com cada pedaço de origem produzindo um pedaço de destino. Os pedaços de destino resultantes se combinam para produzir o destino final.

Para obter instruções e práticas recomendadas sobre o uso de fragmentação de dados, consulte Opções de operação.