Zum Inhalt springen

Wiki-Quellcode von Einreichungswerbservice

Version 1.1 von MACH ProForms GmbH am 15.02.2021
Zeige letzte Bearbeiter
1 ## Standard-Webservice
2
3 Bei dieser Variante wird auf dem zugrundeliegenden Server innerhalb des zutreffenden Arbeitsverzeichnisses ein Ordner für den jeweiligen Assistenten angelegt. Innerhalb dieses Ordners wird je Transaktion ein weiteres Verzeichnis hinzugefügt, welches die zugehörigen Dateien (PDF, XML, FDF, weitere Metadaten) beinhaltet. Sollten Anlagen bei der Einreichung an den Webservice versendet werden, so werden diese ebenfalls entpackt gespeichert.
4
5 Mit dem Startparameter --single-folder werden alle Anträge direkt im ausführenden Ordner abgelegt. Anlagen werden hierbei nicht entpackt.
6
7 ### Nicht enthalten:
8
9 - Schreiben einer CSV-Datei
10 - Flattening der PDF-Dokumente
11
12 ___
13
14 ## Standard-Webservice mit flexibler CSV-Generierung
15
16 Bei dieser Variante wird für jeden Assistenten im zutreffenden Arbeitsverzeichnis ein Ordner angelegt, welcher keine weiteren Unterverzeichnisse enthält. Bei der Ablage der Dateien ist zu unterscheiden, ob es sich um eine Einreichung mit oder Anlagen handelt.
17
18 ### Einreichung ohne Anlagen
19
20 Für jede Einreichung wird das zugehörige PDF-Dokument sowie eine generierte CSV-Datei in der oben beschriebenen Ordnerstruktur abgelegt.
21
22 ### Einreichung mit Anlagen
23
24 Für jede Einreichung wird mindestens eine CSV-Datei erzeugt. Bei dieser Variante werden keine eingereichten PDF-Dokumente gespeichert, sondern ausschließlich die entpackten Anlagen der Einreichung. Der Dateiname der auf der Platte abgelegten Anlagen bildet sich wie folgt:
25
26 ```javascript
27 <Formularnummer\>-\<TransaktionsId\>-\<Anlagenname\>.
28 ```
29
30 Sollten mehrere Anlagen hochgeladen werden, so werden pro Anlage eine generierte CSV-Datei sowie die Anlage selbst gespeichert. Die Bildung des Dateinamens sieht wie folgt aus:
31
32 ```javascript
33 \<Formularnummer\>-\<Transaktionsid\>-\<Anlagennummer\>-\<Anlagenname\>, wobei der Platzhalter \<Anlagennummer\>
34 ```
35
36 entsprechend hochgezählt wird.
37
38 ### Aufbau der CSV-Datei
39
40 Die generierte CSV-Datei beinhaltet folgende Daten:
41 - Dateinamen der zugehörigen Anlage oder des zugehörigen PDF-Dokuments
42 - Alle im Antrag vorhandenen Felder. Hierbei kann die Reihenfolge der Felder über eine Konfigurationsdatei (Properties-Datei) durch den Administrator bestimmt und entsprechend angepasst werden. Die Konfigurationsdatei ist innerhalb des Ordners für den jeweiligen Assistenten unter dem Namen ```*"\<identifier\>.properties"*``` zu finden. Hierbei dient ```*"\<identifier\>"*``` als Platzhalter und repräsentiert den Namen des Assistenten. Ein exemplarischer Aufbau dieser Properties-Datei stellt sich wie folgt dar:
43
44 ```javascript
45 transId=01
46 fileUrl=02
47 Wie_hat_Ihnen_die_Präsentation_gefallen=03
48 input=04
49 staat=05
50 AS_PLZ=06
51 AS_Ort=07
52 AS_Bundesland=08
53 AS_Strasse=09
54 AS_Hausnummer=10
55 file=11
56 ```
57
58 > ***Hinweis:***
59 > Im obigen Beispiel repräsentiert der erste Wert die technische Bezeichnung, wodurch der zugehörige Wert die auftretende Reihenfolge in der CSV-Datei angibt.
60
61 ### Nicht enthalten:
62
63 - Eingangsdatum des Antrags
64 - Startparameter --single-folder entfällt
65 - kein Anlagenverzeichnis
66 - Es wird keine XML-Datei erzeugt
67
68 ___
69
70 ## Standard-Webserivce mit CSV-Generierung inklusive Anlagenverzeichnis
71
72 Bei dieser Variante wird für jeden Assistenten im entsprechenden Arbeitsverzeichnis ein Ordner angelegt, welcher keine weiteren Unterordner enthält. Bei einer Einreichung wird ein geflattetes PDF sowie eine generierte CSV-Datei gespeichert. Der Dateiname der generierten Dateien bildet sich wie folgt: Formularnummer + Transaktions-ID. Alle Einreichungen werden in einer flachen Hierarchie unterhalb des Ordners mit dem entsprechenden Assistentennamen abgelegt.
73
74 ### Aufbau der CSV-Datei
75
76 Die generierte CSV-Datei beinhaltet folgende Daten:
77
78 - Dateinamen des zugehörigen PDF-Dokuments
79 - Eingangsdatum der Einreichung
80
81 > ***Hinweis:***
82 > Bei dieser Variante kann die Reihenfolge der enthaltenen Felder nicht über eine Konfigurationsdatei (Properties-Datei) bestimmt werden.
83
84 > ***Besonderheit:***
85 > In der CSV-Datei werden insgesamt zehn Felder für die Anlagen vorgehalten. Diese Anlagen werden dann separat gespeichert. Die Verlinkung von der CSV-Datei zu den Anlagen findet über einen Pfad statt, welcher den Ablageort der entsprechende Anlage repräsentiert.
86
87 ### Nicht enthalten:
88
89 - Erzeugen eines XML-Files
90 - Möglichkeit der Sortierbarkeit der Anträge
91 - Startparameter --single-folder