Zum Inhalt springen

Wiki-Quellcode von CMS-Schnittstelle

Version 3.1 von MACH ProForms GmbH am 08.10.2020
Zeige letzte Bearbeiter
1 ## Mehrwert technischer Kooperation
2
3 Durch die Implementierung einer Schnittstelle zwischen einem CMS, DMS, Fachverfahren etc. (nachfolgend Partnersystem genannt) und dem Formularserver kann je nach Ausgestaltung ein erheblicher Mehrwert für gemeinsame Kunden erreicht werden. Eine technische Kooperation zwischen den Systemen ist dabei nicht nur ein weiteres Produkt, das den bestehenden Kunden als ein nützliches Add-On angeboten werden kann. Insbesondere im kommunalen Markt gewinnt Interoperabilität von IuKSystemen eine rasant wachsende Bedeutung und wird somit für alle Anbieter zu einem zentralen Vertriebsargument für ihr Basisprodukt.
4
5 Nachfolgend werden einige Implementierungsvarianten der Schnittstelle beschrieben, die mit einem relativ überschaubaren Aufwand umgesetzt werden können:
6
7 ### Redundanzfreie Benutzerverwaltung
8
9 Durch die Verbindung des Partnersystems mit dem Form-Solutions Formularserver kann die Benutzerverwaltung für beide Systeme einheitlich aus der Oberfläche des Partnersystems erfolgen. Die doppelte Erfassung und Pflege der Benutzer entfällt somit künftig für den Kunden, wodurch sowohl der administrative Aufwand, wie auch das Risiko von Fehleingaben halbiert werden.
10
11 Bei personell stets sparsam ausgestatteten IT-Abteilungen der Öffentlichen Hand bedeutet die Aufhebung der Benutzerverwaltungsredundanz einen spürbaren monetären Nutzen, der bei der Auswahl von Software entscheidend sein kann.
12
13 ### Single Sign On
14
15 Mitarbeiter der Kunden beider Systeme sind mit dem Einsatz der Schnittstelle nicht mehr gezwungen sich mehrfach in jedem System separat zu authentifizieren. Mit der einmaligen Passworteingabe beim Partnersystem erfolgt der Login beim Formularserver vollautomatisch. Mit der einfacheren, hindernisfreien Nutzung und der Zeitersparnis für alle Nutzer erhöht das Single Sign On die Effizienz beider Programme. Ferner führt der Wegfall des Umgangs mit mehreren Passwörtern für jeden Nutzer zur Minderung des Administrationsaufwands und zur Erhöhung der Sicherheit, da die Passwörter zur Gedächtnisstütze nicht mehr schriftlich notiert werden müssen.
16
17 ### Vorausgefüllte Formulare im Intranetbereich
18
19 Im Bereich des Intranets besteht der Vorteil, dass i.d.R. die gesamte Nutzergruppe und damit alle Absender und Empfänger von Formularen bekannt sind. Die im Partnersystem gespeicherten Personaldaten können ausgelesen und zur Vorbefüllung von
20 Formularen verwendet werden. Je nach Geschäftsvorfall wird damit ein Großteil der Formularfelder automatisch ausgefüllt, wodurch die Fehlerquote und der Aufwand bei der manuellen Formularbefüllung auf ein absolutes Minimum reduziert und die gesamte Durchlaufzeit von internen Prozessen deutlich beschleunigt werden kann.
21
22 ### Parametrisierungsdynamik
23
24 In bestimmten Lebenslagen muss der Bürger gleich mehrfach in Interaktion zu seiner Gemeinde treten und damit i.d.R. gleichzeitig oder in einem kurzen Zeitraum eine Vielzahl von Formularen ausfüllen.
25
26 **Beispiel: Lebenslage Wohnungswechsel/Umzug**
27
28 Bei einem Umzug muss eine Familie bei der Gemeinde ihren Wohnsitz, ihre Kinder bei der Musikschule und / oder im Kindergarten, ihren Hund bei der Steuerbehörde, Strom, Wasser und Müll bei den Stadtwerken usw. anmelden.
29
30 Diese Liste kann beliebig weitergeführt werden. In dem genannten Beispiel muss die Familie mindestens sieben Formulare ausfüllen. Dabei ist ein Großteil der notwendigen Daten identisch und muss trotzdem wiederholt händisch eingeben werden. Stattdessen kann mit Einverständnis des Bürgers ein Teil der notwendigen Daten zentral zwischengespeichert werden. Mit diesen Daten können die weiteren formulargestützten Interaktionen des Bürgers mit der Gemeinde automatisch vorparametrisiert werden. Der Bürger kann damit in einem viel schnelleren und einfacheren Rahmen seine Anträge vervollständigen und an die Gemeinde weiterleiten. Dies führt mittelfristig zu einer höheren Akzeptanz beim Bürger. Für den Sachbearbeiter bedeutet eine automatische Parametrisierung der Formulare vollständigere und fehlerreduzierte Anträge. Die Bearbeitungszeit für Prüfung, Vervollständigung und Anordnung der Wiedervorlage kann verkürzt werden, was wiederum zu kürzeren Durchlaufzeiten und damit zu höherer Verwaltungseffizienz, sowie besserer Bürgerzufriedenheit beiträgt.
31
32 ### Systemintegration und Mehrwertkonzentration
33
34 Aus dem Partnersystem-Bereich können Kunden direkt die wichtigsten Komponenten des Formularservers ansprechen, bedienen und konfigurieren und damit aus einer Umgebung heraus ohne jegliche Umstellung den Mehrwert beider Systeme vereinen. Trotz plattformübergreifender Funktionalität befindet sich der Nutzer auf einer einheitlichen Oberfläche und braucht bei der täglichen Arbeit nicht ständig zwischen einer Vielzahl von Userinterfaces zu wechseln.
35
36 Unter anderem können die folgenden Komponenten aus dem Partnersystem angesteuert werden:
37
38 #### Formularrecherche
39
40 Der Formularserver enthält ein umfassendes Recherchesystem für Schlagwörter, Namen, Formularnummern und Volltext. Zusätzlich wird die Suche durch standardmäßige Klassifizierung der Formulare in u.a. Kategorie, Dateityp und Datum weiter präzisiert. Weiterhin kann zwischen Verlagsformularen und kundenspezifischen Formularen unterschieden werden.
41
42 #### Formularkonfiguration
43
44 Vor der Veröffentlichung eines bestimmten Formulars können im Formularserver zunächst die Eigenschaften und die Funktionalität desselben festgelegt werden. Durch die Definition der einzelnen Parameter wird bei der Veröffentlichung des Formulars je nach Einstellung der spezifische Link generiert. Hierzu gehört die Festlegung der:
45
46 - zu verwendeten Schaltflächen und damit die durch den Bürger ansprechbaren Funktionalitäten (z.B. Formular online senden, digital signieren etc.)
47 - Formularsicherheit, zu der die Dokumentenverschlüsselung und die Dokumenteneinschränkung zählen (z.B. Drucken nicht zulässig)
48 - Benachrichtigungsoptionen
49 Diese dienen zur Festlegung der E-Mail-Adressen, die beim elektronischen Versand von Formularen benachrichtigt werden.
50 - eCash Optionen
51 Soweit bei den Schaltflächen „Senden mit eCash“ ausgewählt wurde, können bei den eCash Optionen der einzuziehende Betrag und interne Vermerke definiert werden. Bei der Bezahlung mit eCash kann gleichzeitig ein Genehmigungsprozess angestoßen werden.
52 - S-Internetkassen Optionen
53 Ebenfalls für die Bezahlung von Verwaltungsdienstleitungen kann die S-Internetkasse verwendet werden. Diese Bezahllösung beinhaltet die Möglichkeit zwischen drei Bezahlvarianten zu wählen: Bankeinzug, Kreditkarte und Giropay. Dabei kann die Kommune im Vorfeld bestimmen, welche Bezahlvarianten für den Bürger zur Verfügung stehen.
54
55 #### Formulare hochladen
56
57 Die Funktion „Formulare hochladen“ dient zur Übertragung lokal gespeicherter und selbsterstellter Formulare der Kunden auf den Formularserver. Vor dem Hochladevorgang müssen dabei zusätzlich einige Metadaten zum Dokument wie Formularname, Nummer, Kategorie usw. eingegeben werden.
58
59 #### Standard Login
60
61 Trotz umfangreicher Komponenten, die unmittelbar aus der Oberfläche des Partnersystems angesprochen werden können, wäre die Übernahme der kompletten Formularserver Funktionalität zu aufwendig. Hierfür bietet es sich an, einen direkten Login zum Formularserver via Jumplink zu implementieren. Der Benutzer kann sich dabei über die Betätigung eines Buttons im Partnersystem direkt in seinem Account auf dem Formularserver einloggen und im Bedarfsfall so zwischen den Applikationen wechseln.
62
63 ___
64
65 ## Technische Schnittstellendokumentation
66
67 ### Server2Server Schnittstellen
68
69 Server2Server Schnittstellen sind Schnittstellen zur direkten Kommunikation zwischen zwei Servern, um Benutzer- und Laufdaten auf beiden Servern synchron zu halten.
70
71 #### Webservices
72
73 Webservices sind serverseitige Dienste die Daten zwischen zwei Servern mittels des SOAP-Protokolls austauschen. SOAP ist eine abwärtskompatible Weiterentwicklung von XML. Webservice-Klassen sind in die meisten Web-Sprachen eingebettet oder für diese verfügbar. Für PHP empfehlen wir die NuSOAP Klasse, die dieser Dokumentation beigefügt ist. Mit .NET+ besteht eine Inkompatibilität in der Interpretation der HTTP1.1 Referenz, **mit .NET+ bitte HTTP1.0 verwenden.**
74
75 ![[Abbildung 1: Webservice- Schnittstelle|@ws-diagram.jpg]]
76
77 #### Interaktive Schnittstelle
78
79 Interaktive Schnittstellen wurden für Bereiche entwickelt, in denen häufige Änderungen von uns vorgenommen werden und die einer laufenden Nachbesserung bedürfen. Hierzu wird (in einem neuen Fenster) eine Webseite vom Form-Solutions aufgerufen, die nach Ablauf des Dialogs Daten an eine angegebene Webseite übergibt oder, wenn es keiner Datenübergabe bedarf, vom Benutzer geschlossen werden kann.
80
81 ![[Abbildung 2: Interaktive Schnittstelle|@ws-interactive-diagram.jpg]]
82
83 ___
84
85
86 ## Funktionen der Server2Server Schnittstellen
87
88 ### getuser
89
90 getuser liefert die Daten eines Benutzers in einem Array.
91
92 #### Webservice-URL:
93
94 <https://pdf.form-solutions.net/ws2/getuser.php>
95
96 #### Beispieldatei:
97
98 <https://demo.form-solutions.net/ws2/getuser_client.php>
99
100 #### Datenstruktur
101
102 ##### Geforderte Daten
103
104 - **cms**
105 `varchar(32)`
106 CMS-Key des Kunden
107
108 - **User**
109 `varchar (18)`
110 Benutzernummer des Benutzers, dessen Daten vom System zurückgegeben werden.
111
112 ##### Zurückgegebene Daten
113
114 - **Benutzer**
115 `varchar(18)`
116 Benutzernummer
117
118 - **ofsXX1_knr_std**
119 `varchar(13)`
120 Kundennummer
121
122 - **sysmail**
123 `varchar(59)`
124 E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
125
126 - **nick**
127 `varchar(50)`
128 alternativer Benutzername
129
130 - **b12c96nfBehoerde_Amt**
131 `varchar(255)`
132 Amt des Benutzers, z.B. Medienbüro, Finanzamt
133
134 - **b12c96nfBehoerde_Sachbearbeiter_Name**
135 `varchar(50)`
136 Name des Sachbearbeiters
137
138 - **b12c96nfBehoerde_Strasse**
139 `varchar(150)`
140 Straßenname der Behördenanschrift
141
142 - **ofsXX1_from_smail3**
143 `varchar(150)`
144 E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
145
146 - **ofsXX1_to_smail3**
147 `varchar(150)`
148 E-Mail-Adresse an die Formulardaten gesendet werden.
149
150 - **b12c96nfBehoerde1**
151 `text`
152 Behördenname
153 z.B. Stadtverwaltung Karlsruhe
154
155 - **b12c96nfBehoerde1Anschrift**
156 `text`
157 Anschrift der Behörde einzeilig
158
159 - **b12c96nmBehoerde**
160 `text`
161 Anschrift der Behörde dreizeilig
162 Zeilenumbruch: `\<br\>`
163
164 - **b12c96nmEmpfaenger**
165 `text`
166 Anschrift der Behörde sechszeilig
167 Zeilenumbruch: `\<br\>`
168
169 - **b12c96nfBehoerde_PLZ_Ort**
170 `varchar(50)`
171 PLZ, Ort der Behördenanschrift z.B. 75217 Birkenfeld
172
173 - **b12c96nfBehoerde_Sachbearbeiter_Name**
174 `varchar(50)`
175 Name des Sachbearbeiters
176
177 - **b12c96nfSachbearbeiter_Zimmernummer**
178 `varchar(20)`
179 Zimmernummer des Sachbearbeiters
180
181 - **b12c96nfSachbearbeiter_Telefon**
182 `varchar(30)`
183 Telefonnummer des Sachbearbeiters (mit Vorwahl)
184
185 - **b12c96nfSachbearbeiter_Telefax**
186 `varchar(30)`
187 Faxnummer des Sachbearbeiters (ohne Vorwahl)
188
189 - **b12c96nfSachbearbeiter_E_Mail**
190 `varchar(30)`
191 E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
192
193 - **b12c96nfGemeindekennzahl**
194 `varchar(8)`
195 Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer)
196
197 - **b12c96nfOrt_Datum**
198 `varchar(50)`
199 Ort, Datumszeile im Formular z.B. Birkenfeld, den
200
201 - **b12c96nmOrt_Datum2**
202 `text`
203 Ort, Datumszeile zweizeilig im Formular
204 z.B. Birkenfeld, `\<br\>`
205 den
206
207 - **b12c96nfAntragsteller_PLZ**
208 `varchar(10)`
209 Vollständige oder teilweise Postleitzahl des Antragstellers
210
211 - **b12c96nfBehoerde_PLZ_Post**
212 `varchar(7)`
213 Postleitzahl der Behördenanschrift
214
215 - **b12c96nfAntragsteller_Ort**
216 `varchar(30)`
217 Ortsname des Antragstellers
218
219 - **b12c96nfAktenzeichen**
220 `varchar(30)`
221 Aktenzeichen des Formularvorgangs
222
223 - **b12c96nfKontakt1Z**
224 `varchar(250)`
225 Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt
226
227 - **b12c96nmRechtsbehelfsbelehrung**
228 `text`
229 Rechtsbehelfsbelehrung, die ins Formular eingefügt wird
230
231 - **b12c96nfSachbearbeiter_Personalnummer**
232 `varchar(50)`
233 Personalnummer des Sachbearbeiters
234
235 - **b12c96nfBehoerde_Ort**
236 `varchar(255)`
237 Ortsname der Behördenanschrift
238
239 - **ec_sel**
240 `int(0,1)`
241 Der Benutzer hat das Recht eCash Formulare zu generieren.
242
243 - **ec_stat**
244 `int(0,1)`
245 Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
246
247 - **barcode_sel**
248 `int(0,1)`
249 Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
250
251 - **usr_anl**
252 `int(0,1)`
253 Der Benutzer hat das Recht weitere Benutzer im Form-Solutions System anzulegen.
254
255 - **usr_shw**
256 `int(0,1)`
257 Der Benutzer hat das Recht andere Benutzer zu verwalten.
258
259 - **usr_chg**
260 `int(0,1)`
261 Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
262
263 - **usr_login**
264 `int(0,1)`
265 Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
266
267 - **usr_del**
268 `int(0,1)`
269 Der Benutzer hat das Recht andere Benutzerdatensätze im Form-Solutions System zu löschen.
270
271 - **give_right**
272 `int(0,1)`
273 Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
274
275 - **ch_pers**
276 `int(0,1)`
277 Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
278
279 - **preset**
280 `int(0,1)`
281 Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
282
283 - **form_sel**
284 `int (0,1)`
285 Der Benutzer hat das Recht Formulare für alle Benutzer ein- oder auszublenden.
286
287 - **form_deliver**
288 `int(0,1)`
289 Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
290
291 - **form_del**
292 `int(0,1)`
293 Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
294
295 - **form_def_set**
296 `int(0,1)`
297 Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
298
299 - **logo**
300 `int(0,1)`
301 Der Benutzer hat das Recht ein neues Logo hochzuladen.
302
303 - **Exp_ben**
304 `int(0,1)`
305 Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
306
307 - **Exp_form**
308 `int(0,1)`
309 Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
310
311 - **data**
312 `int(0,1)`
313 Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu exportieren.
314
315 - **data_exp**
316 `int(0,1)`
317 Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
318
319 - **archive**
320 `int(0,1)`
321 Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu archivieren.
322
323 - **archive_exp**
324 `int(0,1)`
325 Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare archivieren darf.
326
327 - **Shw_admin**
328 `int(0,1)`
329 Der Benutzer hat das Recht den Administrator Datensatz (-0000) zu sehen und zu verändern.
330
331 ### getusers
332
333 Auf Anfrage erzeugt getusers ein zweidimensionales Array mit den Daten aller Benutzer eines CMS-Keys.
334
335 #### Webservice-URL:
336
337 <https://pdf.form-solutions.net/ws2/getusers.php>
338
339 #### Beispieldatei:
340
341 <https://demo.form-solutions.net/ws2/getusers_client.php>
342
343 #### Datenstruktur
344
345 ##### Geforderte Daten
346
347 - **cms**
348 `varchar(32)`
349 CMS-Key des Kunden
350
351 ##### Zurückgegebene Daten
352
353 Als Ergebnis erhält man ein Array mit Benutzerobjekten. Die einzelnen Objekte entsprechen der Struktur wie unter getuser beschrieben.
354
355 ### putuser (geänderte Daten)
356
357 Putuser legt einen Benutzer in der Datenbank an oder editiert einen vorhandenen Benutzer. Hier kann die Variable „Benutzer“ zwei Zustände haben:
358
359 1. eine vorhandene Benutzernummer -> Das System überschreibt die Daten des Benutzers mit den übergebenen Daten.
360 2. eine noch nicht vorhandene Benutzernummer -> Das System legt einen Benutzer mit dieser Benutzernummer an. Soll die Benutzernummer durch das System bestimmt werden, so muss das Schlüsselwort „new“ angegeben werden. Das System nimmt die nächste Benutzernummer und liefert diese zurück.
361
362 #### Webservice-URL:
363
364 <https://pdf.form-solutions.net/ws2/putuser.php>
365
366 #### Datenstruktur
367
368 ##### Geforderte Daten
369
370 - **Benutzer**
371 `varchar(18)`
372 Benutzernummer
373
374 - **sysmail**
375 `varchar(59)`
376 E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
377
378 - **nick**
379 `varchar(50)`
380 alternativer Benutzername
381
382 - **b12c96nfBehoerde_Amt**
383 `varchar(255)`
384 Amt des Benutzers z.B. Medienbüro, Finanzamt
385
386 - **b12c96nfBehoerde_Strasse**
387 `varchar(150)`
388 Straßenname der Behördenanschrift
389
390 - **ofsXX1_from_smail3**
391 `varchar(150)`
392 E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
393
394 - **ofsXX1_to_smail3**
395 `varchar(150)`
396 E-Mail-Adresse an die Formulardaten gesendet werden.
397
398 - **b12c96nfBehoerde1**
399 `text`
400 Behördenname z.B. Stadtverwaltung Karlsruhe
401
402 - **b12c96nfBehoerde1Anschrift**
403 `text`
404 Anschrift der Behörde einzeilig
405
406 - **b12c96nmBehoerde**
407 `text`
408 Anschrift der Behörde dreizeilig
409 Zeilenumbruch: `\<br\>`
410
411 - **b12c96nmEmpfaenger**
412 `text`
413 Anschrift der Behörde sechszeilig
414 Zeilenumbruch: `\<br\>`
415
416 - **b12c96nfBehoerde_PLZ_Ort**
417 `varchar(50)`
418 PLZ, Ort der Behördenanschrift, z.B. 75217 Birkenfeld
419
420 - **b12c96nfBehoerde_Sachbearbeiter_Name**
421 `varchar(50)`
422 Name des Sachbearbeiters
423
424 - **b12c96nfSachbearbeiter_Zimmernummer**
425 `varchar(20)`
426 Zimmernummer des Sachbearbeiters
427
428 - **b12c96nfSachbearbeiter_Telefon**
429 `varchar(30)`
430 Telefonnummer des Sachbearbeiters (mit Vorwahl)
431
432 - **b12c96nfSachbearbeiter_Telefax**
433 `varchar(30)`
434 Faxnummer des Sachbearbeiters (ohne Vorwahl)
435
436 - **b12c96nfSachbearbeiter_E_Mail**
437 `varchar(30)`
438 E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
439
440 - **b12c96nfGemeindekennzahl**
441 `varchar(8)`
442 Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer).
443
444 - **b12c96nfOrt_Datum**
445 `varchar(50)`
446 Ort, Datumszeile im Formular z.B. Birkenfeld, den
447
448 - **b12c96nmOrt_Datum2**
449 `text`
450 Ort, Datumszeile zweizeilig im Formular
451 z.B. Birkenfeld, `\<br\>`
452 den
453
454 - **b12c96nfAntragsteller_PLZ**
455 `varchar(10)`
456 Vollständige oder teilweise Postleitzahl des Antragstellers.
457
458 - **b12c96nfBehoerde_PLZ_Post**
459 `varchar(7)`
460 Postleitzahl der Behördenanschrift
461
462 - **b12c96nfAntragsteller_Ort**
463 `varchar(30)`
464 Ortsname des Antragstellers
465
466 - **b12c96nfAktenzeichen**
467 `varchar(30)`
468 Aktenzeichen des Formularvorgangs
469
470 - **b12c96nfKontakt1Z**
471 `varchar(250)`
472 Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt.
473
474 - **b12c96nmRechtsbehelfsbelehrung**
475 `text`
476 Rechtsbehelfsbelehrung, die ins Formular eingefügt wird.
477
478 - **b12c96nfSachbearbeiter_Personalnummer**
479 `varchar(50)`
480 Personalnummer des Sachbearbeiters
481
482 - **b12c96nfBehoerde_Ort**
483 `varchar(255)`
484 Ortsname der Behördenanschrift
485
486 - **ec_sel**
487 `int(0,1)`
488 Der Benutzer hat das Recht eCash Formulare zu generieren.
489
490 - **ec_stat**
491 `int(0,1)`
492 Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
493
494 - **barcode_sel**
495 `int(0,1)`
496 Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
497
498 - **usr_anl**
499 `int(0,1)`
500 Der Benutzer hat das Recht weitere Benutzer im Form-Solutions System anzulegen.
501
502 - **usr_shw**
503 `int(0,1)`
504 Der Benutzer hat das Recht andere Benutzer zu verwalten.
505
506 - **usr_chg**
507 `int(0,1)`
508 Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
509
510 - **usr_login**
511 `int(0,1)`
512 Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
513
514 - **usr_del**
515 `int(0,1)`
516 Der Benutzer hat das Recht andere Benutzerdatensätze im Form-Solutions System zu löschen.
517
518 - **give_right**
519 `int(0,1)`
520 Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
521
522 - **ch_pers**
523 `int(0,1)`
524 Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
525
526 - **preset**
527 `int(0,1)`
528 Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
529
530 - **form_sel**
531 `int(0,1)`
532 Der Benutzer hat das Recht Formulare für alle Benutzer ein oder auszublenden.
533
534 - **form_deliver**
535 `int(0,1)`
536 Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
537
538 - **form_del**
539 `int(0,1)`
540 Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
541
542 - **form_def_set**
543 `int(0,1)`
544 Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
545
546 - **logo**
547 `int(0,1)`
548 Der Benutzer hat das Recht ein neues Logo hochzuladen.
549
550 - **exp_ben**
551 `int(0,1)`
552 Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
553
554 - **exp_form**
555 `int(0,1)`
556 Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
557
558 - **data**
559 `int(0,1)`
560 Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu exportieren.
561
562 - **data_exp**
563 `int(0,1)`
564 Dieses Rechts beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
565
566 - **archive**
567 `int(0,1)`
568 Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu archivieren.
569
570 - **archive_exp**
571 `int(0,1)`
572 Dieses Rechts beschreibt, dass der Benutzer eingegangene Formulardaten nur von bestimmten Formularen archivieren darf.
573
574 - **shw_admin**
575 `int(0,1)`
576 Der Benutzer hat das Recht den Administrator-Datensatz (-0000) zu sehen und zu verändern.
577
578 ##### 3.3.2.2 Zurückgegebene Daten
579
580 - **Status**
581 `String`
582
583 - **Benutzer**
584 `varchar(18)`
585
586 - **password**
587 `varchar(50)`
588
589 ##### Besonderheiten
590
591 Die CMS-Schnittstelle ist nicht dazu in der Lage, Benutzer mit Benutzerrollen anzulegen oder zu verwalten, da nicht alle Rechte vergeben werden können. Daher sind alle CMS-Schnittstellen Benutzerdatensätze mit Einzelrechten ausgestattet.
592
593 Weiterhin ist zu beachten, dass die Rechte `data_exp` und `archive_exp` einschränkende Rechte sind. Diese Rechte sind mit
594 der neuen Sortimentsverwaltung obsolet geworden. Wenn die Benutzerrechte `Transaktionsdaten Archivieren` und `Transaktionsdaten exportieren` gesetzt werden sollen, müssen `archive` und `data` gesetzt sein, und die rechte `archive_exp` und `data_exp` dürfen nicht gesetzt sein.
595
596 ### deluser
597
598 Deluser löscht einen spezifischen Benutzer aus der Form-Solutions Datenbank.
599
600 #### Webservice-URL:
601
602 <https://pdf.form-solutions.net/ws2/deluser.php>
603
604 #### Datenstruktur
605
606 ##### Geforderte Daten
607
608 - **cms**
609 `varchar(32)`
610 CMS-Key des Kunden
611
612 - **user**
613 `varchar(18)`
614 Benutzernummer des Benutzers, dessen Daten vom System gelöscht werden sollen.
615
616 ##### Zurückgegebene Daten
617
618 - **Status**
619 `String`
620
621 ### getticket
622
623 Auf Anfrage generiert getticket ein einmaliges Ticket, das zur Authentifizierung der interaktiven Schnittstellen gedacht ist.
624
625 #### Webservice-URL:
626
627 <https://pdf.form-solutions.net/ws2/getticket.php>
628
629 ### Beispieldatei:
630
631 <https://demo.form-solutions.net/ws2/getticket_client.php>
632
633 #### Datenstruktur
634
635 ##### Geforderte Daten
636
637 - **cms**
638 `varchar(32)`
639 CMS-Key des Kunden
640
641 ##### Zurückgegebene Daten
642
643 - **ticket**
644 varchar(64)`
645 Einmalticket, das zum Aufruf eines Prozesses bei interaktiven Schnittstellen eingesetzt wird.
646
647 ### getformlist
648
649 Auf Anfrage generiert getformlist ein Datenarray aller Formulare, welche der durch den CMS-Key authentifizierte Kunde nutzen kann.
650
651 > ***Hinweis:***
652 > Diese Funktion liefert keine Daten über Assistenten mit.
653
654 #### Webservice-URL:
655
656 <https://pdf.form-solutions.net/ws2/getformlist.php>
657
658 #### Beispieldatei:
659
660 <https://demo.form-solutions.net/ws2/getformlist_client.php>
661
662 #### Datenstruktur
663
664 ##### Geforderte Daten
665
666 - **cms**
667 `varchar(32)`
668 CMS-Key des Kunden
669
670 #### Zurückgegebene Daten
671
672 Es wird ein Array mit Formulardaten zurückgeliefert. Jedes Element enthält dabei folgende Daten:
673
674 - **fnr**
675 `varchar(250)`
676 Formularnummer
677
678 - **title**
679 `varchar(250)`
680 Formularname
681
682 - **kat**
683 `varchar(250)`
684 Formularkategorie
685
686 - **pagecount**
687 `int(10)`
688 Anzahl der Formularseiten
689
690 - **created**
691 `date(Y-M-D)`
692 Erstellungsdatum
693
694 - **changed**
695 `date(Y-M-D)`
696 Datum der letzten Änderung
697
698 - **bem**
699 `text`
700 Bemerkungen zum Formular
701
702 - **beschr**
703 `text`
704 Beschreibung des Formulars
705
706 - **formtype**
707 `varchar(3)`
708 Form-Solutions unterscheidet zwischen 2 Formulartypen.
709 fs = ein von Form-Solutions erstelltes Formular
710 knd = ein vom Kunden erstelltes Formular
711
712 ___
713
714 ## Funktionen der Interaktiven Schnittstellen
715
716 ### Sign-In
717
718 Mit dieser Funktion können Sie einen Benutzer ohne weitere Loginabfragen im FormSolutions System einloggen.
719
720 #### URL:
721
722 <https://pdf.form-solutions.net/ticket-in.php>
723
724 #### Übergabeparameter:
725
726 - **Usr**
727 Benutzernummer des Benutzers im FS-System
728
729 - **ticket**
730 Ticketnummer, die zuvor per Webservice angefordert wurde
731
732 - **type**
733 signin`
734
735 ### Formular suchen und Formularlink erstellen
736
737 Diese Funktion öffnet einen Suchdialog, in dem der Benutzer ein Formular suchen und konfigurieren kann. Nach Abschluss dieser Funktion wird die generierte URL an eine übergebene Ziel-URL weitergereicht.
738
739 #### URL:
740
741 <https://pdf.form-solutions.net/ticket-in.php>
742
743 #### Übergabeparameter:
744
745 - **usr**
746 Benutzernummer des Benutzers im FS-System
747
748 - **ticket**
749 Ticketnummer, die zuvor per Webservice angefordert wurde
750
751 - **type**
752 `formsearch`
753
754 - **return**
755 URL, an die der erstellte Formlink übergeben werden soll. Diese URL muss so aussehen, dass am Ende der URL der Formularlink angefügt werden kann. Bsp: <https://pdf.form-solutions.net//ws/back.php?data=>
756 Des Weiteren muss der übergebene Link urlencoded gesendet werden. In dem übergebenen Link wird zusätzlich urlencoded mit dem Parameter `title` der Titel des Formulars und mit dem Parameter `id` die Formularnummer mitgegeben.
757
758 > ***Hinweis:***
759 > In der Variante mit dem type formsearch kann man ab der Release-Version 32.13.0 auch Assistenten suchen. Die Überarbeitung von Assistentenlinks erfolgt ebenso über diese Variante.
760
761 ### Basisformularlink erstellen
762
763 Die Funktion `getbaselink` übergibt einen sicheren Link zu einem Formular ohne weitere Funktionen wie Senden, Barcode, S-Internetkasse oder eCash.
764
765 #### URL:
766
767 <https://pdf.form-solutions.net/ws2/getbaselink.php>
768
769 #### Beispieldatei
770
771 <https://demo.form-solutions.net/ws2/getbaselink_client.php>
772
773 #### Übergabeparameter
774
775 ##### Geforderte Daten:
776
777 - **cms**
778 CMS-Key des Kunden
779
780 - **user**
781 Benutzernummer des Benutzers im FS-System
782
783 - **form**
784 Formularnummer
785
786 ##### Zurückgegebene Daten
787
788 - **Sicherer Link**
789
790 > ***Hinweis:***
791 > Diese Funktion steht für Assistenten nicht zur Verfügung.
792
793 ### Individualformularlink erstellen
794
795 Diese Funktion öffnet einen Konfigurationsdialog, in dem der Benutzer ein übergebenes Formular konfigurieren kann. Nach Abschluss dieser Funktion wird die generierte URL an eine übergebene Ziel-URL weitergereicht.
796
797 #### URL:
798
799 <https://pdf.form-solutions.net/ticket-in.php>
800
801 #### Übergabeparameter:
802
803 - **usr**
804 Benutzernummer des Benutzers im FS-System
805
806 - **ticket**
807 Ticketnummer, die zuvor per Webservice angefordert wurde
808
809 - **type**
810 `formlink`
811
812 - **formular**
813 Formularnummer
814
815 - **formtype**
816 Ist dies ein von Form-Solutions oder ein vom Kunden erstelltes Formular? (`fs`, `knr`) (siehe 3.6.3.2 getformlist - Zurückgegebene Daten, Variable `formtype`)
817
818 - **return**
819 URL an die der erstellte Formlink übergeben werden soll. Diese URL muss so aussehen, dass am Ende der URL der Formularlink angefügt werden kann.
820 Bsp: <https://pdf.form-solutions.net/ws2/back.php?data=>
821 Des Weiteren muss der übergebene Link urlencoded gesendet werden. In dem übergebenen Link wird zusätzlich urlencoded mit dem Parameter title der Titel des Formulars und mit dem Parameter `id` die Formularnummer mitgegeben.
822
823 > ***Hinweis:***
824 > Diese Funktion steht für Assistenten nicht zur Verfügung.