Zum Inhalt springen

Verwandeln Sie Ihre Kontakte in Urlaubsgeld mit unserem neuen Kundenempfehlungsprogramm! Erfahren Sie mehr

✕

OData-Abfrageaktivität

Einführung

Eine OData -Query-Aktivität, die ihre OData-Verbindung verwendet, fragt Objektdaten von einem OData Endpoint ab und soll als Quelle zum Bereitstellen von Daten in einer Operation verwendet werden.

Erstellen einer OData Abfrageaktivität

Eine Instanz einer OData Query-Aktivität wird aus einer OData-Verbindung mithilfe des Aktivitätstyps Abfrage.

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

Eine vorhandene OData Abfrage-Aktivität kann an diesen Stellen bearbeitet werden:

Konfigurieren einer OData-Abfrageaktivität

Führen Sie die folgenden Schritte aus, um eine OData -Abfrage-Aktivität zu konfigurieren:

Schritt 1: Name eingeben und Einstellungen festlegen

Geben Sie in diesem Schritt einen Namen für die Aktivität an und geben Sie die Abfrage Objektklasse sowie alle erforderlichen HTTP-Header an. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

OData-Abfrageaktivität - Konfigurationsschritt 1

Tipp

Felder mit einem variablen Symbol Unterstützung bei der Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder mit einer öffnenden eckigen Klammer [ in das Feld oder klicken Sie auf das Variablensymbol, um eine Liste der vorhandenen Variablen anzuzeigen, aus denen Sie auswählen können.

  • Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede OData -Abfrage-Aktivität eindeutig sein und darf keine Schrägstriche enthalten (/) oder Doppelpunkte (:).

  • Objekt auswählen: Dieser Abschnitt zeigt die im OData Endpoint verfügbaren Objektklassen an.

    • Ausgewähltes Objekt: Nachdem eine Objektklasse ausgewählt wurde, wird sie hier aufgelistet.

    • Suchen: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Objektliste zu filtern. Die Suche berücksichtigt keine Groß- und Kleinschreibung. Wenn bereits Objekte in der Tabelle angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit gefiltert. Um Objekte während der Suche vom Endpoint neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie anschließend die Tabelle, wie unten beschrieben.

    • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Objektklassen vom OData Endpoint neu zu laden. Dies kann nützlich sein, wenn das Schema des OData Endpunkts aktualisiert wurde, um neue Objekttypen zu unterstützen. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Objekttabelle verwendet wurden.

    • Objekt auswählen: Klicken Sie in der Tabelle auf eine beliebige Zeile, um eine Objektklasse auszuwählen. Es kann nur eine Objektklasse ausgewählt werden. Die für jedes Objekt verfügbaren Informationen werden vom OData Endpoint abgerufen:

      • Name: Der Objektklassenname vom OData Endpoint.

      • Beschreibung: Die Objektklassenbeschreibung vom OData Endpoint.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Objektklassen gefüllt ist, wird die OData Verbindung ist möglicherweise nicht erfolgreich. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

  • Erweiterte HTTP-Eigenschaften: Definieren Sie HTTP-Header für die Abfrage. Das OData Protokoll akzeptiert Standard-HTTP-Header, die in Rfc 2616 definiert sind (Absatz 14) sowie alle benutzerdefinierten Header, die für den Endpoint spezifisch sind. Klicken Sie auf das Symbol „Hinzufügen“ um der folgenden Tabelle eine Header hinzuzufügen und für jeden Anforderungsparameter ein Key-Value Paar einzugeben.

    Um die Zeile zu speichern, klicken Sie auf das Senden-Symbol in der Spalte ganz rechts.

    Um eine einzelne Zeile zu bearbeiten oder zu löschen, bewegen Sie den Mauszeiger über die Spalte ganz rechts und verwenden Sie das Bearbeitungssymbol. oder Symbol „Löschen“ .

    Um alle Zeilen zu löschen, klicken Sie auf Alle löschen.

    Notiz

    Benutzerdefinierte Header müssen im Endpoint konfiguriert sein, damit dieser sie als Teil dieser Anfrage akzeptiert. Wenn Sie Microsoft Azure zur Verwaltung Ihres OData Endpoint verwenden, lesen Sie die Microsoft-Dokumentation zu Benutzerdefinierten Headern in Zugriff auf Endpoints, die eine Authentifizierung erfordern.

    Wichtig

    Felder in der Tabelle Erweiterte HTTP-Eigenschaften zeigen das Variablensymbol nur im Bearbeitungsmodus. Damit die Variablenwerte dieser Felder zur Laufzeit ausgefüllt werden, muss die Agentenversion mindestens 10.75 / 11.13 sein..

    Felder in der Tabelle Erweiterte HTTP-Eigenschaften unterstützen die Verwendung von Variablen zur Übergabe von Roh-JSON nicht. Wenn Ihr Anwendungsfall die direkte Definition von Roh-JSON in den Feldern nicht unterstützt, maskieren Sie den JSON-Inhalt, bevor Sie ihn mit einer Variable übergeben. Beispiel: {"success": "true"};wird {\"success\": \"true\"};.

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 2: Unterobjekte auswählen

Wählen Sie in diesem Schritt die untergeordneten Objektklassen aus, die in die Abfrage einbezogen werden sollen. Die einzelnen Benutzeroberflächenelemente dieses Schritts werden unten beschrieben.

OData-Abfrageaktivitätskonfiguration Schritt 2

  • Untergeordnete Objekte auswählen: In diesem Abschnitt werden die Abfrage untergeordneten Objektklassen ausgewählt. Dieser Abschnitt ist optional und kann durch Auswahl von Weiter übersprungen werden.

    • Verfügbare untergeordnete Objekte: In dieser Spalte werden untergeordnete Objektklassen zur Auswahl angezeigt.

      • Suchen: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Liste der untergeordneten Objektklassen zu filtern. Die Suche berücksichtigt keine Groß- und Kleinschreibung. Wenn in der Tabelle bereits Objektklassen angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit gefiltert. Um untergeordnete Objektklassen während der Suche vom Endpoint neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie anschließend die Tabelle, wie unten beschrieben.

      • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol Aktualisierungssymbol, um untergeordnete Objektklassen vom OData Endpoint neu zu laden. Dies kann nützlich sein, wenn Sie dem OData Endpoint kürzlich untergeordnete Objektklassen hinzugefügt haben.

      • Hinzufügen eines untergeordneten Objekts: Klicken Sie innerhalb der Spalte auf eine beliebige Stelle in einer Zeile, um eine oder mehrere untergeordnete Objektklassen auszuwählen. Klicken Sie anschließend auf das Symbol „Hinzufügen“ , um ausgewählte Klassen zur Spalte „Ausgewählte untergeordnete Objekte“ hinzuzufügen.

    • Ausgewählte untergeordnete Objekte: Diese Spalte zeigt ausgewählte untergeordnete Objektklassen an.

      • Entfernen eines untergeordneten Objekts: Klicken Sie innerhalb der Spalte auf eine beliebige Zeile, um eine oder mehrere untergeordnete Objektklassen auszuwählen. Klicken Sie anschließend auf das Symbol „Entfernen“ , um ausgewählte Klassen in die Spalte Verfügbare untergeordnete Objekte zurückzugeben.

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 3: Definieren einer Filterzeichenfolge

In diesem Schritt wird die Filterzeichenfolge einer Abfrage anhand verfügbarer Objektfelder und Abfrage definiert. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

Tipp

Felder mit einem variablen Symbol Unterstützung bei der Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder mit einer öffnenden eckigen Klammer [ Geben Sie die Variable in das Feld ein oder klicken Sie auf das Variablensymbol, um eine Liste der verfügbaren Variablen anzuzeigen.

Der Filterstring kann in den Registerkarten Basis oder Erweitert konfiguriert werden.

Notiz

Änderungen, die auf einer Tab vorgenommen werden, werden nicht auf der anderen Registerkarte angezeigt. Die Abfrage für den Modus, der beim Schließen des Connectors ausgewählt ist, ist die Abfrage, die für den Connector verwendet wird.

  • Basic: Ermöglicht Ihnen, die Filterzeichenfolge mit geführten Feldern zu erstellen:

    OData Abfrageaktivitätskonfiguration, Schritt 3

    • Objektfelder: Wählen Sie die in der Abfrage zu verwendenden Felder basierend auf der ausgewählten Objektklasse aus.

      • Suchen: Geben Sie einen beliebigen Teil eines Feldnamens in das Suchfeld ein, um die Liste der Felder für das ausgewählte Objekt zu filtern. Die Suche berücksichtigt keine Groß- und Kleinschreibung. Die Ergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert.

      • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Felder des Objekts vom OData Endpoint neu zu laden.

      • Alles in der Objektklasse auswählen: Wenn Sie das Suchfeld zum Filtern verwenden, können Sie mit diesem Kontrollkästchen alle sichtbaren Felder auf einmal auswählen.

      • Felder auswählen: Aktivieren Sie die Kontrollkästchen der Felder, die in die Abfrage einbezogen werden sollen, um sie automatisch zum Filterstring hinzuzufügen. Sie können auch alle Felder gleichzeitig über das übergeordnete Kontrollkästchen auswählen.

    • Seitengröße: Geben Sie die maximale Anzahl der Ergebnisse ein, die für jede Seite in der Abfrage abgerufen werden sollen. Wenn Sie dieses Feld leer lassen, enthält jede Seite 100 Ergebnisse.

      Notiz

      Wenn eine clientseitige Paginierung erforderlich ist, verwenden Sie die Felder Überspringen und Oben.

    • Anzahl einschließen: Wählen Sie diese Option aus, um die Anzahl der Ergebnisse einer Abfrage als Teil der Antwort einzuschließen. Wenn eine Abfrage beispielsweise insgesamt 5 Ergebnisse zurückgibt, enthält die Antwort auch "_odata.count": 5.

    • Volltextsuche: Geben Sie Suchbegriffe ein, um nach Objekten der ausgewählten Objektklasse zu Abfrage. Der OData Endpoint steuert die Interpretation der Suche für eine Objektklasse.

    • Überspringen: Geben Sie die Anzahl der Ergebnisse ein, die in der Abfrage übersprungen werden sollen. Wird für die clientseitige Paginierung verwendet.

    • Oben: Geben Sie die maximale Anzahl der Ergebnisse ein, die in der Abfrage empfangen werden sollen. Wird für die clientseitige Paginierung verwendet.

    • Bedingte Klauseln: Um Bedingungen hinzuzufügen, verwenden Sie diese Felder als Eingabe, um die Klauseln zu konstruieren, die dann in der Filterzeichenfolge erscheinen.

      • Objekt: Verwenden Sie das Dropdown-Menü, um die für die Bedingung zu verwendende Objektklasse auszuwählen.

      • Feld: Verwenden Sie die Dropdown-Liste, um das Feld aus der Objektklasse auszuwählen, das für die Bedingung verwendet werden soll.

      • Operator: Verwenden Sie die Dropdown-Liste, um einen geeigneten Operator auszuwählen:

        Vergleich
        Gleich
        Größer als
        Größer als oder gleich
        Kleiner als
        Kleiner als oder gleich

      • Wert: Geben Sie den gewünschten Wert ein, um ihn mit den vorherigen Dropdown-Auswahlen zu vergleichen.

      • Entfernen: Klicken Sie hier, um die Bedingung zu entfernen.

      • Hinzufügen: Klicken Sie hier, um der Tabelle Bedingte Klauseln und der Filterzeichenfolge eine neue Bedingung hinzuzufügen.

      • Alle entfernen: Klicken Sie hier, um alle Bedingungen aus der Tabelle Bedingte Klauseln und der Filterzeichenfolge zu entfernen.

    • Filterzeichenfolge: Wenn Sie die anderen Felder auf der Tab Grundlegend ausfüllen, wird die Filterzeichenfolgenanweisung in diesem Textfeld automatisch mit den ausgewählten Feldern, Bedingungen und Abfrage gefüllt.

  • Erweitert: Blendet die geführten Felder aus und ermöglicht Ihnen, die Filterzeichenfolge direkt zu ändern:

    OData Abfrageaktivitätskonfiguration, Schritt 3b

    • Seitengröße: Geben Sie die maximale Anzahl der Ergebnisse ein, die für jede Seite in der Abfrage abgerufen werden sollen. Wenn Sie dieses Feld leer lassen, enthält jede Seite 100 Ergebnisse.

      Hinweis

      Wenn eine clientseitige Paginierung erforderlich ist, verwenden Sie die $skip Und $top Abfrage im Feld Filterzeichenfolge.

    • Filterzeichenfolge: Bearbeiten Sie die Filterzeichenfolgenanweisung direkt.

  • Testabfrage: Klicken Sie hier, um die Abfrage zu validieren. Bei gültiger Abfrage wird eine Auswahl von bis zu zehn Abfrage in einer Tabelle angezeigt. Ist die Abfrage ungültig, werden entsprechende Fehlermeldungen angezeigt. Wenn Sie den Filter im Erweiterten Modus bearbeiten, muss die Abfrage gültig sein und über diese Schaltfläche validiert werden, um die Schaltfläche Weiter zu aktivieren.

    OData Abfrageaktivitätskonfiguration, Schritt 3c

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hierauf, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 4: Überprüfen des Schema

Das vom Endpoint generierte Schema wird angezeigt. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

OData-Abfrageaktivitätskonfiguration, Schritt 4

  • Datenschema: Dieses Schema wird von benachbarten Transformations übernommen und beim Transformation erneut angezeigt.

    Notiz

    Die in einer Transformation bereitgestellten Daten haben Vorrang vor der Aktivitätskonfiguration.

    • Antwort:

      Antwortschemafeld/-knoten Beschreibung
      queryresponse Antwort von abfragenden Objekten (Entitäten)
      response Knoten, der die Abfrage darstellt
      item Knoten, der die Antwortelemente darstellt
      Objektliste Knoten, der die abgefragte Objektliste (Entitätenmenge) darstellt; zum Beispiel die Person Knoten
      _odata.nextLink String des OData-Annotationsfeldes mit einer URL, die zum Abrufen der nächsten Teilmenge der Ergebnisse aus der angeforderten Abfrage verwendet wird
      _odata.count String des OData-Annotationsfeldes mit der Gesamtzahl der von der Abfrage zurückgegebenen Objekte
      _odata.context String des OData-Annotationsfeldes durch eine URL, die den Speicherort der abgefragten Objektliste enthält
      value Knoten, der die Liste der übereinstimmenden Objekte aus der Abfrage darstellt
      item Knoten, der ein passendes Objekt aus der Abfrage darstellt
      Objektfelder ... Felder, die für die Objektklasse (Entitätstyp) von Objekten in der Objektliste spezifisch sind; zum Beispiel Felder in der item Knoten, wie zum Beispiel UserName Und Concurrency
      _odata.etag String des OData-Annotationsfeldes mit einem Wert, der in einer nachfolgenden Anfrage verwendet werden kann, um festzustellen, ob sich der Wert des Objekts geändert hat
      error Knoten, der Fehlerdetails aus der Abfrage darstellt
      code Zeichenfolge des mit dem Fehler verbundenen Codes
      message Zeichenfolge der mit dem Fehler verbundenen Nachricht

    Der OData Konnektor verwendet die Apache Olingo OData 4.0 Java-Bibliothek. Weitere Informationen zur Unterstützung des OData Protokolls finden Sie in der Bibliotheksdokumentation. Allgemeine Informationen zum OData Protokoll finden Sie auch auf der OData-Dokumentationsseite.

  • Aktualisieren Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Schemas vom OData Endpoint neu zu generieren. Diese Aktion generiert ein Schema auch an anderen Stellen im gesamten Projekt neu, an denen auf dasselbe Schema verwiesen wird, z. B. in einer angrenzenden Transformation.

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

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

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen auf, um die Konfiguration zu schließen, ohne die Änderungen in einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Nächste Schritte

Nachdem Sie eine OData Abfrage-Aktivität konfiguriert haben, schließen Sie die Konfiguration der Operation ab, indem Sie andere Aktivitäten oder Tools hinzufügen und konfigurieren als Operation. Sie können auch die Operation konfigurieren, darunter die Möglichkeit, Vorgänge im selben oder in verschiedenen Workflows miteinander zu verketten.

Menüaktionen für eine Aktivität sind über den Projektbereich und die Design-Canvas zugänglich. Weitere Informationen finden Sie unter Aktionsmenü“ in Connector-Grundlagen.

OData Query-Aktivitäten können als Quelle mit diesen Operation verwendet werden:

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

Wenn Sie bereit sind, einsetzen und ausführen den Operation und validieren Sie das Verhalten, indem Sie die Operation.

Notiz

Die OData -Abfrage-Aktivität kann je nach Schema des Endpunkts eine Warnung bezüglich eines zusätzlichen Unterelements zurückgeben. Dies liegt daran, dass einige OData Felder nicht in den Metadaten des Endpunkts enthalten sind. Die Ausführung der Aktivität wird dadurch jedoch nicht beeinträchtigt.