Wiki-Quellcode von Vorbefüllung von Assistenten
Zuletzt geändert von MACH formsolutions am 08.09.2025
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 | ||
4 | |||
5 | ![[1757353843365-988.png|1757353843365-988.png]] | ||
6 | |||
7 | 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. Die Werte in Hochkommata sind die zu nutzenden Werte - Beispiel: _?Titel=Herr_ | ||
8 | |||
9 | | ---------------------------------------------------------- | ------------------------------- | | ||
10 | | **Technischer Bezeichner / Parameter** | **Vorbefüllung Assistentenbau** | | ||
11 | | ACADEMIC_TITLE("AcademicTitle"), | Akademischer Titel | | ||
12 | | TITLE("Titel"), | Anrede | | ||
13 | | COMPANY_NAME_PHYSICAL_PERSON("CompanyNamePhysicalPerson"), | Betriebsname | | ||
14 | | EMAIL("Email"), | E-Mail | | ||
15 | | ADDRESS_SUPPLEMENT("AddressSupplement"), | Adressierungszusaetze | | ||
16 | | TELEFAX("Telefax"), | Fax Nr. | | ||
17 | | DAY_OF_BIRTH("DateOfBirth"), | Geburtsdatum | | ||
18 | | BIRTH_NAME("BirthName"), | Geburtsname | | ||
19 | | BIRTH_PLACE("BirthPlace"), | Geburtsort | | ||
20 | | STREET_NUMBER("StreetNumber"), | Hausnummer | | ||
21 | | LAST_NAME("LastName"), | Name | | ||
22 | | ADDRESS_LOCALITY_PART("CompanyAddressPartOfLocality"), | Ortsteil | | ||
23 | | TYPE_OF_LEGAL_PERSON("TypeOfLegalPerson"), | Personentyp | | ||
24 | | ZIP("ZipCode"), | PLZ | | ||
25 | | POSTKORB_ID("PostkorbId"), | Postkorb-ID | | ||
26 | | LEGAL_FORM("LegalForm"), | Rechtsform | | ||
27 | | LEGAL_FORM_TEXT("LegalFormText"), | Rechtsform in Textform | | ||
28 | | REGISTER_TYPE("RegisterType"), | Registerart | | ||
29 | | REGISTER_COURT("RegisterCourt"), | Registergericht | | ||
30 | | REGISTER_NUMBER("RegisterNumber"), | Registernummer | | ||
31 | | NATIONALITY("Nationality"), | Staatsangehörigkeit | | ||
32 | | STREET("Street"), | Straße | | ||
33 | | PHONE("Phone"), | Telefon Nr. | | ||
34 | | OCCUPATION("Occupation"), | Tätigkeit | | ||
35 | | OCCUPATION_TEXT("OccupationText"), | Tätigkeit in Textform | | ||
36 | | COMPANY_NAME("CompanyName"), | Unternehmensname | | ||
37 | | STORK_QAA_LEVEL("StorkQaaLevel"), | Vertrauensniveau | | ||
38 | | FIRST_NAME("FirstName"), | Vorname | | ||
39 | | COUNTRY("Country"), | Land | | ||
40 | | PLACE("City"); | Ort | | ||
41 | |||
42 | 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". | ||
43 | |||
44 | --- | ||
45 | |||
46 | ## Vorbefüllung über einen Context-Identifier | ||
47 | |||
48 | ![[1757353961928-369.png|1757353961928-369.png]] | ||
49 | |||
50 | 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. | ||
51 | |||
52 | Ein Übergabeparameter besteht aus folgenden Elementen: | ||
53 | |||
54 | * **Context-Identifier:** | ||
55 | Zum Beispiel „Antragsteller/Daten“ | ||
56 | * **Feldbezeichnungen einer Feldhierarchie:** | ||
57 | AS_Adresse (Verknüpfungsname), AS_Adresse (Objektgruppenname), Adresse (Autovervollständigungsgruppennamen), AS_PLZ („Bezeichnung technisch“ der Komponente) | ||
58 | |||
59 | 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** | ||
60 | |||
61 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
62 | |||
63 | 1. Um eine korrekte Übergabe von Sonderzeichen zu gewährleisten, müssen die Feldwerte url-encodiert übergeben werden. | ||
64 | 1. Hier können die Parameter beim Aufruf durch den Anwender verändert werden. | ||
65 | |||
66 | ![[Ansicht der Vorbefüllung im Assistenten|@VorbefüllungAssistent.jpg]] | ||
67 | |||
68 | ### Befüllen weniger Felder | ||
69 | |||
70 | Sollen nur ein bis zwei Komponenten vorbefüllt werden, kann der Link zum Assistenten um entsprechende Parameter ergänzt werden. | ||
71 | **Zum Beispiel bei einem Ausgangslink der folgenden Form:** | ||
72 | <https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490> | ||
73 | |||
74 | **Ergibt sich folgender Link mit Vorbefüllung:** | ||
75 | <https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490?Antragsteller.Daten.AS_Adresse.AS_Adresse.Adresse.AS_PLZ=76137> | ||
76 | |||
77 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
78 | > | ||
79 | > Hier können die Parameter beim Aufruf durch den Anwender verändert werden. | ||
80 | |||
81 | ### Befüllen mehrerer Felder | ||
82 | |||
83 | 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 | ||
84 | |||
85 | **Originallink des Assistenten:** | ||
86 | <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978> | ||
87 | |||
88 | **Parameter1:** | ||
89 | Antragsteller.Vorname.Vorname=Max | ||
90 | |||
91 | **Parameter2:** | ||
92 | Antragsteller.Familienname.Nachname=Mustermann | ||
93 | |||
94 | **Ergibt:** | ||
95 | <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978?Antragsteller.Vorname.Vorname=Max&Antragsteller.Familienname.Nachname=Mustermann> | ||
96 | |||
97 | Die Parameter setzen sich wie folgt zusammen (Beispiel Parameter1): | ||
98 | |||
99 | | Context Identifier | Bezeichnung technisch | Wert | | ||
100 | | --------------------- | --------------------- | ---- | | ||
101 | | Antragsteller.Vorname | Vorname | Max | | ||
102 | |||
103 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
104 | > | ||
105 | > 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> | ||
106 | |||
107 | --- | ||
108 | |||
109 | ## Vorbefüllung durch Expertenregel | ||
110 | |||
111 | 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: | ||
112 | |||
113 | ```javascript | ||
114 | package de.formsolutions.metaform | ||
115 | import de.formsolutions.metaform.model.* | ||
116 | import java.util.Map; | ||
117 | |||
118 | rule "<Eindeutige Bezeichnung für die Regel>" | ||
119 | when | ||
120 | $requestParameters : Map() | ||
121 | then | ||
122 | if($requestParameters.get("<URL-PARAMETER>") != null) { | ||
123 | String parameterValue = ((String[]) $requestParameters.get("<URL-Parameter>"))[0]; | ||
124 | System.out.println(parameterValue); | ||
125 | } | ||
126 | end | ||
127 | package de.formsolutions.metaform | ||
128 | import de.formsolutions.metaform.model.* | ||
129 | import java.util.Map; | ||
130 | |||
131 | |||
132 | rule "<REGELNAME>" | ||
133 | when | ||
134 | $requestParameters : Map() | ||
135 | Panel(identifier=="<PANELNAME>", $VARIABLENNAME:getInputComponent("KOMPONENTENNAMEN"), $cVARIABLENNAME != null) | ||
136 | then | ||
137 | if($requestParameters.get("TestKomponente") != null) { | ||
138 | String parameterValue = ((String[]) $requestParameters.get("KOMPONENTENNAMEN"))[0]; | ||
139 | $c0.setStringValue(parameterValue); | ||
140 | } | ||
141 | end | ||
142 | ``` | ||
143 | |||
144 | Der Übergabeparameter würde dann wie folgt aussehen: <https://pdf.form-solutions.net/../../..?KOMPONENTENNAMEN=BEISPIELWERT> | ||
145 | |||
146 | --- | ||
147 | |||
148 | ## Zweistufige Übergabe (Postdata) | ||
149 | |||
150 | Beim zweistufigen Vorbefüllen von Ausfüllassistenten können viele Daten übergeben werden, ohne den Anwenderkomfort zu beeinträchtigen. Eine ausführliche Beschreibung finden Sie in der [Administrationsdokumentation](/wiki/admindoku/view/Main/03_Steuerungsprozess/02_Vorbef%C3%BCllung/01_Postdata/) | ||
151 | |||
152 | --- | ||
153 | |||
154 | ## REST-Schnittstelle zur Übergabe von Authentifizierungsdaten (Portal, ServiceKontoNRW, ...) | ||
155 | |||
156 | Für eine vorab durch ein Portal durchgeführte Authentifizierung für einen Antragsassistenten müssen sowohl die Benutzer- bzw. Antragstellerdaten als auch das verifizierte Vertrauensniveau sicher übermittelt werden. Eine ausführliche Beschreibung finden Sie in der [Administrationsdokumentation](/wiki/admindoku/view/Main/03_Steuerungsprozess/02_Vorbef%C3%BCllung/01_Postdata/) | ||
157 | |||
158 | --- | ||
159 | |||
160 | ## Vorbefüllung durch eID (nPA) | ||
161 | |||
162 | 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 | ||
163 | |||
164 | * die entsprechen Komponenten aus der Bibliothek verwendet oder | ||
165 | * eine direkte Zuweisung der Vorbefüllung in der Konfiguration der Komponente hinterlegt werden. | ||
166 | |||
167 | 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: | ||
168 | |||
169 | | Bibliothekselement | Objektpfad Bezeichnung technisch | | ||
170 | | ----------------------------------- | ------------------------------------------------------- | | ||
171 | | Briefanrede | AS_Anrede | | ||
172 | | Vor- / Familienname | AS_Name1.AS_Name1.AS_Vorname | | ||
173 | | Vor- / Familienname | AS_Name1.AS_Name1.AS_Name | | ||
174 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_Vorname | | ||
175 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_Name | | ||
176 | | Vor- / Familien- / Geburtsname | AS_Name2.AS_Name2.AS_GebName | | ||
177 | | Geburtsdaten (ohne Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
178 | | Geburtsdaten (ohne Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
179 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
180 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
181 | | Geburtsdaten (mit Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit | | ||
182 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum | | ||
183 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort | | ||
184 | | Geburtsdaten (weitere Staatsangeh.) | AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit | | ||
185 | | Adresse (HausNr. Getrennt)e | AS_Adresse.AS_Adresse.Adresse.AS_PLZ | | ||
186 | | Adresse (HausNr. Getrennt) | AS_Adresse.AS_Adresse.Adresse.AS_Ort | | ||
187 | | Adresse (HausNr. Getrennt) | AS_Adresse.AS_Adresse.Adresse.AS_Strasse | | ||
188 | | Adresse (HausNr. Getrennt)e | AS_Adresse.AS_Adresse.Adresse.AS_Hausnummer | | ||
189 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_PLZ | | ||
190 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_Ort | | ||
191 | | Adresse (HausNr. Zusammen) | AS_Adresse.AS_Adresse.Adresse.AS_Strasse | | ||
192 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon | | ||
193 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax | | ||
194 | | Kontaktdaten | AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail | | ||
195 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon | | ||
196 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax | | ||
197 | | Kontaktdaten (Pflicht) | AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail | | ||
198 | |||
199 | --- | ||
200 | |||
201 | ## Vorbefüllung mit Benutzerdatensätzen | ||
202 | |||
203 | 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. | ||
204 | |||
205 | Folgende Felder werden befüllt und müssen dementsprechend benannt werden: | ||
206 | |||
207 | | Bibliothekselement | Ausführliche Benamung | Context Identifier | | ||
208 | | ------------------ | --------------------------------------------------------------- | ------------------ | | ||
209 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_E-Mail-Adresse | SB.Daten | | ||
210 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Benachrichtigungsadresse | SB.Daten | | ||
211 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefax | SB.Daten | | ||
212 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Name | SB.Daten | | ||
213 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Personalnummer | SB.Daten | | ||
214 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefon | SB.Daten | | ||
215 | | SB_Sachbearbeiter | SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Zimmernummer | SB.Daten | | ||
216 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Amt/Abteilung | SB.Daten | | ||
217 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_Ort | SB.Daten | | ||
218 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_PLZ | SB.Daten | | ||
219 | | SB_Amt/Abteilung | SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Straße/Postfach | SB.Daten | | ||
220 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Aktenzeichen | SB.Daten | | ||
221 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_einzeilig | SB.Daten | | ||
222 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_klein | SB.Daten | | ||
223 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Anschrift_groß | SB.Daten | | ||
224 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_Ort | SB.Daten | | ||
225 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_PLZ | SB.Daten | | ||
226 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Absender | SB.Daten | | ||
227 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Empfänger | SB.Daten | | ||
228 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Kopfzeile | SB.Daten | | ||
229 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_einzeilig | SB.Daten | | ||
230 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_zweizeilig | SB.Daten | | ||
231 | | SB_Formularfelder | SB_Formularfelder.SB_Formularfelder.SB_Rechtsbehelfsbelehrung | SB.Daten | | ||
232 | |||
233 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ | ||
234 | > | ||
235 | > In der [[Standard-Bibliothek|Main.05_Assistenten.04_Assistentenbauoberfläche.03_Bibliothek]] stehen hierzu bereits vorkonfigurierte Bausteine zur Verfügung. |