Blog del CIIN

SharePoint 2010: Cómo seguir los cambios producidos en un sitio (I)!

Esta es la cuestión que recientemente se nos ha planteado en el CIIN a la hora de poder integrar SharePoint como fuente de información en otro sistema de manera qué este pudiese conocer, a partir de una consulta inicial, qué cambios se habían producido en el sitio en cuanto a nuevas listas creadas, nuevos elementos de sitio creados, etc. En este primer post introduciré algunas de las posibilidades que tenemos disponibles al respecto:

Enfoque PULL

O lo que es lo mismo, es la aplicación de forma proactiva la que va a consultar la información que ha cambiado en los sitios de SharePoint que se estén siguiendo. Las posibilidades que tenemos para conocer estos cambios son las siguientes:

• Modelo de objetos en cliente (sólo para SharePoint 2010) para obtener la colección de cambios que se hayan producido usando para ello el método GetChanges() qué está disponible en los siguientes objetos:
  • Site (Colección de sitios): http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.site.getchanges
  • Web (Sitio de SharePoint): http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.web.getchanges
  • List (lista / biblioteca de documentos): http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list.getchanges
• Servicios web (SharePoint 2007 y SharePoint 2010), y en concreto los servicios web lists.asmx y SiteData.asmx, que disponen de varios métodos para conocer esta colección de cambios:
  • SiteData.asmx:
    • SharePoint 2007:
      • GetChanges: http://msdn.microsoft.com/en-us/library/ms774827(v=office.12). Para conocer los cambios producidos a nivel de colección de sitios entre dos instantes de tiempo.
    • SharePoint 2010:
      • GetChanges: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getchanges
  • Servicio web lists.asmx
    • SharePoint 2007:
      • GetListItemChanges(): http://msdn.microsoft.com/en-us/library/lists.lists.getlistitemchanges(v=office.12).aspx, que nos permite conocer los cambios a partir de una cierta fecha.
      • GetListItemChangesSinceToken(): http://msdn.microsoft.com/en-us/library/lists.lists.getlistitemchangessincetoken(v=office.12). Lo interesante de este método es que nos permite conocer los cambios a partir de una marca o token que fijemos y que nos facilitará ir conociendo cambios posteriores.
    • SharePoint 2010:
      • GetListItemChanges(): http://msdn.microsoft.com/en-us/library/websvclists.lists.getlistitemchanges
      • GetListItemChangesSinceToken():http://msdn.microsoft.com/en-us/library/websvclists.lists.getlistitemchangessincetoken
      • Lists.GetListItemChangesWithKnowledge(): http://msdn.microsoft.com/en-us/library/websvclists.lists.getlistitemchangeswithknowledge, nuevo en SharePoint 2010 que nos permite ampliar los criterios a aplicar para buscar cambios.
• Modelo de objetos  en servidor (SharePoint 2007 y SharePoint 2010) que de forma análoga al modelo de objetos en cliente permite conocer la colección de cambios a través del método GetChanges() con varias sobrecargas en este caso:
  • SharePoint 2007:
    • SPSite:
      • GetChanges(): http://msdn.microsoft.com/es-es/library/ms478440(v=office.12), qué devuelve una colección con los cambios producidos en una colección de sitios.
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/es-es/library/ms459332(v=office.12), que devuelve una colección con los cambios producidos para una cierta colección de sitios a partir de una consulta especificada por un objeto SPChangeQuery (http://msdn.microsoft.com/es-es/library/microsoft.sharepoint.spchangequery(v=office.12)). La consulta se realiza contra el log de cambios como en los casos anteriores, pero parametrizada en este caso.
      • GetChanges(SPChangeToken):http://msdn.microsoft.com/es-es/library/ms464475(v=office.12), qué devuelve una colección de cambios a partir de una marca en el log de cambios dada por SPChangeToken: http://msdn.microsoft.com/es-es/library/microsoft.sharepoint.spchangetoken(v=office.12).
      • GetChanges(SPChangeToken,SPChangeToken): http://msdn.microsoft.com/es-es/library/ms410759(v=office.12), qué devuelve una colección de cambios entre dos marcas en el log de cambios especificadas por SPChangeToken.
    • SPWeb:
      • GetChanges(): http://msdn.microsoft.com/es-es/library/ms458398(v=office.12).
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/es-es/library/ms439079(v=office.12)
      • GetChanges(SPChangeToken): http://msdn.microsoft.com/es-es/library/ms461643(v=office.12)
      • GetChanges(SPChangeToken, SPChangeToken): http://msdn.microsoft.com/es-es/library/ms465409(v=office.12)
    • SPList:
      • GetChanges(): http://msdn.microsoft.com/es-es/library/ms469550(v=office.12).
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/es-es/library/ms439213(v=office.12).
      • GetChanges(SPChangeToken):http://msdn.microsoft.com/es-es/library/ms429636(v=office.12).
      • GetChanges(SPChangeToken,SPChangeToken): http://msdn.microsoft.com/es-es/library/ms443090(v=office.12).
  • SharePoint 2010:
    • SPSite:
      • GetChanges(): http://msdn.microsoft.com/en-us/library/ms478440.
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/en-us/library/ms459332.
      • GetChanges(SPChangeToken):http://msdn.microsoft.com/en-us/library/ms464475.
      • GetChanges(SPChangeToken,SPChangeToken): http://msdn.microsoft.com/en-us/library/ms410759.
    • SPWeb:
      • GetChanges(): http://msdn.microsoft.com/en-us/library/ms458398.
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/en-us/library/ms439079.
      • GetChanges(SPChangeToken): http://msdn.microsoft.com/en-us/library/ms461643.
      • GetChanges(SPChangeToken, SPChangeToken): http://msdn.microsoft.com/en-us/library/ms465409.
    • SPList:
      • GetChanges(): http://msdn.microsoft.com/en-us/library/ms469550.
      • GetChanges(SPChangeQuery): http://msdn.microsoft.com/en-us/library/ms439213.
      • GetChanges(SPChangeToken): http://msdn.microsoft.com/en-us/library/ms429636.
      • GetChanges(SPChangeToken,SPChangeToken): http://msdn.microsoft.com/en-us/library/ms443090.

Aparte de estas opciones, y sobre la misma base, tenemos otras alternativas como:

• Las auditorías de SharePoint que nos permiten monitorizar lo que está sucediendo sobre elementos de lista, listas, sitios, etc. Lo interesante de las auditorias es qué se pueden atacar de forma programática como se ve en este post en lo que a la activación de las mismas se refiere (es con PowerShell, pero la idea es la misma). En el caso de auditorías, contamos con clases interesantes en el modelo de objetos como:
  • SPAudit: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spaudit.aspx
  • SPAuditEntry: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spauditentry
  • SPAuditQuery: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spauditquery

• Otras referencias:
  • Configuración de las auditorías:
    • http://office.microsoft.com/en-us/sharepoint-server-help/configure-audit-settings-for-a-site-collection-HA102031737.aspx
    • http://office.microsoft.com/en-us/sharepoint-server-help/view-audit-log-reports-HA102039795.aspx
    • http://www.c-sharpcorner.com/uploadfile/bhushangawale/sharepoint-auditing-behind-screen-and-remedy/
  • Trabajo programático con auditorías:
    • http://mysharepointwork.blogspot.com.es/2010/09/programmatically-access-audit-for.html
    • http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spauditquery.aspx
• Ataque directo en los siguientes niveles:
  • El log de cambios (Change Log) de SharePoint: http://msdn.microsoft.com/en-us/library/bb447511.aspx.
  • Las tablas a nivel de BD de contenidos (lo veremos en otro post) en las que se almacena la información relativa a esos cambios.
  • Los logs de SQL.
• Otras posibilidades:
  • Mediante feeds RSS.
  • Combinando las búsquedas con el framework de alertas: http://msdn.microsoft.com/en-us/library/hh161512.aspx 

Un tema importante a tener en cuenta en el enfoque PULL y la consulta de los cambios producidos es que SharePoint mantiene el Log de cambios durante 60 días, si bien este parámetro es configurable.

Enfoque PUSH

O lo que es lo mismo, en el lado de SharePoint tenemos algo que está “escuchando” y qué reacciona a los cambios que se produzcan en los distintos niveles que hemos comentado (colección de sitios, sitio, lista). En este caso las posibilidades son:

• El uso del framework de alertas de SharePoint, de manera que podeos implementar una clase que herede IAlertNotifyHandler de manera que ante cambios a estos niveles podemos engancharnos y hacer lo que necesitemos, incluso evitando el envío de un correo electrónico. Referencias en esta línea:
  • Creación programática de alertas:
    • http://www.sharepointology.com/development/how-to-create-alerts-programmatically/
    • http://www.mindfiresolutions.com/Create-SharePoint-Alerts-for-Document-library-or-List-programmatically-958.php
    • http://akanoongo.blogspot.com.es/2010/03/create-sharepoint-alerts.html
    • http://www.sharemuch.com/2009/07/23/use-alert-framework-when-sending-notifications-in-your-sharepoint-custom-app/
    • http://sharepointlive.blogspot.com.es/2008/10/how-to-create-sharepoint-alerts-for.html
  • Clase SPAlert: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spalert.aspx 
  • Referencia en MSDN sobre alertas: http://msdn.microsoft.com/en-us/library/bb897925
• Mediante el uso de manejadores de eventos que reaccionen a todo tipo de cambios.

Y hasta aquí llega este primer post sobre seguimiento de cambios en SharePoint.

Published 5/7/2012 18:49 por Juan Carlos González Martín