Zum Inhalt springen

Zendesk-Suchaktivität in Jitterbit Studio

Einführung

Eine Zendesk Such-Aktivität, die über die Zendesk-Verbindung erfolgt, ruft ein Objekt aus Zendesk ab und ist als Quelle gedacht, um Daten in einer Operation bereitzustellen.

Ratenlimits

Die Zendesk REST API, die vom Zendesk-Connector verwendet wird, setzt eine Reihe von Ratenlimits durch, die von verschiedenen Faktoren abhängen. Lesen Sie die Limits in der Zendesk-Dokumentation.

Erstellen einer Zendesk-Suchaktivität

Eine Instanz einer Zendesk Such-Aktivität wird aus einer Zendesk-Verbindung unter Verwendung des Aktivitätstyps Such erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene Zendesk Such-Aktivität kann an folgenden Orten bearbeitet werden:

Konfigurieren einer Zendesk-Suchaktivität

Befolgen Sie diese Schritte, um eine Zendesk Such-Aktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Objekt aus

In diesem Schritt geben Sie einen Namen für die Aktivität ein und wählen ein Objekt aus. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Endpunktmenü: Wenn Sie mehrere Endpunkte des gleichen Verbindungstyps konfiguriert haben, wird ein Menü oben auf dem Bildschirm angezeigt, das den aktuellen Endpunktnamen anzeigt. Klicken Sie auf das Menü, um zu einem anderen Endpunkt zu wechseln. Weitere Informationen finden Sie unter Ändern des zugewiesenen Endpunkts in Konfigurationsbildschirmen.

    • Endpunkt bearbeiten: Wird angezeigt, wenn Sie über den aktuellen Endpunktnamen fahren. Klicken Sie, um die Verbindungs-Konfiguration des aktuell ausgewählten Endpunkts zu bearbeiten.

  • Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Zendesk Suche-Aktivität eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • Wählen Sie ein Objekt aus: In diesem Abschnitt werden die in dem Zendesk-Endpunkt verfügbaren Objekte angezeigt.

    • Ausgewähltes Zendesk-Objekt: Nachdem ein Objekt ausgewählt wurde, wird es hier aufgelistet.

    • Suche: Geben Sie den Wert einer Spalte in das Suchfeld ein, um die Liste der Objekte zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Objekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Objekte beim Suchen vom Endpunkt neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Objekte vom Zendesk-Endpunkt neu zu laden. Dies kann nützlich sein, wenn Objekte zu Zendesk hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Objekttabelle verwendet werden.

    • Objekt auswählen: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um ein Objekt auszuwählen. Es kann nur ein Objekt ausgewählt werden. Die Informationen, die für jedes Objekt verfügbar sind, werden vom Zendesk-Endpunkt abgerufen:

      • Name: Der Name des Zendesk-Objekts.

      • Description: Die Beschreibung des Zendesk-Objekts.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Objekten gefüllt wird, könnte die Zendesk-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

  • Page Number: Die Anzahl der zurückzugebenden Seiten. Der Standardwert ist 1. Sie sollten dieses Feld auf eins mehr als die erwartete Anzahl der Seiten setzen. Um beispielsweise 350 Datensätze abzurufen, setzen Sie ein Seitenlimit von 5 oder mehr, da Sie vier Seiten (3 von 100 und 1 von 50) plus eine zusätzliche leere Seite benötigen, die den Fluss unterbricht.

  • Page Size: Die Anzahl der Ergebnisse pro Seite, die zurückgegeben werden sollen. Der Standardwert beträgt 100, was auch das Maximum ist. Wenn Sie dieses Feld ändern, müssen Sie möglicherweise neu berechnen, wie viele Seiten Sie im Feld Page Number oben benötigen.

  • Next: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie die Schaltfläche Fertig im letzten Schritt klicken.

  • Discard Changes: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemas

Alle Anforderungs- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird unten beschrieben.

  • Data Schemas: Die Anforderungs- und Antwortdatenschemata für Zendesk werden angezeigt. Wenn die Operation eine Transformation verwendet, werden die Datenschemata später während des Transformationszuordnungsprozesses erneut angezeigt, wo Sie Zielfelder mithilfe von Quellobjekten, Skripten, Variablen, benutzerdefinierten Werten und mehr zuordnen können.

    Hinweis

    Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

    Der Zendesk-Connector verwendet die Zendesk Rest API; siehe die API für Informationen zu den Schemas der unterstützten Objekte.

    Die Daten-Schemas für Anfragen und Antworten bestehen aus diesen Knoten und Feldern:

    • Anfrage:

      Anfrage-Schema Feld/Knoten Hinweise
      searchRequest Suchanfrage
      pageNumber Die Anzahl der zurückzugebenden Seiten. Maximal sind 10.
      pageSize Die Anzahl der Ergebnisse pro Seite, die zurückgegeben werden sollen. Maximal sind 100
      criteria Der Knoten, der Suchkriterien enthält, die die Suche weiter einschränken
      item Der Knoten des Elements, das Suchkriterien enthält
      property Ein [Gruppeneigenschafts-Schlüsselwort], entweder name oder created
      operator Ein [Suchoperator], einer von :, <, >, <=, >=, " ", - oder *
      searchTerm Ein [Suchbegriff], der aus einem benutzerdefinierten Wort, Satz oder Wert besteht

      Hinweis

      Die Zendesk REST API gibt bis zu 1.000 Ergebnisse pro Abfrage zurück, mit maximal 100 Ergebnissen pro Seite. Wenn Sie eine Anzahl von Seiten über das Limit hinaus anfordern (zum Beispiel, indem Sie eine pageNumber von 11 bei einer maximalen pageSize von 100 Ergebnissen pro Seite angeben), wird ein 422 Fehler aufgrund unzureichender Ressourcen zurückgegeben.

      Wenn Sie große Datensätze abrufen müssen, empfiehlt Zendesk, die Suche in kleinere Teile zu unterteilen, indem die Ergebnisse auf einen bestimmten Datumsbereich beschränkt werden.

    • Antwort:

      Antwort-Schema Feld/Knoten Hinweise
      searchResponse Suchantwort
      records Der Knoten der durch die Suche zurückgegebenen Datensätze
      item Der Knoten des Datensatzes
      deleted Ein Boolean, der angibt, ob die Gruppe als gelöscht markiert ist
      updated_at Der Zeitpunkt der letzten Aktualisierung der Gruppe
      name Der Name der Gruppe
      created_at Der Zeitpunkt, zu dem die Gruppe erstellt wurde
      id Eine Ganzzahl, die während der Gruppenerstellung zugewiesen wird
      url Die API-URL der Gruppe
      nextPage Wenn die Ergebnisse nicht alle auf eine Seite passen, zeigt dieses Feld die URL der nächsten Seite. Der Standardwert ist null
      count Anzahl der Ergebnisse
      prevPage Wenn die Ergebnisse nicht alle auf eine Seite passen, zeigt dieses Feld die URL der vorherigen Seite. Der Standardwert ist null

      Hinweis

      Die count-Eigenschaft zeigt die tatsächliche Anzahl der Ergebnisse an. Wenn es beispielsweise 5.000 Ergebnisse gibt, beträgt der count-Wert 5.000, auch wenn die API nur die ersten 1.000 Ergebnisse zurückgibt.

  • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom Zendesk-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie in einer benachbarten Transformation.

  • Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • Fertig: Klicken Sie, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

  • Änderungen verwerfen: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine Zendesk Suche-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration der Operation, indem Sie andere Aktivitäten oder Werkzeuge als Operation Schritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Operationen zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Entwurfsgrafik zugänglich. Für Details siehe Aktivitätsaktionsmenü in Connector-Grundlagen.

Zendesk Suche-Aktivitäten können als Quelle mit diesen Betriebsmustern verwendet werden:

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Speicherort und verwenden Sie dann diesen temporären Speicherort in der Skriptfunktion.

Wenn Sie bereit sind, setzen Sie die Operation ein und führen Sie sie aus und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.