Hooks
De Wiki1000
(Différences entre les versions)
Ligne 13 : | Ligne 13 : | ||
* Actif | * Actif | ||
:Indique que le Hook est actif; est utile en teste pour désactiver un Hook | :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 32 : | Ligne 27 : | ||
|Requête HTTP POST sur l'adresse destination en encodant les paramètres au format html FORM | |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 | ||
:Paramètres associés au hook et utilisé pour les types d'action POST-FORM | :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 : | Exemple : |
Version du 3 septembre 2013 à 16:12
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 :