#Niestandardowe zdarzenie akcji

#Wprowadzenie

NocoBase posiada wbudowane typowe operacje na danych (dodawanie, usuwanie, edycja, przeglądanie itp.). Gdy operacje te nie mogą zaspokoić złożonych potrzeb biznesowych, można skorzystać z niestandardowych zdarzeń akcji w przepływie pracy i powiązać to zdarzenie z przyciskiem „Uruchom przepływ pracy” w bloku strony. Po kliknięciu przez użytkownika zostanie uruchomiony przepływ pracy z niestandardową akcją.

#Tworzenie przepływu pracy

Podczas tworzenia przepływu pracy proszę wybrać „Niestandardowe zdarzenie akcji”:

#Konfiguracja wyzwalacza

#Typ kontekstu

v1.6.0+

Różne typy kontekstu określają, do których przycisków w blokach można przypisać dany przepływ pracy:

• Bez kontekstu: zdarzenie globalne, które można przypisać do przycisków akcji w panelach operacji i blokach danych;
• Pojedynczy rekord: można przypisać do przycisków akcji w blokach danych, takich jak wiersze tabeli, formularze, szczegóły itp.;
• Wiele rekordów: można przypisać do przycisków operacji masowych w tabeli.

#Kolekcja

Gdy typem kontekstu jest pojedynczy rekord lub wiele rekordów, należy wybrać kolekcję, do której ma zostać przypisany model danych:

#Dane powiązane do wykorzystania

Jeśli w przepływie pracy konieczne jest użycie danych powiązanych z wierszem danych wyzwalającym akcję, można tutaj wybrać głębokie pola powiązań:

Pola te zostaną automatycznie wstępnie załadowane do kontekstu przepływu pracy po wyzwoleniu zdarzenia, aby mogły być w nim użyte.

#Konfiguracja akcji

W zależności od typu kontekstu skonfigurowanego w przepływie pracy, konfiguracja przycisków akcji w różnych blokach również się różni.

#Bez kontekstu

v1.6.0+

W panelu operacji i innych blokach danych można dodać przycisk „Uruchom przepływ pracy”:

Po dodaniu przycisku należy przypisać wcześniej utworzony przepływ pracy bez kontekstu, biorąc za przykład przycisk w panelu operacji:

#Pojedynczy rekord

W dowolnym bloku danych, na pasku akcji dla pojedynczego rekordu, można dodać przycisk „Uruchom przepływ pracy”, np. w formularzach, wierszach tabeli, szczegółach itp.:

Po dodaniu przycisku należy przypisać wcześniej utworzony przepływ pracy:

Następnie kliknięcie tego przycisku wyzwoli niestandardowe zdarzenie akcji:

#Wiele rekordów

v1.6.0+

Na pasku akcji bloku tabeli, podczas dodawania przycisku „Uruchom przepływ pracy”, pojawi się dodatkowa opcja wyboru typu kontekstu: „Bez kontekstu” lub „Wiele rekordów”:

Wybór „Bez kontekstu” oznacza zdarzenie globalne, do którego można przypisać tylko przepływy pracy typu bez kontekstu.

Wybór „Wiele rekordów” pozwala na przypisanie przepływu pracy typu wiele rekordów, co może być użyte do operacji masowych po zaznaczeniu wielu danych (obecnie obsługiwane tylko przez tabele). W tym przypadku zakres dostępnych przepływów pracy ograniczony jest do tych, które pasują do kolekcji bieżącego bloku danych:

Podczas wyzwalania przez kliknięcie przycisku, muszą być zaznaczone niektóre wiersze danych w tabeli, w przeciwnym razie przepływ pracy nie zostanie uruchomiony:

#Przykład

Na przykład mamy kolekcję „Próbki”. Dla próbek o statusie „Zebrane” musimy udostępnić operację „Przekaż do badania”. Przekazanie najpierw sprawdzi podstawowe informacje o próbce, następnie wygeneruje rekord „Zapis badania”, a na koniec zmieni status próbki na „Przekazano do badania”. Całego tego procesu nie da się zrealizować za pomocą prostych przycisków CRUD, dlatego można użyć niestandardowego zdarzenia akcji.

Najpierw należy utworzyć kolekcję „Próbki” oraz kolekcję „Zapisy badania” i wprowadzić podstawowe dane testowe do tabeli próbek:

Następnie należy utworzyć przepływ pracy „Niestandardowe zdarzenie akcji”. Jeśli wymagana jest szybka informacja zwrotna z procesu, można wybrać tryb synchroniczny (w trybie synchronicznym nie można używać węzłów typu asynchronicznego, takich jak przetwarzanie ręczne):

W konfiguracji wyzwalacza należy wybrać kolekcję „Próbki”:

Zgodnie z potrzebami biznesowymi należy ułożyć logikę w procesie, na przykład zezwalając na przekazanie do badania tylko wtedy, gdy parametr wskaźnika jest większy niż 90, w przeciwnym razie wyświetlając stosowny komunikat:

Po skonfigurowaniu i włączeniu procesu należy wrócić do interfejsu tabeli i dodać przycisk „Uruchom przepływ pracy” w kolumnie operacji tabeli:

Następnie w menu konfiguracji przycisku należy wybrać przypisanie przepływu pracy i otworzyć okno konfiguracji:

Należy dodać wcześniej włączony przepływ pracy:

Po zatwierdzeniu należy zmienić tekst przycisku na nazwę operacji, np. „Przekaż do badania”. Proces konfiguracji jest zakończony.

Podczas użytkowania należy wybrać dowolny rekord próbki w tabeli i kliknąć przycisk „Przekaż do badania”, aby wyzwolić niestandardowe zdarzenie akcji. Zgodnie z wcześniej ułożoną logiką, jeśli parametr wskaźnika próbki jest mniejszy niż 90, po kliknięciu pojawi się następujący komunikat:

Jeśli parametr wskaźnika jest większy niż 90, proces zostanie wykonany normalnie, wygenerowany zostanie rekord „Zapis badania”, a status próbki zmieni się na „Przekazano do badania”:

W ten sposób proste niestandardowe zdarzenie akcji zostało ukończone. Podobnie, dla procesów o złożonych operacjach, takich jak obsługa zamówień czy składanie raportów, można je realizować poprzez niestandardowe zdarzenia akcji.

#Wywołanie zewnętrzne

Wyzwalanie niestandardowych zdarzeń akcji nie ogranicza się do operacji w interfejsie użytkownika; może być również wyzwalane poprzez HTTP API. W szczególności niestandardowe zdarzenia akcji udostępniają nowy typ operacji dla wszystkich operacji na kolekcjach: trigger, który można wywołać zgodnie ze standardowym API operacji NocoBase.

#Bez kontekstu

Przepływy pracy bez kontekstu wymagają wywołania operacji na zasobie workflows:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/workflows:trigger?triggerWorkflows=workflowKey"

#Pojedynczy rekord

Przepływ pracy wyzwalany przyciskiem, podobnie jak w przykładzie, można wywołać w następujący sposób:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/samples:trigger/<:id>?triggerWorkflows=workflowKey"

Ponieważ ta operacja dotyczy pojedynczego rekordu, przy wywoływaniu dla istniejących danych należy podać ID wiersza danych, zastępując część <:id> w adresie URL.

Jeśli wywołanie dotyczy formularza (np. dodawania lub aktualizacji), w przypadku formularza dodawania nowych danych można nie podawać ID, ale należy przesłać dane, które posłużą jako kontekst wykonania:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Sample 1",
    "id": 91
  }'
  "http://localhost:3000/api/samples:trigger?triggerWorkflows=workflowKey"

W przypadku formularza aktualizacji należy podać zarówno ID wiersza danych, jak i aktualizowane dane:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Sample 1",
    "id": 91
  }'
  "http://localhost:3000/api/samples:trigger/<:id>?triggerWorkflows=workflowKey"

Jeśli podano jednocześnie ID i dane, najpierw zostanie załadowany wiersz danych odpowiadający ID, a następnie właściwości z przesłanego obiektu danych nadpiszą oryginalny wiersz, tworząc ostateczny kontekst danych wyzwalacza.

Dodatkowo parametr URL triggerWorkflows to klucz (key) przepływu pracy; wiele przepływów należy oddzielić przecinkami. Klucz ten można uzyskać po najechaniu myszką na nazwę przepływu pracy u góry płótna:

Po pomyślnym wywołaniu zostanie wyzwolone niestandardowe zdarzenie akcji dla odpowiedniej kolekcji samples.

#Wiele rekordów

Sposób wywołania jest podobny do pojedynczego rekordu, ale przesyłane dane wymagają jedynie wielu parametrów klucza głównego (filterByTk[]) i nie wymagają sekcji data:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/samples:trigger?filterByTk[]=1&filterByTk[]=2&triggerWorkflows=workflowKey"

To wywołanie wyzwoli niestandardowe zdarzenie akcji w trybie wielu rekordów, wykorzystując dane o ID 1 i 2 jako dane kontekstowe wyzwalacza.