Konfiguration aBServer-Dienst

Allgemeine Informationen

Mit diesem Modul kann der aBServer-Dienst konfiguriert werden. Dieses Modul kann nur lokal auf dem Rechner ausgeführt werden, auf dem das Programm installiert ist.

Konfiguration_Dienst_2.PNG

Voraussetzungen

Damit Ihre Mitarbeiter oder Filialen über das Internet auf Ihre Daten zugreifen können, müssen folgende Voraussetzungen erfüllt sein:

  1. Auf dem Server-Rechner muss als Betriebssystem Windows 10 / Server 2016 oder höher installiert sein.
  2. Auf dem Server, der die Daten extern zur Verfügung stellen soll, müssen eine Installation von aB-Agenta und der entsprechende Daten-Ordner vorhanden sein.
  3. Dieser Server muss über das Internet erreichbar sein. Das bedeutet, man muss eine statische öffentliche IP- oder www-Adresse besitzen, die auf diesen Server verweist. Sollten Sie keine statische IP-Adresse haben, kann man das künstlich über verschiedene Anbieter wie beispielsweise TwoDNS erreichen.
  4. Wenn Sie eine Firewall einsetzen, muss der entsprechende Port, an dem die Anfragen eingehen, an den Server weitergeleitet werden. Die korrekte Konfiguration der Firewall wird von uns vorausgesetzt. Wir stellen anhand der FRITZ!Box 7590 die Konfiguration einer Portweiterleitung vor.
  5. Damit der Zugriff über das Internet erfolgen kann, muss der aBServer-Dienst auf dem Server installiert und gestartet sein. Ebenso müssen die korrekten Einstellungen für den Zugriff getroffen worden sein.
  6. Für den Windows-Benutzer, der für den Remote-Zugriff eingesetzt wird, muss zwingend ein Kennwort definiert werden.

aBServer-Dienst in Betrieb nehmen

Um den aBServer-Dienst erstmalig in Betrieb zu nehmen führen Sie folgende Schritte aus:
  1. Prüfen und erfüllen Sie die oben genannten Voraussetzungen.
  2. Installieren Sie den Windows-Dienst, indem Sie auf die Schaltfläche Dienst installieren klicken.
  3. Klicken Sie auf Einstellungen und konfigurieren Sie den Dienst Ihren Gegebenheiten entsprechend. Siehe aBServer-Dienst - Einstellungen

Einstellungen

In diesem Dialog können Sie die Einstellungen für den Remote-Zugriff und den Zugriff über unsere API konfigurieren.

Sie erreichen diesen Dialog über Konfiguration aBServer-Dienst.

uJvcnD6iBatf8mop-8e92937d-33dd-4f1a-99a9-e5e5b466d70f.png

Optionen Remote-Zugriff

  • Dienst-Name
    Der Name des Windows-Dienstes. Dieser ist vorgegeben und kann nicht geändert werden.
  • Modul-Kennwort
    Das Modul-Kennwort muss bei Verbindungen von außen angegeben werden und stellt eine zusätzliche Sicherheitsmaßnahme dar. Durch einen Klick auf den Knopf eye.png können Sie sich das Modul-Kennwort anzeigen lassen.
  • Ordner-Freigabe
    Tragen Sie hier Ihren Datenordner ein. Dadurch geben Sie externen Nutzern die Erlaubnis, auf diesen Datenordner zuzugreifen. Falls Sie mehrere Pfade angeben möchten, tragen Sie diese hintereinander ein und trennen sie mit einem Semikolon ";".
  • SQL-Server-Freigabe
    Tragen Sie hier die SQL-Server-Instanz Ihres Datenordners ein (standardmäßig "\ARTBASE2019"). Dadurch geben Sie externen Nutzern die Erlaubnis, auf diesen SQL-Server zuzugreifen. Falls Sie mehrere Instanzen angeben möchten, tragen Sie diese hintereinander ein und trennen sie mit einem Semikolon ";".
  • Anzahl Verbindungen
    Die maximale Anzahl gleichzeitig verbundener Clients.
  • Port
    Der TCP-Port, der für Remote-Sitzungen verwendet wird. Der Standardwert ist 50000.

Optionen Kalender-Synchronisation

  • Zeitintervall (in Min.)
    Hier stellen Sie das Intervall ein, in dem der Online-Kalender synchronisiert werden soll. Das System startet dann automatisch eine Synchronisation der hinterlegten Kalender.
  • Datenordner
    An dieser Stelle können Sie den Datenordner einstellen, dessen Kalender automatisch synchronisiert werden soll.

Optionen API

  • Port
    Hier stellen Sie das Intervall ein, in dem der Online-Kalender synchronisiert werden soll. Das System startet dann automatisch eine Synchronisation der hinterlegten Kalender.
  • Domain
    Das ist die Domain, mit der auf die API zugegriffen wird. Diese Domain wird nur benötigt, wenn TLS/SSL eingeschaltet wird. Das System sucht dann täglich anhand dieser Domain nach einem Zertifikat im Zertifikatsspeicher, dass an den entsprechenden Port gebunden wird.
    Die Angabe ist notwendig, falls die Verschlüsselung per TLS/SSL eingeschaltet wird.
  • TLS/SSL
    Hier können Sie festlegen, ob der API-Zugriff verschlüsselt stattfinden soll.
    Wenn Sie den Zugriff von außen über das Internet freigeben, sollten Sie diese Option zwingend setzen, weil ansonsten Daten und Kennwörter unverschlüsselt übertragen werden.
    Findet der Zugriff z.B. immer über eine VPN-Verbindung statt, ist eine Verschlüsselung nicht zwingend notwendig.
  • Zertifikatseinstellungen
    Die Zertifikatseinstellungen sind notwendig, wenn der Zugriff auf die API über TLS/SSL verschlüsselt stattfinden soll. Öffnen des Dialogs für die Zertifikatseinstellungen.
  • Dokumentation API 2.1
    Link zum Aufruf der API 2.1 Dokumentation von diesem Dienst. So können Sie eine API-Implementierung mit Ihren eigenen Daten testen.
  • Dokumentation API 2.0
    Link zum Aufruf der API 2.0 Dokumentation von diesem Dienst. So können Sie eine API-Implementierung mit Ihren eigenen Daten testen.
  • CORS
    Einschalten der CORS-Funktion für die API. Dadurch können auch an anderer Stelle gehostete Webseiten auf unsere API zugreifen.
  • CORS Origins
    Wenn CORS eingeschaltet ist, kann man hier einschränken, von welchen Webseiten der Zugriff erlaubt ist. Ist das Feld leer, gilt CORS für alle, ansonsten kann man IP-Adressen oder Domain-Namen eintragen, für die CORS erlaubt sein soll. Einzelne Einträge werden dabei durch eine Pipe "|" getrennt. Die Angabe ist optional.
  • Debug Log-Dateipfad
    In diesem Ordner werden gegebenenfalls Log-Dateien gespeichert.

Vorgehensweise für die Inbetriebnahme des Dienstes


Definieren Sie als erstes ein Modul-Kennwort für den externen Zugriff. Dieses Kennwort muss keine besonderen Richtlinien erfüllen. Da es sich aber um eine zusätzliche Sicherheit für den Zugriff von außen darstellt, sollte dieses Kennwort eine ausreichende Komplexität erfüllen.

Legen Sie nun unter Ordner-Freigabe das Verzeichnis fest, das für den Zugriff von außen freigegeben werden soll. Typischerweise ist das der aB-Agenta Datenordner. Auf diesen und untergeordnete Ordner können die externen Versionen zugreifen. Alle Ordner in den Ebenen darüber werden durch den aBServer-Dienst gesperrt.

Bei der SQL-Server-Freigabe wird der SQL-Server-Name eingetragen, an dem die aB-Agenta-Datenbank angebunden ist. Hierbei handelt es sich standardmäßig um '\ARTBASE2019'. Sollten Sie nicht genau wissen, wie der SQL-Server-Name lautet, können Sie diesen auch in der SQL-Datenbank-Verwaltung von aB-Agenta nachschauen. Rufen Sie diese über die Zusatzmodule innerhalb von aB-Agenta auf.

Zuletzt wählen Sie noch einen Port, an dem der aBServer-Dienst auf Anfragen wartet. Der Port-Bereich bei einem Windows-Betriebssystem reicht von 1 bis 65535. Dabei sind zwischen 1 und 49151 einige Ports durch Standards belegt, wie beispielsweise Port 80 für Internet-Verkehr über das http-Protokoll. Die benutzerdefinierten Ports beginnen ab 49152. Wir geben standardmäßig den Port 50000 vor. Sollte dieser bereits durch eine andere Anwendung benutzt werden, definieren Sie einfach einen anderen. Der gewählte Port muss noch an der externen Firewall freigeschaltet und weitergeleitet werden. Wir haben die Portweiterleitung am Beispiel einer FritzBox beschrieben. Die Freigabe der Ports (Remote-Zugriff und API) in der Windows Firewall kann durch einen Klick auf den Knopf Ports in der Windows-Firewall freigeben automatisch gemacht werden.

Zertifikatseinstellungen

Um den Zugriff auf die API von außen abzusichern, benötigt man eine Internet-Domain und ein Zertifikat zur Verschlüsselung.
Die Domain muss auf Ihren Internet-Anschluss verweisen, damit Anfragen aus z.B. einem Webbrowser auch an den aBServer-Dienst weitergeleitet werden können.

Haben Sie bereits ein gekauftes Zertifikat für die entsprechende Domain, können Sie dieses hier importieren. Haben sie kein Zertifikat für die Domain, kann der aBServer-Dienst automatisch ein LetsEncrypt-Zertifikat erzeugen und aktualisieren.
LetsEncrypt-Zertifikate sind kostenlos, haben dafür aber nur eine Gültigkeit von 3 Monaten. Der aBServer-Dienst versucht ab 30 Tage vor Ablauf der Gültigkeit das LetsEncrypt-Zertifikat zu erneuern.
Damit der Abruf eines LetsEncrypt-Zertifikats funktioniert, muss der externe Port 80 an den internen hier eingestellten Port weitergeleitet werden.
Zusätzlich schaut der Dienst jeden Tag im Windows-Zertifikatsspeicher nach, ob dort ein aktuelles Zertifikat für die in den Einstellungen hinterlegte Domain gibt. Wenn dem so ist, wird dieses für die Verschlüsselung der API-Zugriffe genommen. So können Sie die Erzeugung eines LetsEncrypt-Zertifikats auch außerhalb unseres Dienstes realisieren bzw. ein gültiges gekauftes Zertifikat im Zertifikatsspeicher importieren.
Im Dialog für die Zertifikatseinstellungen kann man zwischen zwei Optionen wählen:

Eigenes Zertifikat

Hier kann man beispielsweise ein gekauftes Zertifikat in den Zertifikatsspeicher importieren und für den Service nutzen oder ein bereits im Zertifikatsspeicher vorhandenes Zertifikat auswählen.
szTDFwOxFJbdO0uO-802743d0-032d-41f7-b429-0f6daad16cf1.png

LetsEncrypt Zertifikat

Wählt man diese Option, kann man die für LetsEncrypt benötigten Informationen hinterlegen, damit der Service selbständig ein Zertifikat anfordern und aktualisieren kann.
jySCRCucfq4LPQ0o-61efa1d8-23a2-4312-8021-b0de558f0a5d.png

Aktive Anmeldungen am Web-Service

In diesem Dialog können Sie sehen, welche Rechner aktuell am aBServer-Dienst angemeldet sind.

aktive_Anmeldungen.png