Zendesk Abfrageaktivität in Jitterbit Studio
Einführung
Eine Zendesk Abfrage-Aktivität, die ihre Zendesk-Verbindung nutzt, ruft Objektdaten von Zendesk ab und ist als Quelle gedacht, um Daten in einer Operation bereitzustellen.
Vorsicht
Die Abfrage-Aktivität ist veraltet. Wir empfehlen stattdessen die Verwendung der Suchaktivität.
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 Abfrageaktivität
Eine Instanz einer Zendesk Abfrage-Aktivität wird aus einer Zendesk-Verbindung unter Verwendung ihres Abfrage-Aktivitätstyps 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. Für Details siehe Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.
Eine vorhandene Zendesk Abfrage-Aktivität kann von diesen Orten aus bearbeitet werden:
- Die Entwurfsfläche (siehe Komponentenaktionsmenü in Entwurfsfläche).
- Der Komponenten-Tab im Projektbereich (siehe Komponentenaktionsmenü in Projektbereich Komponenten-Tab).
Konfigurieren einer Zendesk Abfrageaktivität
Befolgen Sie diese Schritte, um eine Zendesk Abfrage-Aktivität zu konfigurieren:
-
Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Objekt aus
Geben Sie einen Namen für die Aktivität ein und wählen Sie ein Objekt aus. -
Schritt 2: Überprüfen Sie die Datenschemas
Alle Anforderungs- oder Antwortschemas werden angezeigt.
Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Objekt
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.
-
Endpoint-Menü: Wenn Sie mehrere Endpunkte desselben 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 Verbindungsconfiguration 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 Abfrage-Aktivität eindeutig sein und darf keine Schrägstriche
/oder Doppelpunkte:enthalten. -
Wählen Sie ein Objekt aus: Dieser Abschnitt zeigt die in dem Zendesk-Endpunkt verfügbaren Objekte an.
-
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 Zeile, um ein Objekt auszuwählen. Es kann nur ein Objekt ausgewählt werden. Die Informationen zu jedem Objekt werden von dem Zendesk-Endpunkt abgerufen:
-
Name: Der Name des Zendesk-Objekts.
-
Beschreibung: Die Beschreibung des Zendesk-Objekts.
-
Hinweis
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 testen.
-
-
Maximale Anzahl von Seiten: Geben Sie die maximale Anzahl von Seiten an, die zurückgegeben werden sollen. Jede Seite gibt 100 Datensätze zurück. Standardmäßig wird, wenn kein Wert angegeben ist, eine Seite zurückgegeben.
-
Weiter: 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.
-
Ä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 fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.
Schritt 2: Überprüfen der Datenschemas
Alle Anforderungs- oder Antwortschemas werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.
-
Datenschemas: Die Anforderungs- und Antwortdatenschemas für Zendesk werden angezeigt. Wenn die Operation eine Transformation verwendet, werden die Datenschemas 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 Schemafeldern unterstützter Objekte.
Die Anforderungs- und Antwortdatenschemas bestehen aus diesen Knoten und Feldern:
-
Anforderung:
Anfrage-Schema Feld/Knoten Hinweise queryRequest Abfrageanfrage item Die Gruppenobjekte property Ein [Gruppeneigenschafts-Schlüsselwort], entweder nameodercreatedoperator Ein [Suchoperator], einer von :,<,>,<=,>=," ",-oder*searchTerm Ein [Suchbegriff], der aus einem benutzerdefinierten Wort, Satz oder Wert besteht -
Antwort:
Antwort-Schema Feld/Knoten Hinweise queryResponse Abfrageantwort item Die Gruppenobjekte im [JSON-Format] 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
-
-
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 z. B. in einer angrenzenden 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: Nach dem Vornehmen von Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.
Nächste Schritte
Nachdem Sie eine Zendesk Abfrage-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Werkzeuge als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Vorgangseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge 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 Abfrage-Aktivitäten können als Quelle mit diesen Vorgangsmustern verwendet werden:
- Transformationsmuster
- Zwei-Ziel-Archivmuster (nur als erste Quelle)
- Zwei-Ziel-HTTP-Archivmuster (nur als erste Quelle)
- Zwei-Transformationsmuster (als erste oder zweite Quelle)
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, bereitstellen und ausführen Sie den Vorgang und validieren Sie das Verhalten, indem Sie die Vorgangsprotokolle überprüfen.