#Událost před akcí

#Úvod

Plugin Událost před akcí poskytuje mechanismus pro zachycení (intercepci) akcí. Spouští se po odeslání požadavku na vytvoření, aktualizaci nebo odstranění záznamu, ale ještě před jeho zpracováním.

Pokud se ve spuštěném pracovním postupu provede uzel „Ukončit pracovní postup“, nebo pokud selže provedení jiného uzlu (například kvůli chybě nebo jinému nedokončení), bude akce formuláře zachycena. V opačném případě se zamýšlená akce provede normálně.

Ve spojení s uzlem „Zpráva odpovědi“ můžete pro tento pracovní postup nakonfigurovat zprávu, která se vrátí klientovi, a poskytnout mu tak příslušné informace. Události před akcí lze využít pro obchodní validaci nebo logické kontroly, které buď schválí, nebo zachytí požadavky klienta na vytvoření, aktualizaci a odstranění záznamů.

#Konfigurace spouštěče

#Vytvoření spouštěče

Při vytváření pracovního postupu zvolte typ „Událost před akcí“:

#Výběr kolekce

Ve spouštěči zachycujícího pracovního postupu je nejprve nutné nakonfigurovat kolekci, ke které se akce vztahuje:

Poté vyberte režim zachycení. Můžete zvolit, zda se má zachytit pouze tlačítko akce vázané na tento pracovní postup, nebo zda se mají zachytit všechny vybrané akce pro tuto kolekci (bez ohledu na to, z jakého formuláře pocházejí a bez nutnosti vázat odpovídající pracovní postup):

#Režim zachycení

V současné době jsou podporovány typy akcí „Vytvořit“, „Aktualizovat“ a „Odstranit“. Lze vybrat více typů akcí současně.

#Konfigurace akce

Pokud jste v konfiguraci spouštěče vybrali režim „Spustit zachycení pouze při odeslání formuláře vázaného na tento pracovní postup“, musíte se také vrátit do rozhraní formuláře a navázat tento pracovní postup na příslušné tlačítko akce:

V konfiguraci navázání pracovního postupu vyberte odpovídající pracovní postup. Obvykle postačí výchozí kontext pro spouštění dat, „Celá data formuláře“:

#Podmínky pro zachycení

V „Události před akcí“ existují dvě podmínky, které způsobí zachycení odpovídající akce:

1. Pracovní postup se provede až k libovolnému uzlu „Ukončit pracovní postup“. Podobně jako v předchozích pokynech, pokud data, která spustila pracovní postup, nesplňují přednastavené podmínky v uzlu „Podmínka“, vstoupí se do větve „Ne“ a provede se uzel „Ukončit pracovní postup“. V tomto okamžiku se pracovní postup ukončí a požadovaná akce bude zachycena.
2. Selže provedení libovolného uzlu v pracovním postupu, včetně chyb při provádění uzlů nebo jiných výjimečných situací. V takovém případě se pracovní postup ukončí s odpovídajícím stavem a požadovaná akce bude rovněž zachycena. Například pokud pracovní postup volá externí data prostřednictvím „HTTP požadavku“ a požadavek selže, pracovní postup se ukončí se stavem selhání a zároveň zachytí odpovídající požadavek na akci.

Po splnění podmínek pro zachycení se odpovídající akce již neprovede. Například pokud je odeslání objednávky zachyceno, nebudou vytvořena odpovídající data objednávky.

#Související parametry pro odpovídající akci

V pracovním postupu typu „Událost před akcí“ jsou pro různé akce ve spouštěči k dispozici různá data, která lze použít jako proměnné v rámci postupu:

#Výstup zprávy odpovědi

Po nakonfigurování spouštěče můžete v pracovním postupu přizpůsobit relevantní logiku rozhodování. Obvykle použijete režim větvení uzlu „Podmínka“, abyste na základě výsledků konkrétních obchodních podmínek rozhodli, zda „Ukončit pracovní postup“, a vrátili přednastavenou „Zprávu odpovědi“:

Tímto je konfigurace odpovídajícího pracovního postupu dokončena. Nyní můžete zkusit odeslat data, která nesplňují podmínky nakonfigurované v uzlu podmínky pracovního postupu, abyste spustili logiku zachycení. Poté uvidíte vrácenou zprávu odpovědi:

#Stav zprávy odpovědi

Pokud je uzel „Ukončit pracovní postup“ nakonfigurován tak, aby se ukončil se stavem „Úspěch“, a při provedení tohoto uzlu „Ukončit pracovní postup“ bude požadavek na akci stále zachycen, ale vrácená zpráva odpovědi se zobrazí se stavem „Úspěch“ (namísto „Chyba“):

#Příklad

Kombinací výše uvedených základních pokynů si vezměme jako příklad scénář „Odeslání objednávky“. Předpokládejme, že při odeslání objednávky uživatelem potřebujeme zkontrolovat skladové zásoby všech vybraných produktů. Pokud je zásoba kteréhokoli vybraného produktu nedostatečná, odeslání objednávky se zachytí a vrátí se odpovídající zpráva. Pracovní postup bude procházet a kontrolovat každý produkt, dokud nebudou zásoby všech produktů dostatečné, v takovém případě bude pokračovat a vytvoří data objednávky pro uživatele.

Ostatní kroky jsou stejné jako v pokynech. Jelikož však jedna objednávka zahrnuje více produktů, je kromě přidání vztahu mnoho k mnoha „Objednávka“ <-- M:1 -- „Položka objednávky“ -- 1:M --> „Produkt“ v datovém modelu, nutné také přidat uzel „Cyklus“ do pracovního postupu „Událost před akcí“, který se použije k iterativní kontrole, zda je zásoba každého produktu dostatečná:

Objekt pro cyklus je vybrán jako pole „Položka objednávky“ z odeslaných dat objednávky:

Uzel podmínky v rámci cyklu se používá k určení, zda je zásoba aktuálního objektu produktu v cyklu dostatečná:

Ostatní konfigurace jsou stejné jako v základním použití. Když je objednávka nakonec odeslána, pokud má kterýkoli produkt nedostatečné zásoby, odeslání objednávky bude zachyceno a vrátí se odpovídající zpráva. Během testování zkuste odeslat objednávku s více produkty, kde jeden má nedostatečné zásoby a druhý dostatečné. Můžete vidět vrácenou zprávu odpovědi:

Jak můžete vidět, zpráva odpovědi neuvádí, že první produkt „iPhone 15 pro“ je vyprodán, ale pouze to, že druhý produkt „iPhone 14 pro“ má nedostatečné zásoby. Je to proto, že v cyklu má první produkt dostatečné zásoby, takže nebyl zachycen, zatímco druhý produkt měl nedostatečné zásoby, což zachytilo odeslání objednávky.

#Externí volání

Událost před akcí je sama o sobě vložena do fáze zpracování požadavku, takže podporuje i spouštění prostřednictvím volání HTTP API.

Pro pracovní postupy, které jsou lokálně navázány na tlačítko akce, je můžete volat takto (například tlačítko pro vytvoření v kolekci posts):

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post."
  }'
  "http://localhost:3000/api/posts:create?triggerWorkflows=workflowKey"
Parametr URL `triggerWorkflows` je klíč pracovního postupu; více klíčů pracovních postupů je odděleno čárkami. Tento klíč lze získat najetím myši na název pracovního postupu v horní části plátna pracovního postupu:

![Pracovní postup_Klíč_Způsob zobrazení](https://static-docs.nocobase.com/20240426135108.png)

Po provedení výše uvedeného volání se spustí Událost před akcí pro odpovídající kolekci `posts`. Po synchronním zpracování odpovídajícího pracovního postupu se data normálně vytvoří a vrátí.

Pokud nakonfigurovaný pracovní postup dosáhne „Uzlu ukončení“, logika je stejná jako u akce rozhraní: požadavek bude zachycen a nebudou vytvořena žádná data. Pokud je stav uzlu ukončení nakonfigurován jako selhání, vrácený stavový kód odpovědi bude `400`; v případě úspěchu to bude `200`.

Pokud je před uzlem ukončení nakonfigurován také uzel „Zpráva odpovědi“, vygenerovaná zpráva se vrátí také ve výsledku odpovědi. Struktura pro chybu je:

```json
{
  "errors": [
    {
      "message": "message from 'Response message' node"
    }
  ]
}

Struktura zprávy, když je „Uzel ukončení“ nakonfigurován pro úspěch, je:

{
  "messages": [
    {
      "message": "message from 'Response message' node"
    }
  ]
}

Pokud je Událost před akcí nakonfigurována v globálním režimu, nemusíte při volání HTTP API používat parametr URL triggerWorkflows k určení odpovídajícího pracovního postupu. Spustí se jednoduše voláním odpovídající akce kolekce.

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post."
  }'
  "http://localhost:3000/api/posts:create"