Elementy webhook to powszechnie używana metoda umożliwiająca wzajemną interakcję wielu aplikacji, która wykorzystuje żądania HTTP POST do przekazywania wywołań zwrotnych między nimi. Więcej informacji można znaleźć na stronie Wikipedii poświęconej elementom webhook. Typowe zastosowania elementów webhook obejmują wysyłanie powiadomień w wiadomościach e-mail lub SMS, publikowanie wiadomości w mediach społecznościowych, automatyczne zapisywanie rekordów w arkuszu kalkulacyjnym i aktualizowanie profesjonalnych baz danych.
W aplikacji ArcGIS Survey123 można skonfigurować i aktywować elementy webhook podczas przesyłania odpowiedzi na ankietę. Na przykład po pomyślnym przesłaniu informacji do warstwy obiektowej można wywołać element webhook i wyzwolić inne działanie, takie jak wysłanie powiadomienia e-mail, dołączenie zawartości ankiety do arkusza kalkulacyjnego lub wysłanie alertu.
W miejscu pracy użytkownika może być używany własny dostawca elementów webhook, ale dostępny jest także szereg usług procedur wykonywania zadań innych firm, takich jak Microsoft Power Automate, Make (wcześniej Integromat), Zapier i tray.io. Wszystkie te usługi mogą uwzględniać aplikację Survey123 jako wyzwalacz zautomatyzowanego procesu. W szczególności każda z usług Microsoft Power Automate i Make zawiera wbudowany łącznik aplikacji Survey123, dzięki czemu możliwe jest łatwe zintegrowanie aplikacji Survey123 z procedurą wykonywania zadań elementów webhook bez konieczności konfigurowania elementu webhook w witrynie Survey123 lub wprowadzania adresu URL ładunku.
Uwaga:
Gdy tworzysz lub modyfikujesz element webhook ankiety, ankietę należy zaktualizować w aplikacji terenowej Survey123, aby zmiany odniosły skutek.
Istnieje wiele sposobów używania aplikacji Survey123 jako wyzwalacza w procedurach wykonywania zadań. W trzech dalszych sekcjach zostanie przedstawiony sposób konfigurowania elementu webhook, który ma wysyłać wiadomość e-mail, gdy zostanie wysłana odpowiedź na pytanie zawierająca pewną wartość.
Na końcu tego tematu są w celach referencyjnych wymienione wszystkie właściwości, które są dostępne w ładunku zdarzenia elementu webhook.
Konfigurowanie elementu webhook w usłudze Make
Make (wcześniej Integromat) jest platformą automatyzacji online. Zarejestruj się i utwórz bezpłatne konto, aby rozpocząć pracę. Platforma Make zawiera szablony, które mogą stanowić punkt wyjścia przy dołączaniu załączników do powiadomień e-mail, dodawaniu rekordów do arkuszy kalkulacyjnych i tworzeniu elementów kalendarza.
- Przejdź na stronę https://www.make.com/ i się zaloguj.
- Na stronie Scenariusze kliknij przycisk Utwórz nowy scenariusz.
- Kliknij ikonę modułu pośrodku ekranu. Wyszukaj aplikację Survey123 i ją wybierz.
- Wybierz moduł wywołujący Ankieta obserwacyjna.
Ten moduł został zaprojektowany w taki sposób, by uruchamiał ten scenariusz za każdym razem, gdy przesyłana jest odpowiedź na ankietę.
Zostanie wyświetlone okno podręczne ułatwiające skonfigurowaniem modułu Watch survey (Ankieta obserwacyjna).
Wskazówka:
Moduł Tworzenie raportu może być używany o generowania raportu dotyczącego odpowiedzi na ankietę.
- Kliknij przycisk Dodaj i podaj nazwę elementu webhook.
Ta nazwa powinna być unikalna w ankiecie, dla której jest konfigurowany element webhook.
- Jeśli po raz pierwszy korzystasz z modułu Survey123 w usłudze Make, skonfiguruj połączenie z instytucją ArcGIS. Tę czynność należy wykonać tylko raz, ponieważ platforma Make zapisuje poświadczenia do użytku w przyszłości. W obszarze Połączenie kliknij przycisk Dodaj i nadaj nazwę połączeniu z systemem ArcGIS.
- Aby nawiązać połączenie z usługą ArcGIS Online, kliknij przycisk Zapisz i zaloguj się w instytucji ArcGIS.
- Aby połączyć się z oprogramowaniem ArcGIS Enterprise, zarejestruj platformę Make w portalu. Więcej informacji na ten temat zawiera wpis na blogu Tajniki aplikacji Survey123: Make.
- Wybierz ankietę z instytucji ArcGIS, z którą chcesz się połączyć.
- Rozważ opcje, które chcesz uwzględnić w elemencie webhook i kliknij przycisk Zapisz.
Dla wszystkich ustawień zaawansowanych zalecane jest pozostawienie wartości domyślnej Tak. Zapewnia to większą elastyczność przy dostosowywaniu elementu webhook.
- Kliknij przycisk OK.
Element webhook zostanie utworzony, a moduł Watch survey (Ankieta obserwacyjna) zostanie skonfigurowany.
- Kliknij przycisk Dodaj inny moduł po prawej stronie modułu Watch survey (Ankieta obserwacyjna), aby połączyć z nim inny moduł.
- Wyszukaj pozycję Wiadomość e-mail i wybierz moduł Wiadomość e-mail.
- Wybierz działanie Wyślij wiadomość e-mail.
- Jeśli po raz pierwszy korzystasz z tego modułu w usłudze Make, kliknij przycisk Dodaj, aby skonfigurować połączenie z kontem e-mail. Wybierz typ połączenia i zaloguj się na konto.
Tę czynność należy wykonać tylko raz, ponieważ platforma Make zapisuje połączenie do użytku w przyszłości.
- Dodaj adres e-mail odbiorcy.
Jest to adres e-mail, na który będą wysyłane wyzwalane wiadomości e-mail.
- Kliknij pole tekstowe tematu. Wybierz pola z ankiety, aby utworzyć temat wiadomości e-mail z użyciem panelu ustawień modułu, który zostanie wyświetlony.
- Kliknij pole tekstowe treści. Wybierz pola z ankiety, aby zredagować treść wiadomości e-mail z użyciem panelu ustawień modułu, który zostanie wyświetlony. Treść można sformatować przy użyciu języka HTML.
- Kliknij przycisk OK.
W tym scenariuszu wiadomość e-mail będzie wysyłana po uzyskaniu określonej odpowiedzi na pytanie, dlatego należy podać filtr.
- Kliknij przycisk narzędzi znajdujący się między tymi dwoma modułami i wybierz opcję Skonfiguruj filtr.
- Kliknij pole tekstowe Warunek i wybierz w ankiecie pole, którego chcesz użyć w filtrze.
- Wybierz operator dla warunku. W tym przypadku wybierz operator domyślny, Równa się.
- Wprowadź wartość dla warunku i kliknij przycisk OK.
- Kliknij przycisk Zapisz, aby zapisać scenariusz.
Opcjonalnie możesz kliknąć opcję Uruchom jeden raz, aby przetestować element webhook. Po kliknięciu opcji Uruchom jeden raz otwórz aplikację Survey123 i prześlij ankietę, upewniając się, że odpowiedź na ankietę spełnia warunek filtru. Upewnij się, że odbiorca otrzymuje wiadomość e-mail.
- Aktywuj scenariusz za pomocą przełącznika znajdującego się w lewej dolnej części strony. Skonfiguruj w harmonogramie ustawienie Natychmiast, aby zapewnić, że scenariusz będzie uruchamiany za każdym razem po przesłaniu odpowiedzi na ankietę.
Aby poznać dodatkowe sposoby używania aplikacji Survey123 jako wyzwalacza w scenariuszach usługi Make, należy zapoznać się z integracjami Survey123.
Konfigurowanie elementu webhook w usłudze Microsoft Power Automate
Microsoft Power Automate to usługa elementów webhook udostępniana na platformie Microsoft Office 365.
Notatka:
Poświadczenia ArcGIS Online używane do tworzenia przepływów w aplikacji Power Automate są automatycznie wylogowywane po dwóch tygodniach. Jeśli nie można przeglądać oczekiwanych ankiet w aplikacji Power Automate, upewnij się, że jest aktywne połączenie danych aplikacji Survey123. Więcej informacji zawiera artykuł bazy wiedzy Brak ankiet na liście rozwijanej.
W następujących etapach opisano sposób konfigurowania przepływu z użyciem wbudowanego łącznika Survey123 dla ankiet opublikowanych w usłudze ArcGIS Online. Aby użyć usługi Power Automate z ankietami opublikowanymi w oprogramowaniu ArcGIS Enterprise, należy skonfigurować łącznik niestandardowy. Więcej informacji na ten temat zawiera artykuł bazy wiedzy Jak utworzyć łącznik ArcGIS Survey123 dla usługi Microsoft Power Automate do korzystania z oprogramowaniem ArcGIS Enterprise.
- Otwórz aplikację Microsoft Power Automate.
- W menu bocznym strony wybierz opcję Utwórz.
- Wybierz pozycję Automatyczny przepływ w chmurze z opcji Rozpocznij od pustego.
Zostanie wyświetlone okno dialogowe Tworzenie automatycznego przepływu w chmurze.
- Nazwij przepływ.
Następnie należy wybrać wyzwalacz.
- Wpisz w polu wyszukiwania Survey123. Wybierz opcję Po przesłaniu odpowiedzi na ankietę.
- Kliknij przycisk Utwórz.
- Jeśli po raz pierwszy korzystasz z tego łącznika w usłudze Microsoft Power Automate, kliknij przycisk Zaloguj się, aby zalogować się przy użyciu swoich poświadczeń instytucji ArcGIS.
Tę czynność należy wykonać tylko raz, ponieważ platforma Microsoft Power Automate zapisuje poświadczenia do użytku w przyszłości.
- Z rozwijanej listy ankiet wybierz ankietę, którą chcesz używać dla swojego elementu webhook.
Właśnie skonfigurowano wyzwalacz dla elementu webhook. Aby jednak ten element webhook mógł wykonywać działania przy użyciu tego wyzwalacza, proces wymaga zdefiniowania dodatkowych etapów.
W tym przepływie należy wysłać wiadomość e-mail po uzyskaniu określonej odpowiedzi na pytanie, dlatego należy podać warunek.
- Kliknij przycisk Nowy etap i wybierz Warunek w górnej części sekcji Działania.
- Kliknij lewe pole tekstowe, aby otworzyć okno dialogowe wyboru pytania lub właściwości z ankiety. Wybierz pytanie ankiety, którego chcesz użyć do zakwalifikowania ankiety.
- Środkowe pole tekstowe to menu rozwijane umożliwiające wybranie warunku wyzwalającego. Ponieważ szukasz dokładnej odpowiedzi, wybierz opcję jest równe.
- W prawym polu tekstowym wpisz wartość pytania, dla której chcesz wysłać powiadomienie.
Ta wiadomość e-mail ma być wysyłana tylko wtedy, gdy warunek jest spełniony.
- Kliknij opcję Dodaj działanie w polu Jeśli tak. Pole Jeśli nie pozostaje puste.
Wiele usług poczty ma łączniki, których można użyć w tym przepływie.
- W tym ćwiczeniu wybierz opcję Office 365 Outlook – Wyślij wiadomość e-mail (V2).
- Zaloguj się do usługi poczty przy użyciu swoich poświadczeń, jeśli nie zostały one jeszcze zapisane.
- Wypełnij pola Do, Temat oraz Treść swojej wiadomości e-mail.
Okno dialogowe Zasoby dynamiczne, które zostaje wyświetlone po wybraniu pola tekstowego, umożliwia wstawienie zawartości z odpowiedzi na ankietę, jeśli to konieczne.
- Po utworzeniu wiadomości e-mail kliknij przycisk Zapisz.
Element webhook jest kompletny i domyślnie aktywny. Element webhook będzie uruchamiany za każdym razem, gdy zostanie przesłana odpowiedź na ankietę spełniająca podane warunki.
Wskazówka:
Aby wygenerować raport dla odpowiedzi na ankietę, można użyć działania Utwórz raport.
Konfigurowanie elementu webhook w witrynie Survey123
Wykonaj następujące czynności, aby skonfigurować element webhook w witrynie Survey123:
- Na stronie Moje ankiety wybierz kartę Ustawienia z menu znajdującego się w prawym dolnym rogu panelu ankiety.
- Wybierz sekcję Elementy webhook w menu po lewej stronie.
Ta strona umożliwia konfigurowanie elementów webhook i zapewnia dostęp do utworzonych elementów. Jeśli w aplikacji Survey123 nie skonfigurowano żadnych elementów webhook, ta strona jest pusta.
- Kliknij przycisk Dodaj element webhook.
Zostanie wyświetlona nowa strona umożliwiająca skonfigurowanie sposobu interakcji elementu webhook z ankietą.
- Podaj nazwę elementu webhook, która posłuży do jego identyfikacji w przyszłości.
- Adres URL ładunku to miejsce, w które będą wysyłane informacje z ankiety. Ten adres musi zostać podany przez zewnętrzną usługę elementów webhook.
Jeśli element webhook jest tworzony za pomocą usługi, na przykład Microsoft Power Automate lub Make, adres URL ładunku na tej stronie jest zapełniany automatycznie. Inne usługi, takie jak Zapier czy FME Server, podają adres URL ładunku do skopiowania do tej strony. Inne aplikacje mogą wymagać utworzenia dedykowanej usługi do nasłuchiwania elementu webhook.
- Zdarzenia wyzwalacza opisują działania, które powodują wywołanie elementu webhook. Wybierz opcję Przesłanie nowego rekordu.
- Sekcja Dane zdarzenia umożliwia wybranie informacji z ankiety, które zostaną uwzględnione w ładunku: Informacje o ankiecie, Odpowiedź serwera, Przesłany rekord, Informacje o użytkowniku oraz Informacje o portalu. Sprawdź opcje Informacje o ankiecie i Przesłany rekord.
- Przycisk przełącznika Status określa, czy element webhook będzie aktywny po zapisaniu. Pozostaw wartość Włączone (wartość domyślna).
- Kliknij przycisk Zapisz.
Element webhook jest gotowy do użycia i będzie uruchamiany za każdym razem, gdy zostanie przesłana odpowiedź na ankietę. Reguły ustawione w dostawcy elementów webhook mogą sprawić, że wiadomość e-mail będzie wysyłana tylko wtedy, gdy zostaną spełnione określone kryteria.
Właściwości ładunku zdarzenia
Zdarzenie elementu webhook wysyła ładunek właściwości w postaci obiektu JSON. Zawartość tego ładunku jest zależna od ankiety. W poniższej tabeli wymieniono typowe właściwości zawarte w obiekcie JSON:
| Właściwość | Opis |
|---|---|
| eventType | Typ zdarzenia. Możliwe wartości to addData lub editData. |
| portalInfo | Informacje na temat instytucji ArcGIS, która udostępnia ankietę. Zawiera następujące właściwości:
|
| surveyInfo | Informacje na temat ankiety, która wygenerowała element webhook. Zawiera następujące właściwości:
|
| userInfo | Informacje na temat konta instytucji ArcGIS należącego do użytkownika, który wysłał ankietę. Zawiera następujące właściwości:
|
Następujące właściwości zależą od ankiety i typu zdarzenia:
| Właściwość | Opis |
|---|---|
| applyEdits | Ładunek Zastosuj zmiany przesłany przez ankietę. Jeśli eventType ma wartość addData, zawiera adds. Jeśli eventType ma wartość editData, zawiera updates. Podczas dodawania nowego rekordu powtarzania zawiera on również adds. |
| response | Odpowiedź z operacji applyEdits. Zawiera identyfikatory globalne obiektów utworzonych przez operację oraz informacje o tym, czy operacja zakończyła się powodzeniem. |
| feature | Rekord ankiety, która została wysłana. Zawiera następujące właściwości:
|