Encryption 

General 

Process Name (required)

The name of the process as defined in the Process manager of the JobRouter® installation.

Connection (required)

Choose a connection which was defined previously in the Connections module.

Process Table Fields (optional)

Define the process table fields that should be used when starting an instance. Each field item has the following fields:

Name (required)

The name of the process table field as defined in the JobRouter® Designer.

Description (optional)

A description of the process table field.

Type (required)

Select the column type (for now are available: Text, Integer, Attachment). When using the form finisher, the value is casted to this type (in case of text and integer).

Field Size (required)

This option is only shown with type Text. Enter the size of the field. When starting an instance via the transfer table the fields the values are truncated if too long to prevent errors when starting an instance. To disable the truncation enter 0.

Note

Please be sure, that every process table field you use here, has the option Input enabled in the process table definition to allow the setting of the field from a REST resource.

Access 

Enabled

You can enable or disable the process link. Disabled process links cannot be used.

Notes 

Description

This is a descriptive field. You can enter additional remarks for a process link.

General 

Handle (required)

A handle for usage in the form finisher. It is unique in the TYPO3 installation. Only the characters A-Z, a-z, 0-9, - and _ are allowed.

Name (required)

A descriptive name for the step.

Process name (required)

Select one of the defined processes out of the list.

Step Number (required)

Enter the step number of the process.

Access 

Enabled

You can enable or disable the step link. Disabled step links cannot be used.

Notes 

Description

This is a descriptive field. You can enter additional remarks for a process link.

Start one instance 

So, let's start with an example. The form finisher is defined in the YAML configuration of the specific form:

finishers:
   -
      identifier: JobRouterStartInstance
      options:
         handle: 'start_website_contact'
         summary: 'Demo Contact'
         # It is important to add the JobRobot username.
         # The concrete name depends on your configuration above,
         # we assume "robot" here:
         username: 'robot'
         processtable:
            name: '{preName} {lastName}'
            company: '{company}'
            email_address: '{email}'
            phone_number: '{phone}'
            message: '{message}'
            form_identifier: 'www.example.com/demo'

As you can see, you can define some options. These are:

• handle (required): The step handle defined in the Processes module.
• summary: The summary of the instance.
• initiator: The initiator of the instance.
• username: The username the instance should be assigned to.
• jobfunction: The Job Function the instance should be assigned to.
• priority: The priority of the instance (number between 1 and 3).
• pool: The pool of the instance (positive number).
• processtable: You can map the form fields to the process table fields. As you can see in the example above, you define the process table field as the key (for example, email_address) and then map it with the to the form field identifier which is enclosed in curly brackets (for example, {email}). You can also set a static value, combine a static value with a form field or map multiple form fields to a process table field.

Start multiple instances 

It is also possible to start multiple instances – even on different JobRouter® installations. Just use the array notation in options:

finishers:
   -
      identifier: JobRouterStartInstance
      options:
         -
            handle: 'start_website_contact'
            summary: 'Demo Contact'
            username: 'robot'
            processtable:
               name: '{preName} {lastName}'
               company: '{company}'
               email_address: '{email}'
               phone_number: '{phone}'
               message: '{message}'
               form_identifier: 'www.example.com/demo'
         -
            handle: 'collect_anonymous_messages'
            summary: 'Demo Contact'
            username: 'robot'
            processtable:
               ANON_MESSAGE: '{message}'
               FROM_URL: 'https://www.example.com/demo'

Attachments 

One or more attachments (files) can be added to a form and processed with the JobRouterStartInstance form finisher. By default, the files are stored in the first file storage 1:/user_upload/, for example fileadmin/user_upload, but can be overwritten in your form configuration, for instance:

renderables:
  -
    # ...
    renderables:
      -
        properties:
        saveToFileMount: '3:/my_form_uploads/'
        allowedMimeTypes:
          - application/pdf
        type: FileUpload
        identifier: the_pdf_file
        label: 'The PDF file'

In this example, the files are stored in the file storage with the ID 3, and there in a folder named my_form_uploads.

When running the "clean up transfers" command, the files are deleted alongside the according transfer records.

Variables 

You can use variables in the common parameters, such as summary or initiator, and in the process table fields.

For more information have a look into the available variable resolvers. You can also write your own variable resolvers.

Preparing the instance data 

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

<?php
declare(strict_types=1);

namespace MyVendor\MyExtension\Controller;

use JobRouter\AddOn\Typo3Process\Domain\Dto\Transfer;
use JobRouter\AddOn\Typo3Process\Domain\Repository\StepRepository;
use JobRouter\AddOn\Typo3Process\Exception\PrepareException;
use JobRouter\AddOn\Typo3Process\Transfer\Preparer;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

final class MyController extends ActionController
{
   public function __construct(
      private readonly Preparer $preparer,
      private readonly 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->findByHandle('your_step_handle');

      // Define the transfer DTO with your parameters
      // Have a look in the Domain\Dto\Transfer class to see the available setters
      $transfer = new Transfer(time(), $step->getUid(), 'my-correlation-id);
      $transfer->setType('Demo');
      $transfer->setSummary('My summary');
      $transfer->setProcesstable(
         \json_encode([
            '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).

Dashboard 

The dashboard widgets "Instance Starts" and "Instance Start Types" have been removed. If statistics are necessary, use Matomo, Google Analytics or another web analytics tool.

Form finisher 

The "type" option has been removed from the "JobRouterStartInstance" form finisher as it serves no purpose anymore.

Command 

The default value for the "ageOfDays" option in the Clean up transfers command has been lowered from 30 days to 7 days. If you rely on the 30 days, and haven't used the "ageOfDays" option before, you can set it explicitly:

vendor/bin/typo3 jobrouter:process:cleanuptransfers 30

php public/typo3/sysext/core/bin/typo3 jobrouter:process:cleanuptransfers 30

Fixed 

• Finisher preset identified by "JobRouterStartInstance" could not be found

Added 

• Compatibility with TYPO3 v13

Changed 

• Default value of "ageOfDays" option in cleanup command lowered from 30 to 7 days

Removed 

• Compatibility with TYPO3 v11
• Widgets "Instance Starts" and "Instance Start Types"
• "type" option from the "JobRouterStartInstance" form finisher

Fixed 

• Closing edit view in backend shows empty page

Changed 

• Require JobRouter REST Client in version 3
• Namespace from Brotkrueml\JobRouterProcess to JobRouter\AddOn\Typo3Process

Added 

• Allow attachment and date types for an instance start (#9)
• Compatibility with TYPO3 v12

Changed 

• Require JobRouter Client in version 2
• Require JobRouter Connector extension in version 2
• Require JobRouter Base extension in version 2
• Models are no longer Extbase-based and are moved to the Domain/Entity namespace
• Repositories are no longer Extbase-based

Removed 

• Compatibility with TYPO3 v10 (#5)
• Compatibility with PHP 7.4 and 8.0
• Configuration of log writers in the extension configuration

Removed 

• Compatibility with PHP 7.3

Fixed 

• Database error in module DB Check > Records Statistics due to wrong label in TCA
• Handle multibyte characters correctly when cutting string to specific length for transfer

Added 

• Compatibility with TYPO3 v11 LTS
• Possibility to refresh dashboard widgets (TYPO3 v11+ only)

Deprecated 

• Configuration of log writers in the extension configuration

Removed 

• Compatibility with PHP 7.2

Added 

• Show number of days for available transfers in status widget

Fixed 

• Set crdate in transfer table correctly

Added 

• Dashboard widget "Instance Start Errors"

Changed 

• Raise minimum required version to TYPO3 10.4.11

Changed 

• Identifiers of widgets
• Use log table from TYPO3 JobRouter Base extension
• Rename "transfer identifier" to "correlation id" in transfer table

Fixed 

• Differentiate between empty string and 0 in form finisher (integer field)
• Consider maximum length of step parameters

Added 

• Possibility to encrypt transfer data

Added 

• Change/add description field for process/step record
• JobRouter language variable resolver
• Get form values from ResolveFinisherVariableEvent

Changed 

• Rework "Instance Start Status" widget

Updated 

• TYPO3 JobRouter Connector to version 0.11

Removed 

• RestClientFactory is not available anymore, use from TYPO3 JobRouter connector extension instead
• Default parameters in step record

Fixed 

• Show disabled hint in list view
• Resolve all form values in StartInstanceFinisher (also not available because of unfulfilled conditions)

Added 

• Support for TYPO3 v10 LTS
• Prepare for upcoming major PHP versions
• Dashboard widget "Instance starts"
• Dashboard widget "Instance start status"
• Dashboard widget "Types of instance starts"
• Identify types of transfers

Changed 

• Rename DeleteOldTransfersCommand to CleanUpTransfersCommand

Removed 

• Support for TYPO3 v9 LTS

Added 

• Use toggle to display process table fields in module

Changed 

• Throw exception when using undefined process table field

Fixed 

• Assign correct value to process table field when using multi checkbox

Added 

• Type to list of process table fields in module

Fixed 

• Correct translation for frontend context

Changed 

• Simplify configuration in form finisher

Fixed 

• Shorten strings to the maximum length of process field in form finisher

Added 

• Language variable resolver for form finisher
• Localised label variable resolver for form finisher
• Display last run of start command in system information toolbar