Funktionalitäten der Schnittstelle

• Generische Schnittstelle zum Austausch von Bewegungsdaten

• Verschlüsselter Transport

• Externe Rechteverwaltung und Zugriff per SFTP auf Verzeichnisebene (Eigener SFTP-Zugang pro Verzeichnis möglich)

• Ausgehende Daten werden von PEIQ zum Abruf bereitgestellt (OUTBOUND, Richtung bezieht sich auf Perspektive von PEIQ); OUTBOUND = ausgehende Daten werden im SFTP-Verzeichnis abgespeichert, um von dort abgeholt zu werden

• Eingehende Daten schreibt ein Drittsystem auf den SFTP Bereich in der PEIQ Cloud (INBOUND, Richtung bezieht sich auf Perspektive von PEIQ); INBOUND = eingehende Daten werden von außen in den Ordner kopiert und regelmäßig durch PEIQ eingelesen und interpretiert

Inhaltsverzeichnis

Zugriffswege

Der Zugriff auf die Verzeichnisse erfolgt über folgende Protokolle und Clients:

• Protokoll: SFTP (SSH File Transfer Protocol/Secure File Transfer Protocol)

• Port: 22

• Authentifizierung: Benutzername/Passwort oder Benutzername/Zertifikat

• Clients (Auswahl):
  GUI: Z. B. FileZilla
  Kommandozeile/Skript: OpenSSH, verfügbar unter Windows 10 und Server 2019 nativ, ältere Windows-Versionen per Installation von OpenSSH, Linux, MacOS
  Eigenes Programm: SSH/SFTP-Bibliotheken sind für verschiedenste Programmiersprachen verfügbar

• SFTP-Verzeichnis:
  Das SFTP-Verzeichnis ist (technisch bedingt) immer das Unterverzeichnis “/sftp”. Deshalb muss beim Zielverzeichnis (“entferntes Verzeichnis”) immer “sftp” oder “/sftp” eingetragen werden, damit der Upload funktioniert.

Der Up- oder Download über das jeweilige SFTP-Rootverzeichnis (/) ist nicht möglich.

Workflow

Import

• Importe werden per SFTP im SFTP-Eingangsverzeichnis angeliefert

• Ein Workflowdämon überwacht dieses Verzeichnis und importiert in einem definierten Zeitintervall (z. B. jede Minute) neu eingelaufene Daten nach PEIQ PRINT NGEN (“Abräumen”)

Export

• Exporte werden als XML, PDF oder ähnliches im SFTP-Ausgangsordner aus PEIQ PRINT NGEN abgelegt 

• Dort können die Daten vom externen Anbieter je nach eingesetztem Workflow automatisiert oder manuell abgeholt werden. Dabei ist “abzuräumen”.

Im folgenden Video werden die Importworkflows (TV, Börse, Karikatur, Rätsel etc.) erklärt:

Ordnerstruktur

Abhängig vom vereinbarten Funktionsumfangs der PEIQ Cloud und den aktivierten Schnittstellen werden gewisse Ordner bereitgestellt, um diese den entsprechenden externen Dienstleister (Inhaltelieferanten oder Inhalteverarbeiter) freigeben zu können. Dies erfolgt sowohl auf dem Test- als auch auf dem Prod-System.

Die genaue Benamung und Ordnerstruktur ergibt sich aus den jeweiligen Schnittstellen-Dokus und den Mitwirkungs-Werte-Listen.

Die Ordnerstruktur orientiert sich an folgender Illustration. Dabei bilden die nachfolgend eingefärbten Ordner jeweils einen separat verschlüsselten Zugang.

Legende

Mitwirkungspflichten zum Setup

Die Mitwirkung, die für dieses Setup erforderlich ist, finden Sie hier:

Mitwirkungspflichten: INBOUND / OUTBOUND via SFTP

Mitwirkungspflichten zum Betrieb

• Der/die Kund:in muss die zeitnahe Abholung bereitgestellter Export-Daten sicherstellen

• Der/die Kund:in muss sicherstellen, dass nur die verabredeten Dateiformate in die jeweiligen Verzeichnisse hochgeladen werden und keine zusätzlichen oder nicht-importierbaren Dateien

• Der verwendete SFTP-Client muss fehlertolerant sein, um auch kurze Ausfälle des SFTP-Servers z. B. bei Wartungsarbeiten oder durch Schwenks im Loadbalancer ohne Ausfall zu überbrücken

• Der/die Kund:in muss sicherstellen, dass der SFTP-Client für die hochgeladenen Dateien den Zeitstempel des Upload-Vorgangs verwendet (wichtig für das Monitoring)

Bekannte Fehlerquellen

• Der/die Kund:in versucht sich per FTP-Protokoll zu verbinden (anderes, veraltetes Protokoll)

• Der/die Kund:in versucht sich per FTPS-Protokoll zu verbinden (anderes Protokoll)

• Der/die Kund:in stellt im Client nicht Port 22 ein.

Optionale weitere Informationen (auf Anfrage)

/wiki/spaces/CORE/pages/906133524

Verwandte Seiten