StartEinrichten der Schnittstelle
How To

Einrichten der Schnittstelle

ADDISON Grundfunktionen
Letzte Aktualisierung: Lesezeit 6 Minuten
SBA-zu-DocuWare-Schnittstelle

    Einrichten der Schnittstelle

    Allgemein

    Funktionsweise

    Der ADDISON-Dienst SBA-zu-DocuWare Server greift über die DocuWare-GAPI-Schnittstelle bzw. die DocuWare Platform Services auf DocuWare zu. Im Dienst SBA-zu-DocuWare Server wird die gewünschte Ablagemaske konfiguriert und einige weitere Einstellungen durchgeführt. Dadurch kann der Dienst direkt auf das DocuWare-Archiv zugreifen und somit das DocuWare-Archiv „ferngesteuert“ bedienen.

    Voraussetzungen

    Für die Nutzung der Schnittstelle werden die Mindestversionen

    • SBA Version 4.0.34 und
    • DocuWare Version 5.1b mit SP 3 und Hotfix 2

    vorausgesetzt.

    Verwendung der DocuWare-Schnittstelle (ab DW 7.3)

    Um die aktuelle Schnittstelle von DocuWare verwenden zu können, ist kein Kopieren von Dateien aus einem DocuWare-Installationsverzeichnis in das SBA-zu-DocuWare-Installationsverzeichnis notwendig.

    Die folgenden weiteren Dateien, die für die Verwendung der Schnittstelle benötigt werden, werden bei Ausführen des Setups für ADDISON SBA zu DocuWare Dienst automatisch installiert und dürfen nicht aus der DocuWare-Installation kopiert werden:

    • DocuWare.Platform.ServerClient.dll
    • DocuWare.Platform.ServerClient.DotNet.dll
    • DocuWare.RestClient.dll
    • DocuWare.WebIntegration.dll

    Verwendung der DocuWare-Schnittstelle (ab DW 6.8 bis DW 7.1)

    Um die aktuelle Schnittstelle von DocuWare verwenden zu können, kopieren Sie folgende Datei aus dem gelisteten DocuWare-Installationsverzeichnis in das SBA-zu-DocuWare-Installationsverzeichnis**\Assemblies**:

    • [DocuWare-Installation]\Setup Components*DocuWare.Common.dll*

    Die folgenden weiteren Dateien, die für die Verwendung der Schnittstelle benötigt werden, werden bei Ausführen des Setups für ADDISON SBA zu DocuWare Dienst automatisch installiert und dürfen nicht aus der DocuWare-Installation kopiert werden:

    • DocuWare.Platform.ServerClient.dll
    • DocuWare.Platform.ServerClient.DotNet.dll
    • DocuWare.RestClient.dll
    • DocuWare.WebIntegration.dll

    Verwendung der DocuWare-Schnittstelle (bis DW 6.7)

    Um die aktuelle Schnittstelle von DocuWare verwenden zu können, kopieren Sie alle Dateien aus dem DocuWare-Client-Installationsverzeichnis**\Gapi** in das SBA-zu-DocuWare-Installationsverzeichnis**\Assemblies**.

    Anpassung bei 64-Bit-Systemen (bis DW 6.7)

    Auf 64-Bit-Systemen sind ggf. folgende Anpassungen der Datei DocuWare.Gapi.dll.settings vorzunehmen:

    • Den Eintrag suchen und die Option Active="true" auf **Active="false"** ändern.
    • Den Eintrag suchen und die Option Active="true" auf **Active="false"** ändern.

    Verarbeitungszyklen

    Während der Ausgabe eines SBA-Belegs ist dieser bis zum vollständigen Abschluss des Schreibvorgangs durch SBA exklusiv gesperrt und kann erst anschließend durch den ADDISON SBA zu DocuWare Dienst verarbeitet werden.

    In diesem Zusammenhang gilt es folgendes zu beachten:

    • Ist die Sperrung eines SBA-Belegs nach 90 Sekunden noch nicht aufgehoben, so wird dieser übersprungen und der nächste SBA-Beleg verarbeitet.
    • Ist der übersprungene SBA-Beleg beim nächsten Neustart des Dienstes SBA-zu-DocuWare nicht mehr durch SBA exklusiv gesperrt, wird die Verarbeitung des SBA-Belegs nachgeholt.

    Konfigurationseinstellungen

    Für den Dienst SBA-zu-DocuWare Server sind verschiedene Konfigurationseinstellungen vorzunehmen.

    Der Aufruf erfolgt über die Schaltfläche Konfiguration.

    Einstellungen in der DocuWare Administration

    Über die DocuWare Administration müssen vor Einrichtung und Nutzung des ADDISON-Diensts SBA-zu-DocuWare Server ggf. neue Archivfelder angelegt sowie eine Ablagemaske definiert werden.

    Über die Ablagemaske können hierbei auch feste Vorbelegungen von Indexwerten (bspw. für Bereich, Bezeichnung/Betreff und Bearbeitungsstatus) eingerichtet werden.

    #3486712: Software sbazudocuware image7.png

    Ein-/Ausklappen der Bereiche

    Das Ein- und Ausklappen der Bereiche der Konfiguration erfolgt durch Anklicken der Schaltflächen #3486710: Software sbazudocuware image8.png.

    Zugangsdaten

    Login-Typ

    Zur Anmeldung an DocuWare werden folgende Methoden unterstützt:

    • Windows Trusted Login
      Der Benutzer wird über den angemeldeten Windows-Benutzer an DocuWare angemeldet.
    • DocuWare Login
      Der Benutzer wird über Benutzername und Kennwort des DocuWare-Benutzers an DocuWare angemeldet.

    Benutzername und Kennwort

    In diesen Feldern sind bei Verwendung des Login-Typs DocuWare Login der Benutzername und Kennwort des DocuWare-Benutzers einzutragen.

    Globale Archiv- Einstellungen

    Über diese Felder wird definiert, welche Einstellungen der ADDISON-Dienst SBA-zu-DocuWare für den Zugriff auf DocuWare verwendet. Die eingetragenen Daten zu den Feldern müssen in DocuWare vorhanden sein, da sonst kein korrekter Zugriff auf die Daten von DocuWare erfolgen kann.

    • DocuWare Server
      steuert den Zugriff auf die DocuWare-Installation. Das Feld ist ab DocuWare-Version 6.8 einzurichten. Bei Online-Versionen geben Sie die URL ihrer DocuWare Cloud an.
      Erfolgt keine explizite Angabe des Protokolls und/oder Ports, so wird http:// mit Port 80 verwendet (Fall a). Mögliche Varianten:

    • http://

    • :8080

    • https://

    • https://:8080

    • Archivname steuert den Zugriff auf das DocuWare-Archiv.

    • Ablagemaske für Import steuert die zur Verarbeitung der SBA-Belege zur Verfügung stehenden Archivfelder.

    • Identifikation vorhandener Dokumente über steuert die Identifikation bereits archivierter SBA-Belege über Heftung / SBA-ID oder Barcode. I.d.R. erfolgt die Identifikation über Heftung / SBA-ID.

    • Erfolgreich verarbeitete Dokumente löschen? steuert die Handhabung erfolgreich verarbeiteter SBA-Belege.

    Verzeichnisse

    Die Konfigurationsfelder für Verzeichnisse steuern den Zugriff auf die von SBA abgestellten Belege und deren Verarbeitung.

    • Export-Pfad von SBA
      Die Pfadangabe muss dem Ablageverzeichnis von SBA entsprechen.
      Weitere Informationen zur Einrichtung von SBA entnehmen Sie bitte dem Kapitel Konfigurationseinstellungen in SBA.

    • Pfad für verarbeitete Dokumente
      Sollen erfolgreich verarbeitete und somit im DocuWare-Archiv abgelegte SBA-Belege nicht automatisch gelöscht werden, so müssen diese in ein separates Verzeichnis verschoben werden.
      Bitte beachten Sie, dass hierbei ein erhöhter Speicherplatzbedarf entsteht und die Dateien aus diesem Grund nur temporär in diesem Verzeichnis vorgehalten werden sollten.

    • Pfad für nicht erfolgreich verarbeitete Dokumente
      Konnten SBA-Belege nicht korrekt verarbeitet und im DocuWare-Archiv abgelegt werden, so werden die betroffenen SBA-Belege nicht automatisch gelöscht, sondern müssen in ein separates Verzeichnis verschoben werden.

    Feld-Einstellungen allgemein

    Zuordnungen DocuWare-Indexfeld zu ADDISON-Feld

    Im Folgenden sind ADDISON-Felder aufgelistet, denen jeweils ein DocuWare-Indexfeld zugeordnet werden muss, um die entsprechenden Buchungsinformationen aus SBA an DocuWare übergeben und bestimmte Funktionen in Verbindung mit ADDISON und DocuWare ausführen zu können.

    • Heftung / SBA-ID Barcode
      Diese Werte dienen zur Identifikation des SBA-Belegs. Die Zuordnung eines Feldes zu Heftung / SBA-ID oder Barcode muss zwingend erfolgen, damit ein Aufruf des in DocuWare archivierten SBA-Belegs aus der ADDISON Finanzbuchhaltung möglich ist. I.d.R. erfolgt die Identifikation über Heftung / SBA-ID.

    • Mandantennummer, Mandantenname
      Bei diesem Mandanten wurde die Buchung in der ADDISON Finanzbuchhaltung über Scannen-Buchen-Archivieren erstellt.

    • Zeitraum, Zeitraum bis, Jahr
      Die Werte Zeitraum, Zeitraum bis und Jahr werden aus dem Buchungsmonat ermittelt.

    • Ersteller
      Als Ersteller wird der bei ADDISON angemeldete BBS-Benutzer, der die Buchungen über SBA durchführt, ausgegeben.

    • Erstelldatum
      Das Erstelldatum entspricht dem Datum, an dem die Buchung über Scannen-Buchen-Archivieren durchgeführt wurde.

    • Belegdatum, Gesamtbetrag, Konto, Kontoname, Gegenkonto, Gegenkontoname, Belegnummer, Belegnummer 2, Buchungstext, Kost 1, Kost 2, Kost-Menge, USt-IdentNr, Währungskennzeichen
      Diese Buchungsinformationen entsprechen den in der ADDISON Finanzbuchhaltung erfassten Buchungseingaben und können als Indexwerte ins DocuWare-Archiv übergeben werden.

    Starten / Beenden des Diensts

    Die Oberfläche des ADDISON-Dienst SBA-zu-DocuWare Server dient zur Verwaltung und Steuerung des Diensts.

    SBA zu DocuWare-Dienst starten

    Der Dienst wird gestartet. Sobald der Dienst läuft, werden im Export-Pfad von SBA abgestellte SBA-Belegdateien verarbeitet.

    SBA zu DocuWare-Dienst beenden Der Dienst wird beendet, sobald keine Verarbeitung von SBA-Belegdateien aktiv ist.

    Dienst direkt beenden #3486709: Software sbazudocuware image10.png

    Der Dienst wird sofort beendet und bricht somit auch eine laufende Verarbeitung von SBA-Belegdateien ab. Bitte unbedingt beachten: Diese Funktion sollte nur genutzt werden, sofern der Dienst keine Rückmeldung mehr gibt und ein Beenden des Diensts über die Funktion SBA zu DocuWare-Dienst beenden nicht möglich ist.

    Verwandte Themen

    Freischalten von ADDISON Direkt-Anwendungen - Schnelleinstieg für die Steuerkanzlei (ADDISON)
    Das Dokument bietet eine Schritt-für-Schritt-Anleitung zur Konfiguration von ADDISON Direkt-Anwendungen für Mandanten. Es beschreibt, wie man die Software öffnet, den Status überprüft, Mandanten auswählt und Anwendungen aktiviert. Es wird darauf hingewiesen, dass verschiedene Applikationen von Wolters Kluwer und Partnern verfügbar sind, und Informationen zu Preisen und AGB gegeben. Der Prozess endet mit einer Übersicht der ausgewählten Anwendungen und der Bestätigung der Konfiguration.
    Erstellung von Mandanten-Zugangsdaten für ADDISON Direkt - Schnelleinstieg für den Berater mit ADDISON
    Das Dokument beschreibt die Schritte zur Erstellung von Zugangsdaten für den Informationsaustausch über ADDISON Direkt zwischen einer Steuerkanzlei und deren Mandanten. Es erklärt die Freischaltung einzelner oder mehrerer Mandanten. Der Prozess umfasst die Generierung von Logins im ADDISON-Programm, die Auswahl der Mandanten und die Weitergabe der Zugangsdaten. 
    ADDISON: ADDISON Direkt Berechtigungen, Benutzerverwaltungen und Kommunikation aus ADDISON für Kanzleimitarbeiter
    Das Dokument beschreibt die aktuellen Updates zu Berechtigungen, Benutzerverwaltung und Kommunikation in ADDISON Direkt. Es erläutert die Voraussetzungen für den Versand und Aufruf von Kommunikationsnachrichten sowie die Rolle des Absenders. Zudem werden neue Menüpunkte im Register Online vorgestellt, die den Login und die Benutzerverwaltung für AOC-Administratoren betreffen. Besonderes Augenmerk liegt auf der Möglichkeit, Mandantensperren zu übermitteln, sodass gesperrte Mandanten nicht in ADDISON Direkt aufgerufen werden können. Eine PDF-Anleitung ist ebenfalls beigefügt.
    ADDISON Direkt Portalindividualisierung: E-Mails und Zugangsdaten anpassen - Schnelleinstieg für den Berater (ADDISON und AKTE)
    Das Dokument beschreibt die Anpassung von E-Mails und Zugangsdaten in ADDISON Direkt. Dabei können E-Mails an Mandanten personalisiert werden, um auf neue Dokumente oder Nachrichten hinzuweisen. Mit Variablen können Platzhalter eingesetzt werden, die automatisch durch spezifische Informationen ersetzt werden. Grundlegende Einstellungen für Absender und Signatur sowie individuelle Anpassungen der E-Mail-Vorlagen werden erläutert. Zudem wird die Anpassung von Zugangsdaten-Dokumenten behandelt, einschließlich der Erstellung und Vorschau als PDF. Abschließend werden Tipps zur Bearbeitung und Formatierung der Dokumente gegeben.
    ADDISON Direkt Portalindividualisierung - Schnelleinstieg für den Berater (ADDISON)
    Der Text beschreibt die „ADDISON Direkt Portalindividualisierung“, die es ermöglicht, ein Kanzleiportal individuell zu gestalten. Nutzer lernen, wie sie Designanpassungen, Logos, Farbpaletten und Kontaktinformationen einfügen können. Zudem werden Funktionen zur Anpassung der Login-Seite, E-Mail-Signaturen, Dateitypen und Impressum erklärt. Am Ende können Nutzer eine Datenschutzerklärung verwalten und anpassen. Eine PDF-Anleitung steht zum Download zur Verfügung, um den Einstieg zu erleichtern.