Zum Inhalt springen

OData Update-Aktivität in Jitterbit Studio

Einführung

Eine OData Update-Aktivität, die ihre OData-Verbindung verwendet, aktualisiert Objektdaten in einem OData-Endpunkt und ist dafür gedacht, als Ziel verwendet zu werden, um Daten in einem Vorgang zu konsumieren.

Erstellen einer OData Update-Aktivität

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

Konfigurieren einer OData Update-Aktivität

Befolgen Sie diese Schritte, um eine OData Update-Aktivität zu konfigurieren:

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 den Typ des zu aktualisierenden Objekts aus. Geben Sie alle erforderlichen HTTP-Header an und ob die Aktivität im Fehlerfall fortgesetzt werden soll. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

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 Connector-Typs 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 Aktivität zu identifizieren. Der Name muss für jede OData Update-Aktivität eindeutig sein und darf keine Schrägstriche (/) oder Doppelpunkte (:) enthalten.

  • Objekt auswählen: Dieser Abschnitt zeigt die Objektklassen an, die im OData-Endpunkt verfügbar sind.

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

    • Suche: Geben Sie den Wert einer 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 aus dem Endpunkt beim Suchen neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Klicken Sie auf das Aktualisieren-Icon oder das Wort Aktualisieren, um die Objektklassen vom OData-Endpunkt 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 innerhalb der Tabelle auf eine Zeile, um eine Objektklasse auszuwählen. Es kann nur eine Objektklasse ausgewählt werden. Die Informationen, die für jedes Objekt verfügbar sind, werden vom OData-Endpunkt abgerufen:

      • Name: Der Name der Objektklasse vom OData-Endpunkt.

      • Beschreibung: Die Beschreibung der Objektklasse vom OData-Endpunkt.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Objektklassen gefüllt wird, könnte die OData-Verbindung nicht erfolgreich sein. 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 das Update. Das OData-Protokoll akzeptiert standardmäßige HTTP-Header, die in Rfc 2616 (Abschnitt 14) definiert sind, sowie benutzerdefinierte Header, die spezifisch für den Endpunkt sind. Klicken Sie auf das Hinzufügen-Symbol , um einen Header zur Tabelle unten hinzuzufügen, und geben Sie ein Schlüssel-Wert-Paar für jeden Anforderungsparameter ein.

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

    Um eine einzelne Zeile zu bearbeiten oder zu löschen, fahren Sie mit der Maus über die rechte Spalte und verwenden Sie das Bearbeiten-Symbol oder das Löschen-Symbol .

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

    Hinweis

    Benutzerdefinierte Header müssen im Endpunkt konfiguriert werden, damit dieser sie als Teil dieser Anfrage akzeptiert. Wenn Sie Microsoft Azure verwenden, um Ihren OData-Endpunkt zu verwalten, lesen Sie die Microsoft-Dokumentation zu Benutzerdefinierten Headern in Zugriff auf Endpunkte, die Authentifizierung erfordern.

    Wichtig

    Felder in der Tabelle Erweiterte HTTP-Eigenschaften zeigen das Variablen-Symbol nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit befüllt werden, muss die Agenten-Version mindestens 10.75 / 11.13 sein.

    Felder in der Erweiterten HTTP-Eigenschaften-Tabelle unterstützen nicht die Verwendung von Variablen, um rohes JSON zu übergeben. Wenn Ihr Anwendungsfall nicht unterstützt, rohes JSON direkt in den Feldern zu definieren, entkommen Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Zum Beispiel wird {"success": "true"}; zu {\"success\": \"true\"};.

  • Fortfahren bei Fehlern: 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. Diese Option ist standardmäßig ausgewählt.

  • Optionale Einstellungen: Klicken Sie, um zusätzliche optionale Einstellungen zu erweitern.

    • Anforderungsheader: Ein zusätzlicher Ort für HTTP-Header. Header, die in der Erweiterten HTTP-Eigenschaften-Tabelle definiert sind, haben Vorrang.

  • 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: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemas

Die von der Endpunkt generierten Anforderungs- und Antwortschemas werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Datenschemas: Diese Datenschemas werden von benachbarten Transformationen geerbt und während der Transformationszuordnung erneut angezeigt.

    Hinweis

    Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

    • Anforderung:

      Anforderungs-Schema-Feld/Knoten Beschreibung
      updaterequest Anfrage zum Aktualisieren eines Objekts (Entität)
      request Knoten, der die Aktualisierungsanfrage darstellt
      item Knoten, der die Anforderungsartikel darstellt
      Objektliste Knoten, der die Zielobjektliste (Entitätensatz) darstellt, um ein Objekt zu aktualisieren; zum Beispiel der Airline-Knoten
      Objektfelder ... Felder, die spezifisch für die Objektklasse (Entitätstyp) der Objekte in der Objektliste sind; zum Beispiel die Felder AirlineCode und Name
      bind Knoten, der OData-Entitätsnavigationseigenschaftsbindungen darstellt, die hinzugefügt oder aktualisiert werden sollen
      item Knoten, der eine Navigationseigenschaft darstellt, die im Format "key@odata.bind": "value" an das Objekt gebunden werden soll
      value Zeichenfolge der Objektreferenz für die Navigationseigenschaft; zum Beispiel People('russellwhyte')
      key Zeichenfolge des Namens der Navigationseigenschaft, die hinzugefügt oder aktualisiert werden soll; zum Beispiel LocationManager
      key Knoten, der den Schlüssel des Objekts darstellt, das aktualisiert werden soll
      Entitätsschlüssel Zeichenfolge des Schlüssels, der das zu aktualisierende Objekt identifiziert; zum Beispiel das Feld AirlineCode im key-Knoten

    • Antwort:

      Antwort-Schema Feld/Knoten Beschreibung
      updateresponse Antwort auf die Aktualisierung eines Objekts (Entität)
      response Knoten, der die Aktualisierungsantwort darstellt
      item Knoten, der die Antwortelemente darstellt
      entity Knoten, der die Informationen des aktualisierten Objekts darstellt
      statusCode Ganzzahlcode, der mit der Antwort verbunden ist
      isUpdated Zeichenfolge, die angibt, ob die Aktualisierung erfolgreich war
      message Zeichenfolge der mit der Antwort verbundenen Nachricht
      errorDetails Knoten, der die Fehlermeldungen von der Aktualisierung darstellt
      errorMsg Zeichenfolge der mit dem Fehler verbundenen Nachricht

    Der OData-Connector verwendet die Apache Olingo OData Java-Bibliothek. Weitere Informationen zur Unterstützung des OData-Protokolls finden Sie in der Dokumentation der Bibliothek. Allgemeine Informationen zum OData-Protokoll sind ebenfalls auf OData's Dokumentationsseite verfügbar.

  • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Schemas vom OData-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie z. B. 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 fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine OData Update-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 zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Entwurfsgrafik zugänglich. Für Details siehe Aktivitätsaktionsmenü in Connector-Grundlagen.

OData Update-Aktivitäten können als Ziel mit diesen Betriebsmustern verwendet werden:

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, bereitstellen und ausführen Sie die Operation und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.