Square v2 Abfrageaktivität
Einführung
Eine Square v2 Abfrage-Aktivität, die ihre Square v2-Verbindung verwendet, ruft die angegebenen Objektdaten von Square ab und ist als Quelle gedacht, um Daten in einer Operation bereitzustellen.
Hinweis
Die Abfrage-Aktivität gibt die Objektdaten zurück, die in ihrem Anforderungsschema angegeben sind. Um alle Daten des ausgewählten Objekts abzurufen, verwenden Sie die Leseaktivität.
Erstellen einer Square v2 Abfrageaktivität
Eine Instanz einer Square v2 Abfrage-Aktivität wird aus einer Square v2-Verbindung unter Verwendung des Aktivitätstyps Abfrage 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 Einzelheiten finden Sie unter Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.
Eine vorhandene Square v2 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 Square v2 Abfrageaktivität
Befolgen Sie diese Schritte, um eine Square v2 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: Wählen Sie ein Unterobjekt aus
Wählen Sie ein Unterobjekt aus. -
Schritt 3: Überprüfen der Datenschemas
Alle Anfrage- oder Antwortschemas werden angezeigt.
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.
-
Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Square v2 Abfrage-Aktivität einzigartig sein und darf keine Schrägstriche
/
oder Doppelpunkte:
enthalten. -
Wählen Sie ein Objekt aus: In diesem Abschnitt werden die in der Square v2-Schnittstelle verfügbaren Objekte angezeigt.
-
Ausgewähltes Objekt: Nachdem ein Objekt ausgewählt wurde, wird es hier aufgelistet.
-
Suche: Geben Sie den Wert einer beliebigen 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 von der Schnittstelle 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 von der Square v2-Schnittstelle neu zu laden. Dies kann nützlich sein, wenn Objekte zu Square v2 hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Objekttabelle verwendet werden.
-
Auswählen eines Objekts: 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 für jedes Objekt verfügbaren Informationen werden von der Square v2-Schnittstelle abgerufen:
-
Name: Der Name des Objekts.
-
Beschreibung: Die Beschreibung des Objekts.
-
Tipp
Wenn die Tabelle nicht mit verfügbaren Objekten gefüllt wird, könnte die Square v2-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.
-
-
Limit: Geben Sie die maximale Anzahl von Ergebnissen pro Seite an. Der Mindestwert beträgt
1
und der Höchstwert1000
. Wenn dieses Feld leer gelassen wird, beträgt die maximale Anzahl von Ergebnissen pro Seite100
. -
Continue on Error: Wählen Sie diese Option, um die Ausführung der Aktivität fortzusetzen, wenn ein Fehler für einen Datensatz in einer Batch-Anfrage auftritt. Wenn Fehler auftreten, werden diese im Betriebsprotokoll aufgezeichnet.
-
Save & Exit: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.
-
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 vorgenommenen Änderungen zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.
Step 2: Select a sub-object
In diesem Schritt wählen Sie ein Unterobjekt aus. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.
-
Select a Sub-object: In diesem Abschnitt werden die im Square v2-Endpunkt verfügbaren Unterobjekte angezeigt.
-
Selected Object: Das im vorherigen Schritt ausgewählte Objekt wird hier aufgelistet.
-
Select a Sub-object: Nachdem ein Unterobjekt ausgewählt wurde, wird es hier aufgelistet.
-
Search: Geben Sie den Wert einer Spalte in das Suchfeld ein, um die Liste der Unterobjekte zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Unterobjekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Unterobjekte vom Endpunkt beim Suchen neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.
-
Refresh: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Unterobjekte vom Square v2-Endpunkt neu zu laden. Dies kann nützlich sein, wenn Unterobjekte zu Square v2 hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der Tabelle der in der Konfiguration angezeigten Unterobjekte verwendet werden.
-
Selecting a Sub-object: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um ein Unterobjekt auszuwählen. Es kann nur ein Unterobjekt ausgewählt werden. Die für jedes Unterobjekt verfügbaren Informationen werden vom Square v2-Endpunkt abgerufen:
-
Name: Der Name des Unterobjekts.
-
Description: Die Beschreibung des Unterobjekts
-
Tipp
Wenn die Tabelle nicht mit verfügbaren Unterobjekten gefüllt wird, könnte die Square v2-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.
-
-
Back: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.
-
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 auf die Schaltfläche Fertig im letzten Schritt klicken.
-
Discard Changes: Nach Ä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.
Step 3: Überprüfen der Datenschemata
Alle Anfrage- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.
-
Data Schemas: Diese Datenschemata werden von benachbarten Transformationen übernommen und während der Transformationszuordnung erneut angezeigt.
Der Square v2-Connector verwendet die Square API. Weitere Informationen zu den Schema-Knoten und -Feldern finden Sie in der API-Dokumentation des Objekts:
Hinweis
Das Feld
records
, das im Antwortschema vorhanden ist, fungiert als Zähler, wenn Sie mehr als eine Anfrage mit der Abfrage-Aktivität stellen. -
Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom Square v2-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, wo dasselbe Schema referenziert wird, wie 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: 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 wirklich verwerfen möchten.
Nächste Schritte
Nachdem Sie eine Square v2 Abfrage-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 zusammenzuschalten, die sich in denselben oder unterschiedlichen Workflows befinden.
Menüaktionen für eine Aktivität sind über das Projektfenster und die Entwurfskanvas zugänglich. Für Details siehe Aktivitätsaktionsmenü in Connector-Grundlagen.
Square v2 Abfrage-Aktivitäten können als Quelle mit diesen Betriebsmustern 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, deployen und ausführen Sie die Operation und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.