Zum Inhalt springen

HTTP Custom-Aktivität in Jitterbit Studio

Einführung

Eine HTTP Custom-Aktivität führt mit ihrer HTTP-Verbindung eine angegebene HTTP-Methode auf einen über HTTP oder HTTPS erreichbaren Service aus und kann als Quelle oder Ziel in einem Vorgang verwendet werden.

Wichtig

Mit der Veröffentlichung des HTTP v2-Connectors empfehlen wir, bestehende HTTP-Verbindungen und -Aktivitäten auf HTTP v2 zu konvertieren. Weitere Informationen zu den Vorteilen des HTTP v2-Connectors finden Sie in unserem HTTP v2-Blogbeitrag oder lesen Sie einen Vergleich der Funktionen des HTTP- und HTTP v2-Connectors.

Jitterbit beabsichtigt langfristig, den HTTP-Connector einzustellen, was gemäß Jitterbits End-of-Life-Richtlinie angekündigt wird. Derzeit gibt es keinen Zeitplan für die Einstellung und der HTTP-Connector wird weiterhin vollständig unterstützt. Wir empfehlen, bestehende HTTP-Verbindungen und -Aktivitäten nach Möglichkeit auf HTTP v2 zu konvertieren.

HTTP Custom-Aktivität erstellen

Eine Instanz einer HTTP Custom-Aktivität wird aus einer HTTP-Verbindung mit ihrem Custom-Aktivitätstyp erstellt.

Um eine Aktivitätsinstanz 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 Aktivitätsinstanz erstellen in Komponentenwiederverwendung.

Eine bestehende HTTP Custom-Aktivität kann von diesen Orten aus bearbeitet werden:

HTTP Custom-Aktivität konfigurieren

Führen Sie diese Schritte aus, um eine HTTP Custom-Aktivität zu konfigurieren:

Schritt 1: Namen eingeben und Einstellungen festlegen

Geben Sie einen Namen für die Aktivität an und legen Sie das Verb, die URL, Anfrageparameter und Anfrage-Header fest. Jedes Benutzeroberflächenelement dieses Schritts wird nachfolgend beschrieben.

Tipp

Felder mit einem Variablensymbol unterstützen die Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder mit der Eingabe einer öffnenden eckigen Klammer [ in das Feld oder klicken Sie auf das Variablensymbol, um ein Menü mit vorhandenen Variablen anzuzeigen, aus denen Sie auswählen können.

Wichtig

Felder in den Tabellen zeigen das Variablensymbol nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit gefüllt werden, muss die Agent-Version mindestens 10.75 / 11.13 sein.

  • Endpoint-Menü: Wenn mehrere Endpoints desselben Connector-Typs konfiguriert sind, zeigt ein Menü oben auf dem Bildschirm den Namen des aktuellen Endpoints an. Klicken Sie auf das Menü, um zu einem anderen Endpoint zu wechseln. Weitere Informationen finden Sie unter Zugewiesenen Endpoint ändern in Konfigurationsbildschirme.

    • Endpoint bearbeiten: Wird angezeigt, wenn Sie den Mauszeiger über den Namen des aktuellen Endpoints bewegen. Klicken Sie, um die Verbindungskonfiguration des aktuell ausgewählten Endpoints zu bearbeiten.

  • Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede HTTP-Aktivität vom Typ Custom eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • Custom Verb: Geben Sie das benutzerdefinierte Verb (z. B. PATCH) in das Textfeld ein.

  • Path: Geben Sie einen Pfad und/oder Abfrageparameter ein, die an die Basis-URL angehängt werden sollen, die in der Konfiguration der HTTP-Verbindung angegeben wurde. Wenn Sie Abfrageparameter angeben, geben Sie diese wie in einem Webbrowser an, z. B. /queryrecord?id=10.

  • URL: Die URL, die als Verkettung der Basis-URL und des oben eingegebenen Pfads erstellt wird, wird als Referenz bereitgestellt. Um die URL zu bearbeiten, nehmen Sie Änderungen entweder an der Basis-URL in der HTTP-Verbindung oder am oben eingegebenen Pfad vor.

  • Request-Parameter: Klicken Sie auf die Schaltfläche Hinzufügen, um eine Zeile hinzuzufügen, und geben Sie dann einen bestimmten Namen und Wert für angeforderte Parameter ein. Klicken Sie auf die Schaltfläche Entfernen, um eine vorhandene Zeile zu entfernen. Die bereitgestellten Request-Parameter werden automatisch URL-codiert.

  • Request-Header: Klicken Sie auf die Schaltfläche Hinzufügen, um eine Zeile hinzuzufügen, und geben Sie dann einen bestimmten Namen und Wert für angeforderte Header-Informationen ein. Klicken Sie auf die Schaltfläche Entfernen, um eine vorhandene Zeile zu entfernen.

    Maskierung von Request-Headern

    Sensitive Request-Header werden standardmäßig in Runtime-Protokollen maskiert. Um zusätzliche Request-Header bei Verwendung von privaten Agents zu maskieren, fügen Sie diese zum Abschnitt [Masking] der Konfigurationsdatei des privaten Agents hinzu.

  • Speichern und 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 zu wechseln. Die Konfiguration wird erst gespeichert, wenn Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem Schritt zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Request-Schema bereitstellen

In diesem Schritt können Sie ein benutzerdefiniertes Request-Schema bereitstellen (optional).

  • Request-Schema bereitstellen: Das Request-Schema definiert die Struktur der Request-Daten, die von der HTTP-Aktivität verwendet werden. Ob ein Request-Schema erforderlich ist, hängt davon ab, ob die Aktivität als Ziel einer Transformation verwendet wird und ob der Webservice strukturierte Request-Daten erwartet (siehe Schema-Verwendung). Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter In einer Aktivität definierte Schemas.

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

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

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem Schritt zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Antwortsschema bereitstellen

In diesem Schritt können Sie ein benutzerdefiniertes Antwortsschema bereitstellen (optional).

  • Antwortsschema bereitstellen: Das Antwortsschema definiert die Struktur der Antwortdaten, die von der HTTP-Aktivität verwendet werden. Ob ein Antwortsschema erforderlich ist, hängt davon ab, ob die Aktivität als Quelle einer Transformation verwendet wird und ob der Webservice strukturierte Antwortdaten zurückgibt (siehe Schemaverwendung). Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter In einer Aktivität definierte Schemas.

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

  • Weiter: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt zu wechseln. Die Konfiguration wird erst gespeichert, wenn Sie auf der letzten Seite auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem Schritt zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 4: Datenschemas überprüfen

Die konfigurierten Request- und Antwortsschemas (falls bereitgestellt) werden angezeigt.

  • Datenschema: Falls während der Aktivitätskonfiguration bereitgestellt, werden die Request- und/oder Antwortdatenschemas angezeigt. Wenn der Vorgang eine Transformation verwendet, werden die Datenschemas später während des Transformationsmapping-Prozesses erneut angezeigt, wo Sie Zielfelder mithilfe von Quellobjekten, Skripten, Variablen, benutzerdefinierten Werten und mehr zuordnen können. Sie können auch Schemas direkt in einer Transformation definieren.

  • Plugin(s) hinzufügen: Plugins sind von Jitterbit oder Benutzern bereitgestellte Anwendungen, die die nativen Funktionen von Harmony erweitern. Um ein Plugin auf die Aktivität anzuwenden, klicken Sie, um diesen Abschnitt zu erweitern, und aktivieren Sie das Kontrollkästchen neben dem zu verwendenden Plugin. Weitere Anweisungen zur Verwendung von Plugins, einschließlich Details zum Festlegen erforderlicher Variablen, die vom Plugin verwendet werden, finden Sie unter Zu einer Aktivität hinzugefügte Plugins.

  • 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: Klicken Sie nach dem Vornehmen von Änderungen, um die Konfiguration zu schließen, ohne Änderungen an einem Schritt zu speichern. Eine Meldung fordert Sie auf zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Jitterbit-Variablen, die HTTP-Übermittlung beeinflussen

Das Harmony-System definiert bestimmte globale Variablen, die überall in einem Projekt verfügbar sind und als Jitterbit-Variablen oder vordefinierte globale Variablen bekannt sind. Die unten aufgeführten Jitterbit-Variablen sind besonders nützlich für HTTP-Aktivitäten. Weitere Informationen zur Verwendung von Jitterbit-Variablen finden Sie unter Jitterbit-Variablen.

Diese Jitterbit-Variablen beeinflussen die Art und Weise, wie HTTP-Quellenübermittlungen durchgeführt werden:

  • jitterbit.source.max_redirs
  • jitterbit.source.http.ssl_cert_id
  • jitterbit.source.http.transfer_timeout

Diese Jitterbit-Variablen beeinflussen die Art und Weise, wie HTTP-Zielübermittlungen durchgeführt werden:

  • jitterbit.target.http.form_data
  • jitterbit.target.http.form_data.ContentType
  • jitterbit.target.http.form_data.filename
  • jitterbit.target.http.form_data.name
  • jitterbit.target.http.max_redirs
  • jitterbit.target.http.remove_trailing_linebreaks
  • jitterbit.target.http.ssl_cert_id
  • jitterbit.target.http.transfer_timeout

Nächste Schritte

Nach der Konfiguration einer HTTP Custom-Aktivität können Sie diese wie unten beschrieben in einem Vorgang oder Skript verwenden. Sie können auch Chunking konfigurieren, um die Daten in kleinere Chunks zur Verarbeitung aufzuteilen.

Vorgang abschließen

Nach der Konfiguration einer HTTP Custom-Aktivität schließen Sie die Konfiguration des Vorgangs ab, indem Sie weitere Aktivitäten oder Tools als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Vorgangseinstellungen eines Vorgangs konfigurieren, einschließlich der Möglichkeit, Vorgänge zu verketten, die sich in denselben oder verschiedenen Workflows befinden.

Nach der Erstellung einer HTTP Custom-Aktivität sind Menüaktionen für diese Aktivität im Projektbereich auf den Registerkarten Workflows oder Komponenten sowie auf der Designoberfläche verfügbar. Weitere Informationen finden Sie unter Aktionsmenü für Aktivitäten.

Die Vorgangsmuster, die HTTP-Aktivitäten verwenden können, hängen davon ab, ob die Aktivität Daten bereitstellt (als Quelle) oder Daten empfängt (als Ziel) in einem Vorgang, wie nachfolgend unter Als Quelle verwendet und Als Ziel verwendet beschrieben.

Ob der spezifische Webservice Request- oder Response-Schemas für jede Methode bereitstellt, bestimmt, ob eine Aktivität als Quelle oder Ziel verwendet werden kann, wie unter Teile eines Vorgangs in Vorgangserstellung und -konfiguration beschrieben.

Wenn alles bereit ist, stellen Sie den Vorgang bereit, führen ihn aus und überprüfen das Verhalten, indem Sie die Vorgangsprotokolle kontrollieren.

Als Quelle verwendet

HTTP-Aktivitäten, die als Quelle verwendet werden, können mit diesen Vorgangsmustern verwendet werden:

Andere Muster sind mit HTTP-Aktivitäten, die als Quelle verwendet werden, nicht gültig.

Als Ziel verwendet

HTTP-Aktivitäten, die als Ziel verwendet werden, können mit diesen Vorgangsmustern verwendet werden:

Andere Muster sind mit HTTP-Aktivitäten, die als Ziel verwendet werden, nicht gültig.

HTTP-Aktivitäten in Skripten verwenden

HTTP-Aktivitäten können auch in einem Skript referenziert werden, um sie mit Skriptfunktionen zu verwenden, die einen sourceId oder targetId als Parameter verwenden, einschließlich dieser:

Jitterbit-Funktionen

JavaScript-Jitterbit-Funktionen

Weitere Informationen zum Referenzieren von Aktivitäten in Skripten finden Sie unter Endpunkte in Jitterbit Script oder Endpunkte in JavaScript.

Chunking verwenden

Viele Web-Service-APIs haben Größenbeschränkungen. Falls Sie auf Datensatzlimits stoßen, die von der API vorgegeben werden, können Sie Chunking verwenden, um die Quelldaten in mehrere Chunks aufzuteilen. Die Transformation wird dann für jeden Chunk separat durchgeführt, wobei jeder Quell-Chunk einen Ziel-Chunk erzeugt. Die resultierenden Ziel-Chunks werden kombiniert, um das endgültige Ziel zu erzeugen.

Anweisungen und Best Practices zur Verwendung von Chunking finden Sie unter Operationsoptionen.