OData Abfrageaktivität

Einführung

Eine OData -Query-Aktivität unter Verwendung ihrer OData-Verbindung, fragt Objektdaten von einem OData Endpoint ab und ist für die Verwendung als Quelle zum Bereitstellen von Daten in einer Operation vorgesehen.

Erstellen einer OData Abfrageaktivität

Eine Instanz einer OData Query-Aktivität wird aus einer OData-Verbindung erstellt 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 den Aktivitätstyp und fügen Sie ihn auf der Design-Canvas ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitätsinstanz in Komponentenwiederverwendung.

Eine vorhandene OData -Query-Aktivität kann von diesen Orten aus bearbeitet werden:

• Die Design-Canvas (siehe Aktionsmenü „Komponentenaktionen“ in Entwurfsfläche).
• Die Tab Komponenten des Projektbereichs (siehe Aktionsmenü im Projektbereich Tab Komponenten).

Konfigurieren einer OData Abfrageaktivität

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

• Schritt 1: Geben Sie einen Namen ein und legen Sie die Einstellungen fest
  Geben Sie einen Namen für die Aktivität an, geben Sie die Abfrage Objektklasse an und geben Sie alle erforderlichen HTTP-Header an.

• Schritt 2: Unterobjekte auswählen
  Wählen Sie untergeordnete Objektklassen zur Abfrage basierend auf der im vorherigen Schritt ausgewählten Objektklasse aus.

• Schritt 3: Definieren Sie eine Filterzeichenfolge
  Der Abfrage-Generator wird verwendet, um mithilfe der Objektfelder Bedingungen für eine Abfrage festzulegen und eine Paginierung auf eine Abfrage anzuwenden.

• Schritt 4: Überprüfen Sie das Schema
  Alle vom Endpoint generierten Antwortschemata werden angezeigt.

Schritt 1: Namen 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.

• Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede OData Query-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 Liste der Objekte zu filtern. Bei der Suche wird die Groß-/Kleinschreibung nicht beachtet. Wenn in der Tabelle bereits Objekte 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 dann, 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 werden.

  • Objekt auswählen: Klicken Sie in der Tabelle irgendwo auf eine 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 wird, 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 standardmäßige 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 werden, damit er 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 Auf Endpoints zugreifen, 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.

• Speichern und beenden: Wenn 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 an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Untergeordnete Objekte auswählen

Wählen Sie in diesem Schritt die untergeordneten Objektklassen aus, die in die Abfrage einbezogen werden sollen, basierend auf der im vorherigen Schritt ausgewählten Objektklasse. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

• Untergeordnete Objekte auswählen: In diesem Abschnitt werden untergeordnete Objektklassen für die Abfrage 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. Bei der Suche wird die Groß-/Kleinschreibung nicht beachtet. Wenn in der Tabelle bereits Objektklassen angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit gefiltert. Um bei der Suche untergeordnete Objektklassen vom Endpoint neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

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

    • Ein untergeordnetes Objekt hinzufügen: Klicken Sie innerhalb der Spalte irgendwo auf eine Zeile, um eine oder mehrere untergeordnete Objektklassen auszuwählen. Klicken Sie dann auf das Hinzufügen-Symbol, um ausgewählte Klassen zur Spalte Ausgewählte untergeordnete Objekte hinzuzufügen:

      

  • Ausgewählte untergeordnete Objekte: In dieser Spalte werden ausgewählte untergeordnete Objektklassen angezeigt.

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

      

• 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 an einem Schritt vorgenommenen Änderungen zu speichern. In einer Meldung werden Sie aufgefordert zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Definieren Sie eine Filterzeichenfolge

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

Die Filterzeichenfolge kann in den Registerkarten Basis oder Erweitert konfiguriert werden.

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

  

  • Objektfelder: Wählen Sie basierend auf der ausgewählten Objektklasse die in der Abfrage zu verwendenden Felder 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. Bei der Suche wird die Groß-/Kleinschreibung nicht beachtet. Die aufgelisteten Ergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert.

    • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die 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 aufgenommen werden sollen, damit sie automatisch zum Filterstring hinzugefügt werden. Sie können auch alle Felder auf einmal mithilfe des übergeordneten Kontrollkästchens auswählen.

  • Seitengröße: Geben Sie die maximale Anzahl der Ergebnisse ein, die für jede Seite in der Abfrage abgerufen werden sollen. Wenn dieses Feld leer gelassen wird, 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 in der ausgewählten Objektklasse zu Abfrage. Der OData Endpoint steuert, wie die Suche für eine Objektklasse interpretiert wird.

  • Ü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 angezeigt werden.

    • 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
      Ist gleich
      Größer als
      Größer als oder gleich
      Weniger 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 Bedingungsklauseln und der Filterzeichenfolge eine neue Bedingung hinzuzufügen.

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

  • Filterzeichenfolge: Wenn Sie die anderen Felder auf der Tab Einfach ausfüllen, wird die Filterzeichenfolge 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:

  

  • Seitengröße: Geben Sie die maximale Anzahl der Ergebnisse ein, die für jede Seite in der Abfrage abgerufen werden sollen. Wenn dieses Feld leer gelassen wird, 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.

• Abfrage testen: Klicken Sie hier, um die Abfrage zu validieren. Wenn die Abfrage gültig ist, wird eine Auswahl von bis zu 10 Datensätzen, die aus der Abfrage abgerufen wurden, in einer Tabelle angezeigt. Wenn die Abfrage nicht gültig ist, werden entsprechende Fehlermeldungen angezeigt. Wenn Sie die Filterzeichenfolge im Erweiterten Modus bearbeiten, muss die Abfrage gültig sein und über diese Schaltfläche validiert werden, damit die Schaltfläche Weiter aktiviert werden kann.

  

• 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 an einem Schritt vorgenommenen Änderungen zu speichern. In einer Meldung werden Sie aufgefordert zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 4: Überprüfen des Schema

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

• 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ätssatz) darstellt; zum Beispiel der Person Knoten
    _odata.nextLink	String des OData Annotation-Feldes durch eine URL, die zum Abrufen der nächsten Teilmenge an Ergebnissen aus der angeforderten Abfrage verwendet wird
    _odata.count	String des OData Annotation-Feldes mit der Gesamtzahl der von der Abfrage zurückgegebenen Objekte
    _odata.context	String des OData Annotation-Feldes 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 UserName Und Concurrency
    _odata.etag	String des OData Annotation-Feldes mit einem Wert, der in einer nachfolgenden Anfrage verwendet werden kann, um zu bestimmen, 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 verknüpften 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 Dokumentationsseite von OData.

• Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Schemas vom OData Endpoint neu zu generieren. Diese Aktion generiert auch ein Schema 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, 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 hierauf, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine OData -Query-Aktivität konfiguriert haben, schließen Sie die Konfiguration der Operation ab, indem Sie andere Aktivitäten, Transformations oder Scripts als Operation hinzufügen und konfigurieren. Sie können auch die Operation konfigurieren, die die Möglichkeit umfassen, Operationen zu verketten, die sich im gleichen oder in unterschiedlichen Workflows befinden.

Auf Menüaktionen für eine Aktivität kann über den Projektbereich und die Design-Canvas zugegriffen werden. Weitere Informationen finden Sie unter Aktionsmenü in Connector-Grundlagen.

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

• Transformation
• Zwei-Ziel-Archivmuster (nur als erste Quelle)
• HTTP-Archivmuster mit zwei Zielen (nur als erste Quelle)
• Zwei-Transformationsmuster (nur als erste 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, einsetzen und ausführen den Operation und validieren Sie das Verhalten durch Überprüfen der Operation.