Schnittstelle Finanzbuchhaltung

Einleitung

Dieses Handbuch richtet sich an Systemadministratoren und IT-Verantwortliche, die vor der Aufgabe stehen, ein bereits installiertes docuvita Dokumentenmanagement-System um die Funktion Export von Buchungsdaten an die Finanzbuchhaltung zu erweiteren. Es erläutert alle notwendigen Schritte für die Umsetzung.

Über dieses Handbuch

In diesem Kapitel möchten wir Sie mit Ziel und Zweck dieses Handbuches vertraut machen. Hier finden Sie Informationen über das Konzept des Aufbaus dieses Handbuches. Dieses Handbuch erklärt die Funktionen und die Einrichtung der Schnittstelle Finanzbuchhaltung. Die Installation sowie die Konfiguration der Schnittstelle Finanzbuchhaltung können sich je nach verwendetem docuvita-System und vorhandener Finanzbuchhaltung im Ablauf leicht unterscheiden. Das prinzipielle Vorgehen ist aber unabhängig von der Version. Die Verfahren und Beispiele, die in diesem Handbuch dargestellt sind, gehen davon aus, dass Sie mit einem aktuellen Windows Betriebssystem und mit einem aktuellen Browser arbeiten. Manche Vorgehensweisen können hier von diesem Handbuch abweichen.

Symbolerklärung

An verschiedenen Stellen dieses Handbuches finden sich Hinweis-Boxen, die Sie auf besonders wichtige oder wissenswerte Informationen aufmerksam machen sollen. Mit * markierte Kapitel oder Bedienelemente müssen nicht zwangsläufig in sämtlichen Installationen sichtbar sein. Die Sichtbarkeit kann zusätzlich von den Berechtigungen des einzelnen Benutzers abhängen.

Achtung

Diese Hinweise sollten Sie unbedingt beachten.

Info

Hinweise dieser Kategorie enthalten hilfreiche Tipps.

Produktbeschreibung

Mit der Schnittstelle Finanzbuchhaltung können Sie die docuvita erfassten Eingangsrechnungen an eine bereits vorhandene Finanzbuchhaltung übergeben werden. Die Art der Übergabe unterscheidet sich je nach verwendeter Finanzbuchhaltung. Folgende Systeme werden aktuelle unterstütz:

  • DATEV Unternehmen Online (Release Dezember 2019)
  • DATEV Rechnungswesen Pro (Release Dezember 2019)
  • myfactory Rechnungswesen
  • Sage 100 Rechnungswesen
  • SEPA Überweisung

Systemvoraussetzungen

  • docuvita Mindestversion 19.2.1xxx
  • docuvita Windows Client
  • .Net Framework ab Version 4.6
  • Eine Internetverbindung für die Aktivierung und Validierung der Lizenz

Je nach Finanzbuchhaltung müssen weitere Voraussetzungen erfüllt werden.

Installation

Dieses Kapitel enthält Informationen, die zur erfolgreichen Installation des Schnittstelle Finanzbuchhaltung durchzuführen sind. Die einzelnen Installationsschritte sind nachfolgend beschrieben:

Erhöhte Rechte

Die Installation kann nur mit erhöhten Rechten durchgeführt werden.

Update Installation

Um ein Update zu installieren, muss der Windows Client vorher beendet werden.

  • Starten Sie die Datei dvs.finance.setup 19.xx.x.xxxx.msi

  • Im nachfolgenden Schritt erscheint ein Fenster. Klicken Sie auf Weiter um mit der Installation zu beginnen.

installtionStart

  • Lesen Sie sich die Lizenzvereinbarung durch und bestätigen Sie diese.

installtionLicenseAgreement

  • Im nächsten Schritt werden Sie nach dem Lizenzschlüssel gefragt.

installtaionLicenseKey

  • Im darauf folgenden Fenster können Sie die gewünschte Schnittstelle auswählen. Ebenfalls müssen Sie den Installationsordner angeben.

Installationsordner

Beim Installationsordner müssen Sie den Ordner des Windows Client auswählen. Standardwert C:\Program Files (x86)\docuvita\docuvita.client

userSetup

  • Danach erscheint ein Fenster, klicken sie auf Installieren.

installtionConfirmation

  • Abschließend wird die Installation gestartet.

installtionProgress

  • Bei einer erfolgreichen Installation erscheint zum Schluss folgendes Fenster.

installtionEnd

Lizenzdatei

Nach erfolgreicher Installation muss die Lizenzdatei direkt ins das Installverzeichnis (Standardwert C:\Program Files (x86)\docuvita\docuvita.client\plugins) abgelegt werden.

Lizenzvertrag

Der Lizenzvertrag ist im Install-Ordner zu finden.

Konfiguration

Die Konfiguration der Schnittstelle Finanzbuchhaltung erfolgt in zwei Schritten. Im ersten Schritt werden die Export unagbhängigen Einstellungen vorgenommen. Abschließend müssen noch die Schnittstellen spezifischen Konfigurationen durchgeführt werden.

Allgemeine Konfiguration

Erhöhte Rechte

Wenn sich die Installion in Windows Programme Verzeichnis befindet, dann werden zum Anpassen der Konfiguration Administrator Rechte benötigt.

Die Konfiguration erfolgt über eine YML Datei. Diese kann mit einem Standard Texteditor geöffnet und bearbeitet werden. Nachfolgend wird beschrieben, wie Sie dieser Datei gelangen.

  • Wechsel Sie in das Installationsverzeichnis des docuvita Windows.Client (Standardwert C:\Program Files (x86)\docuvita\docuvita.client).
  • Navigieren Sie in das Unterverzeichnis plugins.
  • Öffnen Sie die Datei dvs.finance.FinanceClient.yml mit einem Texteditor Ihrer Wahl.

Die Konfigurationsdatei ist in zwei Abschnitte unterteil. Im ersten werden die globalen Einstellungen vorgenommen. Im zweiten Bereich werden die Export Bedingungen definiert.

Allgemeiner Abschnitt

Parameter Beschreibung Beispiel
isActive Mit dieser Einstellung kann das komplette Plugin deaktiviert werden true
name Anzeigename des Menüpunktes in der Ribbionbar Buchhaltung
showSelectionWindow Wenn false wird dirket die Suche bzw. der Export ausgeführt. Es wird der kein Auswahldialog (Rechnungstyp und/oder Exportzeitraum angezeigt. true
voucherTypes Semikommagetrennte (;) Liste der möglichen Rechnungsarten. Der Inhalt dieser Variablen kann in den Suchen (Paramter) query mittels %vouchertype% verwendet werden. Rechnung;Kassenbelege;Leistungsrechnung;
subMenus Liste der Menüeinträge (Gruppen)
Parameter Beschreibung Beispiel
menuName Technischer Name dieses Menüabschnittes (Gruppe). Dieser muss in der kompletten Konfiguration eindeutig sein bookings
displayName Anzeigenname des Menüabschnittes Buchungen
menuItems Lister der einzelenen Menüpunkte (Buttons) in der aktuellen Gruppe

In der Gruppe menuItems kann eine beliebig lange Liste eingetragen werden. So kann z.B. für jeden Rechnungstyp eine eigenständige Schaltfläche in die Ribbonbar hinzugefügt werden.

Parameter Beschreibung Beispiel
name Technischer Name dieser Schaltfläche. Dieser muss in der kompletten Konfiguration eindeutig sein getReleasedInvoice
displayName Anzeigename der Schaltfläche ungebuchte Rechnungen
image Anzeigebild. Dies kann nicht geändert werden. searchInvoice.png
query Die hier eingetragenen Suche wird ausgeführt. Bei der Suche kann auf die Selektionsparameter Rechnungstyp (%vouchertype%), Startdatum (%startDate%) und Enddatum (%endDate%) zugegriffen werden. Es gibt hier drei mögliche Sucharten.
* leerer Eintrag: Es wird keine Suche durchgeführt. Für die weitere Bearbeitung werden die markierten Objekte verwendet.
* dvRunQuery.exe search: Es wird der Befehl dvRunquery ausgeführt. Es können hierbei alle bekannten Suche verwendet werden. Die Ergebnisse dieser Such werden im aktuellen Tabreiter des Windows Clienst dargestellt. Es erfolgt kein Export bei den gefunden Objekten.
* QueryDetails: Eintrag eines kompletten JSON String für die Suche. Die so gefunden Objekten werden direkt exportiert. Die Suchrrgebnisse werden nicht angezeigt.
* ‘dvRunQuery.exe search /search:”~~FLD485:1 AND FLD487:0 AND OBJ.VOUCHERTYPE:%vouchertype% AND OBJ.VOUCHERDATE:[%startDate%* TO %endDate%]”’
* ‘{“QueryDetails”:{“Constrid”:0,”Constraintname”:”~~FLD485:0 AND FLD487:0 AND OBJ.VOUCHERTYPE:%vouchertype% AND OBJ.VOUCHERDATE:[%startDate%
TO %endDate%*]”,”Constrainttype”:”F”},”ResultSortConditions”:[],”PageNumber”:0,”PageSize”:”1”}’
export Wenn auf true, dann werden die gefunden/markierten Rechnungen exportiert. Dieser Parameter hat keinen Einfluss auf die Suche mittels ‘dvRunQuery.exe’ false
exportTyp Angabe des Exportformates. Wenn kein Eintrag dann wird die installierte (zu erst geladene dll) verwendet. Dieser Parameter ist noch nicht in Verwendung ’‘
tooltip Dieser Text wird angezeigt, wenn man mit der Maus über die Schaltfläche fährt (Kontexthilfe). Listet alle Freigeben und noch nicht gebuchten Rechnungen auf
update Nach erfolgreich durchgeführten Export wird diesen Feld aktuallisiert. Verwendung: technischer Feldname=Feldwert. Der aktuellen Status wird ebenfalls vor dem Export geprüft. Ist diese Bedinung schon auf ja erfolgt kein weiterer Export ‘GEBUCHT=TRUE’

Konfiguration Speichern

Nach dem Abschluss der Änderungen in der Konfigurationsdatei müssen diese noch gespeichert werden. Nach dem Speichern ist ein Reload (Ansicht aktuallisieren) des Windows Clients notwendig.

Beispiel der Standard Konfiguration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Mit dieser Einstellung kann das komplette Plugin deaktiviert werden
isActive: True
# Anzeigename des Menüpunktes in der Ribbionbar
name: Buchhaltung
# Wenn false wird dirket die Suche ausgeführt. Es wird der kein Auswahldialog angezeigt.
showSelectionWindow: true
# Liste der möglichen Rechnungsarten. Der Inhalt dieser Variablen kann in der query mittels %vouchertype% verwendet werden.
voucherTypes: Rechnung;Kassenbelege;Leistungsrechnung;
# Liste der Menüeinträge
subMenus:
        # Technischer Name dieses Menüabschnittes. Dieser muss eindeutig sein
    -   menuName: bookings 
        # Anzeigename des Menüabschnittes            
        displayName: Buchungen
        menuItems:
            # Technischer Name dieses Schaltfläche. Dieser muss eindeutig sein
        -   name: getReleasedInvoice
            # Anzeigename der Schaltfläche
            displayName: ungebuchte Rechnungen
            # Anzeigebild. Dies kann nicht geändert werden.
            image: searchInvoice.png
            query: 'dvRunQuery.exe search /search:"~~FLD485:1 AND FLD487:0 AND OBJ.VOUCHERTYPE:%vouchertype% AND OBJ.VOUCHERDATE:[%startDate%* TO %endDate%*]"'
            # Wenn auf true, dann werden die Rechnungen exportiert.
            export: false
            # Angabe des Exportformates. Wenn kein Eintrag dann wird die installierte (zu erst geladene dll) verwendet.
            exportTyp: ''
            # Dieser Text wird angezeigt, wenn man mit der Maus über die Schaltfläche fährt (Kontexthilfe).       
            tooltip: Listet alle Freigeben und noch nicht gebuchten Rechnungen auf
            # Nach durchgeführten Export wird diesen Feld aktuallisiert. Verwendung: technischer Feldname=Feldwert z.B 'Export=True'
            update:
        # Technischer Name dieses Schaltfläche. Dieser muss eindeutig sein
        -   name: exportInvoice
            # Anzeigename der Schaltfläche
            displayName: Export (Auswahl)
            # Anzeigebild. Dies kann nicht geändert werden.
            image: export.png
            query: 
            # Wenn auf true, dann werden die Rechnungen exportiert.
            export: true
            # Angabe des Exportformates. Wenn kein Eintrag dann wird die installierte (zu erst geladene dll) verwendet.
            exportTyp: ''
            # Dieser Text wird angezeigt, wenn man mit der Maus über die Schaltfläche fährt (Kontexthilfe).       
            tooltip: Schreibt den Buchungsatz für die ausgewählten Dokumente
            # Nach durchgeführten Export wird diesen Feld aktuallisiert. Verwendung: technischer Feldname=Feldwert z.B 'Export=True'
            update: 'GEBUCHT=TRUE'
            # Technischer Name dieses Schaltfläche. Dieser muss eindeutig sein
        -   name: exportAllInvoice
            # Anzeigename der Schaltfläche
            displayName: kompletter Export 
            # Anzeigebild. Dies kann nicht geändert werden.
            image: export.png
            query: '{"QueryDetails":{"Constrid":0,"Constraintname":"~~FLD485:0 AND FLD487:0 AND OBJ.VOUCHERTYPE:%vouchertype% AND OBJ.VOUCHERDATE:[%startDate%* TO %endDate%*]","Constrainttype":"F"},"ResultSortConditions":[],"PageNumber":0,"PageSize":"1"}'
            # Wenn auf true, dann werden die Rechnungen exportiert.
            export: true
            # Angabe des Exportformates. Wenn kein Eintrag dann wird die installierte (zu erst geladene dll) verwendet.
            exportTyp: ''
            # Dieser Text wird angezeigt, wenn man mit der Maus über die Schaltfläche fährt (Kontexthilfe).       
            tooltip: Schreibt den Buchungsatz für die ausgewählten Dokumente
            # Nach durchgeführten Export wird diesen Feld aktuallisiert. Verwendung: technischer Feldname=Feldwert z.B 'Export=True'
            update: 'GEBUCHT=TRUE'

Schnittstellen spezifische Konfiguration

Die Schnittstellen spezifischen Konfiguration finden Sie unter: