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