Vorbefüllung von Assistenten

Veröffentlichte Assistenten 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.

Vorbefüllung mit Standardparameter

1757353843365-988.png

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

Technischer Bezeichner / Parameter Vorbefüllung Assistentenbau

ACADEMIC_TITLE("AcademicTitle"),

Akademischer Titel

TITLE("Titel"),

Anrede

COMPANY_NAME_PHYSICAL_PERSON("CompanyNamePhysicalPerson"),

Betriebsname

EMAIL("Email"),

E-Mail

ADDRESS_SUPPLEMENT("AddressSupplement"),

Adressierungszusaetze

TELEFAX("Telefax"),

Fax Nr.

DAY_OF_BIRTH("DateOfBirth"),

Geburtsdatum

BIRTH_NAME("BirthName"),

Geburtsname

BIRTH_PLACE("BirthPlace"),

Geburtsort

STREET_NUMBER("StreetNumber"),

Hausnummer

LAST_NAME("LastName"),

Name

ADDRESS_LOCALITY_PART("CompanyAddressPartOfLocality"),

Ortsteil

TYPE_OF_LEGAL_PERSON("TypeOfLegalPerson"),

Personentyp

ZIP("ZipCode"),

PLZ

POSTKORB_ID("PostkorbId"),

Postkorb-ID

LEGAL_FORM("LegalForm"),

Rechtsform

LEGAL_FORM_TEXT("LegalFormText"),

Rechtsform in Textform

REGISTER_TYPE("RegisterType"),

Registerart

REGISTER_COURT("RegisterCourt"),

Registergericht

REGISTER_NUMBER("RegisterNumber"),

Registernummer

NATIONALITY("Nationality"),

Staatsangehörigkeit

STREET("Street"),

Straße

PHONE("Phone"),

Telefon Nr.

OCCUPATION("Occupation"),

Tätigkeit

OCCUPATION_TEXT("OccupationText"),

Tätigkeit in Textform

COMPANY_NAME("CompanyName"),

Unternehmensname

STORK_QAA_LEVEL("StorkQaaLevel"),

Vertrauensniveau

FIRST_NAME("FirstName"),

Vorname

COUNTRY("Country"),

Land

PLACE("City");

Ort

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".

Vorbefüllung über einen Context-Identifier

1757353961928-369.png

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 versehen werden. Nach der Erstellung des Assistenten muss dann nur noch der Übergabeparameter an den veröffentlichten Link angehängt werden.

Ein Übergabeparameter besteht aus folgenden Elementen:

  • Context-Identifier:
    Zum Beispiel „Antragsteller/Daten“

  • Feldbezeichnungen einer Feldhierarchie:
    AS_Adresse (Verknüpfungsname), AS_Adresse (Objektgruppenname), Adresse (Autovervollständigungsgruppennamen), AS_PLZ („Bezeichnung technisch“ der Komponente)

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

  • Um eine korrekte Übergabe von Sonderzeichen zu gewährleisten, müssen die Feldwerte url-encodiert übergeben werden.

  • Hier können die Parameter beim Aufruf durch den Anwender verändert werden.

Ansicht der Vorbefüllung im Assistenten

Befüllen weniger Felder

Sollen nur ein bis zwei Komponenten vorbefüllt werden, kann der Link zum Assistenten um entsprechende Parameter ergänzt werden.
Zum Beispiel bei einem Ausgangslink der folgenden Form:
https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490

Ergibt sich folgender Link mit Vorbefüllung:
https://pdf.form-solutions.net/metaform/Form-Solutions/sid/assistant/513607a50cf2416927d48490?Antragsteller.Daten.AS_Adresse.AS_Adresse.Adresse.AS%5FPLZ=76137

Hier können die Parameter beim Aufruf durch den Anwender verändert werden.

Befüllen mehrerer Felder

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

Originallink des Assistenten:
https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978

Parameter1:
Antragsteller.Vorname.Vorname=Max

Parameter2:
Antragsteller.Familienname.Nachname=Mustermann

Ergibt:
https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5559999a0cf2390de27b2978?Antragsteller.Vorname.Vorname=Max&Antragsteller.Familienname.Nachname=Mustermann

Die Parameter setzen sich wie folgt zusammen (Beispiel Parameter1):

Context Identifier Bezeichnung technisch Wert

Antragsteller.Vorname

Vorname

Max

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

Vorbefüllung durch Expertenregel

Sofern sich der Ersteller eines Assistenten dazu entschließt einen Assistenten, ohne einen Context-Identifier vorbefüllen zu lassen, muss dieser folgenden Expertenregel an der entsprechenden Stelle im Assistenten hinterlegen:

package de.formsolutions.metaform
import de.formsolutions.metaform.model.*
import java.util.Map;

rule "<Eindeutige Bezeichnung für die Regel>"
when
 $requestParameters : Map()
then
if($requestParameters.get("<URL-PARAMETER>") != null) {
  String parameterValue = ((String[])
$requestParameters.get("<URL-Parameter>"))[0];
   System.out.println(parameterValue);
 }
end
package de.formsolutions.metaform
import de.formsolutions.metaform.model.*
import java.util.Map;


rule "<REGELNAME>"
when
 $requestParameters : Map()
 Panel(identifier=="<PANELNAME>",
$VARIABLENNAME:getInputComponent("KOMPONENTENNAMEN"), $cVARIABLENNAME !=
null)
then
if($requestParameters.get("TestKomponente") != null) {
  String parameterValue = ((String[])
$requestParameters.get("KOMPONENTENNAMEN"))[0];
   $c0.setStringValue(parameterValue);
 }
end

Der Übergabeparameter würde dann wie folgt aussehen: https://pdf.form-solutions.net/../../..?KOMPONENTENNAMEN=BEISPIELWERT

Zweistufige Übergabe (Postdata)

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 link: Administrationsdokumentation

REST-Schnittstelle zur Übergabe von Authentifizierungsdaten (Portal, ServiceKontoNRW, …​)

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 Administrationsdokumentation

Vorbefüllung durch eID (nPA)

Eine weitere Möglichkeit der Vorbefüllung von Daten in einem Assistenten kann mit der Hilfe des elektronischen Personalausweis (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 des Assistenten die Auswahl „NPA-Nutzung“ auf „Ja“ oder „Optional“ ausgewählt werden. Weiterhin müssen im Assistentenbau

  • die entsprechen Komponenten aus der Bibliothek verwendet oder

  • eine direkte Zuweisung der Vorbefüllung in der Konfiguration der Komponente hinterlegt werden.

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:

Bibliothekselement Objektpfad Bezeichnung technisch

Briefanrede

AS_Anrede

Vor- / Familienname

AS_Name1.AS_Name1.AS_Vorname

Vor- / Familienname

AS_Name1.AS_Name1.AS_Name

Vor- / Familien- / Geburtsname

AS_Name2.AS_Name2.AS_Vorname

Vor- / Familien- / Geburtsname

AS_Name2.AS_Name2.AS_Name

Vor- / Familien- / Geburtsname

AS_Name2.AS_Name2.AS_GebName

Geburtsdaten (ohne Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum

Geburtsdaten (ohne Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort

Geburtsdaten (mit Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum

Geburtsdaten (mit Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort

Geburtsdaten (mit Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit

Geburtsdaten (weitere Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsdatum

Geburtsdaten (weitere Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Geburtsort

Geburtsdaten (weitere Staatsangeh.)

AS_Geburtsdaten.AS_Geburtsdaten.AS_Staatsangehoerigkeit

Adresse (HausNr. Getrennt)e

AS_Adresse.AS_Adresse.Adresse.AS_PLZ

Adresse (HausNr. Getrennt)

AS_Adresse.AS_Adresse.Adresse.AS_Ort

Adresse (HausNr. Getrennt)

AS_Adresse.AS_Adresse.Adresse.AS_Strasse

Adresse (HausNr. Getrennt)

AS_Adresse.AS_Adresse.Adresse.AS_Hausnummer

Adresse (HausNr. Zusammen)

AS_Adresse.AS_Adresse.Adresse.AS_PLZ

Adresse (HausNr. Zusammen)

AS_Adresse.AS_Adresse.Adresse.AS_Ort

Adresse (HausNr. Zusammen)

AS_Adresse.AS_Adresse.Adresse.AS_Strasse

Kontaktdaten

AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon

Kontaktdaten

AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax

Kontaktdaten

AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail

Kontaktdaten (Pflicht)

AS_Kontaktdaten.AS_Kontaktdaten.AS_Telefon

Kontaktdaten (Pflicht)

AS_Kontaktdaten.AS_Kontaktdaten.AS_Fax

Kontaktdaten (Pflicht)

AS_Kontaktdaten.AS_Kontaktdaten.AS_E-Mail

Vorbefüllung mit Benutzerdatensätzen

Zusätzlich zu der Vorbefüllung mittels des elektronischen Personalausweises kann ein Assistent mit den Benutzerdatensätzen des veröffentlichten Sachbearbeiters vorbefüllt werden. Hierzu müssen die Komponenten entsprechend benamt und mit einem Context Identifier versehen werden. Die Daten werden auch in das PDF-Formular übernommen.

Folgende Felder werden befüllt und müssen dementsprechend benannt werden:

Bibliothekselement Ausführliche Benamung Context Identifier

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_E-Mail-Adresse

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Benachrichtigungsadresse

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefax

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Name

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Personalnummer

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Telefon

SB.Daten

SB_Sachbearbeiter

SB_Sachbearbeiter.SB_Sachbearbeiter.SB_Zimmernummer

SB.Daten

SB_Amt/Abteilung

SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Amt/Abteilung

SB.Daten

SB_Amt/Abteilung

SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_Ort

SB.Daten

SB_Amt/Abteilung

SB_Amt/Abteilung.SB_Amt/Abteilung.Amt/Abteilung.SB_PLZ

SB.Daten

SB_Amt/Abteilung

SB_Amt/Abteilung.SB_Amt/Abteilung.SB_Straße/Postfach

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Aktenzeichen

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Anschrift_einzeilig

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Anschrift_klein

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Anschrift_groß

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_Ort

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Antragsteller_PLZ

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Absender

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_E-Mail_Empfänger

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Kopfzeile

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_einzeilig

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Ort/Datum_zweizeilig

SB.Daten

SB_Formularfelder

SB_Formularfelder.SB_Formularfelder.SB_Rechtsbehelfsbelehrung

SB.Daten

In der Standard-Bibliothek stehen hierzu bereits vorkonfigurierte Bausteine zur Verfügung.