Atividade de Consulta do Microsoft SharePoint 365

Introdução

Uma atividade de Consulta do Microsoft SharePoint 365, utilizando 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 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 mais detalhes, veja 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 (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 Consulta do Microsoft SharePoint 365

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

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

• Etapa 2: Selecione objetos filhos
  Especifique os objetos filhos a serem selecionados.

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

• Passo 4: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta são exibidos.

Passo 1: Insira um nome e selecione um objeto

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é descrito abaixo.

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

• Selecionar Objeto: Esta seção exibe os 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 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 critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar 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: Dentro da 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 do objeto do Microsoft SharePoint 365.

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

  Dica

  Se a tabela não for preenchida com objetos disponíveis, a conexão com o Microsoft SharePoint 365 pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e testando novamente as credenciais.

• 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: Selecionar objetos filhos

Nesta etapa, selecione quaisquer objetos filhos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Classes de Objetos: Esta seção exibe as classes de objetos filhos disponíveis e selecionadas para interagir no endpoint do Microsoft SharePoint 365.

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

    • 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 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 exibidos na configuração.

• Adicionar um Objeto Filho: Na coluna Objetos Filhos Disponíveis, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone de adicionar para adicionar as classes selecionadas à coluna Objetos Filhos Selecionados.

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

  • Remover um Objeto Filho: Na coluna Objeto Filho Selecionado, clique em qualquer lugar em uma linha para selecionar uma ou mais classes de objetos filhos. Em seguida, clique no ícone de remover para retornar as classes selecionadas à coluna Objetos Filhos Disponíveis.

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

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

Etapa 3: Definir uma string de filtro

Nesta etapa, uma 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 utilizada nesta etapa da configuração de uma atividade Consulta do Microsoft SharePoint 365 depende da aba selecionada:

• Básico: Esta opção permite que você construa a String de Filtro com campos guiados.

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

Básico

Se a aba Básico estiver selecionada, esta interface é apresentada:

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

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

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar os campos do objeto a partir do endpoint do Microsoft SharePoint 365.

  • Selecionar Todos na Classe de Objeto: 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.

  • Selecionar Campos: Selecione as caixas de seleção dos campos que deseja incluir na consulta para que sejam adicionados automaticamente à String de Filtro. Você também pode selecionar todos os campos de uma vez usando a caixa de seleção pai.

  • Tamanho da Página: Digite um tamanho de página para habilitar a paginação dos 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.

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

  • Pesquisa de Texto Completo: Digite termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint do Microsoft SharePoint 365 lida com a forma como a pesquisa é interpretada para uma classe de objeto.

  • Pular: Digite um número de resultados a serem pulados na resposta da consulta.

  • Máximo: Digite um número máximo de resultados a serem recebidos na resposta da consulta.

  • Cláusulas Condicionais: Para adicionar condicionais, use estes campos como entrada para ajudar a construir as cláusulas, que então aparecem na String de Filtro.

    • Objeto: Use o dropdown para selecionar a classe de objeto a ser usada para a condicional.

    • Campo: Use o dropdown para selecionar o campo da classe de objeto a ser usado para a condicional.

    • Operador: Use o dropdown para selecionar um operador apropriado:

      Comparação
      Igual
      Maior que
      Maior ou Igual
      Menor que
      Menor ou Igual

    • Valor: Insira o valor desejado para comparar com as seleções anteriores do dropdown.

    • Remover: Clique no ícone de excluir para remover a condição da tabela.

    • Adicionar: Clique para adicionar uma nova condição à tabela e String de Filtro.

    • Remover Todos: Clique para remover todas as condições da tabela e String de Filtro.

  • String de Filtro: À medida que você preenche os outros campos na aba Básico, a declaração da string de filtro nesta caixa de texto é automaticamente preenchida com os campos selecionados, condições e opções de consulta.

• Testar Consulta: 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 Protocolo OData v4, uma consulta válida que não retorna resultados tem uma tabela vazia e não exibe uma mensagem de erro.

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

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

Avançado

Se a aba Avançado estiver selecionada, esta interface é apresentada:

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

• String de Filtro: Edite a declaração da string de filtro diretamente.

• Consulta de Teste: 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. Se você editar a string de filtro enquanto estiver no modo Avançado, a consulta deve ser válida e validada através deste botão para habilitar o botão Próximo.

  Nota

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

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

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

• 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 do Microsoft SharePoint 365 utiliza o Protocolo OData v4. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

A atividade Query utiliza JSON em seu esquema de resposta.

• Refresh: Clique no ícone de atualizar ou na palavra Refresh para regenerar esquemas do endpoint do Microsoft SharePoint 365. 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.

• Edit: Clique no ícone de editar acima de cada esquema de dados para entrar no editor. O editor permite adicionar, excluir e reorganizar nós e campos, além de 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 somente após consultar qualquer documentação disponível para o endpoint. Após fazer edições no esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas irá redefinir os esquemas para suas estruturas padrão.

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

• Finished: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

• Discard Changes: 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.

Next steps

Após configurar uma atividade Query do Microsoft SharePoint 365, 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 mais detalhes, veja o menu de ações da atividade em Conceitos básicos do conector.

Atividades de Consulta do Microsoft SharePoint 365 podem ser usadas como fonte com esses padrões de operação:

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

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.