JobRouter Prozess Designer

https://docs.jobrouter.com/2026.1/de/designer
Admin
This manual provides comprehensive documentation for JobRouter Process Designers and Developers,...
Tokens:412,938
Snippets:3,017
Trust Score:9.7
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install @jobrouter/api with npm

Source: https://docs.jobrouter.com/2026.1/de/designer/jsapi_ide.html

Use this command to install the @jobrouter/api package via npm, enabling API autocompletion in your IDE.

```bash
npm install @jobrouter/api
```

--------------------------------

### Install @jobrouter/api with yarn

Source: https://docs.jobrouter.com/2026.1/de/designer/jsapi_ide.html

Use this command to install the @jobrouter/api package via yarn, enabling API autocompletion in your IDE.

```bash
yarn add @jobrouter/api
```

--------------------------------

### Example: Setting a Date Field Value

Source: https://docs.jobrouter.com/2026.1/de/designer/jsapi_jr_set_value.html

This example retrieves a date value from 'end_date' and sets it to 'start_date' if it is a valid Date object. It demonstrates the use of jr_get_value and jr_set_value.

```javascript
function setDateFieldValue() {

 var newDateValue = jr_get_value('end_date');

 if (newDateValue instanceof Date) {

         jr_set_value('start_date', newDateValue);

 }

}
```

--------------------------------

### getStartDate() Beispiel

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getstartdate.html

Ermittelt das Startdatum des Vorgangs als UNIX-Timestamp. Die Funktion benötigt keine Parameter und wird typischerweise innerhalb einer Prozessklasse aufgerufen.

```php
…

$startDate = $this->getStartDate();

…
```

--------------------------------

### Get initiator username with $this->getInitiator()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getinitiator.html

Use this PHP snippet to retrieve the username of the user who started the current process. The function takes no parameters and returns the username as a string.

```php
$username = $this->getInitiator();
```

--------------------------------

### Get full output path with getFullOutputPath

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getfulloutputpath.html

Call getFullOutputPath to retrieve the full path to the output directory of the JobRouter installation. The function takes no parameters and returns the path as a string.

```php
// Pfad zu output-Verzeichnis ermitteln
$outputPath = $this->getFullOutputPath();
```

--------------------------------

### getFullOutputPath()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getfulloutputpath.html

Ermittelt den vollständigen Pfad zum output-Verzeichnis der JobRouter-Installation. Die Funktion hat keine Parameter und gibt den Pfad als String zurück.

```APIDOC
## getFullOutputPath()

### Description
Diese Funktion ermöglicht Ihnen die Ermittlung des vollständigen Pfades zum output-Verzeichnis der JobRouter-Installation.

### Method
PHP-Funktion

### Endpoint
$this->getFullOutputPath()

### Parameters
Keine Parameter.

### Request Example
```php
// Pfad zu output-Verzeichnis ermitteln
$outputPath = $this->getFullOutputPath();
```

### Response
#### Success Response
- **Rückgabewert** (string) - Vollständiger Pfad zum output-Verzeichnis der JobRouter-Installation.

#### Response Example
```php
$outputPath = '/var/www/jobrouter/output';
```
```

--------------------------------

### Pfad zu temp-Verzeichnis ermitteln mit getFullTempPath

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getfulltemppath.html

Verwendung der Funktion getFullTempPath, um den vollständigen Pfad zum temp-Verzeichnis der JobRouter-Installation zu erhalten. Das Temp-Verzeichnis wird nicht automatisch bereinigt; es sollte regelmäßig überprüft oder durch eigene Programmierung bereinigt werden.

```php
…

// Pfad zu temp-Verzeichnis ermitteln

$tempPath = $this->getFullTempPath();

…
```

--------------------------------

### Get Process Step Id with getStepId()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_processstepid.html

Example call to getStepId() to retrieve the Process Step Id of the current step. The function takes no parameters and returns the Process Step Id.

```php
$processStepId = $this->getStepId();
```

--------------------------------

### Set read-only false for all rows in a subtable

Source: https://docs.jobrouter.com/2026.1/de/designer/jsapi_jr_set_subtable_field_readonly.html

Example function that sets the read-only property to false for the 'text1' field in all rows of the subtable view 'name_subtable_sv'. Uses jr_get_subtable_row_ids to get row IDs and iterates over them.

```javascript
setReadonlyFalse : function () {

        var rowIds = jr_get_subtable_row_ids('name_subtable_sv');

        rowIds.forEach(function (rowId) {

            jr_set_subtable_field_readonly('name_subtable_sv', rowId, 'text1', false);

        });

}
```

--------------------------------

### getFullTempPath()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getfulltemppath.html

Ermittelt den vollständigen Pfad zum temp-Verzeichnis der JobRouter-Installation. Die Funktion benötigt keine Parameter und gibt den Pfad als String zurück.

```APIDOC
## getFullTempPath()

### Description
Ermittelt den vollständigen Pfad zum temp-Verzeichnis der JobRouter-Installation. Die Funktion benötigt keine Parameter und gibt den Pfad als String zurück.

### Method
PHP-Funktion

### Endpoint
$this->getFullTempPath()

### Parameters
Keine Parameter.

### Request Example
```php
$tempPath = $this->getFullTempPath();
```

### Response
#### Success Response
- **Rückgabewert** (string) - Vollständiger Pfad zum temp-Verzeichnis, z.B. `C:\inetpub\wwwroot\jobrouter\output\temp`

#### Response Example
```
C:\inetpub\wwwroot\jobrouter\output\temp
```

### Notes
Das temp-Verzeichnis wird nicht automatisch von JobRouter bereinigt. Um Datenmüll zu vermeiden, sollte das Verzeichnis regelmäßig überprüft oder durch eigene Programmierung bereinigt werden.
```

--------------------------------

### isSimulation() Abfrage in PHP

Source: https://docs.jobrouter.com/2026.1/de/designer/php_sissimulation.html

Verwendung der Funktion isSimulation() in einer if-else-Bedingung, um zwischen Simulation und normalem Vorgang zu unterscheiden. Die Funktion liefert true bei Simulation, sonst false.

```php
if ($this->isSimulation()) {
    ...
} else {
     ...
}
```

--------------------------------

### Set read-only true for all rows in a subtable

Source: https://docs.jobrouter.com/2026.1/de/designer/jsapi_jr_set_subtable_field_readonly.html

Example function that sets the read-only property to true for the 'text1' field in all rows of the subtable view 'name_subtable_sv'. Uses jr_get_subtable_row_ids to get row IDs and iterates over them.

```javascript
setReadonlyTrue : function () {

        var rowIds = jr_get_subtable_row_ids('name_subtable_sv');

        rowIds.forEach(function (rowId) {

            jr_set_subtable_field_readonly('name_subtable_sv', rowId, 'text1', true);

        });

},
```

--------------------------------

### Configure and get URL with GetJobArchiveResultListUrlBuilder

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getjobarchiveresultlisturlbuilder.html

Example usage of the URL builder: sets username, validity period, exact and compare filters, enables exact revision, and retrieves the URL. The ellipsis (...) indicates omitted code.

```php
…

$urlBuilder->setUsername('mmustermann');

$urlBuilder->setValidFrom(new DateTime('2013-10-01'));

$urlBuilder->setValidUntil(new DateTime('2013-12-31'));

$urlBuilder->addExactFilter('kundennummer', '005983');

$urlBuilder->setUseExactRevision(true);

$urlBuilder->addCompareFilter('rechnungsdatum', '2013-01-01', '>');

$urlBuilder->addRangeFilter('rechnungsbetrag', 1000, '>=', 10000, '<=');

$url = $urlBuilder->getUrl();

…
```

--------------------------------

### getStartDate()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getstartdate.html

Returns the start date of the process as a UNIX timestamp. This function takes no parameters and is called directly on the process object.

```APIDOC
## getStartDate()

### Description
Returns the start date of the process as a UNIX timestamp.

### Method
Function call

### Endpoint
$this->getStartDate()

### Parameters
None

### Request Example
```php
$startDate = $this->getStartDate();
```

### Response
#### Success Response
- **Return value** (integer) - The start date as a UNIX timestamp.

#### Response Example
```php
$startDate = $this->getStartDate();
```
```

--------------------------------

### Get current process version with $this->getVersion()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getversion.html

Use this snippet to retrieve the version of the current process. The function takes no parameters and returns the version as an integer. The example shows the call within a PHP method context.

```PHP
$processVersion = $this->getVersion();
```

--------------------------------

### preparedExecute Beispiel mit benannten Parametern

Source: https://docs.jobrouter.com/2026.1/de/designer/php_db_preparedexecute.html

Verwendung von preparedExecute auf $jobDB, um ein UPDATE-Statement mit benannten Parametern auszuführen. Die Parameterwerte und -typen werden als Arrays übergeben. Die Reihenfolge der Werte muss mit der Reihenfolge der Typen übereinstimmen, andernfalls können fehlerhafte SQLs entstehen. Im Fehlerfall wird eine JobRouterException geworfen.

```php
$jobDB = $this->getJobDB();

$sql = 'UPDATE JRUSERS SET blocked = :blocked WHERE username = :username';

$parameters = [
 'blocked' => 0,
 'username' => 'some_username_here'
];

$types = [
 JobRouter\Common\Database\ConnectionInterface::TYPE_INTEGER,
 JobRouter\Common\Database\ConnectionInterface::TYPE_TEXT,
];

$jobDB->preparedExecute($sql, $parameters, $types);
```

--------------------------------

### PHP: Retrieve and iterate subtable row IDs with getSubtableRowIds

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getsubtablerowids.html

Use this snippet to get all row IDs from a subtable and loop through them. The function returns an array of row IDs matching the row_id column. The example uses the subtable 'RECHNUNGSPOSITIONEN' and accesses the 'POSITION' value for each row.

```php
// RowIds ermitteln
$rowIds = $this->getSubtableRowIds('RECHNUNGSPOSITIONEN');

// Schleife über alle Zeilen
foreach ($rowIds as $rowId) {
    $position = $this->getSubtableValue('RECHNUNGSPOSITIONEN', 
        $rowId, 'POSITION');
}
```

--------------------------------

### Formatierung für Protokolleinträge deaktivieren (rawLog)

Source: https://docs.jobrouter.com/2026.1/de/designer/php_fehlerprotokollierung.html

Deaktiviert die Formatierung der Protokolleinträge vollständig, sodass sie unverändert in die Logdatei geschrieben werden. Im Beispiel wird ein Array mit Rechnungsdaten übergeben und mit debug ausgegeben.

```php
$this->rawLog();

$rechnungsdaten = ['rechnungsnummer' => 43523453, 'rechnungsdatum' => '01.07.2015', 'kundennummer' => '5325438'];

$this->debug($rechnungsdaten);
```

--------------------------------

### getInitiator()

Source: https://docs.jobrouter.com/2026.1/de/designer/php_getinitiator.html

This function returns the username of the user who started the current process. It takes no parameters and returns a string.

```APIDOC
## getInitiator()

### Description
Returns the username of the user who started the current process.

### Method
Function call

### Endpoint
$this->getInitiator()

### Parameters
None

### Return Value
- **String** - The username of the initiator.

### Example
```php
$username = $this->getInitiator();
```
```
Tokens:
Raw