CM/Forms

Einführung in CM/Forms

CM/Forms ist ein ConSol CM-Add-on, mit dem Sie Webformulare erstellen können. Webformulare können von nicht registrierten Benutzern ausgefüllt werden, d. h. von Benutzern, die sich nicht angemeldet haben oder Benutzern, die noch nicht im Web Client oder CM/Track erstellt wurden.

Konzepte, Begriffe und Definitionen

Konzept	Andere Begriffe	Definition
Webhook		Mechanismus, der die Kommunikation zwischen ConSol CM und externen Applikationen ermöglicht
Übermittlung		Daten, die von einem Benutzer in der Webformular eingegeben wurden und durch Abenden das Formulars an ConSol CM gesendet werden

Zweck und Verwendung

Webformulare werden über das Menüelement Formulare verwaltet. Für die Arbeit mit Webformularen sind Administratorberechtigungen erforderlich.

Ein Webformular besteht aus zwei Teilen: dem Formular selber, das die allgemeine Konfiguration und die Formularfelder enthält, und einem Skript, mit dem die übermittelten Daten verarbeitet werden. Dies kann entweder ein Integrationsskript sein, das zusammen mit einem Webhook verwendet wird, oder ein Task-Skript, das eingesetzt wird, wenn die Übermittlungen in der ConSol CM-Datenbank aufgezeichnet werden.

Webformulare können für verschiedene Anwendungsfälle nützlich sein:

• Anmeldeformulare
  Erstellen Sie ein Webformular, mit dem sich Ihre Benutzer selber bei CM/Track registrieren können.
• Feedback-Formulare
  Sammeln Sie Feedback von Ihren Kunden und verbinden Sie dieses direkt mit einem Vorgang.
• Bewerbungsformulare
  Erstellen Sie ein Formular, in das Bewerber ihre Daten eingeben und einen Lebenslauf hochladen können.
• Assistenten für die Vorgangserstellung
  Stellen Sie einen Assistenten zur Verfügung, der den Benutzer durch den Prozess der Vorgangserstellung leitet.

Verfügbare Einstellungen für Webformulare

Grundlegende Formulardaten

Die grundlegenden Formulardaten werden im oberen Bereich eines Webformulars angezeigt:

• Name: Pflichtangabe. Der interne Namen für das Webformular.
• Öffentlicher Name: Optional. Der öffentliche Namen für das Webformular. Sie können auf Erzeugen klicken, um das Feld mit einer eindeutigen Zeichenfolge, die aus zufällig gewählten Zeichen besteht, zu füllen. Wenn das Formular auf der ConSol CM-Instanz veröffentlicht wird, ist der öffentliche Name Teil der URL, über die der Zugriff auf das Webformular erfolgt.
• Art der Veröffentlichung: Pflichtfeld. Legt fest, wie das Webformular verfügbar gemacht wird. Siehe Veröffentlichen eines Webformulars. Mögliche Werte sind:
  • DENIED / VERWEIGERT: Client-Abfragen zum Formular sind nicht möglich.
  • CM: Das Formular wird auf der ConSol CM-Instanz veröffentlicht. Die URL ist: <CM-Server>/cm-client/cf/<öffentlicher Name>. Es kann in einem iFrame verwendet werden.
  • OWN / EIGENSTÄNDIG: Das Formular wird auf seiner eigenen Instanz veröffentlicht. Dafür ist eine externe Client-Applikation nötig, die das Formular verwaltet. Es kann kein iFrame verwendet werden.
  • FULL / VOLLSTÄNDIG: Das Formular wird auf der ConSol CM-Instanz veröffentlicht und kann gleichzeitig auf seiner eigenen Instanz veröffentlicht werden. Dies ist die Kombination der Veröffentlichungsarten CM und OWN.
• Bedingungsskript: Optional. Der Name des Bedingungsskripts (Skript des Typs Bedingung für Webformular). Das Skript prüft, ob das Formular vom Client verwendet werden kann. Es wird bei GET- und POST-Abfragen ausgeführt. Das Skript muss die Antwort „200“ zurückgeben, damit das Formular angezeigt wird . Die folgenden Variablen sind im Skript verfügbar:
  • remoteIp: IP-Adresse des Clients, der das Formular anfordert
  • formName: Name des Formulars
  • formPublicName: Öffentlicher Name des Formulars
• Aufzeichnung der Übermittlung: Optional. Wählen Sie diese Option, wenn die Daten, die mit dem Webformular übermittelt werden, in der ConSol CM-Datenbanktabelle cmas_custom_form_submission gespeichert werden sollen. Damit können die Benutzereingaben verfolgt und Eingaben im Batch verarbeitet werden, z. B. mit einem Task. Siehe Datenverarbeitung.
• Webhook: Optional. Der Webhook, der benachrichtigt wird, wenn ein Benutzer ein Formular übermittelt. Siehe Datenverarbeitung. Es gibt zwei Optionen:
  • ConSol CM-Webhook: Geben Sie den Namen des Webhooks ein.
  • Externer Webhook: Geben Sie die komplette URL ein.
• Version: Pflichtangabe. Die Version des Webformulars. Klicken Sie auf Erhöhen, um die Versionsnummer zu erhöhen. Die Version kann verwendet werden, wenn es nach der ersten Veröffentlichung des Formulars wichtige Änderungen gibt. Die Version wird in der Übermittlung gespeichert, sodass Verarbeitungsskripte Änderungen im Formular berücksichtigen können.
• Aktiv: Optional. Markieren Sie diese Checkbox, wenn das Webformular aktiv sein soll, d. h. es kann der Veröffentlichungsart entsprechend verwendet werden.

Formulardesign

Der untere Bereich enthält das entworfene Formular. Für das Design des Formulars wird die Bibliothek form.io eingesetzt. Die verfügbaren Komponenten des Formulars werden auf der linken Seite dargestellt und das Formular selber auf der rechten Seite.

In der Einstellung Formulartyp legen Sie die Grundstruktur des Formulars fest:

• Formular
  Verwenden Sie diese Option, wenn das Webformular eine Seite haben soll.
• Assistent
  Verwenden Sie diese Option, wenn das Webformular mehrere Seiten haben soll.

Sie können die gewünschte Komponente mit Drag-and-Drop in das Formular auf der rechten Seite ziehen. Der Konfigurationsdialog für die Komponente wird automatisch geöffnet, siehe Feinjustieren eines Webformulars.

Weitere Informationen finden Sie in der offiziellen Dokumentation der Bibliothek form.io (siehe Form Components, Layout Components und Data Components).

Datenverarbeitung

Es gibt zwei Optionen für die Verarbeitung der mit dem Webformular übermittelten Daten:

• Webhook
  Bedingung: Es ist ein Webhook für das Webformular konfiguriert.
  1. Die übermittelten Daten werden über den Webhook an ConSol CM gesendet.
  2. Das Integrationsskript des Webhooks verarbeitet die Daten.
  3. Die Daten werden in der ConSol CM-Datenbank gespeichert, z. B. in einem Vorgang oder Kontakt.

  Sie müssen den Namen des Webhooks im Feld Webhook der grundlegenden Daten eingeben, siehe Grundlegende Formulardaten.

  Wenn das Webformular auf derselben Instanz wie ConSol CM (Veröffentlichungsart CM) veröffentlicht wird, muss die IP der ConSol CM-Instanz für den Webhook zugelassen sein. Der Webhook muss über eine IP-Adresse abgesichert sein. Die Verwendung von Secret Token ist für CM/Forms nicht möglich. Weitere Informationen zur Erstellung von Webhooks finden Sie in Webhooks.

• Datenbank
  1. Die übermittelten Daten werden direkt in der ConSol CM-Datenbank in der Tabelle cmas_custom_form_submission gespeichert.
  2. Die Daten werden zu einem späteren Zeitpunkt verarbeitet, zum Beispiel in einem Task-Skript, das regelmäßig ausgeführt wird.

  Sie müssen die Checkbox Aufzeichnung der Übermittlung in den grundlegenden Daten markieren, siehe Grundlegende Formulardaten, und ein Task-Skript für die Datenverarbeitung erstellen, siehe Erstellen eines Task-Skripts.

Die folgende Abbildung zeigt die Datenverarbeitung mit einem Webhook (blauer Datenfluss) und Aufzeichnung der Übermittlung (gelber Datenfluss).

Abbildung 30: Datenverarbeitung für Webformulare

Es ist möglich, für ein Webformular sowohl die Aufzeichnung der Übermittlung als auch den Webhook zu verwenden. Die Annahme der Übermittlung hängt von der ausgewählten Option ab:

• Aufzeichnung der Übermittlung + Webhook
  Die Übermittlung wird akzeptiert, wenn der Webhook 200 zurückgibt. Andernfalls erhält der Benutzer, der das Webformular abgesendet hat, eine Fehlermeldung. Die Übermittlung wird aber auch dann in der Datenbank gespeichert, wenn der Webhook einen Fehler zurückgibt.
• Nur Webhook
  Die Übermittlung wird akzeptiert, wenn der Webhook 200 zurückgibt. Andernfalls erhält der übermittelnde Benutzer eine Fehlermeldung.
• Nur Aufzeichnung der Übermittlung
  Die Übermittlung wird akzeptiert, wenn die Daten in der Datenbank gespeichert sind.

Wenn nur die Aufzeichnung der Übermittlung verwendet wird, wird das Webformular nicht über das Ergebnis der Verarbeitung durch das Task-Skript informiert, d. h. der Benutzer, der das Webformular abgesendet hat, weiß nicht, ob die Verarbeitung seiner Anfrage erfolgreich war.

Veröffentlichen eines Webformulars

Abhängig von der ausgewählten Art der Veröffentlichung, siehe Feld Art der Veröffentlichung in den Grundlegende Formulardaten, und dem gewünschten Einsatz des Webformulars sind unterschiedliche Optionen zur Bereitstellung des Webformulars verfügbar.

Häufige Anwendungsfälle sind:

• Art der Veröffentlichung CM, interne Verwendung innerhalb des Unternehmens
• Art der Veröffentlichung CM, Webformular wird über eine von ConSol CM bereitgestellte URL zur Verfügung gestellt, externer Zugriff möglich
• Art der Veröffentlichung CM, über iFrame in eine Website eingebettetes Webformular, externer Zugriff möglich
• Art der Veröffentlichung EIGENSTÄNDIG, über eine eigens entwickelte Applikation bereitgestelltes Webformular, externer Zugriff möglich

Die folgende Abbildung zeigt ein typisches Setup für den dritten Anwendungsfall.

Abbildung 31: Veröffentlichung eines in eine Website eingebetteten Webformulars für den externen Zugriff

Informationen über die erforderlichen Proxy-Einstellungen finden Sie im Abschnitt Operating ConSol CM Behind a Proxy (e.g., Apache HTTPD) des ConSol CM Setup Manuals.

Grundlegende Aufgaben

Sie können die folgenden Aktionen an Webformularen durchführen:

• Neues Webformular erstellen
  Klicken Sie über der Tabelle mit den Webformularen auf den Button Neues benutzerdefiniertes Formular erstellen und nehmen Sie die gewünschten Einstellungen vor, siehe Verfügbare Einstellungen für Webformulare.

  Wenn das neue Webformular einem vorhandenen ähnelt, können Sie eine Kopie des Webformulars erstellen, indem Sie im Kontextmenü des Formulars die Option Kopieren auswählen. Sie müssen dem Webformular einen eindeutigen Namen geben.

  Die folgenden Schritte sind erforderlich, um ein neues Webformular zu erstellen:

  1. Füllen Sie die grundlegenden Formulardaten aus, siehe Grundlegende Formulardaten.

  2. Entwerfen Sie das Formular, siehe Formulardesign.

  3. Entscheiden Sie, wie die Formulardaten in ConSol CM verarbeitet werden sollen, siehe Datenverarbeitung.

  4. Entscheiden Sie, wie das Formular veröffentlicht werden soll, siehe Veröffentlichen eines Webformulars.

  Je nach Art der Veröffentlichung müssen Sie einen Webhook erstellen, siehe Erstellen eines Webhooks.

• Webformular bearbeiten
  Wählen Sie im Kontextmenü des Formulars die Option Bearbeiten und aktualisieren Sie das Formular wie gewünscht, siehe Verfügbare Einstellungen für Webformulare. Wenn das Formular bereits veröffentlich ist, werden die Änderungen sofort wirksam.

• Webformular aktivieren
  Wählen Sie im Kontextmenü des Formulars die Option Aktivieren, um das Formular zu aktivieren. Webformulare müssen aktiviert und veröffentlicht sein, damit sie verwendet werden können.
  

• Webformular deaktivieren
  Wählen Sie im Kontextmenü des Formulars die Option Deaktivieren, um das Formular zu deaktivieren. Deaktivierte Webformulare können nicht ausgefüllt werden.

• Webformular löschen
  Sie können ein Webformular löschen, indem Sie im Kontextmenü des Formulars die Option Löschen auswählen.

Erweiterte Aufgaben

Feinjustieren eines Webformulars

Es gibt eine Vielzahl an Einstellungen, die Sie für ein Formularfeld verwenden können. Sie können ein Datenfeld entweder direkt beim Erstellen konfigurieren oder später, indem Sie auf das Icon Bearbeiten klicken:

Es gibt mehrere Aspekte, die Sie normalerweise beim Design eines Webformulars berücksichtigen müssen:

• Label und Platzhalter:
  Geben Sie das Label und den Platzhalter ein:

  

• Pflichtfelder:
  Setzen Sie Pflichtfelder aus dem Datenmodell auch als Pflichtfelder im Webformular:

  

• API-Schlüssel:
  Sie benötigen den API-Schlüssel, um die übermittelten Werte im Skript, das die Formulardaten verarbeitet, zu referenzieren:

  

• Zuweisung des CM/Track-Benutzerprofils:
  Wenn Sie ein Webformular einsetzen, um es den Benutzer zu ermöglichen, sich selber für CM/Track zu registrieren, muss das CM/Track-Benutzerprofil dem erstellten Kontakt automatisch zugewiesen werden.