#Událost vlastní akce

#Úvod

NocoBase obsahuje vestavěné běžné datové operace (přidávání, mazání, úpravy, prohlížení atd.). Pokud tyto operace nemohou uspokojit složité obchodní potřeby, můžete v pracovním postupu použít událost vlastní akce a navázat tuto událost na tlačítko „Spustit pracovní postup“ v bloku stránky. Po kliknutí uživatele se spustí pracovní postup vlastní akce.

#Vytvoření pracovního postupu

Při vytváření pracovního postupu vyberte „Událost vlastní akce“:

#Konfigurace spouštěče

#Typ kontextu

v.1.6.0+

Rozdílné typy kontextu určují, ke kterým tlačítkům v blocích lze pracovní postup navázat:

• Bez kontextu: Globální událost, kterou lze navázat na panel akcí a akční tlačítka v datových blocích;
• Jeden záznam: Lze navázat na akční tlačítka v datových blocích, jako jsou řádky tabulky, formuláře, detaily atd.;
• Více záznamů: Lze navázat na tlačítka pro hromadné operace v tabulce.

#Kolekce

Pokud je typ kontextu Jeden záznam nebo Více záznamů, musíte vybrat kolekci, ke které se má datový model navázat:

#Související data k použití

Pokud potřebujete v pracovním postupu použít související data spouštěného datového řádku, můžete zde vybrat hluboká související pole:

Tato pole se po spuštění události automaticky přednačtou do kontextu pracovního postupu, aby je bylo možné v pracovním postupu použít.

#Konfigurace akce

V závislosti na typu kontextu nakonfigurovaném v pracovním postupu se konfigurace akčních tlačítek v různých blocích liší.

#Bez kontextu

v1.6.0+

V panelu akcí a dalších datových blocích lze přidat tlačítko „Spustit pracovní postup“:

Po přidání tlačítka navážete dříve vytvořený pracovní postup bez kontextu, jako příklad použijeme tlačítko v panelu akcí:

#Jeden záznam

V libovolném datovém bloku lze do sloupce akcí pro jeden záznam přidat tlačítko „Spustit pracovní postup“, například ve formulářích, řádcích tabulky, detailech atd.:

Po přidání tlačítka navážete dříve vytvořený pracovní postup:

Poté kliknutím na toto tlačítko spustíte událost vlastní akce:

#Více záznamů

v1.6.0+

V panelu akcí bloku tabulky se při přidávání tlačítka „Spustit pracovní postup“ zobrazí další možnost výběru typu kontextu: „Bez kontextu“ nebo „Více záznamů“:

Při výběru „Bez kontextu“ se jedná o globální událost a lze navázat pouze pracovní postupy typu bez kontextu.

Při výběru „Více záznamů“ lze navázat pracovní postup typu více záznamů, který lze použít pro hromadné operace po výběru více dat (aktuálně podporováno pouze tabulkami). Rozsah dostupných pracovních postupů je v tomto případě omezen na ty, které jsou nakonfigurovány pro kolekci odpovídající aktuálnímu datovému bloku:

Při kliknutí na tlačítko pro spuštění musí být v tabulce zaškrtnuty některé datové řádky, jinak se pracovní postup nespustí:

#Příklad

Například máme kolekci „Vzorky“. Pro vzorky ve stavu „Odebráno“ potřebujeme poskytnout akci „Odeslat k inspekci“. Odeslání k inspekci nejprve zkontroluje základní informace o vzorku, poté vygeneruje záznam v kolekci „Záznamy o inspekci“ a následně změní stav vzorku na „Odesláno“. Tento proces nelze provést jednoduchým kliknutím na tlačítka „přidat, smazat, upravit, zobrazit“, proto lze k jeho realizaci použít událost vlastní akce.

Nejprve vytvořte kolekci „Vzorky“ a kolekci „Záznamy o inspekci“ a do tabulky vzorků zadejte základní testovací data:

Poté vytvořte pracovní postup „Událost vlastní akce“. Pokud potřebujete včasnou zpětnou vazbu z procesu, můžete zvolit synchronní režim (v synchronním režimu nelze použít asynchronní uzly, jako je ruční zpracování):

V konfiguraci spouštěče vyberte kolekci „Vzorky“:

Uspořádejte logiku v procesu podle obchodních požadavků, například odeslání k inspekci je povoleno pouze tehdy, když je parametr indikátoru větší než 90, jinak se zobrazí upozornění na problém:

Po konfiguraci a povolení procesu se vraťte do rozhraní tabulky a přidejte tlačítko „Spustit pracovní postup“ do sloupce akcí tabulky:

Poté v konfiguračním menu tlačítka vyberte navázání pracovního postupu a otevřete konfigurační okno:

Přidejte dříve povolený pracovní postup:

Po odeslání změňte text tlačítka na název akce, například „Odeslat k inspekci“, a konfigurace procesu je hotová.

Při použití vyberte v tabulce libovolný záznam vzorku a klikněte na tlačítko „Odeslat k inspekci“, čímž spustíte událost vlastní akce. Podle dříve nastavené logiky, pokud je parametr indikátoru vzorku menší než 90, zobrazí se po kliknutí následující upozornění:

Pokud je parametr indikátoru větší než 90, proces se normálně provede, vygeneruje se „Záznam o inspekci“ a stav vzorku se změní na „Odesláno“:

Tímto je jednoduchá událost vlastní akce hotová. Podobně lze pro složité operace, jako je zpracování objednávek nebo odesílání zpráv, využít události vlastní akce.

#Externí volání

Spuštění události vlastní akce není omezeno pouze na operace v uživatelském rozhraní, lze ji spustit také prostřednictvím HTTP API. Konkrétně událost vlastní akce poskytuje pro všechny operace s kolekcemi nový typ operace pro spuštění pracovního postupu: trigger, který lze volat pomocí standardního API pro operace NocoBase.

#Bez kontextu

Pracovní postupy bez kontextu vyžadují spuštění operace nad prostředkem workflows:

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

#Jeden záznam

Pracovní postup spouštěný tlačítkem, jako v příkladu, lze volat takto:

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

Protože je tato operace zaměřena na jeden záznam, je při volání pro existující data nutné specifikovat ID řádku a nahradit část <:id> v URL.

Pokud se volá pro formulář (např. přidání nebo aktualizace), u formuláře pro přidání dat nemusíte předávat ID, ale musíte předat odesílaná data jako kontext pro provedení:

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"

U formuláře pro aktualizaci je nutné předat ID řádku i aktualizovaná data:

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"

Pokud jsou předána ID i data, nejprve se načte datový řádek odpovídající ID a poté se vlastnosti z předaného datového objektu použijí k přepsání původního řádku, čímž se získá výsledný kontext spouštěcích dat.

Parametr URL triggerWorkflows je klíčem pracovního postupu, více pracovních postupů se odděluje čárkou. Tento klíč lze získat najetím myši na název pracovního postupu v horní části plátna pracovního postupu:

Po úspěšném volání se spustí událost vlastní akce pro odpovídající kolekci samples.

#Více záznamů

Podobně jako u volání pro jeden záznam, ale předávaná data vyžadují pouze parametry primárních klíčů (filterByTk[]) a není třeba předávat část 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"

Toto volání spustí událost vlastní akce v režimu více záznamů a jako data v kontextu spouštěče použije záznamy s ID 1 a 2.