Please enable JavaScript to view this site.

Administrationshandbuch

Navigation: Tech Doc

Konfigurationsdatei

Scroll Zurück Oben Weiter Mehr

Bestimmte Einstellungen, welche den JobRouter und die angebundene Datenbank betreffen, werden in einer Konfigurationsdatei gesetzt (<jobrouter>/config/config.php). Dies sind Einstellungen wie der Datenbankname, der Datenbankbenutzer oder der Standardpfad für das Logging. Bei der Installation von JobRouter werden alle notwendigen Einstellungen in der Datei automatisch eingetragen. Es besteht die Möglichkeit, weitere Einstellungen zu setzen (z. B. den Log-Level ändern oder die Anzeige der Ausführungszeit in der Oberfläche aktivieren).

Die Einstellungen werden als Array (ab Version 5.0.0) oder als einzelnen Konstanten definiert. Wird die Array-Syntax benutzt, werden die Einstellungen nach Bereichen gruppiert. Die einzelnen Bereiche entsprechen den Array-Schlüsseln.

Bitte beachten Sie: Die Konfigurationsdateien von bestehenden Installationen werden beim Update nicht automatisch umstrukturiert. Dies soll manuell erfolgen. Die alte Struktur wird weiterhin unterstützt, wir empfehlen aber eine zeitnahe Umstellung. Die Konstanten für Einstellungen die nun die neue Struktur verwenden, wurden als veraltet in der Konstanten-Übersicht im JobRouter-Portal markiert. Weitere Konstanten werden sukzessiv in nachfolgenden Versionen in die neue Struktur überführt.

Bitte beachten Sie: Die Konstante CONST_DB_PWD wird ab der Version 5.1.0 nicht mehr unterstützt. Sie wird im Patch automatisch in die Array-Syntax konvertiert.

Standard-Konfigurationsdatei ab Version 5.0.0 (MSSQL Server):

<?php

define('CONST_LOGIN_FUNCTIONS', 0);

define('CONST_CHECK_IP', 0);

define('CONST_LOGGER_DEFAULT_PATH', 'path\\to\\jobrouter\\output\\log\\');

define('CONST_LOG_LEVEL_FILE', 'WARNING');

define('CONST_UNICODE_MODE', 1);

return [

  'db' => [

    'user' => 'dbuser',

    'password' => '*****',

    'server' => 5,

    'host' => 'dbhost',

    'database' => 'EXAMPLEDB',

    'port' => '',

  ]

];

Seit Version 2024.1 wird in dem Array auch die Standardsprache gespeichert, was z. B. für die Login-Seite verwendet wird:

...    

    'localization' => [

        'language' => 'english',

    ],

....

Die Sprache kann weiterhin im Menü "Anzeigeeinstellungen" geändert werden. Dabei wird auch der Eintrag in der Konfigurationsdatei aktualisiert. Ändern Sie den Eintrag in der Datei bitte nicht manuell. Nach einer Änderung der Standardsprache in den Anzeigeeinstellungen muss das Verzeichnis cache/symfony geleert werden.

Standard-Konfigurationsdatei mit alter Struktur  (MSSQL Server):

<?php
const CONST_DB_USR = 'dbuser';

const CONST_DB_PWD = '*****';

const CONST_DB_SERVER = 5;

const CONST_DB_HOST = 'dbhost';

const CONST_DB_DATABASE = 'EXAMPLEDB';

const CONST_DB_PORT = '';

const CONST_LOGIN_FUNCTIONS = 0;

const CONST_CHECK_IP = 0;

const CONST_UNICODE_MODE = 1;

const CONST_LOGGER_DEFAULT_PATH = 'path\\to\\jobrouter\\output\\log\\';

const CONST_LOG_LEVEL_FILE = 'WARNING';

const CONST_UNICODE_MODE = 1;

Die Konstanten können mit define oder const definiert werden:

In der Array-Syntax werden aktuell nur folgende Datenbank-Einstellungen unterstützt (mit Schlüssel db):

Einstellung als Konstante

Einstellung im Konfigurationsarray

CONST_DB_USR

user

CONST_DB_PWD

password

CONST_DB_SERVER

server

CONST_DB_HOST

host

CONST_DB_DATABASE

database

CONST_DB_PORT

port

CONST_DB_CHARSET

charset

CONST_DB_EXEC_TIME_LIMIT

execTimeLimit

Weitere Konfigurationsparameter

In dem Array, welches von der config.php zurückgegeben wird, können Sie optional weitere Parameter definieren.

Bitte beachten Sie: die Einstellungen der config.php werden gecached. Wenn Sie Änderungen daran vornehmen, muss im Anschluss das cache/symfony-Verzeichnis gelöscht werden. Beim nächsten Aufruf von JobRouter wird der Cache neu aufgebaut. Dies kann bis zu 1-2 Minuten dauern.

Schlüssel path

Schlüssel

Wert

cache

Absoluter Pfad zu dem ausgelagerten Cache-Verzeichnis.  Bei der Auswahl des Cache-Verzeichnis sollten die allgemeinen Optimierungen beachtet werden.

Beispiel:

<?php

 

// ...

 

return [

  'db' => [

    // ...

  ],

  'path' => [

    'cache' => 'C:\jobrouter\external-jobrouter-cache'

  ],

];

 

Schlüssel cache

Ein Array mit Einstellungen bezogen auf den JobRouter-Cache.

Schlüssel

Wert

connector

Speicherort des JobRouter-Caches. Der Wert kann auf database gesetzt werden, damit der JobRouter-Cache in der Datenbank in einer Tabelle cache_items gespeichert wird. Ist der Schlüssel nicht vorhanden, wird der Cache auf dem Dateisystem gespeichert (Standardverhalten).

 

Bei der Auswahl des Speicherortes sollten die allgemeinen Optimierungen beachtet werden.

 

Die Einstellung ist ab Version 2023.1.21, 2024.1.7 und 2024.2.2 verfügbar.

Beispiel:

<?php

 

// ...

 

return [

  'db' => [

    // ...

  ],

  'cache' => [

    'connector' => 'database'

  ],

];

Schlüssel log

Ein Array mit Einstellungen bezogen auf das Logging.

Schlüssel

Wert/Beschreibung

separateLogPerProcessInstance

Vorgangsbezogenes Logging deaktivieren. Standardmäßig werden alle Vorgangsdaten in einer Datei incident_processid_date.log geschrieben. Mit dem Wert false kann das vorherige Verhalten mit getrennten Log-Dateien wiederhergestellt werden (incident.log, step.log usw.)

Wenn der Eintrag nicht vorhanden oder auf true gesetzt ist, wird eine Log-Datei pro Vorgang erstellt.

Beispiel:

<?php

 

// ...

 

return [

  // ...

  'log' => [

    'separateLogPerProcessInstance' => false

  ],

];

Schlüssel rabbitmq

Ein Array mit Einstellungen für die RabbitMQ-Anbindung.

Schlüssel

Wert

port

Port für die Kommunikation (standardmäßig 5672 oder bei Verwendung von SSL 15672)

apiPort

Port für die Aufrufe der RabbitMQ-API, z. B. für Aliveness-Test (standardmäßig 5671 oder bei Verwendung von SSL 15671)

cacert

Pfad zur SSL-Zertifikatsdatei

Beispiel:

<?php

 

// ...

 

return [

  // ...

  'rabbitmq' => [

    'port' => 443,

    'apiPort' => 8443,

    'cacert' => '/mnt/certs/cert.pem'

  ],

];

Schlüssel feature

Ein Array mit Features, die optional aktiviert oder deaktiviert werden können.

Schlüssel

Wert/Beschreibung

parallelStepProcessing

Schritte werden von JobServer standardmäßig parallel abgearbeitet, wenn die Anzahl der zu verarbeitender Schritte verschiedene Schwellenwerte überschreitet. Unter Umständen kann dies zu einem Fehlverhalten führen, wodurch die Schrittverarbeitung auf einen Fehler läuft und keine Schritte mehr verarbeitet werden.

Mit dieser Option kann die parallele Verarbeitung deaktiviert werden (Wert auf false setzen). Das Deaktivieren führt jedoch zu einer langsameren Verarbeitung und wirkt sich dadurch grundsätzlich auf die Performance von JobRouter aus. Deshalb empfehlen wir, diese Option nur solange zu deaktivieren, bis eine paralle Verarbeitung wieder möglich ist. Dafür entfernen Sie diesen Schlüssel aus dem Konfigurationsarray oder setzen Sie den Wert auf true.

Beispiel:

<?php

 

// ...

 

return [

  // ...

  'feature' => [

    'parallelStepProcessing' => false

  ],

];

];

Schlüssel url

Schlüssel

Wert/Beschreibung

help

Legt fest unter welcher URL die Dokumentation aufgerufen werden kann. Wenn dieser Wert nicht konfiguriert ist wird standardmäßig auf die JobRouter Online-Dokumentation weitergeleitet.

Beispiel:

<?php

 

// ...

 

return [

  // ...

  'url' => [

    'help' => 'https://jobrouter/help/html'

  ],

];

 

Schlüssel security

Schlüssel

Wert/Beschreibung

interpretLoginTextHtml

Die Einstellung dient dazu, das Interpretieren von JavaScript auf die Login-Seite zu unterbinden. Dazu wird der Wert auf false gesetzt werden. Wenn der Eintrag nicht vorhanden oder auf true gesetzt ist, wird JavaScript interpretiert.

Die Einstellung ist ab Version 2023.1.11 verfügbar.

Beispiel:

<?php

 

// ...

 

return [

  // ...

  // Interpretieren unterbinden

  'security' => [

    'interpretLoginTextHtml' => false,

  ],

];