Ir para o conteúdo

Atividade de Atualização OData

Introdução

Uma atividade de Atualização OData, utilizando sua conexão OData, atualiza dados de objetos em um endpoint OData e é destinada a ser usada como um alvo para consumir dados em uma operação.

Criar uma atividade de Atualização OData

Uma instância de uma atividade de Atualização OData é criada a partir de uma conexão OData usando seu tipo de atividade Atualização.

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 mais detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Atualização OData existente pode ser editada a partir destes locais:

Configurar uma atividade de Atualização OData

Siga estas etapas para configurar uma atividade de Atualização OData:

Etapa 1: Insira um nome e selecione o objeto

Nesta etapa, forneça um nome para a atividade e selecione o tipo de objeto a ser atualizado. Especifique quaisquer cabeçalhos HTTP necessários e se a atividade deve continuar em caso de erro. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de atualização OData passo 1

Dica

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

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Atualização OData e não deve conter barras (/) ou dois-pontos (:).

  • Selecionar Objeto: Esta seção exibe as classes de objeto disponíveis no endpoint OData.

    • Objeto Selecionado: Após selecionar uma classe de objeto, ela é listada aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar as classes de objeto do endpoint OData. Isso pode ser útil se o esquema do endpoint OData foi atualizado para suportar novos tipos de objetos. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar de uma linha para selecionar uma classe de objeto. Apenas uma classe de objeto pode ser selecionada. As informações disponíveis para cada objeto são obtidas do endpoint OData:

      • Nome: O nome da classe de objeto do endpoint OData.

      • Descrição: A descrição da classe de objeto do endpoint OData.

    Dica

    Se a tabela não for preenchida com classes de objeto disponíveis, a conexão OData pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

  • Propriedades HTTP Avançadas: Defina os cabeçalhos HTTP para a atualização. O protocolo OData aceita cabeçalhos HTTP padrão definidos em Rfc 2616 (seção 14) assim como quaisquer cabeçalhos personalizados específicos para o endpoint. clique no ícone de adicionar para adicionar um cabeçalho à tabela abaixo e insira um par chave-valor para cada parâmetro de 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.

    Nota

    Cabeçalhos personalizados devem ser configurados no endpoint para que ele os aceite como parte desta solicitação. Se você estiver usando o Microsoft Azure para gerenciar seu endpoint OData, consulte a documentação da Microsoft sobre Cabeçalhos Personalizados em Acessando Endpoints que Requerem Autenticação.

    Importante

    Campos na tabela Propriedades HTTP Avançadas 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.

    Campos na tabela Propriedades HTTP Avançadas 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\"};.

  • 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 solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações. Está selecionado por padrão.

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

    OData Update activity configuration step 1b

    • Cabeçalhos da Solicitação: Um local adicional para cabeçalhos HTTP. Os cabeçalhos definidos na tabela Propriedades HTTP Avançadas têm precedência.
  • 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 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 alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Os esquemas de solicitação e resposta gerados a partir do endpoint são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

OData Update activity configuration step 2

  • 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.

    • Solicitação:

      Campo/Nó do Esquema de Solicitação Descrição
      updaterequest Solicitação para atualizar um objeto (entidade)
      request Nó representando a solicitação de atualização
      item Nó representando os itens da solicitação
      Lista de Objetos Nó representando a lista de objetos-alvo (conjunto de entidades) para atualizar um objeto; por exemplo, o nó Airline
      Campos de Objetos ... Campos específicos da classe de objeto (tipo de entidade) dos objetos na lista de objetos; por exemplo, os campos AirlineCode e Name
      bind Nó representando vínculos de propriedade de navegação de entidade OData para adicionar ou atualizar
      item Nó representando uma propriedade de navegação a ser vinculada ao objeto no formato "key@odata.bind": "value"
      value String da referência do objeto para a propriedade de navegação; por exemplo, People('russellwhyte')
      key String do nome da propriedade de navegação a ser adicionada ou atualizada; por exemplo, LocationManager
      key Nó representando a chave do objeto a ser atualizado
      Chave da Entidade String da chave que identifica o objeto a ser atualizado; por exemplo, o campo AirlineCode no nó key
    • Resposta:

      Campo/Nó do Esquema de Resposta Descrição
      updateresponse Resposta da atualização de um objeto (entidade)
      response Nó representando a resposta da atualização
      item Nó representando os itens da resposta
      entity Nó representando as informações do objeto atualizado
      statusCode Código inteiro associado à resposta
      isUpdated String indicando se a atualização foi bem-sucedida
      message String da mensagem associada à resposta
      errorDetails Nó representando os detalhes do erro da atualização
      errorMsg String da mensagem associada ao erro

    O conector OData utiliza a biblioteca Java Apache Olingo OData 4.0. Consulte a documentação da biblioteca para informações adicionais sobre como o protocolo OData é suportado. Informações gerais sobre o protocolo OData também estão disponíveis no site de documentação do OData.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint OData. Esta ação também regenera um 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 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 uma atividade OData Atualizar, 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 Conceitos básicos do conector.

Atividades OData Atualizar podem ser usadas como um alvo 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.