Configuração do Usuário do Connector Builder¶

Introdução¶

Após um conector personalizado ser publicado, os membros da organização Harmony onde ele é publicado têm 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 e parecem iguais a qualquer outro conector.

Configurar uma Conexão¶

Um conector fornece a interface para inserir informações 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:

• A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
• A página Conexões globais (veja Criar uma conexão global em Conexões Globais).

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

• A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
• A página Conexões globais (veja Editar uma conexão global em Conexões 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 de configuração de conexão são abordados abaixo.

• Nome do Endpoint: Insira um nome para usar 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 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

  Se estiver editando a URL de autenticação, observe que o método de teste de autenticação não está visível. Verifique com o criador do conector para certificar-se de que a nova URL de teste corresponde 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 nenhum parâmetro de consultar ou caminho, 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: 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 testar a conexão em relação à URL de autenticação configurada usando as credenciais fornecidas.

• Salvar alterações: Clique para salvar e fechar a configuração de 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 (consulte Dependências de componentes, exclusão e remoção).

Configurar Atividades¶

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

Se a atividade pode ser usada como uma fonte ou um 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 uma fonte ou um destino, consulte Partes de uma operação em Criação e configuração da operação.

Para criar uma atividade que pode 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 adicionar atividades às operações, consulte Criação e configuração de operação.

A tela de configuração de atividade fornece uma série de etapas para um usuário configurar, que são diferentes para cada conector personalizado 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 definidos durante a criação do conector:

• Nome: Insira um nome para usar 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 sequência de consulta e Cabeçalhos de solicitação: Se o conector personalizado foi criado com parâmetros de caminho, parâmetros de sequência de consultar ou cabeçalhos de solicitação para a atividade, campos adicionais, conforme definido 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 desta 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

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

• Data Schema: 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 mais tarde durante o mapeamento de 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 ou a palavra Atualizar para regenerar esquemas do design do conector do Connector Builder. Essa 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 alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximos Passos¶

Após configurar uma atividade personalizada do Connector Builder, você pode usá-la dentro de uma operação conforme descrito abaixo. Você também pode querer configurar o fragmentação de dados para dividir os dados em pedaços menores para processamento.

Concluir a Operação¶

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

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

Os padrões de operação que as atividades do Custom Connector Builder podem ser usadas dependem se a atividade fornece dados (como uma fonte) ou recebe dados (como um destino) em uma operação, conforme descrito abaixo em Usado como uma fonte e Usado como alvo.

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

Usado Como Fonte¶

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

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

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

Usado Como Alvo¶

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

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

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

Usar Fragmentação de Dados¶

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 fragmentação de dados para dividir os dados de origem em vários chunks. A transformação é então realizada em cada chunk separadamente, com cada chunk de origem produzindo um chunk de destino. Os chunks 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.