Erstellen von benutzerdefinierten SharePoint-Workflowformularen mit Visual Studio 2012

2023-03-21

Stellt Workflowformulare in SharePoint vor. In diesem Artikel werden SharePoint mit dem öffentlichen Update vom März 2013 und Office Developer Tools für Visual Studio 2012 verwendet. Alle Informationen in diesem Artikel gelten sowohl für lokale SharePoint-Bereitstellungen als auch für Office 365.

Bereitgestellt von:Andrew Connell, Voitanos

Hinweis

SharePoint 2010-Workflows wurden am 1. August 2020 für neue Mandanten eingestellt und am 1. November 2020 aus bestehenden Mandanten entfernt. Wenn Sie SharePoint 2010-Workflows verwenden, empfehlen wir die Migration zu Power Automate oder anderen unterstützten Lösungen. Weitere Informationen hierzu finden Sie unter Einstellung von SharePoint 2010-Workflows.

Seit der Einführung von Microsoft SharePoint 2007 unterstützt die SharePoint-Plattform Workflows zur Automatisierung von Geschäftsprozessen. Die SharePoint-Workflowplattform ist auf Windows Workflow Foundation aufgebaut, einem Teil des .NET Framework. Während die Workflowumgebung (Workflow Foundation) zahlreiche Funktionen zum Erstellen benutzerdefinierter Workflows und Verwalten automatisierter Geschäftsprozesse bereitstellt, ergänzt SharePoint darüber hinaus die Endbenutzerintegration. Diese Integration wird in zwei Teilen implementiert:

Benutzern und Gruppen zugewiesene Aufgaben, die durch die Workflows erstellt und überwacht werden können.
Formulare, in denen Informationen von Benutzern erfasst werden, wenn Workflows einem Inhaltstyp (zum Beispiel einer Website, Liste oder Bibliothek) zugeordnet werden oder wenn ein Workflow gestartet wird.

Workflowformulare in SharePoint 2007 und SharePoint 2010

Bei der Implementierung von Workflows in SharePoint 2007 und SharePoint 2010 wurden von Version zu Version stetig Verbesserungen vorgenommen. Insbesondere hat Microsoft in SharePoint 2010 neue Funktionen hinzugefügt, wie beispielsweise die Möglichkeit, Workflows mit Websites zu verknüpfen. Darüber hinaus wurden die Tools zum Erstellen von Workflows, SharePoint Designer 2010 und Visual Studio 2010, gegenüber ihren Vorgängerversionen verbessert. Die Implementierung von Workflowaufgaben und Workflowformularen ist in SharePoint jedoch weitestgehend unverändert geblieben.

Vor SharePoint standen Entwicklern zwei Optionen zum Erstellen von Workflowformularen zur Verfügung. In SharePoint 2007 wurden InfoPath-Formulare und ASP.NET Web Forms gleichermaßen empfohlen. Beide haben Vorteile und Nachteile. In SharePoint 2010 wurde Entwicklern empfohlen, ASP.NET Web Forms zu verwenden, da diese durch die SharePoint-Entwicklertools in Visual Studio 2010 mithilfe der Projektelementvorlagen für die Zuordnung und den Initiierungsworkflow erstellt wurden, die Implementierung war jedoch der in SharePoint 2007 sehr ähnlich.

Änderungen an Workflowformularen in SharePoint

In SharePoint wurde eine neue Workflowarchitektur und Plattform eingeführt, die einige grundlegende Änderungen an der Denkweise über SharePoint darstellt. Die wichtigste Änderung besteht darin, dass Workflows in SharePoint nicht mehr vom SharePoint-Laufzeitmodul verwaltet und ausgeführt werden. SharePoint nutzt stattdessen eine neue Komponente mit dem Namen Workflow-Manager, der die Windows Workflow Foundation-Laufzeit sowie erforderliche Dienste für Workflow Foundation hostet. Der entscheidende Punkt ist, dass der Workflow-Manager außerhalb von SharePoint ausgeführt wird. Wenn ein Workflow veröffentlicht oder eine neue Instanz eines veröffentlichten Workflows gestartet wird, benachrichtigt SharePoint den Workflow-Manager, der wiederum die Workflowabschnitte verarbeitet. Wenn der Workflow Zugriff auf Informationen in SharePoint benötigt, z. B. Listenelementeigenschaften oder Benutzereigenschaften, authentifiziert er den Benutzer mit dem OAuth-Autorisierungsmodell und kommuniziert über die REST-APIs, die in der SharePoint-Version eingeführt wurden.

Außerdem wurde in der SharePoint-Version die allgemeine Richtung für Anpassungen auf der SharePoint-Plattform geändert, obwohl diese Änderung tatsächlich bei SharePoint 2010 und Sandkastenlösungen begann. In SharePoint führte Microsoft Features ein, durch die Anpassungen weg vom SharePoint-Server und hin zum Clientbrowser oder zu anderen externen Ressourcen verschoben wurden. Diese Features enthalten das neue SharePoint-App-Modell, Unterstützung zum Zuweisen einer Identität für Apps und die Authentifizierung mithilfe des OAuth-Autorisierungsmodells sowie Verbesserungen am clientseitigen Objektmodell (CSOM) und den REST-APIs.

Welche Auswirkungen hat dies auf Workflowformulare? Denken Sie daran, dass Entwicklern in SharePoint 2010 von Microsoft empfohlen wurde, ASP.NET Web Forms beim Erstellen von Formularen in Workflows zu verwenden, die mit Visual Studio erstellt wurden. Dieser Ansatz erfordert natürlich serverseitigen Code zum Verarbeiten des Formulars und zum Behandeln der Kommunikation zwischen dem Formular und dem Workflowmodul. In SharePoint ist dies jedoch nur in der an Lösungen orientierten Entwicklung möglich (d. h. die Bereitstellung von WSP-Paketen). Das neue in SharePoint eingeführte SharePoint-App-Modell lässt die Ausführung von serverseitigem Code im SharePoint-Prozess nicht zu.

Um diese Einschränkung zu vermeiden, hat Microsoft CSOM um eine API für die Interaktion mit dem Workflowmodul erweitert. Um eine SharePoint-Farm mit der Workflow-Manager-Farm zu verbinden, müssen Sie den Workflow-Manager-Client auf den SharePoint-Servern installieren. Diese Komponente dient als Proxy, den SharePoint verwendet, um mit der Workflow-Manager-Farm zu kommunizieren. Die Workflowdienste-CSOM-API ist im Grunde die clientseitige Komponente, die Sie zur Interaktion mit dem neuen Workflowmodul verwenden. Weitere Informationen zum SharePoint Workflow Services-CSOM finden Sie unter Arbeiten mit dem clientseitigen SharePoint Workflow Services-Objektmodell.

Inwiefern profitieren SharePoint-Workflowformulare davon? Nun, beim Erstellen von SharePoint-Workflows mithilfe von Visual Studio 2012 erstellen Sie Workflowformulare mithilfe von ASP.NET Web Forms. Sie können diese Formulare als SharePoint-Lösung oder in vorhandenen Lösungen bereitstellen. Dadurch erhalten Sie Zugriff auf alle Serversteuerelemente, die bereits auf dem Server bereitgestellt wurden, wie beispielsweise die ASP.NET-Websteuerelemente und andere nützliche (und manchmal erforderliche) SharePoint-Steuerelemente. Sie können auch das neue Workflowdienste-CSOM verwenden, um alle erforderlichen Aufgaben von der Zuordnung und Initiierung von Formularen bis hinzu zu folgenden Aufgaben (einschließlich, aber nicht beschränkt auf) durchzuführen:

Erstellen von Workflowaufgaben und Verlaufslistens
Erstellen einer neuen Workflowzuordnung auf einer Website, in einer Liste oder einer Dokumentbibliothek
Starten einer neuen Instanz einer vorhandenen Workflowzuordnung

Das Workflowdienste-CSOM ist äußerst stabil und lässt Ihnen eine Menge Raum für Innovationen in Workflows - im Browser und auf einem Remotecomputer.

In SharePoint Server 2013 verfügbare Workflowformulare

Vor der Veröffentlichung von SharePoint gab es drei Typen von benutzerdefinierten Workflowformularen, die erstellt werden konnten: Initiation-, Association- und Task Edit-Formulare. Von diesen drei Formulartypen haben Task Edit-Formulare als benutzerdefinierte Formularlösung an Bedeutung verloren. Die geringere Bedeutung von Task Edit-Formularen begann in SharePoint 2010, da es den SharePoint-Entwicklungstools in Visual Studio 2010 an einem Projektelement für Aufgabenformulare fehlte und stattdessen die standardmäßige Listenanzeige und die Bearbeitungsformulare zum Rendern von Aufgaben verwendet wurden.

Mit SharePoint wurde die Arbeitsweise mit Workflowaufgaben dahingehend verbessert, dass Sie benutzerdefinierte Ergebnisschaltflächen für bestimmte Szenarios erstellen können. Sie können auch das Rendern und das Verhalten bestimmter Spalten in Aufgabenelementen mithilfe des neuen clientseitigen Renderings (CSR) anpassen, das in SharePoint eingeführt wurde. Beachten Sie, dass CSR ausgeführtes JavaScript im Client verwendet. Diese Themen werden im Artikel Arbeiten mit Aufgaben in SharePoint-Workflows mithilfe von Visual Studio 2012 behandelt. Weitere Informationen finden Sie auch im Artikel Anpassen einer Listenansicht in SharePoint-Add-Ins mithilfe des clientseitigen Renderings.

Grundlegendes zu Workflowinitiierungsformularen

Ein Initiierungsformular wird geöffnet, wenn ein Benutzer manuell einen Workflow startet, dessen Workflowdefinition mit dem Formular verknüpft ist. Wenn der Workflow gestartet wird, wird dem Benutzer das Initiierungsformular vorgelegt, und er wird zur Eingabe der Informationen aufgefordert, die der Workflow benötigt. Beispielsweise könnte der Benutzer eine Begründung für einen Workflow eingeben, mit dem eine Genehmigung neuer geschäftlicher Ausgaben eingeleitet wird.

Ein wichtiger Punkt bei Initiierungsformularen ist, dass sie nur angezeigt werden, wenn ein Workflow manuell gestartet wird. Beim Start von Workflows, die gemäß ihrer Konfiguration automatisch gestartet werden, wird kein Initiierungsformular aufgerufen. Diese Bedingung kann bei Workflows, bei denen Daten aus dem Formular übergeben werden müssen, zu Komplikationen führen. Beachten Sie daher Folgendes: Wenn Ihre Workflows so konfiguriert sind, dass sie automatisch gestartet werden, und der Workflow Benutzereingaben erfordert, müssen Sie anstelle eines Initiierungsformulars ein Zuordnungsformular verwenden.

Grundlegendes zu Workflowzuordnungsformularen

Zuordnungsformulare werden Administratoren angezeigt, wenn sie sich erstmalig entscheiden, einen Workflow einer bestimmten Liste oder Dokumentbibliothek hinzuzufügen (oder zuzuordnen). Verwenden Sie die Zuordnungsformulare, um es einem Administrator zu ermöglichen, Parameter, Standardwerte und weitere Informationen für den Workflow anzugeben, der auf Elemente in der Liste oder der Bibliothek angewendet wird.

Mit diesem Standardzuordnungsformular kann der Administrator die Workflowdefinition auswählen, einen Anzeigenamen für die Zuordnung angeben, die Listen angeben, die als Container für alle Aufgaben und Verlaufslistenelemente dienen, die von dem in der Zuordnung ausgewählten Workflow erstellt wurden, sowie die Bedingungen angeben, unter denen der Workflow gestartet werden kann (manuell oder automatisch), wenn Listen- oder Bibliothekselemente erstellt oder aktualisiert werden.

Sie können auch benutzerdefinierte Zuordnungsformulare erstellen. Wenn Sie über ein benutzerdefiniertes Zuordnungsformular für eine Workflowdefinition verfügen, leitet SharePoint den Benutzer zum benutzerdefinierten Formular um, sobald das Standardformular ausgefüllt ist. Verwenden Sie das benutzerdefinierte Formular, um Konfigurationsinformationen zu sammeln, die der Workflow möglicherweise benötigt, z. B. den Aufruf eines externen Webdiensts, bei dem sich der Aufrufer entweder mit authentifizieren oder einen eindeutigen API-Schlüssel für den Zugriff übergeben muss. Dies ist die Art von Informationen, die ein Entwickler nicht in den Workflow hartcodieren möchte. Dieses Szenario wird angezeigt, wenn ein Workflow in einer App enthalten ist, die über den SharePoint Store verkauft wird. In diesem Fall benötigt jeder Kunde sein eigenes Konto beim Remotedienst. Dies ist die Art von Informationen, die Sie vom Benutzer sammeln würden, wenn er die Workflowzuordnung erstellt.

Bei einem weiteren üblichen Szenario müssen Sie Informationen sammeln, die der Initiator des Workflows normalerweise für Workflows übermittelt, die automatisch gestartet werden. Wie zuvor erläutert werden Initiierungsformulare nur dann vorgelegt, wenn Workflows manuell gestartet werden. Wenn hingegen Workflows für einen automatischen Start konfiguriert sind und der Workflow Daten in einigen Feldern des Formulars erwartet, besteht die bevorzugte Lösung in der Verwendung eines benutzerdefinierten Zuordnungsformulars.

Im Initiierungsformular wären diese Standardwerte dann beim manuellen Starten des Workflows vorhanden. Beim automatischen Start konnte der Workflow erkennen, dass keine Daten aus dem Initiierungsformular übergeben wurden, und rückgängig machen stattdessen wieder an die im Zuordnungsformular angegebenen Werte zurück.

Vorgehensweise: Erstellen und Bereitstellen eines benutzerdefinierten Zuordnungsformulars

Bei dieser Vorgehensweise wird gezeigt, wie ein benutzerdefiniertes Zuordnungsformular erstellt wird und wie diese Formular zum Erfassen von Informationen verwendet wird, die dann an den Workflow übergeben werden. Stellen Sie, bevor Sie beginnen, sicher, dass Sie Zugriff auf eine SharePoint-Entwicklerwebsite haben.

Erstellen des benutzerdefinierten Zuordnungsformulars

Erstellen Sie einen benutzerdefinierten Workflow mit Visual Studio 2012.
Erstellen Sie in Visual Studio ein neues SharePoint-App-Projekt, und konfigurieren Sie es als SharePoint-gehostete App.
Fügen Sie dem Projekt eine neue Ankündigungsliste hinzu. Diese Liste wird dem Workflow zugeordnet, und die Ereignisse in dieser Liste lösen den Workflow aus.
Fügen Sie dem Projekt ein Workflowelement hinzu, indem Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt klicken und dann Hinzufügen und anschließend Neues Element auswählen. Wählen Sie dann im Dialogfeld Neues Element hinzufügen das Projektelement Workflow in der Kategorie Office/SharePoint aus. Geben Sie "SampleWorkflow" als Name ein, und klicken Sie dann Weiter. Wenn Sie vom Assistenten zum Anpassen von SharePoint dazu aufgefordert werden, legen Sie das neue Element als Listenworkflow fest.
Auf der nächsten Seite des Assistenten zum Anpassen von SharePoint (siehe Abbildung 1) kann automatisch eine Workflowzuordnung erstellt werden. Wenn Sie benutzerdefinierte Zuordnungsformulare erstellen, sollten Sie diese Option jedoch nicht verwenden. Deaktivieren Sie stattdessen das Kontrollkästchen, und klicken Sie auf Fertig stellen.

Abbildung 1: Deaktivieren Sie die Option zum automatischen Zuordnen des Workflows.
Fügen Sie das anschließend das Formular dem Visual Studio-Projekt hinzu, indem Sie mit der rechten Maustaste auf das Workflowelement im Projektmappen-Explorer klicken, und wählen Sie dann Hinzufügen, Neues Element aus.

Dieser letzte Schritt ist wichtig, da hiermit das Dialogfeld Neues Element hinzufügen darüber informiert wird, dass es sich bei dem Kontext um ein Workflowelement handelt. Daraufhin werden im Dialogfeld Neues Element hinzufügen die beiden Projektelementvorlagen des Formulars (Initiierungsformular und Zuordnungsformular) als Optionen angezeigt, wie in Abbildung 2 dargestellt.

Abbildung 2: Auswählen der Vorlage "Zuordnungsformular".
Select the Workflow Association Form item and remove the "1" from the field name. Klicken Sie auf „Hinzufügen“, um den Vorgang abzuschließen.

Aktualisieren von HTML und JavaScript im Standardzuordnungsformular

Nachdem das neue Formular dem Projekt hinzugefügt wurde, wird es in Visual Studio automatisch geöffnet. Zu diesem Zeitpunkt müssen Sie nur zwei Aktionen an dem Formular durchführen, damit es mit Ihrem Workflow kompatibel ist:

Aktualisieren des HTML-Formulars, um die Datenelemente anzugeben, die Sie von den Benutzern erfassen müssen, und um anzugeben, wie das Formular gerendert werden soll
Aktualisieren des standardmäßigen JavaScript-Codes, um die Werte aus dem aktualisierten Formular abzurufen und um die Eigenschaftsnamen den Namen der Argumente zuzuordnen, die von Ihnen im Workflow erstellt wurden.

Öffnen Sie das Formular, um den Code anzuzeigen.
Ermitteln Sie das im folgenden Codeausschnitt angezeigte Serversteuerelement:
```
<WorkflowServices:WorkflowAssociationFormContextControl ID="WorkflowAssociationFormContextControl1" runat="server" />
```
Dieses Serversteuerelement führt zwei wichtige Aufgaben aus. Zuerst werden die JavaScript-Bibliotheken hinzugefügt, die für das Zuordnungsformular benötigt werden. Zweitens werden die Formularwerte, die vom vorherigen Formular übermittelt wurden, als ausgeblendete HTML-Eingabesteuerelemente auf die Seite geschrieben. Die vorherige Seite war das Standardmäßige SharePoint-Zuordnungsformular, in dem der Benutzer die Workflowdefinition, den Zuordnungsnamen, die Workflowaufgabe und die Verlaufsliste sowie die Startoptionen angegeben hat. Dieses Formular hat einen HTTP POST verwendet, um zu dem benutzerdefinierten Zuordnungsformular zu wechseln, das dem Workflow hinzugefügt wurde. Da es sich um einen HTTP POST handelt, ist der Zugriff auf die Werte im Formular nicht möglich, da die gesamte benutzerdefinierte Logik ohne serverseitigen Code implementiert werden muss. Daher stellt SharePoint dieses Serversteuerelement bereit, um diese Werte aus der HTTP-Anforderungspipeline zu extrahieren und dieser Seite hinzuzufügen.
Führen Sie einen Bildlauf in der Quelldatei durch, bis Sie die HTML-Beispieltabelle gefunden haben, und ersetzen Sie durch den folgenden Code:
```
<table>
  <tr>
    <td colspan="2">
      String:<br /><textarea id="strInput" rows="1" columns="50"/>
    </td>
  </tr>
  <tr>
    <td><button id="Save" onclick="return runAssocWFTask()">Save</button></td>
    <td><button id="Cancel" onclick="location.href = cancelRedirectUrl; return false;">Cancel</button></td>
  </tr>
</table>
```
In dieser Tabelle wird ein einfaches HTML-Textfeld angezeigt, das verwendet wird, um Informationen an die Workflowzuordnung zu übergeben. Beachten Sie, dass das Formular über zwei Schaltflächen verfügt. Diese Schaltflächen werden zum Speichern oder Abbrechen des Workflows verwendet. Wenn Sie auf die Schaltfläche Speichern klicken, ruft der Workflow die JavaScript-Funktion runAssocWfTask() auf, die sich einige Zeilen weiter unten in der Quelldatei befindet. Wir müssen dies als Nächstes ändern.

Aktualisieren des Workflowdienste-JSOM zum Erstellen der Workflowzuordnung

Unmittelbar nach dem HTML-Formularabschnitt in der Quelldatei befindet sich ein ecmascriptshort-Codeblock , der etwa 200 Zeilen lang ist. In diesem Codeblock wird die Implementierung der neuen clientseitigen JavaScript-Objektmodell-API der Workflowdienste in SharePoint veranschaulicht. In den meisten Fällen bleibt dieser JavaScript-Code unverändert, da er einige wichtige Funktionen hat:

Er bestimmt, ob eine neue zugeordnete Workflowaufgabenliste erstellt werden muss, und erstellt diese, falls nötig.
Er bestimmt, ob eine neue zugeordnete Workflowverlaufsliste erstellt werden muss, und erstellt diese, falls nötig.
Er erstellt eine neue Workflowzuordnung mit dem angegebenen Namen, der Workflowdefinition, den Startoptionen und den zugeordneten Listen. Der entscheidende Teil, mit dem Sie sich beim Erstellen der benutzerdefinierten Formulare befassen müssen, ist wo die Werte aus dem Formular erfasst und an die neue Zuordnung übergeben werden. Dies wird im folgenden Verfahren behandelt.

Suchen Sie im JSOM-Skriptblock der Workflowzuordnung nach der JavaScript-Funktion associateWF().
Ermitteln Sie innerhalb des Skriptblocks für diese Funktion die Zeile, die ein neues Array namens metadata definiert:
```
var metadata = new Object();
```
Fügen Sie als Nächstes eine Auflistung von Name-Wert-Paaren hinzu, die Ihre Formularfelder darstellen, die Sie an SharePoint übergeben möchten. Für das benutzerdefinierte Formular in dieser exemplarischen Vorgehensweise benötigen Sie lediglich das folgende JavaScript. Aktualisieren Sie daher den -Block, der die Metadatenvariable festlegt, wie folgt:
```
var strInputValue = document.getElementById("strInput").value;
if (strInputValue) {
  metadata['AssociationFormValue'] = strInputValue;
}
```
An diesem Punkt ist das benutzerdefinierte Zuordnungsformular vollständig.

Verwenden der Zuordnungsformularwerte im Workflow

Wenn das Formular vollständig ist, besteht der nächste Schritt darin, den Workflow so zu konfigurieren, dass die aus dem Zuordnungsformular übergebenen Werte verwendet werden. Ein aus dem Zuordnungsformular übergebener Wert wird als Konfigurationswert übergeben. Hierbei nutzen Sie eine spezielle Aktivität zum Extrahieren des Konfigurationswerts aus den Zuordnungsmetadaten des Workflows und speichern diesen in einer Variablen zur späteren Verwendung.

Öffnen Sie den Workflow in Visual Studio, navigieren Sie zur Registerkarte Variablen, und erstellen Sie eine neue Zeichenfolgenvariable namens AssociationFormValue, wie in Abbildung 3 gezeigt.

Abbildung 3: Erstellen der AssociationFormValue-Variablen.
Drag and drop a GetConfigurationValue activity on the workflow designer surface and set the Name property to the name of the metadata property used in the form, as shown in Figure 4.

Abbildung 4
Legen Sie die Result-Eigenschaft auf den Namen der Variablen fest, wie in Abbildung 4 gezeigt.

Diese Aktivität ruft den Wert der AssociationFormValue-Eigenschaft aus den Metadaten des Workflows ab und speichert ihn in der lokalen Variable. Um den Inhalt der Variablen anzuzeigen, fügen Sie dem Workflow eine WriteToHistory-Aktivität hinzu, und legen sie dessen Message-Eigenschaft fest, um den Wert der Variablen in die Verlaufsliste zu schreiben.
Sie haben die Schritte durchgeführt, wie notwendig sind, um die Formularwerte mit dem Workflow zu verknüpfen. Speichern Sie Ihre Arbeit, und testen Sie das Formular.

Testen des benutzerdefinierten Zuordnungsformulars

Zum Testen des Workflows drücken Sie F5, oder klicken Sie auf die Schaltfläche Start in Visual Studio. Bei dieser Vorgehensweise wird davon ausgegangen, dass eine lokale Installation von SharePoint vorhanden ist. Visual Studio startet dann das Workflow Manager Test Service Host-Dienstprogramm und stellt den Workflow auf der Entwicklerwebsite bereit.
Erstellen Sie die Zuordnung, indem Sie zur Liste Ankündigungen navigieren. Wählen Sie dann im Menüband die Registerkarte Liste aus, klicken Sie auf die Schaltfläche Workfloweinstellungen, Workfloweinstellungen , und klicken Sie dann auf den Link Workflow hinzufügen . An diesem Punkt wird ihnen das SharePoint-Zuordnungsformular angezeigt.
Wählen Sie im Zuordnungsformular den Workflow aus, den Sie testen möchten, und legen Sie einen Namen fest.
Entscheiden Sie sich dafür, neue Aufgaben- und Verlaufslisten zu erstellen, legen Sie fest, dass der Workflow manuell gestartet wird, und klicken Sie dann auf Weiter.
Da Sie ein benutzerdefiniertes Zuordnungsformular in der Workflowdefinition angegeben haben, wird das in Abbildung 5 dargestellte benutzerdefinierte Zuordnungsformular geöffnet.

Abbildung 5: Das benutzerdefinierte Workflowzuordnungsformular.
Geben Sie einen Wert in das Formularfeld ein, und klicken Sie auf Speichern. Dadurch wird die Zuordnung erstellt und der benutzerdefinierte Wert in den Metadaten für die Workflowzuordnung gespeichert.
Um zu überprüfen, ob der Workflow den Wert aus den Konfigurationseinstellungen extrahieren kann, navigieren Sie zurück zur Liste Ankündigungen, und erstellen Sie ein neues Element. Nachdem Sie das Element erstellt haben, starten Sie den benutzerdefinierten Workflow manuell. Sobald der Workflow gestartet wurde, navigieren Sie zur Workflowinstanz-Statusseite des Elements, und überprüfen Sie, ob der Wert in die Verlaufsliste geschrieben wurde, wie in Abbildung 6 gezeigt.

Abbildung 6 Seite "Workflow status".

Vorgehensweise: Erstellen eines benutzerdefinierten Initiierungsformulars

Bei dieser Vorgehensweise wird gezeigt, wie ein benutzerdefiniertes Zuordnungsformular erstellt und verwendet wird, um Informationen von Benutzern zu erfassen, wenn der Workflow manuell gestartet wird.

Erstellen eines neuen Workflowprojekts

Erstellen Sie zunächst einen benutzerdefinierten Workflow mithilfe von Visual Studio 2012, und stellen Sie sicher, dass Sie Zugriff auf eine SharePoint-Entwicklerwebsite haben.
Erstellen Sie ein neues SharePoint-Projekt, das als SharePoint-gehostete App konfiguriert ist.
Fügen Sie dem Projekt eine neue Ankündigungsliste hinzu. Diese Liste wird als Container für Elemente verwendet, die den Workflow auslösen.
Fügen Sie dem Projekt als Nächstes ein Workflowelement hinzu, indem Sie in Projektmappen-Explorer mit der rechten Maustaste auf das Projektsymbol klicken und Hinzufügen, Neues Element auswählen und dann im Dialogfeld Neues Element hinzufügen das Projektelement Workflow auswählen. Wählen Sie dann Hinzufügen, Neues Element aus, und wählen Sie dann im Dialogfeld Neues Element hinzufügen das Projektelement Workflow aus.
Legen Sie für den neuen Workflow den Namen "SampleInitFormWorkflow" fest, und klicken Sie auf Weiter.
Wenn Sie dazu aufgefordert werden, legen Sie das neue Workflowelement als Listenworkflow fest, der der Liste Ankündigungen zugeordnet ist. Legen Sie fest, dass der Workflow manuell gestartet wird. (Beachten Sie, dass das Initiierungsformular nicht angezeigt wird, wenn der Workflow automatisch gestartet wird.)
An diesem Punkt wird das Projekt im Projektmappen-Explorer angezeigt, wie in Abbildung 7 gezeigt. Beachten Sie, dass einige Element wie WorkflowHistoryList und WorkflowTaskList automatisch hinzugefügt wurden, als die Zuordnung erstellt wurde.

Abbildung 7: Darstellung des Projekts im Projektmappen-Explorer

Hinzufügen von Argumenten zum Erfassen von Initiierungsformularwerten

Das Workflowinitiierungsformular fordert Benutzer zur Angabe von zwei Informationen auf, die zum Starten des Workflows benötigt werden: eine Zufallszeichenfolge sowie ein Benutzer, der mit dem Personenauswahl-Steuerelement ausgewählt wird. Um dieses zu aktivieren, konfigurieren Sie zwei Argumente, deren Werte die Workflowdienste-CSOM-API aus dem Formular übernimmt, wenn dieses eingereicht wird.

Klicken Sie im Workflow-Designer am unteren Rand des Bildschirms auf die Registerkarte Argumente, und erstellen Sie zwei Argumente, wie in Abbildung 8 gezeigt. Legen Sie für die Argumente die Namen UserLoginName und SomeRandomString fest.

Abbildung 8: Konfigurieren der Initiierungsformularargumente.
Legen Sie für beide Argumente den Argumenttype auf String fest. Legen Sie ebenfalls für beide Argumente die Richtung auf In fest, wie in Abbildung 8 gezeigt.

Sie können sich die Direction-Eigenschaft als eine Eigenschaft in einer .NET-Klasse vorstellen. Wenn die Richtung auf In festgelegt ist, hat die Eigenschaft eine öffentliche Set-Methode, aber eine private Get-Methode. Wenn die Richtung auf Out festgelegt ist, hat die Eigenschaft eine öffentliche Get-Methode, aber eine private Set-Methode. Ist die Richtung auf In/Out festgelegt, ist sowohl die Get- als auch die Set-Methode öffentlich.
Zum Anzeigen des Inhalts dieser beiden Argumente fügen Sie dem Workflow ein Paar von WriteToHistory-Aktivitäten hinzu, und konfigurieren Sie diese so, dass die Inhalte der Argumente in die Verlaufsliste geschrieben werden.

Sie können diese Argumente auf die gleiche Weise wie Variablen verwenden. Beachten Sie jedoch beim Festlegen der Richtung , dass Sie deren Lese-/Schreibfunktion diktieren. Abbildung 9 zeigt, wie eine der folgenden Aktivitäten aussehen kann, wenn sie konfiguriert ist:

Abbildung 9: Konfigurieren einer WriteToHistory-Aktivität zum Testen von Argumenten

Hinzufügen des Initiierungsformular-Projektelements

Nachdem der Workflow so konfiguriert wurde, dass zwei Eingabeargumente aus dem Formular akzeptiert werden, besteht der nächste Schritt darin, das Formular dem Projekt hinzuzufügen.

Klicken Sie mit der rechten Maustaste im Projektmappen-Explorer auf das Workflowelement, und wählen Sie dann Hinzufügen und anschließend Neues Element aus.
Wählen Sie das Projektelement Workflowinitiierungsformular aus, und entfernen Sie die Zahl "1" aus dem Namen, sodass das Formular "InitForm.aspx" heißt, und klicken Sie dann auf Hinzufügen. Dies bewirkt, dass Visual Studio die neue ASPX-Seite dem Modul Pages hinzufügt, das bereits in der Projektstruktur vorhanden ist. Dadurch wird sichergestellt, dass das Formular im Unterordner Pages in der App bereitgestellt wird. Visual Studio hat auch Eigenschaften für das Workflowelement geändert.
Wählen Sie das Workflowelement SimpleInitFormWorkflow im Projektmappen-Explorer aus, und achten Sie im Raster Eigenschaften darauf, welche Eigenschaften im Initiierungsformular festgelegt wurden. Eine dieser Eigenschaften zeigt auf den relativen Websitepfad des Formulars, das soeben zum Modul Seiten hinzugefügt wurde.

Überprüfen und Aktualisieren des standardmäßigen Initiierungsformulars

Nachdem das neue Initiierungsformular dem Projekt hinzugefügt wurde, wird es von Visual Studio 2012 automatisch geöffnet. Ebenso wie beim Zuordnungsformular müssen auch für dieses neue Initiierungsformular zwei Aufgaben durchgeführt werden:

Aktualisieren des HTML-Formulars, um Datenelemente anzugeben, die vom Benutzer erfasst werden müssen, und um anzugeben, wie das Formular präsentiert werden soll
Aktualisieren des standardmäßigen JavaScript-Blocks, um Benutzereingabewerte aus dem Formular abzurufen und die Eigenschaftsnamen den Namen der Argumente zuzuordnen, die im Workflow erstellt wurden

Hinweis

Beachten Sie in der Quelldatei, dass der erste ASP.NET-Inhaltsplatzhalter, PlaceHolderAdditionalPageHead, Verweise auf die Workflow Services CSOM-Bibliothek (sp.workflowservices.js) und die wichtigsten SharePoint CSOM-Bibliotheken (sp.js und sp.runtime.js) enthält. Unmittelbar nach diesem Codeabschnitt finden Sie einen serverseitigen Kommentar, der einen kommentierten Hinweis enthält. Dieser in Abbildung 10 gezeigte Kommentar ist irrelevant und kann ignoriert werden.

Abbildung 10: Zu ignorierenden Codekommentar.

Abbildung 10: Zu ignorierender Codekommentar

Aktualisieren des HTML-Formulars

Scrollen Sie in der Codedatei des Formulars nach unten, bis Sie den ASP.NET Inhaltsplatzhalter mit dem Namen PlaceHolderMainerreichen. Beachten Sie, dass der erste Teil dieses Abschnitts eine HTML-Tabelle mit drei Formularfeldern enthält. Es werden jedoch nur zwei Felder benötigt.

Aktualisieren Sie diese HTML-Tabelle, indem Sie sie durch folgenden Code ersetzen:

<table>
  <tr>
    <td>
      String:<br />
      <input type="text" id="strInput" />
    </td>
  </tr>
  <tr>
    <td>
      User Picker:<br />
      <SharePoint:PeopleEditor AllowEmpty="false" ValidatorEnabled="true" MultiSelect="false" ID="peoplePicker" runat="server" />
    </td>
  </tr>
  <tr>
    <td>
      <input type="button" name="startWorkflowButton" value="Start" onclick="StartWorkflow()" />
      <input type="button" name="cancelButton" value="Cancel" onclick="RedirFromInitForm()" />
      <br />
    </td>
  </tr>
</table>

Die Tabelle enthält jetzt zwei Eingabesteuerelemente. Das erste ist ein standardmäßiges HTML-Textfeld mit der ID strInput. Das zweite ist ein SharePoint-Steuerelement für die Personenauswahl, dessen ID peoplePicker ist. Letzteres ist ein serverseitiges Steuerelement. Sie ist jedoch auf der Seite zulässig, da sie auf jedem SharePoint-Computer bereitgestellt wurde. Darüber hinaus wird oben im Initiierungsformular auf das Steuerelement verwiesen.

Now notice the two buttons on the form, Start ("startWorkflowButton") and Cancel ("cancelButton"). Wenn Sie auf die Schaltfläche Start klicken, wird die JavaScript-Funktion **StartWorkflow()** aufgerufen. The function itself is located in a script block farther down in the form file and is the subject of the next change that we need to make.

Aktualisieren des JSOM-Codeblocks zum Starten des Workflows

Ermitteln Sie den JavaScript-Codeblock, der unmittelbar auf die HTML-Tabelle folgt, die wir soeben geändert haben. Der Code in dem Skriptblock wird weitestgehend unverändert belassen.

Dieser Code zeigt eine enorme Leistungsfähigkeit und Flexibilität, die in der JSOM-API (Client Side Object Model) von Workflow Services verfügbar ist, die in SharePoint implementiert wurde. Im Allgemeinen führt der Code die folgenden Schritte aus.
Suchen Sie die folgende Codezeile: var wfParams = new Object();
Ersetzen Sie unmittelbar nach dieser Zeile den vorhandenen Code durch Ihren eigenen Code, um Werte aus den beiden HTML-Formularfeldern abzurufen, die wir kurz zuvor erstellt haben: strInput und peoplePicker. Führen Sie hierzu den folgenden Verweis auf die jQuery-Bibliothek dem PlaceHolderAdditionalPageHead-Element im HTML-Markup hinzu. Dadurch wird es einfacher, Werte aus dem Formular abzurufen.
```
<script type="text/javascript" src="../Scripts/jquery-1.8.2.min.js"></script>
```

Kehren Sie nun wieder zu dem Teil des JSOM-Skriptblocks zurück, in dem die Parameter aus dem Formular erfasst werden. Ersetzen Sie den vorhandenen JavaScript-Code durch den folgenden Code:

var wfParams = new Object();
// get people picker value
var html = $("ctl00_PlaceHolderMain_peoplePicker_upLevelDiv");
wfParams['UserLoginName'] = $("#divEntityData", html).attr("key");

// get string input
var strInputValue = $("strInput").value;
wfParams['SomeRandomString'] = strInputValue

Speichern Sie die Änderungen.

Der Code, den wir im vorherigen Verfahren geändert haben, übernimmt viele Aufgaben:

Er ruft die folgenden drei Parameter aus der Abfragezeichenfolge in der URL ab:
- Die Element-ID, mit der die neue Workflowinstanz verknüpft wird, gespeichert in der JavaScript-Variablen [itemId].
- Die ID der Workflowzuordnung der aktuellen Website, Liste oder Dokumentbibliothek, gespeichert in der JavaScript-Variablen [subscriptionId].
- Die URL des Benutzers, gespeichert in der JavaScript-Variablen [redirectUrl]. Dies ist der Ort, an den die Benutzer geleitet werden, nachdem sie das Formular ausgefüllt haben und der Workflow gestartet wurde.
Erstellt ein Array von Eigenschaften, die an den Workflow gesendet werden und in der JavaScript-Variablen [wfParams] gespeichert werden. Dies sind die Werte, die Sie aus dem Formular erfassen müssen, und der zweite der beiden minimalen Schritte, die zum Bearbeiten des benutzerdefinierten Initiierungsformulars erforderlich sind.
Er bezieht Verweise auf einen SharePoint-CSOM-Clientkontext sowie die erforderlichen Workflowdienste.
Sobald das Skript mit dem Workflowdienste-Abonnementdienst verbunden ist (referenziert in der Variablen [subscriptionService] ), führt es eine der folgenden Aufgaben durch:
- Wenn das Skript eine Element-ID aus der Abfragezeichenfolge im ersten Schritt erhalten hat, startet es eine neue Instanz des Workflows für das angegebene Listenelement, indem die [startWorkflowOnListItem()] -Funktion vom Workflowdienste-Instanzdienst aus aufgerufen wird.
- Wurde keine ID gefunden, startet es eine neue Instanz des Workflows auf der aktuellen Website, indem die [startWorkflow()] -Funktion vom Workflowdienste-Instanzdienst aus aufgerufen wird.

Testen des benutzerdefinierten Initiierungsformulars

Testen Sie den Workflow, indem Sie F5 drücken oder auf die Schaltfläche Start in Visual Studio 2012 klicken. Wenn Sie in einer lokalen Installation von SharePoint testen, startet Visual Studio 2012 das hilfsprogramm Workflow-Manager Testdiensthost und stellt den Workflow auf der Entwicklerwebsite bereit. Nach kurzer Zeit wird die Entwicklerwebsite geöffnet.

Navigieren Sie zu der Liste Ankündigungen, und erstellen Sie ein neues Element. Nachdem das Element erstellt wurde, starten Sie den benutzerdefinierten Workflow.

Da die Workflowdefinition einen Verweis auf ein Initiierungsformular enthält, wird der Benutzer zuerst zu diesem Formular geleitet. Geben Sie die erforderlichen Werte ein, und klicken Sie dann auf die Schaltfläche Start. Dadurch wird der JavaScript-Code auf der Seite ausgelöst, und die Workflowinstanz wird gestartet, wie in Abbildung 11 gezeigt.

Abbildung 11: Auslösen des Workflows.

Starten der Workflow-Instanz.

Nachdem der Workflow gestartet wurde, leitet die Seite den Benutzer zurück zur Ursprungsseite. Geben Sie dem Workflow etwas Zeit zum Starten, und navigieren Sie dann zurück zu dem Element, und zeigen Sie die Statusseite der Workflowinstanz an. Beachten Sie, dass die Verlaufsliste die Werte enthält, die in dem Formular übermittelt und dann an SharePoint gesendet wurden, nachdem die Workflowinstanz über das Workflowdienste-JSOM erstellt wurde.

Abbildung 12. Beim Abschließen des Workflows.

Der Beispielworkflow.

Zusammenfassung

In SharePoint wurden zahlreiche Verbesserungen bei Workflows eingeführt. In diesem Artikel wurden die Änderungen im Zusammenhang mit Workflowformularen beschrieben, die aufgrund von Änderungen an der Workflowarchitektur in SharePoint gesteuert wurden. Zudem wurde in diesem Artikel gezeigt, wie benutzerdefinierte Zuordnungsformulare und Initiierungsformulare erstellt werden, mit denen die anspruchsvollen Anforderungen bei der Automatisierung der Geschäftsprozesse von heute mithilfe von Visual Studio 2012 erfüllt werden können.

Freigeben über