Version 2.1 von MACH ProForms GmbH am 11.10.2021

Zeige letzte Bearbeiter
1 ## Datenübergabe über E-Mail (Attachements oder HTTPS)
2
3 Die Standardübermittlung der Formularinhaltsdaten erfolgt per E-Mail. Hierbei wird zusätzlich zwischen einer sicheren und unsicheren Übertragung unterschieden. Bei der sicheren Übertragung (Parameter im veröffentlichten Link `send=1`) wird an die in der Datenbank definierte E-Mail-Adresse eine E-Mail versendet, welche drei bzw. vier Verweise zu den Inhaltsdaten im PDF-, XML, FDF, und ZIP-Format enthält. Zur automatischen Übernahme dieser Daten können diese Verweise ausgelesen und in den Link der Username und das Passwort eingetragen werden (Htaccess-Vefahren). Bei unsicheren E-Mails werden die Formulardaten in den Anhang der E-Mail beigelegt. Diese können demnach direkt vom System oder User übernommen werden.
4
5 ### Beispiel für Zustellung über E-Mail:
6
7 Inbox (Verzeichnis eingegangener Formulare)
8 <https://pdf.form-solutions.net/jmp.php?inb=YWVqRnZydnM=>
9
10 PDF-Formular (Direktstart)
11 <https://pdf.form-solutions.net/cust/22222222-2222_formsolutions/process/010040-aejFvrvs.pdf>
12
13 XML-Datensatz
14 <https://pdf.form-solutions.net/cust/22222222-2222_formsolutions/process/010040-aejFvrvs.xml>
15
16 Anlagen
17 <https://pdf.form-solutions.net/cust/22222222-2222_formsolutions/process/010040-aejFvrvs_attachments.zip>
18
19 Benutzername und Passwort
20 <https://Mustermann:Passwort@pdf.form-solutions.net/cust/22222222-2222_formsolutions/process/010040-aejFvrvs.pdf>
21
22 ### Datenabholung über das Mail/CMS-Key Verfahren
23
24 Zur automatisierten Abholung hat der Formularserver zum oben beschriebenen Abholverfahren mit Htaccess-Vefahren ein alternatives Verfahren namens Mail/CMS-Key entwickelt. Dazu muss das entsprechende System die Vorgangs-ID ermitteln. Mittels dieser ID und dem CMS-Key wird anschließend ein entsprechendes Servlet aufgerufen. Für dieses Verfahren ist der Besitz eines CMS-Keys, den Sie von Form-Solutions erhalten, Voraussetzung.
25
26 #### Beispiel:
27
28 <https://pdf.form-solutions.net/servlet/FileDownload?cmskey=22222222-2222js&templatename=010040-aejFvrvs.pdf&d=1>
29 (Öffnet das PDF-Formular im Browser)
30
31 #### Übergabeparameter:
32
33 - **cmskey**<br/>
34 Eindeutiger Schlüssel des Kunden, erhält er von Form-Solutions
35
36 - **templatename**<br/>
37 Vorgangs-ID (aus Mail geparst) incl. der Dateiendung. Die Dateiendung wird benötigt, weil sonst keine Datei abgeholt werden kann.
38
39 - **d**<br/>
40 Angabe, ob im Browser oder nur herunterladen angeboten werden soll, `d=1` im Browser
41 öffnen, `d=0` herunterladen.
42
43 Rückgabe: Die jeweilige Datei entweder im Browser oder als Download. Für jede Datei muss der Aufruf separat durchgeführt werden.
44
45 ___
46
47 ## Datenübergabe via Webservice
48
49 Alternativ zur Datenübertragung über E-Mail wird vom Formularserver die Übertragung der Formularinhaltsdaten via Webservice an eine beliebige URL angeboten.
50
51 **Notwendige Einstellung:**
52
53 1. Empfänger-URL muss in der Oberfläche des Formularservers oder im Link als Parameter beim Formularaufruf angegeben werden<br/>
54 (`&ofsXX1_to_smail3=http://...`)
55
56 2. Sendeparameter für den Webservice (`&send=8`)
57
58 **Optionale Einstellungen:**
59
60 1. Weiterleitung auf eine bestimmte URL - Parameter: `webserviceRedirect`, der Wert ist URL-encdoed zu übergeben
61 2. Abschaltung Anlagenhandling: `anzahlAnlagen=keine`
62
63 Der zu implementierende Webservice muss dabei die Methode `getFormularInhaltsdaten(String pdffields[], String files[])` mit einem Rückgabewert vom Typ `boolean` (` true`/`false `) zur Verfügung stellen.
64
65 In `pdf-Fields` sind die folgenden Werte aus dem Formular enthalten:
66
67 - **userID**<br/>
68 Benutzernummer
69 z.B. 22222222-2222-0000
70
71 - **ofsXX1_knr_std**<br/>
72 Kundennummer
73
74 - **b12c96nfBehoerde_Amt**<br/>
75 Amt des Benutzers,<br/>
76 z.B. Medienbüro, Finanzamt
77
78 - **b12c96nfBehoerde_Strasse**<br/>
79 Straßenname der Behördenanschrift
80
81 - **b12c96nfBehoerde_PLZ_Ort**<br/>
82 PLZ, Ort der Behördenanschrift,<br/>
83 z.B. 75217 Birkenfeld
84
85 - **b12c96nfBehoerde_Sachbearbeiter_Name**<br/>
86 Name des Sachbearbeiters
87
88 - **b12c96nfSachbearbeiter_Zimmernummer**<br/>
89 Zimmernummer des Sachbearbeiters
90
91 - **b12c96nfSachbearbeiter_Telefon**<br/>
92 Telefonnummer des Sachbearbeiters
93
94 - **b12c96nfSachbearbeiter_Telefax**<br/>
95 Telefax des Sachbearbeiters
96
97 - **b12c96nfSachbearbeiter_E_Mail**<br/>
98 E-Mail-Adresse des Sachbearbeiters
99
100 - **b12c96nfAntragsteller_Name**<br/>
101 Name / Nachname des Antragstellers
102
103 - **b12c96nfAntragsteller_Vorname**<br/>
104 Vorname des Antragstellers
105
106 - **b12c96nfAntragsteller_Strasse**<br/>
107 Straße des Antragstellers - Wohnortes
108
109 - **b12c96nfAntragsteller_PLZ**<br/>
110 Postleitzahl des Antragstellers – Wohnortes
111
112 - **b12c96nfAntragsteller_Ort**<br/>
113 Ortsname des Antragstellers – Wohnortes
114
115 - **b12c96nfAntragsteller_E_Mail**<br/>
116 E-Mail-Adresse des Antragstellers
117
118 - **AS_Telefon**<br/>
119 Telefonnummer des Antragstellers
120
121 - **AS_Telefax**<br/>
122 Telefaxnummer des Antragstellers
123
124 Jedes Formularfeld entspricht dabei einem Eintrag in dem Array. Sollte ein Formularfeld nicht befüllt sein, so wird hierfür ein leerer String verwendet. `Files` enthält die Dateien, `pdf`, `fdf`, `xml` und wenn vorhanden auch `zip`. Die Daten sind dabei jeweils base64-codiert.