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

W tym artykule o mowa o wdrożeniu przykładowego interfejsu API REST, który zawiera informacje na temat narzędzia konfiguracji usługi internetowej z internetowym źródłem danych interfejsu API REST.

Wymagania wstępne

Do korzystania z przykładu wymagane są następujące wymagania wstępne:

  • Narzędzie konfiguracji usługi sieci Web jest zainstalowane.
  • Przykładowa usługa źródła danych REST jest wdrażana. Pobierz i zainstaluj przykład ze strony (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 konfiguracji usługi internetowej

Poniższe kroki pokazują, jak utworzyć nowy projekt dla źródła danych w narzędziu konfiguracji usługi sieci Web.

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

    Narzędzie konfiguracji usługi sieci Web

  2. Wybierz pozycję PlikNowy ProjectREST.

    Tworzenie nowego projektu REST

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

    Wybieranie projektu REST

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

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

    Usługa REST

    Na poniższym ekranie przedstawiono przykłady dla tych wartości:

    Przykładowe wartości dla usługi REST

    Ustaw tryb zabezpieczeń nawartość Brak. Ustaw adres na przykładowy serwer JSON hostowany na platformie Azure.

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

    Projekt REST w narzędziu do konfiguracji usług sieci Web

  6. Następnym krokiem jest zdefiniowanie wywołania interfejsu API REST i przetłumaczenie wywołania na wywołania Windows Communication Foundation (WCF).

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

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

      Wprowadzanie wartości dla usługi REST

      1. Wprowadź nazwę. Ten krok jest oznaczony na zrzucie ekranu etykietą 3.
      2. Wprowadź adres. Ten krok jest oznaczony na zrzucie ekranu etykietą 4.
      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ę:

    Dodawanie metody REST do zasobu

  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 kod JSON podczas przechodzenia do tego przykładu.

  10. Wybierz pozycję Zapisz. Zapisz projekt w 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, które są zdefiniowane wcześniej w przeglądzie usługi sieci Web.

Konfigurowanie typów obiektów w narzędziu do konfiguracji usługi internetowej

Poniższe kroki pokazują, jak skonfigurować typy obiektów dla źródła danych w narzędziu 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 zapewnia 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 powoduje dodanie atrybutów na poniższym ekranie.

  4. Po dodaniu wszystkich wymaganych atrybutów zostanie wyświetlony poniższy ekran.

  5. Typ obiektu i atrybuty po utworzeniu zapewniają puste przepływy pracy, które są dostosowane do operacji wykonywanych w Microsoft Identity Manager (MIM).

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

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

  • Importuj: importuj 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: nie jest obsługiwane przez narzędzie konfiguracji usługi sieci Web.
  • Eksportuj: eksportuj dane MIM do połączonego źródła danych. Następujące trzy akcje są obsługiwane dla operacji. Te akcje można skonfigurować w zależności od wymagań.

    • Dodaj
    • Usuń
    • Zamień
  • Hasło: wykonaj zarządzanie hasłami użytkownika (typ obiektu). Dla tej operacji są dostępne dwie akcje:

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

Uwaga

Te przepływy pracy można skonfigurować dla projektu lub pobrać projekt domyślny z Centrum pobierania Microsoft.

Projektant przepływów pracy

W Projektant przepływu pracy zostanie otwarty obszar roboczy w celu skonfigurowania przepływu pracy zgodnie z wymaganiami. Dla każdego typu obiektu (nowy /existing) narzędzie konfiguracji udostępnia węzły dla przepływów pracy, które są obsługiwane przez narzędzie.

Projektant przepływów pracy

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

  • Węzły w okienku polewej stronie: ułatwiają wybór przepływu pracy, który ma zostać zaprojektowyny.

  • Centrum Projektant przepływu pracy:w tym miejscu można usunąć działania służące do konfigurowania przepływów pracy. Aby wykonać różne 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 Konfiguracja 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 środkowym Projektant przepływu pracy czerwone kółko ze znakiem wykrzyknika obok dowolnego działania wskazuje, że operacja została przerwana i nie jest zdefiniowana poprawnie i całkowicie. Umieść kursor nad czerwonym okręgiem, aby dowiedzieć się, jak dokładnie wystąpił błąd. Po prawidłowym zdefiniowanym działaniu czerwony okrąg zmieni się na żółty znacznik informacji.

    • W środkowym Projektant przepływu pracy informacja o żółtym trójkątze obok dowolnego działania wskazuje, że działanie jest zdefiniowane, ale istnieje więcej czynności, które można wykonać w celu ukończenia działania. 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 ma 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ływupracy: niestandardowe działania służące do konfigurowania przepływów pracy importu.

    • Eksportowanie przepływupracy: niestandardowe działania do konfigurowania przepływów pracy eksportu.

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

    • Debugowanie:Działania przepływu pracy systemu na potrzeby 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 zawiera 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 Przypisz. 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 projektanta centralnego przepływu pracy. Aby uzyskać więcej informacji, zobacz Właściwości.

  • Pasek zadań: Pasek zadań zawiera trzy elementy: zmienne,argumentyi importy. 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 przepływu pracy pełnego importu w narzędziu konfiguracji usługi sieci Web

Poniższe kroki pokazują, jak skonfigurować przepływy pracy pełnego importu dla interfejsu API REST przy użyciu narzędzia konfiguracji usługi sieci Web.

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łny import do skonfigurowania. Argumenty i importy są już zdefiniowane i są specyficzne dla działań. Aby uzyskać więcej informacji, zobacz następujące ekrany.

    Argumenty przepływu pracy pełnego importu

    Zaimportowane przestrzenie nazw

    Po zmianie konfiguracji wywołań należy zmienić nazwy atrybutów, które zmieniają lub dodają przestrzeń nazw do zmiennych, które odwołują się do zwracanej struktury interfejsu API i typów obiektów, które odwołują 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ą dla logiki. Przejdź do dolnej sekcji centralnego projektanta przepływu pracy i zadeklaruj zmienne. Zmienne są deklarowane w następnym kroku.

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

    Działanie sekwencji

  3. Aby dodać zmienną, znajdź pozycję Utwórz zmienną. Wpisz wsResponse w nazwa , wybierz typ zmiennej listy rozwijanej, a następnie wybierz Przeglądaj dla typów. Zostanie wyświetlone okno dialogowe. Wybierz wygenerowanąodpowiedź GETALL. Nie wybierajwartości Zakres i Domyślne. Alternatywnie możesz ustawić te wartości przy użyciu widoku Właściwości.

    Odpowiedź domyślna

  4. Przeciągnij jeszcze jednego projektanta działań Sequence z przybornika do już dodanego działania Sequence.

  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, które jest typowe w różnych scenariuszach operacji.

    Operacja nazwy usługi

    Aby użyć operacji usługi internetowej, 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ższej ilustracji:

      Przypisywanie argumentów

      Ważne

      Nie zmieniaj nazwy,kierunkuani typu argumentu przy użyciu tego okna dialogowego. Jeśli dowolna z tych wartości zostanie zmieniona, działanie stanie się nieprawidłowe. Ustaw tylko wartość dla argumentu . Jak pokazano na tym rysunku, ustawiono wartość wsResponse.

  6. Dodaj działanie ForEach tuż poniżej tabeli WebServiceCallActivity. To działanie służy do iterować po wszystkich atrybutach (zarówno kotwicach, jak i innych niż kotwice) typu obiektu. Przeciągając to działanie na powierzchnię Projektant przepływu pracy, automatycznie wylicza wszystkie nazwy atrybutów obiektu. Ustaw wymagane wartości zgodnie z poniższym ekranem:

    Działanie wywołania usługi internetowej

  7. W niektórych przypadkach może być konieczne otwarcie generated.dll, która znajduje się w pliku WsConfig. Skopiuj ten plik WsConfig i zmień jego nazwę na .zip rozszerzenia. Otwórz i wyodrębnij generated.dll za pomocą preferowanego narzędzia .NET reflector.

    Plik konfiguracji

  8. Zidentyfikuj publiczną przestrzeń nazw elementu EmployeeList:

    Kod listy pracowników

    Następnie dodaj ten zwrot do przepływu pracy ForEach:

    Dodawanie listy pracowników 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ągnięcie tego działania zapewnia poniższy ekran. Działania CreateAnchorAttribute są automatycznie dziedziczone. Zaktualizuj wartość DN na preferowaną nazwę domeny.

    Tworzenie działania zmiany zakresu wpisu CS

    Uwaga

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

  10. Przeciągnij działanie CreateAttributeChange poniżej działania CreateAnchorAttribute. Liczba działań do przeciągnięcia jest równa liczbie atrybutów innych niż zakotwiczenia. Zobacz poniższy rysunek, aby uzyskać informacje referencyjne.

    Tworzenie kotwicy

    Uwaga

    Aby użyć tego działania, wybierz i przypisz odpowiednie pola z listy rozwijanej, a następnie przypisz wartości. W przypadku atrybutów wielowartościowych należy usunąć 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 ma usługi sieci Web.

    Zapisywanie projektu REST

    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 jego wykonawcy). W kreatorze łącznika usługi internetowej można wybrać tylko pliki projektu zapisane w folderze, do których dostęp jest uzyskiwany za Synchronization Service\Extension pośrednictwem interfejsu MIM synchronizacji.

    Użytkownik, który uruchamia narzędzie konfiguracji usługi sieci Web, wymaga następujących uprawnień:

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

Następne kroki