5.0
en
Chris Müller, JobRouter GmbH
This document is published under the Creative Commons BY 4.0 license.
Wed, 22 Apr 2026 06:22:43 +0000
Connect TYPO3 with the JobRouter® digitalisation platform
Table of Contents:
JobRouter® is a scalable digitalisation platform which links processes, data and documents. The TYPO3 extension "TYPO3 JobRouter Connector" links TYPO3 with the JobRouter® platform.
The TYPO3 JobRouter Connector is a base extension for defining connections from TYPO3 to JobRouter®. Other extensions rely on this extension to add further functionality:
This extension uses the JobRouter REST Client library.
Note
If you find a bug or want to propose a feature, please use the issue tracker on GitHub.
This extension uses semantic versioning which basically means for you, that
The changes between the different versions can be found in the changelog.
Target group: Administrators
Note
The extension in version 5.0 supports TYPO3 v13 LTS and TYPO3 v14 LTS.
In addition to the TYPO3 requirements this extension needs the following PHP
extensions: curl and sodium.
| JobRouter Connector | PHP | TYPO3 |
|---|---|---|
| 5.0 | 8.2 - 8.5 | 13.4 / 14.3 |
| 4.0 | 8.1 - 8.4 | 12.4 / 13.4 |
| 3.0 | 8.1 - 8.3 | 11.5 / 12.4 |
| 2.0 | 8.1 - 8.3 | 11.5 / 12.4 |
| 1.2 | 7.4 - 8.2 | 10.4 / 11.5 |
| 1.1 | 7.3 - 8.1 | 10.4 / 11.5 |
| 1.0 | 7.2 - 7.4 | 10.4 |
The recommended way to install this extension is by using Composer. In your Composer-based TYPO3 project root, just type:
composer req jobrouter/typo3-connectorand the recent version will be installed.
The extension offers some configuration which is explained in the Configuration chapter.
In a classic installation, you can also install the extension from the TYPO3 Extension Repository (TER).
Target group: Administrators
To configure the extension, go to System > Settings > Extension Configuration and click on the Configure extensions ... button. Open the jobrouter_connector configuration:
Extension configuration
The extension stores credentials in the database, the password will be encrypted. With this configuration setting you define the path and name of the key file relative to the project directory.
Attention
The key should never be accessible via a browser. So do not put it in
a folder like public or htdocs. If you have a standard TYPO3
installation, the default value is fine.
An encryption key is required to encrypt and decrypt the password. The extension provides a console command for creating a key. So log on to your server and go to the project path. To generate the key, you need write permissions for this path. Run the following command in the project directory for a composer installation:
vendor/bin/typo3 jobrouter:connector:generatekeyIn a non-Composer (legacy) installation execute:
php typo3/sysext/core/bin/typo3 jobrouter:connector:generatekeyHopefully you will receive a successful response:
[OK] Key was generated and stored into "/your/project/path/.jobrouterkey"Some words about the key
Target group: Integrators, Administrators
The connections to JobRouter® installations are managed in the backend module JobRouter > Connections.
Note
The module is only available in the live workspace.
On your first visit after installing the extension and generating the key you should see the following screen:
Initial Connections module screen
Note
If you get the error message that the key file does not exist, first generate the key.
To create a new connection, click on the + Add connection button in the upper menu bar, which displays a form:
Create a connection
The following fields are available:
The base URL of the JobRouter® installation.
Caution
The JobRouter® installation should be accessible only over TLS (https), so that the credentials are transmitted encrypted.
The username to sign in over the REST API.
Tip
For security reasons, use a JobRouter® user who only has the access rights required for the purpose (technical user). It is also possible to create more than one connection to the same JobRouter® installation with different users.
The maximum number of seconds to execute a request.
Default: 0
The TLS certificate of the JobRouter® installation is checked when connecting.
Default: activated
Important
This should only be disabled when connecting to a test or development installation as this introduces security issues.
Enter the URL when connecting through a proxy to the JobRouter® installation.
Default: (empty)
After creating one or more connections, you will see a list of connections when calling the module:
Connection list
If a connection is not enabled, this is indicated by the addition "(disabled)" in the name.
There are three buttons available for each connection:
To delete a connection, open the editing page of the connection. In the upper menu bar you will find the Delete button.
Note
Currently, there is no check during deletion whether a connection is used in other records.
Target group: Developers
You can use the TYPO3 JobRouter Connector as a starting point for your own
logic, for example, to synchronise JobData tables or retrieve archive documents.
Since this extension relies on the JobRouter REST Client library, you can get
a
Rest object to call the JobRouter® REST API.
To simplify the creation of this client object, a factory method is available. Let's have a look at an example in the TYPO3 context:
<?php
declare(strict_types=1);
use JobRouter\AddOn\RestClient\Exception\ExceptionInterface;
use JobRouter\AddOn\Typo3Connector\Domain\Entity\Connection;
use JobRouter\AddOn\Typo3Connector\Domain\Repository\ConnectionRepository;
use JobRouter\AddOn\Typo3Connector\Exception\ConnectionNotFoundException;
use JobRouter\AddOn\Typo3Connector\RestClient\RestClientFactory;
use Psr\Http\Message\ResponseInterface;
final readonly class MyController
{
public function __construct(
private ConnectionRepository $connectionRepository,
private RestClientFactory $restClientFactory,
) {}
public function myAction(): ResponseInterface
{
try {
/** @var Connection $connection */
$connection = $this->connectionRepository->findByHandle('example');
} catch (ConnectionNotFoundException) {
// The connection is not found or disabled
}
try {
$client = $this->restClientFactory->create($connection, 60);
} catch (ExceptionInterface) {
// Maybe authentication failure or HTTP error
}
// Now you can call the request() method of the $client
}
}
Explanation:
Connection entity class with handle example,
which holds the base URL of the JobRouter® installation and the credentials.
Of course, the connection must be registered first in the
Connections module.example or the connection is disabled.
So you have to consider this case.
create() method of the
RestClientFactory . The first argument is the
Connection model,
the second argument the optional lifetime of the authentication token. With
the call the authentication is done immediately, so an exception can be
thrown if a HTTP error occurs or the authentication failed. With the client
object you can make the calls to the REST API. Have a look at the
JobRouter REST Client examples.Note
Have a look at additional TYPO3 extensions for synchronising JobData tables or starting process instances from TYPO3.
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Brotkrueml\JobRouterConnector to JobRouter\AddOn\Typo3ConnectorInitial preview release
The namespace of the JobRouter TYPO3 Connector classes have changed from
\Brotkrueml\JobRouterConnectorto
\JobRouter\AddOn\Typo3ConnectorThe easiest way to update your code to the new namespace is to use search/replace in your project.
The package name (used in composer.) has changed from
brotkrueml/ to jobrouter/.