Freigeben über

Hinzufügen eines Workflows zu einem in SharePoint gehosteten SharePoint-Add-In

  • Artikel

Dies ist der sechste in einer Reihe von Artikeln über die Grundlagen der Entwicklung von SharePoint gehosteten SharePoint-Add-Ins. Machen Sie sich zunächst mit SharePoint-Add-Ins und den vorherigen Artikeln dieser Reihe vertraut, die Sie unter Erste Schritte beim Erstellen von SharePoint gehosteten SharePoint-Add-Ins | Nächste Schritte finden können.

Hinweis

Es wird empfohlen, Microsoft Power Automate für Apps und die Prozessautomatisierung zu verwenden. Ab Visual Studio 2022 wurden Workflowvorlagen aus SharePoint-Add-In-Projekten entfernt. Weitere Informationen finden Sie unter Anleitung: Migrieren von klassischen Workflows zu Power Automate-Abläufe in SharePoint

Tipp

Wenn Sie unsere Artikelreihe zum Thema SharePoint-gehostete Add-Ins durchgearbeitet haben, haben Sie bereits eine Visual Studio-Lösung, die Sie für diesen Artikel verwenden können. Sie können auch das Repository unter SharePoint_SP-hosted_Add-Ins_Tutorials herunterladen und die Datei „BeforeWorkflow.sln“ öffnen.

In diesem Artikel fügen Sie einen Workflow im SharePoint-Add-In „Orientierung für Mitarbeiter“ hinzu, der die Personalabteilung (HR) benachrichtigt, dass ein neuer Mitarbeiter bereit ist, die Personalpapiere auszufüllen.

Hinzufügen eines Workflows zu einem Add-In

  1. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie Hinzufügen>Neuer Ordner aus. Nennen Sie den Ordner Workflows.

  2. Klicken Sie mit der rechten Maustaste auf den neuen Ordner, und wählen Sie Hinzufügen>Neues Element aus. Das Dialogfeld Neues Element hinzufügen wird geöffnet, und der Office/SharePoint-Knoten wird angezeigt.

  3. Wählen Sie Workflow aus, und geben Sie ihm den Namen HR_Intake. Wenn Sie aufgefordert werden, den Workflowtyp auszuwählen, wählen Sie Listenworkflow und dann Weiter aus.

  4. Aktivieren Sie auf der nächsten Seite des Assistenten die Option Ja, Zuordnung durchführen... aus, und legen Sie dann die Dropdownfelder auf die folgenden Werte fest:

    • Die Bibliothek oder Liste, der der Workflow zugeordnet werden soll: Neue Mitarbeiter in Seattle
    • Die Verlaufsliste: <create new>
    • Die Aufgabenliste: <create new>

  5. Wählen Sie Weiter aus.

  6. Aktivieren Sie auf der letzten Seite des Assistenten die Option zum automatischen Starten des Workflows nur, wenn ein Element geändert wird.

  7. Wählen Sie Fertig stellen aus.

    Von den Office Developer Tools für Visual Studio wird Folgendes ausgeführt:

    • Erstellen eines HR_Intake-Workflows im Ordner Workflows mit einer untergeordneten Workflow.xaml-Datei, die im Workflow-Designer geöffnet ist
    • Erstellen einer WorkflowTaskList-Listeninstanz, in der Aufgaben, die Teil des Workflows sind, erstellt und aktualisiert werden
    • Erstellen einer WorkflowHistoryList-Listeninstanz, die ein Protokoll der verschiedenen stattfindenden Schritte bei jeder Ausführung des Workflows ist

Entwerfen des Workflows

Der Workflow sendet eine E-Mail, um einen Mitarbeiter der Personalabteilung zu benachrichtigen, dass der neue Mitarbeiter die Orientierungsphase der Tour durch das Gebäude abgeschlossen hat und zum Ausfüllen der Aufnahmepersonalpapiere bereit ist. Jede Änderung in einem vorhandenen Element der Liste Neue Mitarbeiter in Seattle löst den Workflow aus, aber der Workflow führt keine Aktionen aus, bis das Feld Orientierungsphase des Listenelements auf HR paperwork festgelegt wird. Dann wird eine E-Mail an einen Mitarbeiter der Personalabteilung gesendet und eine Aufgabe für diesen Mitarbeiter zur WorkflowTaskList hinzugefügt.

Hinweis

Zu verschiedenen Zeiten beim Entwerfen Ihres Workflows wird ein blaues Rautensymbol mit einem Ausrufezeichen ( Eine kleine blaue Rautenform mit einem weißen Ausrufezeichen darin. ) auf einem oder mehreren Elementen im Workflow-Designer angezeigt. Diese weisen auf temporäre Fehler hin. (Zeigen Sie mit dem Mauszeiger auf das Symbol, um eine kurze Meldung anzuzeigen, oder suchen Sie in der Visual Studio-Fehlerliste nach Details.) Dies sind Nebenwirkungen der Unvollständigkeit des Workflows. Diese sollten nicht mehr vorhanden sein, wenn Sie das Verfahren abgeschlossen haben.

  1. Öffnen Sie den Bereich Toolbox in Visual Studio, erweitern Sie den Knoten SP - Liste, und ziehen Sie dann LookupSPListItem in die Sequenz im Designer.

  2. Wählen Sie LookupSPListItem aus, um die Eigenschaften im Visual Studio-Bereich Eigenschaften anzuzeigen. Legen Sie die Eigenschaften auf die folgenden Werte fest:

    • ItemID: (aktuelles Element)
    • ListID: (aktuelle Liste)
    • DisplayName: LookupCurrentNewEmployee

    Der Bereich Eigenschaften sollte jetzt wie folgt aussehen:

    Abbildung 1: Eigenschaftenbereich von LookupSPListItem

    Eigenschaftenbereich der Workflowaktivität „Listenelement suchen“, wobei die Eigenschaften „ItemID“, „ListID“ und „DisplayName“ festgelegt sind

  3. Klicken Sie auf eine beliebige Stelle außerhalb des Bereichs, um die Änderungen zu speichern. Die Oberfläche des Designers sollte jetzt wie folgt aussehen.

    Abbildung 2: Sequenz im Workflow-Designer

    Workflow-Designer mit dem Feld „Sequenz“ und einer darin enthaltenen Aktivität mit dem Namen „Aktuellen neuen Mitarbeiter suchen“

  4. Wählen Sie den Link Eigenschaften abrufen in der (neu umbenannten) Aktivität LookupCurrentNewEmployee im Designer aus. Dadurch wird eine GetDynamicValueProperties-Aktivität zur Sequenz hinzugefügt.

  5. Wählen Sie den Text Definieren... in der Aktivität GetDynamicValueProperties aus. Dadurch wird das Dialogfeld Eigenschaften geöffnet.

  6. Legen Sie den Entitätstyp auf Listenelement vonlist_instance_name fest, wobei list_instance_nameneue Mitarbeiter in Seattle ist.

  7. Wählen Sie in der Spalte Pfad die oberste Zelle aus, und wählen Sie dann Orientierungsphase aus der Dropdownliste aus.

  8. Wählen Sie die Zelle darunter aus, und wählen Sie dann Mitarbeiter aus der Dropdownliste aus.

  9. Wählen Sie Variablen auffüllen aus. Dadurch Variablen namens OrientationStage und Title erstellt, und jeder wird der Wert der entsprechenden Felder im aktuellen Element der Liste Neue Mitarbeiter in Seattle zugewiesen. Das Dialogfeld Eigenschaften sollte nun wie folgt aussehen:

  10. Wählen Sie OK aus. Die Designeroberfläche sollte jetzt wie folgt aussehen:

    Abbildung 4: Workflow-Designer

    Der Workflow-Designer mit zwei Aktivitäten: „Listenelement suchen“ und „Dynamische Werte abrufen“.

  11. Öffnen Sie den Bereich Toolbox in Visual Studio, erweitern Sie den Knoten Ablaufsteuerung, und ziehen Sie dann Wenn in den unteren Bereich von Sequenz unterhalb von GetDynamicValueProperties.

  12. Geben Sie in das Feld Bedingung von Wenn den Wert OrientationStage=="HR paperwork" ein.

  13. Öffnen Sie den Bereich Toolbox in Visual Studio, erweitern Sie den Knoten SP - Hilfsprogramme, und ziehen Sie dann E-Mail in das Feld Dann der Wenn-Aktivität.

  14. Wählen Sie die E-Mail-Aktivität aus. Legen Sie im Bereich Eigenschaften die Werte für die Eigenschaften Textkörper, Betreff und An fest. Wählen Sie in jedem Fall die Beschriftungsschaltfläche ... für die -Eigenschaft aus, und verwenden Sie den Ausdrucks-Editor , der geöffnet wird, um den Wert der Eigenschaft wie in der folgenden Tabelle festzulegen. Da es sich dabei um C#-Zeichenfolgenausdrücke handelt, müssen Sie die Anführungszeichen exakt wie gezeigt verwenden. Title ist hier eine Variable, die Sie zuvor dem Feld Titel des Listenelements zugewiesen haben (das den Namen des Mitarbeiters enthält).

    • Körper:Title + " is waiting in the lobby to fill out benefits and employment forms."
    • Betreff:Title + " is ready for HR paperwork"
    • An:new System.Collections.ObjectModel.Collection<string>() {"your_O365_email"}

    Ersetzen Sie den Platzhalter your_O365_email durch die Identität, mit der Sie sich bei Ihrem Office 365-Entwicklerkonto anmelden, z. B. *alias*@*O365domain*.sharepoint.com. Da es sich hier um eine C#-Zeichenfolge handelt, muss diese in Anführungszeichen eingeschlossen sein.

  15. Öffnen Sie den Bereich Toolbox in Visual Studio, erweitern Sie den Knoten Runtime, und ziehen Sie dann TerminateWorkflow in das Feld Sonst der Wenn-Aktivität.

  16. Wählen Sie die TerminateWorkflow-Aktivität aus, und legen Sie im Bereich Eigenschaften den Grund auf Folgendes fest (einschließlich der Anführungszeichen): "Not at HR paperwork stage.". Der Designer sollte jetzt wie folgt aussehen:

    Abbildung 5: Workflow-Designer, wenn der Workflow abgeschlossen ist

    Der Workflow-Designer mit Aktivitäten für

Ausführen und Testen des Add-Ins

  1. Verwenden Sie die F5-Taste, um Ihr Add-In bereitzustellen und auszuführen. Visual Studio führt eine temporäre Installation des Add-Ins auf Ihrer SharePoint-Testwebsite durch und führt das Add-In sofort aus. Die Konsole Diensttesthost des Workflow-Managers wird ebenfalls geöffnet.

  2. Wenn die Standardseite des Add-Ins geöffnet wird, öffnen Sie eins der Elemente zum Bearbeiten, und legen Sie den Wert von OrientationStage auf HR paperwork fest.

    In der Konsole Diensttesthost wird der Hinweis angezeigt, dass der Workflow gestartet wurde. Kurz danach wird der Hinweis angezeigt, dass der Workflow abgeschlossen ist. Es folgt ein Beispiel:

    Abbildung 6 Testdiensthostkonsole

    Das Workflowfenster

    Hinweis

    Wenn die Konsole Diensttesthost nicht geöffnet wird, müssen Sie möglicherweise das Workflow-Debugging aktivieren. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Projektnamen, und wählen Sie Eigenschaften aus. Öffnen Sie im Bereich Eigenschaften die Registerkarte SharePoint, und aktivieren Sie das Kontrollkästchen Workflow-Debugging aktivieren.

  3. Wechseln Sie zum E-Mail-Posteingang (Outlook) Ihres Office 365-Entwicklerkontos. Dort finden Sie eine E-Mail mit dem Betreff „Employee is ready for HR paperwork“, wobei Employee der Name des Mitarbeiters ist, dessen Element Sie bearbeitet haben. Der Text der E-Mail lautet: "Der Mitarbeiter wartet im Wartebereich auf das Ausfüllen von Leistungs- und Beschäftigungsformularen." Es folgt ein Beispiel:

    Abbildung 7: Vom Workflow gesendete E-Mail

    Eine E-Mail-Nachricht in Outlook aus dem Workflow mit dem Betreff

    Tipp

    Wenn der Workflow gestartet, aber niemals abgeschlossen und die E-Mail nicht gesendet wird, versuchen Sie, die Debugsitzung zu beenden, und drücken Sie einige Male erneut F5, bevor Sie davon ausgehen, dass etwas in Ihrem Code nicht in Ordnung ist. Manchmal liegt das Problem bei SharePoint Online. Wenn weiterhin Probleme auftreten, versuchen Sie, einen Inhaltstyp namens ListFieldsContentType, falls dieser noch nicht vorhanden ist, zum Abschnitt ContentTypes der Datei „schema.xml“ hinzuzufügen. Im Folgenden finden Sie ein Beispiel für das Markup:

    <ContentType ID="0x0100781dd48170b94fdc9706313c82b3d04c" Name="ListFieldsContentType" Hidden="TRUE"></ContentType>

    Kopieren Sie den gesamten FieldRefs-Abschnitt des Inhaltstyps NewEmployee in diesen neuen Inhaltstyp. Speichern Sie das Projekt, ziehen Sie es zurück, und drücken Sie erneut F5.

  4. Schließen Sie zum Beenden der Debugsitzung das Browserfenster, oder beenden Sie das Debuggen in Visual Studio. Wann immer Sie F5 drücken, zieht Visual Studio die bisherige Version des Add-Ins zurück und installiert die jeweils neueste Version.

  5. Da Sie mit diesem Add-In und dieser Visual Studio-Lösung in anderen Artikeln arbeiten werden, hat es sich bewährt, das Add-In ein letztes Mal zurückzuziehen, wenn Sie Ihre Arbeit daran für eine Weile abgeschlossen haben. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie die Option Zurückziehen aus.

Nächste Schritte

Im nächsten Artikel dieser Reihe fügen Sie eine benutzerdefinierte Seite und Formatvorlage zu einem von SharePoint gehosteten SharePoint-Add-In hinzu.