Jobs¶

Jobs are tasks executing in the background. They handle operations like sending notifications, mass mailing, syncing, cleanup, etc.

In this article:

Scheduled jobs
Setting up (cron & daemon)
Running jobs in parallel processes
Parameters
Running specific job manually in CLI

Scheduled jobs¶

Scheduled jobs are intended for recurring job execution. They are available at Administration > Scheduled Jobs. Scheduling for a specific job can be configured using the crontab notation.

* * * * *
| | | | |
| | | | |
| | | | +---- Day of the Week   (range: 1-7, 1 standing for Monday)
| | | +------ Month of the Year (range: 1-12)
| | +-------- Day of the Month  (range: 1-31)
| +---------- Hour              (range: 0-23)
+------------ Minute            (range: 0-59)

If you want a job to be run as often as possible, you need to set the scheduling to * * * * *.

Setting up¶

There are two options to set up job processing in the system:

Crontab
Daemon

For both, it's highly recommended to turn on processing jobs in parallel processes: Administration > Job Settings > Jobs Run in Parallel.

Note

Parallel processing is not supported on Windows environment.

Cron¶

The Cron is easy to configure, it's supported by most hosting providers. See how to configure cron here.

In Unix systems, the cron is supposed to be run not more often than once a minute. It's possible to overcome this limitation by adding multiple lines in the crontab with delays:

* * * * * /usr/bin/php -f /path/to/espo/cron.php > /dev/null 2>&1
* * * * * sleep 15; /usr/bin/php -f /path/to/espo/cron.php > /dev/null 2>&1
* * * * * sleep 30; /usr/bin/php -f /path/to/espo/cron.php > /dev/null 2>&1
* * * * * sleep 45; /usr/bin/php -f /path/to/espo/cron.php > /dev/null 2>&1

The command that runs cron.php may differ depending on your server environment. You need to replace /path/to/espo/ with the actual path to your instance.

Daemon¶

Available only in Unix-like operating systems. Requires pcntl and posix PHP extensions (usually available by default).

Command to start the daemon using nohup:

nohup php /path/to/espocrm/daemon.php &

Using Systemd¶

Service configuration file: /etc/systemd/system/espocrm-daemon.service

Configuration (file content):

[Unit]
Description=EspoCRM Daemon Service
Requires=mysql.service
After=mysql.service

[Service]
Type=simple
Restart=always
RestartSec=5
StartLimitInterval=0
User=www-data
ExecStart=/usr/bin/php /path/to/espocrm/daemon.php
StandardError=/path/to/espocrm/data/logs/daemon.log

[Install]
WantedBy=default.target

Command to get the service to start on boot:

systemctl enable espocrm-daemon.service

Command to start the service:

systemctl start espocrm-daemon.service

Running jobs in parallel processes¶

Note

It's highly recommended to enable running jobs in parallel processes.

By default, jobs are executed one by one, that may cause situations when one job blocks the execution of the next job for some time (usually, it's not more than one minute). To avoid this, it's possible to run jobs in parallel processes. The parameter is available at Administration > Job Settings.

Requires pcntl and posix extensions. Some server configurations may restrict the ability to run child processes. Windows is not supported.

Parameters¶

The administrator can set job parameters at Administration > Job Settings.

Jobs Max Portion¶

It's may be reasonable to increase the Jobs Max Portion parameter when the number of users in your CRM is increased. It defines the max number of jobs that can be processed in a single cron or daemon run. By default, it's set to 15.

Running specific job manually in CLI¶

Command:

php command.php run-job JobName

where JobName is an internal name of the job you want to run.

Example

php command.php run-job Cleanup
php command.php run-job ProcessMassEmail

Jobs available out-of-the-box:

CheckEmailAccounts – fetches emails for personal email accounts;
CheckInboundEmails – fetches emails for group email accounts;
Cleanup – performs cleanup, completely deletes removed records;
ProcessMassEmail – sends mass emails;
ProcessWebhookQueue – sends webhooks;
SendEmailNotifications
SendEmailReminders
SubmitPopupReminders
ControlKnowledgeBaseArticleStatus

To print all available jobs run:

bin/command app-info --jobs

Some jobs (CheckEmailAccounts, CheckInboundEmails) require specifying --target-id and/or --target-type options.