Task

CEL2-126 - Wordpress Plugin für celanio Rest API erstellen READY FOR DEVELOPMENT

Einleitung

Mit der Kontaktverwaltung wurde eine angenehme Methode geschaffen, um Kontakte im celanio-System anzulegen, Kontaktdaten zu bearbeiten, neue Adressdaten zu bestehenden Kontakten hinzuzufügen oder sich bestehende Kontakte, mit wahlweise der Informationen über vergangene/zukünftige Veranstaltungsteilnahmen, anzeigen zu lassen.

Installation

Sie bekommen von uns eine ZIP-Datei, in welcher das Plugin enthalten ist. Die erforderlichen Schritte zur Installation können Sie unter folgendem Link zur offiziellen Supportseite von WordPress nachlesen.

Zum Menüpunkt Einstellungen gelangen

Nach Installation des Plugins in WordPress, können Sie mit der Konfiguration der Einstellungen beginnen. 

Um zu den Einstellungen zu gelangen, gehen Sie folgt vor.

Variante 1:

Gehen Sie in Ihrem Dashboard auf den Menüpunkt "Plugins" → "Installierte Plugins". 


Nach Klick darauf sehen Sie alle bereits installierten Plugins, darunter auch "Kontaktverwaltung über Rest-API".

Mit einem Klick auf den Punkt "Einstellungen", gelangen Sie zur Konfigurationsseite des Plugins

Variante 2:

Nach Installation sehen Sie im Dashboard den Menüeintrag "Kontaktverwaltung"


Nach Klick auf "Kontaktverwaltung" öffnet sich darunter das Untermenü.

Klicken Sie dort auf "Einstellungen".


Plugin konfigurieren

Haben Sie die Einstellungsseite geöffnet, beginnt die Konfiguration des Plugins.



Folgende Einstellungen sind zu tätigen:

API Token:

Als Administrator können Sie den Token selbst im celanio-System unter dem Menüpunkt "Administration" → "Benutzer und Gruppen" erstellen

Server-URL: 

Ist Ihre Domain bzw. der Hauptpfad, auf dem das celanio-System installiert ist. Bspw.: https://example.com
URL / Pfad zu Kontakte: 

Der richtige Pfad ist im Plugin schon hinterlegt, wenn dieses Feld frei ist, wird standardmäßig folgender Pfad genutzt: "/restapi/v1/contacts/"

Demnach kann dieses Feld freibleiben. Eingabemöglichkeit besteht, falls der Pfad zukünftig verändert wird.

URL / Pfad zu Teilnehmer: 

Der richtige Pfad ist im Plugin schon hinterlegt, wenn dieses Feld frei ist, wird standardmäßig folgender Pfad genutzt: "/restapi/v1/participations/search/cid/"

Demnach kann dieses Feld freibleiben. Eingabemöglichkeit besteht, falls der Pfad zukünftig verändert wird.

Nachdem Sie Ihre Daten eingetragen haben, bestätigen Sie Ihre Eingaben mit dem Button "Änderungen speichern".

Jetzt sollten Sie Ihre Eingaben in den Textfeldern sehen können.

Navigation und Eingabe von Daten

Nachdem Sie die Einstellungen des Plugins vorgenommen haben, gehen Sie zum Punkt "Kontaktverwaltung" in Ihrem Dashboard.

Dort sehen Sie folgendes Menü:

Mit einem Klick auf den gewünschten Button öffnet sich das Eingabefeld.

Kontakt erstellen

Im Menü "Kontakt erstellen" können Sie neue Benutzer in Ihr System einpflegen.

Dafür füllen Sie Eingabefelder wie folgt erklärt aus.


Feldname:Pflichtfeld Ja/Nein:Beschreibung:













AnredeNeinAnrede des Kontaktes, wählbar ist  'Herr' und 'Frau', 'Bitte auswählen' steht für keine Eingabe, wird dementsprechend nicht übermittelt.
TitelNeinKontakttitel, wählbar 'Kein', 'Dr.' oder 'Prof.'
VornameNeinVorname des Kontaktes
NachnameJaNachname des Kontaktes
StraßeNeinStraßenname
HausnummerNeinHausnummer
PLZ (Postleitzahl)NeinPLZ des Kontaktes
StadtNeinWohnort des Kontaktes
BundeslandNeinBundesland, sollte nur bei Bedarf eingegeben werden
LandNeinLand
E-MailJa

E-Mail-Adresse des Kontaktes muss in einem gültigen E-Mail-Formal eingegeben werden (z.B. example@example.com).

Eine E-Mail kann im System nur einmal angelegt werden.

Wird eine E-Mail doppelt eingetragen, so wird eine Fehlermeldung ausgegeben und die Kontakt-ID des Kontaktes angezeigt, welche diese E-Mail enthält.

TelefonNein

Telefonnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Vorwahl des Ortes, die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Rufnummer inkl. Durchwahl, falls vorhanden

FaxNein

Faxnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Vorwahl des Ortes, die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Faxnummer inkl. Durchwahl, falls vorhanden

MobilNein

Mobilnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Netzbetreibervorwahl (z.B. 0176), die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Rufnummer

FirmennameNein

Name der Firma, mit welcher der Kontakt verknüpft werden soll. Schreibweise muss exakt mit der im System hinterlegten Firma übereinstimmen.

Alternativ können Sie auf diesem  Wege auch eine neue Firma erstellen.

AbteilungNeinAbteilung (z. B. Verkauf)
PositionNeinPosition in der Firma (z.B. Verkäufer)


Die Eingabefelder Nachname und E-Mail sind Pflichtfelder und dürfen nicht leer sein, zusätzlich verlangt das System eine E-Mail-Adresse in korrekter Schreibweise (z.B. example@example.com).

Der Bereich der Firmeneingabe ist optional und sollte nur angegeben werden, wenn die genaue Firmenbezeichnung im System bekannt ist oder eine neue Firma erstellt werden soll.

Nach Absenden des Formulars durch Betätigen des Buttons "Erstellen" bekommen Sie bei richtiger Eingabe folgenden Bildschirm.

Ihnen wird angezeigt, dass der Kontakt erfolgreich erstellt wurde und zusätzlich bekommen Sie die Information, welche Kontakt-ID der neue Kontakt hat.


Kontakt bearbeiten

Im Menü "Kontakt bearbeiten" können Sie Kontaktdaten für einen bestehenden Kontakt bearbeiten.

Dafür füllen Sie Eingabefelder wie folgt erklärt aus.

Kontakt-IDJaKontakt-ID des Kontaktes welcher bearbeitet werden soll






AnredeNeinAnrede des Kontaktes, wählbar ist  'Herr' und 'Frau', 'Bitte auswählen' steht für keine Eingabe, wird dementsprechend nicht übermittelt.
TitelNeinKontakttitel, wählbar 'Kein', 'Dr.' oder 'Prof.'
VornameNeinVorname des Kontaktes
NachnameNeinNachname des Kontaktes
StraßeNeinStraßenname
HausnummerNeinHausnummer
PLZ (Postleitzahl)NeinPLZ des Kontaktes
StadtNeinWohnort des Kontaktes
BundeslandNeinBundesland, sollte nur bei Bedarf eingegeben werden
LandNeinLand
E-MailNein

E-Mail-Adresse des Kontaktes muss in einem gültigen E-Mail-Formal eingegeben werden (z.B. example@example.com).

Eine E-Mail kann im System nur einmal angelegt werden.

Wird eine E-Mail doppelt eingetragen, so wird eine Fehlermeldung ausgegeben und die Kontakt-ID des Kontaktes angezeigt, welche diese E-Mail enthält.

TelefonNein

Telefonnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Vorwahl des Ortes, die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Rufnummer inkl. Durchwahl, falls vorhanden

FaxNein

Faxnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Vorwahl des Ortes, die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Faxnummer inkl. Durchwahl, falls vorhanden

MobilNein

Mobilnummer in folgender Schreibweise:

Feld 1→ Ländercode (z.B. Deutschland = 49), das + davor kann angegeben werden, ist aber keine Pflicht. Wird vom System automatisch erstellt.

Feld 2→ Netzbetreibervorwahl (z.B. 0176), die führende Null kann eingetragen werden, wird aber vom System im Bearbeitungsprozess automatisch gelöscht.

Feld 3→ Rufnummer

FirmennameNein

Name der Firma, mit welcher der Kontakt verknüpft werden soll. Schreibweise muss exakt mit der im System hinterlegten Firma übereinstimmen.

Alternativ können Sie auf diesem  Wege auch eine neue Firma erstellen.

AbteilungNeinAbteilung (z. B. Verkauf)
PositionNeinPosition in der Firma (z.B. Verkäufer)


Das Eingabefeld "Kontakt-ID" ist ein Pflichtfeld und ist nötig, um die Bearbeitung einem Kontakt zuzuordnen.

Die rein personenbezogenen Felder 'Anrede', 'Titel', 'Vorname' und 'Nachname' werden direkt bearbeitet.

Die restlichen Adress- und Firmendaten werden als neue Adresse gespeichert, also zusätzlich zur schon vorhandenen Adresse hinterlegt.

Nach Absenden des Formulars durch Betätigen des Buttons "Bearbeiten" bekommen Sie bei richtiger Eingabe folgenden Bildschirm.

Dort wird Ihnen angezeigt, dass die Daten erfolgreich geändert wurde und gleichzeitig wird Ihnen der neue Datensatz zu dem Kontakt angezeigt.


Kontakt ansehen

Im Menü "Kontakt ansehen" können Sie Kontaktdaten für einen bestehenden Kontakt ansehen.

Die Eingabemaske sieht wie folgt aus:

Kontakt-IDJaKontakt-ID des Kontaktes welcher bearbeitet werden soll


Veranstaltungen anzeigen?Nein

Wenn ein Häkchen gesetzt wird, werden die Veranstaltungen anzeigt, welche im ausgewählten Zeitraum stattgefunden haben oder stattfinden werden.

Zeitraum ist immer ausgewählter Zeitraum +/-

Zeitraum für Teilnahmen?Nein

Zeitraum +/- aktuelles Datum in den Veranstaltungen von diesem Kontakt gebucht worden sind.


Das Eingabefeld "Kontakt-ID" ist ein Pflichtfeld.

Der Punkt "Veranstaltungen anzeigen?" ist optional und bietet in Verbindung mit der Auswahl für den Zeitraum, eine Möglichkeit Veranstaltungen, welche dem Kontakt zugehörig sind, anzeigen zu lassen.

Nach Absenden des Formulars durch Betätigen des Buttons "Suchen" bekommen Sie bei richtiger Eingabe folgenden Bildschirm.

Haben Sie eine nicht existente Kontakt-ID eingegeben, wird Ihnen eine Fehlermeldung angezeigt.

Sie bekommen in der oberen hälte der Ausgabe den kompletten Datenstamm der Adressdaten, sowie der Kontaktdaten, soweit diese im KOntakt hinterlegt sind.

Ist der Kontakt mit einer Firma verknüpft, bekommen sie zusätzlich darunter die Firmendaten angezeigt.

Sollten Sie optional bei der Auswahl den Punkt "Veranstaltungen anzeigen?" gewählt haben, werden darüberhinaus alle Veranstaltungen des Kontaktes +/-  des gewählten Zeitraums ausgegeben.

Rote Daten stehe hierbei für vergangene Veranstaltungen im gesuchten Zeitraum, schwarze für aktuelle und zukünftige.

Deaktivieren/Löschen des Plugins

Sollten Sie das Plugin nicht mehr zu nuzten wünschen, so können Sie das Plugin entweder deaktivieren oder dauerhaft löschen.

Dazu gehen Sie wie folgt vor:

Folgen Sie der Anleitung "Zum Menüpunkt Einstellungen gelangen" der Variante 1.

Dort angekommen sehen Sie wieder folgendes Bild.

Zum Deaktivieren des Plugins klicken Sie auf den Punkt "Deaktivieren", das hat zur Folge, dass das Plugin nicht mehr zur Nutzung verfügbar ist, bis Sie es wieder aktivieren.

Beim Deaktivieren bleiben sämtliche Einstellungen des Plugins gespeichert.

Folgendes Bild zeigt die Menüpunkte des Plugins anch Deaktivierung.

Wenn Sie nun das Plugin wieder aktivieren, steht das Plugin wieder voll zu Verfügung.

Nun haben Sie ebenfalls die Möglichkeit, das Plugin vollständig zu löschen, was zur Konsequenz hat, dass das Pugin aus ihrem System gelöscht wird und alle Einstellungen verloren gehen.

Wenn Sie das Plugin nach Löschung wieder verwenden möchten, können Sie das Plugin, wie in der Anleitung beschrieben, neu installieren.



  • No labels