Square Abfrageaktivität
Einführung
Eine Square Abfrageaktivität ruft Kunden aus einer Square-Verbindung ab und ist dazu gedacht, als Quelle verwendet zu werden, um Daten für eine Operation bereitzustellen. 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:
- Die Entwurfsfläche (siehe Komponentenaktionsmenü in Entwurfsfläche).
- Der Komponenten-Tab im Projektbereich (siehe Komponentenaktionsmenü in Projektbereich Komponenten-Tab).
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
- Schritt 2: Überprüfen Sie die Datenschemas
Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie die Einstellungen
Tipp
Felder mit einem Symbol für Variablen 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 Symbol für Variablen klicken, um ein Menü anzuzeigen, das vorhandene Variablen zur Auswahl auflistet.
-
Name: Geben Sie einen Namen ein, um die Square Query-Aktivität zu identifizieren. Der Name muss für jede Query-Aktivität einzigartig 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 die Schaltfläche Fertig im letzten Schritt klicken.
-
Änderungen verwerfen: Nach Änderungen 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 Transformationszuordnungsprozesses erneut angezeigt, wo Sie Zielfelder mithilfe von Quellobjekten, Skripten, Variablen, benutzerdefinierten Werten und mehr zuordnen können.
Der Square-Connector verwendet die Square REST API. Konsultieren Sie die API-Dokumentation für Informationen zu den Schemafeldern.
-
Antwort:
Antwortschema Feld/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 Schemata vom Endpunkt neu zu generieren. Diese Aktion regeneriert auch das 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: Nach Änderungen klicken Sie auf Änderungen verwerfen, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Eine Nachricht wird Sie auffordern, 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 Registerkarten Workflows oder Komponenten sowie auf der Entwurfsleinwand zugänglich. Siehe Aktivitätsaktionsmenü für Details.
Square Query-Aktivitäten können als Quelle mit diesen Vorgangsmustern verwendet werden:
-
Zwei-Transformationsmuster (als erstes oder zweites Ziel)
Andere Muster sind bei der Verwendung von Square Query-Aktivitäten nicht gültig. Siehe die Validierungsmuster auf der Operation Validität Seite.
Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Ort und verwenden Sie dann diesen temporären Ort in der Skriptfunktion.
Wenn Sie bereit sind, führen Sie die Operation aus und überprüfen Sie das Verhalten, indem Sie die Protokolle der Operation überprüfen.