Wiki-Quellcode von Briefwahlscheinantrag
Zuletzt geändert von MACH ProForms GmbH am 04.07.2024
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | ## Allgemeines | ||
| 2 | |||
| 3 | ### Voraussetzungen | ||
| 4 | |||
| 5 | * Ein [[Paymentanbieter|Main.07_Einstellungen-Fachadministration.03_Module.01_Payment]] ist bereits eingerichtet. | ||
| 6 | * Assistentenrechte für den [[Mandanten|Main.07_Einstellungen-Fachadministration.01_Mandanten.01_Rechte]] sowie den [[Benutzer|Main.07_Einstellungen-Fachadministration.02_Benutzer.02_Benutzereinzelrechte]] sind vorhanden. | ||
| 7 | * Modulkonfigurationsrechte für den [[Mandanten|Main.07_Einstellungen-Fachadministration.01_Mandanten.01_Rechte]] sowie für den [[Benutzer|Main.07_Einstellungen-Fachadministration.02_Benutzer.02_Benutzereinzelrechte]] sind vorhanden. | ||
| 8 | |||
| 9 | ### Relevante Daten | ||
| 10 | |||
| 11 | * WebService-Url | ||
| 12 | * Amtlicher Gemeindeschlüssel (AGS) | ||
| 13 | * X-ApiKey | ||
| 14 | * Referer | ||
| 15 | |||
| 16 | --- | ||
| 17 | |||
| 18 | ## Konfiguration des WebServices | ||
| 19 | |||
| 20 | Es muss sichergestellt werden, dass die WebServices "HSH-Spezifizierter Briefwahlscheinantrag" und "HSH-Briefwahlscheinantrag" bereits zur Verfügung stehen (siehe hierzu "[[Webservice Einrichten|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]])". Hierzu kann entweder der Reiter "Web Services" - "WebService-Definition" oder "WebService-Konfiguration" genutzt werden. Ist die Replikation eingerichtet, sollte der WebService bereits vorhanden sein. | ||
| 21 | |||
| 22 | Unter "WebService-Konfiguration" müssen anschließend die obigen erwähnten Daten erfasst werden. Hierzu wird der WebService-Name "HSH-Briefwahlscheinantrag", die WebService-OrganisationsID "22222222-2222", sowie die von dem Anbieter bereitgestellte, bestenfalls aktuellste WebService-Version ausgewählt. Anschließend wird die WebService-URL eingetragen, beispielsweise "<https://www.meldebehoerde.de:443/cebit/IRWSBV/soap/oliwa/v2/wahlschein>". | ||
| 23 | |||
| 24 | Dieselbe Konfiguration wird für den WebService "HSH-Spezifizierter Briefwahlscheinantrag" vorgenommen. | ||
| 25 | |||
| 26 | "Werte für HTTP-Basic Authentifikation" sind standardmäßig nicht zu befüllen. | ||
| 27 | |||
| 28 | "Werte für Zertifikatsauthentifizierung" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird dennoch von Mach ProForms GmbH empfohlen. | ||
| 29 | |||
| 30 | "Werte für Queue-Messaging Konfiguration" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird dennoch von Mach ProForms GmbH empfohlen (siehe hierzu "[[Security Paket|Main.07_Einstellungen-Fachadministration.03_Module.09_Security-Paket]])". | ||
| 31 | |||
| 32 | Die Aktionsparameter sind zu definieren (siehe hierzu "[[Webservice Einrichten|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]]"). | ||
| 33 | |||
| 34 | Die Werte der Parameter sind je nach Kunden spezifisch anzupassen. | ||
| 35 | |||
| 36 | Nachfolgend werden die Aktionsparameter für "HSH-Briefwahlscheinantrag" aufgelistet. | ||
| 37 | |||
| 38 | ``` | ||
| 39 | Aktionsname des WebServices | ||
| 40 | wahlliste | ||
| 41 | Parametername | ||
| 42 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produkt | ||
| 43 | Wert des Parameters | ||
| 44 | Informationsregister | ||
| 45 | |||
| 46 | Aktionsname des WebServices | ||
| 47 | wahlliste | ||
| 48 | Parametername | ||
| 49 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produkthersteller | ||
| 50 | Wert des Parameters | ||
| 51 | HSH Soft- und Hardware Vertriebs GmbH | ||
| 52 | |||
| 53 | Aktionsname des WebServices | ||
| 54 | wahlliste | ||
| 55 | Parametername | ||
| 56 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produktversion | ||
| 57 | Wert des Parameters | ||
| 58 | 1.10 | ||
| 59 | |||
| 60 | Aktionsname des WebServices | ||
| 61 | wahlliste | ||
| 62 | Parametername | ||
| 63 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:version | ||
| 64 | Wert des Parameters | ||
| 65 | 1 | ||
| 66 | |||
| 67 | Aktionsname des WebServices | ||
| 68 | wahlqrentschluesselung | ||
| 69 | Parametername | ||
| 70 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung.{http://www.hshsoft.de/service/olav-ws-nachrichten/v1}gemeindeschluessel* | ||
| 71 | Wert des Parameters | ||
| 72 | 00000000 | ||
| 73 | |||
| 74 | Aktionsname des WebServices | ||
| 75 | wahlqrentschluesselung | ||
| 76 | Parametername | ||
| 77 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:fassung | ||
| 78 | Wert des Parameters | ||
| 79 | 2019-01-01 | ||
| 80 | |||
| 81 | Aktionsname des WebServices | ||
| 82 | wahlqrentschluesselung | ||
| 83 | Parametername | ||
| 84 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:produkt | ||
| 85 | Wert des Parameters | ||
| 86 | Informationsregister | ||
| 87 | |||
| 88 | Aktionsname des WebServices | ||
| 89 | wahlqrentschluesselung | ||
| 90 | Parametername | ||
| 91 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:responsewithoutrequest | ||
| 92 | Wert des Parameters | ||
| 93 | ? | ||
| 94 | |||
| 95 | Aktionsname des WebServices | ||
| 96 | wahlqrentschluesselung | ||
| 97 | Parametername | ||
| 98 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:produktversion | ||
| 99 | Wert des Parameters | ||
| 100 | 1.10 | ||
| 101 | |||
| 102 | Aktionsname des WebServices | ||
| 103 | wahlqrentschluesselung | ||
| 104 | Parametername | ||
| 105 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:produkthersteller | ||
| 106 | Wert des Parameters | ||
| 107 | HSH Soft- und Hardware Vertriebs GmbH | ||
| 108 | |||
| 109 | Aktionsname des WebServices | ||
| 110 | wahlqrentschluesselung | ||
| 111 | Parametername | ||
| 112 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:produktversion | ||
| 113 | Wert des Parameters | ||
| 114 | 1.10 | ||
| 115 | |||
| 116 | Aktionsname des WebServices | ||
| 117 | wahlqrentschluesselung | ||
| 118 | Parametername | ||
| 119 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:version | ||
| 120 | Wert des Parameters | ||
| 121 | 1 | ||
| 122 | |||
| 123 | Aktionsname des WebServices | ||
| 124 | wahlqrentschluesselung | ||
| 125 | Parametername | ||
| 126 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlqrentschluesselung:test | ||
| 127 | Wert des Parameters | ||
| 128 | ? | ||
| 129 | ``` | ||
| 130 | |||
| 131 | Nachfolgend werden die Aktionsparameter für "HSH-Briefwahlscheinantrag" aufgelistet. | ||
| 132 | |||
| 133 | ``` | ||
| 134 | Aktionsname des WebServices | ||
| 135 | wahlliste | ||
| 136 | Parametername | ||
| 137 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produkt | ||
| 138 | Wert des Parameters | ||
| 139 | Informationsregister | ||
| 140 | |||
| 141 | Aktionsname des WebServices | ||
| 142 | wahlliste | ||
| 143 | Parametername | ||
| 144 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produkthersteller | ||
| 145 | Wert des Parameters | ||
| 146 | HSH Soft- und Hardware Vertriebs GmbH | ||
| 147 | |||
| 148 | Aktionsname des WebServices | ||
| 149 | wahlliste | ||
| 150 | Parametername | ||
| 151 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:produktversion | ||
| 152 | Wert des Parameters | ||
| 153 | 1.10 | ||
| 154 | |||
| 155 | Aktionsname des WebServices | ||
| 156 | wahlliste | ||
| 157 | Parametername | ||
| 158 | {http://wahlschein.v2.oliwa.services.endpoint.ireg.web.hshsoft.de/}wahlliste:version | ||
| 159 | Wert des Parameters | ||
| 160 | 1 | ||
| 161 | ``` | ||
| 162 | |||
| 163 | ![[Webservice Header Parameter|@WebServiceHeaderParameter.jpg]] | ||
| 164 | |||
| 165 | Die Werte "00000000" sind mit dem amtlichen Gemeindeschlüssel auszutauschen. Unter "WebService-HeaderParameter" ist der obig erwähnte X-ApiKey sowie ein Referer einzutragen. | ||
| 166 | |||
| 167 | --- | ||
| 168 | |||
| 169 | ## Konfiguration der Veröffentlichung | ||
| 170 | |||
| 171 | Beim entsprechenden Assistent muss eine WebService-Einreichung konfiguriert werden (siehe hierzu "[[Webservice Einrichten|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]])". Für die Einreichung wird der WebService "HSH-Briefwahlscheinantrag" ausgewählt. | ||
| 172 | |||
| 173 | ![[WebService Einreichung|@Einreichung.jpg]] | ||
| 174 | |||
| 175 | Damit diese Konfiguration genutzt wird, müssen über Formularkonfiguration weitere Veröffentlichungskonfigurationen definiert werden (siehe hierzu "[[Webservice Einrichten|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]])". | ||
| 176 | |||
| 177 | Das Formular muss per "Senden per E-Mail/Webservice" versendet werden. | ||
| 178 | |||
| 179 | ![[Auswahl Sendeart|@PHP12.jpg]] | ||
| 180 | |||
| 181 | Auf der nachfolgenden Seite muss die Option "Senden mit Webservice" ausgewählt und die entsprechende WebService-Url (siehe oben) hinterlegt werden. | ||
| 182 | |||
| 183 | ![[Hinterlegung Webservice URL|@PHP34.jpg]] | ||
| 184 | |||
| 185 | Nach Bestätigen der Seite ist die Konfiguration abgeschlossen. |