Triggers system: Difference between revisions

{{TemplateDocDevEn}}

To execute personalized code after a Dolibarr event (create/modify/remove a third party/invoice/product or other), Dolibarr offers a mechanism of business triggers. This mechanism allows you to personalize a work-flow to have Dolibarr business events being synchronized into another application for example.

You can also use triggers to modify the behavior of Dolibarr itself: for example, to create automatically a contract when an invoice is validated.

1) Copy the trigger file '''htdocs/core/triggers/interface_90_all_Demo.class.php-NORUN''' under the new name:

or

where ''Xxx'' is a string of your choice starting with uppercase character, ''99'' is the priority number for the execution of your trigger (1 being the top priority) and ''MyModule'' is the name of a module if you want that trigger is activated only if module MyModyle is activated. If you want the trigger to be always active, use ''all'' instead of  modMyModule.

This new file must be saved inside same directory.

2) Edit the file ''interface_99_modMyModule_Myworkflow.class.php'' to rename class ''InterfaceDemo'' by ''InterfaceMyworkflow''

Your new trigger file must appears in the list without any error message. This means preceding actions have been done successfully.

You can also use, inside this function, the following preinitialized variables:

dol_syslog("my log message", LOG_DEBUG);

List of all events that launch triggers are available in [[Table llx c action trigger]]. This is a quick list of those events, identified by value of variable '''$action''' into trigger code and type of variable '''$object''' for each code.

In most cases, trigger action code is a key matching this rules:

{{TemplateListOfTriggers}}

This list may be not complete.

To manage other events on objects than the one defined before, you must edit the Dolibarr code to add the following code inside the business method of the class file of the object:

</source>

You can in few minutes, add an interface from Dolibarr towards another system (or why not towards Dolibarr itself), with no risk since you don't touch anything to Dolibarr files. You only "added" a new trigger file inside the trigger directory.

If this new interface can serve a lot of other users, you can package it into a tgz file (see page [[Module_development#Create_a_package_to_distribute_and_install_your_module]]) and submit it on the download area in section external contributions on official Dolibarr web site.