Wiki-Quellcode von Steuerung Einreichungsprozess

Zuletzt geändert von MACH ProForms GmbH am 06.12.2024

version	line-number	content
1.1	1	## Automatische E-Mail Antwort
	2
	3	Standardmäßig erhält der Absender nach dem Einreichen eines Assistenten keine automatische E-Mail Antwort von der Behörde. Soll jedoch der Absender eine E-Mail Antwort erhalten muss hierzu im entsprechenden Assistenten sowie im E-Mailserver bei der Behörde Konfigurationen vorgenommen werden.
	4
477.1	5	---
1.1	6
	7	### Anpassung im Assistenten für die automatische E-Mail Antwort
	8
	9	#### Möglichkeit 1: Einfaches Verfahren (kein Wert im Export)
	10
483.1	11	Hierzu muss im Assistenten in das Panel, z. B. „Persönliche Daten“ auf dem die E-Mail-Adresse während des Ausfüllvorgangs erfasst wird, die [[„Bezeichnung technisch“\|Main.05_Assistenten.04_Assistentenbauoberfläche.04_KonfigurationvonKomponenten]] der Komponente in ofsXX1_from_smail3 oder AS_E-Mail (mit dem entsprechenden _ContextIdentifier _Pfad "Antragsteller.Daten") umbenannt werden.
1.1	12
477.1	13	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
150.1	14
477.1	15	1. Wenn das ofs-Feld leer oder nicht vorhanden ist, wird überprüft, ob es einen Context Identifier für die Antragssteller Daten E-Mail gibt. Ist dieser befüllt, wird dieser Wert als ReplyTo E-Mail verwendet.
	16	1. Sollte aber kein Context Identifier für diese E-Mail vorhanden sein, oder das Feld leer, wird nach einem Feld im Assistenten mit der technischen Bezeichnung AS_E-Mail gesucht. Hier wird der Wert des ersten befüllten Feld verwendet.
	17	1. Sollte kein Feld mit der technischen Bezeichnung vorhanden oder alle leer sein, so wird die ReplyTo E-Mail auf 'null' gesetzt.
	18
1.1	19	![[Ansicht der Änderung des Objektnamen der E-Mail-Adresse\|@VeröffentlichungEmailKomponente.jpg]]
	20
481.1	21	Anschließend kann der Assistent normal [[gespeichert\|Main.05_Assistenten.04_Assistentenbauoberfläche.13_Assistentenspeichern]], freigegeben und [[veröffentlicht\|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] werden. Das Resultat ist dann, dass die im Assistenten eingetragene E-Mail-Adresse als Replyto-Adresse verwendet wird. Dies ermöglicht gerade im Payment- oder Bewerbungsbereich eine automatisierte Antwort bei eingehenden Anträgen. Wenn allerdings bei z. B. Bewerbungen nach dem Ablauf der Frist die eingegangenen Bewerbungen aus dem Kundenbereich exportiert werden, wird dieses Feld nicht angezeigt, da es ein Steuerungsfeld (ofsXX1_from_smail3) vom MACH formsolutions Plattform ist. Das führt zu Möglichkeit 2.
1.1	22
	23	#### Möglichkeit 2: Erweitertes Verfahren mit Exportmöglichkeit
	24
	25	Zusätzlich zu der Möglichkeit 1 muss für diese Möglichkeit noch ein „[[verstecktes Feld\|Main.05_Assistenten.04_Assistentenbauoberfläche.03_Bibliothek]]“ im Assistenten eingebaut werden, das mit dem Wert aus dem Feld „E-Mail (ofsXX1_from_smail3)“ automatisch befüllt wird. Das hat den Effekt, dass die vom Ausfüller eingetragene E-Mail-Adresse zumal als Replyto-Adresse fungiert, als auch, dass der Wert zum Export zur Verfügung steht. Hierzu muss die „Bezeichnung technisch“ der Komponente, in der die E-Mail-Adresse im Ausfüllprozess eingetragen wird, auf ofsXX1_from_smail3 abgeändert werden.
	26
477.1	27	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
	28	>
156.1	29	> Das versteckte Feld muss zwingend auf einem anderen Panel platziert werden, da ansonsten die Regel zur Befüllung nicht greift.
1.1	30
	31	![[Ansicht der Änderung des Objektnamen der E-Mail-Adresse\|@VeröffentlichungEmailKomponente.jpg]]
	32
	33	Auf einem nachfolgenden Panel muss ein „verstecktes Feld“ platziert und die „Bezeichnung technisch“ des versteckten Feldes in „E-Mail“ abgeändert werden. Weiterhin muss in dem versteckten Feld unter den speziellen Einstellungen der Wert geleert werden.
	34
	35	![[Ansicht der Änderung des Objektnamen der E-Mail-Adresse\|@VeröffentlichungEmailKomponenteWert.jpg]]
	36
	37	Zusätzlich muss mittels einer [[Expertenregel\|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.04_Expertenmodus]] dafür gesorgt werden, dass die eingetragene E-Mail-Adresse in das versteckte Feld übertragen wird. Die nachfolgende Regel muss auf dem Panel eingefügt werden, in dem sich das versteckte Feld befindet.
	38
477.1	39	Expertenregel:
1.1	40
	41	```javascript
	42	package de.formsolutions.metaform
	43	import de.formsolutions.metaform.model.*
	44
	45	rule "Mail"
	46	when
	47	Panel(identifier == "Persönliche Daten", $c0:getInputComponent("ofsXX1_from_smail3"), $c0 != null)
	48	Panel(identifier == "Zweites Panel", $c1:getInputComponent("E-Mail"), $c1 != null)
	49	then
	50	$c1.setStringValue($c0.getStringValue());
	51	end
	52	```
	53
477.1	54	Erläuterung:
1.1	55
477.1	56	* Die Definition`rule` „Mail“ ist der Name der Regel und ist frei definierbar.
	57	* In der Definition `Panel(identifier == "Persönliche Daten"` muss der Panelname eingetragen werden auf dem die E-Mail-Adresse erfasst wird.
	58	* Der in der Definition `$c0:getInputComponent("ofsXX1_from_smail3")` befindliche Wert wird ausgelesen und in der Variablen $c0 zwischengespeichert.
	59	* In der Definition `Panel(identifier == "Zweites Panel"` muss das Panel angegeben werden, auf dem sich das versteckte Feld befindet.
1.1	60
477.1	61	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
	62
	63	1. In diesem Fall befinden sich die Komponenten in keiner Objektgruppe.
	64	1. Wenn Sie mit [[Objektgruppen\|Main.05_Assistenten.04_Assistentenbauoberfläche.04_KonfigurationvonKomponenten]] arbeiten, muss der vollständige Pfad eingetragen werden, in der sich das jeweilige Feld befindet.
	65
1.1	66	Nach dem Einpflegen der Regel kann der Assistent normal [[gespeichert\|Main.05_Assistenten.04_Assistentenbauoberfläche.13_Assistentenspeichern]], freigegeben und [[veröffentlicht\|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] werden.
	67
	68	#### Möglichkeit 3: Erweitertes Verfahren mit Export und Validierung
	69
	70	Mit der Hilfe von zwei E-Mailfeldern kann geprüft werden, ob die angegebenen Werte (E-Mail-Adressen) identisch sind. Diese Möglichkeit kann verwendet werden, um sicherzustellen, dass der Antragsteller eine korrekte E-Mail-Adresse angibt. Es werden hierzu zwei E-Mailfelder auf einem Panel benötigt. Eines der E-Mailfelder muss mit der „Bezeichnung technisch“ ofsXX1_from_smail3 versehen sein. Das zweite E-Mail-Feld kann beispielsweise E-Mail benannt werden.
	71
	72	![[Ansicht der zwei E-Mailfelder\|@VeröffentlichungEmailMöglichkeit3.jpg]]
	73
	74	Zusätzlich zu den beiden E-Mailfeldern wird nachfolgende [[Validierungsregel\|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.05_Validierungsregeln]] auf dem Panel benötigt, die die beiden Werte miteinander vergleicht.
	75
	76	```javascript
	77	package de.formsolutions.metaform
	78	import de.formsolutions.metaform.model.*
	79
	80	rule "Emailvergleich"
	81	when
	82	Panel(identifier == "Panel", $f1:getInputComponent("ofsXX1_from_smail3"),
	83	$f2:getInputComponent("E-Mail"), $f1.getStringValue() != $f2.getStringValue())
	84	then
	85	RuleValidationError error = new RuleValidationError("Emailungueltig");
	86	insert(error);
	87	end
	88	```
	89
477.1	90	In dieser Validierungsregel befindet sich ein sogenannter Fehlerschlüssel, der bei einer Eingabe, die nicht identisch ist, dem Antragsteller einen Fehler anzeigt. Der Fehlerschlüssel (Emailungueltig) muss zusätzlich unter der Rubrik „Fehlermeldung“ eingetragen werden. Hierzu muss der Schlüssel (Emailungueltig) eingetragen und in dem Feld „Beschriftung“ eine vom Ersteller definierte Fehlermeldung.
1.1	91
477.1	92	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
1.1	93
477.1	94	1. Der Schlüssel muss identisch sein, wie in der Validierungsregel hinterlegt.
	95	1. Die von Ersteller definierte Fehlermeldung wird dem Bürger angezeigt, wenn die angegebenen E-Mail-Adressen nicht übereinstimmen.
	96
1.1	97	![[Ansicht der Fehlermeldung\|@VeröffentlichungMöglichkeit3.jpg]]
	98
477.1	99	---
1.1	100
	101	### Anpassung im E-Mailserver für die automatische E-Mail Antwort
	102
	103	Der Vorgang:
	104	Der Bürger füllt den Assistenten online aus, trägt bei persönlichen Daten die E-Mail-Adresse ein. Die erfasste E-Mail-Adresse wird als Replyto-Adresse verwendet. Der Assistent wird direkt online an den zuständigen Sachbearbeiter verschickt. Der E-Mailserver verschickt nun mit einem Alias als Absender die E-Mail an den Empfänger. Im Betreff befindet sich ein eindeutiger Betreff, der sich wie folgt zusammensetzt:
	105
	106	OFS: Neues Formular: Name des Assistenten Abs.: AS_Name AS_Nachname
	107
	108	Beim entgegennehmenden E-Mailserver kann nun folgendes Szenario eintreten:
	109
	110	Szenario 1:
	111	Die Empfänger E-Mail-Adresse ist ein Postfach, das speziell für die Entgegennahme dieses Assistenten angelegt wurde, dann kann vermutliche ohne Regel ein Autorespond erfolgen.
	112
	113	Szenario 2:
	114	Die Empfänger E-Mail-Adresse gehört einem Sachbearbeiter und nimmt sämtliche E-Mails entgegen. Dann muss bei eingehenden E-Mails auf dem Server nach einem eindeutigen Betreff gefiltert werden. Dazu kann der eindeutige Teil der Betreffzeile genommen werden:
	115
	116	OFS: Neues Formular: Name des Assistenten
	117
	118	Heißt nun, dass eine Regel greift und eine Aktion bei eingehenden E-Mails die den eindeutigen Betreff
	119
	120	OFS: Neues Formular: Bestellung Personenstandsurkunde
	121
	122	eingerichtet werden muss. Kommt also eine E-Mail mit diesem eindeutigen Betreff lokal am Mailserver an, wird der eindeutige Betreff erkannt und anhand dessen eine automatische Eingangsbestätigung per E-Mail an den Antragssteller versandt.
	123
477.1	124	---
1.1	125
	126	## Änderung Empfänger Benachrichtigungsadresse
	127
477.1	128	### Im Assistenten die Empfängeradresse bestimmen
	129
1.1	130	Standardmäßig erhält der bei der [[Veröffentlichung\|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] hinterlegte Sachbearbeiter nach der Einreichung eine E-Mail mit den eingereichten Daten. Soll jedoch ein anderer Empfänger die E-Mail mit den eingereichten Daten erhalten, muss im Ausfüllprozess des Assistenten eine entsprechende Konfiguration vorgenommen werden.
	131
477.1	132	Hierzu muss im Assistenten die [[„Bezeichnung technisch“\|Main.05_Assistenten.04_Assistentenbauoberfläche.04_KonfigurationvonKomponenten]] der Komponente die mit der E-Mailadresse ausgefüllt wird in ofsXX1_to_smail3 umbenannt werden.
1.1	133
	134	![[Ansicht der Änderung des Objektnamen der E-Mail-Adresse\|@VeröffentlichungEmailKomponenteToMail.jpg]]
	135
477.1	136	Anschließend kann der Assistent normal [[gespeichert\|Main.05_Assistenten.04_Assistentenbauoberfläche.13_Assistentenspeichern]], freigegeben und [[veröffentlicht\|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] werden. Das Resultat ist, dass die in der Komponente eingetragene E-Mail-Adresse als Empfänger-Adresse verwendet wird. Die in der Veröffentlichungskonfiguration hinterlegten Sachbearbeiter-E-Mail-Adressen werden nicht mehr berücksichtigt. Die Ablage in der Inbox bleibt davon unbetroffen, sofern ausgewählt.
1.1	137
477.1	138	### Mehrere Empfänger oder Empfangsarten eintragen:
	139
	140	Wie oben beschrieben einer Komponente im Assistenten den technischen Bezeichner "ofsXX1_to_smail3" zuweisen
	141	Empfänger-, Kopie- und Blindkopie-Adressen angeben, z.B. über eine Expertenregel.
478.1	142	Dabei werden E-Mailadressen innerhalb der Empfängerkategorie kommasepariert ohne Leerzeichen aufgelistet. Die Empfängerkategorien _to/cc/bcc_ werden durch ein Semikolon voneinander getrennt, ohne Leerzeichen.
477.1	143	to:Empfaenger1,Empfaenger2,..;cc:Kopie1,Kopie2,…;bcc:Blindkopie1,…
	144
	145	Beispiel:
480.1	146	to:[support@machproforms.de](support@machproforms.de);bcc:[info@machproforms.de](info@machproforms.de),[m.mustermensch@machproforms.de](m.mustermensch@machproforms.de)
477.1	147
481.1	148	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis: _Das Feld ofsXX1_to_smail3 wird bei Exporten aus dem Kundenbereich, wie zum Beispiel Excel-Exporten, nicht berücksichtigt, da es sich um ein Steuerungsfeld der MACH formsolutions Plattform handelt.
1.1	149
477.1	150	---
1.1	151
	152	## Einreichungsoptionen ein-/ausblenden
	153
	154	Standardmäßig werden am Ende eines Ausfüllprozesses die Schaltflächen „Einreichen“ und „Drucken“ dem Ausfüller zur Verfügung gestellt. In Fällen in denen der Assistent nur online oder nur postalisch gesendet werden soll, steht die Möglichkeit die Schaltflächen mittels einer Expertenregel einzublenden/auszublenden.
	155
	156	Hierzu muss in dem betreffenden Assistenten ein [[neues Panel hinzugefügt\|Main.05_Assistenten.04_Assistentenbauoberfläche.01_PanelhinzufügenPanelwerkzeugleiste]] und mit einer Steuerungsfrage versehen werden. Für die Steuerungsfrage kann beispielsweise eine [[Dropdownkomponente\|Main.05_Assistenten.04_Assistentenbauoberfläche.03_Bibliothek]] verwendet werden, in der die Frage gestellt wird, ob der Antrag online gesendet/gedruckt werden soll oder nicht. Weiterhin wird ein verstecktes Feld benötigt, das die „Bezeichnung technisch“ "ofsXX1_send", um die Schaltfläche "Senden" bzw. "ofsXX1_print" um die Schaltfläche "Drucken" auszublenden.
	157
	158	Zum Abschluss muss nachfolgende Regel in den [[Expertenmodus\|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.04_Expertenmodus]] der versteckten Komponente eingefügt werden.
	159
	160	```javascript
	161	package de.formsolutions.metaform
	162	import de.formsolutions.metaform.model.*
	163
	164	rule "<Eindeutige Bezeichnung für die Regel>"
	165
	166	no-loop
	167	when
	168	Component($c0:searchInputComponent("<KOMPONENTENNAME>"), $c0 != null, $c0.getStringValue() != null) and
	169	$target: Component($c1:searchInputComponent("ofsXX1_send"), $c1 != null)
	170	then
	171	$target.setStringValue($c0.getStringValue());
	172	update($target);
	173	end
	174	```
	175
	176	Mittels der Steuerungsfrage wird nun beim Ausfüllprozess, je nach Auswahl, die Schaltfläche eingeblendet bzw. ausgeblendet. Der Exportwert "0" steht für das Ausblenden und der Exportwert "1" für das Einblenden.
	177
481.1	178	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis_:In der Regel wird der Exportwert auf "1" gesetzt, um nach dem Einreichen der Daten die Mail an den Sachbearbeiter verschlüsselt zu versenden. Dabei wird die Einstellung "unverschlüsselte Mail" in der Veröffentlichungskonfiguration außer Kraft gesetzt.Möchten Sie die eingereichten Daten unverschlüsselt in der Mail an den Sachbearbeiter versenden, sollte der Exportwert in der Regel auf "2" gesetzt werden.
1.1	179
477.1	180	---
	181
1.1	182	## Änderung des Betreffs eingehender E-Mails
	183
	184	Standardmäßig wird im Betreff einer E-Mail, die beim Einreichen eines Assistenten an den Sachbearbeiter gesendet wird, der Vorname und Name des Antragstellers, sofern die Komponenten AS_Name und/oder AS_Vorname verwendet wird, angezeigt. In einigen Fällen kann es notwendig sein zusätzlich zu diesen Daten weitere Daten im Betreff aufzuführen. Hierzu müssen im Assistenten entsprechende Komponenten angelegt und eine [[Expertenregel\|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.04_Expertenmodus]] hinterlegt werden.
	185
	186	```javascript
	187	package de.formsolutions.metaform
	188	import de.formsolutions.metaform.model.*
	189
	190	rule "<Eindeutige Bezeichnung für die Regel>"
	191	no-loop
	192	when
	193	Panel(identifier == "<PANELNAME>", $c0:getInputComponent("<KOMPONENTENNAME/WEITERE KOMPONENTE>"), $c0 != null, $c2:getInputComponent("<VERSTECKTES FELD>"), $c2 != null, $c1:getInputComponent("<KOMPONENTENNAME/ANTRAGSTELLERNAME>"), $c1 != null, $c3:getInputComponent("<KOMPONENTENNAME/ANTRAGSTELLERVORNAME>"), $c1 != null)
	194	then
	195	$c2.setStringValue($c3.getStringValue() + $c1.getStringValue() + " " + $c0.getStringValue());
	196	end
	197	```
	198
477.1	199	Im vorgehenden Beispiel werden die Daten, Antragstellervorname ($c3), Antragstellername ($c1) und der weitere Inhalt aus der zusätzlichen Komponente ($c0), in ein verstecktes Feld ($c2) geschrieben.
1.1	200
482.1	201	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis: _In diesem Fall müssen Name und Vorname der Antragsteller nicht als AS_Name/AS_Vorname deklariert werden, sondern das versteckte Feld muss als AS_Name benannt werden.
1.1	202
477.1	203	---
1.1	204
	205	## Generierung einer laufenden Nummer im Assistenten
	206
	207	Es besteht die Möglichkeit in einem Assistenten eine sogenannte laufende Nummer über eine Regel erstellen zu lassen. Diese laufende Nummer kann beispielsweise für einen Verwendungszweck, der aus einem "Grundaufbau" und einer fortlaufenden Nummer bestehen soll, genutzt werden. Die fortlaufende Nummer wird beim Start eines Assistenten hochgezählt. Um diese Funktion nutzen zu können, muss im entsprechenden Assistenten folgende [[Expertenregel\|Main.05_Assistenten.04_Assistentenbauoberfläche.07_Regelbau.04_Expertenmodus]] auf Panelebene hinterlegt werden.
	208
	209	```javascript
	210	package de.formsolutions.metaform
	211	import de.formsolutions.metaform.model.*
	212	import de.formsolutions.metaform.counter.service.LocalCounterService
	213
	214	rule "<Eindeutige Bezeichnung für die Regel>"
	215	salience 0
	216	when
	217	Panel(identifier == "<PANELNAME>",
	218	$n:getInputComponent("<KOMPONENTENNAME>"), $n != null)
	219	$counter:LocalCounterService()
	220	then
	221	$n.setStringValue($counter.next("1861RK1%04d"));
	222	end
	223	```
	224
477.1	225	> {{icon name="far fa-info-circle" size="3"/}} Hinweis:*
482.1	226	>
	227	> Die laufende Nummer wird pro Mandant generiert. Wenn ein Verlagsassistent diese Funktion nutzt, wird für jeden Mandanten eine separate laufende Nummer vorgehalten.
1.1	228
477.1	229	---
	230
1.1	231	## Weiterleitung per sucessURL
	232
	233	Standardmäßig wird nach dem Einreichen eines Assistenten der Nutzer auf die sogenannte "Einreichebestätigungsseite" weitergeleitet. Hier erhält der Nutzer die Erfolgsmeldung, dass der Antrag erfolgreich eingereicht wurde und kann das ausgefüllte Dokument herunterladen. Es besteht die Möglichkeit jedoch den Nutzer nach dem Einreichen auf eine vordefinierte URL weiterzuleiten. Hierzu muss der veröffentlichte Assistentenlink um einen Parameter sowie die entsprechende URL ergänzt werden.
	234
477.1	235	Parameter: ?successUrl=
1.1	236
477.1	237	Beispiel: <https://pdf.form-solutions.net:443/metaform/Form-Solutions/sid/assistant/5d72590e5b583f582295316b?successUrl=https://form-solutions.de>
1.1	238
477.1	239	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
	240	>
482.1	241	> Wenn für die automatische Assistentenantwortgenerierung die Option "Herunterladen erzwingen" aktiviert ist, wird der Ausfüller zunächst zur Einreichungsbestätigungsseite weitergeleitet. Hier muss er das entsprechende Antwort-PDF-Formular herunterladen. Nach dem Herunterladen und Klicken auf "Beenden" wird der Nutzer dann zur hinterlegten URL weitergeleitet.