Ä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.fweise
	1	+xwiki:XWiki.Dokumentation

Inhalt

...	...	@@ -4,7 +4,8 @@
4	4
5	5	![[Architekturskizze Submissionwebservice|@Submissionwebservice_architecture.svg]]
6	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.
	7	+***Hinweis:***
	8	+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	8
9	9	## Standard-Webservice
10	10
...	...	@@ -14,10 +14,10 @@
14	14
15	15	### Nicht enthalten:
16	16
17		-* Schreiben einer CSV-Datei
18		-* Flattening der PDF-Dokumente
	18	+- Schreiben einer CSV-Datei
	19	+- Flattening der PDF-Dokumente
19	19
20		----
	21	+___
21	21
22	22	## Standard-Webservice mit flexibler CSV-Generierung
23	23
...	...	@@ -29,13 +29,13 @@
29	29
30	30	### Einreichung mit Anlagen
31	31
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:
	33	+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:
33	33
34	34	```javascript
35	35	<Formularnummer\>-\<TransaktionsId\>-\<Anlagenname\>.
36	36	```
37	37
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:
	39	+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:
39	39
40	40	```javascript
41	41	\<Formularnummer\>-\<Transaktionsid\>-\<Anlagennummer\>-\<Anlagenname\>, wobei der Platzhalter \<Anlagennummer\>
...	...	@@ -45,11 +45,10 @@
45	45
46	46	### Aufbau der CSV-Datei
47	47
48		-Die generierte CSV-Datei beinhaltet folgende Daten:
	49	+Die generierte CSV-Datei beinhaltet folgende Daten:
	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:
49	49
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		-
53	53	```javascript
54	54	transId=01
55	55	fileUrl=02
...	...	@@ -64,18 +64,17 @@
64	64	file=11
65	65	```
66	66
67		-> _**Hinweis:**_
68		->
	67	+> ***Hinweis:***
69	69	> Im obigen Beispiel repräsentiert der erste Wert die technische Bezeichnung, wodurch der zugehörige Wert die auftretende Reihenfolge in der CSV-Datei angibt.
70	70
71	71	### Nicht enthalten:
72	72
73		-* Eingangsdatum des Antrags
74		-* Startparameter --single-folder entfällt
75		-* kein Anlagenverzeichnis
76		-* Es wird keine XML-Datei erzeugt
	72	+- Eingangsdatum des Antrags
	73	+- Startparameter --single-folder entfällt
	74	+- kein Anlagenverzeichnis
	75	+- Es wird keine XML-Datei erzeugt
77	77
78		----
	77	+___
79	79
80	80	## Standard-Webservice mit CSV-Generierung inklusive Anlagenverzeichnis
81	81
...	...	@@ -83,25 +83,25 @@
83	83
84	84	### Aufbau der CSV-Datei
85	85
86		-Die generierte CSV-Datei beinhaltet folgende Daten:
	85	+Die generierte CSV-Datei beinhaltet folgende Daten:
87	87
88		-* Dateinamen des zugehörigen PDF-Dokuments
89		-* Eingangsdatum der Einreichung
	87	+- Dateinamen des zugehörigen PDF-Dokuments
	88	+- Eingangsdatum der Einreichung
90	90
91		-> _**Hinweis:**_
92		->
	90	+> ***Hinweis:***
93	93	> Bei dieser Variante kann die Reihenfolge der enthaltenen Felder nicht über eine Konfigurationsdatei (Properties-Datei) bestimmt werden.
94	94
95		-> _**Besonderheit:**_
96		->
	93	+> ***Besonderheit:***
97	97	> 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.
98	98
99		-### Nicht enthalten:
	96	+### Nicht enthalten:
100	100
101		-* Erzeugen eines XML-Files
102		-* Möglichkeit der Sortierbarkeit der Anträge
103		-* Startparameter --single-folder
	98	+- Erzeugen eines XML-Files
	99	+- Möglichkeit der Sortierbarkeit der Anträge
	100	+- Startparameter --single-folder
104	104
105	105	## Support
	103	+Der Einreichungswebservice unterliegt nach Inbetriebnahme keiner weiteren Pflege durch Form-Solutions. Versionsänderungen, Funktionserweiterungen oder sonstige Supportanfragen sind daher kostenpflichtig und müssen gesondert beauftragt werden.
106	106
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.
	105	+
	106	+