Provedor de ID do Documento no modelo de Suplemento do SharePoint

A abordagem adotada para definir identificadores exclusivos para documentos no SharePoint é diferente no novo modelo de suplemento do SharePoint do que era com o Código de Confiança Total. Em um cenário típico de FTC (Código de Confiança Total) / Solução de Farm, manipuladores de eventos de item de lista que executam o código do Modelo de Objeto do lado do servidor do SharePoint foram usados para definir identificadores exclusivos para documentos e foram implantados por meio de Soluções do SharePoint.

Em um cenário de modelo de suplemento do SharePoint, o CSOM (Modelo de Objeto do Lado do Cliente) do SharePoint e/ou a API REST do SharePoint são usados para definir identificadores exclusivos para documentos.

Diretrizes de alto nível

Como regra geral, gostaríamos de fornecer as seguintes diretrizes de alto nível para definir identificadores exclusivos para documentos no novo modelo de suplemento do SharePoint.

• Use o CSOM (Modelo de Objeto do Lado do Cliente) do SharePoint e/ou as APIs REST do SharePoint para definir identificadores exclusivos para documentos.
• Atualmente, não há nenhum mecanismo pronto para uso com suporte para associar código processado remoto para substituir o provedor de ID de documento pronto para uso, portanto, esse recurso não tem suporte nativo para ser modificado com APIs remotas.
• No entanto, como em muitos casos com o modelo Add-in, rotas alternativas estão sendo exploradas.

Como os identificadores exclusivos são definidos nos documentos?

Essencialmente, definir um identificador exclusivo para um documento significa definir o valor de uma coluna em uma lista/biblioteca de documentos do SharePoint.

As APIs do SharePoint (CSOM) e/ou REST podem ser usadas para definir valores de coluna e, portanto, podem ser usadas para definir identificadores exclusivos para documentos. Consulte os artigos a seguir para saber mais sobre essas APIs e como definir valores de coluna com elas.

• Concluir operações básicas usando o código da biblioteca de clientes do SharePoint 2013 (artigo do MSDN)
• Trabalhar com listas e itens de lista com REST (Artigo do MSDN)

Opções para definir identificadores exclusivos para documentos

Você tem algumas opções para definir identificadores exclusivos para documentos armazenados no SharePoint.

• Usar receptores de eventos remotos
• Use um processo em segundo plano

Usar receptores de eventos remotos

Nesse padrão, os receptores de eventos remotos são acionados quando novos documentos são carregados nas bibliotecas do SharePoint. Os receptores de eventos remotos fazem chamadas à API CSOM ou REST para definir identificadores exclusivos para documentos.

• Esse padrão é executado imediatamente após um documento ser carregado no SharePoint.
  • Desde que o código no serviço associado ao receptor de eventos remoto seja executado em tempo hábil, as IDs de documento são definidas rapidamente após um novo documento ser carregado no SharePoint.
• Esse padrão opera apenas em novos documentos carregados no SharePoint, ele não define identificadores exclusivos para documentos já armazenados no SharePoint.
• As operações de carregamento em massa dispararão várias chamadas para o serviço associado ao receptor de eventos remoto. Planeje adequadamente para garantir que as operações de carregamento em massa não sobrecarreguem o serviço.
• Não há como um receptor de eventos remoto notificar o SharePoint se a configuração de uma ID de documento exclusiva falhar.

Quando isso é apropriado?

Quando você precisa definir identificadores exclusivos para documentos rapidamente após serem carregados no SharePoint e não espera operações de carregamento em massa.

Introdução

Os receptores de eventos e listar receptores de eventos (receita de suplemento do SharePoint) descrevem como implementar receptores de eventos no modelo de suplemento e fornecem links para vários exemplos e artigos.

Use um processo em segundo plano

Nesse padrão, um processo em segundo plano verifica documentos no SharePoint para determinar se eles têm um conjunto de identificadores exclusivos. Se nenhum identificador exclusivo for encontrado para um documento, o processo em segundo plano definirá um identificador exclusivo para o documento. O processo em segundo plano faz chamadas à API CSOM ou REST para definir identificadores exclusivos para documentos.

• Esse padrão é executado de acordo com a programação definida para ele.
• Esse padrão opera em todos os documentos para os quais o código é gravado rastreio.
• Sugerimos usar o serviço de pesquisa do SharePoint para executar consultas que incluem filtros para retornar uma lista de documentos que não têm identificadores exclusivos definidos neles.
  • Esse padrão executa o mais rápido e é dimensionado melhor do que qualquer outro padrão de consulta.
  • Esse padrão elimina a lógica de consulta personalizada do serviço em segundo plano.
  • Esse padrão requer alguma configuração de pesquisa.
  • Para saber mais sobre a configuração de pesquisa, consulte a Configuração de Pesquisa (Receita de Suplemento do SharePoint).
• Não é recomendável consultar e retornar recursivamente metadados sobre todos os documentos em um ambiente do SharePoint por loop por meio de objetos da Web e de lista.
  • Esse padrão é executado mais lentamente e escala pior do que qualquer outro padrão de consulta.
  • Você pode encontrar limites de limitação de API ao usar esse padrão.
  • Esse padrão inclui lógica de consulta personalizada no serviço em segundo plano.
  • Esse padrão pode ser implementado com um Trabalho Web do Azure.

Quando isso é apropriado?

• Quando você precisa definir identificadores exclusivos para documentos e receptores de eventos remotos não são uma opção disponível para você.
• Quando você espera ter documentos carregados em massa.
• Quando você precisar garantir que IDs de documento exclusivas sejam definidas nos documentos.
  • Não há como um receptor de eventos notificar o SharePoint se a configuração de uma ID de documento exclusiva falhar.
• Quando você precisar processar documentos já armazenados no SharePoint.

Guia de Introdução

Os trabalhos de temporizador remoto (receita de suplemento do SharePoint) descrevem como implementar trabalhos de temporizador remoto no modelo de suplemento e fornecem links para vários exemplos e artigos.

Links relacionados

• Receptores de evento e listar receptores de evento (receita de suplemento do SharePoint)
• Configuração de pesquisa (receita de suplemento do SharePoint)
• Trabalhos de timer remoto (receita de suplemento do SharePoint)
• Artigos de orientação em https://aka.ms/OfficeDevPnPGuidance
• Referências no MSDN em https://aka.ms/OfficeDevPnPMSDN
• Vídeos em https://aka.ms/OfficeDevPnPVideos

Exemplos de PnP

• OD4B. NavLinksInjection (Amostra de PnP do O365)
• Exemplos e conteúdo no Microsoft 365 Padrões e Práticas (PnP)

Aplicável a

• Office 365 Multilocatário (MT)
• Office 365 dedicado (D)
• SharePoint 2013 local