Configuração do usuário final de um conector do Conector Builder personalizado no Jitterbit Integration Studio

Introdução

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

Acessar um conector personalizado

Em um projeto do Integration Studio, os conectores personalizados são acessados a partir da paleta de componentes de design e aparecem da mesma forma que qualquer outro conector.

Quaisquer conectores do Conector Builder que você criou, tanto não publicados quanto publicados, estarão acessíveis para você. Aqueles criados por outros na organização estarão acessíveis para você apenas se forem publicados, a menos que você seja um administrador da organização Harmony.

Configurar a conexão de um conector personalizado

Um conector fornece uma interface para criar conexões autenticadas, a base utilizada para gerar instâncias de atividades. Essas atividades, uma vez configuradas, interagem com um serviço específico por meio da conexão.

Uma nova conexão personalizada é criada usando o conector personalizado a partir de uma dessas localizações:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A página Endpoints Globais (veja Criar um endpoint global em Endpoints Globais).

Uma conexão personalizada existente pode ser editada a partir destes locais:

• A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
• A aba Componentes no painel do projeto (veja Menu de ações do componente na Aba Componentes do painel do projeto).
• A página Endpoints Globais (veja Editar um endpoint global em Endpoints Globais).

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 da configuração de conexão são abordados abaixo.

• Nome da conexão: Insira um nome para identificar a conexão personalizada. O nome deve ser único para cada conexão personalizada e não deve conter barras (/) ou dois pontos (:). Este nome também é usado para identificar o endpoint, que se refere tanto à conexão quanto às suas atividades.

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

  Cuidado

  Ao editar a URL de autenticação, observe que o método de teste de autenticação não é visível. Verifique com o criador do conector para garantir que a nova URL de teste corresponda ao método configurado pelo criador do conector.

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

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

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

• Teste: Este campo está presente se o conector personalizado foi configurado para usar autenticação básica. Clique neste botão para verificar a conexão usando a configuração fornecida.

• 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 pede para você confirmar 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 (veja Dependências de componentes, exclusão e remoção). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Atividades do conector personalizado

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

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

Criar uma atividade de conector personalizado

Uma instância de uma atividade é criada a partir da conexão configurada usando um tipo de atividade.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).

• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).

Configurar uma atividade de conector personalizado

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

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

• Nome: Insira um nome 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 Requisição: Se o conector personalizado foi criado com parâmetros de caminho, parâmetros de string de consulta ou cabeçalhos de requisição para a atividade, campos adicionais conforme definidos durante a criação do 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 habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração para esta 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 alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

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

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

  Nota

  Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

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

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

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

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

Próximas etapas

Após configurar a atividade de um conector personalizado, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

Uma vez que uma atividade foi criada, as ações do menu para essa atividade estão acessíveis no painel do projeto nas abas Fluxos de Trabalho ou Componentes, e na tela de design. Veja o menu de ações da atividade para mais detalhes.

Os padrões de operação com os quais as atividades do Conector Builder personalizado podem ser usadas dependem de se a atividade fornece dados (como fonte) ou recebe dados (como destino) em uma operação, conforme descrito abaixo em Usado como fonte e Usado como destino.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.

Usado como fonte

Atividades do Conector Builder personalizado que são usadas como fonte podem ser utilizadas com estes padrões de operação:

• Padrão de transformação
• Padrão de arquivo de dois destinos (como a primeira fonte apenas)
• Padrão de duas transformações (como a primeira fonte apenas)

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

Usado como um destino

Atividades personalizadas do Connector Builder que são usadas como um destino podem ser utilizadas com estes padrões de operação:

• Padrão de transformação
• Padrão de duas transformações (apenas como o segundo destino)

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

Usar chunking

Muitas APIs de serviços web têm limitações de tamanho. Se você estiver enfrentando limites de registro impostos pela API, pode ser interessante usar chunking para dividir os dados de origem em múltiplos pedaços. A transformação é então realizada 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 instruções e melhores práticas sobre como usar chunking, veja Opções de operação.