[Product Review]: SharePoint Documentation Toolkit for SharePoint!

Siguiendo con mis artículo sobre productos en torno a SharePoint que he tenido la oportunidad de evaluar últimamente, en esta ocasión os dejo la review del Documentation Toolkit for SharePoint de Acceleratio.

Resumen

A la hora de documentar una granja de SharePoint podemos optar por distintas posibilidades: productos de terceros (ya sean de pago o gratuitos), crearnos nuestra propia herramienta de documentación haciendo uso de la API de SharePoint o bien crearnos unos scripts PowerShell que nos permitan realizar esta tarea. En este artículo voy a abordar la primera de las posibilidades a través de la evaluación del Documentation Toolkit for SharePoint de Acceleratio. Como podéis ver en la página del producto, este Toolkit permite documentar una granja de SharePoint (versiones 2007, 2010 y 2013) en unos pocos clics, explorar rápidamente las distintos parámetros de configuración de la granja, comparar dos granjas para ver las diferencias entre las mismas o monitorizar la salud de la granja. Toda esta funcionalidad es proporcionada por una interfaz de usuario intuitiva y atractiva que persigue facilitar la labor de todos aquellos roles especializados que tienen que trabajar con la granja.

 

 

image

Instalación y configuración del Documentation Toolkit for SharePoint

Antes de proceder a realizar la instalación de esta herramienta, tenemos que revisar que cumplimos los requerimientos mínimos que se requieren para poder realizar su instalación. Estos pasan por tener instalado SharePoint 2007, 2010 o 2013 en el servidor dónde vamos a instalar el Toolkit (Nota: Se puede instalar sobre la versión de servidor de SharePoint o la versión core de la plataforma). En mi caso, voy a instalar el Documentation Toolkit en una máquina en la que tengo instalado SharePoint Server 2013 Enterprise:

  • El proceso de instalación es tan directo, que no merece la pena que me entretenga mucho en él ya que además está perfectamente documentado en el siguiente enlace: http://www.spdockit.com/products/documentation-toolkit-for-sharepoint/
  • Quizás lo más interesante del proceso de instalación en sí es que dispone de dos modos:

    • “Install”, que instala el Toolkit en el servidor de SharePoint.
    • “Run”, que no instala el Toolkit, sino que directamente ejecuta la herramienta. Sin embargo, esta opción no dispone de todas las posibilidades que brinda el Toolkit.
image image

Finalizado el proceso de instalación del Toolkit, se inicia un proceso de configuración vía asistente que entre otras cosas:

  • Crea una BD necesaria para guardar la información que utiliza la herramienta para las distintas funcionalidades disponibles.
  • Permite definir las opciones de carga de los datos (configuraciones de la granja, información de permisos, eventos) que incluyen la periodicidad de carga de los mismos. Fijaros que se establece por defecto una periodicidad de días, por lo que recomiendo dejar estos valores por defecto para no cargar el servidor donde se ejecuta el Toolkit.
image image

Una vez instalado y configurado el Toolkit, vamos a evaluar las siguientes funcionalidades disponibles en la misma y que podéis encontrar en la sección “Features” de la página de producto (http://www.spdockit.com/features/):

Crear documentación de la granja

Esta característica del Toolkit permite documentar parámetros de configuración de la granja a distintos niveles generando un informe Word con toda la información recopilada. Para hacer uso de esta funcionalidad, basta con hacer clic en el botón “Load Farm Settings” e ir siguiendo el correspondiente asistente en el que:

  • Indicaremos en primer lugar el tipo de información a recopilar (Sitios personales, Features, Configuraciones en el Web.Config, configuración de SQL Server, etc).
  • A continuación indicaremos la información relativa a permisos que queremos cargar.

Una vez concluidas estas configuraciones dejamos que el Toolkit empiece a recopilar toda la información necesaria de la granja:

image image

Cuando el Toolkit ha acabado de recoger toda la información, se muestra una vista de explorador con distintos niveles de información que podemos ir visualizando. Por ejemplo, me han parecido destacables los siguientes niveles de información:

  • Topología de la granja.
  • Topología de sitios, que muestra para cada aplicación web las colecciones de sitios disponibles de forma que rápidamente podemos hacer un inventariado de los mismos.
  • La topología de búsquedas.
  • Servicios en el servidor.

Fijaros como además tenemos distintos tipos de exploradores disponibles:

  • El explorador de la granja (con la información comentada).
  • El explorador de sitios, que nos permite bucear en cada colección de sitios y obtener información como las características disponibles, las soluciones desplegadas, etc.
image image
  • El explorador de permisos que luego veremos.

Finalmente, toda esta información se puede exportar en un documento Word o PDF. Por supuesto, podemos elegir si queremos exportar toda la info. o solo parte. Como muestra del informe generado, a continuación podéis ver la sección Farm Overview:

image

Explorador e informes de permisos

El explorador de permisos nos permite de forma jerárquica ir viendo la configuración de seguridad en cuanto a “Principals” (Usuarios o grupos de SharePoint / Directorio Activo) y el nivel de permisos asignados. De esta forma, podremos ir viendo esta información a nivel de:

  • Aplicación Web.
  • Colección de Sitios.
image image
  • Sitio.
  • Lista.
  • Biblioteca.
  • Elemento de lista / Documento.

Para cada nivel disponible en el explorador de permisos, podemos aplicar parámetros de filtrado usando la ventana Filters. Del mismo modo, para cada usuario / grupo mostrado en cada nivel de exploración podremos ver detalles del mismo y los detalles de permisos haciendo clic en las opciones correspondientes de la Ribbon del Toolkit o bien en los enlaces mostrados en cada nivel mostrado por el explorador de permiso. Por supuesto, no me puedo olvidar de la pestaña Permissions que permite realizar comparativas de configuraciones de permisos entre el nivel actual y el nivel previo, o bien con el contenedor padre en la jerarquía o incluso comparar la configuración de permisos entre colecciones de sitios y sitios de distintas aplicaciones web (la comparación siempre es entre contenedores del mismo nivel). Finalmente, en la sección Reports del Toolkit, podréis encontrar informes relativos a permisos que os permiten ver de forma detallada los permisos a nivel de sitios, listas y elementos de lista. También tendréis disponibles informes variados como los permisos únicos que hay en un sitio, los permisos para un usuario / grupo concreto, etc. Y por supuesto, todos estos informes se pueden exportar a Excel, PF, se pueden personalizar para añadir o quitar columnas, etc.

image image

Explorador de configuración

La funcionalidad de Explorador de configuración está disponible a través del Farm Explorer ya que proporciona informaciones como:

  • Contraseñas y claves.
  • Lista de productos instalados en cada servidor de la granja.

Y a través de la sección de Scheduled Tasks donde podemos ver las tareas programadas en el servidor: programación de rastreos completos, incrementales, importación de perfiles de usuario, compilación de audiencias, etc.

image

Comparación de aplicaciones web

Esta funcionalidad forma parte de la funcionalidad más general del Toolkit que permite comparar granjas completas en una organización ya sea porque queremos identificar diferencias entre las mismas o porque en una de nuestras granjas hay un problema que no aparece en las otras. La funcionalidad de comparación de granjas se basa en crear “snapshots” de configuración de cada granja que luego son utilizados para realizar la comparativa por lo que no es necesario estar conectados a ambas granjas.

La comparación de aplicaciones web puede realizarse entre aplicaciones web de la misma granja o de granjas diferentes. A modo de ejemplo, vamos a ver como se realiza el proceso de comparación de dos aplicaciones web en el Toolkit:

  • En primer lugar, nos vamos a la pantalla de inicio de la herramienta para iniciar el “Compare wizard”. La primera pantalla de este asistente nos permite elegir el nivel de comparación que queremos: Granjas, Aplicaciones Web o Permisos. En nuestro caso, elegiremos Aplicaciones Web.
  • A continuación elegimos las dos Aplicaciones Web a comparar:
image image
  • Cuando concluye el proceso de generación de los snapshots, el toolkit muestra un informe en el que se detalla la comparación entre ambas aplicaciones web indicando aquellas configuraciones las que difieren:

image

Monitorización de la salud de la granja

Para finalizar con la review del Documentation Toolkit for SharePoint, voy a analizar las características de monitorización de salud de la granja de que dispone:

  • All Events, que muestra en una misma vista información procedente de los Logs de SharePoint o de los eventos de Windows y para todos los servidores de la granja. Para cada mensaje que se muestra, podemos ver los detalles del mismo.
  • Event Log, muestra la información relativa a los eventos de Windows.
  • Finalmente, la sección ULS muestra la información procedente de los Logs de SharePoint de una forma similar a como lo hace el clásico ULS Viewer.
image image

Por supuesto, de nuevo contamos con capacidades como:

  • Definir filtros sobre los datos mostrados (Por ejemplo, el nivel del mensaje o la fuente del mismo).
  • Exportación de los datos a Excel / PDF.

Conclusiones

El hacer una review tan extensa de un producto para SharePoint se ha debido a que me ha parecido un producto muy completo y con unas prestaciones sorprendentes y quizás no esperadas si te dejas llevar por el nombre del mismo: Documentation Toolkit for SharePoint. Este Toolkit va más allá de permitir documentar una granja de SharePoint ya que permite explorar en todos sus niveles una granja, extraer informes en cada nivel relativos a aplicaciones web, colecciones de sitios, sitios, etc, además de permitir monitorizar la granja y encontrar rápidamente problemas a resolver. La funcionalidad de comparación de granjas, aplicaciones web y permisos me parece excelente para asegurarnos que todas nuestras granjas cuentan con la misma configuración o bien detectar rápidamente porque en una granja tenemos problemas y no en otras. Finalmente, y aunque fuera del análisis actual, no me puedo olivar de la sección de “Best practices”…espectacular, ya que identifica malas prácticas que se hayan cometido en la granja analizada en cuanto a configuración de la misma.

Referencias