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

W tym artykule opisano wdrażanie przykładowego interfejsu API REST, aby zapoznać się z narzędziem konfiguracji usługi internetowej za pomocą internetowego źródła 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 z witryny (zobacz tutaj).

{

"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 projektów REST w narzędziu konfiguracji usługi internetowej

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

1. Otwórz narzędzie konfiguracji usługi sieci Web. Otwiera pusty projekt SOAP.

   

2. Wybierz 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)
   • Namespace
   • Tryb zabezpieczeń (typ uwierzytelniania)

   

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

   

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

5. Kliknij przycisk OK. Projekt REST wymieniony w narzędziu konfiguracji usług internetowych.

   

6. Następnym krokiem jest zdefiniowanie wywołania interfejsu API REST i przekładanie tego wywołania na wywołania programu Windows Communication Foundation (WCF).

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

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

      

      1. Wprowadź nazwę. Krok ten jest oznaczony jako 3 na zrzucie ekranu.
      2. Wprowadź adres. Ten krok jest oznaczony jako 4 na zrzucie ekranu.
      3. Kliknij 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. Zauważ, ż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 puste wartości parametrów. 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 Zapisz. Zapisz projekt w pliku C:\Program Files\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions.

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 konfiguracji usługi internetowej.

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 powoduje pojawienie się poniższego ekranu.

   

3. Okienko po prawej stronie 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. Po dodaniu wszystkich wymaganych atrybutów zostanie wyświetlony poniższy ekran.

   

5. Typ obiektu i atrybuty po utworzeniu udostępniają puste szablony przepływów pracy, które obsługują 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 robocze to seria działań wykonywanych przez Web Services Connector podczas działania. 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: nie jest obsługiwane przez narzędzie konfiguracyjne usługi sieciowej.

• Eksportowanie: eksportowanie danych z programu MIM do połączonego źródła danych. Następujące trzy działania są obsługiwane dla tej operacji. Te akcje można skonfigurować na podstawie wymagań.

  • Dodaj
  • Usuń
  • Zamień

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

  • Ustawianie hasła
  • 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.

Projektant przepływu pracy

Projektant przepływu pracy otwiera obszar roboczy, aby skonfigurować przepływ pracy zgodnie z wymaganiami. W przypadku każdego typu obiektu (nowy /existing) narzędzie konfiguracji udostępnia węzły dla 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 służące do konfigurowania 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 Korzystanie z projektantów działań.

  • W centralnym projektancie przepływu pracy czerwony okrąg z wykrzyknikiem obok dowolnego działania wskazuje, że operacja została porzucona i nie jest zdefiniowana poprawnie i całkowicie. Zatrzymaj wskaźnik myszy na czerwonym okręgu, aby dowiedzieć się, jaki jest dokładny błąd. 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 że można zrobić więcej, aby ukończyć to działanie. Zatrzymaj wskaźnik myszy na żółtym trójkącie, aby wyświetlić więcej informacji.

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

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

  • Opis: nagłówek tego przybornika. Jedna karta umożliwia dostęp do przybornika i właściwości wybranej aktywności przepływu pracy.

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

  • Przepływ pracy eksportu: działania niestandardowe do konfigurowania przepływu 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.

  • Oświadczenia: Systemowe działania przepływu pracy zdefiniowane w Przepływie pracy 4. Aby uzyskać więcej informacji, zobacz Używanie projektantów działań.

• Właściwości: na karcie Właściwości są wyświetlane właściwości określonego działania przepływu pracy, które jest umieszczone w obszarze projektanta i wybrane. Na rysunku po lewej stronie przedstawiono właściwości aktywności Przypisywania. 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 umieszczone w centralnym projektancie przepływu pracy. Aby uzyskać więcej informacji, zobacz Właściwości.

• Pasek zadań: Pasek zadań zawiera trzy elementy: Zmienne, Argumenty i 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 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.

1. Wybierz przepływ pracy pełnego importowania, 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 przekonfigurowaniu wywołań, należy zmienić nazwy atrybutów, które się zmieniają, lub dodać przestrzeń nazw do zmiennych odwołujących się do struktury zwracanej przez API oraz do typów obiektów, które odnoszą się do starej przestrzeni nazw. Przybornik w okienku po prawej stronie zawiera wszystkie działania specyficzne dla przepływu pracy potrzebne 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 aktywności Sequence z Toolbox i upuść go na powierzchnię Windows Workflow Designer. Zapoznaj się z następującymi ekranami. Działanie Sekwencja 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 Name, wybierz rozwijane menu typu Zmienna, a następnie wybierz Przeglądaj typy. Zostanie wyświetlone okno dialogowe. Wybierz wygenerowaną>odpowiedź>. Pozostaw niezaznaczone wartości Zakres i Domyślne . Alternatywnie ustaw te wartości przy użyciu widoku Właściwości .

   

4. Przeciągnij jeszcze jedną aktywność projektanta Sequence z Przybornika w ramach już dodanej aktywności Sequence.

5. Przeciągnij element WebServiceCallActivity przedstawiony w sekcji Wspólne. To działanie służy do wywoływania operacji usługi sieci Web dostępnej po procesie Discovery. Jest to działanie niestandardowe i jest typowe 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ższej ilustracji:

     

     Ważne

     Nie zmieniaj nazwy, kierunku lub 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 WebServiceCallActivity. To działanie służy do iterowania wszystkich atrybutów (zarówno kotwiczących, jak i niekotwiczących) typu obiektu. Podczas przeciągania tej aktywności na powierzchnię Projektanta Przepływu Pracy, automatycznie zostaną wyliczone 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 znajdującego się w pliku WsConfig elementu generated.dll. Skopiuj ten plik WsConfig i zmień jego nazwę na rozszerzenie .zip. Otwórz i wyodrębnij generated.dll przy użyciu preferowanego narzędzia refleksora .NET.

   

8. Zidentyfikuj publiczną przestrzeń nazw dla elementu EmployeeList:

   

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

   

9. Przeciągnij działanie CreateCSEntryChangeScope w ciele ForEach. To działanie służy do tworzenia wystąpienia obiektu CSEntryChange w domenie przepływu pracy dla każdego rekordu podczas pobierania danych z docelowego źródła danych. Przeciągnięcie tego działania powoduje wyświetlenie ekranu poniżej. 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 udostępnionej 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, które nie są zakotwiczone. Zobacz poniższą ilustrację, aby uzyskać informacje referencyjne.

    

    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 narzędzia MA usługi sieci Web.

    

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

    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, uzyskiwanym za pośrednictwem interfejsu użytkownika synchronizacji programu MIM, można wybrać tylko pliki projektu, które są zapisane w folderze Synchronization Service\Extension.

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

    • Pełna kontrola nad folderem rozszerzenia usługi synchronizacji.
    • Dostęp do odczytu klucza rejestru HKLM\System\CurrentControlSet\Services\FIMSynchronizationService\Parameters, który służy do określenia ścieżki 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 usługi sieci Web