Atividade de consulta do Microsoft SharePoint 365

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 se destina a ser usado 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 quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade existente de Consulta do Microsoft SharePoint 365 pode ser editada nestes locais:

• A quadro de design (veja menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel 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: Digite um nome e selecione um objeto
  Dê um nome para a atividade e selecione um objeto.

• Etapa 2: Selecionar objetos filhos
  Especifique os objetos filhos selecionados.

• Etapa 3: Definir uma sequência de caracteres de filtro
  Defina condições para uma consultar nos objetos filho selecionados.

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

Etapa 1: insira um nome e selecione 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.

• 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 objetos disponíveis no endpoint do Microsoft SharePoint 365.

  • Objeto selecionado: Depois que um objeto é selecionado, ele é listado aqui.

  • Pesquisa: 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 serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

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

  • Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar em 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.

    • 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 do Microsoft SharePoint 365 pode não ser bem-sucedida. Certifique-se de estar conectado reabrindo a conexão e testando as credenciais novamente.

• 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 desta etapa e prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 2: Selecione objetos filho

Nesta etapa, selecione quaisquer objetos filhos. 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 no endpoint do Microsoft SharePoint 365.

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

    • Pesquisa: 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 serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar objetos do endpoint do Microsoft SharePoint 365. Isso pode ser útil se objetos tiverem sido adicionados ao Microsoft SharePoint 365. Esta ação atualiza todos os metadados usados para criar 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 objetos filhos. Em seguida, clique no ícone Adicionar. para adicionar 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 objetos 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 prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 3: definir uma sequência de filtro

Nesta etapa, a String de Filtro de uma consultar é definida usando os campos de objeto e as configurações de consultar disponíveis. 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 que você crie 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 for selecionada, esta interface será apresentada:

Dica

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

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

  • Pesquisar: Insira 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 pressionamento de tecla.

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

  • Selecionar tudo 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 só vez.

  • Selecionar Campos: Marque as caixas de seleção dos campos que deseja incluir na consultar 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: 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.

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

  • Pesquisa de Texto Completo: Insira os termos de pesquisa para consultar objetos na classe de objeto selecionada. O endpoint do Microsoft SharePoint 365 controla como a pesquisa é interpretada para uma classe de objeto.

  • Ignorar: Insira um número de resultados a serem ignorados na resposta da consultar.

  • Superior: Insira um número máximo de resultados a serem recebidos na resposta da consultar.

  • 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 menu suspenso para selecionar a classe de objeto a ser usada para o condicional.

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

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

      Comparação
      É igual a
      Maior que
      Maior ou igual a
      Menor que
      Menor ou igual a

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

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

    • Adicionar: Clique para adicionar uma nova condicional à tabela e Filtrar sequência de caracteres.

    • Remover tudo: Clique para remover todos os condicionais da tabela e Filtrar sequência de caracteres.

  • Sequência de caracteres de filtro: Conforme você preenche os outros campos na aba Básico, a instrução da sequência de caracteres de filtro nesta caixa de texto é preenchida automaticamente com os campos, condições e opções de consultar selecionados.

• Consulta de Teste: Clique para validar a consultar. Se a consultar for válida, uma amostra de até 10 registros recuperados da consultar será exibida em uma tabela. Se a consultar não for válida, as mensagens de erro relevantes serão exibidas.

  Nota

  Devido a uma limitação no Protocolo OData v4, uma consultar 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 prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Avançado

Se a aba Avançado for selecionada, esta interface será apresentada:

Dica

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

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

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

• Consulta de Teste: Clique para validar a consultar. Se a consultar for válida, uma amostra de até 10 registros recuperados da consultar será exibida em uma tabela. Se a consultar não for válida, mensagens de erro relevantes serão exibidas. Se você editar a sequência de caracteres do filtro no modo Avançado, a consultar deverá ser válida e validada por meio deste botão para habilitar o botão Avançar.

  Nota

  Devido a uma limitação no Protocolo OData v4, uma consultar 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 prosseguir para a próxima. 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Etapa 4: Revise 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 do Microsoft SharePoint 365 usa 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 usa JSON em seu esquema de resposta.

• Atualizar: Clique no ícone de atualização ou a palavra Atualizar para regenerar esquemas do endpoint do Microsoft SharePoint 365. Essa 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 em í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, 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 consulta à documentação disponível para o endpoint. Após fazer edições no esquema, a data da última edição é exibida na parte superior do esquema aplicável para indicar que o esquema passou por 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicitará que você confirme se deseja descartar as alterações.

Próximos passos

Após configurar uma atividade de Consulta 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 configurações da operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte menu de ações da atividade em Noções básicas do conector.

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

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

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

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