Line 2:
Line 2:
<!-- You can edit this section but do NOT remove these comments
<!-- You can edit this section but do NOT remove these comments
Links below will be automatically replicated on translated pages by PolyglotBot -->
Links below will be automatically replicated on translated pages by PolyglotBot -->
+
[[zh:计划任务模块]]
<!-- END interlang links -->
<!-- END interlang links -->
Line 19:
Line 20:
= Installation =
= Installation =
−
This module is included with the Dolibarr distribution, so there is no need to install it.
+
{{NoInstallModuleEn}}
= Setup =
= Setup =
−
To use this module, you must first enable it using an administrator account, via the menu option "'''Home - Setup - Modules'''".
−
Choose the tab where the module is listed. Then click on "Activate".
[[File:Scheduled Jobs Module Activation EN.png|thumb]]
[[File:Scheduled Jobs Module Activation EN.png|thumb]]
−
The module is now activated.
+
{{ActivationModuleEn}}
−
An cog icon appears [[File:Cog circle.svg|thumb|30x30px]] for the module, click on it to access the setup page specific to the module.
+
+
+
== Module Setup ==
[[File:Module Scheduled Job setup EN.png|thumb]]
[[File:Module Scheduled Job setup EN.png|thumb]]
+
The only parameter that can be changed is the Security key used on the URL to launch cron jobs.
+
+
Below there is linked to :
+
* The "'''Home - Admin tools - Scheduled jobs'''" to see and edit scheduled jobs.
+
* The URL to check and launch qualified cron jobs: http://mydolibarradress/htdocs/public/cron/cron_run_jobs.php?securitykey=xxxxxxxxxxxxxxxxxxxxxxxx&userlogin=admin
+
* The URL to check and launch a specific job by its job id : http://mydolibarradress/htdocs/public/cron/cron_run_jobs.php?securitykey=xxxxxxxxxxxxxxxxxxxxxxxx&userlogin=admin&id=cronjobid
+
+
== External activation of the module ==
+
The module need to be externally activated each 5 minutes.
+
+
Depending on the environment where Dolibarr is running, the procedure to be followed is different.
+
+
=== Unix Environment ===
+
On Unix environment you should use the crontab entry to run the command line each 5 minutes
+
+
=== Windows Environment ===
+
On Windows, you have to create a new task in the Windows Task Scheduler.
+
+
* '''General''': don't forget to check "Run with maximum permissions".
+
* '''Trigger''': Choose according to the use of your PC
+
* '''Action''':
+
Select "Start a program".
+
Then put in Program/Script: C:\wamp64\bin\php7.3.12\php.exe
+
And in Add arguments: -f C:\wamp64\wwww\dolibarr\scripts\cron\cron_run_jobs.php xxxxxxxxxxxxxxxx admin
+
+
With 'xxxxxxxxxxxxxxxx' is the security key that you will find in the parameters of the scheduled jobs module, and 'admin' is the name of your session.
+
+
The path indicated may be different depending on the installation and software version.
+
This task will execute a command in windows to execute the php, then launch the planned work in progress of dolibarr
+
+
=== Dolibarr available on Internet ===
+
You can use external services like :
+
* https://webcron.dolizen.fr/
+
* https://cron-job.org/en/
+
+
= Manage the Scheduled jobs =
+
[[File:Module Schedule Job List EN.png|thumb]]
+
In '''Home - Admin tools - Scheduled jobs''' you will find the list of active jobs and the last activation time.
+
+
You can also create new jobs.