Zu Content springen
Deutsch
Support Formular
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

Installations- und Betriebsanleitung zur Anbindung des Active-Directorys

Das über das AlsterText Kundenportal bereitgestellte Paket installiert einen lokalen Collector zur Synchronisation von Benutzer- und Gruppendaten aus dem Microsoft Active Directory. Der Collector liest relevante Informationen aus dem konfigurierten Active-Directory-Bereich aus und überträgt dieses automatisiert an einen zentralen Backend-Endpunkt zur weiteren Verarbeitung.

Folgende Aufgaben werden durchgeführt:

  • Lesen von Benutzern aus dem definierten AD-Synchronisationsbereich
  • Lesen von Gruppen und Gruppenmitgliedschaften
  • Erzeugen eines standardisierten JSON-Payloads
  • Automatische Übertragung des Payloads an das zentrale Backend

Voraussetzungen

Betriebssystem

  • Windows Server
  • Windows Client

Laufzeitumgebung

  • Windows PowerShell 5.1 oder höher
  • PowerShell 7 oder höher

Erforderliche Komponenten

  • ActiveDirectory-Modul (RSAT)

Netzwerkzugriffe

  • Active Directory Domain Controller

  • Zentraler Backend-Endpunkt

Lieferumfang

Das Installationspaket enthält typischerweise folgende Dateien:

src\
.env.example
Install.ps1
Uninstall.ps1
README.txt

Vorbereitung

Vor der Installation sind folgende Voraussetzungen sicherzustellen:  

  1. Der für die Synchronisation vorgesehene Active-Directory-Bereich wurde festgelegt
  2. Die benötigten Active-Directory-Gruppen wurden angelegt
  3. Die zu synchronisierenden Benutzer wurden den entsprechenden Gruppen zugeordnet
  4. Die relevanten Gruppen befinden sich innerhalb des später konfigurierten Synchronisationsbereichs (SYNC_USERS_OU_DN).
  5. Die Liste der zu synchronisierenden Gruppen wurde an AlsterText übermittelt

Die in Solventum™ Fluency Direct™ benötigten Gruppen werden durch AlsterText angelegt und müssen vor dem Produktivstart abgestimmt werden.

Installation

Paket entpacken:
Das Installationspaket vollständig in ein lokales Verzeichnis entpacken.

Installation starten:
PowerShell mit Administrator-Rechten öffnen und im entpackten Verzeichnis ausführen: 

.\Install.ps1 -Force

Alternativ unter Windows PowerShell 5.1:

powershell -ExecutionPolicy Bypass -File .\Install.ps1 -Force

Konfiguration anpassen:
Nach erfolgreicher Installation die Konfigurationsdatei bearbeiten:

C:\Program Files\FftAdSyncCollector\.env

Die Datei muss mit den bereitgestellten spezifischen Werten befüllt werden. Wichtige Konfigurationsparameter:

Parameter Beschreibung
CUSTOMER_ID Eindeutige Kundenkennung (wird durch AlsterText mitgeteilt)
AD_SERVER Domain Controller
SYNC_USERS_OU_DN Synchronisationsbereich im Active Directory
BACKEND_API_BASE_URL Basis-URL des Backends
BACKEND_API_TOKEN Authentifizierungstoken
BACKEND_SUBMIT_PATH API-Endpunkt für die Übertragung 
COLLECTOR_INTERVAL_SECONDS Ausführungsintervall

Hinweis:

Die Installation erfolgt immer im Zielverzeichnis

C:\Program Files\FftAdSyncCollector

Die geplante Windows-Aufgabe verwendet anschließend ebenfalls diesen Installationspfad.

Collector starten

Nach dem Speichern der Konfiguration kann der Collector durch manuelles Ausführen der geplanten Aufgabe oder durch einen Neustart des Systems gestartet werden.

Betrieb

Der Collector wird im Hintergrund ausgeführt. Die Wiederholung der Synchronisation erfolgt automatisch anhand des Parameters COLLECTOR_INTERVAL_SECONDS.

Geordnetes Stoppen

Der Collector kann über eine Stop-Datei sauber beendet werden. Hierzu können Sie folgende Datei anlegen:

C:\Program Files\FftAdSyncCollector\run\stop.signal

Der laufende Collector erkennt diese Datei automatisch und beendet sich anschließend geordnet. Nach dem erfolgreichen Stopp kann die Datei wieder entfernt werden.

Fehlerbehandlung

Wenn erforderliche Voraussetzungen fehlen, wird der Start des Collectors frühzeitig abgebrochen. Typische Ursachen hierfür sind:

  • Fehlende .env-Datei
  • Fehlendes Active-Directory-Modul
  • Nicht erreichbarer Backend-Endpunkt
  • Fehlerhafte Konfiguration des Domain Controllers
  • Fehlerhafte Konfiguration des Synchronisationsbereichs

Zur Analyse sollte zunächst die Logdatei geprüft werden:

C:\Program Files\FftAdSyncCollector\reports\main.log

Deinstallation

Zur Entfernung des Collectors:

.\Uninstall.ps1

 

Zur vollständigen Entfernung einschließlich Installationsverzeichnis:

.\Uninstall.ps1 -RemoveInstallRoot