Änderungen von Dokument CMS-Schnittstelle

Zuletzt geändert von MACH ProForms GmbH am 10.10.2024

Von 176.1 nach 175.1 Von 183.1 nach 182.1

Von Version 182.1

bearbeitet von MACH ProForms GmbH
am 10.10.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 176.1

bearbeitet von MACH ProForms GmbH
am 22.09.2022

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (1 geändert, 0 hinzugefügt, 0 gelöscht)
- logo.jpg

Details

Seiteneigenschaften

Inhalt

@@ -1,32 +5,29 @@
--## Voraussetzungen
--
--Sie benötigen einen gültigen [[CMS-Key|doc:Main.01_Systemadministration.03_Installation.03_Abschliessend.02_Datenbank.01_CMS.WebHome]].
--
  ## Mehrwert technischer Kooperation
--Durch die Implementierung einer Schnittstelle zwischen einem CMS, DMS, Fachverfahren etc. (nachfolgend Partnersystem genannt) und dem Formular-Server 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 IuK-Systemen (Informations- und Kommunikations-Systemen) rasant an Bedeutung und wird somit für alle Anbieter zu einem zentralen Vertriebsargument für ihr Basisprodukt.
++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.
  Nachfolgend werden einige Implementierungsvarianten der Schnittstelle beschrieben, die mit einem relativ überschaubaren Aufwand umgesetzt werden können:
  ### Redundanzfreie Benutzerverwaltung
--Durch die Verbindung des Partnersystems mit MACH formsolutions 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.
++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.
--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.
++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.
  ### Single Sign On
--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 Reduzierung des Administrationsaufwands und zur Erhöhung der Sicherheit, da die Passwörter zur Gedächtnisstütze nicht mehr schriftlich notiert werden müssen.
++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.
--### Vorausgefüllte Formulare im Intranet-Bereich
++### Vorausgefüllte Formulare im Intranetbereich
--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 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 Minimum reduziert und die gesamte Durchlaufzeit von internen Prozessen deutlich beschleunigt werden kann.
++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
++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.
  ### Parametrisierungsdynamik
--In bestimmten Lebenslagen muss der Bürger mehrfach in Interaktion zu seiner Gemeinde treten und damit i.d.R. gleichzeitig oder in einem kurzen Zeitraum eine Vielzahl von Formularen ausfüllen.
++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.
--**Beispiel: Lebenslage Wohnungswechsel/Umzug**
++**Beispiel: Lebenslage Wohnungswechsel/Umzug**
  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.
@@ -34,26 +34,26 @@
  ### Systemintegration und Mehrwertkonzentration
--Aus dem Partnersystem-Bereich können Kunden direkt die wichtigsten Komponenten des Formular-Servers 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.
++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.
  Unter anderem können die folgenden Komponenten aus dem Partnersystem angesteuert werden:
--#### Formular-Recherche
++#### Formularrecherche
--Der Formular-Server enthält ein umfassendes Recherche-System 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.
++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.
  #### Formularkonfiguration
--Vor der Veröffentlichung eines bestimmten Formulars können im Formular-Server 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:
++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:
--* zu verwendeten Schaltflächen und damit die durch den Bürger ansprechbaren Funktionalitäten (z.B. Formular online senden, digital signieren etc.)
--* Formularsicherheit, zu der die Dokumentenverschlüsselung und die Dokumenteneinschränkung zählen (z.B. Drucken nicht zulässig)
--* Benachrichtigungsoptionen
--Diese dienen zur Festlegung der E-Mail-Adressen, die beim elektronischen Versand von Formularen benachrichtigt werden.
--* eCash Optionen
--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.
--* S-Internetkassen Optionen
--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.
++- zu verwendeten Schaltflächen und damit die durch den Bürger ansprechbaren Funktionalitäten (z.B. Formular online senden, digital signieren etc.)
++- Formularsicherheit, zu der die Dokumentenverschlüsselung und die Dokumenteneinschränkung zählen (z.B. Drucken nicht zulässig)
++- Benachrichtigungsoptionen
++ Diese dienen zur Festlegung der E-Mail-Adressen, die beim elektronischen Versand von Formularen benachrichtigt werden.
++- eCash Optionen
++ 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.
++- S-Internetkassen Optionen
++ 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.
  #### Formulare hochladen
@@ -63,7 +63,7 @@
  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.
-----
++___
  ## Technische Schnittstellendokumentation
@@ -79,12 +79,13 @@
  #### Interaktive Schnittstelle
--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 MACH ProForms aufgerufen, die nach Ablauf des Dialogs Daten an eine angegebene Webseite übergibt oder, wenn es keiner Datenübergabe bedarf, vom Benutzer geschlossen werden kann.
++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.
  ![[Abbildung 2: Interaktive Schnittstelle|@ws-interactive-diagram.jpg]]
-----
++___
++
  ## Funktionen der Server2Server Schnittstellen
  ### getuser
@@ -95,184 +95,241 @@
  <https://pdf.form-solutions.net/ws2/getuser.php>
++#### Beispieldatei:
++
++<https://demo.form-solutions.net/ws2/getuser_client.php>
++
  #### Datenstruktur
  ##### Geforderte Daten
--* **cms**
++- **cms**
  `varchar(32)`
--CMS-Key des Kunden
--* **User**
--`varchar (18)`
--Benutzernummer des Benutzers, dessen Daten vom System zurückgegeben werden.
++ CMS-Key des Kunden
++- **User**
++ `varchar (18)`
++ Benutzernummer des Benutzers, dessen Daten vom System zurückgegeben werden.
++
  ##### Zurückgegebene Daten
--* **Benutzer**
--`varchar(18)`
--Benutzernummer
--* **ofsXX1_knr_std**
--`varchar(13)`
--Kundennummer
--* **sysmail**
--`varchar(59)`
--E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
--* **nick**
--`varchar(50)`
--alternativer Benutzername
--* **b12c96nfBehoerde_Amt**
--`varchar(255)`
--Amt des Benutzers, z.B. Medienbüro, Finanzamt
--* **b12c96nfBehoerde_Sachbearbeiter_Name**
--`varchar(50)`
--Name des Sachbearbeiters
--* **b12c96nfBehoerde_Strasse**
--`varchar(150)`
--Straßenname der Behördenanschrift
--* **ofsXX1_from_smail3**
--`varchar(150)`
--E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
--* **ofsXX1_to_smail3**
--`varchar(150)`
--E-Mail-Adresse an die Formulardaten gesendet werden.
--* **b12c96nfBehoerde1**
--`text`
--Behördenname
--z.B. Stadtverwaltung Karlsruhe
--* **b12c96nfBehoerde1Anschrift**
--`text`
--Anschrift der Behörde einzeilig
--* **b12c96nmBehoerde**
--`text`
--Anschrift der Behörde dreizeilig
--Zeilenumbruch: `\<br\>`
--* **b12c96nmEmpfaenger**
--`text`
--Anschrift der Behörde sechszeilig
--Zeilenumbruch: `\<br\>`
--* **b12c96nfBehoerde_PLZ_Ort**
--`varchar(50)`
--PLZ, Ort der Behördenanschrift z.B. 75217 Birkenfeld
--* **b12c96nfBehoerde_Sachbearbeiter_Name**
--`varchar(50)`
--Name des Sachbearbeiters
--* **b12c96nfSachbearbeiter_Zimmernummer**
--`varchar(20)`
--Zimmernummer des Sachbearbeiters
--* **b12c96nfSachbearbeiter_Telefon**
--`varchar(30)`
--Telefonnummer des Sachbearbeiters (mit Vorwahl)
--* **b12c96nfSachbearbeiter_Telefax**
--`varchar(30)`
--Faxnummer des Sachbearbeiters (ohne Vorwahl)
--* **b12c96nfSachbearbeiter_E_Mail**
--`varchar(30)`
--E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
--* **b12c96nfGemeindekennzahl**
--`varchar(8)`
--Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer)
--* **b12c96nfOrt_Datum**
--`varchar(50)`
--Ort, Datumszeile im Formular z.B. Birkenfeld, den
--* **b12c96nmOrt_Datum2**
--`text`
--Ort, Datumszeile zweizeilig im Formular
--z.B. Birkenfeld, `\<br\>`
--den
--* **b12c96nfAntragsteller_PLZ**
--`varchar(10)`
--Vollständige oder teilweise Postleitzahl des Antragstellers
--* **b12c96nfBehoerde_PLZ_Post**
--`varchar(7)`
--Postleitzahl der Behördenanschrift
--* **b12c96nfAntragsteller_Ort**
--`varchar(30)`
--Ortsname des Antragstellers
--* **b12c96nfAktenzeichen**
--`varchar(30)`
--Aktenzeichen des Formularvorgangs
--* **b12c96nfKontakt1Z**
--`varchar(250)`
--Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt
--* **b12c96nmRechtsbehelfsbelehrung**
--`text`
--Rechtsbehelfsbelehrung, die ins Formular eingefügt wird
--* **b12c96nfSachbearbeiter_Personalnummer**
--`varchar(50)`
--Personalnummer des Sachbearbeiters
--* **b12c96nfBehoerde_Ort**
--`varchar(255)`
--Ortsname der Behördenanschrift
--* **ec_sel**
++- **Benutzer**
++ `varchar(18)`
++ Benutzernummer
++
++- **ofsXX1_knr_std**
++ `varchar(13)`
++ Kundennummer
++
++- **sysmail**
++ `varchar(59)`
++ E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
++
++- **nick**
++ `varchar(50)`
++ alternativer Benutzername
++
++- **b12c96nfBehoerde_Amt**
++ `varchar(255)`
++ Amt des Benutzers, z.B. Medienbüro, Finanzamt
++
++- **b12c96nfBehoerde_Sachbearbeiter_Name**
++ `varchar(50)`
++ Name des Sachbearbeiters
++
++- **b12c96nfBehoerde_Strasse**
++ `varchar(150)`
++ Straßenname der Behördenanschrift
++
++- **ofsXX1_from_smail3**
++ `varchar(150)`
++ E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
++
++- **ofsXX1_to_smail3**
++ `varchar(150)`
++ E-Mail-Adresse an die Formulardaten gesendet werden.
++
++- **b12c96nfBehoerde1**
++ `text`
++ Behördenname
++ z.B. Stadtverwaltung Karlsruhe
++
++- **b12c96nfBehoerde1Anschrift**
++ `text`
++ Anschrift der Behörde einzeilig
++
++- **b12c96nmBehoerde**
++ `text`
++ Anschrift der Behörde dreizeilig
++ Zeilenumbruch: `\<br\>`
++
++- **b12c96nmEmpfaenger**
++ `text`
++ Anschrift der Behörde sechszeilig
++ Zeilenumbruch: `\<br\>`
++
++- **b12c96nfBehoerde_PLZ_Ort**
++ `varchar(50)`
++ PLZ, Ort der Behördenanschrift z.B. 75217 Birkenfeld
++
++- **b12c96nfBehoerde_Sachbearbeiter_Name**
++ `varchar(50)`
++ Name des Sachbearbeiters
++
++- **b12c96nfSachbearbeiter_Zimmernummer**
++ `varchar(20)`
++ Zimmernummer des Sachbearbeiters
++
++- **b12c96nfSachbearbeiter_Telefon**
++ `varchar(30)`
++ Telefonnummer des Sachbearbeiters (mit Vorwahl)
++
++- **b12c96nfSachbearbeiter_Telefax**
++ `varchar(30)`
++ Faxnummer des Sachbearbeiters (ohne Vorwahl)
++
++- **b12c96nfSachbearbeiter_E_Mail**
++ `varchar(30)`
++ E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
++
++- **b12c96nfGemeindekennzahl**
++ `varchar(8)`
++ Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer)
++
++- **b12c96nfOrt_Datum**
++ `varchar(50)`
++ Ort, Datumszeile im Formular z.B. Birkenfeld, den
++
++- **b12c96nmOrt_Datum2**
++ `text`
++ Ort, Datumszeile zweizeilig im Formular
++ z.B. Birkenfeld, `\<br\>`
++ den
++
++- **b12c96nfAntragsteller_PLZ**
++ `varchar(10)`
++ Vollständige oder teilweise Postleitzahl des Antragstellers
++
++- **b12c96nfBehoerde_PLZ_Post**
++ `varchar(7)`
++ Postleitzahl der Behördenanschrift
++
++- **b12c96nfAntragsteller_Ort**
++ `varchar(30)`
++ Ortsname des Antragstellers
++
++- **b12c96nfAktenzeichen**
++ `varchar(30)`
++ Aktenzeichen des Formularvorgangs
++
++- **b12c96nfKontakt1Z**
++ `varchar(250)`
++ Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt
++
++- **b12c96nmRechtsbehelfsbelehrung**
++ `text`
++ Rechtsbehelfsbelehrung, die ins Formular eingefügt wird
++
++- **b12c96nfSachbearbeiter_Personalnummer**
++ `varchar(50)`
++ Personalnummer des Sachbearbeiters
++
++- **b12c96nfBehoerde_Ort**
++ `varchar(255)`
++ Ortsname der Behördenanschrift
++
++- **ec_sel**
++ `int(0,1)`
++ Der Benutzer hat das Recht eCash Formulare zu generieren.
++
++- **ec_stat**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
++
++- **barcode_sel**
++ `int(0,1)`
++ Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
++
++- **usr_anl**
++ `int(0,1)`
++ Der Benutzer hat das Recht weitere Benutzer im Form-Solutions System anzulegen.
++
++- **usr_shw**
++ `int(0,1)`
++ Der Benutzer hat das Recht andere Benutzer zu verwalten.
++
++- **usr_chg**
++ `int(0,1)`
++ Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
++
++- **usr_login**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
++
++- **usr_del**
++ `int(0,1)`
++ Der Benutzer hat das Recht andere Benutzerdatensätze im Form-Solutions System zu löschen.
++
++- **give_right**
++ `int(0,1)`
++ Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
++
++- **ch_pers**
++ `int(0,1)`
++ Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
++
++- **preset**
  `int(0,1)`
--Der Benutzer hat das Recht eCash Formulare zu generieren.
--* **ec_stat**
--`int(0,1)`
--Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
--* **barcode_sel**
--`int(0,1)`
--Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
--* **usr_anl**
--`int(0,1)`
--Der Benutzer hat das Recht weitere Benutzer im System anzulegen.
--* **usr_shw**
--`int(0,1)`
--Der Benutzer hat das Recht andere Benutzer zu verwalten.
--* **usr_chg**
--`int(0,1)`
--Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
--* **usr_login**
--`int(0,1)`
--Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
--* **usr_del**
--`int(0,1)`
--Der Benutzer hat das Recht andere Benutzerdatensätze im System zu löschen.
--* **give_right**
--`int(0,1)`
--Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
--* **ch_pers**
--`int(0,1)`
--Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
--* **preset**
--`int(0,1)`
--Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
--* **form_sel**
--`int (0,1)`
--Der Benutzer hat das Recht Formulare für alle Benutzer ein- oder auszublenden.
--* **form_deliver**
--`int(0,1)`
--Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
--* **form_del**
--`int(0,1)`
--Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
--* **form_def_set**
--`int(0,1)`
--Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
--* **logo**
--`int(0,1)`
--Der Benutzer hat das Recht ein neues Logo hochzuladen.
--* **Exp_ben**
--`int(0,1)`
--Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
--* **Exp_form**
--`int(0,1)`
--Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
--* **data**
--`int(0,1)`
--Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu exportieren.
--* **data_exp**
--`int(0,1)`
--Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
--* **archive**
--`int(0,1)`
--Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu archivieren.
--* **archive_exp**
--`int(0,1)`
--Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare archivieren darf.
--* **Shw_admin**
--`int(0,1)`
--Der Benutzer hat das Recht den Administrator Datensatz (-0000) zu sehen und zu verändern.
++ Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
++- **form_sel**
++ `int (0,1)`
++ Der Benutzer hat das Recht Formulare für alle Benutzer ein- oder auszublenden.
++
++- **form_deliver**
++ `int(0,1)`
++ Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
++
++- **form_del**
++ `int(0,1)`
++ Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
++
++- **form_def_set**
++ `int(0,1)`
++ Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
++
++- **logo**
++ `int(0,1)`
++ Der Benutzer hat das Recht ein neues Logo hochzuladen.
++
++- **Exp_ben**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
++
++- **Exp_form**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
++
++- **data**
++ `int(0,1)`
++ Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu exportieren.
++
++- **data_exp**
++ `int(0,1)`
++ Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
++
++- **archive**
++ `int(0,1)`
++ Der Benutzer hat das Recht eingegangene Formulardaten als CSV-, XLS-, XML-Datei zu archivieren.
++
++- **archive_exp**
++ `int(0,1)`
++ Dieses Recht beschreibt, dass der Benutzer nur bestimmte Formulare archivieren darf.
++
++- **Shw_admin**
++ `int(0,1)`
++ Der Benutzer hat das Recht den Administrator Datensatz (-0000) zu sehen und zu verändern.
++
  ### getusers
  Auf Anfrage erzeugt getusers ein zweidimensionales Array mit den Daten aller Benutzer eines CMS-Keys.
@@ -281,13 +281,17 @@
  <https://pdf.form-solutions.net/ws2/getusers.php>
++#### Beispieldatei:
++
++<https://demo.form-solutions.net/ws2/getusers_client.php>
++
  #### Datenstruktur
  ##### Geforderte Daten
--* **cms**
--`varchar(32)`
--CMS-Key des Kunden
++- **cms**
++ `varchar(32)`
++ CMS-Key des Kunden
  ##### Zurückgegebene Daten
@@ -298,7 +298,7 @@
  Putuser legt einen Benutzer in der Datenbank an oder editiert einen vorhandenen Benutzer. Hier kann die Variable „Benutzer“ zwei Zustände haben:
 . eine vorhandene Benutzernummer -> Das System überschreibt die Daten des Benutzers mit den übergebenen Daten.
--1. 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.
++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.
  #### Webservice-URL:
@@ -308,182 +308,235 @@
  ##### Geforderte Daten
--* **Benutzer**
--`varchar(18)`
--Benutzernummer
--* **sysmail**
--`varchar(59)`
--E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
--* **nick**
--`varchar(50)`
--alternativer Benutzername
--* **b12c96nfBehoerde_Amt**
--`varchar(255)`
--Amt des Benutzers z.B. Medienbüro, Finanzamt
--* **b12c96nfBehoerde_Strasse**
--`varchar(150)`
--Straßenname der Behördenanschrift
--* **ofsXX1_from_smail3**
--`varchar(150)`
--E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
--* **ofsXX1_to_smail3**
--`varchar(150)`
--E-Mail-Adresse an die Formulardaten gesendet werden.
--* **b12c96nfBehoerde1**
--`text`
--Behördenname z.B. Stadtverwaltung Karlsruhe
--* **b12c96nfBehoerde1Anschrift**
--`text`
--Anschrift der Behörde einzeilig
--* **b12c96nmBehoerde**
--`text`
--Anschrift der Behörde dreizeilig
--Zeilenumbruch: `\<br\>`
--* **b12c96nmEmpfaenger**
--`text`
--Anschrift der Behörde sechszeilig
--Zeilenumbruch: `\<br\>`
--* **b12c96nfBehoerde_PLZ_Ort**
--`varchar(50)`
--PLZ, Ort der Behördenanschrift, z.B. 75217 Birkenfeld
--* **b12c96nfBehoerde_Sachbearbeiter_Name**
--`varchar(50)`
--Name des Sachbearbeiters
--* **b12c96nfSachbearbeiter_Zimmernummer**
--`varchar(20)`
--Zimmernummer des Sachbearbeiters
--* **b12c96nfSachbearbeiter_Telefon**
--`varchar(30)`
--Telefonnummer des Sachbearbeiters (mit Vorwahl)
--* **b12c96nfSachbearbeiter_Telefax**
--`varchar(30)`
--Faxnummer des Sachbearbeiters (ohne Vorwahl)
--* **b12c96nfSachbearbeiter_E_Mail**
--`varchar(30)`
--E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
--* **b12c96nfGemeindekennzahl**
--`varchar(8)`
--Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer).
--* **b12c96nfOrt_Datum**
--`varchar(50)`
--Ort, Datumszeile im Formular z.B. Birkenfeld, den
--* **b12c96nmOrt_Datum2**
--`text`
--Ort, Datumszeile zweizeilig im Formular
--z.B. Birkenfeld, `\<br\>`
--den
--* **b12c96nfAntragsteller_PLZ**
--`varchar(10)`
--Vollständige oder teilweise Postleitzahl des Antragstellers.
--* **b12c96nfBehoerde_PLZ_Post**
--`varchar(7)`
--Postleitzahl der Behördenanschrift
--* **b12c96nfAntragsteller_Ort**
--`varchar(30)`
--Ortsname des Antragstellers
--* **b12c96nfAktenzeichen**
--`varchar(30)`
--Aktenzeichen des Formularvorgangs
--* **b12c96nfKontakt1Z**
--`varchar(250)`
--Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt.
--* **b12c96nmRechtsbehelfsbelehrung**
--`text`
--Rechtsbehelfsbelehrung, die ins Formular eingefügt wird.
--* **b12c96nfSachbearbeiter_Personalnummer**
--`varchar(50)`
--Personalnummer des Sachbearbeiters
--* **b12c96nfBehoerde_Ort**
--`varchar(255)`
--Ortsname der Behördenanschrift
--* **ec_sel**
--`int(0,1)`
--Der Benutzer hat das Recht eCash Formulare zu generieren.
--* **ec_stat**
--`int(0,1)`
--Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
--* **barcode_sel**
--`int(0,1)`
--Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
--* **usr_anl**
--`int(0,1)`
--Der Benutzer hat das Recht weitere Benutzer im System anzulegen.
--* **usr_shw**
--`int(0,1)`
--Der Benutzer hat das Recht andere Benutzer zu verwalten.
--* **usr_chg**
--`int(0,1)`
--Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
--* **usr_login**
--`int(0,1)`
--Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
--* **usr_del**
--`int(0,1)`
--Der Benutzer hat das Recht andere Benutzerdatensätze im System zu löschen.
--* **give_right**
--`int(0,1)`
--Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
--* **ch_pers**
--`int(0,1)`
--Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
--* **preset**
--`int(0,1)`
--Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
--* **form_sel**
--`int(0,1)`
--Der Benutzer hat das Recht Formulare für alle Benutzer ein oder auszublenden.
--* **form_deliver**
--`int(0,1)`
--Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
--* **form_del**
--`int(0,1)`
--Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
--* **form_def_set**
--`int(0,1)`
--Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
--* **logo**
--`int(0,1)`
--Der Benutzer hat das Recht ein neues Logo hochzuladen.
--* **exp_ben**
--`int(0,1)`
--Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
--* **exp_form**
--`int(0,1)`
--Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
--* **data**
--`int(0,1)`
--Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu exportieren.
--* **data_exp**
--`int(0,1)`
--Dieses Rechts beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
--* **archive**
--`int(0,1)`
--Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu archivieren.
--* **archive_exp**
--`int(0,1)`
--Dieses Rechts beschreibt, dass der Benutzer eingegangene Formulardaten nur von bestimmten Formularen archivieren darf.
--* **shw_admin**
--`int(0,1)`
--Der Benutzer hat das Recht den Administrator-Datensatz (-0000) zu sehen und zu verändern.
++- **Benutzer**
++ `varchar(18)`
++ Benutzernummer
++- **sysmail**
++ `varchar(59)`
++ E-Mail-Adresse des Benutzers, an die Systembenachrichtigungen der Kundenbereich-Oberfläche (Passwort zurücksetzten etc.) geschickt werden.
++
++- **nick**
++ `varchar(50)`
++ alternativer Benutzername
++
++- **b12c96nfBehoerde_Amt**
++ `varchar(255)`
++ Amt des Benutzers z.B. Medienbüro, Finanzamt
++
++- **b12c96nfBehoerde_Strasse**
++ `varchar(150)`
++ Straßenname der Behördenanschrift
++
++- **ofsXX1_from_smail3**
++ `varchar(150)`
++ E-Mail-Adresse, die als Versender von Formulardaten angezeigt wird.
++
++- **ofsXX1_to_smail3**
++ `varchar(150)`
++ E-Mail-Adresse an die Formulardaten gesendet werden.
++
++- **b12c96nfBehoerde1**
++ `text`
++ Behördenname z.B. Stadtverwaltung Karlsruhe
++
++- **b12c96nfBehoerde1Anschrift**
++ `text`
++ Anschrift der Behörde einzeilig
++
++- **b12c96nmBehoerde**
++ `text`
++ Anschrift der Behörde dreizeilig
++ Zeilenumbruch: `\<br\>`
++
++- **b12c96nmEmpfaenger**
++ `text`
++ Anschrift der Behörde sechszeilig
++ Zeilenumbruch: `\<br\>`
++
++- **b12c96nfBehoerde_PLZ_Ort**
++ `varchar(50)`
++ PLZ, Ort der Behördenanschrift, z.B. 75217 Birkenfeld
++
++- **b12c96nfBehoerde_Sachbearbeiter_Name**
++ `varchar(50)`
++ Name des Sachbearbeiters
++
++- **b12c96nfSachbearbeiter_Zimmernummer**
++ `varchar(20)`
++ Zimmernummer des Sachbearbeiters
++
++- **b12c96nfSachbearbeiter_Telefon**
++ `varchar(30)`
++ Telefonnummer des Sachbearbeiters (mit Vorwahl)
++
++- **b12c96nfSachbearbeiter_Telefax**
++ `varchar(30)`
++ Faxnummer des Sachbearbeiters (ohne Vorwahl)
++
++- **b12c96nfSachbearbeiter_E_Mail**
++ `varchar(30)`
++ E-Mail-Adresse des Sachbearbeiters, die im Formular angezeigt werden soll.
++
++- **b12c96nfGemeindekennzahl**
++ `varchar(8)`
++ Gemeindekennzahl der Behörde (im Regelfall die ersten 8 Stellen der Kundennummer).
++
++- **b12c96nfOrt_Datum**
++ `varchar(50)`
++ Ort, Datumszeile im Formular z.B. Birkenfeld, den
++
++- **b12c96nmOrt_Datum2**
++ `text`
++ Ort, Datumszeile zweizeilig im Formular
++ z.B. Birkenfeld, `\<br\>`
++ den
++
++- **b12c96nfAntragsteller_PLZ**
++ `varchar(10)`
++ Vollständige oder teilweise Postleitzahl des Antragstellers.
++
++- **b12c96nfBehoerde_PLZ_Post**
++ `varchar(7)`
++ Postleitzahl der Behördenanschrift
++
++- **b12c96nfAntragsteller_Ort**
++ `varchar(30)`
++ Ortsname des Antragstellers
++
++- **b12c96nfAktenzeichen**
++ `varchar(30)`
++ Aktenzeichen des Formularvorgangs
++
++- **b12c96nfKontakt1Z**
++ `varchar(250)`
++ Einzeilige Kontaktnachricht auf dem Kopf des Formulars, wird meist mit Öffnungszeiten und anderen Informationen gefüllt.
++
++- **b12c96nmRechtsbehelfsbelehrung**
++ `text`
++ Rechtsbehelfsbelehrung, die ins Formular eingefügt wird.
++
++- **b12c96nfSachbearbeiter_Personalnummer**
++ `varchar(50)`
++ Personalnummer des Sachbearbeiters
++
++- **b12c96nfBehoerde_Ort**
++ `varchar(255)`
++ Ortsname der Behördenanschrift
++
++- **ec_sel**
++ `int(0,1)`
++ Der Benutzer hat das Recht eCash Formulare zu generieren.
++
++- **ec_stat**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich eCash Statistiken anzusehen.
++
++- **barcode_sel**
++ `int(0,1)`
++ Der Benutzer hat das Recht 2D-Barcode Formulare zu erstellen.
++
++- **usr_anl**
++ `int(0,1)`
++ Der Benutzer hat das Recht weitere Benutzer im Form-Solutions System anzulegen.
++
++- **usr_shw**
++ `int(0,1)`
++ Der Benutzer hat das Recht andere Benutzer zu verwalten.
++
++- **usr_chg**
++ `int(0,1)`
++ Der Benutzer hat das Recht die Personalisierungsdatensätze anderer Benutzer zu ändern.
++
++- **usr_login**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich als ein anderer Benutzer einzuloggen (dies wird meist zum debuggen benutzt).
++
++- **usr_del**
++ `int(0,1)`
++ Der Benutzer hat das Recht andere Benutzerdatensätze im Form-Solutions System zu löschen.
++
++- **give_right**
++ `int(0,1)`
++ Der Benutzer hat das Recht seine eigenen Rechte an andere Benutzer weiterzugeben.
++
++- **ch_pers**
++ `int(0,1)`
++ Der Benutzer hat das Recht seinen eigenen Personalisierungsdatensatz zu ändern.
++
++- **preset**
++ `int(0,1)`
++ Der Benutzer hat das Recht Passwörter anderer Benutzer zurückzusetzen.
++
++- **form_sel**
++ `int(0,1)`
++ Der Benutzer hat das Recht Formulare für alle Benutzer ein oder auszublenden.
++
++- **form_deliver**
++ `int(0,1)`
++ Der Benutzer hat das Recht selbst erstellte Formulare hochzuladen.
++
++- **form_del**
++ `int(0,1)`
++ Der Benutzer hat das Recht selbst erstellte Formulare aller Benutzer zu löschen.
++
++- **form_def_set**
++ `int(0,1)`
++ Der Benutzer hat das Recht Formulardefinitionen vorzugeben.
++
++- **logo**
++ `int(0,1)`
++ Der Benutzer hat das Recht ein neues Logo hochzuladen.
++
++- **exp_ben**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich die angezeigten Benutzerdaten als CSV-, XLS-, XML-Datei herunterzuladen.
++
++- **exp_form**
++ `int(0,1)`
++ Der Benutzer hat das Recht sich eine Liste gesuchter Formulare als CSV-, XLS-, XML-Datei herunterzuladen.
++
++- **data**
++ `int(0,1)`
++ Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu exportieren.
++
++- **data_exp**
++ `int(0,1)`
++ Dieses Rechts beschreibt, dass der Benutzer nur bestimmte Formulare exportieren darf.
++
++- **archive**
++ `int(0,1)`
++ Der Benutzer hat das Recht eingegangene Formulardaten als XLS, CSV, XML Datei zu archivieren.
++
++- **archive_exp**
++ `int(0,1)`
++ Dieses Rechts beschreibt, dass der Benutzer eingegangene Formulardaten nur von bestimmten Formularen archivieren darf.
++
++- **shw_admin**
++ `int(0,1)`
++ Der Benutzer hat das Recht den Administrator-Datensatz (-0000) zu sehen und zu verändern.
++
  ##### 3.3.2.2 Zurückgegebene Daten
--* **Status**
--`String`
--* **Benutzer**
--`varchar(18)`
--* **password**
--`varchar(50)`
++- **Status**
++ `String`
++- **Benutzer**
++ `varchar(18)`
++
++- **password**
++ `varchar(50)`
++
  ##### Besonderheiten
  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.
--Weiterhin ist zu beachten, dass die Rechte `data_exp` und `archive_exp` einschränkende Rechte sind. Diese Rechte sind mit 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.
++Weiterhin ist zu beachten, dass die Rechte `data_exp` und `archive_exp` einschränkende Rechte sind. Diese Rechte sind mit
++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.
  ### deluser
--Deluser löscht einen spezifischen Benutzer aus der Datenbank.
++Deluser löscht einen spezifischen Benutzer aus der Form-Solutions Datenbank.
  #### Webservice-URL:
@@ -493,17 +493,18 @@
  ##### Geforderte Daten
--* **cms**
--`varchar(32)`
--CMS-Key des Kunden
--* **user**
--`varchar(18)`
--Benutzernummer des Benutzers, dessen Daten vom System gelöscht werden sollen.
++- **cms**
++ `varchar(32)`
++ CMS-Key des Kunden
++- **user**
++ `varchar(18)`
++ Benutzernummer des Benutzers, dessen Daten vom System gelöscht werden sollen.
++
  ##### Zurückgegebene Daten
--* **Status**
--`String`
++- **Status**
++ `String`
  ### getticket
@@ -513,26 +513,29 @@
  <https://pdf.form-solutions.net/ws2/getticket.php>
++### Beispieldatei:
++
++<https://demo.form-solutions.net/ws2/getticket_client.php>
++
  #### Datenstruktur
  ##### Geforderte Daten
--* **cms**
--`varchar(32)`
--CMS-Key des Kunden
++- **cms**
++ `varchar(32)`
++ CMS-Key des Kunden
  ##### Zurückgegebene Daten
--* **ticket**
--varchar(64)`
--Einmalticket, das zum Aufruf eines Prozesses bei interaktiven Schnittstellen eingesetzt wird.
++- **ticket**
++ varchar(64)`
++ Einmalticket, das zum Aufruf eines Prozesses bei interaktiven Schnittstellen eingesetzt wird.
  ### getformlist
  Auf Anfrage generiert getformlist ein Datenarray aller Formulare, welche der durch den CMS-Key authentifizierte Kunde nutzen kann.
--> _**Hinweis:**_
-->
++> ***Hinweis:***
  > Diese Funktion liefert keine Daten über Assistenten mit.
  #### Webservice-URL:
@@ -539,54 +539,67 @@
  <https://pdf.form-solutions.net/ws2/getformlist.php>
++#### Beispieldatei:
++
++<https://demo.form-solutions.net/ws2/getformlist_client.php>
++
  #### Datenstruktur
  ##### Geforderte Daten
--* **cms**
--`varchar(32)`
--CMS-Key des Kunden
++- **cms**
++ `varchar(32)`
++ CMS-Key des Kunden
  #### Zurückgegebene Daten
  Es wird ein Array mit Formulardaten zurückgeliefert. Jedes Element enthält dabei folgende Daten:
--* **fnr**
--`varchar(250)`
--Formularnummer
--* **title**
--`varchar(250)`
--Formularname
--* **kat**
--`varchar(250)`
--Formularkategorie
--* **pagecount**
--`int(10)`
--Anzahl der Formularseiten
--* **created**
--`date(Y-M-D)`
--Erstellungsdatum
--* **changed**
--`date(Y-M-D)`
--Datum der letzten Änderung
--* **bem**
--`text`
--Bemerkungen zum Formular
--* **beschr**
--`text`
--Beschreibung des Formulars
--* **formtype** `varchar(3)`
--Die Software unterscheidet zwischen 2 Formulartypen.
--fs = ein von MACH ProForms erstelltes Formular
++- **fnr**
++ `varchar(250)`
++ Formularnummer
++
++- **title**
++ `varchar(250)`
++ Formularname
++
++- **kat**
++ `varchar(250)`
++ Formularkategorie
++
++- **pagecount**
++ `int(10)`
++ Anzahl der Formularseiten
++
++- **created**
++ `date(Y-M-D)`
++ Erstellungsdatum
++
++- **changed**
++ `date(Y-M-D)`
++ Datum der letzten Änderung
++
++- **bem**
++ `text`
++ Bemerkungen zum Formular
++
++- **beschr**
++ `text`
++ Beschreibung des Formulars
++
++- **formtype**
++ `varchar(3)`
++ Form-Solutions unterscheidet zwischen 2 Formulartypen.
++fs = ein von Form-Solutions erstelltes Formular
  knd = ein vom Kunden erstelltes Formular
-----
++___
--## Funktionen der Interaktiven Schnittstellen
++##  Funktionen der Interaktiven Schnittstellen
  ### Sign-In
--Mit dieser Funktion können Sie einen Benutzer ohne weitere Login-Abfragen im System einloggen.
++Mit dieser Funktion können Sie einen Benutzer ohne weitere Loginabfragen im FormSolutions System einloggen.
  #### URL:
@@ -594,15 +594,17 @@
  #### Übergabeparameter:
--* **Usr**
++- **Usr**
  Benutzernummer des Benutzers im FS-System
--* **ticket**
++
++- **ticket**
  Ticketnummer, die zuvor per Webservice angefordert wurde
--* **type**
--signin`
--### Formular suchen und Formular-Link erstellen
++- **type**
++ signin`
++### Formular suchen und Formularlink erstellen
++
  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.
  #### URL:
@@ -611,21 +611,23 @@
  #### Übergabeparameter:
--* **usr**
--Benutzernummer des Benutzers im FS-System
--* **ticket**
--Ticketnummer, die zuvor per Webservice angefordert wurde
--* **type**
--`formsearch`
--* **return**
--URL, an die der erstellte Formular-Link übergeben werden soll. Diese URL muss so aussehen, dass am Ende der URL der Formular-Link angefügt werden kann. Bsp: <https://pdf.form-solutions.net//ws/back.php?data=>
++- **usr**
++ Benutzernummer des Benutzers im FS-System
++
++- **ticket**
++ Ticketnummer, die zuvor per Webservice angefordert wurde
++
++- **type**
++ `formsearch`
++
++- **return**
++ 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=>
  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.
--> _**Hinweis:**_
-->
--> In der Variante mit dem type formsearch kann man ab der Release-Version 32.13.0 auch Assistenten suchen. Die Überarbeitung von Assistenten-Links erfolgt ebenso über diese Variante.
++> ***Hinweis:***
++> 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.
--### Basisformular-Link erstellen
++### Basisformularlink erstellen
  Die Funktion `getbaselink` übergibt einen sicheren Link zu einem Formular ohne weitere Funktionen wie Senden, Barcode, S-Internetkasse oder eCash.
@@ -633,26 +633,31 @@
  <https://pdf.form-solutions.net/ws2/getbaselink.php>
++#### Beispieldatei
++
++<https://demo.form-solutions.net/ws2/getbaselink_client.php>
++
  #### Übergabeparameter
  ##### Geforderte Daten:
--* **cms**
--CMS-Key des Kunden
--* **user**
--Benutzernummer des Benutzers im FS-System
--* **form**
--Formularnummer
++- **cms**
++ CMS-Key des Kunden
++- **user**
++ Benutzernummer des Benutzers im FS-System
++
++- **form**
++  Formularnummer
++
  ##### Zurückgegebene Daten
--* **Sicherer Link**
++- **Sicherer Link**
--> _**Hinweis:**_
-->
++> ***Hinweis:***
  > Diese Funktion steht für Assistenten nicht zur Verfügung.
--### Individualformular-Link erstellen
++### Individualformularlink erstellen
  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.
@@ -662,20 +662,27 @@
  #### Übergabeparameter:
--* **usr**
--Benutzernummer des Benutzers im FS-System
--* **ticket**
--Ticketnummer, die zuvor per Webservice angefordert wurde
--* **type**
--`formlink`
--* **formular**
--Formularnummer
--* **formtype**
--Ist dies ein von MACH ProForms oder ein vom Kunden erstelltes Formular? (`fs`, `knr`) (siehe 3.6.3.2 getformlist - Zurückgegebene Daten, Variable `formtype`)
--* **return** URL an die der erstellte Formular-Link übergeben werden soll. Diese URL muss so aussehen, dass am Ende der URL der Formular-Link angefügt werden kann.
++- **usr**
++ Benutzernummer des Benutzers im FS-System
++
++- **ticket**
++ Ticketnummer, die zuvor per Webservice angefordert wurde
++
++- **type**
++ `formlink`
++
++- **formular**
++ Formularnummer
++
++- **formtype**
++ 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`)
++
++- **return**
++ 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/ws2/back.php?data=>
  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.
--> _**Hinweis:**_
-->
++> ***Hinweis:***
  > Diese Funktion steht für Assistenten nicht zur Verfügung.
++
++

logo.jpg

Größe

@@ -1,1 +1,1 @@
--97.6 KB
++117.6 KB

Inhalt