Zum Hauptinhalt springen

Kanal-Konfiguration — Exportierte verarbeitete Dokumente

Im Bereich Exportierte verarbeitete Dokumente legen Sie fest, wohin Workist die fertig verarbeiteten Daten schickt und in welchem Format. Vier Unterseiten arbeiten dabei zusammen:

  1. AS2 — Versand über das EDI-Protokoll AS2.
  2. SFTP — Versand auf einen SFTP-Server (Workist-verwaltet oder Ihr eigener).
  3. Upload — generische Übertragungsregeln: Zielordner, Originaldokument mitsenden, gewählter Übertragungsweg.
  4. Ausgabedatei — Format und Inhalt der erzeugten Datei (z. B. XML nach Workist-Schema).

AS2 und SFTP beschreiben den Übertragungsweg. Ausgabedatei beschreibt den Inhalt. Über Upload wählen Sie aus, welcher Übertragungsweg verwendet werden soll und welche zusätzlichen Dateien mitgehen.

Voraussetzungen

  • Zugriff auf die Kanal-Konfiguration.
  • Für AS2: Endpunkt, AS2-Name und Zertifikate vom Empfänger.
  • Für eigenen SFTP: Host, Port, Benutzername, Passwort/Schlüssel. Für den Workist-verwalteten SFTP-Server brauchen Sie nur einen öffentlichen SSH-Schlüssel, siehe Datenaustausch mittels SFTP.
  • Für Ausgabedatei: ein vorab mit Ihrer Ansprechperson abgestimmtes Serialisierungsmodul.

Schritt 1 — AS2-Konfiguration

Wählen Sie in der Navigation unter Exportierte verarbeitete Dokumente den Eintrag AS2.

AS2-Konfiguration eines Kanals

FeldBedeutung
AS2 Absendername (leer lassen für Standard-Workist-AS2-Absendername)Der AS2-Name, mit dem Workist sich beim Empfänger meldet. Solange das Feld leer bleibt, verwendet Workist seinen Standardnamen — der für die meisten Fälle ausreicht.
AS2 EmpfängerendpunktDie URL des AS2-Endpunkts auf der Gegenstelle (z. B. https://edi.lieferant.de/as2).
AS2 EmpfängernameDer AS2-Identifier der Gegenstelle. Muss exakt mit dem übereinstimmen, was die Gegenstelle vergibt — Tippfehler führen zu Ablehnungen.
AS2 Empfänger-VerifizierungszertifikatÖffentliches Zertifikat (PEM-Format), mit dem Workist die digitalen Signaturen der Gegenstelle prüft. Wird Ihnen vom Empfänger bereitgestellt.
AS2 Empfänger-VerschlüsselungszertifikatÖffentliches Zertifikat (PEM-Format), mit dem Workist die ausgehenden Nachrichten an die Gegenstelle verschlüsselt.
Empfängerzertifikate validieren?Wenn aktiv, prüft Workist die Gültigkeit (Ablaufdatum, Signatur) der hinterlegten Empfängerzertifikate.

Klicken Sie auf Speichern.

hinweis

Die AS2-Konfiguration alleine sorgt nicht dafür, dass Dokumente exportiert werden. Sie müssen den Versandweg zusätzlich im Bereich Upload über Wie sollen die Dokumente übertragen werden? auf AS2 stellen.

Schritt 2 — SFTP-Konfiguration

Wählen Sie in der Navigation unter Exportierte verarbeitete Dokumente den Eintrag SFTP.

SFTP-Konfiguration eines Kanals

FeldBedeutung
Host (leer lassen für Workist-verwalteten SFTP-Server)Hostname Ihres eigenen SFTP-Servers. Solange das Feld leer ist, verwendet Workist den eigenen verwalteten SFTP-Server.
Hostkey (leer lassen für Workist-verwalteten SFTP-Server)Öffentlicher Hostschlüssel Ihres Servers — wird zur Verifikation beim Verbindungsaufbau genutzt.
Port (leer lassen für Workist-verwalteten SFTP-Server)Port Ihres eigenen SFTP-Servers.
Benutzername (leer lassen für Workist-verwalteten SFTP-Server)SFTP-Benutzername auf Ihrer Seite.
Passwort (leer lassen für Workist-verwalteten SFTP-Server)Passwort des SFTP-Benutzers. Das Feld zeigt den hinterlegten Wert maskiert an; ein erneutes Speichern überschreibt das Passwort.
Workist-verwalteter SFTP-Server (Standardfall)

Lassen Sie alle Felder leer. Hinterlegen Sie stattdessen Ihren öffentlichen SSH-Schlüssel (siehe Datenaustausch mittels SFTP). Workist erstellt das Konto auf dem verwalteten SFTP-Server automatisch.

Klicken Sie auf Speichern.

Schritt 3 — Upload-Konfiguration

Wählen Sie in der Navigation unter Exportierte verarbeitete Dokumente den Eintrag Upload. Dieser Bereich verbindet den Übertragungsweg (AS2 oder SFTP) mit dem Ziel auf der Empfängerseite und steuert, welche zusätzlichen Dateien mitgehen.

Upload-Konfiguration mit aktiviertem Upload und Originaldokument

FeldBedeutung
Upload aktivierenHauptschalter — solange ausgeschaltet, werden keine Dokumente exportiert, selbst wenn AS2/SFTP konfiguriert ist.
Zielordner für generierte DateienPfad auf dem SFTP-Server, in den Workist die generierten Ausgabedateien (z. B. XML) ablegt. Bei AS2 wird das Feld nicht ausgewertet.
Zielordner für ausgehende DokumentePfad für Originaldokumente / -mails, sofern aktiv (siehe nächste zwei Schalter).
Originaldokument hochladenWenn aktiv, schickt Workist zusätzlich zur generierten Ausgabedatei das ursprüngliche PDF/Bild mit, das Workist verarbeitet hat.
Originale E-Mail hochladenWenn aktiv, schickt Workist die ursprüngliche E-Mail (z. B. .eml) zusätzlich mit. Sinnvoll, wenn der Empfänger Kontext aus der E-Mail braucht (Anreden, Hinweise im Mailtext).
Wie sollen die Dokumente übertragen werden? (SFTP, AS2, API)Auswahl des Übertragungswegs. SFTP und AS2 verweisen auf die Konfiguration aus den vorigen Schritten; API stellt die verarbeiteten Daten stattdessen zum Abruf über die Workist-API bereit.
Zusätzliche DateienEigener, ausklappbarer Bereich: zusätzlich zum Hauptexport weitere relevante Dokumente mitschicken — z. B. den Lieferschein, eine Rechnung oder das Angebot.
Reihenfolge der Aktivierung

Konfigurieren Sie zuerst AS2 oder SFTP (Schritt 1 oder 2). Erst wenn die Verbindungsdaten hinterlegt sind, sollten Sie hier Upload aktivieren einschalten. So vermeiden Sie fehlgeschlagene Übertragungen direkt nach dem Aktivieren.

Übergabe per API

Soll die Übergabe an Ihr Zielsystem über die Workist-API erfolgen, stellen Sie Folgendes ein:

  • Upload aktivierennicht angehakt,
  • Wie sollen die Dokumente übertragen werden? — auf API,
  • Originaldokument hochladennicht angehakt.

Die verarbeiteten Daten stehen dann zum Abruf über die API bereit, statt auf einen SFTP-Server oder per AS2 versendet zu werden.

Klicken Sie auf Speichern.

Schritt 4 — Ausgabedatei

Wählen Sie in der Navigation unter Exportierte verarbeitete Dokumente den Eintrag Ausgabedatei.

Ausgabedatei-Konfiguration mit aktivierter Serialisierung

Hier legen Sie fest, was Workist in die Ausgabedatei schreibt — unabhängig davon, wie sie übertragen wird.

FeldBedeutung
Serialisierung aktivierenHauptschalter — wenn aus, erzeugt Workist gar keine Ausgabedatei (auch dann nicht, wenn Upload aktiv ist).
SerialisierungsmodulEin technischer Bezeichner des Moduls, das die Datei erzeugt (z. B. den XML-Serializer nach Workist-Schema). Dieser Wert wird beim Onboarding gemeinsam mit Workist festgelegt — bitte passen Sie ihn nicht ohne Rücksprache an.
Zusätzliche KopfzeilendatenfelderKomma-getrennte Liste zusätzlicher Kopfdatenfelder, die in die Ausgabedatei aufgenommen werden, auch wenn sie nicht standardmäßig im Serializer enthalten sind.
Zusätzliche PositionszeilenfelderWie oben, aber für Felder pro Position.
Verweis auf die analysierte Datei einfügen (<External_Document_Link>)Wenn aktiv, ergänzt Workist in der Ausgabedatei einen Link auf die ursprünglich verarbeitete Datei (z. B. das PDF).
Link zur Workbench einfügen (<Workist_URL>)Wenn aktiv, ergänzt Workist einen Deep-Link in die Workbench, mit dem Empfänger:innen direkt zum Vorgang springen können.
E-Mail-Absenderinformationen einfügen (<Received_By>)Wenn aktiv, übernimmt Workist die Von-Information der ursprünglichen E-Mail in die Ausgabedatei.
Kurzen externen Dateinamen verwendenWenn aktiv, verwendet Workist einen kürzeren Dateinamen beim Export (z. B. wenn das Empfangssystem maximale Dateinamenlängen erzwingt).

Klicken Sie auf Speichern.

Welche Felder landen in der Ausgabe?

Standardmäßig enthält die Ausgabedatei alle Felder aus Dokumentenverarbeitung → Kopffelder / Positionzeilenfelder. Über Zusätzliche Kopfzeilendatenfelder und Zusätzliche Positionszeilenfelder können Sie weitere Felder ergänzen, die im Standard-Serializer nicht enthalten sind.

Wie die vier Seiten zusammenspielen

Ein kompletter Export-Lauf nutzt alle vier Seiten:

  1. Ausgabedatei erzeugt die Datei (XML/JSON/…) aus den extrahierten Werten.
  2. Upload entscheidet, dass exportiert werden soll und über welchen Weg.
  3. AS2 oder SFTP liefert die technischen Verbindungsdaten für den gewählten Weg.
  4. Optional: Originaldokument hochladen / Originale E-Mail hochladen / Zusätzliche Dateien ergänzen den Versand um begleitende Dokumente.
Faustregel

Wenn ein Empfänger eine erwartete Datei nicht erhält, prüfen Sie die Schalter in dieser Reihenfolge: Ausgabedatei → Serialisierung aktivierenUpload → Upload aktivieren → der gewählte Übertragungsweg.

Häufige Fragen

Kann ein Kanal über AS2 und SFTP gleichzeitig versenden? Pro Kanal-Konfiguration gibt es genau einen ausgewählten Übertragungsweg im Upload-Bereich. Wenn Sie parallele Wege brauchen, sprechen Sie mit Ihrer Ansprechperson bei Workist über kanalspezifische Lösungen.

Was passiert, wenn der SFTP-Server temporär nicht erreichbar ist? Workist versucht Übertragungen mehrfach (Retry). Wenn der Server dauerhaft ausfällt, sehen Sie Fehlermeldungen in den Statistiken und können sich an den Support wenden.

Wo finde ich die generierte Datei zur Kontrolle? Über die Dokumentübersicht des jeweiligen Dokuments. Bei aktivem Originaldokument hochladen wird auch das Original mit verschickt und ist auf dem Zielsystem direkt verfügbar.

Hilfe und Support

Bei Problemen mit Export oder Übertragung halten Sie folgende Informationen bereit:

  • den Kanalnamen und welche Konfiguration es betrifft (AS2, SFTP, Upload, Ausgabedatei),
  • bei AS2: den Empfängerendpunkt, den AS2 Empfängername und ggf. den Wortlaut der Fehlermeldung aus dem Empfängersystem,
  • bei SFTP: den Host, Port, Benutzername und ob Sie den Workist-verwalteten oder Ihren eigenen SFTP-Server nutzen,
  • bei Inhalt der Ausgabedatei: den genauen Feldnamen (technischer Datenbezeichnungsname aus Dokumentenverarbeitung → Kopffelder) und ein Beispiel, wie der Wert in der Datei aktuell aussieht vs. wie er aussehen sollte.