Atividade de Consulta do Microsoft SharePoint 365 no Jitterbit Studio

Introdução

Uma atividade de Consulta do Microsoft SharePoint 365, usando sua conexão do Microsoft SharePoint 365, consulta dados de objetos no Microsoft SharePoint 365 e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade de Consulta do Microsoft SharePoint 365

Uma instância de uma atividade de Consulta do Microsoft SharePoint 365 é criada a partir de uma conexão do Microsoft SharePoint 365 usando seu tipo de atividade de Consulta.

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

Uma atividade de Consulta do Microsoft SharePoint 365 existente pode ser editada a partir destes locais:

• A tela de design (consulte Menu de ações de componentes em Tela de design).
• A aba Componentes do painel de projeto (consulte Menu de ações de componentes em Aba Componentes do painel de projeto).

Configurar uma atividade de Consulta do Microsoft SharePoint 365

Siga estas etapas para configurar uma atividade de Consulta do Microsoft SharePoint 365:

• Etapa 1: Inserir um nome e selecionar um objeto
  Forneça um nome para a atividade e selecione um objeto.

• Etapa 2: Selecionar objetos filhos
  Especifique os objetos filhos a selecionar.

• Etapa 3: Definir uma string de filtro
  Defina condições para uma consulta nos objetos filhos selecionados.

• Etapa 4: Revisar os esquemas de dados
  Todos os esquemas de solicitação ou resposta são exibidos.

Etapa 1: Inserir um nome e selecionar um objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Menu de endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, consulte Alterar o endpoint atribuído em Telas de configuração.

  • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint selecionado no momento.

• Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade de Consulta do Microsoft SharePoint 365 e não deve conter barras / ou dois-pontos :.

• Selecionar Objeto: Esta seção exibe objetos disponíveis no endpoint do Microsoft SharePoint 365.

  • Objeto Selecionado: Após um objeto ser selecionado, ele é listado 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 objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada digitação. Para recarregar objetos do endpoint ao pesquisar, insira critérios de pesquisa e depois atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar objetos do endpoint do Microsoft SharePoint 365. Isso pode ser útil se objetos foram adicionados ao Microsoft SharePoint 365. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

• Selecionando um Objeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Microsoft SharePoint 365:

  • Nome: O nome do objeto do Microsoft SharePoint 365.

  • Tipo: O tipo de objeto do Microsoft SharePoint 365.

  • Descrição: A descrição do objeto do Microsoft SharePoint 365.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e fechar 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 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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecionar objetos filhos

Nesta etapa, selecione qualquer objeto filho. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Classes de Objeto: Esta seção exibe as classes de objeto filho disponíveis e selecionadas para interagir com o endpoint do Microsoft SharePoint 365.

  • Objetos Filhos Disponíveis: Esta seção exibe uma lista de classes de objeto filho disponíveis no Microsoft SharePoint 365.

    • Pesquisar: Digite 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 serão filtrados em tempo real a cada digitação. Para recarregar objetos do endpoint ao pesquisar, digite os critérios de pesquisa e depois atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar objetos do endpoint do Microsoft SharePoint 365. Isso pode ser útil se objetos foram adicionados ao Microsoft SharePoint 365. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

    • Adicionando um Objeto Filho: Na coluna Objetos Filhos Disponíveis, clique em qualquer lugar de uma linha para selecionar uma ou mais classes de objeto filho. Em seguida, clique no ícone de adição para adicionar as classes selecionadas à coluna Objetos Filhos Selecionados.

  • Objetos Filhos Selecionados: Após adicionar uma classe de objeto filho, ela é listada aqui.

    • Removendo um Objeto Filho: Na coluna Objeto Filho Selecionado, clique em qualquer lugar de uma linha para selecionar uma ou mais classes de objeto filho. Em seguida, clique no ícone de remoção para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.

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

• Próximo: Clique para armazenar temporariamente a configuração desta 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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Definir uma string de filtro

Nesta etapa, a String de Filtro de uma consulta é definida usando campos de objeto disponíveis e configurações de consulta. Cada elemento da interface do usuário desta etapa é descrito abaixo.

A interface usada nesta etapa da configuração de uma atividade Consulta do Microsoft SharePoint 365 depende da aba selecionada:

• Básico: Esta opção permite construir a String de Filtro com campos guiados.

• Avançado: Esta opção oculta os campos guiados e permite modificar a String de Filtro diretamente.

Básico

Se a aba Basic estiver selecionada, a interface descrita abaixo é apresentada.

• Object Fields: Selecione os campos a serem usados na consulta com base na classe de objeto selecionada.

  • Search: Digite qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos do objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada digitação.

  • Refresh: Clique no ícone de atualização ou na palavra Refresh para recarregar os campos do objeto do endpoint Microsoft SharePoint 365.

  • Select All in Object Class: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma vez.

  • Select Fields: Selecione as caixas de seleção dos campos que deseja incluir na consulta para adicioná-los automaticamente à Filter String. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.

  • Page Size: Digite um tamanho de página para ativar a paginação de resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

  • Include Count: Selecione para incluir o número de resultados de uma consulta como parte da resposta.

  • Full Text Search: Digite termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint Microsoft SharePoint 365 determina como a pesquisa é interpretada para uma classe de objeto.

  • Skip: Digite um número de resultados a pular na resposta da consulta.

  • Top: Digite um número máximo de resultados a receber na resposta da consulta.

  • Conditional Clauses: Para adicionar condicionais, use esses campos como entrada para ajudar a construir as cláusulas, que então aparecem na Filter String.

    • Object: Use o menu suspenso para selecionar a classe de objeto a usar para a condicional.

    • Field: Use o menu suspenso para selecionar o campo da classe de objeto a usar para a condicional.

    • Operator: Use o menu suspenso para selecionar um operador apropriado:

      Comparação
      Equals
      Greater Than
      Greater Than or Equals
      Less Than
      Less Than or Equals

    • Value: Digite o valor desejado para comparar com as seleções anteriores do menu suspenso.

    • Remove: Clique no ícone de exclusão para remover a condicional da tabela.

    • Add: Clique para adicionar uma nova condicional à tabela e à Filter String.

    • Remove All: Clique para remover todas as condicionais da tabela e da Filter String.

  • Filter String: Conforme você preenche os outros campos na aba Basic, a instrução de filtro nesta caixa de texto é preenchida automaticamente com os campos selecionados, condições e opções de consulta.

• Test Query: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta é exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes são exibidas.

  Nota

  Devido a uma limitação no OData v4 Protocol, uma consulta válida que não retorna resultados exibe uma tabela vazia e não mostra uma mensagem de erro.

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

• Next: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Finished 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 solicita que você confirme que deseja descartar as alterações.

Avançado

Se a guia Avançado estiver selecionada, a interface descrita abaixo será apresentada.

• Tamanho da página: Digite um tamanho de página para ativar a paginação de resultados. O número de resultados em uma página totalizará até o tamanho especificado. Um link para a próxima página de resultados também será incluído na resposta.

• Cadeia de filtro: Edite a instrução de cadeia de filtro diretamente.

• Testar consulta: Clique para validar a consulta. Se a consulta for válida, uma amostra de até 10 registros recuperados da consulta será exibida em uma tabela. Se a consulta não for válida, mensagens de erro relevantes serão exibidas. Se você editar a cadeia de filtro enquanto estiver no modo Avançado, a consulta deve ser válida e validada por meio deste botão para ativar o botão Próximo.

  Nota

  Devido a uma limitação no Protocolo OData v4, uma consulta válida que não retorna nenhum resultado tem uma tabela vazia e não exibe uma mensagem de erro.

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

• Próximo: Clique para armazenar temporariamente a configuração desta 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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 4: Revisar os esquemas de dados

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

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

  O conector Microsoft SharePoint 365 usa o Protocolo OData v4. Consulte a documentação da API para obter informações sobre os nós de esquema e campos.

  A atividade Consulta usa JSON em seu esquema de resposta.

• Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas do endpoint Microsoft SharePoint 365. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

• Editar: Clique no ícone de edição acima de cada esquema de dados para entrar no editor. O editor permite adicionar, excluir e reorganizar nós e campos e alterar seus tipos de dados. Todos os nós e campos recém-adicionados são definidos como [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas apenas após consultar a documentação disponível do endpoint. Após fazer edições de esquema, uma data da última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas os redefinirá para suas estruturas padrão.

• 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 solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Query do Microsoft SharePoint 365, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as definições da operação, que incluem a capacidade de encadear operações que estão no mesmo fluxo de trabalho ou em fluxos de trabalho diferentes.

As ações de menu de uma atividade são acessíveis no painel do projeto e na tela de design. Para obter detalhes, consulte Menu de ações de atividade em Noções básicas do conector.

As atividades Query do Microsoft SharePoint 365 podem ser usadas como fonte com estes padrões de operação:

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

Para usar a atividade com funções de script, escreva os dados em um local temporário e depois 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.