© Kellie L. Folkerts/Shutterstock.com
Ereignisempfänger (Teil 2)

Kolumne: SharePoint ganz praktisch


In der letzten Ausgabe der Kolumne wurden die Grundlagen von Ereignisempfängern in SharePoint erläutert. Heute werden erweiterte Techniken und Details behandelt. Weiterhin wird demonstriert, wie Ereignisempfänger für Features realisiert werden.

Ereignisempfänger sind das ideale Mittel, um auf direkte Benutzerinteraktionen einwirken zu können. Die direkte Benutzerinteraktion ist allerdings nur eingeschränkt möglich, da keine eigene Benutzeroberfläche bereitgestellt werden kann. Ereignisempfänger bieten sich aber immer dann an, wenn bestimmte Aktionen, wie das Auslösen einer zusätzlichen Datenverarbeitung, während oder zeitnah nach einer Benutzeraktion ausgelöst werden sollen. Dafür stehen – wie in Teil 1 dargestellt wurde – synchrone und asynchrone Ereignisse bereit. Neben den SharePoint-basierten Ereignisempfängern, die bestimmten SharePoint-Elementen wie Listen oder auch Listeneinträgen zugeordnet sind, existieren auch die so genannten „Featureereignisempfänger“ (engl. Feature Event Receivers). Wie ein solcher Featureereignisempfänger realisiert werden kann, wird im späteren Verlauf erläutert. Zunächst geht es um die Realisierung eines klassischen Farm-basierten Ereignisempfängers, der aus einem Word-Dokument automatisiert ein PDF-Dokument generiert.

Word-zu-PDF-Konvertierung

SharePoint unterstützt mit den Word Automation Services unter anderem die zeitgesteuerte Umwandlung von Word-Dateien in das PDF-Dateiformat. Dieser Dienst steht schon seit SharePoint 2010 zur Verfügung, aber erst mit SharePoint 2013 wurde der Dienst um die Möglichkeit der direkten Konvertierungsausführung erweitert. Unter SharePoint 2010 musste eine Konvertierung zunächst über einen zeitgesteuerten Auftrag (Timer Job) eingeplant werden. Die Konvertierung fand daher erst dann statt, wenn der Auftrag zur Ausführung kam. SharePoint 2013 besitzt eine erweiterte Programmierschnittstelle und ermöglicht die direkte Ausführung einer Konvertierung. Diese zusätzliche Möglichkeit soll nun in dem nachfolgenden Beispiel für einen Ereignisempfänger zum Einsatz kommen. Konkret soll der Ereignisempfänger Folgendes leisten:

  1. Nach einer Word-Datei-Aktualisierung ein PDF erstellen
  2. Das erstellte PDF mit der Word-Datei verknüpfen
  3. Einen Hinweis in den Dokumenteneigenschaften hinterlegen, wann das PDF erstellt wurde
  4. Beim Löschen eines Word-Dokuments auch das PDF entfernen

Bevor mit der eigentlichen Implementierung begonnen werden kann, muss auf der SharePoint-Entwicklungsplattform sichergestellt sein, dass der Word Automation Service aktiv ist. Dies kann am einfachsten innerhalb der SharePoint-Zentraladministration überprüft werden. Nachdem die Zentraladministration geladen wurde, dem Navigationspunkt „Manage service applications“ folgen. Dieser befindet sich auf der rechten Seite in der Gruppe „Application Management“, wie auch in Abbildung 1 zu sehen ist. Auf der sich dann öffnenden Seite werden die installierten Dienstanwendungen aufgelistet. Befindet sich in der Liste noch kein Eintrag zum Word Automation Service, so muss dieser zunächst neu eingerichtet werden. Die Neueinrichtung startet mit der Schaltfläche New im Menüband. Hier befindet sich der Eintrag Word Automation Services. Nach der Anwahl öffnet sich der in Abbildung 2 dargestellte Dialog. Im oberen Bereich muss ein frei wählbarer Name für die Dienstanwendung vergeben werden. Der Name wird dann später für die programmatische Verwendung benötigt. Unter „Application Pool“ kann entweder ein bestehender Pool verwendet oder ein neuer erstellt werden. Nach diesen Angaben kann über die Schaltfläche Next der Vorgang fortgesetzt werden. Auf der zweiten Seite werden benötigte Datenbankinformationen abgefragt. Hier müssen der SharePoint-SQL-Server-Datenbankserver, ein eindeutiger Datenbankname...

headline from sands settings