Dokumentation
Dokumentation
Dokumentenmanagement

1Allgemeines Konzept der Dokumentenverarbeitung

Wir können auch Dokumente für Sie verarbeiten und sie an Ihre Kunden senden. Es gibt mehrere Gründe, warum Sie diese Funktion nutzen möchten:

  1. Wenn Ihre Anwendung keine Funktion zum Erstellen von PDF-Dokumenten besitzt, können Sie einfach unsere verwenden und müssen sich nicht mehr darum kümmern.

  2. Wenn Ihre Anwendung die PDF-Dokumente nicht per E-Mail an die Kunden versenden kann.

  3. Wir haben festgestellt, dass die Dokumentenverarbeitung und insbesondere das Anpassen von Dokumenten oft eine echte Qual ist. Wir bieten Ihnen daher eine einfache und bequeme Möglichkeit, Ihre Dokumente an Ihre Vorlage anzupassen.

  4. Einige Zahlungsprozessoren haben sehr spezifische Anforderungen an das Erscheinungsbild sowie an die Zahlungsinformationen, die Teil des Dokuments sein müssen. Bei vielen Warenkörben kann die Anpassung der Dokumentenerstellung nicht ohne Überschreiben von Kerndateien erfolgen.

Note
 Die Dokumentenverarbeitung kann innerhalb der Connector-Konfiguration konfiguriert werden. Um sie auszuschalten, gehen Sie zu Space > Zahlung > Konfiguration > Connectors.

2Rendering-Prozess

Wenn wir das Dokument rendern, rendern wir es zunächst als HTML und konvertieren es dann in ein PDF und senden es an den Kunden.

3Dokumentvorlagen erstellen

Grundsätzlich haben Sie zwei Möglichkeiten. Sie erstellen entweder Ihre eigenen Dokumentvorlagen für Rechnungen, Lieferscheine usw. Oder Sie beginnen, die bestehenden Dateien zu überschreiben. In diesem Fall können Sie jedoch nur eine aktive Version für die verschiedenen Vorlagen verwenden. Mit anderen Worten, Sie können dann nur eine bestimmte Rechnungsvorlage, eine Lieferschein- vorlage usw. haben.

Wenn Sie jedoch internationalisieren oder einem bestimmten Connector eine andere Vorlage zuweisen möchten, müssen Sie beginnen, Vorlagen zu erstellen. Vorlagen können für alle Arten von verschiedenen Dokumenttypen unter Space > Anpassen > Dokumentvorlagen erstellt werden. Wenn Sie auf Dokument erstellen klicken, werden Sie gefragt, welchen Dokumenttyp Sie erstellen möchten. Je nach Typ können Sie zusätzliche Entitäten definieren. Wählen Sie im Ressourcen-Editor Ihre Vorlagendatei aus, die verwendet werden soll. Sobald die Vorlage erstellt ist, können Sie sie für Connectoren usw. verwenden.

Slack-Abonnement-Benachrichtigung
Figure 1. Erstellen Sie eine Dokumentvorlage in Ihrem Space unter Space > Anpassen > Dokumentvorlagen.

4Anpassung

Um die Kommunikation mit Ihren Kunden persönlicher zu gestalten, möchten Sie vielleicht die Vorlagen Ihrer Dokumente anpassen (zum Beispiel durch Hinzufügen eines Logos oder Ihres Firmendesigns). Sie können dies ganz einfach tun, indem Sie entweder Ihre Vorlage hochladen oder in den Ressourcen eine neue erstellen.

Die Vorlagen werden in der Sprache twig geschrieben. Nachfolgend finden Sie einige allgemeine Informationen darüber, wie Sie Ihre Dokumente anpassen können. Eine ausführlichere Dokumentation darüber, wie twig verwendet werden kann, finden Sie in unserer twig-Dokumentation.

4.1Ressourcenstruktur

Alle Ressourcen, die mit dem Erscheinungsbild von Dokumenten verbunden sind, finden Sie im document-Ordner im Ressourcen-Editor:

  • css-folder: Enthält alle CSS-Dateien, die zum Gestalten Ihrer Vorlagen verwendet werden. Wir verwenden eine spezifische .twig-Sprache, um die Dokumente zu gestalten.

  • fonts-folder: Im Fonts-Ordner können Sie spezifische Schriftarten speichern, die Sie auf Ihre Dokumente anwenden möchten (stellen Sie sicher, dass Sie die Verwendung innerhalb der CSS-Datei angeben).

  • images-folder: Enthält die Bilder für die Dokumente einschliesslich des Hintergrund-PDFs. Das Hintergrund-PDF enthält den statischen Hintergrund Ihres Dokuments. Die anderen Elemente werden auf dieses PDF gedruckt. Welcher Hintergrund verwendet wird, ist ebenfalls innerhalb der CSS-Datei angegeben.

  • template-folder: Der Template-Ordner enthält die .twig-Vorlage der Dokumente.

Note
 Wenn Sie Dateien hochladen, stimmen Sie ausdrücklich zu, dass Sie im Besitz der erforderlichen geistigen Eigentumsrechte sind, um die Dateien mit uns zu teilen. Wir garantieren Ihnen, dass auf die Ressourcen nur von Benutzern zugegriffen werden kann, die Zugriff auf Ihren Space haben.

4.2Gestaltungsoptionen speziell für Dokumente

Hier finden Sie einige nützliche allgemeine Informationen darüber, wie Sie Ihre Dokumente gestalten können. Eine ausführlichere Dokumentation darüber, wie twig verwendet werden kann, finden Sie in unserer twig-Dokumentation.

4.2.1Eigene Schriftarten in Dokumenten verwenden

Es ist möglich, spezifische Schriftarten in Ihren Vorlagen zu verwenden. Laden Sie dazu Ihre .ttf- Dateien in den Font-Ordner hoch und stellen Sie sicher, dass Sie die Dateien im CSS einbinden.

Hier ist ein Beispiel:

@font-face {
    font-family: "OpenSans";
    font-weight: normal;
    src: url('resource:/document/fonts/OpenSans-Regular.ttf');
    -fs-pdf-font-embed: embed;
    -fs-pdf-font-encoding: Identity-H;
}

4.2.2Dokument-Hintergrundvorlage ändern

Beim Erstellen des Dokuments drucken wir den dynamischen Inhalt über das Hintergrunddokument, das in der Datei /documents/css/base.css in Ihrem Space definiert ist. Die Vorlage wird für alle Dokumente verwendet.

@page {
	background-image: url('resource:/document/images/document-background.pdf');
	padding: 0;

	/* Border of the Document */
	margin:  30mm 10mm 20mm 10mm;
	size: A4;
}

Um das Dokument an Ihre Bedürfnisse anzupassen, können Sie entweder den Pfad hier ändern oder die Datei unter /document/images/document-background.pdf durch Ihre eigene Dokumentvorlage überschreiben. Es ist auch möglich, eine andere Vorlage für die erste und alle folgenden Seiten zu haben. Dazu müssen Sie den Selektor @page:first zu Ihrer base.css-Datei hinzufügen.

@page {
	background-image: url('resource:/document/images/document-background.pdf');
	padding: 0;

	/* Border of the Document */
	margin:  30mm 10mm 20mm 10mm;
	size: A4;
}

@page:first {
	background-image: url('resource:/document/images/first-document-background.pdf');
}

Dies verwendet die document-background.pdf für die folgenden Seiten und die first-document-background.pdf für die erste Seite.

4.2.3Variablen in den Vorlagen verwenden

Sie können Variablen in Ihren Vorlagendateien verwenden. Alle verfügbaren Variablen, die im jeweiligen Kontext verfügbar sind, werden im Ressourcen-Editor im unteren Tab angezeigt, einschliesslich einer Beschreibung der Variablen. Sie können die twig-Syntax verwenden, um diese Variablen zu interpretieren. Eine ausführlichere Dokumentation darüber, wie twig verwendet werden kann, finden Sie in unserer twig-Dokumentation.

Slack-Abonnement-Benachrichtigung
Figure 2. Die im Kontext verfügbaren Variablen werden in der unteren Leiste des Ressourcen-Editors angezeigt.