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ć z elementów webhook instytucji, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 10.7 lub nowszej. Aby można było używać z elementów webhook usług, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 11.0 lub nowszej.
- Aby tworzyć elementy webhook instytucji i zarządzać nimi, musisz być administratorem lub mieć przypisaną rolę administratora domyślnego.
- Aby tworzyć elementy webhook usług i zarządzać nimi, musisz mieć przypisane uprawnienia administratora aktualizacji, usuwania, zabezpieczeń i infrastruktury lub serwerów albo 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 Workflow Manager i Notebook Server, 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 usługi obiektowej, usługa musi mieć możliwość edycji i mieć włączone śledzenie zmian bez synchronizacji.
- Aby można było skonfigurować elementy webhook dla usługi geoprzetwarzania, usługa musi być asynchroniczna.
Notatka:
W tej wersji elementy webhook usług są funkcjami w fazie beta. Funkcje w fazie beta mogą nie być kompletne, mogą w nich występować znane problemy z wydajnością lub jakością i funkcje te nie będą wspierane w ramach pomocy technicznej firmy Esri. Dokumentacja wersji beta interfejsu API dla elementów webhook usług jest dostępna w pliku PDF Podręcznik interfejsu API administratora elementów webhook usług . Aby uzyskać więcej informacji o funkcjach w fazie beta w oprogramowaniu ArcGIS Enterprise, zapoznaj się z tematem Funkcje beta.
Tworzenie elementu webhook instytucji
Elementy webhook instytucji umożliwiają subskrybowanie wyzwalaczy dla zdarzeń powiązanych z elementami, grupami i użytkownikami portalu ArcGIS Enterprise.
Notatka:
Aby zapoznać się z przykładowym żądaniem POST, które tworzy element webhook dotyczący zdarzeń związanych z użytkownikami, grupami i elementami, zapoznaj się z dokumentacją tworzenia elementu webhook (Create Webhook) interfejsu API REST.
Aby utworzyć element webhook dla instytucji, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Portal Directory i zaloguj się jako członek z rolą administratora.
Elementy webhook mogą być tworzone i zarządzane tylko przez administratorów lub członków, którym przypisano rolę administratora domyślnego.
https://machine.domain.com/webadaptor/sharing/restGdy się zalogujesz, zostanie wyświetlona strona zasobów Użytkownik dla Twojego konta.
- Kliknij hiperłącze ID instytucji lub utwórz żądanie w poniższej postaci, aby przejść do strony zasobów Portale > Własny.
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Przewiń do dołu strony zasobów Własny i kliknij opcję Element webhook > Utwórz element webhook, aby uzyskać dostęp do operacji Utwórz element webhook.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa.
- W polu tekstowym Adres URL ładunku podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a portalem ArcGIS Enterprise.
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 klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz tajny (opcjonalnie).
- Opcjonalnie określ informacje o dezaktywacji elementu webhook w polu tekstowym Właściwości konfiguracji.
Domyślnie element webhook zostaje zdezaktywowany, jeśli w ciągu pięciu dni wystąpiło pięć niepowodzeń.
- W obszarze Które zdarzenia ma wyzwalać ten element webhook wybierz opcję Pozwól mi zdefiniować ręcznie lub opcję Wysyłaj mi wszystko.
- Jeśli wybierzesz opcję Pozwól mi zdefiniować ręcznie, w polu tekstowym Wysyłaj mi zmiany dla tych zdarzeń rozdzielanych przecinkami wypisz zdarzenia wyzwalające, które będą używane dla tego elementu webhook. Jeśli na przykład chcesz subskrybować wszystkie zdarzenia dotyczące określonej grupy w instytucji, wprowadź zdarzenie wyzwalające podobne do pokazanego poniżej, gdzie [groupID] reprezentuje niepowtarzalny identyfikator powiązany z określoną grupą:
/groups/[groupID]/update - Jeśli wybierzesz opcję Wysyłaj mi wszystko, subskrybujesz wszystkie obsługiwane zdarzenia wyzwalające. Będziesz otrzymywać powiadomienia o wszystkich zdarzeniach w miarę ich występowania.
- Jeśli wybierzesz opcję Pozwól mi zdefiniować ręcznie, w polu tekstowym Wysyłaj mi zmiany dla tych zdarzeń rozdzielanych przecinkami wypisz zdarzenia wyzwalające, które będą używane dla tego elementu webhook. Jeśli na przykład chcesz subskrybować wszystkie zdarzenia dotyczące określonej grupy w instytucji, wprowadź zdarzenie wyzwalające podobne do pokazanego poniżej, gdzie [groupID] reprezentuje niepowtarzalny identyfikator powiązany z określoną grupą:
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz element webhook, aby przesłać żądanie.
Po ukończeniu operacji do Twojej instytucji zostanie dodany nowy 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.
Notatka:
Aby zobaczyć przykładowe żądanie POST, które konfiguruje te właściwości zaawansowane, zapoznaj się z dokumentacją aktualizowania ustawień elementów webhook (Update Webhook Settings) interfejsu API REST.
Aby ustawić te zaawansowane właściwości, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Portal Directory i zaloguj się jako członek z rolą administratora. Elementy webhook mogą być tworzone i zarządzane tylko przez administratorów lub członków, którym przypisano rolę administratora domyślnego.
https://machine.domain.com/webadaptor/sharing/restGdy się zalogujesz, zostanie wyświetlona strona zasobów Użytkownik dla Twojego konta.
- Kliknij hiperłącze ID instytucji lub utwórz żądanie w poniższej postaci, aby przejść do strony zasobów Portale > Własny.
https://machine.domain.com/webadaptor/sharing/rest/portals/self - Przewiń do dołu strony zasobów Własny i kliknij opcję Element webhook > Ustawienia > Aktualizuj, aby uzyskać dostęp do operacji Aktualizuj element webhook.
- W punkcie końcowym Aktualizuj element webhook podaj następujące informacje:
- Ustaw wartość ustawienia Liczba prób powiadomienia.
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 0–5.
- Ustaw wartość ustawienia Limit czasu powiadomienia w sekundach.
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 przedziału od 0 do 60 sekund.
- Ustaw wartość ustawienia Czas między powiadomieniami w sekundach.
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 powiadomienia.
- Ustaw wartość ustawienia Liczba prób powiadomienia.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Aktualizuj ustawienia elementu webhook, aby przesłać żądanie.
Po ukończeniu operacji zaktualizowane właściwości zostaną zastosowane do każdego skonfigurowanego elementu webhook instytucji.
Tworzenie elementu webhook usługi geoprzetwarzania
Elementy webhook usług geoprzetwarzania umożliwiają subskrybowanie określonych wyzwalaczy zdarzeń związanych z usługami geoprzetwarzania.
Notatka:
Aby zobaczyć przykładowe żądanie POST, które tworzy element webhook dla usług geoprzetwarzania, zapoznaj się z dokumentacją interfejsu API REST elementów webhook w wersji beta w pliku PDF Podręcznik interfejsu API administratora elementów webhook usług .
Aby utworzyć element webhook dla usługi geoprzetwarzania, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Server Administrator Directory i zaloguj się jako członek z przypisanymi odpowiednimi uprawnieniami administratora.Elementy webhook mogą być tworzone i zarządzane tylko przez administratorów, którzy mają przypisane uprawnienia administratora aktualizacji, usuwania, zabezpieczeń i infrastruktury lub serwerów albo którym przypisano rolę administratora domyślnego.
https://machine.domain.com/webadaptor/admin - Po zalogowaniu się przejdź do zasobu Elementy webhook dla usługi geoprzetwarzania, klikając opcję Usługi > [ServiceName] > Elementy webhook > Utwórz, gdzie [ServiceName] oznacza usługę, dla której zostanie utworzony element webhook. W przypadku usług znajdujących się w określonych folderach kliknij opcję Usługi > [FolderName] > [ServiceName] > Elementy webhook > Utwórz, gdzie [FolderName] oznacza folder, w którym znajduje się usługa.
Uwaga:
Aby można było skonfigurować elementy webhook dla usługi geoprzetwarzania, ta usługa musi być asynchroniczna.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa. Podana nazwa może zawierać tylko wartości alfanumeryczne. Użycie znaków specjalnych spowoduje zwrócenie odpowiedzi z informacją o błędzie.
- Opcjonalnie ustaw klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz podpisu.
- W polu tekstowym Adres URL elementu hook podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a serwerem ArcGIS Server wdrożenia. Przykładowy ładunek 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 określ typ nośnika. Z menu rozwijanego Typ zasobów wybierz jedną z następujących opcji:
- application/json (domyślne)
- application/x-www-form-urlencoded
- Opcjonalnie zdefiniuj format ładunków. Z menu rozwijanego Format ładunku wybierz jedną z następujących opcji:
- JSON (domyślne)
- PJSON
- Opcjonalnie użyj parametru Aktywne, aby wyłączyć lub włączyć wywołania zwrotne w przypadku wyzwolenia elementu webhook. Aby włączyć, wybierz opcję Prawda. Aby wyłączyć, wybierz opcję Fałsz.
Domyślnie wywołania zwrotne są włączone.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz, aby przesłać żądanie.
Po ukończeniu operacji do określonej usługi geoprzetwarzania zostanie zastosowany nowy element webhook.
Notatka:
W przeciwieństwie do elementów webhook instytucji i usług obiektowych elementy webhook usług geoprzetwarzania nie mają wyzwalaczy zdarzeń zdefiniowanych przez użytkownika. Elementy webhook usług geoprzetwarzania dostarczają ładunki po ukończeniu zadania geoprzetwarzania. Aby uzyskać więcej informacji na temat ładunków dostarczanych dla usług geoprzetwarzania, zapoznaj się z tematem Ładunki.Tworzenie elementu webhook usługi obiektowej
Elementy webhook usług obiektowych umożliwiają subskrybowanie określonych wyzwalaczy zdarzeń związanych z usługami obiektowymi.
Notatka:
Aby zobaczyć przykładowe żądanie POST, które tworzy element webhook dla usług obiektowych, zapoznaj się z dokumentacją interfejsu API REST elementów webhook w wersji beta w pliku PDF Podręcznik interfejsu API administratora elementów webhook usług .
Aby utworzyć element webhook dla usługi obiektowej, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Server Administrator Directory i zaloguj się jako członek z przypisanymi odpowiednimi uprawnieniami administratora.
Elementy webhook mogą być tworzone i zarządzane tylko przez administratorów, którzy mają przypisane uprawnienia administratora aktualizacji, usuwania, zabezpieczeń i infrastruktury lub serwerów albo którym przypisano rolę administratora domyślnego.
https://machine.domain.com/webadaptor/admin - Po zalogowaniu się przejdź do zasobu Elementy webhook dla usługi obiektowej, klikając opcję Usługi > [ServiceName] > Elementy webhook > Utwórz, gdzie [ServiceName] oznacza usługę, dla której zostanie utworzony element webhook. W przypadku usług znajdujących się w określonych folderach kliknij opcję Usługi > [FolderName] > [ServiceName] > Elementy webhook > Utwórz, gdzie [FolderName] oznacza folder, w którym znajduje się usługa.
Uwaga:
Aby można było skonfigurować elementy webhook dla usługi obiektowej, usługa musi mieć możliwość edycji i mieć włączone śledzenie zmian bez synchronizacji.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa. Podana nazwa może zawierać tylko wartości alfanumeryczne. Użycie znaków specjalnych spowoduje zwrócenie odpowiedzi z informacją o błędzie.
- Podaj wyzwalacze zdarzeń, które będą używane dla tego elementu webhook, w polu tekstowym Typ zmiany. Aby na przykład wywoływać element webhook za każdym razem, gdy tworzona jest usługa obiektowa, użyj następującego wyzwalacza zdarzeń:
Przykład
FeaturesCreated - Opcjonalnie ustaw klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz podpisu.
- W polu tekstowym Adres URL elementu hook podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a serwerem ArcGIS Server wdrożenia. Przykładowy ładunek 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 określ typ nośnika. Z menu rozwijanego Typ zasobów wybierz jedną z następujących opcji:
- application/json (domyślne)
- application/x-www-form-urlencoded
- Opcjonalnie zdefiniuj format ładunków. Z menu rozwijanego Format ładunku wybierz jedną z następujących opcji:
- JSON (domyślne)
- PJSON
- Opcjonalnie użyj parametru Aktywne, aby wyłączyć lub włączyć wywołania zwrotne w przypadku wyzwolenia elementu webhook. Aby włączyć, wybierz opcję Prawda. Aby wyłączyć, wybierz opcję Fałsz.
Domyślnie wywołania zwrotne są włączone.
- Dostosuj harmonogram dla elementów webhook, modyfikując informacje Sekundy w polu tekstowym Harmonogram. W przypadku usług obiektowych, które są często edytowane, zmniejsz wartość Sekundy, aby odbierać częstsze elementy webhook z mniejszą ilością informacji o zdarzeniach w ładunku. W przypadku usług obiektowych, które nie są często zmieniane, zwiększ wartość właściwości Sekundy, aby odbierać rzadsze elementy webhook z większą ilością informacji o zdarzeniach w ładunku.
Minimalna i domyślna wartość harmonogramu to 20 sekund.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz, aby przesłać żądanie.
Po ukończeniu operacji do określonej usługi obiektowej zostanie zastosowany nowy element webhook.