Kundenexport (JSON)

Was Kundenexport (JSON) kann, wie du das Werkzeug aktivierst und freigibst, was in der JSON-Datei steht und wie du einen Kunden aus der Kundenverwaltung exportierst.

Kundenexport (JSON) ist ein Werkzeug, das i-Planner selbst gebaut hat. Ein externer Anbieter ist nicht beteiligt. Damit lädst du in der Kundenverwaltung den Datensatz eines Kunden als JSON-Datei herunter. Vorher muss deine Organisation das Werkzeug einmal unter Organisation › Integrationen aktivieren.

Kurz erklärt

Kundenexport (JSON) erzeugt in der Kundenverwaltung für einen Kunden eine JSON-Datei mit seinen Daten:

Im Fenster Kundenexport (JSON) wählst du genau einen Kunden aus. Ein Klick auf Öffnen startet sofort den Download der Datei kunde_<ID>.json. Hinter kunde_ steht die interne ID des Kunden.
In der Datei stehen der Kundendatensatz, Adressen, Kontaktdaten, Beruf, Nummern, Identifizierung, Finanzdaten, Verträge mit ihren Vertragspersonen, Schäden, Beziehungen zu anderen Kontakten und Verknüpfungen. Die Einzelheiten stehen unter Was in der JSON-Datei von Kundenexport (JSON) steht.
Dazu kommen als Nachschlagelisten die Feldbeschriftungen, die Werte der Auswahllisten mit ihrer Bezeichnung und die Sparten. Mit ihnen lassen sich die gespeicherten Werte lesen.
Ist beim Öffnen des Werkzeugs in der Kundenverwaltung ein Kunde aufgerufen, steht er im Fenster schon im Feld Kunde.
Unter Organisation › Integrationen legt deine Organisation fest, wer das Werkzeug nutzen darf.
Zugangsdaten oder einen Account brauchst du dafür nicht.

Die Daten gehen nur in eine Richtung und nur für einen Kunden je Export. Einen Export mehrerer oder aller Kunden auf einmal gibt es nicht. Auch einen automatischen oder zeitgesteuerten Export oder eine Synchronisation gibt es nicht. Kundenexport (JSON) hat keine Import-Funktion. Der Export liest nur und ändert in i-Planner nichts. An Dritte geht dabei nichts.

Typische Aufgaben:

Deine Organisation will das Werkzeug nutzen: Kundenexport (JSON) einrichten.
Du brauchst die Daten eines Kunden als Datei: Kunden als JSON-Datei exportieren.
Du willst die Datei lesen oder weiterverarbeiten: Was in der JSON-Datei von Kundenexport (JSON) steht.
Die Kachel fehlt oder statt der Datei kommt eine Meldung: Fehlerbehebung.

Voraussetzungen

Zum Aktivieren und zum Festlegen der Freigabe unter Organisation › Integrationen braucht deine Benutzerrolle das Recht Integrationen.
Kundenexport (JSON) ist unter Organisation › Integrationen aktiviert. Sonst erscheint die Kachel Kundenexport (JSON) in der Kundenverwaltung nicht.
Wer exportiert, ist für das Werkzeug freigegeben. Das ist der Fall, wenn die Freigabe auf Alle Mitarbeiter (Voreinstellung) steht. Bei Nur ausgewählte Mitarbeiter muss die Person selbst, über ihre Rolle oder über eine ihrer Gruppen ausgewählt sein.
Du arbeitest mit einem Mitarbeiter-Login in der Kundenverwaltung. Mit einem Kunden-Login im Kundenportal lässt sich das Werkzeug nicht nutzen.
Zugangsdaten oder einen Account brauchst du nicht.
Der Kontakt, den du exportieren willst, ist als Kunde angelegt. Produktpartner und Benutzer lassen sich im Fenster Kundenexport (JSON) nicht auswählen.

Kundenexport (JSON) einrichten

Kundenexport (JSON) richtest du einmal für die ganze Organisation ein.

Öffne Organisation › Integrationen und wähle links unter Entdecken die Liste Alle. Kundenexport (JSON) hat keine Kategorie und steht deshalb nicht unter Pool, Datenlieferanten, E-Mail oder KI.
Klicke Kundenexport (JSON) an. Die Detailseite zeigt oben das Kennzeichen Official, die Beschreibung „i-Planner-Tool zum vollständigen Export eines Kundendatensatzes im JSON-Format.“ und Built by iPlanner.
Schalte im Bereich Aktivierung den Schalter Integration aktivieren ein. i-Planner speichert die Änderung sofort, einen Speichern-Knopf gibt es nicht.

Optional: Nach dem Einschalten erscheint der Bereich Einschränkungen. Dort legst du unter Freigabe fest, wer das Werkzeug nutzen darf: Alle Mitarbeiter (Voreinstellung) oder Nur ausgewählte Mitarbeiter.
Nur bei Nur ausgewählte Mitarbeiter: Wähle im Bereich Ausgewählte Mitarbeiter die Rollen, Gruppen und Personen aus, die Kundenexport (JSON) nutzen dürfen. Nach jeder Änderung an der Auswahl meldet i-Planner „Freigabe gespeichert“.

Mehr musst du nicht eintragen. Die Detailseite von Kundenexport (JSON) hat keinen Bereich Zugangsdaten, und es gibt kein geheimes Feld wie ein Passwort oder einen Schlüssel.

Feld	Pflicht	Was eintragen
Integration aktivieren	Ja	Einschalten, einmal für die Organisation. Solange der Schalter aus ist, erscheint die Kachel Kundenexport (JSON) in der Kundenverwaltung nicht.
Freigabe	Nein	Alle Mitarbeiter (Voreinstellung) oder Nur ausgewählte Mitarbeiter. Das Feld erscheint erst nach dem Einschalten im Bereich Einschränkungen.
Ausgewählte Mitarbeiter	Nein	Die Rollen, Gruppen und Personen, die Kundenexport (JSON) nutzen dürfen. Der Bereich erscheint bei Nur ausgewählte Mitarbeiter, und zwar schon vor dem ersten Einschalten. Eine Auswahl dort speichert i-Planner aber erst, wenn das Werkzeug aktiviert ist, siehe Integration aktivieren. Ist dort niemand ausgewählt, darf niemand das Werkzeug nutzen.

Wie die Auswahl der Rollen, Gruppen und Personen im Einzelnen funktioniert, steht unter Organisation › Integrationen im Abschnitt Wer die Integration nutzen darf.

Ob Kundenexport (JSON) eingeschaltet ist, siehst du unter Organisation › Integrationen. In der Listenansicht steht dann als Status Aktiv, in der Kachelansicht trägt die Kachel die Markierung Aktiviert. Inaktiv steht für eingerichtet, aber ausgeschaltet, Verfügbar für noch nie aktiviert. Wer das Werkzeug ein- oder ausgeschaltet oder die Freigabe geändert hat, steht unter Organisation › Audit-Log in Einträgen mit dem Bereich „Integrationen“.

Was Kundenexport (JSON) übermittelt

Nichts an Dritte. Kundenexport (JSON) hat keinen externen Anbieter. Auf seiner Detailseite unter Organisation › Integrationen steht Built by iPlanner, und der Export läuft auf dem i-Planner-Server. Ein Klick auf Öffnen im Fenster Kundenexport (JSON) erzeugt einen Download-Link. Er führt zum i-Planner-Server und enthält nur die interne ID des gewählten Kunden und einen Einmal-Code. Der Link gilt nur einmal und höchstens 30 Minuten.

Was in der JSON-Datei von Kundenexport (JSON) steht

Zurück kommt bei Kundenexport (JSON) eine JSON-Datei, die dein Browser herunterlädt. Das passiert sofort nach dem Klick auf Öffnen im Fenster Kundenexport (JSON), bei jedem Klick neu. In i-Planner landet nichts. Beim Export wird dort nichts gespeichert oder geändert. Die Datei zeigt den Stand der Daten zum Zeitpunkt des Downloads.

Dateiname: kunde_<ID>.json. Hinter kunde_ steht die interne ID des Kunden.
Format: UTF-8, lesbar formatiert mit Zeilenumbrüchen und Einrückungen. Umlaute stehen als Umlaute in der Datei.

Die Datei ist in Abschnitte gegliedert, jeder Abschnitt ist eine Liste von Einträgen:

Abschnitt in der Datei	Inhalt
`customer`	Der Kundendatensatz mit den Stammdaten des Kunden
`addresses`	Adressen
`contactdata`	Kontaktdaten
`occupations`	Angaben zum Beruf
`numbers`	Nummern
`idents`	Angaben zur Identifizierung
`finance`	Finanzdaten
`contracts`	Verträge. Zu jedem Vertrag stehen unter `persons` die Vertragspersonen
`damages`	Schäden
`customer_relations`	Beziehungen des Kunden zu anderen Kontakten, zum Beispiel zu Partner oder Kindern
`relations`	Verknüpfungen, bei denen der Kunde Eigentümer ist, zum Beispiel ein Vertrag, mit dem ein Dokument verknüpft ist
`fields`	Nachschlageliste: Feldbeschriftung, technischer Feldname und Eingabetyp der Felder für Kunde, Schäden, Dokumente, Adressen, Kontaktdaten, Beruf, Finanzen, Nummern und Identifizierung
`options`	Nachschlageliste: alle Werte der Auswahllisten deiner Organisation mit ihrer Bezeichnung
`sparten`	Nachschlageliste: alle Sparten

Nicht in der Datei stehen unter anderem Bankverbindungen, Dokumente und Dateien, Aktivitäten und Ziele. „Vollständig“ in der Beschreibung auf der Detailseite bezieht sich nur auf den Umfang in dieser Tabelle. Gelöschte Adressen, Kontaktdaten, Berufsangaben, Nummern, Identifizierungen, Finanzdaten, Verträge, Schäden und Verknüpfungen fehlen auch.

So liest du die Datei:

Die Schlüssel sind die technischen Feldnamen. Auswahlfelder enthalten den gespeicherten Wert, nicht den Klartext.
Den Klartext zu einem gespeicherten Wert findest du in options. Dort steht zu jedem Wert (wert) die Bezeichnung (bezeichnung). Die Sparten stehen in sparten. Beide Listen enthalten alle Einträge deiner Organisation, nicht nur die Werte dieses Kunden.
Die Beschriftungen der Felder für Kunde, Schäden, Dokumente, Adressen, Kontaktdaten, Beruf, Finanzen, Nummern und Identifizierung stehen in fields. Für Verträge und Vertragspersonen gibt es dort keine Beschriftungen. Diese Felder stehen nur mit ihrem technischen Namen in der Datei.

Kunden als JSON-Datei exportieren

Das geht in der Kundenverwaltung, sobald Kundenexport (JSON) unter Organisation › Integrationen aktiviert ist und du dafür freigegeben bist.

Rufe in der Kundenverwaltung den Kunden auf, den du exportieren willst. Der Schritt ist optional, spart aber die Suche. Ist beim Öffnen des Werkzeugs ein Kunde aufgerufen, steht er im Fenster schon im Feld Kunde.
Klicke oben rechts in der Kopfzeile, links neben deinem Profilbild, auf das Raster-Symbol mit dem Tooltip Schnittstellen. Es öffnet die Kacheln der Schnittstellen, die für dich aktiviert und freigegeben sind, jede mit Logo und Namen.
Wähle Kundenexport (JSON). Das Fenster Kundenexport (JSON) öffnet sich mit dem Feld Kunde und den Schaltflächen Öffnen und Abbrechen. Darin steht der Hinweis „Bitte wähle einen Kunden aus und drücke "Öffnen", um die Daten zu exportieren.“
Steht im Feld Kunde noch niemand, suche den Kunden über Kunde suchen und wähle ihn in der Trefferliste aus. Unter jedem Namen steht eine Zusatzzeile, zum Beispiel mit „Geb.“ und dem Geburtsdatum, der Nummer, dem Betreuer und der Adresse. Das Feld nimmt genau einen Kunden auf. Sobald er gewählt ist, verschwindet das Suchfeld.
Klicke auf Öffnen. Der Download der Datei kunde_<ID>.json startet sofort.

Abbrechen schließt das Fenster.

Jeder Klick auf Öffnen erzeugt einen neuen Download-Link, der nur einmal und höchstens 30 Minuten gilt. Brauchst du die Datei noch einmal oder mit dem aktuellen Stand, klicke im Fenster Kundenexport (JSON) erneut auf Öffnen.

Häufige Fragen

Nein. Im Fenster Kundenexport (JSON) nimmt das Feld Kunde genau einen Kunden auf. Einen Massenexport gibt es nicht. Auch einen automatischen oder zeitgesteuerten Export gibt es nicht. Für jeden weiteren Kunden wiederholst du den Export.

Nein. Kundenexport (JSON) hat keine Import-Funktion und keinen Rückweg. Der Export liest nur. In i-Planner wird dabei nichts gespeichert oder geändert.

Nein. Die Detailseite unter Organisation › Integrationen hat keinen Bereich Zugangsdaten, und das Fenster Kundenexport (JSON) in der Kundenverwaltung fragt keinen Account ab.

Hinter dem Info-Symbol am Schalter Integration aktivieren steht zwar ein Hinweis zu Accounts: „Deaktivieren suspendiert die Accounts nicht — es schränkt nur die Nutzung der Schnittstelle ein. Zum Stilllegen der Accounts den Schalter ‚Alle Accounts deaktivieren‘ nutzen.“ Dieser Text ist bei allen Integrationen gleich. Kundenexport (JSON) verwendet keine Accounts.

Nein. Einzelne Exporte stehen nicht im Audit-Log der Organisation. Dort steht nur, wer Kundenexport (JSON) ein- oder ausgeschaltet oder die Freigabe geändert hat. Du findest das unter Organisation › Audit-Log in Einträgen mit dem Bereich „Integrationen“. Mehr dazu steht unter Organisation › Integrationen im Abschnitt Sehen, wer eine Integration geändert hat. Wer exportieren darf, legst du über die Freigabe auf der Detailseite von Kundenexport (JSON) fest.

Weitere Themen

Fehlerbehebung: wenn die Kachel fehlt, der Download nicht startet oder eine Fehlermeldung erscheint.
Wer die Integration nutzen darf: die Freigabe für Rollen, Gruppen und Personen einstellen.
Kunden: den Kunden in der Kundenverwaltung aufrufen.
Portale: die Linksammlung zu den Gesellschaftsportalen, ebenfalls ein Werkzeug von i-Planner.