App-Verwaltung

#App aus einer Einladung installieren

1. Löse zuerst den Einladungscode ein.#

   Wie das geht, steht im Abschnitt „Einladungscode einlösen“. Ist der Code gültig und die App in deiner Organisation noch nicht installiert, öffnet sich das Fenster App installieren.

2. Prüfe die Angaben zur App.#

   Das Fenster zeigt Informationen zur eingeladenen App. Hat der Anbieter eine Begründung für die angefragten Berechtigungen hinterlegt, siehst du sie ebenfalls.

3. Wähle unter Zugriff gewähren auf die Berechtigungen aus, die die App erhalten soll.#

   Jede angefragte Berechtigung steht dort mit einer kurzen Beschreibung. Alle sind vorausgewählt. Entferne den Haken bei allem, was die App nicht erhalten soll. Fragt die App keine Berechtigungen an, fehlt diese Liste.

4. Klicke auf Installieren & Zugriff gewähren.#

   Du siehst die Meldung „App wurde installiert.“

#App aus einer Datei importieren

1. Öffne das Drei-Punkte-Menü neben Erstellen und wähle Aus Datei importieren.#
2. Lade im Feld JSON-Datei die Exportdatei der App hoch.#

   Das Feld ist ein Pflichtfeld und nimmt nur JSON-Dateien an, zum Beispiel eine Datei, die du mit Exportieren heruntergeladen hast.

3. Bestätige den Import.#

   Gibt es noch keine App mit demselben Slug, erscheint „App wurde importiert und erstellt.“ Gibt es sie schon, erscheint „Bestehende App wurde aktualisiert.“

#App exportieren

1. Suche in der Liste auf der Seite Apps die App, die du exportieren willst.#
2. Klicke in ihrer Zeile auf Exportieren.#

   Dein Browser lädt die Konfiguration der App als JSON-Datei herunter. Der Dateiname beginnt mit „tool-“, danach folgen der Slug der App und „.json“.

#Entwickler-Tools einer App öffnen

1. Suche die App in der Liste auf der Seite Apps.#
2. Klicke in ihrer Zeile auf Entwickler-Tools.#

   Es öffnet sich eine Seite mit dem Titel „<App-Name> — Entwickler-Tools“.

3. Prüfe die Übersicht der App.#

   Du siehst Name, Version und Base URL. Ist noch keine Adresse hinterlegt, steht dort „Noch nicht gesetzt“. Bei einer installierten App siehst du zusätzlich Status und Installiert am. Ist die App nicht installiert, steht dort „Diese App ist in dieser Instanz nicht installiert.“

4. Nutze bei Bedarf die Aktionen im Kopfbereich der Seite.#

   Ist die App noch nicht installiert, kannst du sie hier über Installieren installieren. Bei einer installierten App stehen dir die folgenden Menüs zur Verfügung.

• Einladungen: Einladungscode erstellen und Einladungen verwalten
• Entwicklung: Einstellungen, Entwicklermodus, Test-Webhook senden und Dokumentation
• Veröffentlichen & Deploy: Verifizierung beantragen, Deployen und Redeploy
• Drei-Punkte-Menü: Aktivieren beziehungsweise Deaktivieren und Deinstallieren

#App von einer URL importieren

1. Öffne das Drei-Punkte-Menü neben Erstellen und wähle Von URL importieren.#
2. Gib im Feld Base URL die Basis-Adresse der App ein.#

   Das Feld ist ein Pflichtfeld und verlangt eine gültige URL, zum Beispiel https://my-tool.example.com.

3. Bestätige den Import.#

   Die App-Beschreibung wird von dieser Adresse gelesen und die App wird übernommen. Du siehst die Meldung „App wurde aus Manifest importiert.“

#Neue App erstellen

1. Klicke im Kopfbereich der Seite Apps auf Erstellen.#

   Das Fenster Quick App öffnet sich.

2. Gib im Feld App-Name einen Namen ein.#

   Das Feld ist ein Pflichtfeld mit höchstens 255 Zeichen.

3. Lege unter Oberfläche fest, wo die App erscheinen soll.#

   Eigene Seite ist vorausgewählt und legt einen Navigations-Eintrag mit eigener Seite an. Solange diese Option gewählt ist, bestimmst du im Feld Menübereich, in welchem Bereich der Navigation der Eintrag erscheint. Ein Bereich ist vorbelegt. Zusätzlich kannst du Dashboard-Widget (kompakte Karte auf dem Dashboard), Kontakt-Tab (zusätzlicher Tab auf der Kontakt-Detailseite) und Kontakt-Massenaktion (Aktion für ausgewählte Kontakte in der Kontaktliste) wählen.

4. Optional: Klappe Webhooks auf und wähle die Ereignisse, bei denen die App benachrichtigt werden soll.#

   Zur Auswahl stehen contact.created, contact.updated, contact.deleted, donation.created und task.assigned. Webhooks kannst du auch später hinzufügen.

5. Klappe API-Berechtigungen auf und wähle, auf welche Daten die App zugreifen darf.#

   Zur Auswahl stehen Kontakte lesen (vorausgewählt), Kontakte schreiben, Spenden lesen, Spenden schreiben, Projekte lesen und Organisations-Info lesen.

6. Optional: Erkläre im Feld Begründung für Berechtigungen, wofür die App diese Berechtigungen braucht.#

   Höchstens 1000 Zeichen. Organisationen, die die App über eine Einladung installieren, sehen diese Begründung im Fenster App installieren.

7. Bestätige, um die App anzulegen.#

   Du siehst „App wurde erstellt. Führe den Befehl aus, um loszulegen.“ und landest in den Entwickler-Tools der neuen App. Dort steht ein Befehl, den du in deinem Projektverzeichnis im Terminal ausführst, um die App mit dieser Instanz zu verbinden.

#Einladungscode einlösen

1. Öffne das Drei-Punkte-Menü neben Erstellen und wähle Einladungscode einlösen.#
2. Gib im Feld Einladungscode deinen Code ein.#

   Das Feld ist ein Pflichtfeld. Der Code muss mindestens 10 Zeichen lang sein.

3. Bestätige.#

   Ist der Code gültig, öffnet sich das Fenster App installieren. Mach dann wie im Abschnitt „App aus einer Einladung installieren“ beschrieben weiter.

#App aktivieren oder deaktivieren

1. Suche die installierte App in der Liste auf der Seite Apps.#
2. Klicke in ihrer Zeile auf Deaktivieren oder Aktivieren.#

   Bei einer aktiven App heißt die Aktion Deaktivieren, bei einer inaktiven Aktivieren.

3. Bestätige die Rückfrage.#

   Du siehst die Meldung „Status wurde geändert.“

#Apps

Die Liste auf der Seite Apps zeigt nur die Apps deiner aktuellen Organisation. Die neuesten Apps stehen oben. Sichtbare Spalten sind Name (durchsuchbar und sortierbar), Slug (durchsuchbar), Version, Status und Installiert (Ja/Nein-Symbol für deine Organisation). Das Erstellungsdatum ist als Spalte standardmäßig ausgeblendet und lässt sich einblenden.

In jeder Zeile findest du je nach Zustand der App Installieren (nur bei nicht installierten Apps), Aktivieren oder Deaktivieren (nur bei installierten Apps), Entwickler-Tools, Exportieren sowie eine Aktion zum Bearbeiten der App.

#Einstellungen einer App bearbeiten

Über die Bearbeiten-Aktion in der Zeile einer App öffnet sich ein Fenster mit mehreren Reitern:

• Allgemein: Name (Pflichtfeld), Slug (Pflichtfeld, eindeutig, nur Buchstaben, Ziffern, Binde- und Unterstriche), Beschreibung, Base URL, OAuth Redirect-Pfad, Version, Autor, Autor-URL und Status (Privat oder Nicht gelistet)
• Berechtigungen: auf welche Daten und Funktionen die App zugreifen darf
• UI-Slots: wo die App in der Oberfläche erscheint, mit Slot-Typ, Integrationstyp, Pfad, Bezeichnung und bei Navigationseinträgen Menü
• Webhooks: Webhook-Pfad und Events
• Einstellungen-Schema: Einstellungsfelder, die Organisationen beim Installieren konfigurieren können, mit Schlüssel, Feldtyp, Bezeichnung, Standardwert und Pflichtfeld
• Entwickler: Freigeschaltete Entwickler, also weitere Nutzer deiner Organisation, die den Entwicklermodus für diese App verwenden dürfen

#Häufige Fragen