#Événement d'action personnalisée

#Présentation

NocoBase intègre des actions de données courantes (ajout, suppression, modification, consultation, etc.). Lorsque ces actions ne peuvent pas répondre à des besoins métier complexes, vous pouvez utiliser l'événement d'action personnalisée dans un flux de travail et lier cet événement au bouton « Déclencher le flux de travail » d'un bloc de page. Lorsqu'un utilisateur clique dessus, cela déclenchera un flux de travail d'action personnalisée.

#Créer un flux de travail

Lors de la création d'un flux de travail, sélectionnez « Événement d'action personnalisée » :

#Configuration du déclencheur

#Type de contexte

v.1.6.0+

Le type de contexte détermine les boutons de bloc auxquels le flux de travail peut être lié :

• Sans contexte : Il s'agit d'un événement global qui peut être lié aux boutons d'action des panneaux d'action et des blocs de données ;
• Enregistrement unique : Peut être lié aux boutons d'action des blocs de données tels que les lignes de tableau, les formulaires, les détails, etc. ;
• Plusieurs enregistrements : Peut être lié aux boutons d'action groupée d'un tableau.

#collection

Lorsque le type de contexte est un enregistrement unique ou plusieurs enregistrements, vous devez sélectionner la collection à laquelle lier le modèle de données :

#Données d'association à utiliser

Si vous avez besoin d'utiliser les données d'association de la ligne de données déclenchée dans le flux de travail, vous pouvez sélectionner ici des champs d'association profonds :

Ces champs seront automatiquement préchargés dans le contexte du flux de travail après le déclenchement de l'événement, afin d'être utilisés dans le flux de travail.

#Configuration de l'action

Selon le type de contexte configuré pour le flux de travail, la configuration des boutons d'action dans les différents blocs varie également.

#Sans contexte

v1.6.0+

Dans les panneaux d'action et les autres blocs de données, vous pouvez ajouter un bouton « Déclencher le flux de travail » :

Après avoir ajouté le bouton, liez le flux de travail sans contexte créé précédemment, en prenant pour exemple le bouton dans un panneau d'action :

#Enregistrement unique

Dans n'importe quel bloc de données, un bouton « Déclencher le flux de travail » peut être ajouté à la barre d'actions pour un enregistrement unique, comme dans les formulaires, les lignes de tableau, les détails, etc. :

Après avoir ajouté le bouton, liez le flux de travail créé précédemment :

Ensuite, cliquez sur ce bouton pour déclencher cet événement d'action personnalisée :

#Plusieurs enregistrements

v1.6.0+

Dans la barre d'actions d'un bloc de tableau, lors de l'ajout d'un bouton « Déclencher le flux de travail », une option supplémentaire apparaît pour choisir le type de contexte : « Sans contexte » ou « Plusieurs enregistrements » :

Lorsque vous choisissez « Sans contexte », il s'agit d'un événement global qui ne peut être lié qu'à des flux de travail de type sans contexte.

Lorsque vous choisissez « Plusieurs enregistrements », vous pouvez lier un flux de travail de type plusieurs enregistrements, utilisable pour des opérations groupées après avoir sélectionné plusieurs données (actuellement pris en charge uniquement par les tableaux). La portée des flux de travail sélectionnables est limitée à ceux configurés pour correspondre à la collection du bloc de données actuel :

Lors du déclenchement par clic sur le bouton, vous devez avoir coché certaines lignes de données dans le tableau, sinon le flux de travail ne sera pas déclenché :

#Exemple

Par exemple, nous avons une collection « Échantillons ». Pour les échantillons « Collectés » (statut), nous devons fournir une opération « Soumettre pour inspection ». La soumission vérifiera d'abord les informations de base de l'échantillon, puis générera un « Enregistrement d'inspection », et modifiera enfin le statut de l'échantillon en « Soumis ». Cette série de processus ne peut pas être accomplie par de simples boutons CRUD ; c'est ici que l'événement d'action personnalisée intervient.

Créez d'abord une collection « Échantillons » et une collection « Enregistrements d'inspection », puis saisissez des données de test de base pour la table des échantillons :

Ensuite, créez un flux de travail « Événement d'action personnalisée ». Si vous avez besoin d'un retour immédiat du processus, vous pouvez choisir le mode synchrone (en mode synchrone, vous ne pouvez pas utiliser de nœuds asynchrones comme le traitement manuel) :

Dans la configuration du déclencheur, sélectionnez « Échantillons » pour la collection :

Organisez la logique du processus selon les besoins métier, par exemple, la soumission n'est autorisée que si le paramètre de l'indicateur est supérieur à 90, sinon un message d'erreur est affiché :

Une fois le processus configuré et activé, retournez à l'interface du tableau et ajoutez un bouton « Déclencher le flux de travail » dans la colonne d'actions du tableau :

Ensuite, dans le menu de configuration du bouton, choisissez de lier le flux de travail pour ouvrir la fenêtre de configuration :

Ajoutez le flux de travail précédemment activé :

Après avoir soumis, modifiez le texte du bouton par le nom de l'opération, comme « Soumettre pour inspection ». La configuration est terminée.

Lors de l'utilisation, sélectionnez n'importe quel échantillon dans le tableau et cliquez sur le bouton « Soumettre pour inspection » pour déclencher l'événement d'action personnalisée. Selon la logique organisée, si le paramètre de l'indicateur est inférieur à 90, le message suivant s'affichera :

Si le paramètre de l'indicateur est supérieur à 90, le processus s'exécutera normalement, générant un « Enregistrement d'inspection » et changeant le statut de l'échantillon en « Soumis » :

Ainsi, un événement d'action personnalisée simple est terminé. De même, pour des opérations métier complexes comme le traitement de commandes ou la soumission de rapports, vous pouvez utiliser les événements d'action personnalisée.

#Appel externe

Le déclenchement des événements d'action personnalisée ne se limite pas aux opérations de l'interface utilisateur ; il peut également être déclenché via des appels d'API HTTP. En particulier, les événements d'action personnalisée fournissent un nouveau type d'opération pour toutes les opérations de collection : trigger, qui peut être appelé via l'API d'action standard de NocoBase.

#Sans contexte

Les flux de travail sans contexte doivent être déclenchés sur la ressource workflows :

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

#Enregistrement unique

Similairement au flux de travail déclenché par un bouton dans l'exemple, vous pouvez l'appeler ainsi :

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

Comme cette opération cible une seule donnée, vous devez spécifier l'ID de la ligne de données lors de l'appel sur des données existantes, en remplaçant la partie <:id> dans l'URL.

S'il s'agit d'un appel via un formulaire (comme un ajout ou une mise à jour), vous n'avez pas besoin de passer d'ID pour un ajout, mais vous devez passer les données soumises comme contexte d'exécution :

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

Pour un formulaire de mise à jour, vous devez passer à la fois l'ID de la ligne de données et les données mises à jour :

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

Si l'ID et les données sont fournis simultanément, la ligne de données correspondant à l'ID sera d'abord chargée, puis les propriétés de l'objet de données transmis écraseront la ligne originale pour obtenir le contexte de déclenchement final.

De plus, le paramètre d'URL triggerWorkflows correspond à la clé du flux de travail, plusieurs flux de travail étant séparés par des virgules. Cette clé peut être obtenue en survolant le nom du flux de travail en haut du canevas :

Une fois l'appel réussi, l'événement d'action personnalisée de la collection samples correspondante sera déclenché.

#Plusieurs enregistrements

Similaire à l'appel pour un enregistrement unique, mais les données transmises ne nécessitent que plusieurs paramètres de clé primaire (filterByTk[]), sans partie data :

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

Cet appel déclenchera l'événement d'action personnalisée en mode plusieurs enregistrements, en utilisant les données d'ID 1 et 2 comme contexte du déclencheur.