Developer corner

Target group: Developers

Start instances

Sometimes it is necessary to start instances in a JobRouter® installation programmatically. An API and a start command are available for this use case.

Instances are started asynchronously when submitting a form and using the form finisher since a JobRouter® installation may be unavailable or in maintenance mode and to avoid long page loads. Let’s take a look at the flow:

Transferring data sets

As you can see from the diagram, you can prepare multiple instances. The different instances can be started on different JobRouter® installations – depending on the configuration of the step link in the Process module.

Preparing the instance data

If you want to start instances programmatically in a JobRouter® installation, you can use the Preparer class within TYPO3, e.g. in an Extbase controller:

<?php
declare(strict_types=1);

namespace Vendor\Extension\Controller;

use Brotkrueml\JobRouterProcess\Domain\Model\Transfer;
use Brotkrueml\JobRouterProcess\Domain\Repository\StepRepository;
use Brotkrueml\JobRouterProcess\Exception\PrepareException;
use Brotkrueml\JobRouterProcess\Transfer\Preparer;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

final class MyController extends ActionController
{
   private Preparer $preparer;
   private StepRepository $stepRepository;

   // It's important to use dependency injection to inject all necessary
   // dependencies
   public function __construct(
      Preparer $preparer,
      StepRepository $stepRepository
   ) {
      $this->preparer = $preparer;
      $this->stepRepository = $stepRepository;
   }

   public function myAction()
   {
      // ... some other code

      // First get the step link uid from the step handle.
      // It is advised to use the handle because the step link uid can differ
      // from development to production system (it is an auto increment).
      $step = $this->stepRepository->findOneByHandle('your_step_handle');

      // Define the transfer domain model with your parameters
      // Have a look in the Transfer model to see the available setters
      $transfer = new Transfer();
      $transfer->setCrdate(time());
      $transfer->setStepUid($step->getUid());
      $transfer->setType('Demo');
      $transfer->setSummary('My summary');
      $transfer->setProcesstable([
         'name' => 'John Doe',
         'company' => 'Acme Ltd.',
         'email_address' => 'jdoe@example.com',
         'message' => 'Please send me information.',
      ]);

      try {
         $this->preparer->store($transfer);
      } catch (PrepareException $e) {
         // On errors an exception can be thrown
         var_dump($e->getMessage());
      }

The start command must be activated with a cron job to periodically start instances in the JobRouter® installation(s).

Instead of the Preparer class, you can also use the Brotkrueml\JobRouterProcess\Domain\Repository\TransferRepository to store transfer records in the database.