Mikroapps

Konfigurieren der Integration

Nach dem Hinzufügen der HTTP-Integration konfigurieren Sie nun Ihre Integration. Diese Endpunktdaten bilden gemeinsam mit der konfigurierten Dienstaktion die Grundlage für das Erstellen der umsetzbaren Mikroapps.

Hinzufügen von Datenendpunkten

Konfigurieren Sie die Datenendpunkte, damit relevante Daten in den Cache gelesen werden. Alle Daten, die wir dem Benutzer anzeigen möchten (oder die Ereignisse oder Aktionen auslösen sollen), müssen im Cache sein.

Führen Sie folgende Schritte aus, um einen Datenendpunkt hinzuzufügen:

  1. Wählen Sie Daten laden.

    Neuen Endpunkt hinzufügen

  2. Geben Sie Endpunktname und Endpunkt-URI ein.

  3. Konfigurieren Sie die Anforderungsmethode.

  4. (Optional) Wählen Sie + Parameter hinzufügen und konfigurieren Sie bei Bedarf die Parameter Path, Query oder Header.

    Hinweis:

    Der ausgewählte Datentyp bestimmt die Formatierung der Attribute. Die Formatierung bestimmt die Felder in Mikroapps. Verwenden Sie geschweifte Klammern {} zum Verweis auf Parameternamen. Beispiel: .

  5. Wählen Sie den Paginierungstyp.

    Der Paginierungstyp hängt vom API-Standard Ihrer Zielanwendungsintegration ab. In der API-Dokumentation Ihrer Zielanwendungsintegration erfahren Sie, welche Paginierungsmethode Ihre Anwendungsintegration verwendet. In der HTTP-Integration stehen folgende Standard-Paginierungsmethoden zur Auswahl.

    • Keine - Keine definierte Paginierung.
    • Seite - Begrenzen der Zeilenanzahl pro Seite.

      Beispiel:https://example.com?limit=100&page=3

    • Offset - Festlegen von zwei Parametern: Offset und Limit. “Offset” definiert die Anzahl der Datensätze, die übersprungen werden sollen, “Limit” die Anzahl der Datensätze, die pro Seite anzuzeigen sind.

      Beispiel:https://example.com?limit=100&offset=300

    • Link - Festlegen der Paginierungsmethode, die den Link zur nächsten Seite im Textkörper definiert.

      Beispiel:

       {
       “data” […]
       “next”: https://example.com?lpage=3
       }
      
    • Headerlink - Ähnlich der Link-Paginierung. Definieren der Paginierung basierend auf dem Header der URL-Seite.

      Beispiel:

       Link: <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=15>; rel="next",
       <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
      
    • Cursor - Bei der Cursor-Paginierung wird ein eindeutiger Bezeichner für einen Datensatz als Zeiger auf den nächsten Datensatz verwendet, der für die Ergebnisseite abzufragen ist.

      Beispiel:https://example.com?paginationToken=BFLMPSVZ

    • OData - Wählen Sie Ihre OData-Version aus, um die Paginierung nach OData-Standards durchzuführen.

      Endpunktpaginierungstyp festlegen

  6. Wählen Sie Dienst testen, um zu prüfen, ob der Endpunkt korrekt konfiguriert ist.

    Bei erfolgreichem Test fahren Sie mit dem nächsten Schritt fort. Wenn Sie eine Fehlermeldung erhalten, müssen Sie zunächst den Fehler gemäß der angezeigten Fehlermeldung beheben.

Abrufen der Datenstruktur

Sie können Ihre Tabellen jetzt im Abschnitt Datenstruktur abrufen erstellen.

  1. Wählen Sie Tabellen generieren.
  2. Wählen Sie Von API oder Von JSON:
    • Von API - der Datenabruf erfolgt automatisch vom definierten Endpunkt.
    • Von JSON - Die API wird bei Bedarf eingefügt, z. B. wenn Sie die Antwort haben, die API jedoch nicht aufrufen können. (Optional) Definieren Sie den Stammpfad, wenn der definierte Endpunkt einen alternativen Stamm benötigt. Die Definition des Stammpfads muss in JSON-Zeigernotation erfolgen.
  3. Wählen Sie Tabellen generieren.
  4. Um den Primärschlüssel festzulegen, wählen Sie das Stiftsymbol Attribute bearbeiten und aktivieren den Primärschlüssel für das Attribut, das als Primärschlüssel verwendet werden soll (z. B. id). Wichtig ist, dass die Spalte “Primärschlüssel” keine Nullwerte enthält. Ändern Sie den Datentyp nicht in TIMESTAMP.

    Hinweis:

    Beim Erstellen einer benutzerdefinierten Integration und Mikroapp müssen Sie stets einen Primärschlüssel zuteilen, um ein korrektes inkrementelles Laden zu aktivieren. Andernfalls werden Daten beim Synchronisieren vollständig überschrieben.

  5. (Optional) Wählen Sie Tabelle hinzufügen, konfigurieren Sie zusätzliche Tabelleneigenschaften, wie für die gewünschte Zielanwendung erforderlich, und klicken Sie auf Speichern. Anschließend können Sie die Tabellenstruktur vom API-Endpunkt neu laden.

  6. Inkrementelle Synchronisierung

    Bei aktivierter inkrementeller Synchronisierung können Sie die Synchronisierung einrichten. Dabei werden in kürzeren Abständen nur die Datensätze heruntergeladen, die seit der letzten Datensynchronisierung aktualisiert wurden. Hierfür müssen Sie konfigurieren, wie oft Ihr API-Aufruf ausgeführt werden soll. Geben Sie mindestens einen Serverzeitparameter ein. Wenn Sie keinen Zeitplan festlegen, erfolgt die Synchronisierung manuell.

    Benutzerdefinierte Parameter sind nur erforderlich, wenn die Zielanwendung sie benötigt. Weitere Informationen finden Sie bei Bedarf in der Dokumentation für Ihre Zielanwendungsintegration. Wenn Sie eine benutzerdefinierte Zeichenfolge für die Synchronisierung erstellen, muss diese in eckigen Klammern stehen. Beispiel: [updated >=] ‘JJJ-MM-TT HHmm’.

    Weitere Informationen zur Synchronisierung finden Sie unter Festlegen der Datensynchronisierung weiter unten.

  7. Geben Sie den Basisnamen der erstellten Tabellen im Abschnitt Datenstruktur abrufen ein und wählen Sie eine der folgenden Optionen:
    • Von API - der Datenabruf erfolgt automatisch vom definierten Endpunkt.
    • Von Beispiel-JSON - die API wird bei Bedarf eingefügt, z. B. wenn Sie die Antwort haben, die API jedoch nicht aufrufen können.

    Synchronisierung festlegen

  8. Wählen Sie Hinzufügen.

Der Datenendpunkt ist damit zugeordnet und Sie können nun die Dienstaktionen einrichten.

Hinweis:

Nach dem Einrichten und Hinzufügen des Endpunkts ist die Tabellenstruktur gesperrt. Bei erforderlicher Strukturänderung müssen Sie einen neuen Endpunkt für das Laden von Daten erstellen und konfigurieren.

Hinzufügen zusätzlicher API-Aufrufe

Wenn Sie Datenendpunkte für die Anwendungsintegration konfigurieren, können Sie dem ursprünglichen übergeordneten Endpunkt zusätzliche untergeordnete Endpunkte hinzufügen, um eine Aufrufverkettung zu aktivieren. Nachdem Sie Ihre Datenendpunkte eingerichtet haben, können Sie weitere zugeordnete Endpunkte hinzufügen.

Führen Sie die folgenden Schritte aus:

  1. Wählen Sie Bearbeiten im Menü der Integration, der Sie einen untergeordneten Anruf hinzufügen möchten.

    Bearbeiten im Menü der Integration

    Die Seite der Integration wird geöffnet.

  2. Wählen Sie im Menü des gewünschten Datenendpunkts die Option Untergeordneten API-Aufruf hinzufügen:

    Menü "Untergeordneten API-Aufruf hinzufügen"

  3. Wählen Sie die übergeordnete Tabelle aus und definieren Sie den Endpunkt entsprechend den Schritten zum Laden von Daten (siehe oben).

Beim Definieren der Anforderungsmethode können Sie den Pfad auf einen statischen Wert oder einen Spaltenwert festlegen. Ihre API-Aufrufkette ist jetzt mit dem übergeordneten API-Aufruf verknüpft. Die von Ihnen definierten übergeordneten bzw. untergeordneten Endpunkte werden nun auf der Seite “Datenendpunkt” angezeigt.

Hinweis:

Beim Erstellen von Integrationen empfiehlt es sich, Ihre Daten nur von einem einzigen Endpunkt zu laden. Bündeln Sie Endpunkt-Aufrufe nach Möglichkeit, anstatt einzelne Aufrufe auszuführen.

Zusammenführen von Tabellen

Beim Konfigurieren untergeordneter API-Aufrufe können Sie untergeordnete Tabellen mit der übergeordneten Tabelle zusammenführen. Wählen Sie eine der folgenden Optionen aus:

Wählen Sie Nicht zusammenführen, um übergeordnete und untergeordnete Tabellen nicht zusammenzuführen.

Wählen Sie Als Detail zusammenführen, um alle Aufgaben und Anforderungen aus dem System of Record (SoR) und alle Anforderungsdetails abzurufen und zusammenzuführen. Hier ein Beispiel mit über- und untergeordneter Tabelle:

/request-list
{
“ID”: 123,
“Titel”: “Auto”,
“Rolle”: “Bestellung”,
“Kategorie”: “Vertrieb”
}

Und:

/request-detail/123
{
“ID”: 123,
“Titel”: “Auto”,
“Beschreibung”: “Cabriolet”,
“Datum”: “2020-01-01”
}

Nach Auswahl von Als Detail zusammenführen erhält man folgende Tabelle:

ID Titel Rolle Kategorie Beschreibung Datum
123 Auto Bestellung Vertrieb Cabriolet 2020-01-01

Wählen Sie Als Unterliste zusammenführen, um jede untergeordnete Tabelle einzeln an die übergeordnete Tabelle anzuhängen. Im obigen Beispiel ergibt das Zusammenführen als Unterliste Folgendes:

ID Titel Rolle Kategorie ID Titel Beschreibung Datum
123 Auto Bestellung Vertrieb 123 Auto Cabriolet 2020-01-01

Konfigurieren von Tabellen

Sie können Tabellenprimärschlüssel neu konfigurieren, ohne eine neue Konfiguration einzurichten. Hierfür löschen Sie einzelne Tabelleneinträge im Tabellenfenster, synchronisieren die Tabelle neu, und wählen den neuen Primärschlüssel aus.

Unterstützte Zeitformate

Die HTTP-Integration unterstützt die folgenden Zeitformate für die Daten in Ihrem System of Record (SoR):

  • ISO-Datumsformat
  • OData-Format
  • "yyyy-M-dd HH:mm:ss.SSS",
  • "M/d/yy h:mm a",
  • "M/d/yyyy h:mm:ss a",
  • "dd/MM/yy HH:mm",
  • "MMM d, yyyy h:mm:ss a",
  • "dd-MMM-yyyy HH:mm:ss",
  • "MMMM d, yyyy h:mm:ss a",
  • "dd MMMM yyyy HH:mm:ss",
  • "EEEE, MMMM d, yyyy h:mm:ss a",
  • "EEEE, d MMMM yyyy HH:mm:ss 'o''clock'",
  • "h:mm a",
  • "HH:mm",
  • "h:mm:ss a",
  • "HH:mm:ss"

Hinzufügen von Dienstaktionen

Nach dem Konfigurieren Ihrer HTTP-Integration können Sie die Dienstaktionen konfigurieren. Mit Dienstaktionen konfigurieren Sie die Aktionen, mit denen Sie in das Kerndatensystem (System of Record, SoR) Ihrer Anwendungsintegration zurückschreiben. Sie konfigurieren Dienstaktionen auf ähnliche Weise wie die oben genannten Datenendpunkte. Da Ihre Anwendungsintegration beliebig viele benutzerdefinierte Kombinationen umfassen kann, erklären wir ganz allgemein, wie Dienstaktionen funktionieren.

Führen Sie folgende Schritte aus, um Dienstaktionen hinzuzufügen:

  1. Wählen Sie die erstellte Integration unter Anwendungsname aus.
  2. Wählen Sie Dienstaktionen und Neue Dienstaktion hinzufügen.
  3. Geben Sie einen Aktionsnamen ein (z. B. JIRA-Ticketinfo abrufen) und geben Sie den Pfad für den Endpunkt-URI ein: (/rest/api/2/issue/)
  4. Konfigurieren Sie die Anforderungsmethode gemäß den API-Erfordernissen Ihrer Anwendungsintegration.

    Hinweis:

    Verwenden Sie geschweifte Klammern {} zum Verweis auf Parameternamen. Beispiel: .

  5. Wählen Sie Hinzufügen, um die Dienstaktion zu speichern. Sie können nun nach Bedarf weitere Dienstaktionen hinzufügen.

API-Anforderungsmethode

Konfigurieren Sie nun die Anforderungsmethode gemäß den API-Erfordernissen Ihrer Anwendungsintegration. Nutzen Sie folgende Komponenten:

  • GET - Abrufen von Ressourcen aus dem SoR der Anwendungsintegration ohne Änderung.
  • POST - Erstellen einer neuen Ressource im SoR der Anwendungsintegration.
  • PUT - Aktualisieren vorhandener Ressourcen in der Anwendungsintegration.
  • PATCH - Partielle Aktualisierung einer Ressource.
  • DELETE - Löschen einer Ressource.

Folgende API-Parameter können konfiguriert werden:

  • Header - Definieren von Parametern im Header der Anforderung, in der Regel bezogen auf die Autorisierung.
  • Path - Definieren von Parametern im Pfad des Endpunkts, vor der Abfragezeichenfolge.
  • Query - Definieren von Parametern in der Abfragezeichenfolge des Endpunkts.
  • Body - Definieren von Parametern im Textkörper der Anforderung.

Datenaktualisierung vor Ausführung einer Aktion

(Optional) Konfigurieren Sie eine Datenaktualisierung vor dem Ausführen einer Aktion, um sicherzustellen, dass Daten vollständig für Mikroapp-Endbenutzer synchronisiert sind, wenn diese die Aktion ausführen. Sie möchten beispielsweise sicherstellen, dass der Betrag, der in der Mikroapp zum Genehmigen angezeigt wird, korrekt ist und nicht in der Zeit zwischen dem Erstellen und Genehmigen geändert wurde.

Führen Sie folgende Schritte aus, um Daten vor einer Aktion zu aktualisieren:

  1. Wählen Sie den vorhandenen Datenendpunkt, von dem Sie den aktualisierten Datensatz abrufen möchten.
  2. (Optional) Aktivieren Sie Untergeordnete Endpunkte einschließen nur dann, wenn die untergeordneten Datenendpunkte zum Abrufen aller Details des aktualisierten Datensatzes erforderlich sind.
  3. (Optional) Erweitern Sie die ursprüngliche Endpunkt-URI, wenn das Update dadurch einen einzelnen Datensatz abrufen kann. Zum Beispiel, wenn die Datenendpunkt-URI https://domain/api/items in https://domain/api/items/itemId aktualisiert wird. Die neue Endpunkt-URI muss dieselbe Datenstruktur wie die ursprüngliche URI zurückgeben, da sonst die Datenanalyse fehlschlägt.
  4. (Optional) Erweitern Sie die ursprünglichen Anforderungsparameter mit Zusätzlichen Parameter hinzufügen, um das Filtern einzelner Datensätze zu ermöglichen.

Beenden Sie die Konfiguration mit Speichern.

Datenaktualisierung nach Ausführung einer Aktion

(Optional) Um sicherzustellen, dass Ihre Daten nach dem Ausführen einer Aktion vollständig synchronisiert sind, können Sie eine Datenaktualisierung konfigurieren, um neue Daten aus dem System of Records (SoR) der Zielanwendung abzurufen.

Führen Sie folgende Schritte aus, um Daten nach einer Aktion zu aktualisieren:

  1. Wählen Sie den vorhandenen Datenendpunkt, von dem Sie den aktualisierten Datensatz abrufen möchten.
  2. (Optional) Aktivieren Sie Untergeordnete Endpunkte einschließen nur dann, wenn die untergeordneten Datenendpunkte zum Abrufen aller Details des aktualisierten Datensatzes erforderlich sind.
  3. (Optional) Erweitern Sie die ursprüngliche Endpunkt-URI, wenn das Update dadurch einen einzelnen Datensatz abrufen kann. Zum Beispiel, wenn die Datenendpunkt-URI https://domain/api/items in https://domain/api/items/itemId aktualisiert wird. Die neue Endpunkt-URI muss dieselbe Datenstruktur wie die ursprüngliche URI zurückgeben, da sonst die Datenanalyse fehlschlägt.
  4. (Optional) Erweitern Sie die ursprünglichen Anforderungsparameter mit Zusätzlichen Parameter hinzufügen, um das Filtern einzelner Datensätze zu ermöglichen.

Beenden Sie die Konfiguration mit Speichern.

Überprüfen erforderlicher Entitäten

Verwenden Sie Tabelle, um die aktuelle Liste Ihrer Tabellen im Cache und die auf die Tabellen angewendeten Filter zu überprüfen.

Sie können nun die erste Datensynchronisierung festlegen und ausführen, es sei denn, Sie müssen benutzerdefinierte Beziehungen erstellen. Weitere Informationen finden Sie unter Festlegen der Datensynchronisierung.

Erstellen von benutzerdefinierten Beziehungen

Auf der Seite Beziehungen können Sie eine benutzerdefinierte Verbindung zwischen Tabellen in Ihrer Integration erstellen. Sie können dies verwenden, wenn Sie mehrere Basis-URLs haben und mehrere Integrationen erforderlich sind oder wenn Sie eine benutzerdefinierte Beziehung in derselben Integration erstellen möchten. Da dies ein anspruchsvoller Anwendungsfall ist, sollten Sie sich mit dem Erstellen von Mikroapps in einer einzelnen Integration vertraut machen, bevor Sie mit der Zuordnung mehrerer Integrationen beginnen.

  1. Wählen Sie auf der Seite zum Verwalten der Mikroapps das Menü neben der Integration aus, deren Entitäten Sie überprüfen möchten.
  2. Wählen Sie Bearbeiten und dann Beziehungen.
  3. Wählen Sie Neue Beziehung hinzufügen.

    Die Seite “Beziehung hinzufügen” wird geöffnet.

  4. Sie können Ihre Primärtabelle Ihrer Fremdtabelle zuordnen.
  5. Geben Sie den Alias ein, den Sie verwenden möchten.

Sie können nun zusätzliche Referenzspalten zuordnen und hinzufügen, basierend auf den Primärschlüsseln, die Sie für jede Integration eingerichtet haben.

Wichtig:

Wenn Sie eine Tabelle löschen, werden auch alle Beziehungen gelöscht.

Festlegen der Datensynchronisierung

Hiermit werden Daten von Ihren integrierten Anwendungen an die Mikroappsplattform gesendet, sodass ein Abgleich mit dem Cache erfolgen kann. Als bewährte Methode wird empfohlen, alle 24 Stunden eine vollständige Synchronisierung durchzuführen. Inkrementelle Synchronisierungen können für alle fünf Minuten konfiguriert werden.

  1. Wählen Sie auf der Seite zum Verwalten der Mikroapps das Menü neben der Integration aus, für die Sie eine Synchronisierung festlegen möchten.
  2. Wählen Sie Synchronisierung.

    Festlegen der Datensynchronisierung

  3. Wählen Sie Vollständig bzw. Inkrementell für die Datensynchronisierung.

    • Vollständig - Der lokale Cache wird geleert und alle Daten werden aus dem Quellsystem abgerufen.

      Wichtig:

      Das Ausführen einer vollständigen Synchronisierung kann lange dauern. Wir empfehlen das Ausführen einer vollständigen Synchronisierung in der Nacht oder während Auszeiten. Wählen Sie das X-Symbol, um eine laufende Datensynchronisierung jederzeit abzubrechen.

    • Inkrementell - Es werden nur geänderte (neue und aktualisierte) Datensätze abgerufen. Gelöschte Daten werden nicht geladen.

      Wichtig:

      Nicht alle APIs unterstützen eine inkrementelle Synchronisierung.

      Wenn Sie eine tägliche oder wöchentliche Synchronisierung definieren, erfolgt diese willkürlich innerhalb des von Ihnen festgelegten Zeitfensters. Wenn Sie beispielsweise eine tägliche, vollständige Synchronisierung in der Zeit von 00-04 Uhr festlegen, wird diese zu einem willkürlich gewählten Zeitpunkt in diesem Zeitraum gestartet.

  4. Wählen Sie Speichern.

Hinweis:

Falls notwendig, können Sie über die Pfeilsymbole die Integrationen auch nach Bedarf auszuführen.

Anzeigen von Integrationsprotokollen

Mit Integrationsprotokoll zeigen Sie einen Verlauf der Änderungen an, kategorisiert nach Schweregrad. Verwenden Sie diese Option, um Probleme mit Ihrer Integration zu beheben. Wenn beispielsweise die Synchronisierung fehlgeschlagen ist, können Sie die Ursache in den Integrationsprotokollen suchen. Wenn erwartete Karten nicht angezeigt werden, prüfen Sie anhand der Integrationsprotokolle, ob die Synchronisierung stattgefunden hat.

Anzeigen von Integrationsprotokollen

  1. Wählen Sie auf der Seite zum Verwalten der Mikroapps das Menü neben der Integration aus, deren Integrationsprotokolle Sie anzeigen möchten.
  2. Wählen Sie Integrationsprotokolle.
  3. Überprüfen Sie die Einträge und wählen Sie ggf. das Menü zum Filtern nach Fehlern.

Exportieren von Integrationskonfigurationen

Sie können Ihre Integrationskonfigurationen auch exportieren. Alle Anmeldeinformationen werden verworfen. Dazu gehören Kennwörter und Clientangaben. Nur die auf dem Mikroappserver gespeicherte Konfiguration wird exportiert. Beispielsweise wird beim Export Ihr Benutzername und Ihre OAuth-Konfiguration beibehalten, aber nicht Ihr Kennwort und auch nicht der geheime Clientschlüssel.

  1. Wählen Sie auf der Seite zum Verwalten der Mikroapps das Menü neben der Integration aus, die Sie exportieren möchten.
  2. Wählen Sie Konfiguration exportieren.

    Die Datei service.mapp wird heruntergeladen.

So geht es weiter

Nach dem Erstellen und Konfigurieren Ihrer benutzerdefinierten Integration erstellen Sie nun eigene Mikroapps für ein Benutzererlebnis, das Ihre Anforderungen erfüllt und tägliche Workflows optimiert. Weitere Informationen finden Sie unter Erstellen von Mikroapps.