Przycisk odnośnika
Skonfiguruj przycisk otwierający odnośnik lub wysyłający żądanie HTTP, wstaw dane systemowe za pomocą znaczników i określ sposób wyświetlania odpowiedzi.
Przycisk odnośnika (Link Button) jest konfigurowalnym przyciskiem, który administrator może udostępnić użytkownikom systemu. Po kliknięciu wykonuje działanie określone w konfiguracji.
Przycisk może ułatwić codzienne zadania, takie jak otwarcie mapy, przejście do innego systemu, pobranie informacji o zgłoszeniu lub wysłanie danych do zewnętrznej aplikacji. Użytkownik może wykonać te czynności bez ręcznego wyszukiwania adresów i kopiowania danych.
Przycisk odnośnika obsługuje dwa typy działań: Odnośnik i Żądanie. Ustawienia są dostępne po naciśnięciu przycisku .
Sekcje opisu przycisku:
1. Przeznaczenie
Typy działań
Odnośnik
Działanie Odnośnik otwiera wskazane adresy internetowe lub uruchamia obsługiwane aplikacje zewnętrzne.
Przykłady zastosowania:
- otwarcie mapy pokazującej lokalizację;
- przejście do strony internetowej lub narzędzia używanego w pracy;
- otwarcie aplikacji, takiej jak TeamViewer lub AnyDesk.
Administrator wskazuje adres do otwarcia i wybiera, czy ma on zostać otwarty w tym samym oknie przeglądarki, czy w nowej karcie.
Żądanie
Działanie Żądanie wysyła żądania do innych systemów, na przykład w celu pobrania informacji lub przekazania danych. Może służyć do komunikacji z API, czyli interfejsem umożliwiającym aplikacjom wymianę danych.
Przykłady zastosowania:
- pobranie bieżącego statusu zgłoszenia;
- wysłanie danych zgłoszenia do innego systemu;
- aktualizacja wybranych informacji w zewnętrznej aplikacji;
- wyświetlenie wyniku operacji.
W tym trybie administrator określa metodę żądania, adres docelowy i dane wysyłane do zewnętrznego systemu.
Korzystanie z danych systemowych
W trybie Żądanie można używać znaczników odwołujących się do danych dostępnych w systemie. Dzięki nim przycisk może wysyłać informacje dotyczące konkretnego zgłoszenia, użytkownika, zasobu lub kontraktu.
Znaczniki można dodawać za pomocą kreatora otwieranego ikoną nożyczek. Zamiast ręcznie wpisywać składnię znacznika, administrator wybiera kategorię i pole, z którego ma zostać pobrana wartość. System automatycznie wstawia odpowiednie wyrażenie.
Dostępne kategorie obejmują:
- dane systemowe;
- dane użytkownika;
- dane zgłoszenia;
- dane zasobu;
- dane kontraktu.
Kategorie mogą również zawierać pola niestandardowe utworzone w danej konfiguracji systemu.
Przycisk może na przykład wysłać do zewnętrznego systemu identyfikator zgłoszenia lub wartość jednego z jego pól. Wartości są pobierane z odpowiednich danych systemowych, dlatego ta sama konfiguracja przycisku może być używana dla różnych rekordów.
Wyświetlanie odpowiedzi
W trybie Żądanie można włączyć opcję Czekaj na odpowiedź, aby skonfigurować sposób wyświetlania odpowiedzi z zewnętrznego systemu.
Po włączeniu tej opcji staje się dostępne pole Szablon HTML okna odpowiedzi. Administrator może w nim określić wygląd odpowiedzi.
Szablon wykorzystuje HTML i może również korzystać z AngularJS. Odpowiedź jest dostępna w zmiennej {{response}}.
Administrator może przedstawić wynik w czytelnej formie, na przykład w oknie z nagłówkiem i sformatowaną treścią. Szablon można dostosować do rodzaju danych zwracanych przez zewnętrzny system.
Przykłady zastosowania
Przycisk odnośnika może ułatwić wiele codziennych zadań, na przykład:
- Otwieranie mapy: przycisk typu Odnośnik otwiera adres mapy w nowej karcie przeglądarki.
- Pobieranie statusu zgłoszenia: przycisk typu Żądanie wysyła żądanie GET do zewnętrznego API.
- Wysyłanie danych zgłoszenia: przycisk typu Żądanie wysyła dane do innego systemu, na przykład metodą POST.
- Aktualizacja informacji: przycisk typu Żądanie wysyła dane potrzebne do aktualizacji rekordu w zewnętrznym systemie, na przykład metodą PATCH.
- Automatyczne przekazywanie danych: znaczniki pozwalają dołączyć do żądania identyfikator zgłoszenia lub wartość pola niestandardowego.
- Wyświetlanie wyników operacji: opcja Czekaj na odpowiedź i Szablon HTML okna odpowiedzi pozwalają użytkownikowi wyświetlić odpowiedź otrzymaną z zewnętrznego systemu.
Działanie przycisku zależy od jego konfiguracji i możliwości systemu, z którym się komunikuje.
2. Konfiguracja
Przycisk konfiguruje się w panelu administracyjnym po naciśnięciu przycisku . W sekcji Typ działania wybierz kartę Odnośnik lub Żądanie, zależnie od tego, co przycisk ma robić.
Po wybraniu odpowiedniej karty uzupełnij wymagane pola i dostosuj pozostałe ustawienia do potrzeb.
2.1. Konfiguracja odnośnika
Karta Odnośnik pozwala skonfigurować przycisk otwierający wskazany adres. Poniżej opisano opcje dostępne przy konfiguracji.
Pokaż ostrzeżenie przed otwarciem odnośnika
Ta opcja wyświetla ostrzeżenie przed otwarciem odnośnika.
Zaznacz tę opcję, jeśli użytkownicy mają otrzymać ostrzeżenie przed przejściem pod wskazany adres.
Przycisk
W tej sekcji określa się tekst wyświetlany na przycisku.
Tekst przycisku
Wpisz etykietę przycisku widoczną dla użytkownika. To pole jest wymagane. Aby przycisk dobrze wyglądał na ekranach o różnych rozmiarach, użyj krótkiej, czytelnej etykiety wskazującej, co stanie się po kliknięciu.
Ustawienia odnośnika
W tej sekcji konfiguruje się adres odnośnika i sposób jego otwierania.
Adres odnośnika
Wpisz adres otwierany po kliknięciu przycisku. To pole jest wymagane.
Informacja Dozwolone formaty pod polem zawiera przykłady obsługiwanych formatów adresu:
google.comhttps://google.comhttp://google.comwww.google.comTeamViewerAnyDesk
Pole może służyć do otwierania stron internetowych oraz adresów powiązanych z zewnętrznymi aplikacjami. Uruchomienie aplikacji zewnętrznej zależy od tego, czy jest zainstalowana i poprawnie skonfigurowana w systemie użytkownika.
W przypadku stron internetowych zalecane są adresy HTTPS.
Gdzie otworzyć odnośnik
Wybierz sposób otwierania adresu.
Dostępne opcje:
- W tym samym oknie: otwiera adres w bieżącym oknie przeglądarki.
- W nowej karcie: otwiera adres w nowej karcie przeglądarki.
Zapisywanie konfiguracji
Po uzupełnieniu wymaganych pól możesz zapisać konfigurację przycisku.
- Zapisz: zapisuje konfigurację.
- Anuluj: anuluje edycję.
Przed zapisaniem sprawdź, czy pola Tekst przycisku i Adres odnośnika zostały uzupełnione.
2.2. Konfiguracja żądania
Karta Żądanie pozwala skonfigurować przycisk wysyłający żądanie pod wskazany adres. Można go wykorzystać do komunikacji z innymi systemami, na przykład do pobierania informacji, wysyłania danych lub wykonywania operacji z użyciem danych zgłoszenia.
Na tej karcie można określić metodę żądania, miejsce jego wykonania, adres docelowy oraz dodatkowe opcje obsługi żądania i odpowiedzi.
Pokaż ostrzeżenie przed wykonaniem żądania
Ta opcja wyświetla ostrzeżenie przed wysłaniem żądania.
Zaznacz tę opcję, jeśli użytkownicy mają otrzymać ostrzeżenie przed wykonaniem operacji. Może być przydatna, gdy żądanie wysyła dane do innego systemu lub zmienia istniejące dane.
Przycisk
W tej sekcji określa się tekst wyświetlany na przycisku.
Tekst przycisku
Wpisz etykietę przycisku widoczną dla użytkownika. To pole jest wymagane. Aby przycisk dobrze wyglądał na ekranach o różnych rozmiarach, użyj krótkiej, czytelnej etykiety wskazującej, co stanie się po kliknięciu.
Ustawienia żądania
W tej sekcji określa się sposób wysyłania żądania i jego miejsce docelowe.
Metoda
Wybierz metodę HTTP określającą rodzaj wykonywanej operacji.
Dostępne metody:
- GET: pobiera informacje z systemu docelowego.
- POST: wysyła dane do systemu docelowego, na przykład w celu utworzenia nowego rekordu lub rozpoczęcia operacji.
- PUT: wysyła dane w celu utworzenia lub zastąpienia zasobu, zależnie od działania systemu docelowego.
- PATCH: wysyła dane w celu aktualizacji wybranych informacji.
- DELETE: wysyła żądanie usunięcia zasobu w systemie docelowym.
Wybierz metodę zgodną z wymaganiami systemu odbierającego żądanie.
Gdzie wykonać żądanie
Wybierz miejsce wykonania żądania.
Dostępne opcje:
- Frontend: żądanie jest wykonywane w przeglądarce użytkownika.
- Backend: żądanie jest wykonywane po stronie serwera.
Właściwa opcja zależy od sposobu integracji i wymagań operacji.
Adres żądania
Wpisz adres, pod który zostanie wysłane żądanie. To pole jest wymagane.
Przykładowy adres:
https://api.example.com/resource/123
Adres powinien wskazywać punkt końcowy API lub inną usługę obsługującą wybraną metodę żądania.
Przycisk z ikoną nożyczek pod polem otwiera kreator znaczników. Pozwala on wstawić wartości z danych systemowych, takie jak identyfikator zgłoszenia lub wartość pola niestandardowego.
Dzięki temu adres można dostosować do rekordu, dla którego użytkownik klika przycisk.
Treść JSON
W tym polu określa się treść żądania w formacie JSON. Jest dostępne dla metod POST, PUT i PATCH.
Treść JSON może zawierać dane wysyłane do systemu docelowego. Można też używać znaczników, aby wypełnić treść żądania wartościami z systemu.
Możesz na przykład wysłać do zewnętrznego systemu identyfikator zgłoszenia i jego status.
Pole Treść JSON nie jest wyświetlane dla metod GET i DELETE.
Opcje dodatkowe
Ufaj wszystkim certyfikatom
Ta opcja dotyczy weryfikacji certyfikatów używanych podczas łączenia z systemem docelowym.
Korzystaj z tej opcji ostrożnie. W środowiskach produkcyjnych zaleca się pozostawienie jej wyłączonej, chyba że istnieje konkretny powód zmiany sposobu weryfikacji certyfikatów.
Czekaj na odpowiedź
Zaznacz tę opcję, jeśli przycisk ma czekać na odpowiedź z systemu docelowego i udostępnić ją do wyświetlenia użytkownikowi.
Po włączeniu tej opcji staje się dostępne pole Szablon HTML okna odpowiedzi, w którym można określić sposób wyświetlania odpowiedzi.
Szablon HTML okna odpowiedzi
To pole pojawia się po włączeniu opcji Czekaj na odpowiedź. Pozwala utworzyć szablon HTML określający sposób prezentacji odpowiedzi z systemu docelowego.
Szablon może korzystać z AngularJS, a odpowiedź jest dostępna w zmiennej {{response}}.
Przykład prostego szablonu:
<div>
<h3>Operation result</h3>
<pre>{{response}}</pre>
</div>
W tym przykładzie odpowiedź jest wyświetlana pod nagłówkiem „Operation result”. Element pre zachowuje formatowanie wyświetlanego tekstu.
Szablon można dostosować do rodzaju danych zwracanych przez API.
Zapisywanie konfiguracji
Po uzupełnieniu wymaganych pól możesz zapisać konfigurację przycisku.
- Zapisz: zapisuje konfigurację.
- Anuluj: kończy edycję bez zapisywania zmian.
Przed zapisaniem sprawdź, czy pola Tekst przycisku i Adres żądania zostały uzupełnione. Dostosuj pozostałe ustawienia do wymagań operacji.
3. Przykłady konfiguracji
3.1. Otwieranie mapy: odnośnik
Aby utworzyć przycisk otwierający mapę, skonfiguruj go następująco:
| Pole | Wartość |
|---|---|
| Typ działania | Odnośnik |
| Tekst przycisku | Otwórz mapę |
| Adres odnośnika | Adres wybranej mapy |
| Gdzie otworzyć odnośnik | W nowej karcie |
Możesz włączyć opcję Pokaż ostrzeżenie przed otwarciem odnośnika, jeśli przed otwarciem adresu ma pojawić się ostrzeżenie.
Po uzupełnieniu pól kliknij Zapisz, aby zapisać konfigurację.
Gdy użytkownik kliknie przycisk Otwórz mapę, skonfigurowany adres otworzy się w nowej karcie przeglądarki.
Jeśli zaznaczono opcję Pokaż ostrzeżenie przed otwarciem odnośnika, po kliknięciu pojawi się okno ostrzeżenia.
Jeśli adres ma być generowany z danych zgłoszenia lub zasobu, sprawdź, czy pole Adres odnośnika obsługuje mechanizmy dynamicznego podstawiania wartości, takie jak znaczniki.
3.2. Pobieranie nazwy zgłoszenia: żądanie
Administrator chce udostępnić użytkownikom przycisk pobierający nazwę aktualnie przeglądanego zgłoszenia. Po kliknięciu przycisku system wysyła żądanie do API, a następnie wyświetla odpowiedź.
Przykładowa konfiguracja:
| Pole | Wartość |
|---|---|
| Typ działania | Żądanie |
| Tekst przycisku | Pobierz nazwę zgłoszenia |
| Metoda | GET |
| Gdzie wykonać żądanie | Frontend |
| Adres żądania | Adres API zawierający identyfikator zgłoszenia |
| Ufaj wszystkim certyfikatom | Wyłączone |
| Czekaj na odpowiedź | Włączone |
W polu Adres żądania wpisz odpowiedni punkt końcowy API. Jeśli adres ma zawierać identyfikator bieżącego zgłoszenia, możesz wstawić go za pomocą kreatora znaczników, dostępnego po kliknięciu ikony nożyczek. W tym przykładzie znacznik {{TicketId}} zostanie zastąpiony identyfikatorem zgłoszenia aktualnie przeglądanego przez użytkownika.
Adres może na przykład wyglądać następująco:
https://mintsd.opgksoftware.com/api/tickets/{{TicketId}}
Aby wyświetlić odpowiedź otrzymaną z systemu docelowego, włącz opcję Czekaj na odpowiedź. Następnie w polu Szablon HTML okna odpowiedzi utwórz szablon wyświetlający zwrócone dane. W tym przykładzie potrzebny jest tylko parametr nazwy.
Przykładowy szablon:
<div>
<strong>Ticket name:</strong> {{response.data.name}}
</div>
Wygląd odpowiedzi można dostosować, wpisując kod HTML wraz ze stylami.
Poniżej przedstawiono przykładową konfigurację:
Po zapisaniu konfiguracji użytkownicy mogą kliknąć przycisk Pobierz nazwę zgłoszenia.
System wysyła żądanie GET pod wskazany adres, a odpowiedź jest udostępniana w skonfigurowanym oknie.
Rzeczywisty wynik zależy od danych zwróconych przez API i konfiguracji systemu docelowego.