Wiki-Quellcode von Vorbefüllung von Assistenten
Zuletzt geändert von Form-Solutions GmbH am 25.01.2024
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | [[Veröffentlichte Assistenten|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] können zum Startzeitpunkt bereits (teil-)vorbefüllt werden. Hierzu steht dem Ersteller des Assistenten die Möglichkeit einer Vorbefüllung über einen Context-Identifier, eine Vorbefüllung mittels einer Expertenregel oder per eID. | ||
2 | |||
3 | ## Vorbefüllung mit Standardparameter (ohne Context Identifier) | ||
4 | |||
5 | Zum einen können einige Standardparameter übergeben werden, die bei Verwendung von Standardassistenten oder Assistenten mit verknüpften Standardobjekten die entsprechenden Felder des Antragstellers vorbefüllen: | ||
6 | |||
7 | * Titel | ||
8 | * FirstName | ||
9 | * LastName | ||
10 | * BirthName | ||
11 | * BirthPlace | ||
12 | * DateOfBirth | ||
13 | * Nationality | ||
14 | * Street | ||
15 | * StreetNumber | ||
16 | * ZipCode | ||
17 | * City | ||
18 | * Phone | ||
19 | * Telefax | ||
20 | |||
21 | |||
22 | Hierzu muss lediglich in der Komponente der Contextidentifier hinterlegt sein. Die "Standardparameter" dienen dann als "Kurzversion" vom CI-Objektpfad. Also "?FirstName=Test" statt "?Antragsteller.Daten.AS_Name1.AS_Name1.AS_Vorname=Test". | ||
23 | |||
24 | --- | ||
25 | |||
26 | ## Vorbefüllung über einen Context Identifier (Übergabe per GET) | ||
27 | |||
28 | Hat sich der Ersteller dafür entschieden einen Assistenten mittels Context-Identifier vorbefüllen zu lassen, müssen die zu befüllenden Komponenten im Assistenten mit einem „[[Context-Identifier|Main.05_Assistenten.04_Assistentenbauoberfläche.04_KonfigurationvonKomponenten]]“ versehen werden. Nach der Erstellung des Assistenten muss dann nur noch der Übergabeparameter an den veröffentlichten Link angehängt werden. | ||
29 | |||
30 | Ein Übergabeparameter besteht aus folgenden Elementen: | ||
31 | |||
32 | * **Context-Identifier:** | ||
33 | Zum Beispiel „Antragsteller/Daten“ | ||
34 | * **Feldbezeichnungen einer Feldhierarchie:** | ||
35 | AS_Adresse (Verknüpfungsname), AS_Adresse (Objektgruppenname), Adresse (Autovervollständigungsgruppennamen), AS_PLZ („Bezeichnung technisch“ der Komponente) | ||
36 | |||
37 | Diese werden jeweils mit einem „Punkt“ verbunden. Daraus ergibt sich z. B. der folgende Vorbefüllungsparameter: **Antragsteller.Daten.AS_Adresse.AS_Adresse.Adresse.AS_PLZ=76137** | ||
38 | |||
39 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
40 | |||
41 | 1. Um eine korrekte Übergabe von Sonderzeichen zu gewährleisten, müssen die Feldwerte url-encodiert übergeben werden. | ||
42 | 1. Hier können die Parameter beim Aufruf durch den Anwender verändert werden. | ||
43 | |||
44 | |||
45 | |||
46 | ![[Ansicht der Vorbefüllung im Assistenten|@VorbefüllungAssistent.jpg]] | ||
47 | |||
48 | ### Befüllen weniger Felder | ||
49 | |||
50 | Sollen nur ein bis zwei Komponenten vorbefüllt werden, kann der Link zum Assistenten um entsprechende Parameter ergänzt werden. | ||
51 | **Zum Beispiel bei einem Ausgangslink der folgenden Form:** | ||
52 | <https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490> | ||
53 | |||
54 | **Ergibt sich folgender Link mit Vorbefüllung:** | ||
55 | <https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490?Antragsteller.Daten.AS_Adresse.AS_Adresse.Adresse.AS_PLZ=76137> | ||
56 | |||
57 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
58 | > | ||
59 | > Hier können die Parameter beim Aufruf durch den Anwender verändert werden. | ||
60 | |||
61 | ### Befüllen mehrerer Felder | ||
62 | |||
63 | Für jede zu befüllende Komponente muss entsprechend ein Context-Identifier gesetzt werden. Sollen nun statt einer Komponente, mehrere Komponenten vorbefüllt werden, muss der Link mit den Feldbezeichnungen entsprechend der Feldhierarchie ergänzt werden. Das sieht z. B. wie folgt aus | ||
64 | |||
65 | **Originallink des Assistenten:** | ||
66 | <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978> | ||
67 | |||
68 | **Parameter1:** | ||
69 | Antragsteller.Vorname.Vorname=Max | ||
70 | |||
71 | **Parameter2:** | ||
72 | Antragsteller.Familienname.Nachname=Mustermann | ||
73 | |||
74 | **Ergibt:** | ||
75 | <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978?Antragsteller.Vorname.Vorname=Max&Antragsteller.Familienname.Nachname=Mustermann> | ||
76 | |||
77 | Die Parameter setzen sich wie folgt zusammen (Beispiel Parameter1): | ||
78 | |||
79 | | Context Identifier | Bezeichnung technisch | Wert | | ||
80 | | --------------------- | --------------------- | ---- | | ||
81 | | Antragsteller.Vorname | Vorname | Max | | ||
82 | |||
83 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
84 | > | ||
85 | > Um bei der Befüllung mittels einem Link ein Leerzeichen zwischen zwei Werte zu setzen, muss das Zeichen "+" gesetzt werden. Dies würde dann wie folgt beispielsweise aussehen <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978?Antragsteller.Vorname.Vorname=Max&Antragsteller.Daten.Ort=Karlsruhe+Rheinhafen> | ||
86 | |||
87 | --- | ||
88 | |||
89 | ## Vorbefüllung durch Expertenregel | ||
90 | |||
91 | Sofern sich der Ersteller eines Assistenten dazu entschließt einen Assistenten, ohne einen Context-Identifier vorbefüllen zu lassen, muss dieser folgenden [[Expertenregel|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.04_Expertenmodus]] an der entsprechenden Stelle im Assistenten hinterlegen: | ||
92 | |||
93 | ```javascript | ||
94 | package de.formsolutions.metaform | ||
95 | import de.formsolutions.metaform.model.* | ||
96 | import java.util.Map; | ||
97 | |||
98 | rule "<Eindeutige Bezeichnung für die Regel>" | ||
99 | when | ||
100 | $requestParameters : Map() | ||
101 | then | ||
102 | if($requestParameters.get("<URL-PARAMETER>") != null) { | ||
103 | String parameterValue = ((String[]) $requestParameters.get("<URL-Parameter>"))[0]; | ||
104 | System.out.println(parameterValue); | ||
105 | } | ||
106 | end | ||
107 | package de.formsolutions.metaform | ||
108 | import de.formsolutions.metaform.model.* | ||
109 | import java.util.Map; | ||
110 | |||
111 | |||
112 | rule "<REGELNAME>" | ||
113 | when | ||
114 | $requestParameters : Map() | ||
115 | Panel(identifier=="<PANELNAME>", $VARIABLENNAME:getInputComponent("KOMPONENTENNAMEN"), $cVARIABLENNAME != null) | ||
116 | then | ||
117 | if($requestParameters.get("TestKomponente") != null) { | ||
118 | String parameterValue = ((String[]) $requestParameters.get("KOMPONENTENNAMEN"))[0]; | ||
119 | $c0.setStringValue(parameterValue); | ||
120 | } | ||
121 | end | ||
122 | ``` | ||
123 | |||
124 | Der Übergabeparameter würde dann wie folgt aussehen: <https://pdf.form-solutions.net/../../..?KOMPONENTENNAMEN=BEISPIELWERT> | ||
125 | |||
126 | --- | ||
127 | |||
128 | ## Zweistufige Übergabe (Postdata) | ||
129 | |||
130 | Beim zweistufigen Vorbefüllen von Ausfüllassistenten können sehr viele Daten ohne Beeinträchtigung des Anwenderkomforts übergeben werden. Eine ausführliche Beschreibung finden Sie in der Admindokumentation unter "Form-Solutions Schnittstellen/Steuerungsprozess/Vorbefüllung/Postdata". | ||
131 | |||
132 | --- | ||
133 | |||
134 | ## REST-Schnittstelle zur Übergabe von Authentifizierungsdaten (Portal, ServiceKontoNRW, ...) | ||
135 | |||
136 | Um eine Vorab-Authentifizierung für einen Antragsassistenten durch ein Portal durchzuführen, müssen sowohl die Benutzer-/Antragstellerdaten, als auch das verifizierte Vertrauens-Niveau) gesichert übergeben werden. Eine ausführliche Beschreibung finden Sie in der Admindokumentation unter "Form-Solutions Schnittstellen/Steuerungsprozess/Vorbefüllung/SecurePostdata". | ||
137 | |||
138 | --- | ||
139 | |||
140 | ## Vorbefüllung durch eID (nPA) | ||
141 | |||
142 | Eine weitere Möglichkeit der Vorbefüllung von Daten in einem Assistenten kann mit der Hilfe des elektronischen Personalausweis [[(eID)|Main.07_Einstellungen-Fachadministration.03_Module.05_eID]] ermöglicht werden. Hierbei werden die entsprechenden Daten, die sich auf dem elektronischen Personalausweis befinden, direkt beim Start des Assistenten in die Felder vorbefüllt. Hierzu muss bei der Konfiguration der [[Veröffentlichungsparameter|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] des Assistenten die Auswahl „NPA-Nutzung“ auf „Ja“ oder „Optional“ ausgewählt werden. Weiterhin müssen im Assistentenbau | ||
143 | |||
144 | * die entsprechen Komponenten aus der Bibliothek verwendet oder | ||
145 | * eine direkte Zuweisung der Vorbefüllung in der Konfiguration der Komponente hinterlegt werden. | ||
146 | |||
147 | Folgende Komponentengruppen können aus der Standardbibliothek verwendet werden, die durch eine bereits hinterlegte "Zuweisung der Vorbefüllung" mit der eID Funktion vorbefüllt werden: | ||
148 | |||
149 | | Bibliothekselement | Objektpfad Bezeichnung technisch | | ||
150 | | ----------------------------------- | ------------------------------------------------------- | | ||
151 | | Briefanrede | AS_Anrede | | ||
152 | | Vor- / Familienname | AS_Name1.AS_Name1.AS_Vorname | | ||
153 | | Vor- / Familienname | AS_Name1.AS_Name1.AS_Name | | ||
154 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_Vorname | | ||
155 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_Name | | ||
156 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_GebName | | ||
157 | | Geburtsdaten (ohne Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
158 | | Geburtsdaten (ohne Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
159 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
160 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
161 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit | | ||
162 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
163 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
164 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit | | ||
165 | | Adresse (HausNr. Getrennt)e | AS_Adresse.AS_Adresse.Adresse.AS_PLZ | | ||
166 | | Adresse (HausNr. Getrennt) | AS_Adresse.AS_Adresse.Adresse.AS_Ort | | ||
167 | | Adresse (HausNr. Getrennt) | AS_Adresse.AS_Adresse.Adresse.AS_Strasse | | ||
168 | | Adresse (HausNr. Getrennt)e | AS_Adresse.AS_Adresse.Adresse.AS_Hausnummer | | ||
169 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_PLZ | | ||
170 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_Ort | | ||
171 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_Strasse | | ||
172 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon | | ||
173 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax | | ||
174 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail | | ||
175 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon | | ||
176 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax | | ||
177 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail | | ||
178 | |||
179 | --- | ||
180 | |||
181 | ## Vorbefüllung mit Benutzerdatensätzen | ||
182 | |||
183 | Zusätzlich zu der Vorbefüllung mittels des elektronischen Personalausweises kann ein Assistent mit den [[Benutzerdatensätzen|Main.07_Einstellungen-Fachadministration.02_Benutzer]] des veröffentlichten Sachbearbeiters vorbefüllt werden. Hierzu müssen die [[Komponenten|Main.05_Assistenten.04_Assistentenbauoberfläche.04_KonfigurationvonKomponenten]] entsprechend benamt und mit einem Context Identifier versehen werden. Die Daten werden auch in das PDF-Formular übernommen. | ||
184 | |||
185 | Folgende Felder werden befüllt und müssen dementsprechend benannt werden: | ||
186 | |||
187 | | Bibliothekselement | Ausführliche Benamung | Context Identifier | | ||
188 | | ------------------ | --------------------------------------------------------------- | ------------------ | | ||
189 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_E-Mail-Adresse | SB.Daten | | ||
190 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Benachrichtigungsadresse | SB.Daten | | ||
191 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefax | SB.Daten | | ||
192 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Name | SB.Daten | | ||
193 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Personalnummer | SB.Daten | | ||
194 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefon | SB.Daten | | ||
195 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Zimmernummer | SB.Daten | | ||
196 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Amt/Abteilung | SB.Daten | | ||
197 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_Ort | SB.Daten | | ||
198 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_PLZ | SB.Daten | | ||
199 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Straße/Postfach | SB.Daten | | ||
200 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Aktenzeichen | SB.Daten | | ||
201 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_einzeilig | SB.Daten | | ||
202 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_klein | SB.Daten | | ||
203 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_groß | SB.Daten | | ||
204 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_Ort | SB.Daten | | ||
205 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_PLZ | SB.Daten | | ||
206 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Absender | SB.Daten | | ||
207 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Empfänger | SB.Daten | | ||
208 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Kopfzeile | SB.Daten | | ||
209 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_einzeilig | SB.Daten | | ||
210 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_zweizeilig | SB.Daten | | ||
211 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Rechtsbehelfsbelehrung | SB.Daten | | ||
212 | |||
213 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
214 | > | ||
215 | > In der [[Standard-Bibliothek|Main.05_Assistenten.04_Assistentenbauoberfläche.03_Bibliothek]] stehen hierzu bereits vorkonfigurierte Bausteine zur Verfügung. |