Web Service Connector-Workflowhandbuch für ein REST-API-Beispiel

In diesem Artikel wird die Bereitstellung einer REST-Beispiel-API behandelt, um das Webdienstkonfigurationstool mit einer REST-API-Webdatenquelle zu durchlaufen.

Voraussetzungen

Für die Verwendung des Beispiels sind die folgenden Voraussetzungen erforderlich:

• Das Webdienstkonfigurationstool ist installiert.
• REST-Beispieldienst für Datenquellen wird bereitgestellt. Laden Sie das Beispiel herunter und installieren Sie es (siehe hier).

{

"EmployeeList":[

{"id":"1","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""},{"id":"2","employee_name":"Albano","employee_salary":"22213","employee_age":"37","profile_image":""}

]

}

Konfigurieren der REST-Projektermittlung im Webdienstkonfigurationstool

Die folgenden Schritte zeigen, wie Sie ein neues Projekt für Ihre Datenquelle im Webdienstkonfigurationstool erstellen.

1. Öffnen Sie das Webdienstkonfigurationstool. Es öffnet ein leeres SOAP-Projekt.

   

2. Wählen Sie Datei>Neues>REST-Projektaus.

   

3. Wählen Sie auf der linken Seite REST-Projekt und dann Hinzufügen.

   

4. Geben Sie auf der nächsten Seite die folgenden Informationen an:

   • Der name des neuen Webdiensts
   • Adresse (REST-API-URL-Pfad)
   • Namespace
   • Sicherheitsmodus (Authentifizierungstyp)

   

   Die folgende Abbildung zeigt Beispiele für diese Werte:

   

   Legen Sie den Sicherheitsmodus auf Nonefest. Legen Sie die Adresse auf den in Azure gehosteten JSON-Beispielserver fest.

5. Wählen Sie OK aus. Das REST-Projekt, das im Web Services-Konfigurationstool aufgeführt ist.

   

6. Der nächste Schritt besteht darin, den REST-API-Aufruf zu definieren und den Aufruf in die Windows Communication Foundation (WCF)-Aufrufe zu übersetzen.

   1. Erweitern Sie das REST-Projekt, und wählen Sie den RESTSAMPLE--Dienst aus.

   2. Wählen Sie Hinzufügen. Sie werden aufgefordert, zwei Werte hinzuzufügen:

      

      1. Geben Sie den Namen ein. Dieser Schritt wird im Screenshot als 3 bezeichnet.
      2. Geben Sie die Adresse ein. Dieser Schritt wird im Screenshot als 4 bezeichnet.
      3. Wählen Sie OK aus. Der Beschreibung für den RESTSAMPLE--Dienst wird eine REST-Ressource hinzugefügt.

7. Wählen Sie im Feld Ressourcen die soeben hinzugefügte REST-Ressource aus. Fügen Sie die folgende Methode hinzu:

   

8. Wählen Sie die REST-Methode aus. Beachten Sie, dass es ihnen möglich ist, mehrere Methoden in derselben Ressource zu erstellen und die während der Ausführung übergebenen Abfragen zu definieren.

9. Für die GETALL-Methode sind keine Abfragen erforderlich. Lassen Sie die Parameterwerte leer. Beim Exportieren oder Importieren der REST-API müssen Sie je nach Funktion die Beispielanforderung /oder Antwort definieren. Kopieren Sie die JSON-Rückgabe, und fügen Sie sie ein, wenn Sie zu diesem Beispiel navigieren.

   

10. Wählen Sie Speichern aus. Speichern Sie das Projekt in C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions.

Konfigurieren von Objekttypen im Webdienstkonfigurationstool

Die folgenden Schritte zeigen, wie Sie Objekttypen für Ihre Datenquelle im Webdienstkonfigurationstool konfigurieren.

1. Der nächste Schritt besteht darin, das Verbinderraumschema zu definieren. Dies wird erreicht, indem der Objekttyp erstellt und deren Objekttypen definiert werden. Klicken Sie im linken Bereich auf Objekttypen und klicken Sie auf die Schaltfläche Hinzufügen. Daraufhin öffnet sich die folgende Seite. Fügen Sie einen neuen Objekttyp hinzu, und geben Sie einen Namen an. Klicken Sie auf die Schaltfläche OK .

   

2. Wenn Sie einen Objekttyp hinzufügen, wird die folgende Seite angezeigt.

   

3. Im rechten Bereich, der dem Objekttyp entspricht, können Sie die Attribute und deren Eigenschaften für den ausgewählten Objekttyp verwalten. Wenn Sie auf die Schaltfläche "Hinzufügen" klicken, wird unten der Bildschirm angezeigt, auf dem sie Attribute hinzufügen können.

   

   

4. Der folgende Bildschirm wird nach dem Hinzufügen aller erforderlichen Attribute angezeigt.

   

5. Objekttyp und Attribute, die nach der Erstellung erstellt wurden, stellen leere Workflows bereit, die auf die vorgänge ausgerichtet sind, die in Microsoft Identity Manager (MIM) ausgeführt werden.

Konfigurieren von Workflows im Webdienstkonfigurationstool

Der nächste Schritt besteht darin, die Workflows für Den Objekttyp zu konfigurieren. Workflow-Dateien sind eine Reihe von Aktivitäten, die vom Konnektor der Webdienste zur Ausführung verwendet werden. Die Workflows werden verwendet, um den entsprechenden MIM-Vorgang zu implementieren. Mit dem Webdienstkonfigurationstool können Sie vier verschiedene Workflows erstellen:

• Importieren: Importieren von Daten aus einer Datenquelle für die folgenden beiden Workflowtypen:

  • Vollständiger Import: Ein vollständiger Import, der konfiguriert werden kann.
  • Delta-Import: Vom Webdienstkonfigurationstool nicht unterstützt.

• Exportieren: Exportieren von Daten aus MIM in eine verbundene Datenquelle. Die folgenden drei Aktionen werden für den Vorgang unterstützt. Sie können diese Aktionen basierend auf Ihren Anforderungen konfigurieren.

  • Hinzufügen
  • Löschen
  • Ersetzen Sie

• Kennwort: Durchführen der Kennwortverwaltung für den Benutzer (Objekttyp). Für diesen Vorgang stehen zwei Aktionen zur Verfügung:

  • Kennwort festlegen
  • Kennwort ändern

• Testverbindung: Konfigurieren Sie einen Workflow, um zu überprüfen, ob die Verbindung mit dem Datenquellenserver erfolgreich hergestellt wurde.

Workflow-Designer

Der Workflow-Designer öffnet den Arbeitsbereich, um den Workflow gemäß Anforderung zu konfigurieren. Für jeden Objekttyp (neu /existing) stellt das Konfigurationstool die Knoten für Workflows bereit, die vom Tool unterstützt werden.

Der Workflow-Designer besteht aus den folgenden UI-Elementen:

• Knoten im linken Bereich: Diese helfen Ihnen, auszuwählen, welche Workflows Sie entwerfen möchten.

• Zentraler Workflow-Designer: Hier können Sie die Aktivitäten zum Konfigurieren der Workflows ablegen. Zum Ausführen verschiedener MIM-Vorgänge (Export, Import, Kennwortverwaltung) können Sie die Standard- und benutzerdefinierten Workflowaktivitäten von .NET Workflow Framework 4 verwenden. Das Webdienstkonfigurationstool verwendet Standard- und benutzerdefinierte Workflowaktivitäten. Weitere Informationen zu Standardaktivitäten finden Sie unter Verwenden von Aktivitäts-Designern.

  • Im zentralen Workflow-Designer weist ein roter Kreis mit Ausrufezeichen neben jeder Aktivität darauf hin, dass der Vorgang verworfen wurde und nicht richtig und vollständig definiert ist. Zeigen Sie auf den roten Kreis, um den genauen Fehler zu ermitteln. Nachdem die Aktivität richtig definiert wurde, ändert sich der rote Kreis in das gelbe Informationszeichen.

  • Im zentralen Workflow-Designer weist ein gelbes Dreiecksinformationszeichen neben jeder Aktivität darauf hin, dass die Aktivität definiert ist, aber es gibt mehr, die Sie tun können, um die Aktivität abzuschließen. Zeigen Sie auf das gelbe Dreieck, um weitere Informationen anzuzeigen.

• Toolbox: Packt alle Tools einschließlich System- und benutzerdefinierter Aktivitäten und vordefinierter Anweisungen zum Entwerfen des Workflows. Weitere Informationen finden Sie unter Toolbox-.

• Toolbox-Abschnitte: Die Toolbox enthält die folgenden Abschnitte und Kategorien:

  • Beschreibung: Der Titel der Toolbox. Eine Registerkarte greift auf die Toolbox und die Eigenschaften der ausgewählten Workflowaktivität zu.

  • Import-Workflow: Benutzerdefinierte Aktivitäten zum Einrichten von Import-Workflows.

  • Export-Workflow: Benutzerdefinierte Aktivitäten zum Konfigurieren von Export-Workflows.

  • Allgemein: Angepasste Aktivitäten zur Konfiguration eines Workflows.

  • Debug-: Systemworkflowaktivitäten zum Debuggen, die in Workflow 4 definiert sind. Diese Aktivitäten ermöglichen die Problemverfolgung für einen Workflow.

  • Anweisungen: Systemworkflow-Aktivitäten, die in Workflow 4 definiert sind. Weitere Informationen finden Sie unter Verwendung von Aktivitätsdesignern.

• Eigenschaften: Auf der Registerkarte "Eigenschaften" werden die Eigenschaften einer bestimmten Workflowaktivität angezeigt, die im Designerbereich abgelegt und ausgewählt wird. Die Abbildung auf der linken Seite zeigt die Eigenschaften der Aktivität Zuweisen. Bei jeder Aktivität unterscheiden sich die Eigenschaften und werden beim Konfigurieren des benutzerdefinierten Workflows verwendet. Auf dieser Registerkarte können Sie die Attribute des ausgewählten Tools definieren, das im zentralen Workflow-Designer abgelegt wurde. Weitere Informationen finden Sie unter Eigenschaften.

• Vorgangsleiste: Die Taskleiste enthält drei Elemente: Variablen, Argumenteund Imports. Diese Elemente werden zusammen mit Workflowaktivitäten verwendet. Weitere Informationen finden Sie unter Einführung eines Entwicklers in Windows Workflow Foundation (WF) in .NET 4.

Konfigurieren eines vollständigen Importworkflows im Webdienstkonfigurationstool

Die folgenden Schritte zeigen, wie Sie workflows für den vollständigen Import für die REST-API mithilfe des Webdienstkonfigurationstools konfigurieren.

1. Wählen Sie den zu konfigurierenden Vollständigen Importworkflow aus. Die Argumente und Importe sind bereits definiert und sind spezifisch für die Aktivitäten. Weitere Informationen finden Sie in den folgenden Bildschirmen.

   

   

   Nach der Neukonfiguration der Aufrufe müssen Sie die Namen der Attribute ändern, die sich ändern, oder den Namespace zu den Variablen hinzufügen, die sich auf die Rückgabestruktur der API und auf Objekttypen beziehen, die auf den alten Namespace verweisen. Die Toolbox im rechten Bereich enthält alle benutzerdefinierten workflowspezifischen Aktivitäten, die Sie für die Konfiguration benötigen. Weisen Sie die Werte den Variablen zu, die Sie für Ihre Logik verwenden möchten. Wechseln Sie zum unteren Abschnitt des zentralen Workflow-Designers, und deklarieren Sie die Variablen. Variablen werden im nächsten Schritt deklariert.

2. Fügen Sie eine Aktivität Sequenz hinzu. Ziehen Sie den Aktivitätsdesigner Sequenz aus der Toolbox und legen Sie ihn auf der Oberfläche des Windows Workflow Designers ab. Siehe die folgenden Bildschirme. Die Aktivität Sequenz enthält eine geordnete Collection von untergeordneten Aktivitäten, die sie der Reihe nach ausführt.

   

3. Um eine Variable hinzuzufügen, suchen Sie Create Variable. Geben Sie wsResponse als Name ein, wählen Sie die Dropdown-Liste Variablentyp und wählen Sie dann Durchsuchen nach Typen. Ein Dialogfeld wird angezeigt. Wählen Sie generiert>GETALL>Rückmeldung. Lassen Sie die Werte Umfang und Standard unmarkiert. Alternativ können Sie diese Werte auch über die Ansicht Eigenschaften festlegen.

   

4. Ziehen Sie einen weiteren Sequenz Aktivitätsdesigner aus der Toolbox innerhalb der bereits hinzugefügten Sequenz-Aktivität.

5. Ziehen Sie eine WebServiceCallActivity, die unter Common. präsentiert wird. Diese Aktivität dient dazu, eine nach der Erkennung verfügbare Webdienst-Operation aufzurufen. Dies ist eine benutzerdefinierte Aktivität, die in verschiedenen Vorgangsszenarien üblich ist.

   

   Um den Webdienstvorgang zu verwenden, legen Sie die folgenden Eigenschaften fest:

   • Dienstname: Geben Sie einen Namen für den Webdienst ein.

   • Endpunktname: Geben Sie einen Endpunktnamen für den ausgewählten Dienst an.

   • Vorgangsname: Geben Sie den jeweiligen Vorgang für den Dienst an.

   • Argument: Wählen Sie Argumente. Weisen Sie im nächsten Dialogfeld die Argumentwerte zu, wie in der folgenden Abbildung dargestellt:

     Zuweisen von Argumenten

     Wichtig

     Ändern Sie den Name, Richtung oder Typ für ein Argument nicht über diesen Dialog. Wenn eine dieser Werte geändert wird, wird die Aktivität ungültig. Legen Sie nur den Wert für das Argument fest. Wie in dieser Abbildung gezeigt, ist der Wert wsResponse festgelegt.

6. Fügen Sie eine ForEach Aktivität direkt unter WebServiceCallActivity hinzu. Diese Aktivität wird verwendet, um alle Attribute (sowohl Anker als auch Nichtanker) des Objekttyps zu iterieren. Beim Ziehen dieser Aktivität in die Workflow-Designer-Oberfläche werden automatisch alle Attributnamen für Ihr Objekt aufgezählt. Legen Sie die erforderlichen Werte gemäß folgendem Bildschirm fest:

   

7. In einigen Fällen müssen Sie möglicherweise die generated.dll öffnen, die sich in der WsConfig-Datei befindet. Kopieren Sie diese WsConfig-Datei, und benennen Sie sie mit der Erweiterung .zip um. Öffnen und extrahieren Sie generated.dll mit Ihrem bevorzugten .NET-Reflektor-Tool.

   

8. Bestimmen Sie den öffentlichen Namespace für die EmployeeList:

   

   Fügen Sie als Nächstes diese Rückgabe in den Workflow ForEachein:

   

9. Ziehen Sie eine CreateCSEntryChangeScope Aktivität in den ForEach-Teil. Diese Aktivität wird verwendet, um eine Instanz des CSEntryChange-Objekts in der Workflowdomäne für jeden jeweiligen Datensatz zu erstellen, während Daten aus der Zieldatenquelle abgerufen werden. Wenn Sie diese Aktivität ziehen, wird die folgende Seite angezeigt. CreateAnchorAttribute-Aktivitäten werden automatisch vererbt. Aktualisieren Sie den DN- Wert auf Ihren bevorzugten Domänennamen.

   

   Hinweis

   Verankerungswerte und Objektnamen variieren je nach dem verfügbar gemachten Webdienst. Die Abbildung zeigt ein Beispiel.

10. Ziehen Sie eine CreateAttributeChange-Aktivität unter die CreateAnchorAttribute-Aktivität. Die Anzahl der zu ziehenden Aktivitäten ist gleich der Anzahl der Nicht-Anker-Attribute. Siehe die folgende Abbildung als Referenz.

    erstellen

    Hinweis

    Um diese Aktivität zu verwenden, wählen Sie die entsprechenden Felder aus der Dropdownliste aus, und weisen Sie die Werte zu. Bei mehrwertigen Attributen legen Sie mehrere CreateValueChangeActivity-Aktivitäten innerhalb einer CreateAttributeChangeActivity-Aktivität ab.

11. Speichern Sie dieses Projekt am Speicherort %FIM_INSTALL_FOLDER%\Synchronization Service\Extensions. Konfigurieren Sie dann den Verwaltungs-Agent wie in Webdienst MA-Konfigurationbeschrieben.

    

    Standardprojekte sollten an Standort %FIM_INSTALL_DIR\2010\Synchronization Service\Extensions auf dem Zielsystem heruntergeladen und gespeichert werden. Die Projekte sind dann im Assistenten des Konnektors für Webdienste sichtbar.

    Beim Ausführen der ausführbaren Datei werden Sie aufgefordert, den Speicherort für die Installation anzugeben. Geben Sie den Speicherort ein.

    Wichtig

    Die Projektdatei kann an jedem Speicherort gespeichert und geöffnet werden, vorausgesetzt, der Ausführende verfügt über die entsprechenden Zugriffsrechte. Nur Projektdateien, die im ordner Synchronization Service\Extension gespeichert werden, können im Webdienst-Connector-Assistenten ausgewählt werden, auf den über die MIM-Synchronisierungs-UI zugegriffen wird.

    Der Benutzer, der das Webdienstkonfigurationstool ausführt, erfordert die folgenden Berechtigungen:

    • Vollzugriff auf den Ordner "Erweiterung des Synchronisierungsdiensts".
    • Lesezugriff auf den Registrierungsschlüssel HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters, in dem sich der Speicherort des Erweiterungsordners befindet.

Nächste Schritte

• Übersicht über den generischen Konnektor für Webdienste
• Installieren des Webdienstkonfigurationstools
• SOAP-Bereitstellungshandbuch
• REST-Bereitstellungshandbuch
• Webdienst MA-Konfiguration