abas Software AG

Ein Modul ist ein Baustein, der eine bestimmte Software auf dem System verwalten soll. Der abas Installer installiert das Modul auf dem Host und überprüft, ob die Software funktioniert und korrekt konfiguriert ist. Dazu müssen alle erforderlichen Konfigurationswerte definiert werden. Ein Modul kann auch von einem anderen Modul abhängen.

1. Übersicht

In der Version 2019r4n07 sind die Module Dashboard, Freitexteditor und Rest API integriert. Der Freitexteditor und das Dashboard sind Webanwendungen. Daher benötigen Sie einen Webserver. Zusätzlich benötigt das Dashboard noch eine Datenbank zur Speicherung der Daten. Die Benutzerauthentifizierung wird von Keycloak übernommen. Hier ist eine Anbindung des LDAPs oder ADs möglich. Außerdem wird ein Lizenzverwalter installiert. Dieser prüft, ob die Lizenzen für abas ERP und abas Dashboard gültig sind.

Die Verknüpfungen der einzelnen Module sind in der folgenden Abbildung ersichtlich:

2. BPM

Mit abas BPM modellieren und optimieren Sie Ihre Geschäftsprozesse. Die Business Process Management-Lösung bietet alle Werkzeuge, mit denen Ihre Mitarbeiter, Kunden, Lieferanten, aber auch abas ERP und weitere Systeme dauerhaft in die Gestaltung und Optimierung von Geschäftsprozessen eingebunden werden können.

Definierte Workflows und deren Aufgaben werden in den Arbeitsalltag integriert und können über Dashboards komfortabel überwacht werden. So werden Prozesse nachhaltig und lebendig in Ihrem Unternehmen etabliert.

BPM ist abhänging von den Modulen Oauth2, Client und EDP.

BPM erfordert die Installation des Moduls ESDK App.

2.1. Aufbau

bpm:
  Type: abas::bpm
  Host: main
  Properties:
    install_dir: <Installationsverzeichnis>
    user: <Installationsbenutzer>
    setup:
      project_name: <Projektname>
      version: <Versionsnummer>
      extra_hosts:
      - ip: <IP>
        hostname: <Hostname>
      engine_port: <Port für Verbindung zwischen der Engine und ERP >
      database_port: <Externer Port des Datenbank-Containers>
    license:
      license_controller: <Name des Lizenz-Controller-Moduls>
    authentication:
      oauth2: <Name des oauth2-Moduls>
      registry_credentials: <Anmeldeinformationen für registry.abas.sh>
      database_credentials: <Anmeldeinformation für das Einrichter der Datenbank>
    configuration:
      admin_user_email: <Administration-Benutzer für den Start>
      timezone: <Zeitzone>
      ui_options:
        abas_gui_embedded: <Aktivierung der Benutzeroberfläche in abas ERP>
        abas_gui: true <Aktivierung der Benutzeroberfläche ab ERP Version 2016>
        abas_gui_2016: <Aktivierung der Benutzeroberfläche bis ERP Version 2016>
        webui: <Aktivierung der Benutzeroberfläche bis Webclient Version 1>
        webclient: <Aktivierung der Benutzeroberfläche ab Webclient Version 1>
      edp_configs:
        - client: <Name des client-Moduls>
          edp: <Name des edp-Moduls>
          credentials: <Anmeldeinformationen für die Durchführung von Service-Aufgaben>
          dde_server_name: <dde_server_name>
          display_name: <Name, der in der BPM UI angezeigt wird>

# BPM erfordert die Installation der ESDK App
esdk_app:
  Type: abas::esdk_app
  Host: main
  Properties:
    installer_version: <Versionsnummer>
    registry_credentials: <Name des Credentials-Moduls>
    edp_credentials: <Name des Credentials-Moduls>
    erp: <Name des Erp-Moduls>
    client: <Name des Client-Moduls>
    client_user: <Client-Benutzer>
    skip_eapps: <Überspringer der Installation der Essentials Apps>
    app_id: wkflw

    # Für erp Version 2019r4/erp 20
    artifact_url: 'https://registry.abas.sh/artifactory/abas.maven-public/de/abas/bpm/app/abas-bpm-essentials-app/1.1.1-b910-v2019r4/abas-bpm-essentials-app-1.1.1-b910-v2019r4.jar'
    app_version: 1.1.1-b910-v2019r4

    # Für erp Version 2018r4
    # artifact_url: 'https://registry.abas.sh/artifactory/abas.maven-public/de/abas/bpm/app/abas-bpm-essentials-app/1.1.1-b910-v2018r4/abas-bpm-essentials-app-1.1.1-b910-v2018r4.jar'
    # app_version: 1.1.1-b910-v2018r4

    # Für erp Version 2017r4
    # artifact_url: 'https://registry.abas.sh/artifactory/abas.maven-public/de/abas/bpm/app/abas-bpm-essentials-app/1.1.1-b910-v2017r4/abas-bpm-essentials-app-1.1.1-b910-v2017r4.jar'
    # app_version: 1.1.1-b910-v2017r4


    # Für BPM Version 1.0.0
    # artifact_url: 'https://registry.abas.sh/artifactory/abas.maven-public/de/abas/bpm/app/abas-bpm-essentials-app/1.0.0-b464-v2018r4/abas-bpm-essentials-app-1.0.0-b464-v2018r4.jar'
    # app_version: 1.0.0-b464-v2018r4
    # app_id: wkflw

2.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modultyp

Gültiger Wert: abas::bpm

2

Host

Dependency

Name des Hosts.

Properties

1

install_dir

Text

Installationsverzeichnis von abas bpm

2

user

Text

Installationsbenutzer

Linux-Benutzer, dem die bpm-Installation gehört und der sie ausführt. Kann nach der Erstinstallation nicht aktualisiert werden.

3

setup

Map

Setup-Parameter

project_name

Text

Eindeutiger Projektname

version

Enum

Versionsnummer
Gültige Werte: 1.1.1; 1.0.0

extra_hosts

Array

Extra-Hosts-Parameter

ip

Text

IP des Hosts

hostname

Text

Name des Hosts

engine_port
(optional)

Text

Port, der eine Verbindung zwischen der Engine und dem ERP herstellt.
Standardwert: 8088

database_port
(optional)

Text

Externer Port des Datenbank-Containers. Notwendig für die Interaktion mit psql.

4

authentication

Map

Authentifizierungsparameter

oauth2

Dependency

Name des Oauth2 Moduls

registry_credentials

Credentials

Name der Anmeldedaten

database_credentials

Credentials

Verweis auf Anmeldeinformationen, die zum Einrichten der bpm postgres-Datenbank verwendet wurden.

5

configuration

Map

Konfigurationsparameter

admin_user_email

Text

Nach der automatischen Erstellung des Benutzers erhält der Benutzer beim ersten Anmelden Administratorrechte.

timezone

Text

Zeitzone
Standardwert: UTC

ui_options

Map

UI-Options-Parameter

Aktivierung der abas-ERP-Benutzeroberfläche, die zur Bearbeitung von abas Aufgaben verwendet werden sollen.

abas_gui_embedded

Boolean

abas BPM UI integriert in der abas GUI in Chromium

abas_gui_2016

Boolean

abas GUI bis Version 2016

abas_gui

Boolean

abas GUI ab Version 2016

webui

Boolean

Webclient bis Version 1

webclient

Boolean

Webclient ab Version 1

edp_configs

Array

EDP-Verbindungsparameter

client

Dependency

Name des Moduls Client

display_name

Text

Name, der in der BPM UI angezeigt wird

edp

Dependency

Name des Moduls EDP

credentials

Credentials

Anmeldeinformationen für die Durchführung von Service-Aufgaben

dde_server_name

Text

DDE-Servername.
Zuerst die abas ERP Einstellung öffnen, dann die Externe Schnittstellen anklicken und den Namen des 2.DDE-Servers kopieren.

rest_api_id

Text

Rest-API-Setup, wird in der Webclient-URL für den Mandanten verwendet.

edp_log_enabled
(optional)

Boolean

Aktivierung des EDP Logs. Diese wird hier gespeichert: /var/lib/docker/containers/[container-id]/[container-id]-json.log

edp_lock_wait_duration
(optional)

Simple

Definition der Anzahl der Sekunden, die die EDP-Ausführung bei Service-Aufgabe auf Sperren wartet.
Standardwert: 240

edp_end_session_mode
(optional)

Enum

Definiert, wie edp seine Verbindung schließt.
Gültige Werte: HOLD, PAUSE, DISCONNECT
Standardwert: HOLD

smtp
(optional)

Map

SMTP-E-Mail-Einstellungen, um E-Mails mit abas BPM senden zu können

host

Text

Host

port

Text

Port

user

Text

Benutzer

password

Text

Passwort

tls_enabled

Boolean

TLS aktiviert

auth

Boolean

Authentifizierung

from

Text

Absender

business_hours
(optional)

Map

Geschäftszeiten-Parameter, die die Berechnung von Timern und Fälligkeitsterminen beeinflussen

monday

Text

Zeit für Montag

tuesday

Text

Zeit für Dienstag

wednesday

Text

Zeit für Mittwoch

thursday

Text

Zeit für Donnerstag

friday

Text

Zeit für Freitag

saturday

Text

Zeit für Samstag

sunday

Text

Zeit für Sonntag

6

license

Map

Lizenzparameter

license_controller

Dependency

Name des License Controller Moduls

3. Client

Dieses Modul beschreibt den Client (auch bekannt als Mandant). Momentan kann damit kein Client installiert werden.

3.1. Aufbau

client:
  Type: abas::client
  Host: <Name des host>
  Properties:
    mname: <Name des Mandants>
    suffix_mandantdir: <Verzeichnis des Mandants>
    create_mode: <Erstellungsmodus>
    erp: <Name des ERP-Moduls>
    mandant: <Mandant>

3.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::client

2

Host

Dependency

Name des Hosts.

Properties

1

mname

Text

Name des Mandanten

Steht im mandantdir.env unter BEGIN und END.

2

suffix_mandantdir

Text

Name des Client-Verzeichnisses

Steht im mandantdir.env unter SUFFIX_MANDANTDIR.

3

create_mode

Enum

Erstellungsmodus

Bestimmung des ursprünglichen Inhalts des Mandants.

Gültige Werte: INIT, EMPTY

4

erp

Dependency

ERP

Name des ERP Moduls.

5

mandant

Text

Mandant

Steht im mandantdir.env unter MANDANT.
Erscheint z. B. in der Statusleiste der nativen UI.

6

base_mandantdir
(optional)

Text

Name des Basis-Verzeichnisses

Standard: homebase-Wert des ERP Moduls.
Kann NICHT während der Installation verwendet werden.

4. Client Config

Dieses Modul konfiguriert einen Client (auch bekannt als Mandant). Es erstellt die config-Datei (.server.conf) im Mandant. Dadurch weiß der Mandant, wie er auf den Lizenzserver zugreifen kann.

Ist abhänging von den Modulen Client, ERP, License Controller und Jwt Auth Userinfo.

4.1. Aufbau

clientConfiguration:
  Type: abas::client_configuration
  Host: <Name des host>
  Properties:
    jwt_auth_userinfo: <Name des jwt_auth_userinfo>
    erp: <Name des ERP-Moduls>
    client: <Name des client-Moduls>
    license_controller: <Name des license_controller-Moduls>

4.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::client_configuration

2

Host

Dependency

Name des Hosts.

Properties

1

erp

Dependency

Name des ERP Moduls.

2

client

Dependency

Name des Client Moduls.

3

license_controller

Dependency

Name des License Controller Moduls.

4

jwt_auth_userinfo

Dependency

Name des Jwt Auth Userinfo Moduls.

5. Dashboard

Das abas Dashboard ist ein persönliches Cockpit, mit dem Sie schnell auf Informationen und Anwendungen zugreifen können, die Sie für Ihre tägliche Arbeit benötigen. Es handelt sich um eine moderne, personalisierte Übersicht, die perfekt mit dem Webclient harmoniert, aber auch in die Windows-Benutzeroberfläche integriert werden kann.

Ist abhänging von den Modulen Mongo DB und Oauth2.

5.1. Aufbau

dashboard:
  Type: abas::dashboard
  Host: <Name des host>
  Version: <Versionsnummer>
  Properties:
    install_dir: <Installationsverzeichnis>
    user: <Benutzername>
    dashboard_api_port: <Port>
    registry_credentials: <Name des Credentials-Moduls>
    mongodb: <Name des mongodb-Moduls>
    oauth2: <Name des oauth2-Moduls>
    mongodb_dashboard_credentials: <Name des Credentials für die mongodb>

5.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::dashboard

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer für abas dashboard
Gültige Werte: 1.0.0

Properties

1

install_dir

Text

Installationsverzeichnis

2

user

Text

Benutzer, der die Installation ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe Docker gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. root ist in diesem Feld ist ebenfalls ein gültiger Wert.

3

dashboard_api_port

Text

Der HTTP-Port, mit dem die Dashboard-API kommuniziert.

Standardwert: 12345

4

registry_credentials

Credentials

Name der Anmeldedaten.

5

mongodb

Dependency

Name des Mongo DB Moduls.

6

oauth2

Dependency

Name des Oauth2 Moduls.

7

mongodb_dashboard_credentials

Credentials

Verweis auf den Abschnitt Anmeldeinformationen, der das Benutzername-Kennwort für Ihren Mongodb-Dashboard-Benutzer enthält.

8

context_path
(optional)

Text

Verzeichnis für Dashboard-Dateien. Der URL-Unterkontext zum Aufrufen von abas Dashboard im Browser. Es muss im Ordner public_html liegen.

Standardwert: Dashboard

6. EDP

Dieses Modul beschreibt die EDP-Verbindung. Momentan kann damit keine EDP-Verbindung installiert werden.

6.1. Aufbau

edp:
  Type: abas::edp
  Host: <Name des host>
  Properties:
    erp: <Name des ERP-Moduls>
    port: <edp-Port>
    service_name: edp

6.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::edp

2

Host

Dependency

Name des Hosts.

Properties

1

erp

Dependency

Name des ERP Moduls.

2

port
(optional)

Simple

Port
Standardwert: 6550

4

service_name
(optional)

Simple

Name der Servicedatei, die für den EDP-Service zuständig ist.

3

servicefile_path
(optional)

Enum

Verzeichnis der Servicedatei.
Diese ist NICHT änderbar!

Gültiger Wert: /etc/xinetd.d/

7. ERP

Dieses Modul beschreibt die ERP-Installation. Momentan kann damit kein ERP installiert werden.

7.1. Aufbau

erp:
  Type: abas::erp
  Host: <Name des host>
  Properties:
    homedir: <Home-Verzeichnis>
    datmod_homedir: <datmod-Verzeichnis>
    datmod_servicefile_basename: datmod
    javapath: <Java-Verzeichnis>
    dirname_s3: <s3-Verzeichnis>
    dirname_nobackup: <NOBACKUP-Verzeichnis>
    username_help: <help-Benutzer>
    group_name: <Gruppenname-erp-Benutzer>
    group_number: <Gruppennummer-erp-Benutzer>
    datmod_port: <Port-datmod-Service>
    abasmountdir: <Mount-Verzeichnis>
    version: <ERP-Version>
    edp: edp
    ssh_port: <SSH-Port>
    s3_user: <s3-Benutzername>
    registry_credentials: registry_credentials

7.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::erp

2

Host

Dependency

Name des Hosts.

Properties

1

homedir

Simple

Home-Verzeichnis

Überprüfung der ERP-Installation und Zugriff auf weitere Informationen.

2

datmod_homedir

Simple

Homedir des datmod-Dienstes. Es kann von mehreren Installationen verwendet werden. Kann NICHT während der Installation verwendet werden.

3

datmod_servicefile_basename

Text

Name der Servicedatei, wird verwendet, um den Namen der Servicedatei zu bestimmen.

Standardwert: datmod

4

javapath

Simple

Der Pfad zu Java, der für die ERP-Installation verwendet wird.

6

abasmountdir

Text

Der Pfad des Mandanten, auf dem ERP installiert ist.

7

version

Simple

ERP-Version
Beispiel: 2018r2n06

8

registry_credentials

Credentials

Name der Anmeldedaten.

9

dirname_s3
(optional)

Simple

s3-Verzeichnis, in dem der s3-Bereich installiert wird.

Standardwert: s3

10

dirname_nobackup
(optional)

Simple

Alle Dateien, die nicht gesichert werden müssen, werden in diesem Verzeichnis gespeichert.

Standardwert: nobackup

11

username_help
(optional)

Simple

Der Benutzer, der auf das s3-Verzeichnis verweist, wird für Verwaltungszwecke benötigt, z. B. Neustart, Clientkopie usw.

Standardwert: hilfe

12

group_name
(optional)

Simple

Gruppenname für ERP-Benutzer
Die primäre Gruppe für die ERP-Benutzer wird in /etc/group erstellt.

Standardwert: abas

13

group_number
(optional)

Simple

Gruppennummer für Gruppennamen
Der Wert wird in /etc/group der Gruppe in group_name zugewiesen

Standardwert: <computed>

14

datmod_port
(optional)

Simple

Port des datmod-Dienstes
Er kann von mehreren Installationen verwendet werden.

Standardwert: 48392

15

datmod_servicefile_path
(optional)

Enum

Verzeichnis des dotmod-Dienstes
Identifiziert den Pfad zu den Servicedateien (NICHT ÄNDERBAR!).

Standardwert: /etc/xinetd.d/

16

edp
(optional)

Dependency

Name des EDP Moduls.

17

ssh_port
(optional)

Text

SSH-Port

Standardwert: 22

18

s3_user
(optional)

Text

S3-Benutzer

Standardwert: s3

19

default_passwd
(optional)

Simple

Standardkennwort für alle speziellen Benutzer (z. B. hilfe, berp, bdemo, bleer), die kein separates Home-Verzeichnis haben.

Standardwert: abas

20

archname
(optional)

Enum

Architekturname: Identifiziert die Architektur des Betriebssystems (NICHT ÄNDERBAR!).

Gültiger Wert und Standardwert: x86_64_linux

21

extra_usernames
(optional)

Simple

Hinzufügen weiterer Benutzer.
Kann verwendet werden, um kundenspezifische Benutzer zu erstellen.

8. ESDK App

abas Essentials SDK ist ein Anpassungstool für die einfache Entwicklung und Bereitstellung von Anpassungsprojekten für abas ERP.

Ein abas ERP-Anpassungsprojekt kann aus vielen verschiedenen Komponenten bestehen. Neben der Anwendungslogik sind weitere Komponenten wie z. B. folgende möglich:

  • Infosysteme

  • zusätzliche Variablentabellen

  • zusätzliche Variablen in Standarddatenbanken

  • benutzerdefinierte Masken

  • Aufzählungen

  • Schlüssel

  • Datenobjekte

Ein mit dem abas Essentials SDK entwickeltes Anpassungsprojekt für abas ERP erstellt eine abas App, die aus allen oben genannten Komponenten besteht und auf jedem abas ERP-Client installiert werden kann. Es enthält das ESDK Gradle Plugin als Entwicklungstool und ESDK App Installer als Bereitstellungstool für eine ESDK App.

8.1. Aufbau

esdk_app:
  Type: abas::esdk_app
  Host: main
  Properties:
    installer_version: <Versionsnummer>
    registry_credentials: <Name des Credentials-Moduls>
    edp_credentials: <Name des Credentials-Moduls>
    erp: <Name des Erp-Moduls>
    client: <Name des Client-Moduls>
    client_user: <Client-Benutzer>
    skip_eapps: <Überspringer der Installation der Essentials Apps>
    artifact_url: <Artifact URL>
    app_version: <App Version>
    app_id: <App ID>

8.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modultyp

Gültiger Wert: abas::esdk_app

2

Host

Dependency

Name des Hosts.

Properties

1

installer_version

Enum

Versionsnummer

Gültige Werte: 0.12.33, 0.12.24, 0.12.22, 0.12.21, 0.12.20, 0.12.10, 0.12.7

2

registry_credentials

Credentials

Name der Anmeldedaten

3

edp_credentials

Credentials

ERP Benutzeranmeldeinformationen, für die Installation der esdk-App.

Name der Anmeldedaten

4

client

Dependency

Name des Moduls Client

5

client_user

Simple

Client-Benutzer

6

skip_eapps

Boolean

Überspringen der Installation des Infosystems ESSENTIALSAPPS.

7

artifact_url

Simple

Artifact-URL

8

app_version

Simple

App Version

9

app_id

Simple

App ID

10

erp

Dependency

Name des Moduls [Erp]

11

timeout
(optional)

Simple

Das Zeitlimit für Vorgänge auf dem ERP-Server in Sekunden.

Standardwert: 300

12

s3lock
(optional)

Boolean

Setzen der env-Variable trotz_s3lock, bevor die Installation gestartet wird.

Gültige Werte: true (trotz_s3lock=1) oder false (trotz_s3lock=0)

13

force
(optional)

Boolean

Erzwingt die Installation einer bestimmten ESDK-App, auch wenn dieselbe oder eine höhere Version bereits installiert ist.

14

skip_essentials_versioncheck
(optional)

Boolean

Überspringen der Prüfung, ob das ESDK-App-Installationsprogramm und die zu installierende App mit der Zielversion von abas Essentials kompatibel sind.

15

eapps_only
(optional)

Boolean

Installieren nur das Infosystem ESSENTIALSAPPS. Es wird keine andere ESDK-App installiert.

9. Freetexteditor

Installation eines abas Freitexteditors zur Bearbeitung von Textfeldern der abas Maske.

9.1. Aufbau

freetexteditor:
    Type: abas::freetexteditor
    Host: <Name vom Host>
    Properties:
        ui_version: <Versionsnummer>

9.2. Properties

Name Typ Bedeutung

1

Type

Identifier

Modul-Typ

Gültiger Wert: abas::freetexteditor

2

Host

Dependency

Name des Hosts.

Properties

1

ui_version

Text

Gültiger Wert: 1.0.0

2

context_path
(optional)

Text

URL-Unterkontext zum Aufrufen des Freetexteditors im Browser

Standardwert: freetexteditor

Mit diesem Modul wird die Volltextsuche im abas ERP installiert.

10.1. Aufbau

fulltext_search:
  Type: abas::fulltext_search
  Host: main
  Properties:
    install_dir: <Installationsverzeichnis>
    client: <Mandantname>
    search_engine_port: <Portnummer>
    version: <versionsnummer>

10.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::fulltext_search

2

Host

Dependency

Name des Hosts.

Properties

1

install_dir

Identifier

Verzeichnis, in dem die Volltextsuche installiert werden soll

Standardwert: /opt/fulltext_search

2

client

Dependency

Name des Client Moduls

3

search_engine_port

Integer

Jetty-Server Port auf dem Zielsystem

Standardwert: 11666

4

version

Text

Die Version der Volltextsuchmaschine. Wenn Sie die Volltextsuche im On-Premise-Szenario ausgeführtt wird, ist dieser Parameter erforderlich.

11. Jwt Auth Userinfo

Das JSON Web Token (kurz JWT) ist für die Authentifizierung bei Single Sign-on (SSO) zuständig. Dadurch muss der Benutzer Credentials nur an einer zentralen Stelle eingeben und nicht bei jeder UI. Dieses Modul ist verantworlich für die Durchführung einer JWT-Token-Validierung für die Verwendung für andere Module.

11.1. Aufbau

jwt_auth_userinfo:
    Type: abas::jwt_auth_userinfo
    Host: <Name vom Host>
    Version: <Versionsnummer>
    Properties:
      install_dir: <Installationsverzeichnis>
      user: <Benutzer>
      port: <Portnummer>
      oauth2: <Name des oauth2-Moduls>
      rest_api: <Name des Rest API-Moduls>
      authentication:
        erp_credentials: <ERP Anmeldeinformation>
        registry_credentials: registry_credentials
      erp_permissions: <ERP Berechtigung>
      erp_workspaces: <ERP Workspace>
      tenant_identity: <Name des Tenant Identity-Moduls>

11.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::jwt_auth_userinfo

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer vom Modul jwt_auth_userinfo

Gültiger Wert: 1.1212

Properties

1

install_dir

Text

Installationsverzeichnis

2

user

Text

Benutzer, der die Installation ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe Docker gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. root ist in diesem Feld ebenfalls ein gültiger Wert.

3

port

Simple

Portnummer für den Container jwt_auth_userinfo

Standardwert: 19950

4

oauth2

Dependency

Name des Oauth2 Moduls

5

rest_api

Dependency

Name des Rest Api Moduls

6

authentication

Map

Authentifizierungsparameter

registry_credentials

Credentials

Verweis auf Anmeldeinformationen für registry.abas.sh

erp_credentials

Credentials

Verweis auf den Abschnitt Anmeldeinformationen an, der das Benutzername-Passwort für Ihren ERP-Benutzer enthält

7

erp_permissions

Simple

ERP-Berechtigungen, die für den Benutzer im Feld "Rechte oder Erlaubnisse" verwendet werden

8

erp_workspaces

Simple

ERP-Arbeitsbereich, der für den Benutzer im Feld "arbber" verwendet wird

9

tenant_identity
(optional)

Dependency

Name des Tenant Identity Moduls

10

project_name
(optional)

Text

Name des Projekts.
Er identifiziert das resultierende Docker-Compose-Projekt. Dieser Name muss auf einem Host eindeutig sein.

Standardwert: jwt_auth_userinfo

11

user_sync_mode
(optional)

Enum

Benutzer Synchronisation, vom Cloud Connect

Gültige Werte: update-only, full

Standardwert: full

12

loglevel
(optional)

Enum

Ausführlichkeitsstufe der Dienstprotokolle

Gültige Werte: trace, debug, info, warn, warning, error

Standardwert: info

13

no_proxy
(optional)

Simple

Keine Verwendung des PROXY’s

12. Keycloak

Keycloak ist ein Open Source-Projekt von Redhat, das von jeder Anwendung als Identitätsanbieter verwendet werden kann. Es dient der Benutzerauthentifizierung und -autorisierung unter Verwendung der Standards OAuth2.0 und Open Connect 1.0.

12.1. Aufbau

keycloak:
    Type: abas::keycloak
    Host: <Name vom Host>
    Version: <Versionsnummer>
    Properties:
      install_dir: <Installationsverzeichnis>
      user: <Benutzer>
      project_name: <Projektname>
      http_port: <Server-HTTP-Port>
      https_port: <Server-HTTPS-Port>
      keycloak_admin_credentials: <Anmeldeinformationen für den Admin>
      keycloak_db_credentials: <Anmeldeinformationen für die Datenbank>
      webserver_base_url: webserver.webserver_base_url
      tenant_identity: <Name des Tenant Identity-Moduls>
      secure_mode: false
      management_http_port: <Keycloak-management-HTTP-Port>
      authentication:
        registry_credentials: registry_credentials

12.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::keycloak

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 1.4

Properties

1

install_dir

Text

Installationsverzeichnis

2

user

Text

Benutzer, der die Installation ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe "Docker" gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. root ist in diesem Feld ebenfalls ein gültiger Wert.

3

project_name

Text

Projektname

4

http_port

Text

Dieser Server-HTTP-Port wird von den [Clients] verwendet, um über HTTP auf den Authentifizierungsserver zuzugreifen. Er muss ein verfügbarer Port auf dem Zielsystem sein.

Standardwert: 8087

5

https_port

Text

Dieser Server-HTTPS-Port wird von den [Clients] verwendet, um über HTTPS auf den Authentifizierungsserver zuzugreifen. Er muss ein verfügbarer Port auf dem Zielsystem sein.

Standardwert: 5443

6

keycloak_admin_credentials

Credentials

Anmeldeinformationen für den Admin. Wenn eine neue Kopie von Keycloak installiert wird, sind dies der Administrator-Benutzername und das Kennwort, die für den Master-Bereich festgelegt wurden.
Wenn Sie eine vorhandene Installation konfigurieren, ist dies das Benutzername-Passwort eines Administrators, der über die Rollen und Rechte zum Erstellen von Realms und Clients verfügt.

7

keycloak_db_credentials

Credentials

Anmeldeinformationen für die Datenbank. Wenn eine neue Kopie von Keycloak installiert wird, werden der Benutzername und das Kennwort für die Keycloak-Datenbank (PostgresSQL) festgelegt.
Wenn Sie eine vorhandene Installation konfigurieren, sollten Sie das in der vorherigen Installation verwendete Benutzername-Passwort verwenden.

8

webserver_base_url

Reference

URL des Webserver Moduls

Gültiger Wert: <Webserver-Modul-Name>.webserver_base_url

9

tenant_identity

Dependency

URL des Tenant Identity Moduls

10

secure_mode

Boolean

Art der Verwendung des Ports für andere Module

Wenn true festgelegt ist, greifen die Module, die als Identitätsanbieter auf Keycloak basieren, über HTTPs auf Keycloak zu, andernfalls wird HTTP verwendet. HTTP für Keycloak ist weiterhin konfiguriert und vorhanden, daher müssen Sie weiterhin den HTTPs-Port angeben.

11

authentication

Map

Authentifizierungsparameter

registry_credentials

Credentials

Name der Anmeldedaten

12

project_name
(optional)

Text

Er identifiziert das resultierende Docker-Compose-Projekt. Dieser Name muss auf einem Host eindeutig sein.

Standardwert: jwt_auth_userinfo

13

container_name
(optional)

Text

Name des Docker Containers. Containernamen müssen im Docker-Netzwerk eindeutig sein.

Standardwert: keycloak

14

master_realm
(optional)

Text

Name des Master-Realm wird für die Anmeldung bei Keycloak und die Erstellung der abas-Realms verwendet.

Standardwert: master

15

realm
(optional)

Text

Name des abas-Realm

Standardwert: abas

16

overwrite_realm
(optional)

Boolean

Dieses Flag steuert, ob Keycloak den Realm mit dem angegebenen Parameter "Realm"-Namen erstellt. Oder ob alternativ die Relam-Erstellung übersprungen und ein vorhandener Realm mit dem angegebenen Namen für Client-Konfigurationen und anderen Realm-Einstellungen wiederverwendet wird.

Standardwert: false

17

management_http_port
(optional)

Text

Der Wildfly Application Server-Verwaltungskonsolenport, über den auf die Verwaltungskonsole des Wildfly Application Servers zugegriffen werden kann. Wenn der Port 9990 ist, kann dies die Form http://<Ziel-Hostname>:9990/console/index.html haben.

18

keycloak_loglevel
(optional)

Enum

Ausführlichkeitsstufe der Keycloak-Protokolle

Gültige Werte: ALL, DEBUG, ERROR, FATAL, INFO, TRACE, WARN, false

Standardwert: INFO

19

root_loglevel
(optional)

Enum

Ausführlichkeitsstufe der Root-Protokolle

Gültige Werte: ALL, DEBUG, ERROR, FATAL, INFO, TRACE, WARN, false

Standardwert: INFO

20

certificate_subject
(optional)

Text

Erstellung der Betrefffelder für das Zertifikat

Mit diesem Feld können Sie die Felder im Zertifikat festlegen, die mit dem von der Installation verwendeten Befehl openssl generiert wurden. Der Wert muss wie folgt formatiert sein: / type0 = value0 / type1 = value1 / type2 =…, Zeichen dürfen durch \ (Backslash) maskiert werden, Leerzeichen werden nicht übersprungen. Die Typen können im Befehl openssl für das Flag -subj des CSR nachgeschlagen werden. Eine Beispielzeichenfolge sieht folgendermaßen aus: / C = DE / ST = BW / L = Karlsruhe / O = abas / OU = IT wobei / C = Land , / ST = Status, / L = Standort, / O = Organisation, / OU = Organisationseinheit Fügen Sie NICHT das Feld / CN = Common Name hinzu. Dies wird automatisch an die Zeichenfolge angehängt, die dem Hostnamen des Computers entspricht, auf dem der Schlüssel installiert wird.

13. License Controller

Überprüfen der Lizenzen von abas ERP und abas Dashboard auf Gültigkeit.

13.1. Aufbau

license_controller:
    Host: main
    Type: abas::license_controller
    Version: <Versionsnummer>
    Properties:
      install_dir: <Installationsverzeichnis>
      user: <Benutzer>
      port: <Port>
      tenant_identity: <Name des Tenant Identity-Moduls>
      authentication:
        registry_credentials: registry_credentials

13.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::license_controller

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 1.390

Properties

1

install_dir

Text

Installationsverzeichnis

2

port
(optional)

Simple

Port

Standardwert: 8911

3

user

Text

Benutzer, der die Installation ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe Docker gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. root ist in diesem Feld ebenfalls ein gültiger Wert.

4

tenant_identity

Dependency

Name des Moduls Tenant Identity

5

authentication

Map

Authentifizierungsparameter

registry_credentials

Credentials

Name der Anmeldedaten

6

stage
(optional)

Text

Nur auf Anweisungen des abas-Mitarbeiters zum Test wechseln

Standardwert: prod

7

docker_image_tag
(optional)

Text

Docker Image Tag

14. Mongo DB

MongoDB ist eine NoSQL-Datenbank von MongoDB Inc. Diese Datenbank wird vom Dashboard-Modul verwendet.

14.1. Aufbau

mongodb:
  Type: abas::mongodb
  Host: main
  Version: <Versionsnummer>
  Properties:
    install_dir: <Installationsverzeichnis>
    user: abas-mongodb
    mongodb_admin_credentials: mongodb_admin_credentials
    mongo_db_port: 27017
    databases:
      dashboard:
        credentials: mongodb_dashboard_credentials
    authentication:
      registry_credentials: private_read

14.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::mongodb

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 1.4

Properties

1

install_dir

Identifier

Das Installationsverzeichnis, unter dem die Datenbank Mongodb installiert wird.

2

user

Text

Benutzer, dem die Mongodb-Installation gehört und der sie ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe Docker gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. Der Benutzer root in diesem Feld ist ebenfalls ein gültiger Wert.

3

mongodb_admin_credentials

Credentials

Dies ist der Verweis auf den Abschnitt Anmeldeinformationen, der das Benutzername-Passwort für Ihren Mongodb-Administrator enthält.

4

mongo_db_port

Text

Der Port wird von Clients verwendet, um die Mongodb zu erreichen.

Standardwert: 27017

5

databases

Map

Datenbankparameter

Zuordnung aller Datenbanken, die das Modul erstellt. Dabei wird der Verweis auf den Abschnitt Anmeldeinformationen berücksichtigt. In diesem Abschnitt ist das für eine bestimmte Datenbank festzulegende Benutzername-Kennwort hinterlegt.

dashboard

Map

Dieser Schlüssel wird als Datenbankname verwendet. Der Wert ist die Referenz für die Anmeldeinformationen dieser Datenbank.

credentials

Credentials

Dies ist der Verweis auf den Abschnitt Anmeldeinformationen, der das Benutzername-Kennwort für Ihren Mongodb-Benutzer enthält, der Lese- und Schreibzugriff auf die verschlüsselte Datenbank hat.

user_prefs

Map

Dieser Schlüssel wird als Datenbankname verwendet. Der Wert ist die Referenz für die Anmeldeinformationen dieser Datenbank.

credentials

Credentials

Dies ist der Verweis auf den Abschnitt Anmeldeinformationen, der das Benutzername-Kennwort für Ihren Mongodb-Benutzer enthält, der Lese- und Schreibzugriff auf die verschlüsselte Datenbank hat.

6

authentication

Map

Authentifizierungsparameter

registry_credentials

Credentials

Name der Anmeldedaten

7

project_name
(optional)

Identifier

Ein Name, der ein abas mongodb-Setup identifiziert. Muss eindeutig sein, wenn mehrere Mongodb-Setups auf demselben Host vorhanden sein sollen. Der Parameter Projektname bestimmt einen Teil des Containernamens über die Umgebungsvariable COMPOSE_PROJECT_NAME.

8

mongo_express_port
(optional)

Text

Auf den Port auf dem Host, auf den der Mongo Express Management-Webclient zugreifen kann, kann der Browser zugreifen. Dies muss unabhängig vom Parameterwert install_mongoexpress angegeben werden.

15. Oauth2

OAuth2 ist ein Switcher-Modul, mit dem die Installation zwischen Auth0-Authentifizierung und Keycloak-Authentifizierung umgeschaltet werden kann. Für den Cloud-Fall müssen Sie dieses Modul an Auth0 weiterleiten. Im Falle einer On-Premise-Lösung müssen Sie dieses Modul an Keycloak weiterleiten.

Dieses Modul liefert Proxy-Werte für alle anderen Module. So wird die Identifikation des verwendeten Szenarios sichergestellt: Cloud oder On-Premise.

Mit diesem Abstraktionsmodul können Installation und Module nahtlos zwischen den beiden Szenarien wechseln.

15.1. Aufbau

So kann eine minimale abasfile.yaml-Definition für eine On-Premise-Lösung aussehen:

oauth2:
  Type: abas::oauth2
  Host: main
  Properties:
    name: oauth2
    type: keycloak
    keycloak: keycloak

So kann eine minimale abasfile.yaml-Definition für die Auth0-Lösung aussehen:

oauth2:
  Type: abas::oauth2
  Host: main
  Properties:
    name: auth0-type
    auth0: auth0
    type: auth0

15.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::oauth2

2

Host

Dependency

Name des Hosts.

Properties

1

name

Identifier

Dies ist eine Freitextzeichenfolge, die jedoch idealerweise den hier ausgewählten Szenariotyp widerspiegeln sollte. Zum Beispiel keycloak-type für die On-Premise-Installationsvariante und auth0-type für die Cloud-Installationsvariante.

2

type

Enum

Der Wert dieses Parameters entscheidet, ob eine Cloud-Installation oder eine lokale Installation durchgeführt wird. Dieser Parameter hat nur 2 mögliche Werte:
- keycloak (On-Premise)
- auth0 (Hybrid)

3

keycloak (required/optional)

Dependency

Der Name des Keycloak-Moduls in der abasfile.yml. Diese Referenz wird verwendet, um alle Authentifizierungsinformationen abzurufen, die das Keycloak-Modul bietet. Diese Informationen werden an alle Module weitergeleitet, die diese benötigen.

4

auth0 (required/optional)

Dependency

Der Name des Oauth2-Moduls in der Datei abasfile.yml. Diese Referenz wird verwendet, um alle Authentifizierungsinformationen abzurufen, die das auth0-Modul bietet. Diese Informationen werden an alle Module weitergeleitet, die diese benötigen.

16. Online Help

Dieses Modul lädt die Onlinehilfedateien von einem ERP-Host herunter und platziert sie im Unterverzeichnis des Webroots vom Webserver. Darüber hinaus wird der Webserver so konfiguriert, dass die Hilfedateianforderung an das Assets-Verzeichnis weitergeleitet wird.

16.1. Aufbau

online-help:
  Type: abas::online_help
  Host: main
  Properties:
    install_dir: <Installationsverzeichnis>
    webserver: webserver
    erp: erp
    erp_credentials: abasmanage-erp

16.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::online_help

2

Host

Dependency

Name des Hosts.

Properties

1

install_dir

Identifier

Das Modul-Installationsverzeichnis, in das die Download-Skripte der Onlinehilfe gestellt werden.

2

webserver

Dependency

Der Webserver, auf dem die Onlineilfe gehostet wird. Dies ist der Verweis auf den Abschnitt mit den Anmeldeinformationen, der das Benutzername-Passwort des ERP-Superusers enthält.

3

erp

Dependency

Der ERP-Host, der die Onlinehilfedateien enthält.

4

erp_credentials

Credentials

ERP-Superuser-Anmeldeinformationen. Dies ist der Verweis auf den Abschnitt mit den Anmeldeinformationen, der das Benutzername-Passwort des ERP-Superusers enthält.

17. Rest Api

17.1. Aufbau

rest_api:
    Host: <Name vom Host>
    Type: abas::rest_api
    Version: <Versionsnummer>
    Properties:
      install_dir: <Installationsverzeichnis>
      user: abas-rest-api
      port: <Portnummer>
      oauth2: oauth2
      enable_web_sockets: true
      loglevel_de_abas_mw_edp: DEBUG
      clients:
          edp: edp
          client: sabamasterfile
      authentication:
        registry_credentials: private_read

17.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::rest_api

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 0.94.0

Properties

1

install_dir

Text

Verzeichnis, in dem die abas Rest API installiert werden soll

2

user

Text

Ein Linux-Benutzer, dem die Rest API Installation gehört.

Standardwert: abas-rest-api

3

port

Simple

Port, unter dem die Rest API Anwendung läuft.

Standardwert: 8920

4

oauth2

Dependency

Die abas Rest API unterstützt die JWT Validierung. Der Oauth2-Server stellt die öffentlichen Schlüssel über eine JSON Web Token Set-URL bereit.

5

enable_web_sockets

Boolean

Die abas Rest-API unterstützt einen Web-Socket-Endpunkt, um das EDV-Protokoll direkt zu verwenden. Dies befindet sich derzeit in der Testphase und wird nur von den mobilen Anwendungen über die Cloud verwendet.

6

loglevel_de_abas_mw_edp

Enum

Diese Einstellung legt die EDP-Protokollstufe fest. Der gesamte EDP-Verkehr wird auf Debug-Ebene protokolliert. Um die EDP-Protokollierung global zu aktivieren, setzen Sie diese Eigenschaft auf DEBUG oder TRACE. Die Protokollierung pro Anforderung erfolgt durch Setzen des HTTP-Headers x-abas-mw-edp-log-level auf die Protokollstufe INFO.

Gültige Werte: TRACE, DEBUG, INFO, WARN, ERROR

Standardwert: INFO

7

clients

Array

Die Konfiguration wird verwendet, um eine Verbindung zu einem abas ERP-Client herzustellen.

edp

Dependency

edp

client

Dependency

sabamasterfile

id

Text

Die ERP-Client-ID in der AWS-Rest-API. Wenn es nicht definiert ist, wird client.mname verwendet.

description

Text

Die Beschreibung des ERP-Clients. Wenn es nicht definiert ist, wird client.mandant verwendet.

min_pool_size

Text

Die minimale Größe des Verbindungspools (EDP-Sitzungen).

Standardwert: 1

max_pool_size

Text

Die maximale Anzahl nicht verwendeter (inaktiver) Verbindungen im Pool.

max_pool_wait

Text

Die maximale Wartezeit des Pools, bevor eine Anforderung fehlschlägt.

disable_pool

Text

Deaktiviert den Sitzungspool vollständig.

Standardwert: false

ws_timeout_minutes

Text

Die Arbeitsablaufzeit in Minuten.

Standardwert: 720

initialize_meta_data_on_startup

Text

Wenn diese Eigenschaft auf true gesetzt ist, werden die Metadaten des Clients nach dem Start der abas Rest-API abgerufen. Andernfalls wird es abgerufen, wenn die erste Anforderung erfolgt.

Standardwert: true

time_between_two_pool_controls

Text

Das Intervall in Sekunden, in dem der Pool-Controller-Thread die Anzahl der inaktiven Sitzungen überprüft.

Standardwert: 30_

max_ftext_size

Text

Das Intervall, in dem nach Änderungen in den Metadaten abgefragt wird.

Standardwert: 16384

metadata_polling_interval_in_seconds

Text

Das Intervall, in dem der Server den Client nach Metadatenänderungen abfragt.

Standardwert: 3600

edp_log_cache_size

Text

Wenn ein schwerwiegender ERP-Serverfehler auftritt, werden die letzten angebenen Zeilen (standard: 1000 Zeilen) des EDV-Protokolls geleert.

Standardwert: 1000

force_edp_client_version

Text

Das Festlegen der EDV-Client-Version ist erforderlich, wenn die JEDP-Bibliothek neuer als die ERP-Installation ist.

Standardwert: ERP-Version

8

authentication

Map

registry_credentials

Credentials

Verweis auf Anmeldeinformationen für registry.abas.sh.

9

servlet_context_path
(optional)

Text

Der abas Rest-API Servlet Context Pfad.

Standardwert: /mw

10

service_ip
(optional)

Text

Die IP, über die die abas Rest-API erreichbar ist.

Standardwert: 0.0.0.0

11

project_name
(optional)

Text

Ein Name, der das resultierende Docker-Compose-Projekt identifiziert. Dieser Name muss auf einem Host eindeutig sein.

Standardwert: rest_api

12

tenant_identity
(optional)

Dependency

Die Mandantenidentität wird für die (optionale, aber empfohlene) Zielgruppenprüfung des JWT benötigt. Sie wird nur verwendet, wenn auch die Oauth2-Abhängigkeit festgelegt ist.

13

access_log_max_history_days
(optional)

Text

Die maximale Anzahl von Tagen, an denen das Zugriffsprotokoll der abas Rest-API beibehalten wird.

Standardwert: 30

14

access_log_max_total_size
(optional)

Text

Die maximale Größe des Zugriffsprotokolls der abas Rest-API. Es muss in kb, mb oder gb (z. B. 500 MB) definiert werden.

Standardwert: 1gb

15

loglevel_de_abas_mw
(optional)

Enum

Diese Einstellung legt nur die Protokollstufe der abas Rest API-Anwendung fest.

Standardwert: INFO

16

loglevel_root
(optional)

Enum

Diese Einstellung legt die Protokollstufe vom root log level der abas Rest API-Anwendung fest.

Gültige Werte: TRACE, DEBUG, INFO, WARN, ERROR

Standardwert: INFO

17

detailed_error_messages
(optional)

Boolean

Die abas Rest API liefert detaillierte Fehlermeldungen, wenn diese Option aktiviert ist. Die Fehlermeldungen enthüllen dann möglicherweise Details des Geräts und des Setups. Dies könnte ein Sicherheitsproblem sein. Mit Vorsicht verwenden.

18

external_docker_network
(optional)

Text

Verwenden Sie diese Eigenschaft, um einem externen Docker-Netzwerk beizutreten. Das Netzwerk muss auf demselben Host vorhanden sein.

19

arguments
(optional)

Array

Wenn Sie zusätzliche Befehlszeilenargumente an das abas Rest API-Programm übergeben müssen, können Sie dies hier tun.

20

fulltext_search
(optional)

Array

Fügen Sie alle Volltextsuchkonfigurationen hinzu, die Sie der Rest-API hinzufügen möchten. Kann eine Teilmenge von Clients sein, wenn Sie nicht möchten, dass die Volltextsuche für jeden Client konfiguriert wird.

fulltext_search

dependency

abas::fulltext_search

edp

dependency

abas::edp

18. Tenant Identity

Dieses Modul ist ein Metamodul und wird von anderen Modulen benötigt.

18.1. Aufbau

tenant_identity:
  Type: abas::tenant_identity
  Host: <Name vom Host>
  Properties:
    b64_configuration_string: <b64 configuration string>

18.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::tenant_identity

2

Host

Dependency

Name des Hosts.

Properties

1

b64_configuration_string

Text

Ein base64 codierter Token, der generiert wird, wenn Sie Ihren abas Tenant erstellen

19. User Administration

Dies ist ein Metamodul, das registrierte Benutzer in Keycloak nach anderen Modulen wie Dashboard- und Webclient-Modulen abfragen kann, die diese Informationen möglicherweise benötigen.

19.1. Aufbau

user_administration:
  Host: main
  Type: abas::user_administration
  Version: <Versionsnummer>
  Properties:
    install_dir: <Installationsverzeichnis>
    user: <Benutzer>
    port: <Port>
    oauth2: oauth2
    keycloak_admin_credentials: keycloak.keycloak_admin_credentials
    authentication:
      registry_credentials: registry_credentials

19.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::user_administration

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 1.412

Properties

1

install_dir

Text

Installationsverzeichnis

2

user

Text

Benutzer, der die Administration ausführt.

3

port

Simple

Port, an dem der Administrationscontainer gestartet wird.

Standardwert: 18110

4

oauth2

Dependency

Benutzer, der im Oauth2-Server definiert sind.

5

keycloak_admin_credentials

Reference

Keycloak credentials für Administrationsbereich

6

authentication

Map

registry_credentials

Credentials

Verweis auf Anmeldeinformationen für registry.abas.sh.

7

project_name

Text

Ein Name, der das resultierende Docker-Compose-Projekt identifiziert. Dieser Name muss auf einem Host eindeutig sein.

Standardwert: user_administration

8

external_docker_network

Text

Verwenden Sie diese Eigenschaft, um einem externen Docker-Netzwerk beizutreten. Das Netzwerk muss auf demselben Host vorhanden sein.

20. WebClient

Der abas WebClient bietet ein webbasiertes Frontend für den Zugriff auf Ihre ERP-Installation und deren Steuerung.

20.1. Aufbau

webclient:
  Type: abas::webclient
  Host: main
  Properties:
    install_dir: <Installationsverzeichnis>
    registry_credentials: registry_credentials
    rest_api: rest_api
    version: <Versionsnummer>

20.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::webclient

2

Host

Dependency

Name des Hosts.

Properties

1

install_dir

Identifier

Verzeichnis, in dem abas Webclient installiert werden soll.

2

registry_credentials

Credentials

Der Pfad zu den angegebenen Anmeldeinformationen in der Datei credentials.yml

3

rest_api

Dependency

Der Name des Rest Api-Moduls in der abas-installer-Umgebung.

4

version
(optional)

Versionsnummer

Wenn Sie den Webclient im On-Premise-Szenario ausführen, ist dieser Parameter erforderlich.

21. Webserver

Das Webserver-Modul wird benötigt, wenn ein Client alle abas-browserbasierten Weblösungen intern hosten möchte. Der unterstützte Webserver ist derzeit Nginx, das mit dem abas-installer installiert wird.

21.1. Aufbau

webserver:
  Type: abas::webserver
  Host: <Name vom Host>
  Version: <Versionsnummer>
  Properties:
    install_dir: <Installationsverzeichnis>
    user: abas-webserver
    http_port: 80
    https_port: 443
    registry_credentials: private_read
    debug_mode: false
    oauth2: oauth2
    secure_mode: false
    modules_to_host:
      dashboard: dashboard
      freetexteditor: freetexteditor
      rest_api: rest_api
      user_administration: user_administration

21.2. Properties

Name Typ Bedeutung

1

Type

Modul-Typ

Gültiger Wert: abas::client

2

Host

Dependency

Name des Hosts.

3

Version

Enum

Versionsnummer

Gültiger Wert: 1.4

Properties

1

install_dir

Text

Installationsverzeichnis, in dem abas Webserver-Dateien installiert werden.

Das Installationsverzeichnis enthält Ihren Ordner public_html, mit dem Inhalt, den Ihr Webserver bereitstellt. Es enthält die Konfigurationsdateien für verschiedene Module, die der Webserver hostet. Und es kann eventuell auch einen Sicherungsordner früherer Installationen enthalten, sobald Sie ein Update des Moduls durchgeführt haben.

2

user

Text

Linux Benutzer

Benutzer, dem die Webserver-Installation gehört und der sie ausführt. Kann nach der Erstinstallation nicht aktualisiert werden. Wenn der Benutzer bereits vorhanden ist, sollte er zur Gruppe Docker gehören. Dieser Benutzer muss über Lese- und Schreibberechtigungen für das Installationsverzeichnis verfügen. Der Benutzer root in diesem Feld ist ebenfalls ein gültiger Wert.

3

http_port

Text

Der HTTP-Server-Port auf dem Zielsystem

Dieser Port wird von den Clients verwendet, um den Webserver-Server über HTTP vom Browser aus zu erreichen. Dies muss ein verfügbarer Port auf dem Zielsystem sein.

Standardwert: 8181

4

https_port

Text

Der HTTPS-Keycloak-Serverport auf dem Zielsystem

Dieser Port wird von den Clients verwendet, um den Webserver über HTTPS vom Browser aus zu erreichen. Dies muss ein verfügbarer Port auf dem Zielsystem sein.

Standardwert: 4443

5

registry_credentials

Credentials

Die Eigenschaft verweist auf den Abschnitt Anmeldeinformationen, der das Benutzername-Passwort für Ihre Anmeldung an abas enthält.

Dies ist der Verweis auf den Abschnitt Credentials, der das Benutzername-Passwort für Ihre abas-Anmeldung enthält. Dies ist erforderlich, um verschiedene freigegebene Webartefakte herunterzuladen, für deren Bereitstellung der Webserver verwendet wird.

6

modules_to_host

Map

Eine Abhängigkeitsmap von Modulreferenzen. (Dies ist ein optionaler Parameter, aber derzeit müssen Sie mindestens einen Eintrag definieren.)

Dies ist die Liste aller Module, die der Webserver für den Kunden lokal hostet oder umkehrt. Ein Reverse-Proxy ist z.B. Setup für die Rest-API, damit die Anwendungen nicht auf das CORS-Problem stoßen. Diese Map enthält eine Reihe vordefinierter Schlüssel, die nur erkannt werden. Nicht jedes in diese Liste eingegebene zufällige Modul hat eine Auswirkung. Die Liste der möglichen Schlüssel und Werte für diese Karte lautet derzeit wie folgt:

webclient

Dependency

Verweis auf die Definition des WebClient-Moduls

rest_api

Dependency

Verweis auf die Rest Api-Moduldefinition

dashboard

Dependency

Verweis auf die Definition des Dashboard-Moduls

freetexteditor

Dependency

Verweis auf die Definition des Freetexteditor-Moduls

user_administration

Dependency

Verweis auf die Definition des User Administration-Moduls

7

debug_mode
(optional)

Boolean

Aktivieren oder deaktivieren den Debug-Modus auf dem Webserver.

Wenn Sie dies auf true setzen, werden viele Webserver-Debug- und -Rewrite-Protokolldateien generiert. Es wird nicht empfohlen, dies für die Produktion einzuschalten. Sie können die Protokolle mit dem Befehl docker-compose logs anzeigen.

8

oauth2
(optional)

Dependency

Der Verweis auf die Oauth2-Moduldefinition in Ihrem abasfile.yml.

Der Verweis spezifiziert die ID dieses Oauth2-Moduls, wie es in der abasfile.yml-Datei deklariert ist.

9

secure_mode
(optional)

Boolean

Dieses Flag steuert, ob der Nginx-Server HTTPS Protokoll (tls) für die Bereitstellung von Inhalten verwendet.

10

repo_base_url
(optional)

Text

Dies ist die Basis-URL, die vom Installationsmodul über cURL zum Abrufen von UI-Assets für den Webserver verwendet wird. Für Nexus Repo ist dies folgende URL: https://registry.abas.sh/service/rest/beta/search/assets/download

Standardwert: https://artifactory.abas.sh/artifactory

11

certificate_subject
(optional)

Text

In diesem Feld werden die Betrefffelder im generierten Zertifikat festgelegt

Mit diesem Feld können Sie die Felder in dem Zertifikat festlegen, das mit dem von der Installation verwendeten Befehl openssl generiert wurde. Der Wert muss wie folgt formatiert sein: / type0 = value0 / type1 = value1 / type2 = …​, Zeichen können durch \ (Backslash) maskiert werden. Es werden keine Leerzeichen übersprungen. Die Typen können im Befehl openssl für das Flag -subj des CSR nachgeschlagen werden. Eine Beispielzeichenfolge sieht folgendermaßen aus: / C = DE / ST = BW / L = Karlsruhe / O = abas / OU = IT wobei / C = Land, / ST = Bundesland, / L = Standort, / O = Organisation, / OU = Organisationseinheit NICHT das Feld / CN = Common Name hinzufügen. Dies wird automatisch an die Zeichenfolge angehängt, die dem Hostnamen des Computers entspricht, auf dem der Webserver installiert wird.

12

project_name
(optional)

Text

Projektname

Ein Name, der ein abas Webserver-Setup identifiziert. Muss eindeutig sein, wenn mehrere Webserver-Setups auf demselben Host vorhanden sein sollen.