Jobs

Sometimes it's reasonable to execute the script in background. For example, to avoid a used waiting for a response for a long time.

Scheduling job

As of v7.0:

use Espo\Core\Job\JobSchedulerFactory;
use Espo\Core\Job\QueueName;

/** @var JobSchedulerFactory $jobSchedulerFactory */
$jobSchedulerFactory->create()
    ->setClassName($jobClassName) // should implement `Espo\Core\Job\Job` interface
    ->setQueue(QueueName::Q0) // optional
    ->setGroup('some-group-name') // optional
    ->setData([
        'someKey' => $someValue
    ])
    ->schedule();

You can pass JobSchedulerFactory as a constructor dependency.

Legacy method (before v7.0):

$entityManager->createEntity('Job', [
    'serviceName' => 'MyJobService',
    'methodName' => 'jobDoSomething',
    'data' => (object) [
        'key1' => 'value1',
        'key2' => 'value2',
    ],
    'executeTime' => date('Y-m-d H:i:s'), // you can delay execution by setting a later time
    'queue' => 'q0', // available queues are listed below
]);

Job implementation

As of v7.0:

<?php
namespace Espo\Custom\MyJobs;

use Espo\Core\Job\Job;
use Espo\Core\Job\Job\Data;

class MyJob implements Job
{
     public function __construct(/* pass needed dependencies */)
     {
     }

     public function run(Data $data): void
     {
         // job logic here
     }
}

Legacy method. Create a service class file custom/Espo/Custom/Services/MyJobService.php:

<?php
namespace Espo\Custom\Services;

class MyJobService extends \Espo\Core\Services\Base
{
    protected function init()
    {
        $this->addDependencyList([
            'entityManager',
        ]);
    }

    public function jobDoSomething($data)
    {
        $key1 = $data->key1;
        $key2 = $data->key2;

        $entityManager = $this->getInjection('entityManager');

        // do something
    }
}

Clear cache from the admin panel.

Queues

• e0 - intended for email sending; run as often as possible;
• q0 - for general use; run as often as possible;
• q1 - for general use; run every minute.