Ir para o conteúdo

Atividade BULK HTTP v2

Introdução

Uma atividade HTTP v2 BULK, utilizando sua conexão HTTP v2, envia múltiplas requisições para um serviço acessível através do protocolo HTTP ou HTTPS, e pode ser usada tanto como uma fonte (para fornecer dados em uma operação) quanto como um destino (para consumir dados em uma operação).

Criar uma atividade HTTP v2 BULK

Uma instância de uma atividade HTTP v2 BULK é criada a partir de uma conexão HTTP v2 usando seu tipo de atividade BULK.

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 HTTP v2 BULK existente pode ser editada a partir destes locais:

Configurar uma atividade HTTP v2 BULK

Siga estas etapas para configurar uma atividade HTTP v2 BULK:

Etapa 1: Insira um nome e especifique as configurações

Neste passo, forneça um nome para a atividade e especifique o método, caminho, parâmetros de solicitação, cabeçalhos de solicitação e configurações adicionais. Cada elemento da interface do usuário deste passo é descrito abaixo.

Configuração da atividade em massa HTTP v2 passo 1

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade BULK HTTP v2 e não deve conter barras / ou dois pontos :.

  • Configurações Opcionais: Clique para expandir configurações opcionais adicionais:

    • Método: Especifique o método HTTP a ser utilizado, um dos POST, PUT, GET, DELETE, HEAD, PATCH ou OPTIONS.

    • Caminho: Insira uma URL a ser utilizada para a atividade:

      • Se deixado em branco, a URL Base configurada na conexão HTTP v2 será utilizada em tempo de execução.
      • Se um caminho parcial for especificado, ele será anexado à URL Base configurada na conexão HTTP v2.
      • Se uma URL completa for especificada, ela substituirá a URL Base configurada na conexão HTTP v2.

      Parâmetros de solicitação podem ser incluídos envolvendo-os entre chaves { }. Parâmetros de consulta (como /queryrecord?id=10) também podem ser utilizados.

      • URL: Exibe a URL completa a ser utilizada em tempo de execução.

    • Parâmetros de Solicitação: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um Nome e Valor para cada parâmetro de solicitação. Os parâmetros de solicitação fornecidos serão automaticamente codificados em URL.

      Alternativamente, os parâmetros de solicitação podem ser fornecidos na transformação de solicitação. Parâmetros de solicitação que não compartilham uma chave são enviados cumulativamente, independentemente de onde são especificados. Se a mesma chave de parâmetro for especificada tanto neste campo quanto na transformação de solicitação, a especificada na transformação terá precedência.

      Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

      Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição ou o ícone de exclusão .

      Para excluir todas as linhas, clique em Limpar Tudo.

      Importante

      Os campos na tabela Parâmetros da Solicitação exibem o ícone de variável apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

      Os campos na tabela Parâmetros da Solicitação não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

    • Cabeçalhos da Solicitação: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um Nome e Valor para cada cabeçalho de solicitação.

      Alternativamente, os cabeçalhos podem ser definidos em outros campos de configuração da interface do usuário ou fornecidos na transformação da solicitação. Cabeçalhos que não compartilham uma chave são enviados cumulativamente, independentemente de onde são especificados.

      Se a mesma chave de cabeçalho for especificada em vários locais, a seguinte ordem de precedência é seguida:

      1. Um cabeçalho fornecido na transformação da solicitação substitui todos os campos abaixo.
      2. Um cabeçalho fornecido no campo Cabeçalhos da Solicitação de uma atividade HTTP v2 BULK (este campo) substitui o restante dos campos abaixo.
      3. Um cabeçalho fornecido no campo Cabeçalhos da Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos da Solicitação na Execução da Atividade estiver habilitado, tem a menor precedência.

      Nota

      Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

      Aviso

      Não defina manualmente cabeçalhos de solicitação Authorization em atividades HTTP v2 se a conexão HTTP v2 estiver configurada para enviar seus próprios cabeçalhos de solicitação Authorization dependendo do tipo de autenticação selecionado. Fazer isso resulta na terminação da operação e falha antes de alcançar o endpoint de destino e é registrado como um erro 400 Bad Request.

      Se a autenticação dinâmica for necessária no nível da atividade, defina o tipo de autenticação da conexão como Sem Autenticação e configure os cabeçalhos de solicitação de Autorização da atividade conforme necessário.

      Para salvar a linha, clique no ícone de envio na coluna mais à direita.

      Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição ou o ícone de exclusão .

      Para excluir todas as linhas, clique em Limpar Tudo.

      Importante

      Os campos na tabela Cabeçalhos da Solicitação exibem o ícone de variável apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

      Os campos na tabela Cabeçalhos da Solicitação não suportam o uso de variáveis para passar JSON bruto. Se o seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

    • Configurações Adicionais: Clique no ícone de adicionar para adicionar uma linha à tabela abaixo e insira um Nome e Valor para cada configuração adicional.

      Essas configurações adicionais são suportadas:

      Chave
      		 Valor Padrão Tipo de Dados Descrição
      connection-timeout 30000 Inteiro O tempo limite de transferência em milissegundos. Se essa configuração não for especificada, o tempo limite de transferência padrão é de 30000 milissegundos (30 segundos). Defina como 0 para um tempo limite ilimitado.
      content-type — String O tipo de conteúdo da estrutura de solicitação que é esperado pela API em particular. Por exemplo, text/plain, application/json, application/x-www-form-urlencoded, etc. Se essa configuração não for especificada, não há valor padrão.
      max-redirect 50 Inteiro O número máximo de redirecionamentos a seguir. Se essa configuração não for especificada, o padrão é seguir 50 redirecionamentos. Defina como 0 ou um número negativo para impedir o seguimento de quaisquer redirecionamentos.
      trailing-linebreaks false String Remove espaços em branco e quebras de linha no início e no final quando definido como true. Se essa configuração não for especificada ou definida como false, os dados permanecem inalterados.

Alternativamente, configurações adicionais podem ser fornecidas na transformação de solicitação. Configurações adicionais que não compartilham uma chave são enviadas cumulativamente, independentemente de onde são especificadas. Para todas as configurações, exceto para o tipo de conteúdo, se a mesma chave de configuração for especificada tanto neste campo quanto na transformação de solicitação, a especificada na transformação tem precedência.

Para content-type, um valor especificado aqui tem precedência sobre todos os outros lugares na interface onde o tipo de conteúdo pode ser especificado. Se o tipo de conteúdo for especificado em vários lugares, esta ordem de precedência é seguida:

  1. Um cabeçalho Content-Type fornecido na tabela de Configurações Adicionais de uma atividade HTTP v2 BULK (esta tabela) substitui todos os campos abaixo.
  2. O campo bodyContentType especificado em uma transformação de solicitação substitui os campos restantes abaixo.
  3. Um cabeçalho Content-Type fornecido no nó headers da transformação de solicitação substitui os campos restantes abaixo.
  4. Um cabeçalho Content-Type fornecido no campo Cabeçalhos da Solicitação de uma atividade HTTP v2 BULK substitui o campo restante abaixo.
  5. Um cabeçalho Content-Type fornecido no campo Cabeçalhos da Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos da Solicitação na Execução da Atividade estiver habilitado, tem a menor precedência.

Nota

Se um cabeçalho for definido em múltiplas localizações, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Esta ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

Para salvar a linha, clique no ícone de enviar na coluna mais à direita.

Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de editar ou o ícone de excluir .

Para excluir todas as linhas, clique em Limpar Tudo.

Importante

Os campos na tabela de Configurações Adicionais exibem o ícone de variável apenas no modo de edição. Para que os valores variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

Os campos na tabela Configurações Adicionais não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

  • Ignorar erro de operação em caso de código de status não bem-sucedido: Selecione para que as operações relatem um status bem-sucedido, mesmo que um código de status não bem-sucedido seja retornado da API que o conector está chamando. O valor padrão é não selecionado.

  • Selecionar código de status HTTP a ser considerado sucesso em tempo de execução da operação: Selecione Agrupado por Classe ou Granular (Entrada Manual) para considerar códigos de status especificados como bem-sucedidos nos logs de operação.

    • Agrupado por Classe: Quando selecionado, um dropdown é exibido com classes de códigos de status não bem-sucedidos a serem tratados como bem-sucedidos. As opções do dropdown incluem Redirecionamento 3xx, Erro do Cliente 4xx e Erro do Servidor 5xx. O valor padrão do dropdown é não selecionado.

    • Granular (Entrada Manual): Quando selecionado, um campo é exibido para inserir manualmente uma lista delimitada por vírgulas de códigos de status não bem-sucedidos a serem tratados como bem-sucedidos. Esta lista pode incluir diferentes classes de códigos de status ao mesmo tempo. O valor padrão do campo é em branco.

      ![HTTP v2 granular status](/_download/images/cs/conn/http-v2/http-v2-granular-status.png){ style="width:940px" }

  • Multipart: Selecione para suportar requisições multipart/form-data ao usar esquemas padrão. Isso é necessário para requisições que incluem uploads de formulário RFC 1867.

  • Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma requisição em lote. Se algum erro for encontrado, ele será registrado no log de operação.

  • Salvar & 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 será 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 mudanças feitas em qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade em massa HTTP v2

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    Nota

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

    Os esquemas de solicitação e resposta padrão consistem nos seguintes nós e campos:

    • Solicitação:

      Nó/Campo do Esquema de Solicitação Notas
      json Formato do esquema de solicitação
      requests Nó de solicitações
      item Nó de itens
      request Nó de uma solicitação específica
      root Nó da raiz da solicitação
      identifier Identificador da solicitação
      path Caminho da solicitação, não incluindo a URL base do endpoint
      headers Nó de cabeçalhos
      item Nó de um cabeçalho específico
      key Chave do cabeçalho
      value Valor do cabeçalho
      method Método da solicitação
      requestParameters Nó de parâmetros da solicitação
      item Nó de um parâmetro de solicitação específico
      key Chave do parâmetro da solicitação
      value Valor do parâmetro da solicitação
      body Corpo da solicitação

    • Resposta:

      Campo/Node do Esquema de Resposta Notas
      json Formato do esquema de resposta
      responses Nó de respostas
      items Nó de itens
      response Nó de uma resposta específica
      responseItem Nó de um item de resposta
      identifier Identificador da resposta
      headers Nó de cabeçalhos
      item Nó de um cabeçalho específico
      key Chave do cabeçalho
      value Valor do cabeçalho
      error Nó de erro
      statusCode Código de status HTTP da resposta
      statusMessage Mensagem de status da resposta
      details Detalhes da resposta
      properties Propriedades da resposta
      responseContent Conteúdo da resposta
      status Um booleano indicando se uma resposta foi retornada

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint HTTP v2. Esta ação também regenera um 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 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 qualquer etapa. Uma mensagem pede para confirmar que você deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade HTTP v2 BULK, 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.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Fundamentos do conector.

Atividades HTTP v2 BULK que são usadas como fonte podem ser utilizadas com esses padrões de operação:

Atividades BULK do HTTP v2 que são usadas como um alvo podem ser utilizadas com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

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