Ogólny łącznik REST API
Dowiedz się, jak łatwo nawiązać połączenie i wchodzić w interakcje z wieloma REST API przy użyciu konfigurowalnego i wszechstronnego łącznika ogólnego interfejsu REST API .
Ogólny łącznik REST API
Dowiedz się, jak łatwo nawiązać połączenie i wchodzić w interakcje z wieloma REST API przy użyciu konfigurowalnego i wszechstronnego łącznika ogólnego interfejsu REST API .
Ogólny łącznik REST API
Ogólny łącznik REST API jest częścią natywnych łączników Pro Engine i w tej pierwszej wersji służy do zapisywania danych w rozwiązaniach firm trzecich oferujących REST API . Można go używać we wszystkich rozwiązaniach Matrix42 Core , Pro and IGA korzystających z zarządzania łącznikami (EPE).
W wersji 2025.2 wprowadzono nowy łącznik ogólnego REST API z zadaniami opartymi na zdarzeniach.
Wersja 2025.3 wprowadziła obsługę zadań planowanych dla tego ogólnego łącznika REST API .
Polityka uczciwego użytkowania
Złącze może być używane bez ograniczeń w normalnych warunkach pracy. Jeśli jednak jego użycie spowoduje znaczny wzrost obciążenia, wymagającego dodatkowych zasobów chmury (np. pamięci lub mocy obliczeniowej), mogą zostać naliczone dodatkowe opłaty.
Aby używać tego łącznika do tworzenia, aktualizowania lub usuwania kont użytkowników lub obiektów grupowych, wymagana jest aktywna licencja IGA .
Ogólny łącznik interfejsu REST API wymaga konfiguracji zgodnie z przypadkiem użycia klienta. Zasadniczo konfiguracja składa się z trzech kroków:
- Konfiguruj łącznik – umożliwia łącznikowi nawiązanie połączenia z rozwiązaniem oferującym REST API
- Konfiguruj zadanie zdarzeń — używane, gdy dane są zapisywane (wywołania oparte na zdarzeniach z węzła koordynacji przepływu pracy) do rozwiązania oferującego REST API
- Konfigurowanie węzłów koordynacji przepływu pracy w celu korzystania z zadań opartych na zdarzeniach
Ogólne funkcjonalności
Łączniki – funkcjonalności ogólne
Łączniki – funkcjonalności ogólne
W tym artykule opisano ogólne funkcje zarządzania natywnymi konektorami w rozwiązaniu. Wszystkimi natywnymi konektorami zarządza się z poziomu tego samego interfejsu użytkownika.
Należy zwrócić uwagę, że dla każdego złącza istnieją osobne opisy, w których szczegółowo opisano konkretne funkcjonalności złącza i instrukcje konfiguracji.
Aby uzyskać dostęp do zarządzania konektorami, użytkownik musi posiadać uprawnienia administratora do konfiguracji platformy klienta. Po prawidłowym przyznaniu dostępu, karta konektora będzie widoczna i użytkownik będzie mógł zarządzać konektorami.
Menu lewe
Zarządzanie złączami jest podzielone na cztery zakładki:
- Przegląd – do tworzenia i aktualizowania natywnych łączników. Użytkownik z uprawnieniami administratora może zobaczyć ich status, typ oraz liczbę zaplanowanych zadań lub zdarzeń z nimi powiązanych.
- Uwierzytelnianie – do tworzenia i aktualizowania zadań uwierzytelniania. Pro uwierzytelniania jest niezbędne, aby Secure Access mógł zdefiniować, którzy użytkownicy końcowi Klienta mają dostęp do strony logowania Matrix42 Core , Pro and IGA .
- Dzienniki - do pobierania dzienników Native Connector i Secure Access z interfejsu użytkownika.
- Ustawienia – ogólne ustawienia dla łączników natywnych i Secure Access , obejmujące typ środowiska do rejestrowania i monitorowania.
Karta przeglądu złączy
Na stronie przeglądu użytkownik może łatwo i szybko sprawdzić status wszystkich złączy.
Górny pasek:
- Status łączników natywnych (EPE)
- Zielony tekst oznacza, że Native Connectors jest online. Wszystkie potrzebne usługi są aktywne i działają.
- Czerwony tekst oznacza, że wystąpił problem z Native Connectors, wszystkie usługi nie są uruchomione.
- Status Secure Access ( ESA )
- Zielony tekst oznacza, że Secure Access jest online. Wszystkie potrzebne usługi są uruchomione i działają.
- Czerwony tekst oznacza, że wystąpił problem z Secure Access , żadna usługa nie jest uruchomiona.
- Numer wersji łączników natywnych wyświetlany jest w prawym górnym rogu
Górny pasek widoku listy:
- Nowy łącznik – otwiera nowe okno umożliwiające dodanie i skonfigurowanie nowego łącznika
- Usuń łącznik(i) — odniesienia do przepływu pracy zostaną obliczone i pojawi się okno dialogowe z prośbą o potwierdzenie usunięcia (należy pamiętać, że obliczanie odniesień może potrwać kilka sekund)
- Eksport – Administrator może wyeksportować jeden lub więcej konektorów (i zadań) ze środowiska. Zwykle używane do eksportowania konektorów i konektorów (i zadań) z testów do produkcji. Poufne informacje o konektorach natywnych są chronione hasłem.
- Import – Administrator może zaimportować jeden lub więcej konektorów (i zadań) do środowiska. Zazwyczaj używane do importowania konektorów (i zadań) z testów do produkcji.
- Administrator nie może importować ze starego interfejsu użytkownika EPE (starszego niż 2024.1) do nowego. Środowiska źródłowe i docelowe muszą mieć tę samą wersję.
- Import nie powiedzie się, jeśli konfiguracja (szablony, atrybuty) będzie inna – na przykład gdy brakuje jakiegoś atrybutu
- Jeśli importujesz coś z tymi samymi szczegółami łącznika, zostanie to scalone w ramach istniejącego łącznika
- Odśwież — administrator może odświeżyć widok łączników, klikając przycisk .
Widok listy w celu przeglądu,
- Wybierz złącze(a) — wybierz jedno złącze, klikając pole wyboru przed rzędem złącza lub klikając pole wyboru w rzędzie nagłówka, co spowoduje wybranie wszystkich złączy
- Identyfikator – automatycznie generowany, unikalny identyfikator łącznika. Nie można go edytować ani zmieniać.
- Status – wskazuje status zaplanowanego zadania
-
Zielony znacznik wyboru – zadanie zostało wykonane bez żadnych błędów
-
Czerwony krzyżyk – zadanie zostało wykonane, ale wystąpiły błędy
-
Szary zegar – zadanie nie zostało jeszcze wykonane, oczekiwanie na zaplanowanie -
Pomarańczowy - jedno z zadań ma problem
- Brak wartości — brak zaplanowanego zadania
-
- Nazwa – nazwa łącznika dodana do ustawień łącznika. Unikalna nazwa łącznika przechowującego konfigurację dla jednego źródła danych.
- Typ – wskazuje system docelowy/źródłowy
- Zaplanowane – informuje o liczbie skonfigurowanych zaplanowanych zadań
- Wydarzenie – informuje o liczbie skonfigurowanych zadań zdarzeń
- Zarządzać
- Ikona pióra – otwiera ustawienia łącznika (dwukrotne kliknięcie rzędu łączników również otwiera ustawienia)
- Ikona papieru - kopiuje złącze
- Zatrzymaj – odniesienia do przepływu pracy są obliczane i pojawia się okno dialogowe z prośbą o potwierdzenie usunięcia
- Wyszukiwanie – Użytkownik może wyszukiwać złącze, wpisując termin wyszukiwania w odpowiednim polu. Można wyszukiwać w polach Identyfikator, Status, Nazwa, Typ, Zaplanowane i Zdarzenie.
Informacje o zaplanowanym zadaniu (kliknij strzałkę z przodu łącznika)
Po kliknięciu strzałki na początku wiersza łącznika wyświetlane są wszystkie powiązane zadania zaplanowane i zdarzenia
Górny pasek zadań zaplanowanych
- Nowe zadanie – otwiera stronę konfiguracji nowego zadania
- Usuń zadanie(a) – usuwa wybrane zadanie(a) z systemu i nie będzie można ich już odzyskać.
- Odśwież – odśwież widok zadań opartych na harmonogramie
- Szukaj - użytkownik może wyszukiwać zadania, wpisując termin wyszukiwania w odpowiednim polu, aby określić identyfikator, nazwę, włączenie, status wyodrębnienia/załadowania.
Widok listy zaplanowanych zadań
- Wybierz zadanie(a) - Wybierz zadanie, które chcesz usunąć, z widoku listy, zaznaczając je.
- Id – unikalny identyfikator zadania. Generowany automatycznie i nie można go zmienić.
- Nazwa - Nazwa zadania dodana do ustawień zadania, unikalna nazwa zadania.
- Włączone – wyświetla, czy zadanie jest zaplanowane, czy nie
-
Zielony znacznik wyboru – zadanie jest zaplanowane
-
Czerwony krzyżyk – zadanie nie jest zaplanowane
-
- Status ekstrakcji – wyświetla status ekstrakcji danych z docelowego katalogu/systemu
- Zielony znacznik wyboru – dane zostały pomyślnie wyodrębnione
- Czerwony krzyżyk – dane zostały wyodrębnione z błędem(ami) lub wyodrębnienie nie powiodło się
-
Zegar - Zadanie oczekuje na wykonanie
-
- Status ładowania — wyświetla status eksportu danych z pliku JSON do rozwiązania klienta
- Zielony znacznik wyboru – dane zostały pomyślnie zaimportowane do rozwiązania klienta
-
Czerwony krzyżyk – dane zostały zaimportowane z błędem(ami) lub import się nie powiódł
-
- Zarządzać
- Ikona pióra – otwiera ustawienia zadania w osobnym oknie (dwukrotne kliknięcie wiersza zadania również otwiera ustawienia zadania)
- Ikona papieru – kopiuje zadanie
- Ikona zegara – otwiera widok historii zadań
- Zatrzymaj - usuń zadanie, otwiera się okno pop-up z potwierdzeniem usunięcia
Widok historii zaplanowanych zadań
Po kliknięciu ikony zegara w wierszu zaplanowanego zadania zostanie wyświetlona historia harmonogramu.
Górny pasek historii wyświetleń
- Odśwież – odświeża status zaplanowanego zadania. Nie ma to wpływu na zadanie, aktualizuje jedynie interfejs użytkownika, aby wyświetlić najnowsze informacje o uruchomieniu zadania.
Widok listy dla historii zaplanowanych zadań
- Kolor wiersza wskazuje status
- Zielony – zadanie wykonane pomyślnie
- Czerwony – wystąpił błąd podczas wykonywania
-
- Identyfikator wykonania – unikalny identyfikator wiersza zaplanowanego zadania
- Planowany czas wyodrębniania – kiedy planowane jest następne wyodrębnianie z katalogu/aplikacji
- Czas zakończenia ekstrakcji – kiedy ekstrakcja została ukończona
- Status ekstrakcji – status pobierania danych z katalogu/aplikacji
- Czas rozpoczęcia ładowania – kiedy planowane jest kolejne ładowanie dla klientów
- Czas ukończenia ładowania – kiedy ładowanie zostało ukończone
- Status ładowania – status ładowania informacji do rozwiązania klienta
Widok listy dla statusu zaplanowanego zadania
- Rzeczywisty czas rozpoczęcia – znacznik czasu rzeczywistego rozpoczęcia
- Plik użytkownika – plik JSON zawierający informacje o użytkowniku odczytane z katalogu/aplikacji
- Plik grupy – plik JSON zawierający informacje o grupie odczytane z katalogu/aplikacji
- Plik ogólny — plik JSON zawierający ogólne informacje odczytane z katalogu/aplikacji
- Wyodrębnij informacje – szczegółowe informacje o odczycie informacji z katalogu/aplikacji
- Informacje o załadowaniu - szczegółowe informacje o załadowaniu informacji do klientów Matrix42 Core , Pro and IGA
Okno edycji zaplanowanego zadania
Konfigurację zadania zaplanowanego można otworzyć, klikając ikonę pióra lub klikając dwukrotnie wiersz zadania.
Menu po lewej stronie oraz atrybuty różnią się w zależności od wybranych opcji, dlatego bardziej szczegółowe instrukcje dotyczące edycji zadań można znaleźć w opisie łącznika. Istnieją jednak wspólne funkcjonalności dla wszystkich zaplanowanych zadań, które opisano poniżej.
Zapisywanie zadania
Jeśli w zadaniu brakuje obowiązkowych informacji, najechanie kursorem myszy na przycisk zapisywania pokaże, które atrybuty są nadal puste.
Górny pasek do edycji zaplanowanego zadania
- Uruchom zadanie ręcznie — administrator może uruchomić zadanie ręcznie poza zdefiniowanym harmonogramem
- Zatrzymaj zadanie – administrator może zatrzymać aktualnie uruchomione zadanie zaplanowane. Zadanie zostanie zatrzymane, a jego status zmieni się na zatrzymany. Zadanie będzie w tym stanie czekać do następnego momentu.
- Wyczyść pamięć podręczną danych – pamięć podręczna danych dla następnego uruchomienia użytkowników i grup zostanie wyczyszczona. Oznacza to, że następne uruchomienie zostanie wykonane tak samo jak pierwsze.
- Domyślnie pamięć podręczną czyścimy codziennie o godzinie 00:00 UTC
- Jeśli chcesz wyczyścić pamięć podręczną w innym czasie, musisz określić inną wartość w pliku hosta „custom.properties”.
- Pamięć podręczna EPE jest również czyszczona po ponownym uruchomieniu EPE, po ponownym uruchomieniu całego środowiska zmieniane są mapowania EPE
Informacje o zadaniu wydarzenia
Po kliknięciu strzałki na początku wiersza łącznika wyświetlane są wszystkie powiązane zadania zaplanowane i zdarzenia
Górny pasek zadań zdarzeń
- Nowe zadanie – otwiera stronę konfiguracji dla nowego zadania zdarzenia
- Usuń zadanie(a) – usuwa wybrane zadanie(a), pojawia się okno pop-up z prośbą o potwierdzenie usunięcia
- Odśwież – odświeża widok zadań zdarzeń
- Pokaż odwołania do przepływów pracy – oblicza relacje i statusy przepływów pracy związane z zadaniami. Jest to bardzo przydatne, jeśli nie wiesz, z których przepływów pracy pochodzą zadania oparte na zdarzeniach.
Widok listy zadań zdarzeń
- Wybierz zadanie(a) - Wybierz zadanie, które chcesz usunąć, z widoku listy, zaznaczając je.
- Id – unikalny identyfikator zadania. Generowany automatycznie i nie można go zmienić.
- Nazwa - Nazwa zadania dodana do ustawień zadania, unikalna nazwa zadania.
- Relacje przepływu pracy
- Znak zapytania wyświetla okno podręczne ze szczegółowymi informacjami o odniesieniu
- Status przepływu pracy
- Nieużywane – brak powiązań z przepływem pracy
- W użyciu — do zadania dołączono przepływ(y) pracy, zadania nie można usunąć
- Zarządzać
- Ikona pióra – otwiera ustawienia zadania w osobnym oknie
- Ikona papieru – kopiuje zadanie
- Ikona Stop – usuwa zadanie, pojawia się okno pop-up z prośbą o potwierdzenie usunięcia
Okno edycji zadania zdarzenia
Konfigurację zadania zdarzenia można otworzyć, klikając ikonę pióra lub klikając dwukrotnie wiersz zadania.
Menu po lewej stronie oraz atrybuty różnią się w zależności od wybranych opcji, dlatego bardziej szczegółowe instrukcje dotyczące edycji zadań można znaleźć w opisie łącznika. Istnieją jednak wspólne funkcjonalności dla wszystkich zadań zdarzeń, które opisano poniżej.
Edytuj okno zadania zdarzenia
- Użycie zadania, edytowalne? — pojawia się, gdy edycja istniejącego zadania i zmiana typu użycia zadania spowoduje przerwanie przepływów pracy
- Typ mapowania, edytowalny? - pojawia się, gdy edycja istniejącego zadania i zmiana typu mapowania spowoduje przerwanie przepływów pracy
Zapisywanie zadania
Jeśli w zadaniu brakuje obowiązkowych informacji, najechanie kursorem myszy na przycisk zapisywania pokaże, które atrybuty są nadal puste.
Karta uwierzytelniania
Uwierzytelnianie dla rozwiązań Matrix42 Core , Pro and IGA konfiguruje się na karcie uwierzytelniania. Należy pamiętać, że tylko niektóre łączniki (łączniki katalogowe) obsługują uwierzytelnianie, więc nie jest możliwe utworzenie zadań uwierzytelniania dla wszystkich dostępnych łączników.
Górny pasek do uwierzytelniania
- Nowy łącznik – otwiera nowe okno umożliwiające skonfigurowanie nowego łącznika (należy pamiętać, że nie wszystkie łączniki obsługują uwierzytelnianie)
- Usuń łącznik(i) – usuwa wybrane zadania, pojawia się okno pop-up z prośbą o potwierdzenie usunięcia
- Eksport – użytkownik może wyeksportować jedno lub więcej zadań ze środowiska. Zazwyczaj używane do eksportowania zadań z testów do produkcji. Złącza EPE są chronione hasłem.
- Należy pamiętać, że obszar zadań uwierzytelniania nie jest eksportowany, należy go ustawić ręcznie po zaimportowaniu
- Import – użytkownik może zaimportować jedno lub więcej zadań do środowiska. Zazwyczaj używane do importowania zadań z testów do produkcji.
- Odśwież – odświeża widok zadań uwierzytelniania
Widok listy do przeglądu uwierzytelniania
- Wybierz złącze(a) — wybierz jedno złącze, klikając pole wyboru przed rzędem złącza lub klikając pole wyboru w rzędzie nagłówka, co spowoduje wybranie wszystkich złączy
- Identyfikator – automatycznie generowany, unikalny identyfikator łącznika. Nie można go edytować ani zmieniać.
- Nazwa – nazwa łącznika dodana do ustawień łącznika. Unikalna nazwa łącznika przechowującego konfigurację dla jednego źródła danych.
- Typ – wskazuje system docelowy/źródłowy
- Liczba – informuje, ile zadań uwierzytelniania jest skonfigurowanych
- Zarządzać
- Ikona pióra – otwiera ustawienia zadania uwierzytelniania w osobnym oknie
- Ikona papieru – kopiuje zadanie
- Ikona Stop – usuwa wybrane zadanie
Informacje o zadaniu uwierzytelniania
Po kliknięciu strzałki na początku wiersza łącznika wyświetlane są wszystkie powiązane zadania zaplanowane i zdarzenia
Górny pasek do przeglądu uwierzytelniania
- Utwórz nowe zadanie – otwiera stronę konfiguracji dla nowego zadania uwierzytelniania
- Usuń zadanie(a) – usuwa wybrane zadanie(a), pojawia się okno pop-up z prośbą o potwierdzenie usunięcia
- Odśwież – odświeża widok zadań uwierzytelniania
Widok listy do przeglądu uwierzytelniania,
- Wybierz zadanie(a) - Wybierz zadanie, które chcesz usunąć, z widoku listy, zaznaczając je.
- Id – unikalny identyfikator zadania. Generowany automatycznie i nie można go zmienić.
- Nazwa - Nazwa zadania dodana do ustawień zadania, unikalna nazwa zadania.
- Zarządzać
- Ikona pióra – otwiera ustawienia zadania w osobnym oknie (dwukrotne kliknięcie wiersza zadania otwiera również okno ustawień)
- Ikona papieru – kopiuje zadanie
- Ikona Stop – usuwa zadanie, pojawia się okno pop-up z prośbą o potwierdzenie usunięcia
Karta dzienników
Karta dzienników umożliwia pobranie dzienników Native Connector i Secure Access z interfejsu użytkownika w celu przeprowadzenia szczegółowego rozwiązywania problemów.
- Dzienniki epe-master — zawierają ostrzeżenia, komunikaty debugowania i komunikaty o błędach dotyczące natywnych łączników, a także informacje o tym, jak długo trwały działania związane z zadaniami.
- Dzienniki epe-worker-ad – zawierają wyciąg danych o stanie konektora Active Directory (co Native Connector ładuje do klientów korzystających z rozwiązań Matrix42 Core , Pro and IGA ). Jeśli zaznaczenie jest puste, oznacza to, że katalog nie jest używany w tym środowisku.
- Dzienniki epe-worker-azure – zawierają status danych ekstraktu Entra ID (dane, które Native Connector ładuje do rozwiązań Matrix42 Core , Pro and IGA ). Jeśli zaznaczenie jest puste, oznacza to, że katalog nie jest używany w tym środowisku.
- Dzienniki epe-worker-ldap – zawierają status ekstrakcji danych LDAP (dane, które Native Connector ładuje do klientów korzystających z rozwiązań Matrix42 Core , Pro and IGA ). Jeśli zaznaczenie jest puste, oznacza to, że katalog nie jest używany w tym środowisku.
- Dzienniki epe-launcher – zawierają informacje o uruchomieniach EPE
- datapump-itsm logi - Zawiera informacje o eksporcie danych do rozwiązań klientów Matrix42 Core , Pro and IGA .
- esa logs - Zawiera informacje o uwierzytelnianiu Secure Access .
Karta Ustawienia
Karty ustawień służą do monitorowania środowisk z łącznikami.
- Typ środowiska - musi być wybrany i informacja ta jest wykorzystywana na przykład do krytycznego definiowania alertu.
- Test – wybierz tę opcję, jeśli Twoje środowisko jest używane jako środowisko testowe
- Pro d – wybierz tę opcję, jeśli Twoje środowisko jest używane jako środowisko produkcyjne
- Demo – wybierz tę opcję, jeśli Twoje środowisko jest używane jako demo lub środowisko szkoleniowe
- Dev – wybierz tę opcję, jeśli Twoje środowisko jest używane jako środowisko programistyczne
Co monitorujemy?
- Niepowodzenia w planowanym udostępnianiu (wyodrębnianie danych, eksportowanie danych do ESM, nieaktualne certyfikaty, nieprawidłowe hasła, nieprawidłowa baza wyszukiwania/filtr, nieprawidłowe mapowania itp.)
- Niepowodzenia w obsłudze zdarzeń (brak zapisu do AD / Azure itp.)
- Dostarczanie oparte na zdarzeniach – które łączniki są używane do zapisywania danych w aplikacjach/katalogach.
- ESA ponad dziesięć nieudanych prób logowania do jednego użytkownika w ciągu ostatnich 3 dni
- Typ środowiska - musi być wybrany i informacja ta jest wykorzystywana na przykład do krytycznego definiowania alertu.
Migracje danych
Nie klikaj opcji „Migruj mapowania atrybutów” ani „Migruj przepływy pracy”, jeśli nie zostaniesz o to poproszony przez Matrix42 .
Konfiguruj łącznik
W tym rozdziale opisano instrukcje konfiguracji łącznika umożliwiającego połączenie z REST API .
Aby skonfigurować provisioning, będziesz potrzebować dostępu do konsoli konfiguracji platformy.
1. Otwórz obszar Administracji (symbol koła zębatego).
2. Otwórz widok Złącza.
3. Wybierz „Nowy łącznik”
4. Wybierz typ źródła danych: Ogólne REST API
5. Podaj nazwę łącznika i dodaj ustawienia połączenia:
- Nazwa złącza – nadaj złączu przyjazną nazwę (nazwę można później zmienić)
- Adres URL hosta – adres URL bazowy dla REST API . Można go użyć jako prefiksu do wywołania adresu URL końcowego.
- Typ łącznika REST : ogólny lub Google . W przypadku Google należy użyć Google , a w przypadku wszystkich innych typów interfejsu REST API należy użyć ogólnego.
Wybierz właściwą metodę uwierzytelniania, w zależności od systemu, z którym się łączysz
- Uwierzytelnianie podstawowe – uwierzytelnianie podstawowe przy użyciu nazwy użytkownika i hasła w nagłówku uwierzytelniania zakodowanym w standardzie Base64
- Token nośnika – użycie stałego nagłówka uwierzytelniania tokena nośnika
- Wyłączone – dla publicznych interfejsów API bez uwierzytelniania (w wersji 2025.3 i nowszych)
- Nagłówek uwierzytelniania – dla stałego tajnego nagłówka (w wersji 2025.3 i nowszych)
- Token dynamiczny — dla przepływu poświadczeń klienta OAuth 2.0 i podobnego (w wersji 2025.3 i nowszych)
Ustaw prawidłową paginację na podstawie systemu zewnętrznego, z którym łączysz się za pomocą tego łącznika.
Paginacja ogólnego łącznika REST API obsługuje 5 różnych typów paginacji. Są one używane przez zadania zaplanowane:
- Wyłączone — API nie obsługuje paginacji i zwraca wszystkie dane w jednej odpowiedzi.
- Start i przesunięcie – API używa parametrów start i przesunięcie. Przy każdym żądaniu zwiększaj start o przesunięcie, aż do pobrania wszystkich danych.
- Inkrementacja stron – API korzysta z numeracji stron. Przy każdym żądaniu zwiększaj numer strony o jeden, aż nie zostaną zwrócone żadne wyniki.
- Token linku – odpowiedź zawiera adres URL następnej strony. Podążaj za tym adresem, aż nie pojawi się żaden link.
- Token atrybutu linku – odpowiedź zawiera token następnej strony. Wyślij ten token jako parametr zapytania w następnym żądaniu. Paginacja w stylu Google .
Wypełnij informacje o użytkowniku API sieci Web
- Użytkownik API internetowego — wybierz właściwego użytkownika API internetowego, który będzie używany podczas zapisywania danych z systemu zewnętrznego do rozwiązań Matrix42 Core , Pro and IGA
- Hasło do API internetowego – hasło użytkownika API internetowego
7. Zapisz informacje o złączu
8. Dodaj certyfikat główny HTTPS zewnętrznego systemu REST API , który będzie traktowany jako zaufany przez funkcję zarządzania łącznikami (EPE). Można to zrobić tylko za pomocą Matrix42 : Dodaj certyfikat.
9. Rozwiązanie Matrix42 Core , Pro and IGA może teraz łączyć się z zewnętrznym REST API
- Następnym krokiem jest skonfigurowanie zaplanowanego zadania do odczytu danych lub zadania zdarzeń do zapisu danych i działań w kierunku REST API .
Ogólne uid dotyczące zaplanowanych zadań
Ogólne uid dotyczące zaplanowanych zadań
Jak utworzyć nowe zadanie zaplanowane w celu zaimportowania danych
Aby skonfigurować zadanie provisioningu oparte na harmonogramie, musisz mieć dostęp do zakładki Administracja / Łączniki.
1. Otwórz obszar Administracji (symbol koła zębatego).
2. Otwórz widok Złącza .
3. Wybierz opcję Łącznik dla zadania opartego na harmonogramie i wybierz opcję Nowe zadanie
Uwaga! Jeśli łącznik nie zostanie utworzony, należy najpierw wybrać Nowy łącznik , a następnie Nowe zadanie.
4. Kontynuuj zgodnie z instrukcjami dotyczącymi konkretnego złącza: złącza natywne
Czy powinienem użyć opcji Przyrostowej, Pełnej czy obu?
Zaplanowane zadanie może być typu przyrostowego lub pełnego.
Nie importuj uprawnień za pomocą zadania przyrostowego AD i LDAP
Zadanie przyrostowe ma problem z importowaniem uprawnień. Obecnie zaleca się, aby nie importować członkostwa w grupach z zaplanowanym zadaniem przyrostowym.
W przypadku łączników Microsoft Active Directory i OpenLDAP usuń to mapowanie w zadaniu przyrostowym:
Ustawienia zadań zaplanowanych:
Typ przyrostowy obsługiwany jest tylko przez łączniki Microsoft Active Directory , LDAP i Microsoft Graph API (dawniej znane jako Entra ID ).
Typ przyrostowy oznacza, że Native Connectors (EPE) pobiera dane z systemu źródłowego, wykorzystując informacje o zmienionym znaczniku czasu, więc pobiera tylko te dane, które zostały zmienione lub dodane po poprzednim uruchomieniu zadania przyrostowego.
Podczas pierwszego uruchomienia zadania typu „Incremental” wykonywane jest pełne pobieranie (i zapisywanie bieżącego znacznika czasu w bazie danych EPE). Następnie zadanie używa tego znacznika czasu, aby zapytać źródło danych o dane, które uległy zmianie od tego znacznika czasu (a następnie EPE aktualizuje znacznik czasu w bazie danych EPE przed kolejnym uruchomieniem zadania). Czyszczenie pamięci podręcznej zadania nie wpływa na ten znacznik czasu, więc zadanie typu „Incremental” jest zawsze przyrostowe po pierwszym uruchomieniu.
Pełny typ jest obsługiwany przez wszystkie złącza.
Pełny typ importu zawsze pobiera wszystkie dane (które są skonfigurowane do pobierania) z systemu źródłowego przy każdym uruchomieniu.
Zarówno zadania pełne, jak i przyrostowe korzystają również z pamięci podręcznej zadań w EPE, co sprawia, że niektóre importy są szybsze i lżejsze dla systemu M42 .
Domyślnie pamięć podręczna tego zadania jest czyszczona o północy czasu UTC. Po wyczyszczeniu pamięci podręcznej, kolejny import jest uruchamiany bez buforowania, aby ustalić, czy pobrane dane powinny zostać przesłane do ESM. Wszystkie pobrane dane są przesyłane do ESM. Jednak po tym, kolejne zadanie jest uruchamiane do następnego wyczyszczenia pamięci podręcznej, używając pamięci podręcznej EPE do określenia, czy pobrane dane powinny zostać przesłane do ESM.
Możesz skonfigurować, o której porze dnia pamięć podręczna zadań ma być opróżniana, zmieniając globalne ustawienie w konfiguracji EPE datapump:
/opt/epe/datapump-itsm/config/ niestandardowe .properties
który jest domyślnie ustawiony na: clearCacheHours24HourFormat=0
Możesz również czyścić pamięć podręczną wiele razy dziennie, ale musisz to dokładnie przemyśleć, ponieważ ma to wpływ na ogólną wydajność, ponieważ EPE będzie przesyłać zmiany do ESM, które prawdopodobnie już tam są, na przykład (nie dodawaj spacji do wartości atrybutu): clearCacheHours24HourFormat=6,12
Po zmianie tej wartości należy ponownie uruchomić kontener EPE DataPump, aby wprowadzić zmiany.
Zalecenia:
Zawsze domyślnie ustawiaj typ zadania zaplanowanego jako Pełny.
Jeśli chcesz pobierać zmiany w danych pobranych już przez pełne zadanie, częściej niż możesz je uruchamiać, dodaj również zadanie przyrostowe. Zazwyczaj zadanie przyrostowe nie jest potrzebne.
Zalecana kolejność harmonogramowania
Zalecana kolejność harmonogramowania zależy od ilości danych odczytywanych z systemu/katalogu Klienta do rozwiązania Matrix42 Core , Pro lub IGA i czy import jest przyrostowy czy pełny.
Przykłady harmonogramowania,
| Całkowita liczba użytkowników | Łączna liczba grup | Sekwencja pełnego obciążenia | Sekwencja ładowania przyrostowego |
| < 500 | < 1000 | Co 30 minut, jeśli nie jest używane obciążenie częściowe Cztery (4) razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 10 minut |
| < 2000 | < 2000 | Co 60 minut, jeśli nie jest używane obciążenie częściowe Cztery (4) razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 15 minut |
| < 5000 | < 3000 | Co cztery (4) godziny, jeżeli nie jest wykorzystywane obciążenie częściowe Dwa razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 15 minut |
| < 10 000 | < 5000 | Maksymalny import dwa razy dziennie, bez względu na to, czy ładunek częściowy jest wykorzystywany, czy nie | Co 30 minut |
| < 50 000 | < 7000 | Maksymalny import raz dziennie, bez względu na to, czy obciążenie częściowe jest wykorzystywane, czy nie | Co 60 minut |
| Ponad 50 000 | Ponad 7000 | Może być potrzebny inny pracownik EPE, prosimy o kontakt z właścicielem produktu Pro | Ocenione oddzielnie |
Należy pamiętać, że jeśli kilka zadań jest uruchomionych jednocześnie, może być potrzebna większa liczba pracowników EPE. Zadania powinny być zaplanowane w różnych godzinach i mogą zostać ukończone zgodnie z powyższą tabelą. Jeśli jednak więcej niż 6 zadań jest uruchomionych jednocześnie, należy zwiększyć liczbę pracowników EPE. W miarę możliwości zaleca się unikanie planowania zadań w tym samym czasie.
Zalecenia dotyczące wydajności
Jeżeli ilość danych do zaimportowania przekracza 10000, należy wziąć pod uwagę następujące kwestie:
Dostosuj poziom logowania ESM i DATAPUMP do poziomu ERROR, aby zmniejszyć ilość rejestrowania podczas wykonywania zadania
Należy jak najmniej automatyzacji uruchamiać od razu dla importowanych kart danych (odbiorników, procedur obsługi, przepływów pracy), ponieważ powoduje to, że ESM potrzebuje więcej czasu na obsługę nowych kart danych.
Ustaw usunięte konta i uprawnienia jako usunięte/wyłączone
Dzięki tej funkcjonalności możesz oznaczyć status konta i uprawnienia, np. jako Usunięte lub Wyłączone, gdy konto lub uprawnienie zostanie usunięte z systemu źródłowego. Od wersji 2025.3 możesz również ustawić status obiektów ogólnych (nie tylko kont/tożsamości i uprawnień/grup).
Dla wersji 2025.3 i nowszych
W wersji 2025.3 te ustawienia zostały przeniesione z plików właściwości do interfejsu użytkownika zadań. Można teraz również skonfigurować te ustawienia dla obiektów ogólnych, co nie było możliwe wcześniej.
Dla każdego zaplanowanego zadania i dla wszystkich typów mapowania istnieje osobna konfiguracja. Oto przykład takiej konfiguracji dla zadania:
Dla wersji 2025.2 i starszych
Funkcjonalność ta jest dostępna dla zadań zaplanowanych typu „pełny”.
Ustawienia znajdują się w pliku konfiguracyjnym Dockers DataPump. Aby zmienić wartości tych parametrów, należy je ustawić w pliku /opt/epe/datapump-itsm/config/custom.properties .
Konfiguracja
Aby włączyć funkcję wyłączania, konfiguracja DataPump powinna mieć następujące parametry ustawione na wartość true:
disable.unknown. esm .users=true
disable.unknown. esm .groups=true
Te dwa parametry są domyślnie ustawione na fałsz w wersjach 2024.2 i 2025.1. W wersji 2025.2 i nowszych są one domyślnie ustawione na prawdę.
Następnie mamy następujące parametry:
personTemplateStatusCodeAttributeKey=accountStatus
personTemplateStatusAttributeDisabledValueKey=Deleted
groupTemplateStatusCodeAttributeKey=status
groupTemplateStatusAttributeDisabledValueKey=5 - Removed
Pierwsze dwa atrybuty powinny wskazywać na atrybut DatacardHiddenState w szablonie użytkownika i określać, jaka wartość powinna zostać tam wysłana po usunięciu użytkownika.
Domyślnie accountStatus i Wartość 5 - Removed w szablonie IGA Account .
Wszystkie te elementy muszą odpowiadać konfiguracji atrybutów:
To samo dotyczy dwóch następnych parametrów, ale dotyczą one Grup.
Jeśli musisz zmienić te parametry w pliku właściwości, wprowadź zmiany w kontenerze Datapump do pliku: /opt/ epe /datapump-itsm/config/ custom .properties. Zmiany te zostaną zachowane po ponownym uruchomieniu kontenera i skopiowane do pliku /opt/ epe /datapump-itsm/config/application.properties.
Opis
Zadania zapisują swój __taskid__ wyświetlany w interfejsie użytkownika jako Task Id mapping na karty danych. Następnie jest on używany do ustalenia, czy karta danych została dodana przez to zadanie. Dotyczy to sytuacji, gdy istnieje wiele zadań z różnymi grupami użytkowników.
To pole było wcześniej używane jako datasourceid, ale odkąd przeszliśmy do modelu, w którym łącznik może mieć wiele zadań, jego identyfikator nie może być już używany, dlatego pole zostało zmienione na taskid.
Biorąc za przykład użytkowników, gdy zadanie jest uruchamiane, ESM jest pytany o listę użytkowników, którzy mają swój identyfikator zadania w polu Task Id mapping i nie mają wartości personTemplateStatusAttributeDisabledValueKey w personTemplateStatusCodeAttributeKey
Następnie wynik ten jest porównywany z tym, co pobrało zadanie, a karty danych użytkowników, które nie zostały pobrane, mają atrybut personTemplateStatus ustawiony na wartość określoną w konfiguracji - 5 - Removed .
Przykładowy dziennik poniżej obrazuje opisany proces i informuje, że jeden użytkownik został usunięty.
To samo dotyczy grup, ale zamiast tego używane są atrybuty groupTemplateStatus .
Notatki
- Funkcja działa tylko z zadaniami zaplanowanymi przy użyciu pełnego pobierania.
- Brak wsparcia dla szablonów ogólnych, dostępne są tylko dane dotyczące tożsamości i dostępu
- Podczas migracji z poprzednich wersji, w których nadal używano datasourceid, konieczne jest uruchomienie programu przynajmniej raz w celu ustawienia identyfikatorów zadań w datacards.
- EPE identyfikuje użytkowników lub grupy niepełnosprawnych jako tych, którzy zostali usunięci z AD . Obecnie nie obsługujemy statusów związanych z aktywnością lub nieaktywnością jednostki.
- EPE nie umożliwia użytkownikom samodzielnego powrotu do systemu.
- Jeśli więcej niż jedno zadanie pobiera tych samych użytkowników lub grupy, może to spowodować nadpisanie identyfikatora zadania w karcie danych, w zależności od tego, które zadanie zostało uruchomione jako ostatnie. Zaleca się, aby wiele zadań typu full nie pobierało tego samego użytkownika lub grupy.
- Zawsze zmieniaj plik konfiguracyjny w pliku custom.properties , nie zmieniaj wyłącznie pliku application.properties, ponieważ zmiany te zostaną utracone po ponownym uruchomieniu kontenera, jeśli nie wprowadzono takich samych zmian w pliku custom.properties.
Skonfiguruj zadanie zaplanowane do odczytu danych
Wersja 2025.3 dodała obsługę odczytu danych przy użyciu zadań zaplanowanych.
Łącznik ogólnego REST API służy do odczytywania danych z rozwiązań innych firm udostępniających REST API poprzez tworzenie zadań provisioningu opartych na harmonogramie.
Jak utworzyć nowe zadanie do wizualizacji w programie Scheduled Pro
Aby skonfigurować zadanie provisioningu oparte na harmonogramie, potrzebny będzie dostęp do konsoli konfiguracji platformy.
Uwaga! Jeśli łącznik nie zostanie utworzony, musisz najpierw utworzyć „nowy łącznik”, a następnie będziesz mógł tworzyć nowe zadania.
1. Otwórz widok konfiguracji platformy (symbol koła zębatego).
2. Otwórz widok Złącza.
3. Wybierz łącznik, dla którego skonfigurowano zadanie oparte na harmonogramie
4. Wybierz „nowe zadanie” pod właściwym łącznikiem
5. Zdefiniuj harmonogram zadania (czy i jak zaplanowane zadanie powinno być uruchamiane okresowo). Wybierz kolejność harmonogramowania, która zależy od ilości danych odczytywanych przez rozwiązanie Matrix42 Core , Pro and IGA .
Zalecana kolejność harmonogramowania zależy od ilości danych odczytanych z katalogu klienta do rozwiązania Matrix42 Core , Pro and IGA oraz od tego, czy import odbywa się z częściowym, czy pełnym obciążeniem.
Przykładowy harmonogram odczytu danych.
| Całkowita liczba użytkowników | Łączna liczba grup | Sekwencja pełnego obciążenia | Sekwencja częściowego obciążenia |
| < 500 | < 1000 | Co 30 minut, jeśli nie jest używane obciążenie częściowe Cztery (4) razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 10 minut |
| < 2000 | < 2000 | Co 60 minut, jeśli nie jest używane obciążenie częściowe Cztery (4) razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 15 minut |
| < 5000 | < 3000 | Co cztery (4) godziny, jeżeli nie jest wykorzystywane obciążenie częściowe Dwa razy dziennie, jeśli stosowane jest obciążenie częściowe |
Co 15 minut |
| < 10 000 | < 5000 | Maksymalny import dwa razy dziennie, bez względu na to, czy ładunek częściowy jest wykorzystywany, czy nie | Co 30 minut |
| < 50 000 | < 7000 | Maksymalny import raz dziennie, bez względu na to, czy obciążenie częściowe jest wykorzystywane, czy nie | Co 60 minut |
| Ponad 50 000 | Ponad 7000 | Może być potrzebny inny pracownik EPE, prosimy o kontakt z właścicielem produktu Pro | Ocenione oddzielnie |
5. Wypełnij szczegóły zadania
- Wprowadź unikalną nazwę zadania dla zadania opartego na harmonogramie
- Użycie zadania wskazuje, że jest to zadanie służące do odczytu danych, zapisu danych lub uwierzytelniania. Należy pamiętać, że późniejsza zmiana typu zdarzenia może spowodować przerwanie przepływów pracy lub integracji.
- Typ mapowania zależy od typu informacji odczytywanej z katalogu. W przypadku łącznika REST API typu Generic obsługiwane są tylko mapowania ogólne.
- Ogólne (jeden szablon) – używane, gdy z katalogu odczytywane są ogólne informacje
6. Wypełnij parametry zadania
- Zapytanie — rzeczywisty punkt końcowy adresu URL API , który ma zostać wywołany
- Podzapytania – opcjonalne. Można ich użyć, jeśli zachodzi potrzeba pobrania danych powiązanych z zapytaniem z innego punktu końcowego API .
- Nagłówki zapytania – niestandardowe nagłówki dodawane do końcowego zapytania podczas ekstrakcji danych.
Zarządzanie złączami (EPE) dodaje te nagłówki automatycznie, więc nie ma potrzeby ich jawnego dodawania:
“Content-Type”, “…”
"Authorization", “…” - Znacznik wartości – może być pusty. Wartość zależy od struktury danych JSON zwróconej przez API zapytań. Na przykład, jeśli całe dane znajdują się w obiekcie JSON zestawu wyników, ustaw ten znacznik wartości na zestaw wyników.
- Znacznik błędu – może być pusty. Wartość zależy od struktury komunikatu o błędzie JSON zwróconej przez API zapytań. Na przykład, jeśli cały komunikat o błędzie znajduje się w obiekcie JSON "errors", ustaw ten znacznik wartości na "errors".
- Próg bezpieczeństwa dla wywołań API – próg bezpieczeństwa zapobiegający powstawaniu pętli nieskończonych. Ustaw go na 2 razy więcej niż liczba wywołań potrzebnych do pobrania wszystkich danych przez to zadanie. Jeśli pobieranie wszystkich danych przez to zadanie, np. 50 wywołań stronicowanych, ustaw tę wartość na 100.
- Unikalny atrybut – ustaw unikalną nazwę atrybutu (z uwzględnieniem wielkości liter) z zestawu wyników JSON. Zazwyczaj jest to ID, id lub g uid itd. Każdy wiersz musi mieć unikalną wartość tego atrybutu. Należy również dodać ten atrybut do tabeli mapowania na końcu konfiguracji zadania. Uwaga! Zaplanowane zadanie nie może pobrać danych, które nie zawierają tego unikalnego atrybutu dla każdego obiektu.
7. Uzupełnij informacje o awarii
Opcjonalne ustawienia obsługi awarii. Jeśli zaplanowane zadanie zakończy się niepowodzeniem, może utworzyć kartę danych w ESM, która wyświetli błąd. Jeśli ustawienia awarii są zdefiniowane, administrator nie musi ręcznie sprawdzać statusu zaplanowanych zadań.
- Szablon awarii — wybierz szablon karty danych, który zostanie utworzony w razie wystąpienia błędów podczas udostępniania (połączenie ze źródłami danych, przekroczenie limitu czasu itp.).
- Folder awarii – wybierz folder, w którym będzie przechowywana karta danych awarii.
- Atrybut awarii — wybierz atrybut, w którym w szablonie awarii mają być przechowywane informacje o błędzie. Wybierz atrybut typu tekstowego.
8. Dodaj mapowania ogólne
W sekcji mapowań konfigurujesz, który atrybut z komunikatu JSON zostanie odczytany do którego atrybutu na karcie danych Matrix42 Core , Pro and IGA .
- Szablon docelowy — wybierz szablon, aby zdefiniować mapowania atrybutów
- Folder docelowy – wybierz folder z listy folderów. Lista jest zawężana w celu dopasowania do wybranego szablonu.
- Mapowanie typu źródła danych – opcjonalne. Jeśli jest ustawione, zapisuje typ łącznika do tego atrybutu.
- Mapowanie identyfikatorów zadań — w tym atrybucie zapisywany jest numer identyfikacyjny zadania.
- Ustaw wartość na karcie danych dla obiektu usuniętego z systemu źródłowego – tę funkcjonalność aktywuje się, zaznaczając pole wyboru. Gdy obiekt, który został wcześniej odczytany z systemu zewnętrznego do rozwiązania, zostanie usunięty z systemu zewnętrznego, to zaplanowane zadanie zauważa, że obiekt został usunięty i oznacza wybrany atrybut karty danych żądaną wartością. Można tego użyć na przykład do ustawienia atrybutu Status na Usunięty (jak pokazano na poniższym zrzucie ekranu).
- Mapowania atrybutów
- Atrybut zewnętrzny – który atrybut z API systemu zewnętrznego jest odczytywany z treści JSON
- Atrybut lokalny – do którego atrybutu w Matrix42 Core , Pro and IGA jest mapowany atrybut
- Można ustawić dodatkowe atrybuty do mapowań atrybutów, wybierając opcję Nowy atrybut
9 Zapisz zadanie provisioningu, klikając przycisk Zapisz.
Jeśli brakuje niektórych wymaganych atrybutów, przycisk zapisu jest wyświetlany w kolorze szarym i pokazuje, czego brakuje w ustawieniach.
10. Skonfigurowano teraz zadanie łącznika oparte na harmonogramie do odczytu ogólnego REST API
- Teraz możesz poczekać, aż zadanie zostanie rozpoczęte zgodnie z harmonogramem lub
- Uruchom zadanie ręcznie – klikając przycisk „Uruchom zadanie” u góry okna edycji zadania, zadanie jest konfigurowane do natychmiastowego uruchomienia. Zazwyczaj jest to przydatne w przypadku uruchomień testowych lub gdy nie chcesz zmieniać ustawień harmonogramu, ale chcesz uruchomić zadanie od razu.
Przykład komunikatu rozpoczynającego ręczne uruchomienie zadania:
Jeśli zadanie jest wykonywane ręcznie ( uruchom zadanie ) lub jest uruchamiane zgodnie z harmonogramem, status zadania można sprawdzić w kolumnie zarządzania listą zaplanowanych zadań, klikając przycisk „Wyświetl historię” .
Konfiguruj zadanie oparte na zdarzeniach
Zadanie zdarzenia jest używane podczas zapisywania danych (lub wykonywania innych wywołań REST API opartych na zdarzeniach z Workflow) w rozwiązaniu klienta oferującym ogólne REST API . Te funkcje zarządzania złączami są dostępne dla wszystkich rozwiązań Matrix42 Core , Pro and IGA .
Przykłady wykorzystania zadań opartych na zdarzeniach:
- Dodaj konto
- Zaktualizuj osobę
- Aktywuj konto
- Utwórz bilet
- Nieaktywne urządzenie
Wszelka konfiguracja związana z zarządzaniem złączami i zadaniami provisionowania opartymi na zdarzeniach jest konfigurowana w widoku Matrix42 Core , Pro lub IGA Connectors.
1. Otwórz widok konfiguracji Matrix42 Core , Pro lub IGA (symbol koła zębatego).
2. Otwórz widok złączy
3. Wybierz łącznik, który będzie korzystał z zadania zdarzenia
4. Wybierz „nowe zadanie” pod właściwym łącznikiem
5. Wypełnij ustawienia zadania
- Nazwa zadania — podaj nazwę zadania, która będzie wyświetlana w widoku łączników.
- Dobrą praktyką jest nadawanie zadaniu nazwy opisującej jego cel, na przykład [Nazwa szablonu]:[Aktywność] Żądanie usługi IGA : Dodaj konto
- Użycie zadania wskazuje, że jest to zadanie używane do odczytu lub zapisu danych. Można to później zmienić, ale nie jest to zalecane, jeśli zadanie zdarzenia jest w użyciu. Spowoduje to przerwanie przepływów pracy.
- Typ mapowania zależy od typu informacji odczytanych z katalogu. Wybory mapowania tożsamości są wyświetlane na podstawie tego ustawienia.
- Ogólne (jeden szablon) – używane, gdy z katalogu odczytywane są informacje ogólne. Mogą to być dowolne typy danych.
Ostrzeżenie dotyczące zmiany sposobu użycia zadania lub typu mapowania, gdy używane jest zadanie zdarzenia:
6. Wypełnij parametry zadania
- Zapytanie – punkt końcowy API, który wywoła to zadanie. Można go pozostawić pusty i podać w węźle orkiestracji przepływu pracy. Można podać pełny adres punktu końcowego, taki jak: https://apiurl.com/endpointtocall lub sam koniec adresu URL. Jeśli podasz tylko koniec adresu URL, na przykład endpointtocall , końcowy adres URL zostanie połączony z następującymi elementami: adres URL hosta konektora + zapytanie zadania + adres URL węzła orkiestracji.
- Nagłówki zapytania – niestandardowe nagłówki dodawane do ostatecznego zapytania do REST API . Zapoznaj się z dokumentacją API systemu docelowego/źródłowego, aby dowiedzieć się, jakie nagłówki są wymagane.
- Formater atrybutu daty – służy do formatowania dat podczas konfigurowania atrybutu typu daty w systemie docelowym. Możesz wybrać format z listy lub dodać własny. Pole po prawej stronie pokazuje przykład sformatowanej daty.
- Formater atrybutu DateTime – służy do formatowania daty i godziny podczas konfigurowania atrybutu typu datetime w systemie docelowym. Możesz wybrać format z listy lub dodać własny. Pole po prawej stronie pokazuje przykład sformatowanej daty i godziny.
7. Zdefiniuj mapowania ogólne
- Szablon docelowy — wybierz szablon, aby zdefiniować mapowania atrybutów
- Folder docelowy – wybierz folder z listy folderów. Lista jest zawężana w celu dopasowania do wybranego szablonu.
- Mapowania atrybutów ( Notatka! W większości przypadków nie ma potrzeby ich ustawiania. Dane używane w zadaniu zdarzenia są konfigurowane w węźle Workflow Orchestration.
- Atrybut szablonu Efecte - do którego atrybutu w katalogu Efecte jest mapowany atrybut.
- Atrybut katalogu – który atrybut z katalogu jest mapowany na Efecte
- Dodaj nowy atrybut — możliwe jest ustawienie dodatkowych atrybutów poprzez wybranie przycisku Nowy atrybut.
8. Zapisz zadanie
Zapisz zadanie provisioningu za pomocą przycisku „Zapisz”
Jeśli brakuje jakichkolwiek obowiązkowych informacji, nie będzie można zapisać zadania. Przycisk Zapisz pokaże brakujące informacje.
9. Skonfiguruj przepływ pracy, aby użyć tego zadania opartego na zdarzeniach z węzłem Orchestration
Następnym krokiem jest skonfigurowanie przepływu pracy w celu wykorzystania tego zadania opartego na zdarzeniach.
Z poziomu silnika przepływu pracy w Platformie możliwe jest wykonywanie działań provisioningowych w odniesieniu do usług katalogowych klientów. Oznacza to, że dowolną aktywność dostępnych węzłów orkiestracji można uruchomić w dowolnym momencie przepływu pracy.
Odniesienia do przepływów pracy są wyświetlane na stronie przeglądu łącznika (można odświeżyć odniesienia do przepływów pracy za pomocą przycisku „Pokaż odniesienia do przepływów pracy”):
Konfigurowanie działań węzła Workflow Orchestration
Ogólne wywołanie REST
Dodaj węzeł Orchestration do swojego przepływu pracy i skonfiguruj następujące rzeczy.
Nazwa - ustaw nazwę opisową
Opis - ustaw opisowy opis
Orchestrate - wybierz Pro Engine
Źródło danych — wybierz Ogólne REST API
Aktywność — wybierz ogólne wywołanie REST
Cel — wybierz zadanie oparte na zdarzeniach (możesz użyć tego samego zadania dla wielu węzłów orkiestracji)
Akcja – wybierz akcję na podstawie wywoływanego REST API (sprawdź dokumentację API , aby uzyskać informacje o poprawnej akcji). Obsługiwane akcje to: POST, PUT, PATCH, DELETE i GET.
Adres URL REST – punkt końcowy API, do którego się odwołujesz. Może to być pełny adres URL lub jego sufiks. Jeśli użyjesz sufiksu, rzeczywisty adres URL do wywołania zostanie połączony przy użyciu następujących elementów: adres URL hosta konektora + zapytanie zadania + adres URL węzła orkiestracji. Zmiennych atrybutów szablonu można używać podobnie jak w węźle poczty e-mail, używając składni dolara, takiej jak: $attribute_code$ i $reference:attribute_code$.
Uwaga! Jeśli w adresie URL znajdują się spacje lub znaki $, pamiętaj o ich zakodowaniu w adresie URL. Zatem $ to %24, a spacja to %20.
Rest Body – treść JSON dla wywołania API. Może być pusta, jeśli wywoływane API nie wymaga treści. Szczegóły dotyczące treści można znaleźć w dokumentacji API . Zmiennych atrybutów szablonu można używać podobnie jak w węźle e-mail, używając składni dolara, takiej jak: $attribute_code$ i $reference:attribute_code$.
Na przykład w tym ciele mamy dwie zmienne: $firstname$ i $lastname$
{"nazwa": {
"givenName": "$firstname$",
"familyName": "$nazwisko$"}}
Jeśli potrzebujesz utworzyć skomplikowany kod JSON dla wywołania API , możesz najpierw skonstruować pełny kod JSON dla atrybutu datacard. A następnie umieścić w nim tylko kod tego atrybutu, na przykład: $generated_json_body_attributecode$
Jak wygenerować treść JSON w kodzie
How to generate JSON in workflow
Use json library to read value from JSON
This example is for example for OnPremisesExtensionAttributes, but this same approach can be used for all kinds of JSON messages for Microsoft Graph API and REST API's.
To read 1 specific value from JSON which looks like this:
{ "extensionAttribute1": "test data1", "extensionAttribute2": null, "extensionAttribute3": null, "extensionAttribute4": "EXT", "extensionAttribute5": null, "extensionAttribute6": null, "extensionAttribute7": null, "extensionAttribute8": null, "extensionAttribute9": "HR functions", "extensionAttribute10": "100", "extensionAttribute11": null, "extensionAttribute12": null, "extensionAttribute13": null, "extensionAttribute14": "test5", "extensionAttribute15": "M365_E5" }
You can do it easily with following code on workflow script.
Example (example uses two esm attributes: onPremisesExtensionAttributes and extensionAttribute14code):
import json
if onPremisesExtensionAttributes:
_data = this.get("onPremisesExtensionAttributes")
_obj = json.loads(_data)
_value = _obj["extensionAttribute14"]
this.set("extensionAttribute14code",_value)Remember to always test, that code selects correct data from JSON for your use-case, and if not, do needed adjustments to it.
Atrybut odpowiedzi REST – do tego atrybutu zostanie zapisany wynik JSON wywołania API . Nie wszystkie API zwracają odpowiedź JSON. Szczegóły można znaleźć w dokumentacji API .
How to read value from JSON in workflow
Use json library to read value from JSON
This example is for example for OnPremisesExtensionAttributes, but this same approach can be used for all kinds of JSON messages for Microsoft Graph API and REST API's.
To read 1 specific value from JSON which looks like this:
{ "extensionAttribute1": "test data1", "extensionAttribute2": null, "extensionAttribute3": null, "extensionAttribute4": "EXT", "extensionAttribute5": null, "extensionAttribute6": null, "extensionAttribute7": null, "extensionAttribute8": null, "extensionAttribute9": "HR functions", "extensionAttribute10": "100", "extensionAttribute11": null, "extensionAttribute12": null, "extensionAttribute13": null, "extensionAttribute14": "test5", "extensionAttribute15": "M365_E5" }
You can do it easily with following code on workflow script.
Example (example uses two esm attributes: onPremisesExtensionAttributes and extensionAttribute14code):
import json
if onPremisesExtensionAttributes:
_data = this.get("onPremisesExtensionAttributes")
_obj = json.loads(_data)
_value = _obj["extensionAttribute14"]
this.set("extensionAttribute14code",_value)Remember to always test, that code selects correct data from JSON for your use-case, and if not, do needed adjustments to it.
Wyjątek Pro dostarczania — jeśli wystąpi problem z wywołaniem REST API , do tego atrybutu zostanie zapisany błąd.
Obsługa wyjątków:
- Wyjątek w Pro to opcjonalna właściwość w tym węźle przepływu pracy. Administratorzy mogą skonfigurować tę właściwość w trybie użycia, aby możliwe było zapisywanie wyjątków w przypadku wystąpienia jakichkolwiek wyjątków podczas akcji aprowizacji.
- Wynik węzła będzie miał stan „Zakończono”, jeśli kod odpowiedzi HTTP REST API będzie wynosił 200 lub więcej, ale mniej niż 400.
- Szczegóły dotyczące pomyślnych i nieudanych wywołań REST API można znaleźć w logach.
Rozwiązywanie problemów
W tym rozdziale opisano opcje rozwiązywania problemów,
- W przypadku użycia szablonu awarii należy sprawdzić poprawność karty danych
- Sprawdź historię zaplanowanych zadań z poziomu zarządzania łącznikiem
- Sprawdź dzienniki modułu Efecte Provisioning Engine
Ograniczenia
Ograniczenia zadań opartych na zdarzeniach
- Wiadomości e-mail nie są obsługiwane
- Załączniki nie są obsługiwane
Ograniczenia zadań zaplanowanych
- Atrybuty typu daty (należy je zmapować na atrybut typu ciągu)
- Atrybuty typu DateTime (należy je zmapować na atrybut typu string)
- Wiadomości e-mail nie są obsługiwane
- Załączniki nie są obsługiwane