Ä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

...	...	@@ -4,8 +4,7 @@
4	4
5	5	![[Architekturskizze Submissionwebservice|@Submissionwebservice_architecture.svg]]
6	6
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.
	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.
9	9
10	10	## Standard-Webservice
11	11
...	...	@@ -15,10 +15,10 @@
15	15
16	16	### Nicht enthalten:
17	17
18		-- Schreiben einer CSV-Datei
19		-- Flattening der PDF-Dokumente
	17	+* Schreiben einer CSV-Datei
	18	+* Flattening der PDF-Dokumente
20	20
21		-___
	20	+---
22	22
23	23	## Standard-Webservice mit flexibler CSV-Generierung
24	24
...	...	@@ -30,13 +30,13 @@
30	30
31	31	### Einreichung mit Anlagen
32	32
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:
	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:
34	34
35	35	```javascript
36	36	<Formularnummer\>-\<TransaktionsId\>-\<Anlagenname\>.
37	37	```
38	38
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:
	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:
40	40
41	41	```javascript
42	42	\<Formularnummer\>-\<Transaktionsid\>-\<Anlagennummer\>-\<Anlagenname\>, wobei der Platzhalter \<Anlagennummer\>
...	...	@@ -46,10 +46,11 @@
46	46
47	47	### Aufbau der CSV-Datei
48	48
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:
	48	+Die generierte CSV-Datei beinhaltet folgende Daten:
52	52
	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,17 +64,18 @@
64	64	file=11
65	65	```
66	66
67		-> ***Hinweis:***
	67	+> _**Hinweis:**_
	68	+>
68	68	> Im obigen Beispiel repräsentiert der erste Wert die technische Bezeichnung, wodurch der zugehörige Wert die auftretende Reihenfolge in der CSV-Datei angibt.
69	69
70	70	### Nicht enthalten:
71	71
72		-- Eingangsdatum des Antrags
73		-- Startparameter --single-folder entfällt
74		-- kein Anlagenverzeichnis
75		-- 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
76	76
77		-___
	78	+---
78	78
79	79	## Standard-Webservice mit CSV-Generierung inklusive Anlagenverzeichnis
80	80
...	...	@@ -82,25 +82,25 @@
82	82
83	83	### Aufbau der CSV-Datei
84	84
85		-Die generierte CSV-Datei beinhaltet folgende Daten:
	86	+Die generierte CSV-Datei beinhaltet folgende Daten:
86	86
87		-- Dateinamen des zugehörigen PDF-Dokuments
88		-- Eingangsdatum der Einreichung
	88	+* Dateinamen des zugehörigen PDF-Dokuments
	89	+* Eingangsdatum der Einreichung
89	89
90		-> ***Hinweis:***
	91	+> _**Hinweis:**_
	92	+>
91	91	> Bei dieser Variante kann die Reihenfolge der enthaltenen Felder nicht über eine Konfigurationsdatei (Properties-Datei) bestimmt werden.
92	92
93		-> ***Besonderheit:***
	95	+> _**Besonderheit:**_
	96	+>
94	94	> 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.
95	95
96		-### Nicht enthalten:
	99	+### Nicht enthalten:
97	97
98		-- Erzeugen eines XML-Files
99		-- Möglichkeit der Sortierbarkeit der Anträge
100		-- Startparameter --single-folder
	101	+* Erzeugen eines XML-Files
	102	+* Möglichkeit der Sortierbarkeit der Anträge
	103	+* Startparameter --single-folder
101	101
102	102	## 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.
104	104
105		-
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.