abas Software AG

A module is a component which is responsible for managing certain software on a system. abas Installer installs the module on the host and checks if the software works and is configured correctly. For this, all required configuration values must be defined. A module can also depend on another module.

1. Overview

In Version 2019r4n07, the modules Dashboard, freetext editor and Rest API are integrated. The free text editor and the Dashboard are web applications. Therefore, they require a web server. Additionally, the Dashboard requires a database for storing the data. User authentication takes place using Keycloak. A connection of the LDAP or AD is possible. Furthermore, a license manager is installed. It checks if the licenses for abas ERP and abas Dashboard are valid.

The following figure shows the links of the individual modules:

2. BPM

You can use abas BPM to model and optimize your business processes. The Business Process Management solution provides all tools using which employees, customers, vendors, but also abas ERP and other systems, can be permanently included in the design and optimization of business processes.

Defined workflows and their tasks are integrated into daily work routines and can be conveniently monitored via dashboards. This way you can establish sustainable, agile processes throughout your company.

BPM is dependent on the modules Oauth2, Client and EDP.

BPM requires the installation of the ESDK App module.

2.1. Structure

bpm:
  Type: abas::bpm
  Host: main
  Properties:
    install_dir: <Installation directory> user: <Installation user>
    setup:
      project_name: <Project name>
      version: <Version number>
      extra_hosts:
      - ip: <IP>
        hostname: <Hostname>
      engine_port: <Port for the connection between the engine and ERP>
      database_port: <External port of the database container>
    license:
      license_controller: <Name des Lizenz-Controller-Moduls>
    authentication:
      authentication:<Name of the Oauth2 module>
      registry_credentials: <Credentials for registry.abas.sh>
      database_credentials: <Credentials for setting up the database>
    configuration:
      admin_user_email: <Administration user for the start> timezone: <Time zone>
      ui_options:
        abas_gui_embedded: <Activation of the user interface in abas ERP>
        abas_gui: true <Activation of the user interface from ERP Version 2016>
        abas_gui_2016: <Activation of the user interface up to ERP Version 2016>
        webui: <Activation of the user interface up to Web Client Version 1>
        webclient: <Activation of the user interface from Web Client Version 1>
      edp_configs:
      - client: <Name of the Client module>
        edp: <Name of the EDP module>
        credentials: <Credentials for the performance of service tasks>
        dde_server_name: <dde_server_name>
        display_name: <Name which is displayed in the BPM UI>

# BPM requires the installation of the ESDK app.
esdk_app:
  Type: abas::esdk_app
  Host: main
  Properties:
    installer_version: <Version number>
    registry_credentials: <Name of the Credentials module>
    edp_credentials: <Name of the Credentials module>
    erp: <Name of the ERP module>
    client: <Name of the Client module>
    client_user: <Client user>
    skip_eapps: <Skipping the installation of the Essentials apps>
    app_id: wkflw

    # For erp verion 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

    # For erp verion 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

    # For erp verion 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


    # Forr 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 Type Meaning

1

Type

Identifier

Module type

Valid value: abas::bpm

2

Host

Dependency

Name of the Hosts.

Properties

1

install_dir

Text

Installation directory of abas BPM

2

user

Text

Installation user

Linux user to whom the BPM installation belongs and who performs it. Cannot be updated after initial installation.

3

setup

Map

Setup parameters

project_name

Text

Unique project name

version

Enum

Versions number
Valid value: 1.1.1; 1.0.0

extra_hosts
(optional)

Array

Extra hosts parameters

ip

Text

IP of the host

hostname

Text

Name of the host

engine_port
(optional)

Text

Port which establishes a connection between the engine and ERP.
Default value: 8088

database_port
(optional)

Text

External port of the database container. Required for interaction with psql.

4

authentication

Map

Authentication parameters

oauth2

Dependency

Name of the Oauth2 module

registry_credentials

Credentials

Name der credentials

database_credentials

Credentials

Reference to credentials which were used for setting up the bpm postgres database.

5

configuration

Map

Configuration parameters

admin_user_email

Text

After the automatic creation of the user, the user obtains administration permissions the first time they log in.

timezone

Text

Time zone
Default value: UTC

ui_options

Map

UI options parameters

Activation of the abas ERP user interface which is to be used for processing abas tasks.

abas_gui_embedded

Boolean

abas BPM UI integrated in the abas GUI in Chromium

abas_gui_2016

Boolean

abas GUI up to Version 2016

abas_gui

Boolean

abas GUI from Version 2016

webui

Boolean

Webclient up to Version 1

webclient

Boolean

Webclient from Version 1

edp_configs

Array

EDP connection parameters

client

Dependency

Name of the Client module

display_name

Text

Name which is displayed in the BPM UI

edp

Dependency

Name of the EDP module

credentials

Credentials

Credentials for the performance of service tasks.

dde_server_name

Text

DDE server name.
First open the abas ERP setting, then click on the External interfaces and copy the name of the 2.DDE client.

rest_api_id

Text

Rest API setup, used in the Web Client URL for the client.

edp_log_enabled
(optional)

Boolean

Activation of the EDP log. This is saved here: /var/lib/docker/containers/[container-id]/[container-id]-json.log

edp_lock_wait_duration
(optional)

Simple

Definition of the number of seconds the EDP processing waits for locks on service tasks.
Default value: 240

edp_end_session_mode
(optional)

Enum

Defines how EDP closes its connection.
Valid values: HOLD, PAUSE, DISCONNECT
Default value: HOLD

smtp
(optional)

Map

SMTP email settings in order to be able to send emails with abas BPM

host

Text

Host

port

Text

Port

user

Text

User

password

Text

Password

tls_enabled

Boolean

TLS activated

auth

Boolean

Authentication

from

Text

Sender

business_hours
(optional)

Map

Business hours parameters which influence the calculation of timers and due dates

monday

Text

Time for Monday

tuesday

Text

Time for Tuesday

wednesday

Text

Time for Wednesday

thursday

Text

Time for Thursday

friday

Text

Time for Friday

saturday

Text

Time for Saturday

sunday

Text

Time for Sunday

6

license

Map

License controller parameters

license_controller

Dependency

Name of the License Controller moduke

3. Client

This module describes the client. Currently, it cannot be used to install a client.

3.1. Structure

client:
  Type: abas::client
  Host: <Name des host>
  Properties:
    mname: <Name of the client>
    suffix_mandantdir: <Directory  des client>
    create_mode: <Creation mode>
    erp: <Name of the ERP module>
    mandant: <Client>

3.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::client

2

Host

Dependency

Name of the host.

Properties

1

mname

Text

Name of the client

Can be found in mandantdir.env under BEGIN and END.

2

suffix_mandantdir

Text

Name of the client directory

Can be found in mandantdir.env under SUFFIX_MANDANTDIR.

3

create_mode

Enum

Creation mode

Determining the original content of the client.

Valid values: INIT, EMPTY

4

erp

Dependency

ERP

Name of the ERP module.

5

mandant

Text

Mandant

Can be found in mandantdir.env under MANDANT.
Appears, for example, in the status bar of the native UI.

6

base_mandantdir
(optional)

Text

Name of the base directory

Default: homebase value of the ERP module.
Cannot be used during installation.

4. Client Config

This module configures a client. It creates the config file (.server.conf) in the client. In this way, the client knows how to access the license server.

It is dependent on the modules Client, ERP, License Controller and Jwt Auth Userinfo.

4.1. Structure

clientConfiguration:
  Type: abas::client_configuration
  Host: <Name of the host>
  Properties:
    jwt_auth_userinfo: <Name of the jwt_auth_userinfo>
    erp: <Name of the ERP module>>
    client: <Name of the Client module>>
    license_controller: <Name of the license_controller module>

4.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::client_configuration

2

Host

Dependency

Name of the host.

Properties

1

erp

Dependency

Name of the ERP module.

2

client

Dependency

Name of the Client module.

3

license_controller

Dependency

Name of the License Controller module.

4

jwt_auth_userinfo

Dependency

Name of the Jwt Auth Userinfo module.

5. Dashboard

The abas Dashboard is a personal cockpit using which you can quickly access information and applications required for your daily work. It is a modern, personalized overview, which works perfectly with the Web Client, but can also be integrated into the Windows user interface.

It is dependent on the modules Mongo DB and Oauth2.

5.1. Structure

dashboard:
  Type: abas::dashboard
  Host: <Name of the host>
  Version: <Version number>
  Properties:
    install_dir: <Installation directory>
    user: <User name>
    dashboard_api_port: <Port>
    registry_credentials: <Name of the Credentials module>
    mongodb: <Name of the mongodb module>
    oauth2: <Name of the Oauth2 module>
    mongodb_dashboard_credentials: <Name of the Credentials for the mongodb>

5.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::dashboard

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number of the abas dashboard
Valid values: 1.0.0

Properties

1

install_dir

Text

Installation directory

2

user

Text

User who performs the installation. Cannot be updated after initial installation. If the user is already available, they should belong to the Docker group. This user must have read and write permissions for the installation directory. root is also a valid value for this field.

3

dashboard_api_port

Text

HTTP port with which the Dashboard API communicates.

Default value: 12345

4

registry_credentials

Credentials

Name of the credentials.

5

mongodb

Dependency

Name of the Mongo DB module.

6

oauth2

Dependency

Name of the Oauth2 module.

7

mongodb_dashboard_credentials

Credentials

Reference to the Credentials section which contains the user name password for your Mongodb Dashboard user.

8

context_path
(optional)

Text

Directory for Dashboard files. The URL subcontext for calling the abas Dashboard in the browser. It must be located in the public_html folder.

Default value: Dashboard

6. EDP

This module describes the EDP connection. Currently, it cannot be used to install an EDP connection.

6.1. Structure

edp:
Type: abas::edp
Host: <Name of the host>
Properties:
  erp: <Name of the ERP module>
  port: <edp port>
  service_name: edp

6.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::edp

2

Host

Dependency

Name of the host.

Properties

1

erp

Dependency

Name of the ERP module.

2

port
(optional)

Simple

Port
Default value: 6550

4

service_name
(optional)

Simple

Name of the service file which is responsible for the EDP service.

3

servicefile_path
(optional)

Enum

Directory of the service file. It cannot be changed!

Valid value: /etc/xinetd.d/

7. ERP

This module describes the ERP installation. Currently, it cannot be used to install ERP.

7.1. Structure

erp:
  Type: abas::erp
  Host: <Name of the host>
  Properties:
    homedir: <Home directory>
    datmod_homedir: <datmod directory>
    datmod_servicefile_basename: datmod
    javapath: <Java directory>
    dirname_s3: <s3 directory>
    dirname_nobackup: <NOBACKUP directory>
    username_help: <help user>
    group_name: <erp user group name>
    group_number: <erp user group number>
    datmod_port: <datmod service port>
    abasmountdir: <Mount directory>
    version: <ERP-Version>
    edp: edp
    ssh_port: <SSH port>
    s3_user: <s3 user name>
    registry_credentials: registry_credentials

7.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::erp

2

Host

Dependency

Name of the host.

Properties

1

homedir

Simple

Home directory

Check of the ERP installation and access to further information.

2

datmod_homedir

Simple

Homedir of the datmod service. It can be used by multiple installations. Cannot be used during installation.

3

datmod_servicefile_basename

Text

Name of the service file. Used to determine the name of the service file.

Default value: datmod

4

javapath

Simple

Path to Java which is used for the ERP installation.

6

abasmountdir

Text

Path of the client in which ERP is installed.

7

version

Simple

ERP version
Example: 2018r2n06

8

registry_credentials

Credentials

Name of the credentials.

9

dirname_s3
(optional)

Simple

s3 directory in which the s3 area will be installed.

Default value: s3

10

dirname_nobackup
(optional)

Simple

All files that do not have to be backed up will be stored in this directory.

Default value: nobackup

11

username_help
(optional)

Simple

The user referring to the s3 directory is required for administrative purposes, e.g. restart, client copy, etc.

Default value: hilfe

12

group_name
(optional)

Simple

Group name for ERP users.
The primary group for the ERP users is created in /etc/group.

Default value: abas

13

group_number
(optional)

Simple

Group number for group names.
The value is assigned to the group in /etc/group.

Default value: <computed>

14

datmod_port
(optional)

Simple

Port of the datmod service.
It can be used by multiple installations.

Default value: 48392

15

datmod_servicefile_path
(optional)

Enum

Directory of the datmod service.
Identifies the path to the service files (CANNOT BE CHANGED!).

Default value: /etc/xinetd.d/

16

edp
(optional)

Dependency

Name of theEDP module.

17

ssh_port
(optional)

Text

SSH port

Default value: 22

18

s3_user
(optional)

Text

S3 user

Default value: s3

19

default_passwd
(optional)

Simple

Default password for all special users (for example, hilfe, berp, bdemo, bleer) that do not have a separate home directory.

Default value: abas

20

archname
(optional)

Enum

Architecture name: identifies the architecture of the operating system (CANNOT BE CHANGED!)

Valid value und Default value: x86_64_linux

21

extra_usernames
(optional)

Simple

Adding further users.
Can be used to create custom users.

8. ESDK App

abas Essentials SDK is a customization tool for simple development and preparation of abas ERP customization projects.

An abas ERP customization project can comprise many different components. In addition to the application logic, further components, such as the following, are possible:

  • Infosystems

  • Additional tables of variables

  • Additional variables in standard databases

  • User-defined screens

  • Enumerations

  • Keys

  • Database objects

A customization project for abas ERP, developed using abas Essentials SDK, creates an abas app which consists of all components listed above and can be installed in every abas ERP client. It contains the ESDK Gradle plugin as a development tool and ESDK App Installer as the provision tool for an ESDK app.

8.1. Structure

esdk_app:
  Type: abas::esdk_app
  Host: main
  Properties:
    installer_version: <Version nummer>
    registry_credentials: <Name of the Credentials module>
    edp_credentials: <Name of the Credentials module>
    erp: <Name of the ERP module>
    client: <Name of the Client module>
    client_user: <Client user>
    skip_eapps: <Skipping the installation of the Essentials apps>
    artifact_url: <Artifact URL>
    app_version: <App version>
    app_id: <App ID>

8.2. Properties

Name Type Meaning

1

Type

Identifier

Module type

Valid value: abas::esdk_app

2

Host

Dependency

Name of the host.

Properties

1

installer_version

Enum

Version number

Valid values: 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 of the credentials

3

edp_credentials

Credentials

ERP user login information for the installation of the ESDK app

Name of the credentials

4

client

Dependency

Name of the Client module

5

client_user

Simple

Client user

6

skip_eapps

Boolean

Skipping the installation of the ESSENTIALSAPPS infosystem

7

artifact_url

Simple

Artifact URL

8

app_version

Simple

App version

9

app_id

Simple

App ID

10

erp

Dependency

Name of the [Erp] module

11

timeout
(optional)

Simple

Time limit for processes on the ERP server in seconds

Default value: 300

12

s3lock
(optional)

Boolean

Setting the environment variable trotz_s3lock before the installation is started

Valid values: true (trotz_s3lock=1) or false (trotz_s3lock=0)

13

force
(optional)

Boolean

Enforcing the installation of a certain ESDK app, even if the same or a higher version has already been installed

14

skip_essentials_versioncheck
(optional)

Boolean

Skipping the check as to whether the ESDK app installation program and the app to be installed are compatible with the target version of abas Essentials

15

eapps_only
(optional)

Boolean

Only installing the ESSENTIALSAPPS infosystem. No other ESDK app is installed.

9. Freetexteditor

Installation of an abas free text editor for editing text fields of the abas screen.

9.1. Structure

freetexteditor:
    Type: abas::freetexteditor
    Host: <Name of the host>
    Properties:
        ui_version: <Version number>

9.2. Properties

Name Typ Meaning

1

Type

Identifier

Module type

Valid value: abas::freetexteditor

2

Host

Dependency

Name of the host.

Properties

1

ui_version

Text

Valid value: 1.0.0

2

context_path
(optional)

Text

URL subcontext for calling the free text editor in the browser

Default value: freetexteditor

Using this module, the full text search is installed in abas ERP.

10.1. Structure

fulltext_search:
  Type: abas::fulltext_search
  Host: main
  Properties:
    install_dir: <Installation directory>
    client: <Client name>
    search_engine_port: <Port number>
    version: <Version number>

10.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::fulltext_search

2

Host

Dependency

Name of the host.

Properties

1

install_dir

Identifier

Directory in which the full text search is to be installed

Default value: /opt/fulltext_search

2

client

Dependency

Name of the Client

3

search_engine_port

Integer

Jetty server port in the target system

Default value: 11666

4

version

Text

Version of the full text search engine. If you perform the full text search in the on-premise scenario, this parameter is required.

11. Jwt Auth Userinfo

The JSON Web Token (JWT) is responsible for authentication when using single sign-on (SSO). Thus, the user has to enter credentials only in one central place and not for every UI. This module is responsible for the performance of a JWT token validation for the use for other modules.

11.1. Structure

jwt_auth_userinfo:
    Type: abas::jwt_auth_userinfo
    Host: <Name of the host>
    Version: <Version number>
    Properties:
      install_dir: <Installation directory>
      user: <User>
      port: <Port number>
      oauth2: <Name of the oauth2 module>
      rest_api: <Name of the Rest API module>
      authentication:
        erp_credentials: <ERP credentials>
        registry_credentials: registry_credentials
      erp_permissions: <ERP permissions>
      erp_workspaces: <ERP workspace>
      authentication: <Authentication>
      tenant_identity: <Name of the Tenant Identity module>

11.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::jwt_auth_userinfo

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number of the jwt_auth_userinfo module

Valid value: 1.1212

Properties

1

install_dir

Text

Installation directory

2

user

Text

User who performs the installation. Cannot be updated after initial installation. If the user is already available, they should belong to the Docker group. This user must have read and write permissions for the installation directory. root is also a valid value for this field.

3

port

Simple

Port number for the jwt_auth_userinfo container

Default value: 19950

4

oauth2

Dependency

Name of the Oauth2 module

5

rest_api

Dependency

Name of the Rest Api module

6

authentication

Map

Authentication parameters

registry_credentials

Credentials

Reference to credentials for registry.abas.sh

erp_credentials

Credentials

Reference to the Credentials section which contains the user name password for your ERP user

7

erp_permissions

Simple

ERP permissions which are used for the user in the "Rights or permissions" field

8

erp_workspaces

Simple

ERP workspace which is used for the user in the "arbber" field

9

tenant_identity
(optional)

Dependency

Name of the Tenant Identity module

10

project_name
(optional)

Text

Name of the project.
Identifies the resulting Docker Compose project. This name must be unique on a host.

Default value: jwt_auth_userinfo

11

user_sync_mode
(optional)

Enum

User synchronization, from Cloud Connect

Valid values: update-only, full

Default value: full

12

loglevel
(optional)

Enum

Level of detail of the service logs

GValid values: trace, debug, info, warn, warning, error

Default value: info

13

no_proxy
(optional)

Simple

No use of the proxy

12. Keycloak

Keycloak is an open source project from Red Hat, which can be used as an identity provider by every application. It serves the purpose of user authentication and authorization, using the standards OAuth2.0 and Open Connect 1.0.

12.1. Structure

keycloak:
    Type: abas::keycloak
    Host: <Name of the host>
    Version: <Version number>
    Properties:
      install_dir: <Installation directory>
      user: <User>
      http_port: <Server-HTTP-Port>
      https_port: <Server-HTTPS-Port>
      keycloak_admin_credentials: <Credentials for the administrator>
      keycloak_db_credentials: <Credentials for the administrator>
      webserver_base_url: webserver.webserver_base_url
      tenant_identity: <Name of the Tenant Identity module>
      secure_mode: false
      management_http_port: <Keycloak-management-HTTP-Port>
      keycloak_admin_credentials: <Keycloak-admin-credentials>
      authentication:
        registry_credentials: registry_credentials

12.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::keycloak

2

Host

Dependency

Name des host.

3

Version

Enum

Version number

Valid values: 1.4

Properties

1

install_dir

Text

Installation directory

2

user

Text

User who performs the installation. Cannot be updated after initial installation. If the user is already available, they should belong to the "Docker" group. This user must have read and write permissions for the installation directory. root is also a valid value for this field.

3

project_name

Text

Project name

4

http_port

Text

This server HTTP port is used by the [Clients] to access the authentication server via HTTP. It must be a port available in the target system.

Default value: 8087

5

https_port

Text

This server HTTPS port is used by the [Clients] to access the authentication server via HTTPS. It must be a port available in the target system.

Default value: 5443

6

keycloak_admin_credentials

Credentials

Credentials for the administrator. If a new copy of Keycloak is installed, these are the administrator user name and the password which were defined for the Master scope.
If you configure an existing installation, this is the user name password of an administrator who has the roles and permissions for creating realms and clients.

7

keycloak_db_credentials

Credentials

Credentials for the database. If a new copy of Keycloak is installed, the user name and the password for the Keycloak database (PostgresSQL) are defined.
If you configure an existing installation, you should use the user name password used in the previous installation.

8

webserver_base_url

Reference

URL of the Webserver module

Valid value: <Webserver-Modul-Name>.webserver_base_url

9

tenant_identity

Dependency

URL of the Tenant Identity module

10

secure_mode

Boolean

Type of use of the port for other modules

If true has been defined, modules which are based on Keycloak as the identity provider access Keycloak via HTTPS; otherwise, HTTP is used. HTTP for Keycloak is still configured and available. Therefore, you must still specify the HTTPS port.

11

authentication

Map

Authentication parameter

registry_credentials

Credentials

Name of the Anmeldedaten

12

project_name
(optional)

Text

Identifies the resulting Docker Compose project. This name must be unique on a host.

Default value: jwt_auth_userinfo

13

container_name
(optional)

Text

Name of the Docker container. Container names must be unique in the Docker network.

Default value: keycloak

14

master_realm
(optional)

Text

Name of the master realm, used for the login to Keycloak and the creation of the abas realm

Default value: master

15

realm
(optional)

Text

Name of the abas realm

Default value: abas

16

overwrite_realm
(optional)

Boolean

This flag controls if Keycloak creates the realm with the specified parameter "Realm" name, or if, alternatively, the realm creation is skipped and an existing realm with the name specified for client configurations and other realm settings is used.

Default value: false

17

management_http_port
(optional)

Text

WildFly Application Server management console port via which the management console of the WildFly Application Server can be accessed. If the port is 9990, it can have the form http://<Ziel-Hostname>:9990/console/index.html.

18

keycloak_loglevel
(optional)

Enum

Log level detail of the Keycloak logs

Valid values: ALL, DEBUG, ERROR, FATAL, INFO, TRACE, WARN, false

Default value: INFO

19

root_loglevel
(optional)

Enum

Level of detail of the root logs

Valid values: ALL, DEBUG, ERROR, FATAL, INFO, TRACE, WARN, false

Default value: INFO

20

certificate_subject
(optional)

Text

Creating the subject fields for the certificate

Using this field, you can define the fields in the certificate which were generated with the openssl command used by the installation. The value must be formatted as follows: / type0 = value0 / type1 = value1 / type2 =…, Characters can be masked through \ (backslash), spaces will not be skipped. The types can be looked up in the openssl command for the - subj flag of the CSR. Example of a character string: / C = DE / ST = BW / L = Karlsruhe / O = abas / OU = IT, meaning / C = country, / ST = status, / L = location, / O = organization, / OU = organizational unit Do NOT add the field / CN = Common Name. It is automatically added to the character string which corresponds to the host name of the computer on which the key will be installed.

13. License Controller

Checking the abas ERP and abas Dashboard licenses for validity.

13.1. Structure

license_controller:
    Host: main
    Type: abas::license_controller
    Version: <Version number>
    Properties:
      install_dir: <Installation directory>
      user: <User>
      port: <Port>
      tenant_identity: <Name of the Tenant Identity module>
      authentication:
        registry_credentials: registry_credentials

13.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::license_controller

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number

Valid value: 1.390

Properties

1

install_dir

Text

Installation directory

2

port
(optional)

Simple

Port

Default value: 8911

3

user

Text

User who performs the installation. Cannot be updated after initial installation. If the user is already available, they should belong to the Docker group. This user must have read and write permissions for the installation directory. root is also a valid value for this field.

4

tenant_identity

Dependency

Name of the Tenant Identity module

5

authentication

Map

Authentication parameter

registry_credentials

Credentials

Name of the credentials

6

stage
(optional)

Text

Only change to test on the instructions of the abas employee

Default value: prod

7

docker_image_tag
(optional)

Text

Docker Image Tag

14. Mongo DB

MongoDB is a NoSQL database from MongoDB Inc. This database is used by the Dashboard module.

14.1. Structure

mongodb:
  Type: abas::mongodb
  Host: main
  Version: <Version number>
  Properties:
    install_dir: <Installation directory>
    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 Meaning

1

Type

Module type

Valid value: abas::mongodb

2

Host

Dependency

Valid value host.

3

Version

Enum

Version number

Valid value: 1.4

Properties

1

install_dir

Identifier

Installation directory in which the Mongodb will be installed

2

user

Text

User to whom the Mongodb installation belongs and who performs it. Cannot be updated after initial installation. If the user is already available, they should belong to the Docker group. This user must have read and write permissions for the installation directory. The user root is also a valid value for this field.

3

mongodb_admin_credentials

Credentials

This is the reference to the Credentials section which contains the user name password for your Mongodb administrator.

4

mongo_db_port

Text

The port is used by clients to reach the Mongodb.

Default value: 27017

5

databases

Map

Database parameter

Allocation of all databases created by the module. The reference to the Credentials section is taken into account. In this section, the user name password to be defined for a certain database is specified.

dashboard

Map

This key is used as the database name. The value is the reference for the credentials of this database.

credentials

Credentials

This is the reference to the Credentials section which contains the user name password for your Mongodb user who has read and write access to the encrypted database.

*user_prefs *

Map

This key is used as the database name. The value is the reference for the credentials of this database.

credentials

Credentials

This is the reference to the Credentials section which contains the user name password for your Mongodb user who has read and write access to the encrypted database.

6

authentication

Map

Authentication parameter

registry_credentials

Credentials

Name of the credentials

7

project_name
(optional)

Identifier

Name which identifies an abas mongodb setup. Must be unique if multiple Mongodb setups should exist on the same host. The Project name parameter defines a part of the container name via the COMPOSE_PROJECT_NAME environment variable.

8

mongo_express_port
(optional)

Text

The browser can access the port on the host to which the Mongo Express Management web client has access. This must be specified independently of the parameter value install_mongoexpress.

15. Oauth2

OAuth2 is a switcher module using which the installation can be switched between Auth0 authentication and Keycloak authentication. For the cloud case, you must pass this module to Auth0. In the case of an on-premise solution, you must pass this module to Keycloak.

This module provides proxy values for all other modules. This ensures the identification of the scenario used: cloud or on-premise. With this abstraction module, the installation and modules can seamlessly switch between the two scenarios.

15.1. Structure

A minimal abasfile.yaml definition for an on-premise solution could appear as follows:

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

A minimal abasfile.yaml definition for the Auth0 solution could appear as follows:

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

15.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::oauth2

2

Host

Dependency

Name of the host.

Properties

1

name

Identifier

This is a free text character string, which should, however, ideally reflect the scenario type selected here. E.g., keycloak-type for the on-premise installation variant and auth0-type for the cloud installation variant.

2

type

Enum

The value of this parameter defines if a cloud installation or a local installation will be performed. This parameter has only 2 possible values:
- keycloak (on-premise)
- auth0 (hybrid)

3

keycloak

Dependency

Name of the Keycloak module in the abasfile.yml file. This reference is used to retrieve all authentication information provided by the Keycloak module. This information is passed to all modules which require it.

4

auth0

Dependency

Name of the Oauth2 module in the abasfile.yml file. This reference is used to retrieve all authentication information provided by the auth0 module. This information is passed to all modules which require it.

16. Online Help

This module downloads the Online Help files from an ERP host and places them in the subdirectory of the web server’s web root. Furthermore, the web server is configured in such a way that the Help file request is passed to the assets directory.

16.1. Structure

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

16.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::online_help

2

Host

Dependency

Name of the host.

Properties

1

install_dir

Identifier

Module installation directory in which the download scripts of Online Help will be placed

2

webserver

Dependency

Webserver on which the Online Help is hosted. This is the reference to the Credentials section which contains the user name password for the ERP super user.

3

erp

Dependency

ERP host containing the Online Help files

4

erp_credentials

Credentials

ERP super user credentials. This is the reference to the Credentials section which contains the user name password for the ERP super user.

17. Rest Api

17.1. Structure

rest_api:
    Host: <Name of the host>
    Type: abas::rest_api
    Version: <Version number>
    Properties:
      install_dir: <Installation directory>
      user: abas-rest-api
      port: <Port number>
      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 Meaning

1

Type

Module type

Valid value: abas::rest_api

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number

Valid value: 0.94.0

Properties

1

install_dir

Text

Directory in which the abas Rest API is to be installed

2

user

Text

Linux user to whom the Rest API installation belongs

Default value: abas-rest-api

3

port

Simple

Port on which the Rest API application runs

Default value: 8920

4

oauth2

Dependency

The abas Rest API supports the JWT validation. The Oauth2 server provides the JSON Web Token Set-URL.

5

enable_web_sockets

Boolean

The abas Rest API supports a web socket endpoint in order to use the EDP protocol directly. It is only used by the mobile applications via the cloud.

6

loglevel_de_abas_mw_edp

Enum

This setting defines the EDP log level. All EDP traffic is logged at the debug level. To globally enable EDP logging, set this property to DEBUG or TRACE. The logging per request is done by setting the HTTP header x-abas-mw-edp-log-level to the log level INFO.

Valid values: TRACE, DEBUG, INFO, WARN, ERROR

Default value: INFO

7

clients

Array

The configuration is used to connect to an abas ERP client.

edp

Dependency

edp

client

Dependency

sabamasterfile

id

Text

The ERP client ID in the AWS rest API. If it is not defined, client.mname is used.

description

Text

Die Beschreibung des ERP-Clients.

Default value: client.mandant

min_pool_size

Text

The minimum size of the connection pool (EDP sessions).

Default value: 1

max_pool_size

Text

The maximum number of unused (inactive) connections in the pool.

max_pool_wait

Text

The maximum time that the pool waits before a request fails.

disable_pool

Text

Deactivates the session pool completely.

Default value: false

ws_timeout_minutes

Text

The workflow time in minutes.

Default value: 720

initialize_meta_data_on_startup

Text

If this property is set to true, the client’s metadata is retrieved after the abas Rest API is started. Otherwise, it is retrieved when the first request is made.

Default value: true

time_between_two_pool_controls

Text

The interval in seconds at which the pool controller thread checks the number of idle sessions.

Default value: 30

max_ftext_size

Text

The interval at which changes to the metadata are requested.

Default value: 16384

metadata_polling_interval_in_seconds

Text

The interval at which the server polls the client for metadata changes.

Default value: 3600

edp_log_cache_size

Text

If a serious ERP server error occurs, the last specified lines (standard: 1000 lines) of the IT protocol are emptied.

Default value: 1000

force_edp_client_version

Text

It is necessary to set the EDP client version if the JEDP library is newer than the ERP installation.

Default value: ERP-Version

8

authentication

Map

registry_credentials

Credentials

Reference to credentials for registry.abas.sh.

9

servlet_context_path
(optional)

Text

abas Rest API ServletContext path.

Default value: /mw

10

service_ip
(optional)

Text

IP via which the abas Rest API can be accessed.

Default value: 0.0.0.0

11

project_name
(optional)

Text

Name identifying the resulting Docker Compose project. This name must be unique on a host.

Default value: rest_api

12

tenant_identity
(optional)

Dependency

The tenant identity is required for the (optional, but recommended) target group validation of the JWT. It is only used if also the Oauth2 dependency has been defined.

13

access_log_max_history_days
(optional)

Text

Maximum number of days for which the access log of the abas Rest API is retained

Default value: 30

14

access_log_max_total_size
(optional)

Text

Maximum size of the access log of the abas Rest API. Must be defined in kb, mb or gb.

Default value: 1gb

15

loglevel_de_abas_mw
(optional)

Enum

This setting only defines the log level of the abas Rest API application.

Default value: INFO

16

loglevel_root
(optional)

Enum

This setting defines the log level of the root log level of the abas Rest API application.

Valid values: TRACE, DEBUG, INFO, WARN, ERROR

Default value: INFO

17

detailed_error_messages
(optional)

Boolean

The abas Rest API provides detailed error messages, if this option is activated. The error messages may reveal details about the device and setup. This could be a security problem. Use carefully.

18

external_docker_network
(optional)

Text

Use this property to join an external Docker network. The network must exist on the same host.

19

arguments
(optional)

Array

If you have to pass additional command line arguments to the abas Rest API program, you can do this here.

20

fulltext_search
(optional)

Array

Add all full text search configurations which you want to add to the Rest API. Can be a subset of clients, if you do not want the full text search to be configured for every client.

fulltext_search

dependency

abas::fulltext_search

edp

dependency

abas::edp

18. Tenant Identity

This module is a meta module and is required by other modules.

18.1. Structure

tenant_identity:
  Type: abas::tenant_identity
  Host: <Name  of the host>
  Properties:
    b64_configuration_string: <b64 configuration string>

18.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::tenant_identity

2

Host

Dependency

Name of the host.

Properties

1

b64_configuration_string

Text

Base64 encoded token which is generated when you create your abas tenant.

19. User Administration

This is a metamodule that registered users in Keycloak can query for other modules such as dashboard and web client modules that may need this information.

19.1. Stucture

user_administration:
  Host: main
  Type: abas::user_administration
  Version: <Version number>
  Properties:
    install_dir: <Installation directory>
    user: <User>
    port: <Port>
    oauth2: oauth2
    keycloak_admin_credentials: keycloak.keycloak_admin_credentials
    authentication:
      registry_credentials: registry_credentials

19.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::user_administration

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number

Valid value: 1.412

Properties

1

install_dir

Text

Installation directory

2

user

Text

User who performs the administration

3

port

Simple

Port on which the administration container is started

Default value: 18110

4

oauth2

Dependency

User defined on the Oauth2 server.

5

keycloak_admin_credentials

Reference

Keycloak credentials for administration scope.

6

authentication

Map

registry_credentials

Credentials

Reference to credentials for registry.abas.sh.

7

project_name

Text

Name identifying the resulting Docker Compose project. This name must be unique on a host.

Default value: user_administration

8

external_docker_network

Text

Use this property to join an external Docker network. The network must exist on the same host.

20. WebClient

The abas Web Client provides a web-based front end for accessing and controlling your ERP installation.

20.1. Structure

webclient:
  Type: abas::webclient
  Host: main
  Properties:
    install_dir: <Installation directory>
    registry_credentials: registry_credentials
    rest_api: rest_api
    version: <Version number>

20.2. Properties

Name Typ Meaning

1

Type

Module type

Valid value: abas::webclient

2

Host

Dependency

Name of the host.

Properties

1

install_dir

Identifier

Directory in which the abas Web Client is to be installed.

2

registry_credentials

Credentials

Path to the specified credentials in the credentials.yml file

3

rest_api

Dependency

Name of the Rest Api module in the abas Installer environment

4

version
(optional)

Version number

If you run the Web Client in the on-premise scenario, this parameter is required.

21. Webserver

The Webserver module is required if a client wants to host all abas browser-based web solutions internally. The web server currently supported is Nginx, which is installed with abas Installer.

21.1. Structure

webserver:
  Type: abas::webserver
  Host: <Name of the host>
  Version: <Version number>
  Properties:
    install_dir: <Installation directory>
    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 Meaning

1

Type

Module type

Valid value: abas::client

2

Host

Dependency

Name of the host.

3

Version

Enum

Version number

Valid value: 1.4

Properties

1

install_dir

Text

Installation directory in which the abas web server files will be installed.

The installation directory contains your public_html folder with the content provided by your web server. It contains the configuration file for various modules hosted by the web server. It may also include a backup folder of earlier installations, once you have updated the module.

2

user

Text

Linux Benutzer

User to whom the Webserver installation belongs and who performs it. Cannot be updated after initial installation. If the user is already available, they should belong to the Docker group. This user must have read and write permissions for the installation directory. The user root is also a valid value for this field.

3

http_port

Text

HTTP server port in the target system

This port is used by the clients to reach the Webserver server via HTTP from the browser. This must be a port available in the target system.

Default value: 8181

4

https_port

Text

HTTPS Keycloak server port in the target system

This port is used by the clients to reach the Webserver server via HTTPS from the browser. This must be a port available in the target system.

Default value: 4443

5

registry_credentials

Credentials

The property refers to the Credentials section which contains the user name password for your login to abas.

This is the reference to the Credentials section which contains the user name password for your abas login. This is required to download various shared web artifacts, for whose provision the web server is used.

6

modules_to_host

Map

EDependency map of module references. (This is an optional parameter. Currently, however, you must define at least one entry.)

This is the list of all modules which the web server hosts locally for the customer or vice versa. For example, a reverse proxy is the setup for the Rest API so that the applications do not encounter the CORS problem. This map contains a number of predefined keys, which are only recognized. Not every random module entered in this list has an effect. The list of possible keys and values fro this map is currently as follows:

webclient

Dependency

Reference to the definition of the WebClient module.

rest_api

Dependency

Reference to the definition of the Rest Api module.

dashboard

Dependency

Reference to the definition of the Dashboard module.

freetexteditor

Dependency

Reference to the definition of the Freetexteditor module.

user_administration

Dependency

Reference to the definition of the User Administration module.

7

debug_mode
(optional)

Boolean

Activate or deactivate Debug mode on the web server.

If you set this to true, many web server debug and rewrite log files will be generated. It is not recommended to activate this for production. You can display the logs using the docker-compose logs command.

8

oauth2
(optional)

Dependency

Reference to the Oauth2 module definition in your abasfile.yml file.

9

secure_mode
(optional)

Boolean

This flag controls whether the Nginx server uses HTTPS protocol (tls) for content delivery.

10

repo_base_url
(optional)

Text

This is the base URL which is used by the installation module via cURL to retrieve UI assets for the web server. For Nexus repo, this is the following URL: https://registry.abas.sh/service/rest/beta/search/assets/download

Default value: https://artifactory.abas.sh/artifactory

11

certificate_subject
(optional)

Text

In this field, the subject fields in the generated certificate are defined.

Using this field, you can define the fields in the certificate which was generated with the openssl command used by the installation. The value must be formatted as follows: / type0 = value0 / type1 = value1 / type2 = …, Characters can be masked through \ (backslash). Spaces will not be skipped. The types can be looked up in the openssl command for the - subj flag of the CSR. Example of a character string: / C = DE / ST = BW / L Karlsruhe / O = abas / OU = IT, meaning / C = country, / ST = state, / L = location, / O = organization, / OU = organizational unit Do NOT add the field / CN = Common Name. It is automatically added to the character string which corresponds to the host name of the computer on which the web server will be installed.

12

project_name
(optional)

Text

Project name

Name which identifies an abas web server setup. Must be unique if multiple web server setups should exist on the same host.

13

dms_base_url
(optional)

Text

DMS URL

URL for DMS Dashboard integration