Jako administrator instytucji możesz skonfigurować elementy webhook dla wdrożenia oprogramowania ArcGIS Enterprise, aby otrzymywać powiadomienia o wystąpieniu określonych zdarzeń. W poniższych sekcjach omówiono sposób konfigurowania instytucji i elementów webhook usług.
Wymagania wstępne dotyczące tworzenia elementów webhook
Przed utworzeniem elementów webhook rozważ następujące kwestie:
- Aby móc używać elementów webhook instytucji, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 10.7 lub nowszej. Aby móc używać elementów webhook usługi, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 11.0 lub nowszej.
- Aby tworzyć elementy webhook instytucji i zarządzać nimi, musisz mieć przypisane uprawnienie Elementy webhook instytucji lub mieć przypisaną rolę administratora domyślnego.
- Aby tworzyć elementy webhook usługi geoprzetwarzania i zarządzać nimi, musisz mieć przypisane uprawnienie Geoprzetwarzanie lub mieć przypisaną rolę administratora domyślnego.
Notatka:
Użytkownicy, którym przypisano uprawnienie Geoprzetwarzanie, będą musieli również wymagać dodania do swojej roli niestandardowej uprawnienia Publikowanie warstw z serwera.
- Aby tworzyć elementy webhook usługi obiektowej i zarządzać nimi, musisz mieć przypisane uprawnienie Warstwa obiektowa lub mieć przypisaną rolę administratora domyślnego.
- Odbiorniki elementów webhook muszą być skonfigurowane pod kątem komunikacji przez protokół HTTPS. Istnieje kilka opcji obsługiwanych dla odbiorników, takich jak odbiorniki usług internetowych innych producentów (Microsoft Power Automate, Zapier i IFFT), niestandardowe usługi internetowe, ArcGIS Notebook Server i ArcGIS Workflow Manager. Aby zapoznać się z przykładami tworzenia niestandardowych usług internetowych lub aby rozpocząć korzystanie z odbiorników innych producentów, zapoznaj się z tematem Repozytorium elementów webhook. Aby dowiedzieć się więcej o tworzeniu elementów webhook Notebook Server i Workflow Manager, zapoznaj się z tematami Tworzenie zadań za pomocą elementów webhook i Automatyzacja procedur wykonywania zadań za pomocą notatników ArcGIS.
- Aby można było skonfigurować elementy webhook dla hostowanej usługi obiektowej, usługa ta musi mieć możliwość edycji i mieć włączone śledzenie zmian bez synchronizacji.
- Aby skonfigurować elementy webhook dla niehostowanej usługi obiektowej, dane geobazy przedsiębiorstwa, do których odwołuje się usługa, muszą spełniać wymagania dotyczące śledzenia zmian i być zgodne z jednym z poniższych wzorców:
- Jest to nie wersjonowana usługa obiektowa z włączoną archiwizacją i globalnymi identyfikatorami.
- Jest to wersjonowana według gałęzi usługa obiektowa bez włączonej funkcji zarządzania wersjami, w której zmiany są stosowane bezpośrednio do obiektów w wersji domyślnej.
- Jest to wersjonowana według gałęzi usługa obiektowa z włączoną funkcją zarządzania wersjami. Gdy funkcja zarządzania wersjami jest włączona, usługa może utworzyć element webhook, który ma wyzwalacz zdarzenia FeaturesPosted wywołujący element webhook za każdym razem, gdy operacja post jest wykonywana w usłudze.
Notatka:
W oprogramowaniu ArcGIS Enterprise 11.3 dodano obsługę usług obiektowych z wersjonowaniem według gałęzi.
- Aby można było skonfigurować elementy webhook dla usługi geoprzetwarzania, usługa musi być asynchroniczna.
Konfiguruj elementy webhook instytucji
Elementy webhook instytucji umożliwiają subskrybowanie wyzwalaczy dla zdarzeń powiązanych z elementami, grupami i użytkownikami portalu ArcGIS Enterprise.
Tworzenie elementu webhook instytucji
Aby utworzyć element webhook instytucji za pomocą witryny internetowej portalu ArcGIS Enterprise, wykonaj następujące czynności:
- Sprawdź, czy jesteś zalogowany jako administrator domyślny lub za pomocą niestandardowej roli z uprawnieniem Elementy webhook instytucji.
- Wybierz opcję Instytucja > Ustawienia > Elementy webhook.
- W obszarze Elementy webhook instytucji kliknij opcję Utwórz element webhook.
- W oknie Utwórz element webhook wykonaj następujące czynności:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa.
- Wybierz typ elementu webhook z rozwijanego menu Typ.
- Wybranie opcji Wszystkie oznacza subskrypcję wszystkich obsługiwanych wyzwalaczy zdarzeń. Będziesz otrzymywać powiadomienia o wszystkich zdarzeniach w miarę ich występowania.
- Wybranie opcji Elementy, Użytkownicy, Grupy lub Role umożliwia ręczne określenie, które wyzwalacze zdarzeń mają zostać subskrybowane.
- Jeśli wybierzesz typ elementu webhook inny niż Wszystkie, pojawi się dodatkowe menu rozwijane odnoszące się do wybranego typu elementu webhook. Jeśli na przykład wybranym typem elementu webhook jest Elementy, pojawi się menu rozwijane Elementy, gdzie możesz wybrać konkretny element, który element webhook będzie monitorował.
- Wybierz wyzwalacze zdarzeń z menu rozwijanego Zdarzenia. Jeśli na przykład chcesz, aby element webhook był wywoływany, gdy określony element zostanie opublikowany, wybierz /items/<ID elementu>/publish.
- Wybierz typ odbiornika elementu webhook.
- Jeśli wybierzesz opcję Adres URL elementu webhook, podaj adres URL ładunku dla odbiornika elementu webhook. Przykładowy adres URL ładunku pokazano poniżej:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
- Jeśli wybierzesz opcję Notatnik, wybierz notatnik, który będzie uruchamiany, gdy element webhook zostanie wyzwolony.
Notatka:
Jeśli opcja Notatnik nie jest dostępna, oznacza to, że w portalu nie został skonfigurowany serwer Notebook Server. Jeśli opcja ta jest dostępna, ale nie można jej wybrać, oznacza to, że nie jesteś właścicielem żadnych notatników odpowiednich do konfigurowania elementów webhook. Musisz być właścicielem elementu notatnika, który będzie użyty przez element webhook.
- Jeśli wybierzesz opcję Adres URL elementu webhook, podaj adres URL ładunku dla odbiornika elementu webhook. Przykładowy adres URL ładunku pokazano poniżej:
- Opcjonalnie ustaw wartość tajną dla elementu webhook w polu tekstowym Tajny (opcjonalnie). Wartość wpisu tajnego zostanie użyta do wygenerowania podpisu zawartego w nagłówkach ładunków elementów webhook. Za pomocą tego podpisu odbiornik elementu webhook może określić, czy komunikat powinien być zaufany.
- Kliknij opcję Utwórz element webhook.
Konfigurowanie parametrów zaawansowanych dla elementów webhook instytucji
Ustawienia zaawansowane zastosowane do elementów webhook instytucji umożliwiają dalsze dostosowywanie działania elementów webhook, na przykład określanie liczby prób dostarczenia, czasu powiadomienia oraz czasu między próbami dostarczenia.
Aby skonfigurować zaawansowane właściwości za pomocą witryny internetowej portalu ArcGIS Enterprise, wykonaj następujące czynności:
- Zaloguj się do instytucji jako administrator domyślny lub za pomocą niestandardowej roli z uprawnieniem Elementy webhook instytucji.
- Wybierz opcję Instytucja > Ustawienia > Elementy webhook.
- W obszarze Elementy webhook instytucji kliknij opcję Zaawansowane ustawienia elementów webhook.
- W oknie Zaawansowane ustawienia elementów webhook wykonaj następujące czynności:
- Ustaw wartość parametru Liczba prób dostarczenia.
Ta wartość określa liczbę prób, które zostaną wykonane w celu dostarczenia ładunku elementu webhook. Domyślnie portal ArcGIS Enterprise spróbuje dostarczyć ładunek trzy razy. Wartość liczby prób musi być liczbą całkowitą z zakresu od 0 do 5.
- Ustaw wartość parametru Limit czasu powiadamiania.
Ta wartość określa czas w sekundach, przez który portal ArcGIS Enterprise będzie czekać na odpowiedź z odbiornika. Domyślnie portal ArcGIS Enterprise czeka 10 sekund. Wartość określająca liczbę sekund oczekiwania portalu ArcGIS Enterprise musi być liczbą całkowitą z zakresu od 0 do 60 sekund.
- Ustaw wartość parametru Czas między powiadomieniami.
Ta wartość określa czas w sekundach między poszczególnymi próbami dostarczenia ładunku. Domyślnie portal ArcGIS Enterprise będzie próbować dostarczyć kolejny ładunek po 5 sekundach, jeśli poprzednia próba się nie powiedzie, aż do osiągnięcia liczby prób określonej w ustawieniu Liczba prób dostarczenia.
- Ustaw wartość parametru Liczba prób dostarczenia.
- Po skonfigurowaniu powyższych ustawień kliknij opcję Zapisz.
Zaktualizowane właściwości zostaną zastosowane do każdego skonfigurowanego elementu webhook instytucji.
Konfigurowanie elementów webhook usługi
Elementy webhook usługi umożliwiają subskrybowanie wyzwalaczy zdarzeń związanych z usługami obiektowymi instytucji lub ukończeniem zadań usług geoprzetwarzania.
Tworzenie elementu webhook usługi
Aby utworzyć element webhook dla usługi geoprzetwarzania lub usługi obiektowej, wykonaj następujące czynności:
- Zaloguj się w instytucji jako administrator domyślny lub członek roli niestandardowej z uprawnieniami administracyjnymi do tworzenia elementów webhook usługi i zarządzania nimi.
Notatka:
Członkowie, którym przypisano rolę publikującego, nie będą mogli tworzyć elementów webhook usługi ani zarządzać nimi z poziomu witryny portalu ArcGIS Enterprise i będą musieli realizować te procedury wykonywania zadań przy użyciu administracyjnego interfejsu API. - Wybierz opcję Instytucja > Ustawienia > Elementy webhook.
- W obszarze Elementy webhook usługi kliknij opcję Utwórz element webhook.
- W oknie Utwórz element webhook wykonaj następujące czynności:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa.
- Wybierz usługę z menu rozwijanego Usługa.
Notatka:
Wybranie usługi geoprzetwarzania spowoduje ustawienie dla zdarzenia wartości Usługa została zakończona. Wybranie usługi obiektowej spowoduje włączenie menu rozwijanego Zdarzenia.
- Jeśli wybierzesz element webhook usługi obiektowej, wybierz wyzwalacz zdarzenia z menu rozwijanego Zdarzenia. Jeśli na przykład chcesz, aby element webhook był wywoływany, gdy edycja obejmuje nowy załącznik, wybierz opcję AttachmentsCreated.
- Podaj adres URL ładunku dla odbiornika elementu webhook w polu tekstowym Adres URL elementu webhook. Przykładowy adres URL ładunku pokazano poniżej:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
- Opcjonalnie ustaw wartość tajną dla elementu webhook w polu tekstowym Tajny (opcjonalnie). Wartość wpisu tajnego zostanie użyta do wygenerowania podpisu zawartego w nagłówkach ładunków elementów webhook. Za pomocą tego podpisu odbiornik elementu webhook może określić, czy komunikat powinien być zaufany.
- Kliknij opcję Utwórz element webhook.
Konfigurowanie parametrów zaawansowanych dla elementów webhook usługi
Ustawienia zaawansowane zastosowane do elementów webhook usługi umożliwiają dalsze dostosowywanie działania elementów webhook, na przykład określanie liczby prób dostarczenia, czasu powiadomienia oraz czasu między próbami dostarczenia.
Aby skonfigurować zaawansowane właściwości za pomocą witryny internetowej portalu ArcGIS Enterprise, wykonaj następujące czynności:
- Zaloguj się w instytucji jako administrator domyślny lub członek roli niestandardowej z uprawnieniami administracyjnymi do tworzenia elementów webhook usługi i zarządzania nimi.
Notatka:
Członkowie, którym przypisano rolę publikującego, nie będą mogli tworzyć elementów webhook usługi ani zarządzać nimi z poziomu witryny portalu ArcGIS Enterprise i będą musieli realizować te procedury wykonywania zadań przy użyciu administracyjnego interfejsu API. - Wybierz opcję Instytucja > Ustawienia > Elementy webhook.
- W obszarze Elementy webhook usługi kliknij opcję Zaawansowane ustawienia elementów webhook.
- W oknie Zaawansowane ustawienia elementów webhook wykonaj następujące czynności:
- Ustaw wartość parametru Liczba prób dostarczenia.
Ta wartość określa liczbę prób, które zostaną wykonane w celu dostarczenia ładunku elementu webhook. Domyślnie system spróbuje dostarczyć ładunek trzy razy. Wartość liczby prób musi być liczbą całkowitą z zakresu od 0 do 5.
- Ustaw wartość parametru Limit czasu powiadamiania.
Ta wartość określa czas w sekundach, przez który system będzie czekać na odpowiedź od odbiornika. Domyślnie system czeka 10 sekund. Ta wartość musi być liczbą całkowitą z zakresu od 0 do 60 sekund.
- Ustaw wartość parametru Czas między powiadomieniami.
Ta wartość określa czas w sekundach między poszczególnymi próbami dostarczenia ładunku. Domyślnie system spróbuje dostarczyć kolejny ładunek po 5 sekundach, jeśli poprzednia próba się nie powiedzie, aż do osiągnięcia liczby prób określonej w ustawieniu Liczba prób dostarczenia.
- Skonfiguruj wartość ustawienia Ostatnia liczba dni.
Ta wartość określa liczbę dni, przez które może wystąpić określona liczba błędów, zanim element webhook zostanie zdezaktywowany. Domyślnie system akceptuje określoną liczbę błędów (określoną za pomocą opcji Maksymalna liczba niepowodzeń) w ciągu 5 dni. Ta wartość musi być liczbą całkowitą z zakresu od 1 do 30.
- Skonfiguruj wartość ustawienia Maksymalna liczba niepowodzeń.
Ta wartość określa liczbę błędów, które mogą wystąpić w ciągu określonej liczby dni, zanim element webhook zostanie zdezaktywowany. Domyślnie system akceptuje 5 błędów w ciągu ustalonej liczby dni (określonej za pomocą opcji Ostatnia liczba dni), zanim elementy webhook zostaną zdezaktywowane. Ta wartość musi być liczbą całkowitą z zakresu od 1 do 30.
- Ustaw wartość parametru Liczba prób dostarczenia.
- Po skonfigurowaniu powyższych ustawień kliknij opcję Zapisz.
Zaktualizowane właściwości zostaną zastosowane do każdego skonfigurowanego elementu webhook usługi.