Document toolboxDocument toolbox

Installation Backend und Services

Alle Installationsprogramme bieten es an, diese in einem Silent-Modus zu installieren. Hierzu kann folgender Aufrufparameter verwendet werden:

C:\<install>.exe /exenoui <PARAMETERS> /passive

Für die Funktionsweise des Systems werden Drittkomponenten benötigt. Diese können sowohl in Docker als auch in Windows betrieben werden.

Möchten Sie die benötigten Dienste als Docker-Container betreiben, benötigen Sie die folgenden Docker-Images

Externe nicht verwaltet von uns:

  • postgres:latest

  • rabbitmq:3.8.2

  • solr:8

  • minio/minio (Wird nur benötigt für den Betrieb vom Object Storage)

Bei den externen Images haben wir leider keinen Einfluss auf die Qualität und dessen Update-Zyklen. Aus diesem Grund sind auch feste Versionsnummern angegeben mit denen das System bei uns im Testzentrum betrieben wurde.

Bei der Verwendung von Docker-Container ist zu beachten, dass die Dienste und Anwendungen eine Abhängigkeit von den Backend-Systemen haben.

Aus diesem Grund empfehlen wir, dass alle Dienste und Anwendungen von uns auf die oben genannten Dienste warten, bis diese zur Verfügung stehen.

Zur Installation des Backends unter Windows bitten wir, die Schritte der folgenden Anleitung zu beachten. https://actiware-development.atlassian.net/wiki/spaces/AWIO/pages/3216310503

Authentication Service

Aufrufparameter

Beschreibung

Standardwert

Aufrufparameter

Beschreibung

Standardwert

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DATABASE_SERVER

Angabe des Datenbankservers

localhost:5432

DATABASE_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

DEFAULT_USER

Name des Benutzers, der im Authentifizierungs-Service automatisch angelegt werden soll

admin

DEFAULT_PASS

Passwort des Benutzer, der im Authentifizierungs-Service automatisch angelegt werden soll

admin

DEFAULT_PORT

Port, auf dem der Authentifizierungs-Service laufen soll

30001

DEFAULT_DB

Name der Datenbank-Collection für den Authentifizierungs-Service (Wird automatisch angelegt, wenn nicht vorhanden)

io-auth-service

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest

UTF8

TOKEN

Docker: TOKEN_MASTER

Master token, welcher für jede Verbindung zu den einzelnen Services verwendet werden kann

lDJHC2EdeGzchDv9SACl

EXCHANGE_AUTH

Name der Queue, die für das Senden von Authentifizierungsnachrichten verwendet werden soll.

auth.service

BIND_TOKEN_TO_IP

Angabe, ob die Tokens an die IP Adresse des Anwenders gebunden werden soll. 

false

VALIDITY_PERIOD

Docker: DEFAULT_VALIDITY_PERIOD

Angabe (in Sekunden), wie lange ein Token inaktiv bleiben darf, bis dieser als ungültig gekennzeichnet wird.

86400

Docker:
KRB5_KTNAME

Angabe des Speicherortes für die keytab-Datei.

 

Lokale Konfigurationsdatei

{ "database": { "uri": "localhost:5432", "database": "io-auth-service", "encoding": "UTF8", "security": { "username": "admin", "password": "admin" } }, "amqp_config": { "host": "localhost", "port": 5672, "username": "rabbit", "password": "carrot", "exchange_name": "auth.service" }, "mail_config": { "smtp_server": "smtp.office365.com", "smtp_port": 587, "encryption": "STARTTLS", "sender": "", "user": "", "password": "" }, "default_validity_period": 86400, "bind_token_to_ip": false, "master_token": "lDJHC2EdeGzchDv9SACl", "first_user": "admin", "first_password": "admin", "port": 30001, "https": { "port": 32001, "certificate_file": "", "certificate_password": "" } }

Process Service

Aufrufparameter

Beschreibung

Standardwert

Aufrufparameter

Beschreibung

Standardwert

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DATABASE_SERVER

Angabe des Datenbankservers

localhost:5432

DATABASE_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest.

UTF8

DEFAULT_DB

Name der Datenbank-Collection für den Process-Service (Wird automatisch angelegt, wenn nicht vorhanden)

io-process-service

DEFAULT_PORT

Port, auf dem der Process-Service laufen soll

30003

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

http://localhost:30001

EXCHANGE_REPORTING

Name der Queue, die für das Senden von Reportnachrichten verwendet werden soll.

process.reporting

EXCHANGE_REPORTS

Name der Queue, die für das Senden von Reports verwendet werden soll.

process.reports

EXCHANGE_STATUS

Name der Queue, an die Statusinformationen gesendet werden sollen.

process.status

EXCHANGE_STATUS_KEY

Routing Key für das Senden von Statusinformationen.

process_engine_1

QUEUE_RPC

Name der Queue, die für RPC Aufrufe verwendet/bereitgestellt werden soll.

process.rpc

MODULE_CALLBACK_URL

Öffentliche Adresse des Process-Services. Diese Adresse wird an die einzelnen Module für die Kommunikation zum Process-Service verwendet.

http://localhost:30003

MODULE_TRIGGER_TOKEN

Angabe eines Sicherheitstokens, welcher von den Auslösern verwendet wird. 

admin

DEFAULT_USER

Angabe des Benutzers, welche für die Prozesse als Eigentümer eingetragen werden soll, sofern kein Eigentümer beim Starten eines Prozesse gesetzt wurde.

admin

DEFAULT_LANGUAGE

Angabe, welche Sprache verwendet werden soll, um Systemnachrichten zu übersetzen und welche Sprache für das Starten von Prozessen verwendet werden sollen.

en-US

ALLOW_ANONYMOUS_PROCESS_START

Angabe, ob Prozesse anonym gestartet werden dürfen.

true

DEBUG_LOG

Angabe, ob Debug-Meldungen auf der Konsole ausgegeben werden sollen.

false

REPORTS_DEFAULT_RETENTION (nur Docker)
REPORTS_DEVICE_RETENTION
REPORTS_NONDEVICE_RETENTION

Gibt an, wie lange die Reports standardmäßig vorgehalten werden. Nach Ablauf der hier angegebenen Zeit, werden die Reports automatisch gelöscht.

Folgende Werte können hier angegeben werden (das N steht für eine Zahl):

  • N years: Anzahl an Jahren

  • N months: Anzahl an Monaten

  • N days: Anzahl an Tagen

  • N hours: Anzahl an Stunden

  • N minutes: Anzahl an Minuten

  • N seconds: Anzahl an Sekunden

Die einzelnen Werte können auch per Komma getrennt angegeben werden. Die Angabe der Einheit (years, months, etc.) kann auch im Singular angegeben werden (year, month, etc.). Folgendes führt z.B. zu einer Aufbewahrungsdauer von 1 Jahr und 2 Monaten:

“1 year, 2 months”

Wird hier kein Wert angegeben, werden die Reports nie gelöscht. Über REPORTS_DEVICE_RETENTION und REPORTS_NONDEVICE_RETENTION kann das verhalten jeweils für Device-Prozesse und nicht-Device Prozesse festgelegt werden.

<leer>

HTTP_TIMEOUT

Gibt an, wie lange der Process Service auf die Antwort von Modulen und sonstigen HTTP Anfragen warten soll.

Folgende Werte können hier angegeben werden (das N steht für eine Zahl):

  • N years: Anzahl an Jahren

  • N months: Anzahl an Monaten

  • N days: Anzahl an Tagen

  • N hours: Anzahl an Stunden

  • N minutes: Anzahl an Minuten

  • N seconds: Anzahl an Sekunden

Die einzelnen Werte können auch per Komma getrennt angegeben werden. Die Angabe der Einheit (years, months, etc.) kann auch im Singular angegeben werden (year, month, etc.). Folgendes führt z.B. zu einer Wartedauer von 1 Jahr und 2 Monaten:

“1 year, 2 months”

5 minutes

USE_OLD_REPORT_SERVICE

Wenn dieser Wert auf “true” gesetzt wird, wird die Methodik des Report Service 1.x verwendet. Andernfalls werden die Reports in die Datenbank geschrieben, wo der Report Service 2.x diese abholt.

Diese Option setzt bei “true” die Konfigurationsoption “store_in_database” auf “false”.

 

REPORTS_RETAIN_OPTION_ERROR (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_ERROR
REPORTS_NONDEVICE_RETAIN_OPTION_ERROR

Über diese Optionen kann angegeben werden, ob fehlerhafte Prozesse einen Report erzeugen (true) oder nicht (false).

REPORTS_RETAIN_OPTION_ERROR legt dies Allgemein fest (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_ERROR liegt dies für Device Prozesse fest
REPORTS_NONDEVICE_RETAIN_OPTION_ERROR legt dies für nicht-Device Prozesse fest

true

REPORTS_RETAIN_OPTION_WARNING (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_WARNING
REPORTS_NONDEVICE_RETAIN_OPTION_WARNING

Über diese Optionen kann angegeben werden, ob Prozesse mit Warnungen einen Report erzeugen (true) oder nicht (false).

REPORTS_RETAIN_OPTION_WARNING legt dies Allgemein fest (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_WARNING liegt dies für Device Prozesse fest
REPORTS_NONDEVICE_RETAIN_OPTION_WARNING legt dies für nicht-Device Prozesse fest

 

REPORTS_RETAIN_OPTION_SUCCESS (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_SUCCESS
REPORTS_NONDEVICE_RETAIN_OPTION_SUCCESS

Über diese Optionen kann angegeben werden, ob erfolgreich durchgelaufene Prozesse einen Report erzeugen (true) oder nicht (false).

REPORTS_RETAIN_OPTION_SUCCESS legt dies Allgemein fest (nur Docker)
REPORTS_DEVICE_RETAIN_OPTION_SUCCESS liegt dies für Device Prozesse fest
REPORTS_NONDEVICE_RETAIN_OPTION_SUCCESS legt dies für nicht-Device Prozesse fest

 

Lokale Konfigurationsdatei

{ "database": { "address": "localhost:5432", "name": "io-process-service", "user": "admin", "password": "admin", "encoding": "UTF8", }, "message_queue": { "address": "localhost:5672", "user": "rabbit", "password": "carrot", "use_tls": false, "report_message_exchange": "process.reporting", "report_exchange": "process.reports", "rpc_queue": "process.rpc", "status_exchange": "process.status", "status_exchange_key": "process_engine_1" }, "log": { "output": "console", "mode": "Debug" }, "module_info": { "callback_url": "http://localhost:30003", "trigger_token": "admin", "amqp_server": "localhost:5672", "amqp_user": "rabbit", "amqp_pass": "carrot" }, "security": { "default_user": "demo", "allow_anonymous_process_start": false }, "reports": { "store_in_database": true, "retain_options": { "error": true, "warning": true, "success": true }, "retention": { "default": "" }, "device_process": { "retain_options": { "error": true, "warning": true, "success": true }, "retention": { "default": "" } }, "non_device_process": { "retain_options": { "error": true, "warning": true, "success": true }, "retention": { "default": "" } } }, "http_timeout": "5 minutes", "default_language": "en-US", "auth_service": "http://localhost:30001", "port": 30003 }

Report Service 1 obsolete

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DEFAULT_PORT

Port, auf dem der Report-Service laufen soll

30011

REBUILD_BATCH_SIZE

Angabe der Reports, die zeitglich für den Neuaufbau des Index verwendet werden sollen

100

RETENTION_INTERVAL

Angabe einer Zeitspanne, in welcher die Retention-Regeln ausgeführt werden sollen. Die Zeitspanne kann in optionalen Stunden, Minunten und Sekunden angegeben werden. Hierzu trägt jede angegebene Ziffer, einen Suffix. Zulässige Suffixe: “h” für Stunde, “m” für Minute und “s” für Sekunde. Beispiel für eine Zeitspane von 3 Stunden, 2 Minuten und 1 Sekunde: “3h2m1s”

1h

DB_HOST

Angabe des Hostname des PostgreSQL Servers

localhost

DB_PORT

Angabe des Ports vom PostgreSQL Server

5432

DB_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DB_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest

UTF8

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzer der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AMQP_REPORT_MESSAGES_EXCHANGE

Name des Exchange, der für das Empfangen von Nachrichten verwendet werden soll.

process.reporting

AMQP_REPORT_MESSAGES_QUEUE

Name der Queue, die für das Empfangen von Nachrichten verwendet werden soll.

rps.reportMessages

AMQP_REPORTS_EXCHANGE

Name des Exchange, der für das Empfangen von Reports verwendet werden soll.

process.reports

AMQP_REPORTS_QUEUE

Name der Queue, die für das Empfangen von Reports verwendet werden soll.

rps.reports

REPORT_PATH

Angabe, in welchem Verzeichnis auf dem Server Reports gespeichert werden sollen.

reports

SEARCH_HOST

Angabe des Hostname des Suchdienstes.

localhost

SEARCH_PORT

Angabe des Ports, auf dem der Suchdienst erreichbar sein soll.

8983

SEARCH_CORE

Angabe der Bezeichnung für die Suchindex Datenbank für Reporteinträge.

reports

SEARCH_AUTH_TYPE

Gibt an, welche Authentifizierungsmethode für Solr verwendet werden soll. Hier sind folgende Werte möglich:

  • None: Keine Authentifizierung

  • Basic: Eine HTTP-Basic Authentifizierung

None

SEARCH_AUTH_BASIC_USER

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier der Benutzername für die Authentifizierung eingetragen.

 

SEARCH_AUTH_BASIC_PASS

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier das Password für die Authentifizierung eingetragen.

 

Lokale Konfigurationsdatei

Report Service 2 active

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DEFAULT_PORT

Port, auf dem der Report-Service laufen soll

30011

DB_HOST

Angabe des Hostname des PostgreSQL Servers

localhost

DB_PORT

Angabe des Ports vom PostgreSQL Server

5432

DB_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DB_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest

UTF8

DEFAULT_DB

Der Datenbank-Name, unter dem die Daten für den Object Storage abgelegt werden

io-process-service

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzer der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AMQP_REPORTS_EXCHANGE

Name des Exchange, der für das Empfangen von Reports verwendet werden soll.

process.reports

AMQP_REPORTS_QUEUE

Name der Queue, die für das Empfangen von Reports verwendet werden soll.

rps.reports

LOG_FILES

Angabe, in welchem Verzeichnis das Logfile vom Service gespeichert werden soll.

<APPDIR>\logfiles\log-report-service-.txt

SEARCH_HOST

Angabe des Hostname des Suchdienstes.

localhost

SEARCH_PORT

Angabe des Ports, auf dem der Suchdienst erreichbar sein soll.

8983

SEARCH_CORE

Angabe der Bezeichnung für die Suchindex Datenbank für Reporteinträge.

reports

SEARCH_AUTH_TYPE

Gibt an, welche Authentifizierungsmethode für Solr verwendet werden soll. Hier sind folgende Werte möglich:

  • None: Keine Authentifizierung

  • Basic: Eine HTTP-Basic Authentifizierung

None

SEARCH_AUTH_BASIC_USER

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier der Benutzername für die Authentifizierung eingetragen.

 

SEARCH_AUTH_BASIC_PASS

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier das Password für die Authentifizierung eingetragen.

 

Lokale Konfigurationsdatei

Client Service

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DB_HOST

Angabe des Datenbankservers

localhost

DB_PORT

Angabe des Port des Datenbankservers

5432

DB_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DB_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest.

UTF8

DEFAULT_DB

Name der Datenbank-Collection für den Process-Service (Wird automatisch angelegt, wenn nicht vorhanden)

io-client-service

DEFAULT_PORT

Port, auf dem der Process-Service laufen soll

30009

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzer der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

http://localhost:30001

EXCHANGE_DOWNLOAD_LIST

Name der Queue, die für das Senden von Reports verwendet werden soll.

client.downloadlist

EXCHANGE_REPORT_MESSAGES

client.report.messages

EXCHANGE_CLIENT

Name der Queue, an die Statusinformationen gesendet werden sollen.

client.message

EXCHANGE_CLIENT_KEY

Routing Key für das Senden von Statusinformationen.

client_1

QUEUE_RPC

Name der Queue die für RPC Aufrufe verwendet/bereitgestellt werden soll.

client.rpc

MODULE_CALLBACK_URL

Öffentliche Adresse des Client-Services. Diese Adresse wird an die einzelnen Module für die Kommunikation zum Client-Service verwendet.

localhost

MODULE_CALLBACK_AMQP_SERVER

Angabe der öffentlichen Adresse des Message-Queue Servers, welche die einzelnen Module für die Kommunikation verwenden sollen.

localhost

MODULE_CALLBACK_AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

MODULE_CALLBACK_AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

Lokale Konfigurationsdatei

Project Service

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DB_HOST

Angabe des Hostname des Datenbankservers

localhost

DB_PORT

Angabe des Port des Datenbankservers

5432

DB_USER

Angabe des Benutzernamens, der für die Verbindung zum Datenbankserver verwendet werden soll.

admin

DB_PASS

Angabe des jeweiligen Passwortes für den Anwender, welches für die Verbindung zum Datenbankserver verwendet werden soll.

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest.

UTF8

DEFAULT_DB

Name der Datenbank-Collection für den Process-Service (Wird automatisch angelegt, wenn nicht vorhanden)

io-project-service

DEFAULT_PORT

Port, auf dem der Process-Service laufen soll

30003

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

http://localhost:30001

EXCHANGE_DESIGNER

Angabe, welche Message Queue Exchange für die Kommunikation mit dem Designer verwendet werden soll

designer.bus

Lokale Konfigurationsdatei

Dashboard Service obsolete

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DATABASE_SERVER

Angabe des Datenbankservers

localhost:5432

DATABASE_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest.

UTF8

DEFAULT_DB

Name der Datenbank-Collection für den Dashboard-Service (Wird automatisch angelegt, wenn nicht vorhanden)

io-dashboard-service

DEFAULT_PORT

Port auf dem der Dashboard-Service laufen soll

30007

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

http://localhost:30001

SEARCH_SERVICE_ADDRESS

Angabe der Adresse des Search-Services

http://localhost:8983

SEARCH_CORE

Angabe des Names des Suchindexes, welcher für das Dashboard verwendet werden soll.

iotcore

SEARCH_AUTH_TYPE

Gibt an, welche Authentifizierungsmethode für Solr verwendet werden soll. Hier sind folgende Werte möglich:

  • None: Keine Authentifizierung

  • Basic: Eine HTTP-Basic Authentifizierung

None

SEARCH_AUTH_BASIC_USER

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier der Benutzername für die Authentifizierung eingetragen

 

SEARCH_AUTH_BASIC_PASS

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier das Password für die Authentifizierung eingetragen

 

Lokale Konfigurationsdatei

Dashboard Service 2 active

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DEFAULT_PORT

Port, auf dem der Report-Service laufen soll

30007

DB_HOST

Angabe des Hostname des PostgreSQL Servers

localhost

DB_PORT

Angabe des Ports vom PostgreSQL Server

5432

DB_USER

Angabe des Benutzers, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DB_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am PostgreSQL Server verwendet werden soll

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest

UTF8

DEFAULT_DB

Der Datenbank-Name, unter dem die Daten für den Object Storage abgelegt werden

io-dashboard-service

LOG_FILES

Angabe, in welchem Verzeichnis das Logfile vom Service gespeichert werden soll.

<APPDIR>\logfiles\log-dashboard-service-.txt

SEARCH_HOST

Angabe des Hostname des Suchdienstes.

localhost

SEARCH_PORT

Angabe des Ports, auf dem der Suchdienst erreichbar sein soll.

8983

SEARCH_CORE

Angabe der Bezeichnung für die Suchindex Datenbank für Reporteinträge.

iotcore

SEARCH_AUTH_TYPE

Gibt an, welche Authentifizierungsmethode für Solr verwendet werden soll. Hier sind folgende Werte möglich:

  • None: Keine Authentifizierung

  • Basic: Eine HTTP-Basic Authentifizierung

None

SEARCH_AUTH_BASIC_USER

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier der Benutzername für die Authentifizierung eingetragen.

 

SEARCH_AUTH_BASIC_PASS

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier das Password für die Authentifizierung eingetragen.

 

Lokale Konfigurationsdatei

Object Storage Service

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

DB_HOST

Angabe des Hostname des Datenbankservers

localhost

DB_PORT

Angabe des Port des Datenbankservers

5432

DB_USER

Angabe des Benutzernamens, der für die Verbindung zum Datenbankserver verwendet werden soll.

admin

DB_PASS

Angabe des jeweiligen Passwortes für den Anwender, welches für die Verbindung zum Datenbankserver verwendet werden soll.

admin

DATABASE_ENCODING

Legt die Kodierung für die Datenbank fest.

UTF8

DEFAULT_DB

Der Datenbank-Name, unter dem die Daten für den Object Storage abgelegt werden

io-object-storage-service

HOST
(nicht im Setup verfügbar)

Setzt die Adresse auf die der Service hört, ist dieser Wert nicht gesetzt oder entspricht er einem leeren String, wird auf alle Interfaces gebunden.

 

DEFAULT_PORT

Port, unter dem der Installierte Object Storage läuft

30010

AUTH_HOST

Angabe des Hostname des Authentifizierungs Servers

localhost

AUTH_PORT

Angabe des Port des Authentifizierungs Servers

30001

AMQP_SERVER

Angabe des Hostname des Message-Queue Servers

localhost

AMQP_PORT

Angabe des Ports vom Message-Queue Server

5672

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server verwendet werden soll

rabbit

AMQP_PASS

Angabe des Passwortes, für den Benutzer der für die Anmeldung am Message-Queue Server verwendet werden soll

carrot

TOKEN

Master token, welcher für jede Verbindung zu den einzelnen Services verwendet werden kann. Bei bestehender Installatioin muss der vorherige Token übernommen werden.

 

SEARCH_HOST

Angabe des Hostnames für den Suchdienst

localhost

SEARCH_PORT

Angabe des Port für den Suchdienst

8983

SEARCH_CORE

Der Name des Cores, der für die Suche verwendet werden soll.

documents

SEARCH_AUTH_TYPE

Gibt an, welche Authentifizierungsmethode für Solr verwendet werden soll. Hier sind folgende Werte möglich:

  • None: Keine Authentifizierung

  • Basic: Eine HTTP-Basic Authentifizierung

None

SEARCH_AUTH_BASIC_USER

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier der Benutzername für die Authentifizierung eingetragen

 

SEARCH_AUTH_BASIC_PASS

Wenn für SEARCH_AUTH_TYPE der Wert “Basic” gesetzt ist, wird hier das Password für die Authentifizierung eingetragen

 

PROJECT_SERVICE_ADDRESS

Service, welcher genutzt wird um das Modul hochzuladen. Dieser muss während der Installation bereits gestartet sein.

 

S3_ADDRESS

Angabe des Hostnames für den S3 Storage

localhost

S3_PORT

Angabe des Ports für den S3 Storage

9000

S3_STORAGE_PATH

Pfad im laufenden Betriebssystem, unter dem die Buckets abgelegt werden

data

S3_USE_SSL

Angabe, ob SSL genutzt wird oder nicht

false

S3_ACCESS_KEY

Nutzername für den Storage Bereich

IVcGpUdPNSmsvq1rDZJx

S3_SECRET_KEY

Angabe des S3 Passworts

x1bao4fWH7Fefs0ibDXl

Machine Learning Service

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

NER_SERVICE_HOST

Setzt die Adresse unter welcher der NER-Service erreichbar ist.

localhost

NER_SERVICE_PORT

Setzt den Port unter welchem der NER-Service erreichbar ist.

8000

NER_SERVICE_TIMEOUT

Setzt die Dauer in Sekunden bis eine NER-Abfrage abgebrochen wird. Kommt es häufiger zu Timeouts, sollte dieser Wert erhöht werden.

240

NER Service

Aufrufparameter

Beschreibung

Standardwerte

Aufrufparameter

Beschreibung

Standardwerte

DOWNLOAD_MODEL

Gibt an, ob das NER-Modell heruntergeladen werden soll. Steht dieser Wert auf True und es ist bereits das aktuellste Modell installiert, wird dieser Vorgang übersprungen.

True

Web Client

Aufrufparameter

Beschreibung

Standardwert

Aufrufparameter

Beschreibung

Standardwert

ACCEPT_LICENSE_AGREEMENT

Mit 1 kann festgelegt werden, dass die Lizenzbestimmungen akzeptiert werden

0

APPDIR

Angabe des Installationsverzeichnisses

%ProgramFiles%

AMQP_SERVER

Angabe des Hostnamens, auf dem der Message-Queue Server horchen soll

localhost

AMQP_PORT

Angabe des Ports, auf dem der Message-Queue Server erreichbar sein soll

15674

AMQP_USER

Angabe des Benutzers, der für die Anmeldung am Message-Queue Server benötigt wird

rabbit

AMQP_PASS

Angabe des Passwortes für den Benutzer, der für die Anmeldung am Message-Queue Server verwendet werden muss

carrot

BASE_SERVICE_ADDRESS

Angabe der Basisadresse über den alle anderen Dienste wie Authentifizierung-, Client- und Process-Service erreichbar sind. Bei Angabe dieser Adresse müssen dann bei den anderen Diensten nur noch den Port angegeben werden.

http://localhost

AUTH_SERVICE_ADDRESS

Angabe der Adresse des Authentifizierungs-Services

:30001

CLIENT_SERVICE_ADDRESS

Angabe der Adresse des Client-Services

:30009

PROCESS_SERVICE_ADDRESS

Angabe der Adresse des Process-Services

:30003

SERVICE_POOL_NAME

 

Default

SERVICE_POOL_DESCRIPTION