#Niestandardowe zdarzenie akcji

#Wprowadzenie

NocoBase posiada wbudowane typowe operacje na danych (dodawanie, usuwanie, aktualizowanie, przeglądanie itp.). Kiedy te operacje nie są wystarczające do spełnienia złożonych wymagań biznesowych, mogą Państwo wykorzystać niestandardowe zdarzenia akcji w przepływie pracy. Poprzez przypisanie takiego zdarzenia do przycisku „Uruchom przepływ pracy” w bloku strony, kliknięcie go przez użytkownika spowoduje uruchomienie przepływu pracy z niestandardową akcją.

#Tworzenie przepływu pracy

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

#Konfiguracja wyzwalacza

#Typ kontekstu

v.1.6.0+

Typ kontekstu decyduje o tym, do których przycisków w blokach mogą Państwo przypisać dany przepływ pracy:

• Bez kontekstu: Zdarzenie globalne, które można przypisać do przycisków akcji na pasku operacji oraz w blokach danych.
• Pojedynczy rekord: Można przypisać do przycisków akcji w blokach danych, takich jak wiersze tabel, formularze i widoki szczegółów.
• 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 potrzebują Państwo użyć danych powiązanych z wierszem danych wyzwalającym przepływ pracy, mogą Państwo wybrać tutaj głębokie pola powiązane:

Pola te zostaną automatycznie wstępnie załadowane do kontekstu przepływu pracy po wyzwoleniu zdarzenia, dzięki czemu będą dostępne do użycia w przepływie pracy.

#Konfiguracja akcji

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

#Bez kontekstu

v.1.6.0+

Na pasku operacji i w innych blokach danych mogą Państwo dodać przycisk „Uruchom przepływ pracy”:

Po dodaniu przycisku proszę przypisać do niego wcześniej utworzony przepływ pracy bez kontekstu. Poniżej przykład z użyciem przycisku na pasku operacji:

#Pojedynczy rekord

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

Po dodaniu przycisku proszę przypisać do niego wcześniej utworzony przepływ pracy:

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

#Wiele rekordów

v.1.6.0+

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

Gdy wybrano „Bez kontekstu”, jest to zdarzenie globalne i można przypisać tylko przepływy pracy typu „Bez kontekstu”.

Gdy wybrano „Wiele rekordów”, mogą Państwo przypisać przepływ pracy dla wielu rekordów, który może być używany do operacji masowych po wybraniu wielu rekordów (obecnie obsługiwane tylko przez tabele). Dostępne przepływy pracy są ograniczone do tych, które zostały skonfigurowane tak, aby pasowały do kolekcji bieżącego bloku danych:

Podczas klikania przycisku w celu wyzwolenia, muszą Państwo zaznaczyć niektóre wiersze danych w tabeli; w przeciwnym razie przepływ pracy nie zostanie uruchomiony:

#Przykład

Na przykład, mają Państwo kolekcję „Próbki”. Dla próbek o statusie „Zebrane” należy zapewnić akcję „Przekaż do kontroli”. Akcja ta najpierw sprawdzi podstawowe informacje o próbce, następnie wygeneruje „Zapis kontroli”, a na koniec zmieni status próbki na „Przekazano do kontroli”. Ponieważ tej serii procesów nie można zrealizować za pomocą prostych przycisków „dodaj, usuń, aktualizuj, przeglądaj”, można w tym celu wykorzystać niestandardowe zdarzenie akcji.

Najpierw proszę utworzyć kolekcję „Próbki” i kolekcję „Zapisy kontroli”, a następnie wprowadzić podstawowe dane testowe do kolekcji „Próbki”:

Następnie proszę utworzyć przepływ pracy „Niestandardowe zdarzenie akcji”. Jeśli potrzebują Państwo szybkiej informacji zwrotnej z procesu operacji, mogą Państwo wybrać tryb synchroniczny (w trybie synchronicznym nie można używać węzłów asynchronicznych, takich jak ręczne przetwarzanie):

W konfiguracji wyzwalacza proszę wybrać „Próbki” dla kolekcji:

Proszę ułożyć logikę w procesie zgodnie z wymaganiami biznesowymi. Na przykład, zezwolić na przekazanie do kontroli tylko wtedy, gdy parametr wskaźnika jest większy niż 90; w przeciwnym razie wyświetlić odpowiedni komunikat:

Po skonfigurowaniu i włączeniu przepływu pracy, proszę wrócić do interfejsu tabeli i dodać przycisk „Uruchom przepływ pracy” w kolumnie akcji tabeli:

Następnie, w menu konfiguracji przycisku, proszę wybrać opcję przypisania przepływu pracy i otworzyć okno konfiguracji:

Proszę dodać wcześniej włączony przepływ pracy:

Po zatwierdzeniu, proszę zmienić tekst przycisku na nazwę akcji, np. „Przekaż do kontroli”. Proces konfiguracji jest teraz zakończony.

Aby użyć, proszę wybrać dowolne dane próbki w tabeli i kliknąć przycisk „Przekaż do kontroli”, 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 zostanie wyświetlony następujący komunikat:

Jeśli parametr wskaźnika jest większy niż 90, proces zostanie wykonany normalnie, generując „Zapis kontroli” i zmieniając status próbki na „Przekazano do kontroli”:

W tym momencie proste niestandardowe zdarzenie akcji jest zakończone. Podobnie, w przypadku firm z złożonymi operacjami, takimi jak przetwarzanie zamówień czy składanie raportów, niestandardowe zdarzenia akcji mogą być wykorzystane do ich realizacji.

#Wywołanie zewnętrzne

Wyzwolenie niestandardowych zdarzeń akcji nie ogranicza się tylko do operacji w interfejsie użytkownika; mogą być one również wyzwalane poprzez wywołania HTTP API. W szczególności, niestandardowe zdarzenia akcji udostępniają nowy typ akcji dla wszystkich operacji na kolekcjach, aby wyzwalać przepływy pracy: trigger, który można wywołać za pomocą standardowego API operacji NocoBase.

Przepływ pracy wyzwalany przyciskiem, 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 akcja dotyczy pojedynczego rekordu, podczas wywoływania jej dla istniejących danych, należy określić ID wiersza danych, zastępując część <:id> w adresie URL.

Jeśli wywołanie dotyczy formularza (np. dodawania lub aktualizacji), dla formularza dodającego nowe dane można pominąć ID, ale należy przekazać przesłane dane jako kontekst wykonania:

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

Dla formularza aktualizacji należy przekazać zarówno ID wiersza danych, jak i zaktualizowane dane:

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

Jeśli przekazano jednocześnie ID i dane, najpierw zostanie załadowany wiersz danych odpowiadający ID, a następnie właściwości z przekazanego obiektu danych zostaną użyte do nadpisania oryginalnego wiersza danych, aby uzyskać ostateczny kontekst danych wyzwalających.

Dodatkowo, parametr URL triggerWorkflows to klucz przepływu pracy; wiele kluczy przepływów pracy jest oddzielonych przecinkami. Klucz ten można uzyskać, najeżdżając myszką na nazwę przepływu pracy u góry płótna przepływu pracy:

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

Jeśli chcą Państwo wyzwolić zdarzenie dla danych powiązanych typu „jeden do jednego” (typ „jeden do wielu” nie jest obecnie obsługiwany) w tej akcji, mogą Państwo użyć ! w parametrze, aby określić dane wyzwalające pola powiązanego:

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

Po pomyślnym wywołaniu zostanie wyzwolone niestandardowe zdarzenie akcji dla odpowiadającej kolekcji categories.