Hooks
De Wiki1000
(Différences entre les versions)
(Page créée avec « __NOTOC__ {{latest}} Les hooks permettent d'associer des actions à des évènements métiers dans le but de notifier des applications. {{tip|Pour notifier un utilisateu... ») |
|||
(6 révisions intermédiaires par un utilisateur sont masquées) | |||
Ligne 1 : | Ligne 1 : | ||
__NOTOC__ | __NOTOC__ | ||
− | {{ | + | {{Version700}} |
Les hooks permettent d'associer des actions à des évènements métiers dans le but de notifier des applications. | Les hooks permettent d'associer des actions à des évènements métiers dans le but de notifier des applications. | ||
Ligne 10 : | Ligne 10 : | ||
[[image:Hook-regeventclass.png]] | [[image:Hook-regeventclass.png]] | ||
+ | |||
+ | * Actif | ||
+ | :Indique que le Hook est actif; est utile en teste pour désactiver un Hook | ||
* Action | * Action | ||
:Le type d'action associé au hook | :Le type d'action associé au hook | ||
− | |||
− | |||
− | |||
− | |||
Les types d'action possibles sont : | Les types d'action possibles sont : | ||
Ligne 22 : | Ligne 21 : | ||
{|class="wikitable" | {|class="wikitable" | ||
|- | |- | ||
− | |Post | + | |Post du contenu |
|Requête HTTP POST sur l'adresse destination | |Requête HTTP POST sur l'adresse destination | ||
+ | |- | ||
+ | |Post des paramètres | ||
+ | |Requête HTTP POST sur l'adresse destination en encodant les paramètres au format html FORM | ||
|} | |} | ||
− | + | {{tip|Les actions sont exécutées de manière asynchrone, une action peut échouer sans compromettre la transaction.}} | |
− | + | * url | |
+ | :L'url de destination associée au hook | ||
− | + | * Contenu | |
+ | :Le contenu du message transmis au destinataire. Le contenu sera substitué par les valeurs de l'objet métier à l'origine de l'évènement en utilisant la fonction [[FormatMsg (Instance)|FormatMsg]]. | ||
+ | |||
+ | * Condition | ||
+ | :Si la condition est définie, expression booléenne devant retourner true pour que le hook soit exécuté. | ||
+ | |||
+ | * Paramètres | ||
+ | :Paramètres associés au hook et utilisé pour les types d'action POST-FORM | ||
+ | |||
+ | * Code | ||
+ | :Ce script sera exécuté après l'exécution du hook. | ||
+ | |||
+ | Le contexte d'exécution de ce code comprend les propriétés suivantes : | ||
+ | |||
+ | {|class="wikitable" | ||
+ | |- | ||
+ | |ErrorCode | ||
+ | |Entier | ||
+ | |Code de retour de la requête HTTP | ||
+ | |- | ||
+ | |ErrorText | ||
+ | |Chaîne | ||
+ | |Texte associé au code de retour de la requête HTTP | ||
+ | |- | ||
+ | |ErrorContent | ||
+ | |Chaîne | ||
+ | |Contenu du retour en cas d'erreur | ||
+ | |- | ||
+ | |Response | ||
+ | |Chaîne | ||
+ | |Contenu de la réponse si pas d'erreur | ||
+ | |} | ||
+ | |||
+ | |||
+ | Exemple : | ||
− | + | * [[Notifier un serveur node.js sur un évènement métier]] | |
− | *[[ | + | * [[Envoyer un sms sur un évènement métier]] |
[[Category:Alertes]] | [[Category:Alertes]] | ||
− | [[Category: | + | [[Category:Version700]] |
Version actuelle en date du 13 janvier 2015 à 10:49
Les hooks permettent d'associer des actions à des évènements métiers dans le but de notifier des applications.
Tip : Pour notifier un utilisateur utilisez une alerte |
Définir un évènement métier
Voir définir un évènement métier
- Actif
- Indique que le Hook est actif; est utile en teste pour désactiver un Hook
- Action
- Le type d'action associé au hook
Les types d'action possibles sont :
Post du contenu | Requête HTTP POST sur l'adresse destination |
Post des paramètres | Requête HTTP POST sur l'adresse destination en encodant les paramètres au format html FORM |
Tip : Les actions sont exécutées de manière asynchrone, une action peut échouer sans compromettre la transaction. |
- url
- L'url de destination associée au hook
- Contenu
- Le contenu du message transmis au destinataire. Le contenu sera substitué par les valeurs de l'objet métier à l'origine de l'évènement en utilisant la fonction FormatMsg.
- Condition
- Si la condition est définie, expression booléenne devant retourner true pour que le hook soit exécuté.
- Paramètres
- Paramètres associés au hook et utilisé pour les types d'action POST-FORM
- Code
- Ce script sera exécuté après l'exécution du hook.
Le contexte d'exécution de ce code comprend les propriétés suivantes :
ErrorCode | Entier | Code de retour de la requête HTTP |
ErrorText | Chaîne | Texte associé au code de retour de la requête HTTP |
ErrorContent | Chaîne | Contenu du retour en cas d'erreur |
Response | Chaîne | Contenu de la réponse si pas d'erreur |
Exemple :