Evaluierung SPDocKit

Bei vielen SharePoint On Premise Farmen sind die unterschiedlichen Staging-Umgebungen mit der Zeit nicht mehr identisch. Im ungünstigsten Fall kann es dann passieren, dass eine neue Lösung in der Entwicklungs- und Testumgebung läuft, aber in der Produktionsumgebung nicht.

Um hier nicht nur mit organisatorischen Maßnahmen vorzubeugen, sondern auch konkrete Unterschiede zwischen den Umgebungen herauszufinden, wurde für einen Kunden SPDocKit evaluiert. Das Tool wurde ursprünglich dafür entwickelt, eine SharePoint-Farm zu dokumentieren, es können aber auch Farmen verglichen werden.

Installation und allgemeines Handling

SPDocKit verbindet sich über die API, d.h. es muss auf einem WebFrontend installiert werden. Für viele Funktionalitäten wird außerdem eine eigene Datenbank benötigt.

Sämtliche Installationen, Konfigurationen sowie das Einlesen von Daten liefen bei allen Tests performant und stabil.

Das Tool ist intuitiv zu bedienen, jedoch müssen manchmal Inhalte von der Farm nachgeladen werden. Hierbei ist nicht ganz ersichtlich, wann bzw. warum das notwendig ist oder wie es verhindert werden kann.

Jeder Ladevorgang dauert ein paar Minuten, da viele Informationen aus der Farm gelesen werden.

Scheduling

Viele der im Folgenden aufgeführten Reports können nach einem Zeitplan ausgeführt werden. Die Resultate können entweder per E-Mail verschickt werden oder die Datei wird im Filesystem oder gleich im SharePoint abgelegt.

Farm Explorer

Der Farm Explorer zeigt Einstellungen und Werte der SharePoint-Farm, den zugehörigen Servern IIS, SQL etc. an.

Beispiele:

  • Es kann eine Liste aller Content-Datenbanken der Farm angezeigt werden

  • Anzeige einer Liste von Farm Features mit ihren Eigenschaften mit u.a. Feature IDs und Aktivierungsstatus

  • Backup-Einstellungen



 

Site Explorer

Hier werden ähnlich dem Farm Explorer Informationen über WebApps mit ihren Site Collections und Subsites angezeigt.

Beispiel-Informationen:

  • Web Application Features,

  • People Picker Einstellungen

  • Web Config Files (Report geht nur ab IE 9)

  • Site Collection Features

  • Sandbox Solutions

  • Content Types Hierarchy

  • Content Type Usage

  • Features

  • Workflow Templates

  • Workflow Associations

 
 

Permissions Explorer

Zeigt Berechtigungen auf allen Ebenen an, also auf Web Applications, Site Collections, Sites, Lists und List Items.

Permissions Reports

Stellt verschiedene Reports zum Thema Berechtigungen zur Verfügung. So können z.B. alle Gruppen aufgelistet und ihre Mitglieder angezeigt werden.

Außerdem kann die Anzahl der Benutzer pro Site dargestellt werden:


Content and Usage Reports

Stellt verschiedene Reports über Inhalte und Features zur Verfügung.

Z.B. kann für jedes Feature (im Beispiel "Document Sets") angezeigt werden, wo es aktiviert ist.


Best Practices

Im Dashboard gibt es eine schöne Übersicht über die Einhaltung von Best Practices.



Einzelne Best Practices können mit Hilfe eines Wizards auch selbst definiert werden


Hierbei können zwar umfangreiche Daten gefiltert und mit Regeln und Formatierung versehen werden, jedoch nicht alle vordefinierten Best Practices nachgestellt oder bearbeitet werden.

Die Ergebnisse der Best Practices können als Word-Datei gespeichert, jedoch nicht über das Scheduling automatisiert werden.

Queries & Rules

Queries sind Abfragen, die selbst definiert werden können. Als Beispiel gibt es einen Query, der Dateien findet, die ausgecheckt sind. Die Ergebnisse werden als Tabellen dargestellt und über die URL kann direkt die betroffene Datei angezeigt werden.


Rules sind Regeln, die auf bestimmte Ebenen angewandt werden können. Als Beispiel ist die Rule mitgeliefert, mit der für jede Bibliothek unter der gewählten Ebene (auch z.B. auf Farm-Ebenen) die Einstellung setzt, dass die Versionierung eingeschaltet wird.

Dieses Feature ist sehr gefährlich, da hier die Einstellungen im SharePoint tatsächlich verändert werden, ohne dass sich die Handhabung grundsätzlich von den reinen Anzeigemöglichkeiten unterscheidet.

Change History

In der Change History werden Snapshots angezeigt.
Snapshots können manuell oder vom Service angelegt werden. Die Intervalle, in denen der Service Snapshots erstellt, können definiert werden.
Die einzelnen Elemente können verglichen werden, die verfügbaren Werte entsprechen dem Farm Explorer.

Snapshots

Bei einem Snapshot werden die Informationen über die Farm in einer Datei gespeichert. Diese kann dann zu einem späteren Zeitpunkt wieder geöffnet und mit dem neuen Stand verglichen werden. Diese Dateien können auch z.B. auf einem Netzwerklaufwerk abgelegt werden, um sie dann mit einer anderen Farm zu vergleichen.

Es gibt jedoch keine Möglichkeit, sie ohne ein auf einem Webfrontend installiertes SPDocKit zu öffnen.

Vergleiche

Bei Vergleichen können zwei Snapshots miteinander oder ein Snapshot mit dem aktuellen Stand der Farm verglichen werden.

Die Eigenschaften werden in der Oberfläche als aufklappbare Tabelle angezeigt, wobei mit Icons ersichtlich ist, ob es hier Unterschiede gibt. In der Liste darunter werden die einzelnen Werte von Quelle und Ziel des Vergleichs aufgelistet.


Das Ergebnis kann als PDF abgespeichert werden.

Schwierigkeiten beim Farmvergleich

Für den geplanten und idealer Weise automatisierten Vergleich der verschiedenen Staging-Umgebungen ist SPDocKit leider nur eingeschränkt hilfreich. Hierbei gibt es die folgenden Schwierigkeiten:

  • Keine Automatisierung

Vergleiche können nur manuell und nicht per Scheduling durchgeführt werden.

  • Nur einfacher Vergleich möglich

Im Tool wird beim Vergleich nur abgefragt, ob zwei Werte identisch sind oder nicht. Somit werden bei verschiedenen Farmen einige Einstellungen immer als unterschiedlich angezeigt. Diese können nicht vom Vergleich ausgeschlossen werden.

Zu den Einstellungen, die bei unterschiedlichen Farmen meist oder zwangsweise verschieden sind, gehören unter anderem:

  • Server Name
  • Service Accounts
  • URLs
  • Automatisiert erstellte GUIDs
  • Alle Einstellungen, die diese Werte beinhalten, wie
    • Datenbanknamen
    • Installierte Patches (gelistet z.B. mit „Service Pack 2 for Microsoft 2010 Server Language Pack (KB2687462) 64-Bit Edition - 14.0.7015.1000(SERVERNAME)"
  • Reihenfolge der Auflistung

Sind bei Einstellungen die Namen nicht absolut identisch, so werden sie erst für die Quelle und dann für das Ziel aufgelistet. Da es je nach Einstellung sehr lange Listen sind, ist es schwer, die Werte zu finden.

  • Dateiexport

Die Vergleichsinformationen können nur angezeigt oder als PDF exportiert werden. Somit kann keine automatisierte Auswertung stattfinden.

Das PDF aus einem normalen Vergleich zweier Einstellungen enthält nicht die Informationen des UI.


Dies liegt daran, dass hier bereits die Servernamen unterschiedlich sind. Somit werden die Werte nicht gelistet und können im PDF auch nicht manuell verglichen werden.

Fazit

Grundsätzlich ist SPDocKit ein sinnvoller Helfer für Farmadministratoren. Durch die Dokumentation der eigentlichen Farm kann sichergestellt werden, dass der Soll-Zustand, der durch die Installationsdokumentation vorgegeben ist, auch dem Ist-Zustand entspricht.

Auch können durch den Vergleich von automatisiert erstellten Snapshots Änderungen an einem System gut nachvollzogen werden.

Für den Vergleich von zwei verschiedenen Farmen eignet sich das Tool jedoch nur bedingt. Bei einem konkreten Fehlerfall können die Umgebungen recht benutzerfreundlich und performant in den betreffenden Bereichen verglichen werden. Doch da ein Vergleich nicht automatisiert erstellt und ausgewertet werden kann, wird kaum ein Administrator regelmäßig zwei oder mehr Farmen vergleichen.

Comments