Zum Inhalt springen

Square-Abfrageaktivität im Jitterbit Studio

Einführung

Eine Square-Abfrageaktivität ruft Kunden aus einer Square-Verbindung ab und ist dazu gedacht, als Quelle für Daten zu dienen, die einer Operation bereitgestellt werden. Nach der Konfiguration einer Square-Verbindung können Sie so viele Square-Aktivitäten konfigurieren, wie Sie möchten, für jede Square-Verbindung.

Erstellen einer Square-Aktivität

Eine Instanz einer Aktivität wird aus einer Verbindung unter Verwendung eines 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 Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer Square-Abfrageaktivität

Befolgen Sie diese Schritte, um eine Square-Abfrageaktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie die Einstellungen

Tipp

Felder mit einem Variablen-Icon unterstützen die Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder, indem Sie eine öffnende eckige Klammer [ in das Feld eingeben, oder indem Sie auf das Variablen-Icon klicken, um ein Menü anzuzeigen, das vorhandene Variablen zur Auswahl auflistet.

  • Endpoint-Menü: 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 Square Query-Aktivität zu identifizieren. Der Name muss für jede Query-Aktivität eindeutig sein und darf keine Schrägstriche (/) oder Doppelpunkte (:) enthalten.

  • Feldsortierung: Geben Sie die zu verwendende Feldsortierung an, entweder DEFAULT oder CREATED_AT.

  • Sortierreihenfolge: Geben Sie die zu verwendende Sortierreihenfolge an, entweder DESC (absteigend) oder ASC (aufsteigend).

  • Anzahl der zurückzugebenden Datensätze: Die maximale Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Ein gültiger Eintrag ist entweder leer oder ein Wert von 0 bis 1000. Lassen Sie das Feld leer (Standard), um alle Datensätze zurückzugeben.

  • Speichern & Beenden: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • 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 auf die Schaltfläche Fertig im letzten Schritt klicken.

  • Änderungen verwerfen: Nachdem Sie Änderungen vorgenommen haben, klicken Sie auf Änderungen verwerfen, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht wird Sie auffordern, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemas

  • Datenschema: Das Antwortdatenschema für Square wird angezeigt. Wenn die Operation eine Transformation verwendet, werden die Datenschemas später während des Transformations-Mapping-Prozesses erneut angezeigt, wo Sie Ziel-Felder mithilfe von Quellobjekten, Skripten, Variablen, benutzerdefinierten Werten und mehr zuordnen können.

    Der Square-Connector verwendet die Square REST API. Weitere Informationen zu den Schemafeldern finden Sie in der API-Dokumentation.

    • Antwort:

      Antwort-Schemafeld/-Knoten Hinweise
      errorMessage Die Fehlermeldung
      customers Knoten der Kunden
      id Kunden-ID
      createdAt Erstellungsdatum
      updatedAt Aktualisierungsdatum
      givenName Der Vorname des Kunden
      familyName Der Nachname des Kunden
      companyName Das Unternehmen des Kunden
      nickname Der Spitzname des Kunden
      emailAddress Die Email-Adresse des Kunden
      phoneNumber Die Telefonnummer des Kunden

  • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom Endpunkt neu zu generieren. Diese Aktion regeneriert auch das Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie z. B. 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 auf Änderungen verwerfen, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht wird Sie bitten, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine Square Query-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 Betriebseinstellungen eines Vorgangs konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuschalten, die sich in denselben oder unterschiedlichen Workflows befinden.

Nachdem eine Square-Aktivität erstellt wurde, sind die Menüaktionen für diese Aktivität im Projektbereich entweder in den Tabs Workflows oder Komponenten sowie auf der Entwurfskanvas zugänglich. Siehe Aktionsmenü der Aktivität für Details.

Square Query-Aktivitäten können als Quelle mit diesen Betriebsmustern verwendet werden:

Andere Muster sind bei der Verwendung von Square Query-Aktivitäten nicht gültig. Siehe die Validierungsmuster auf der Betriebsvalidität Seite.

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, implementieren und führen Sie den Betrieb aus und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.