Beispielworkflows und Beispieldokumente verwenden

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Sie können die Funktionalität, die das Plugin Dokument | E-Rechnung zur Verfügung stellt, mit Beispielworkflows und Beispieldokumenten testen.

Beispielworkflows verwenden

Das Plugin wird mit Beispielworkflows ausgeliefert. Sie verschaffen sich damit einen Überblick über die Funktionalität und können die Workflows als Grundlage für eigene Workflows duplizieren und weiterverwenden.

Beispielworkflow	Inhalt	Konfigurationen
agorum.electronic.invoicing.demo_complete	Kompletter Durchlauf: E-Rechnung lesen (parse), lesbare Ansicht erzeugen (createView), daraus wieder eine E-Rechnung erstellen (createInvoice), Ergebnis erkennen (check) und prüfen (validateInvoice)	xrechnung_cii, xrechnung_ubl, zugferd_cii
agorum.electronic.invoicing.demo_all_knots	Alle Workflow-Knoten des Plugins einzeln	validate, xrechnung_cii, xrechnung_cii_rabatt, xrechnung_ubl, zugferd_cii, custom

Achtung: Die Beispielworkflows legen ihre Ergebnisse im Ordner /agorum/roi/workspace/agorum.electronic.invoicing/test ab. Dieser Ordner wird bei der Installation nicht angelegt. Fehlt er, bricht der Start mit der Meldung Parameter baseFolder is invalid, object not found with ID: /agorum/roi/workspace/agorum.electronic.invoicing/test ab. Legen Sie den Ordner vorher an oder tragen Sie in den Knoten file einen eigenen Zielordner ein.

So führen Sie einen Beispielworkflow aus:

Öffnen Sie im Explorer den Ordner /agorum/roi/customers/agorum.electronic.invoicing/test/workflow-samples und darin den Ordner des Workflows, etwa agorum.electronic.invoicing.demo_complete.
Doppelklicken Sie auf definition.acwd.

Ergebnis: Der Workflow-Editor öffnet sich in einem neuen Browser-Tab.
Klicken Sie in der Werkzeugleiste auf Ausführen.
Wählen Sie links eine Konfiguration, etwa zugferd_cii.acwc, und klicken Sie rechts auf Ausführen.

Ergebnis: Der Workflow läuft durch, der Editor wechselt in die Prozessübersicht. Die erzeugten Dateien liegen mit einer UUID als Namen im Ordner /agorum/roi/workspace/agorum.electronic.invoicing/test.

Die Konfigurationen verweisen auf Testdokumente unter /Home/roi/MyFiles/Administration/customers/…, also über die Verknüpfung im Bereich des Administrators. Passen Sie den Pfad an, wenn der Workflow unter einem anderen Benutzer läuft.

Die Beispieldokumente im Unterordner test/data umfassen unter anderem XRechnungen in UBL und CII, eine Peppol-Rechnung, ZUGFeRD-PDFs, Rechnungen mit Anhängen, eine Rechnungskorrektur, absichtlich ungültige Rechnungen und JSON-Dateien mit normalisierten Daten (completeDataStructure.json, EN16931_COMPLIANT/minimal_json.json).

Nach dem Installieren des Plugins können Sie auf die Beispielworkflows über den Workflow-Editor zugreifen. Sie finden die Beispiel-Workflows im Ordner /agorum/roi/customers/agorum.electronic.invoicing/test/workflow-samples. Im Workflow-Editor können Sie die Beispielworkflows auch mit unterschiedlichen Konfigurationen ausführen. Dabei werden Beispieldokumente aus dem Plugin-Ordner verwendet. Sie finden diese Dokumente im Unterordner test/data.

Ausführen eines Beispielworkflows

Beispielvorlage als Grundlage für eigene Dokumentvorlagen verwenden

Sie können E-Rechnungen, die nur in XML vorliegen (XRechnungen), besser lesbar und weiterverwendbar anzeigen lassen. Dazu benötigen Sie eine Dokumentvorlage.

Achtung: Für das Füllen der Vorlage und die Umwandlung in PDF setzt Dokument | E-Rechnung voraus, dass auf dem agorum core-Server LibreOffice installiert ist. Wenn Sie noch OpenOffice verwenden, müssen Sie stattdessen LibreOffice installieren. Die Vorlage selbst können Sie mit Word oder LibreOffice bearbeiten.

Eigene Dokumentvorlage erstellen

Sie können eine eigene Dokumentvorlage erstellen, indem Sie die Beispielvorlage kopieren und für Ihre Bedürfnisse anpassen. Alternativ können Sie auch eine neue Vorlage erstellen und sich hinsichtlich der Platzhalter für die E-Rechnungsdaten an der Beispielvorlage orientieren. Die Dokumentvorlage muss nicht im DOCX-Format vorliegen; es werden auch andere Office-Dateiformate unterstützt, insbesondere .odt.

Sie finden die Beispielvorlagen in diesem Ordner:

/agorum/roi/customers/agorum.electronic.invoicing/template

Invoice_Template_Complete_All_Keys.docx: enthält alle Platzhalter, die in einer E-Rechnung vorkommen können; Standardvorlage der Kontextmenü-Aktion.
Invoice_Template_Complete.docx: kompaktere Rechnungsdarstellung, verwendet im Beispielworkflow demo_complete.

Die Platzhalter tragen die Namen der normalisierten Daten. Bis zu drei Steuersätze werden zusammengefasst ausgegeben; Beträge und Datumswerte werden nach den Parametern Datums-Format und Zahlenformat formatiert. Die Bezeichnung des Rechnungstyps steht im Platzhalter agorum_accounting_document_type_code_description, etwa Rechnung für 380 oder Rechnungskorrektur für 384; ohne hinterlegte Übersetzung erscheint der Code.

Sie können die Beispielvorlage wie folgt als Grundlage für eine eigene Vorlage verwenden und mit dem Beispielworkflow testen:

Kopieren Sie die Beispielvorlage Invoice_Template_Complete_All_Keys.docx aus dem Plugin-Ordner in Ihre eigene Dateistruktur und ändern Sie den Dateinamen, etwa zu:
```
My_Invoice_Template.docx
```
Öffnen Sie das Dokument. Es enthält alle Metadaten, die in einer E-Rechnung möglicherweise vorkommen. Sie können die Daten neu anordnen und für Sie nicht relevante Daten aus dem Dokument entfernen. In diesem Beispiel wurde eine Kopfzeile mit dem Hinweis ergänzt, dass es sich um eine E-Rechnung handelt. Außerdem wird der Gesamtbetrag zusätzlich in der Kopfzeile ausgegeben.
Öffnen Sie den Workflow, mit dem Sie die neue Vorlage testen wollen, und ersetzen Sie im createView-Knoten die Angabe für den Parameter Vorlage durch die ID oder den Pfad der eben erstellten Vorlage.
Klicken Sie Ausführen, um den Workflow mit der neuen Vorlage zu testen.

Ergebnis: Der Workflow erstellt mit der neuen Vorlage eine DOCX- oder PDF-Datei und legt sie dort ab, wo es der Workflow vorsieht.

Anzeige einer E-Rechnung mit anderer Vorlage

Standard-Template für die Kontextmenü-Aktion konfigurieren

Die Kontextmenü-Aktion E-Rechnung > PDF-Ansicht erzeugen verwendet standardmäßig das mitgelieferte Template Invoice_Template_Complete_All_Keys.docx. Wenn Sie ein eigenes Template als Standard für diese Aktion verwenden möchten, können Sie dies über die MetaDB konfigurieren.

Setzen Sie dazu folgenden MetaDB-Eintrag auf den Pfad oder die ID Ihrer Vorlage:

MAIN_MODULE_MANAGEMENT/customers/agorum.electronic.invoicing/settings/templateDoc

Wenn dieser MetaDB-Eintrag nicht gesetzt ist, wird automatisch das mitgelieferte Template verwendet:

/agorum/roi/customers/agorum.electronic.invoicing/template/Invoice_Template_Complete_All_Keys.docx

Hinweis: Diese Einstellung betrifft ausschließlich die Kontextmenü-Aktion. In Workflows geben Sie das Template direkt im Workflow-Knoten Dokument aus E-Rechnung erstellen über den Parameter Vorlage an, siehe Knoten Dokument aus E-Rechnung erstellen verwenden.