Przewodnik przepływu pracy łącznika usługi internetowej dla przykładowego interfejsu API REST

W tym artykule opisano wdrażanie przykładowego interfejsu API REST, aby zapoznać się z narzędziem do konfiguracji usługi internetowej za pomocą internetowego źródła danych interfejsu API REST.

Wymagania wstępne

Do użycia przykładu wymagane są następujące wymagania wstępne:

• Narzędzie konfiguracji usługi internetowej jest zainstalowane.
• Przykładowa usługa źródła danych REST jest wdrażana. Pobierz i zainstaluj przykład z witryny (zobacz tutaj).

Uwaga

Dane JSON muszą zawierać pojedynczy obiekt z właściwością zawierającą tablicę.

{

"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":""}

]

}

Konfigurowanie odnajdywania projektu REST w narzędziu do konfiguracji usługi internetowej

W poniższych krokach pokazano, jak utworzyć nowy projekt dla źródła danych w narzędziu do konfiguracji usługi sieci Web.

1. Otwórz narzędzie konfiguracji usługi sieci Web. Spowoduje to otwarcie pustego projektu PROTOKOŁU SOAP.

   

2. Wybierz pozycję Plik>nowy>projekt REST.

   

3. Po lewej stronie wybierz pozycję Projekt REST , a następnie wybierz pozycję Dodaj.

   

4. Na następnej stronie podaj następujące informacje:

   • Nowa nazwa usługi internetowej
   • Adres (ścieżka adresu URL interfejsu API REST)
   • Przestrzeń nazw
   • Tryb zabezpieczeń (typ uwierzytelniania)

   

   Na poniższym ekranie przedstawiono przykłady dla następujących wartości:

   

   Dla trybu zabezpieczeń ustaw wartość Brak. Ustaw adres na przykładowy serwer JSON hostowany na platformie Azure.

5. Wybierz przycisk OK. Projekt REST wymieniony w narzędziu do konfiguracji usług sieci Web.

   

6. Następnym krokiem jest zdefiniowanie wywołania interfejsu API REST i tłumaczenie wywołania do wywołań programu Windows Communication Foundation (WCF).

   1. Rozwiń projekt REST i wybierz usługę RESTSAMPLE .

   2. Wybierz pozycję Dodaj. Zostanie wyświetlony monit o dodanie dwóch wartości:

      

      1. Wprowadź nazwę. Ten krok jest oznaczony jako 3 na zrzucie ekranu.
      2. Wprowadź adres. Ten krok jest oznaczony jako 4 na zrzucie ekranu.
      3. Wybierz przycisk OK. Zasób REST jest dodawany do opisu usługi RESTSAMPLE .

7. W polu Zasoby wybierz właśnie dodany zasób REST. Dodaj następującą metodę:

   

8. Wybierz metodę REST. Zwróć uwagę, że istnieje możliwość utworzenia wielu metod w tym samym zasobie i zdefiniowania zapytań przekazywanych podczas wykonywania.

9. W przypadku metody GETALL nie są wymagane żadne zapytania. Pozostaw wartości parametrów puste. Podczas eksportowania lub importowania interfejsu API REST należy zdefiniować przykładowe żądanie /lub odpowiedź w zależności od funkcji. Skopiuj i wklej zwracany kod JSON podczas przechodzenia do tego przykładu.

   

10. Wybierz pozycję Zapisz. Zapisz projekt w pliku C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions.

Uwaga

Po zapisaniu projektu zostanie wygenerowany plik WsConfig. Plik konfiguracji zawiera wiele plików zdefiniowanych wcześniej w przeglądzie usługi sieci Web.

Konfigurowanie typów obiektów w narzędziu konfiguracji usługi sieci Web

W poniższych krokach pokazano, jak skonfigurować typy obiektów dla źródła danych w narzędziu do konfiguracji usługi sieci Web.

1. Następnym krokiem jest zdefiniowanie schematu przestrzeni łącznika. Jest to osiągane przez utworzenie typu obiektu i zdefiniowanie ich typów obiektów. Kliknij pozycję Typy obiektów w okienku po lewej stronie i kliknij przycisk Dodaj . Spowoduje to otwarcie poniższego ekranu. Dodaj nowy typ obiektu i podaj nazwę. Kliknij przycisk OK .

   

2. Dodanie typu obiektu zawiera poniższy ekran.

   

3. Prawe okienko odpowiadające typowi obiektu umożliwia zachowanie atrybutów i ich właściwości dla wybranego typu obiektu. Kliknięcie przycisku Dodaj zawiera poniższy ekran, na którym można dodać atrybuty.

   

   

4. Poniższy ekran pojawia się po dodaniu wszystkich wymaganych atrybutów.

   

5. Typ obiektu i atrybuty po utworzeniu udostępnia puste przepływy pracy obsługujące operacje wykonywane w programie Microsoft Identity Manager (MIM).

Konfigurowanie przepływów pracy w narzędziu konfiguracji usługi internetowej

Następnym krokiem jest skonfigurowanie przepływów pracy dla typu obiektu. Pliki przepływu pracy to szereg działań używanych przez łącznik usług sieci Web w czasie wykonywania. Przepływy pracy są używane do implementowania odpowiedniej operacji programu MIM. Narzędzie konfiguracji usługi internetowej ułatwia tworzenie czterech różnych przepływów pracy:

• Importuj: zaimportuj dane ze źródła danych dla następujących dwóch typów przepływów pracy:

  • Pełny import: pełny import, który można skonfigurować.
  • Importowanie różnicowe: nieobsługiwane przez narzędzie do konfiguracji usługi sieci Web.

• Eksportowanie: eksportowanie danych z programu MIM do połączonego źródła danych. W przypadku operacji obsługiwane są następujące trzy akcje. Możesz skonfigurować te akcje na podstawie wymagań.

  • Dodaj
  • Usuń
  • Zamień

• Hasło: wykonaj zarządzanie hasłami dla użytkownika (typu obiektu). Dla tej operacji są dostępne dwie akcje:

  • Ustaw hasło
  • Zmień hasło

• Połączenie testowe: skonfiguruj przepływ pracy, aby sprawdzić, czy połączenie z serwerem źródła danych zostało pomyślnie nawiązane.

Uwaga

Możesz skonfigurować te przepływy pracy dla projektu lub pobrać projekt domyślny z Centrum pobierania Microsoft.

Projektant przepływów pracy

Projektant przepływu pracy otwiera obszar roboczy, aby skonfigurować przepływ pracy zgodnie z wymaganiami. Dla każdego typu obiektu (nowy /istniejący) narzędzie konfiguracji udostępnia węzły przepływów pracy obsługiwanych przez narzędzie.

Projektant przepływu pracy składa się z następujących elementów interfejsu użytkownika:

• Węzły w okienku po lewej stronie: ułatwiają wybór, który przepływ pracy chcesz zaprojektować.

• Centralny projektant przepływu pracy: w tym miejscu możesz usunąć działania związane z konfigurowaniem przepływów pracy. Aby wykonać różne operacje programu MIM (eksportowanie, importowanie, zarządzanie hasłami), można użyć standardowych i niestandardowych działań przepływu pracy programu .NET Workflow Framework 4. Narzędzie do konfiguracji usługi sieci Web używa standardowych i niestandardowych działań przepływu pracy. Aby uzyskać więcej informacji na temat standardowych działań, zobacz Używanie projektantów działań.

  • W centralnym projektancie przepływu pracy czerwony okrąg z wykrzyknikiem obok wszystkich działań wskazuje, że operacja została porzucona i nie jest zdefiniowana poprawnie i całkowicie. Umieść kursor na czerwonym kole, aby dowiedzieć się dokładnie o błędzie. Po poprawnym zdefiniowaniu działania czerwony okrąg zmieni się na żółty znacznik informacji.

  • W centralnym projektancie przepływu pracy żółty trójkąt obok dowolnego działania wskazuje, że działanie jest zdefiniowane, ale jest więcej, co można zrobić, aby ukończyć działanie. Umieść kursor nad żółtym trójkątem, aby wyświetlić więcej informacji.

• Przybornik: pakuje wszystkie narzędzia, w tym działania systemowe i niestandardowe oraz wstępnie zdefiniowane instrukcje, aby zaprojektować przepływ pracy. Aby uzyskać więcej informacji, zobacz Przybornik.

• Sekcje przybornika: Przybornik zawiera następujące sekcje i kategorie:

  • Opis: nagłówek przybornika. Jedna karta uzyskuje dostęp do przybornika i właściwości wybranego działania przepływu pracy.

  • Importowanie przepływu pracy: działania niestandardowe służące do konfigurowania przepływów pracy importu.

  • Eksportowanie przepływu pracy: działania niestandardowe służące do konfigurowania przepływów pracy eksportu.

  • Typowe: działania niestandardowe służące do konfigurowania dowolnego przepływu pracy.

  • Debugowanie: działania przepływu pracy systemu do debugowania zdefiniowane w przepływie pracy 4. Te działania umożliwiają śledzenie problemów dla przepływu pracy.

  • Instrukcje: Działania przepływu pracy systemu zdefiniowane w przepływie pracy 4. Aby uzyskać więcej informacji, zobacz Używanie projektantów działań.

• Właściwości: karta właściwości wyświetla właściwości określonego działania przepływu pracy, które jest porzucane w obszarze projektanta i wybrane. Rysunek po lewej stronie przedstawia właściwości działania Przypisywanie . Dla każdego działania właściwości różnią się i są używane podczas konfigurowania niestandardowego przepływu pracy. Ta karta umożliwia zdefiniowanie atrybutów wybranego narzędzia, które zostało porzucone do centralnego projektanta przepływu pracy. Aby uzyskać więcej informacji, zobacz Właściwości.

• Pasek zadań: Pasek zadań zawiera trzy elementy: Zmienne, Argumenty i Import. Te elementy są używane razem z działaniami przepływu pracy. Aby uzyskać więcej informacji, zobacz Wprowadzenie dewelopera do programu Windows Workflow Foundation (WF) na platformie .NET 4.

Konfigurowanie pełnego przepływu pracy importowania w narzędziu konfiguracji usługi internetowej

W poniższych krokach pokazano, jak skonfigurować pełne przepływy pracy importu dla interfejsu API REST przy użyciu narzędzia konfiguracji usługi internetowej.

Ostrzeżenie

Ten przykład tworzy tylko przepływ pracy. Mogą być wymagane modyfikacje przepływu pracy, takie jak użycie logiki niestandardowej w interfejsie API.

1. Wybierz przepływ pracy Pełnego importu, aby skonfigurować. Argumenty i importy są już zdefiniowane i są specyficzne dla działań. Aby uzyskać więcej informacji, zobacz następujące ekrany.

   

   

   Po zmianie konfiguracji wywołań należy zmienić nazwy atrybutów, które zmieniają się lub dodają przestrzeń nazw do zmiennych odwołujących się do struktury zwracanej interfejsu API i typów obiektów odwołujących się do starej przestrzeni nazw. Przybornik w okienku po prawej stronie zawiera wszystkie niestandardowe działania specyficzne dla przepływu pracy wymagane do konfiguracji. Przypisz wartości do zmiennych, które będą używane dla logiki. Przejdź do dolnej sekcji centralnego projektanta przepływu pracy i zadeklaruj zmienne. Zmienne są deklarowane w następnym kroku.

2. Dodaj działanie Sekwencja. Przeciągnij projektanta działań sekwencji z przybornika i upuść go na powierzchni projektanta przepływu pracy systemu Windows. Zapoznaj się z następującymi ekranami. Działanie Sequence zawiera uporządkowaną kolekcję działań podrzędnych, które są wykonywane w kolejności.

   

3. Aby dodać zmienną, znajdź pozycję Utwórz zmienną. Wpisz wsResponse jako nazwę, wybierz listę rozwijaną Typ zmiennej , a następnie wybierz pozycję Przeglądaj dla typów. Zostanie wyświetlone okno dialogowe. Wybierz wygenerowaną>odpowiedźGETALL>. Pozostaw niezaznaczone wartości Zakres i Domyślne . Możesz też ustawić te wartości przy użyciu widoku Właściwości .

   

4. Przeciągnij jeszcze jednego projektanta działań sekwencji z przybornika w ramach już dodanego działania sekwencji.

5. Przeciągnij element WebServiceCallActivity przedstawiony w obszarze Wspólne. To działanie służy do wywoływania operacji usługi sieci Web dostępnej po odnalezieniu. Jest to działanie niestandardowe i jest wspólne w różnych scenariuszach operacji.

   

   Aby użyć operacji usługi sieci Web, ustaw następujące właściwości:

   • Nazwa usługi: wprowadź nazwę usługi internetowej.

   • Nazwa punktu końcowego: określ nazwę punktu końcowego dla wybranej usługi.

   • Nazwa operacji: określ odpowiednią operację dla usługi.

   • Argument: wybierz pozycję Argumenty. W następnym oknie dialogowym przypisz wartości argumentów, jak pokazano na poniższym rysunku:

     

     Ważne

     Nie zmieniaj nazwy, kierunku ani typu argumentu przy użyciu tego okna dialogowego. Jeśli którakolwiek z tych wartości zostanie zmieniona, działanie stanie się nieprawidłowe. Ustaw tylko wartość argumentu. Jak pokazano na tym rysunku, wartość wsResponse jest ustawiona.

6. Dodaj działanie ForEach tuż poniżej elementu WebServiceCallActivity. To działanie służy do iterowania wszystkich atrybutów (zarówno kotwic, jak i niekotwiców) typu obiektu. Przeciągając to działanie do powierzchni Projektanta przepływu pracy, automatycznie wylicza wszystkie nazwy atrybutów dla obiektu. Ustaw wymagane wartości zgodnie z następującym ekranem:

   

7. W niektórych przypadkach może być konieczne otwarcie generated.dll znajdującej się w pliku WsConfig. Skopiuj ten plik WsConfig i zmień jego nazwę na rozszerzenie .zip. Otwórz i wyodrębnij generated.dll przy użyciu preferowanego narzędzia odblaskowego platformy .NET.

   

8. Zidentyfikuj publiczną przestrzeń nazw elementu EmployeeList:

   

   Następnie dodaj ten powrót do przepływu pracy ForEach:

   

9. Przeciągnij działanie CreateCSEntryChangeScope w treści ForEach . To działanie służy do tworzenia wystąpienia obiektu CSEntryChange w domenie przepływu pracy dla każdego odpowiedniego rekordu podczas pobierania danych z docelowego źródła danych. Przeciąganie tego działania zapewnia poniższy ekran. Działania CreateAnchorAttribute są automatycznie dziedziczone. Zaktualizuj wartość DN na preferowaną nazwę domeny.

   

   Uwaga

   Wartości kotwicy i nazwy obiektów różnią się w zależności od uwidocznionej usługi internetowej. Na rysunku przedstawiono przykład.

10. Przeciągnij działanie CreateAttributeChange poniżej działania CreateAnchorAttribute . Liczba działań do przeciągania jest równa liczbie atrybutów niekotwiczenia. Aby uzyskać informacje, zobacz poniższą ilustrację.

    

    Uwaga

    Aby użyć tego działania, wybierz i przypisz odpowiednie pola z listy rozwijanej i przypisz wartości. W przypadku atrybutów wielowartościowych usuń wiele działań CreateValueChangeActivity wewnątrz działania CreateAttributeChangeActivity .

11. Zapisz ten projekt w lokalizacji %FIM_INSTALL_FOLDER%\Synchronization Service\Extensions. Następnie skonfiguruj agenta zarządzania zgodnie z opisem w konfiguracji programu MA usługi sieci Web.

    

    Domyślne projekty powinny być pobierane i zapisywane w lokalizacji %FIM_INSTALL_DIR\2010\Synchronization Service\Extensions w systemie docelowym. Projekty są następnie widoczne w kreatorze łącznika usługi internetowej.

    Podczas uruchamiania pliku wykonywalnego zostanie wyświetlony monit o określenie lokalizacji instalacji. Wprowadź lokalizację zapisywania.

    Ważne

    Plik projektu można zapisać i otworzyć z dowolnej lokalizacji (z odpowiednimi uprawnieniami dostępu do jego funkcji wykonawczej). W kreatorze łącznika usługi sieci Web dostępnym za pośrednictwem interfejsu użytkownika synchronizacji programu MIM można wybrać tylko pliki projektów, które są zapisywane Synchronization Service\Extension w folderze.

    Użytkownik, który korzysta z narzędzia do konfiguracji usługi sieci Web, wymaga następujących uprawnień:

    • Pełna kontrola w folderze Rozszerzenia usługi synchronizacji.
    • Odczyt dostępu do klucza HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters rejestru, za pomocą którego znajduje się ścieżka folderu Extension.

Następne kroki

• Omówienie ogólnego łącznika usługi internetowej
• Instalowanie narzędzia konfiguracji usługi sieci Web
• Przewodnik wdrażania protokołu SOAP
• Przewodnik wdrażania REST
• Konfiguracja ma usługi sieci Web