#Gebeurtenis vóór actie

#Introductie

De plugin 'Gebeurtenis vóór actie' biedt een interceptiemechanisme voor acties. Deze kan worden geactiveerd nadat een verzoek voor een aanmaak-, update- of verwijderactie is ingediend, maar voordat het wordt verwerkt.

Als een "Eindig workflow"-knooppunt wordt uitgevoerd in de geactiveerde workflow, of als een ander knooppunt niet succesvol wordt uitgevoerd (door een fout of andere onvolledigheid), dan wordt de formulieractie onderschept. Anders wordt de beoogde actie normaal uitgevoerd.

Door het te gebruiken in combinatie met het knooppunt "Antwoordbericht", kunt u een antwoordbericht configureren dat naar de client wordt teruggestuurd, om zo passende meldingen te geven. Gebeurtenissen vóór actie kunnen worden gebruikt voor bedrijfsvalidatie of logische controles, om aanmaak-, update- en verwijderverzoeken die door de client zijn ingediend, goed te keuren of te onderscheppen.

#Triggerconfiguratie

#Trigger aanmaken

Wanneer u een workflow aanmaakt, selecteert u het type "Gebeurtenis vóór actie":

#Collectie selecteren

In de trigger van een interceptie-workflow is het eerste wat u moet configureren de collectie die overeenkomt met de actie:

Vervolgens selecteert u de interceptiemodus. U kunt ervoor kiezen om alleen de actieknop te onderscheppen die aan deze workflow is gekoppeld, of om alle geselecteerde acties voor deze collectie te onderscheppen (ongeacht uit welk formulier ze komen, en zonder dat de bijbehorende workflow hoeft te worden gekoppeld):

#Interceptiemodus

Momenteel ondersteunde actietypen zijn "Aanmaken", "Updaten" en "Verwijderen". U kunt meerdere actietypen tegelijk selecteren.

#Actieconfiguratie

Als in de triggerconfiguratie de modus "Interceptie alleen activeren wanneer een formulier dat aan deze workflow is gekoppeld, wordt ingediend" is geselecteerd, moet u ook teruggaan naar de formulierinterface en deze workflow koppelen aan de bijbehorende actieknop:

In de workflow-koppelingsconfiguratie selecteert u de bijbehorende workflow. Meestal is de standaardcontext voor het activeren van gegevens, "Volledige formuliergegevens", voldoende:

#Voorwaarden voor interceptie

Bij een "Gebeurtenis vóór actie" zijn er twee voorwaarden die ertoe leiden dat de bijbehorende actie wordt onderschept:

1. De workflow bereikt een "Eindig workflow"-knooppunt. Net als in de voorgaande instructies, wanneer de gegevens die de workflow hebben geactiveerd niet voldoen aan de vooraf ingestelde voorwaarden in een "Conditie"-knooppunt, zal de "Nee"-tak worden ingegaan en het "Eindig workflow"-knooppunt worden uitgevoerd. Op dat moment eindigt de workflow en wordt de aangevraagde actie onderschept.
2. Een knooppunt in de workflow wordt niet succesvol uitgevoerd, inclusief uitvoeringsfouten of andere uitzonderlijke situaties. In dit geval eindigt de workflow met een overeenkomstige status en wordt de aangevraagde actie ook onderschept. Als de workflow bijvoorbeeld externe gegevens oproept via een "HTTP-verzoek" en het verzoek mislukt, eindigt de workflow met een mislukte status en wordt tegelijkertijd het bijbehorende actieverzoek onderschept.

Nadat aan de interceptievoorwaarden is voldaan, wordt de bijbehorende actie niet langer uitgevoerd. Als een orderinzending bijvoorbeeld wordt onderschept, worden de bijbehorende ordergegevens niet aangemaakt.

#Gerelateerde parameters voor de bijbehorende actie

In een workflow van het type "Gebeurtenis vóór actie" kunnen, afhankelijk van de actie, verschillende gegevens van de trigger als variabelen in de workflow worden gebruikt:

#Antwoordbericht uitvoeren

Nadat u de trigger heeft geconfigureerd, kunt u de relevante beoordelingslogica in de workflow aanpassen. Meestal gebruikt u de vertakkingsmodus van het "Conditie"-knooppunt om, op basis van de resultaten van specifieke bedrijfscondities, te beslissen of u de "workflow beëindigt" en een vooraf ingesteld "Antwoordbericht" retourneert:

Hiermee is de configuratie van de bijbehorende workflow voltooid. U kunt nu proberen gegevens in te dienen die niet voldoen aan de voorwaarden die in het conditieknooppunt van de workflow zijn geconfigureerd, om zo de interceptielogica van de interceptor te activeren. U zult dan het geretourneerde antwoordbericht zien:

#Status van het antwoordbericht

Als het "Eindig workflow"-knooppunt is geconfigureerd om met een "Succes"-status af te sluiten, en dit knooppunt wordt uitgevoerd, dan wordt het verzoek voor deze actie nog steeds onderschept. Het geretourneerde antwoordbericht wordt echter weergegeven met een "Succes"-status (in plaats van "Fout").

#Voorbeeld

Laten we, in combinatie met de bovenstaande basisinstructies, een "Orderinzending"-scenario als voorbeeld nemen. Stel dat we bij het indienen van een bestelling door de gebruiker de voorraad van alle geselecteerde producten moeten controleren. Als de voorraad van een geselecteerd product onvoldoende is, wordt de bestelling onderschept en wordt een bijbehorende melding teruggestuurd. De workflow zal elk product controleren totdat de voorraad van alle producten voldoende is, waarna het doorgaat en de ordergegevens voor de gebruiker aanmaakt.

Andere stappen zijn hetzelfde als in de instructies. Echter, aangezien een bestelling meerdere producten omvat, moet u, naast het toevoegen van een veel-op-veel-relatie "Bestelling" <-- M:1 -- "Bestelregel" -- 1:M --> "Product" in het gegevensmodel, ook een "Lus"-knooppunt toevoegen in de "workflow 'Gebeurtenis vóór actie'" om iteratief te controleren of de voorraad van elk product voldoende is:

Het object voor de lus wordt geselecteerd als de array "Bestelregel" uit de ingediende ordergegevens:

Het conditieknooppunt binnen de lus wordt gebruikt om te bepalen of de voorraad van het huidige productobject in de lus voldoende is:

Andere configuraties zijn hetzelfde als in het basisgebruik. Wanneer de bestelling uiteindelijk wordt ingediend, wordt de bestelling onderschept en wordt een bijbehorende melding teruggestuurd als een product onvoldoende voorraad heeft. Probeer tijdens het testen een bestelling in te dienen met meerdere producten, waarbij één product onvoldoende voorraad heeft en een ander voldoende. U ziet dan het geretourneerde antwoordbericht:

Zoals u kunt zien, geeft het antwoordbericht niet aan dat het eerste product, "iPhone 15 pro", onvoldoende voorraad heeft, maar alleen dat het tweede product, "iPhone 14 pro", onvoldoende voorraad heeft. Dit komt omdat in de lus het eerste product voldoende voorraad had en daarom niet werd onderschept, terwijl het tweede product onvoldoende voorraad had, wat de orderinzending onderschepte.

#Externe aanroep

De 'Gebeurtenis vóór actie' zelf wordt geïnjecteerd tijdens de verwerkingsfase van het verzoek, en ondersteunt daarom ook activering via HTTP API-aanroepen.

Voor workflows die lokaal aan een actieknop zijn gekoppeld, kunt u deze als volgt aanroepen (met de aanmaakknop van de posts-collectie als voorbeeld):

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"

De URL-parameter triggerWorkflows is de sleutel van de workflow; meerdere workflow-sleutels worden gescheiden door komma's. Deze sleutel kunt u verkrijgen door de muis over de workflownaam bovenaan het workflow-canvas te bewegen:

Nadat de bovenstaande aanroep is gedaan, wordt de 'Gebeurtenis vóór actie' voor de bijbehorende posts-collectie geactiveerd. Nadat de bijbehorende workflow synchroon is verwerkt, worden de gegevens normaal aangemaakt en geretourneerd.

Als de geconfigureerde workflow een "Eindknooppunt" bereikt, is de logica hetzelfde als bij een interface-actie: het verzoek wordt onderschept en er worden geen gegevens aangemaakt. Als de status van het eindknooppunt is geconfigureerd als mislukt, is de geretourneerde antwoordstatuscode 400; bij succes is deze 200.

Als er vóór het eindknooppunt ook een "Antwoordbericht"-knooppunt is geconfigureerd, wordt het gegenereerde bericht ook in het antwoordresultaat geretourneerd. De structuur voor een fout is:

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

De berichtstructuur wanneer het "Eindknooppunt" is geconfigureerd voor succes is:

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

Als de 'Gebeurtenis vóór actie' is geconfigureerd in de globale modus, hoeft u bij het aanroepen van de HTTP API de URL-parameter triggerWorkflows niet te gebruiken om de bijbehorende workflow te specificeren. Een directe aanroep van de bijbehorende collectie-actie zal deze activeren.

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"