Änderungen von Dokument Einreichungswebservice

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.Dokumentation
	1	+xwiki:XWiki.fweise

Inhalt

...	...	@@ -1,3 +1,11 @@
	1	+## Architekturskizze
	2	+
	3	+Bei jeder im Folgenden beschriebenen Variante des Webservices wird eine einheitliche Architektur verwendet. Da der Webservice derzeit ausschließlich über HTTP erreichbar ist, wird ein Reverse-Proxy benötigt, um die die Verschlüsselung der Daten zu gewährleisten. Nachfolgend wird die Kommunikationsstrecke vom Absenden eines Antrages bis hin zur Annahme und Weiterverarbeitung durch den Webservice visuell dargestellt.
	4	+
	5	+![[Architekturskizze Submissionwebservice|@Submissionwebservice_architecture.svg]]
	6	+
	7	+_**Hinweis:**_ Bei der Kommunikation vom Formularserver in das interne Netzwerk wird standardmäßig der SSL-Port 443 verwendet. Die interne Weiterleitung des Reverse-Proxies an den Webservice erfolgt auf den Port, welcher bei der Installation des Webservices angegeben wurde.
	8	+
1	1	## Standard-Webservice
2	2
3	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.
...	...	@@ -6,10 +6,10 @@
6	6
7	7	### Nicht enthalten:
8	8
9		-- Schreiben einer CSV-Datei
10		-- Flattening der PDF-Dokumente
	17	+* Schreiben einer CSV-Datei
	18	+* Flattening der PDF-Dokumente
11	11
12		-___
	20	+---
13	13
14	14	## Standard-Webservice mit flexibler CSV-Generierung
15	15
...	...	@@ -21,13 +21,13 @@
21	21
22	22	### Einreichung mit Anlagen
23	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:
	32	+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	25
26	26	```javascript
27	27	<Formularnummer\>-\<TransaktionsId\>-\<Anlagenname\>.
28	28	```
29	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:
	38	+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	31
32	32	```javascript
33	33	\<Formularnummer\>-\<Transaktionsid\>-\<Anlagennummer\>-\<Anlagenname\>, wobei der Platzhalter \<Anlagennummer\>
...	...	@@ -37,10 +37,11 @@
37	37
38	38	### Aufbau der CSV-Datei
39	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:
	48	+Die generierte CSV-Datei beinhaltet folgende Daten:
43	43
	50	+* Dateinamen der zugehörigen Anlage oder des zugehörigen PDF-Dokuments
	51	+* 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:
	52	+
44	44	```javascript
45	45	transId=01
46	46	fileUrl=02
...	...	@@ -55,17 +55,18 @@
55	55	file=11
56	56	```
57	57
58		-> ***Hinweis:***
	67	+> _**Hinweis:**_
	68	+>
59	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	60
61	61	### Nicht enthalten:
62	62
63		-- Eingangsdatum des Antrags
64		-- Startparameter --single-folder entfällt
65		-- kein Anlagenverzeichnis
66		-- Es wird keine XML-Datei erzeugt
	73	+* Eingangsdatum des Antrags
	74	+* Startparameter --single-folder entfällt
	75	+* kein Anlagenverzeichnis
	76	+* Es wird keine XML-Datei erzeugt
67	67
68		-___
	78	+---
69	69
70	70	## Standard-Webservice mit CSV-Generierung inklusive Anlagenverzeichnis
71	71
...	...	@@ -73,22 +73,25 @@
73	73
74	74	### Aufbau der CSV-Datei
75	75
76		-Die generierte CSV-Datei beinhaltet folgende Daten:
	86	+Die generierte CSV-Datei beinhaltet folgende Daten:
77	77
78		-- Dateinamen des zugehörigen PDF-Dokuments
79		-- Eingangsdatum der Einreichung
	88	+* Dateinamen des zugehörigen PDF-Dokuments
	89	+* Eingangsdatum der Einreichung
80	80
81		-> ***Hinweis:***
	91	+> _**Hinweis:**_
	92	+>
82	82	> Bei dieser Variante kann die Reihenfolge der enthaltenen Felder nicht über eine Konfigurationsdatei (Properties-Datei) bestimmt werden.
83	83
84		-> ***Besonderheit:***
	95	+> _**Besonderheit:**_
	96	+>
85	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	86
87		-### Nicht enthalten:
	99	+### Nicht enthalten:
88	88
89		-- Erzeugen eines XML-Files
90		-- Möglichkeit der Sortierbarkeit der Anträge
91		-- Startparameter --single-folder
	101	+* Erzeugen eines XML-Files
	102	+* Möglichkeit der Sortierbarkeit der Anträge
	103	+* Startparameter --single-folder
92	92
	105	+## Support
93	93
94		-
	107	+Der Einreichungswebservice unterliegt nach Inbetriebnahme keiner weiteren Pflege durch MACH ProForms. Versionsänderungen, Funktionserweiterungen oder sonstige Supportanfragen sind daher kostenpflichtig und müssen gesondert beauftragt werden.