Compartir a través de

Proveedor de id. de documento en el modelo de complemento de SharePoint

El enfoque que se usa para establecer identificadores únicos para documentos en SharePoint es diferente en el nuevo modelo de complemento de SharePoint que con código de plena confianza. En un escenario típico de solución de granja de servidores o código de plena confianza (FTC), se usaron controladores de eventos de elemento de lista que ejecutan código de modelo de objetos del lado servidor de SharePoint para establecer identificadores únicos para documentos y se implementaron a través de soluciones de SharePoint.

En un escenario de modelo de complemento de SharePoint, el modelo de objetos del lado cliente de SharePoint (CSOM) o la API REST de SharePoint se usan para establecer identificadores únicos para documentos.

Directrices importantes

Como regla general, nos gustaría proporcionar las siguientes directrices de alto nivel para establecer identificadores únicos para documentos en el nuevo modelo de complemento de SharePoint.

  • Use el modelo de objetos del lado cliente de SharePoint (CSOM) o las API REST de SharePoint para establecer identificadores únicos para los documentos.
  • Actualmente, no hay ningún mecanismo integrado compatible para asociar código procesado remoto para reemplazar el proveedor de identificadores de documento de fábrica, por lo que esta funcionalidad no se admite de forma nativa para modificarse con API remotas.
  • Sin embargo, como en muchos casos con el modelo de complemento, se están explorando rutas alternativas.

¿Cómo se establecen los identificadores únicos en los documentos?

Básicamente, establecer un identificador único para un documento significa establecer el valor de una columna en una biblioteca de documentos o lista de SharePoint.

Las API de REST y SharePoint (CSOM) se pueden usar para establecer valores de columna y, por lo tanto, se pueden usar para establecer identificadores únicos para documentos. Consulte los artículos siguientes para obtener más información sobre estas API y cómo establecer valores de columna con ellas.

Opciones para establecer identificadores únicos para documentos

Tiene algunas opciones para establecer identificadores únicos para los documentos almacenados en SharePoint.

  • Uso de receptores de eventos remotos
  • Uso de un proceso en segundo plano

Uso de receptores de eventos remotos

En este patrón, los receptores de eventos remotos se activan cuando se cargan nuevos documentos en las bibliotecas de SharePoint. Los receptores de eventos remotos realizan llamadas ASOM o API REST para establecer identificadores únicos para documentos.

  • Este patrón se ejecuta inmediatamente después de cargar un documento en SharePoint.
    • Siempre que el código del servicio asociado al receptor de eventos remotos se ejecute a tiempo, los identificadores de documento se establecen rápidamente después de cargar un nuevo documento en SharePoint.
  • Este patrón solo funciona en nuevos documentos cargados en SharePoint, no establece identificadores únicos para los documentos que ya están almacenados en SharePoint.
  • Las operaciones de carga masiva desencadenarán varias llamadas al servicio asociado al receptor de eventos remotos. Planee en consecuencia para asegurarse de que las operaciones de carga masiva no sobrecargarán el servicio.
  • No hay manera de que un receptor de eventos remoto notifique a SharePoint si se produjo un error al establecer un identificador de documento único.

¿Cuándo es una buena opción?

Cuando necesite establecer identificadores únicos para los documentos rápidamente después de cargarlos en SharePoint y no espere operaciones de carga masiva.

Introducción

Receptores de eventos y receptores de eventos de lista (receta de complemento de SharePoint) describe cómo implementar receptores de eventos en el modelo de complemento y proporciona vínculos a varios ejemplos y artículos.

Uso de un proceso en segundo plano

En este patrón, un proceso en segundo plano comprueba los documentos de SharePoint para determinar si tienen un identificador único establecido. Si no se encuentra ningún identificador único para un documento, el proceso en segundo plano establece un identificador único para el documento. El proceso en segundo plano realiza llamadas CSOM o API REST para establecer identificadores únicos para documentos.

  • Este patrón se ejecuta según la programación que defina para él.
  • Este patrón funciona en todos los documentos en los que se escribe el código para rastrear.
  • Se recomienda usar el servicio de búsqueda de SharePoint para ejecutar consultas que incluyan filtros para devolver una lista de documentos que no tienen identificadores únicos establecidos en ellos.
    • Este patrón realiza el más rápido y se escala mejor que cualquier otro patrón de consulta.
    • Este patrón elimina la lógica de consulta personalizada del servicio en segundo plano.
    • Este patrón requiere cierta configuración de búsqueda.
    • Para obtener más información sobre la configuración de búsqueda, vea La configuración de búsqueda (receta de complemento de SharePoint).
  • No se recomienda consultar y devolver metadatos de forma recursiva sobre todos los documentos de un entorno de SharePoint mediante bucles a través de objetos web y de lista.
    • Este patrón realiza el más lento y se escala peor que cualquier otro patrón de consulta.
    • Puede encontrar límites de limitación de API al usar este patrón.
    • Este patrón incluye lógica de consulta personalizada en el servicio en segundo plano.
    • Este patrón se puede implementar con un trabajo web de Azure.

¿Cuándo es una buena opción?

  • Cuando necesite establecer identificadores únicos para documentos y receptores de eventos remotos no es una opción disponible para usted.
  • Cuando se espera que los documentos se carguen de forma masiva.
  • Cuando necesite asegurarse de que los identificadores de documento únicos se establecen en los documentos.
    • No hay ninguna manera de que un receptor de eventos notifique a SharePoint si se produjo un error al establecer un identificador de documento único.
  • Cuando necesite procesar documentos ya almacenados en SharePoint.

Introducción

Los trabajos del temporizador remoto (receta de complemento de SharePoint) describe cómo implementar trabajos de temporizador remoto en el modelo de complemento y proporciona vínculos a varios ejemplos y artículos.

Ejemplos de PnP

Se aplica a

  • Office 365 multiempresa (MT)
  • Office 365 dedicado (D)
  • SharePoint 2013 local
  • Last updated on