Amazon SQS Get Messages-Aktivität in Jitterbit Studio
Einführung
Eine Amazon SQS Get Messages-Aktivität, die ihre Amazon SQS-Verbindung verwendet, ruft alle verfügbaren Amazon SQS-Nachrichten in einer bestimmten Warteschlange ab und ist als Quelle in einem Vorgang gedacht.
Diese Aktivität verwendet die ReceiveMessage-Aktion aus der Amazon SQS-API.
Voraussetzungen
Um diese Aktivität erfolgreich zu nutzen, müssen Sie über die folgenden AWS IAM-Kontoberechtigungen verfügen:
sqs:GetQueueUrlsqs:ListQueuessqs:ReceiveMessage
Berechtigungen für mehrere Konten gelten nicht für diese Aktion. Weitere Informationen finden Sie in Grundlegende Beispiele für Amazon SQS-Richtlinien im Amazon SQS-Entwicklerhandbuch.
Erstellen einer Amazon SQS Get Messages-Aktivität
Eine Instanz einer Amazon SQS Get Messages-Aktivität wird aus einer Amazon SQS-Verbindung unter Verwendung des Aktivitätstyps Get Messages 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 Amazon SQS Get Messages-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 Amazon SQS Get Messages-Aktivität
Befolgen Sie diese Schritte, um eine Amazon SQS Get Messages-Aktivität zu konfigurieren:
-
Schritt 1: Geben Sie einen Namen ein, wählen Sie eine Warteschlange aus und geben Sie die Einstellungen an
Geben Sie einen Namen für die Aktivität ein, wählen Sie eine Warteschlange aus und geben Sie die Einstellungen zum Empfangen von Nachrichten an. -
Schritt 2: Überprüfen Sie die Datenschemas
Alle Anforderungs- oder Antwortschemas, die vom Endpunkt generiert wurden, werden angezeigt.
Schritt 1: Geben Sie einen Namen ein, wählen Sie eine Warteschlange aus und geben Sie die Einstellungen an
In diesem Schritt geben Sie einen Namen für die Aktivität ein, wählen Sie eine Warteschlange aus und geben Sie die Einstellungen zum Empfangen von Nachrichten an.
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ü mit vorhandenen Variablen anzuzeigen, aus denen Sie auswählen können.
-
Endpunktmenü: Wenn Sie mehrere Endpunkte desselben 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 Amazon SQS Get Messages-Aktivität eindeutig sein und darf keine Schrägstriche (
/) oder Doppelpunkte (:) enthalten. -
Wählen Sie eine Warteschlange aus: In diesem Abschnitt werden die in dem Amazon SQS-Endpunkt verfügbaren Warteschlangen angezeigt. Wenn Sie eine vorhandene Aktivitätskonfiguration erneut öffnen, wird nur die ausgewählte Warteschlange angezeigt, anstatt die gesamte Warteschlangenliste neu zu laden.
-
Ausgewählte Warteschlange: Nachdem eine Warteschlange ausgewählt wurde, wird sie hier aufgelistet.
-
Suche: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Liste der Warteschlangen zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Warteschlangen bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Warteschlangen vom Endpunkt beim Suchen 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 Warteschlangen vom Amazon SQS-Endpunkt neu zu laden. Dies kann nützlich sein, wenn Warteschlangen zu Amazon SQS hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Warteschlangentabelle verwendet werden.
-
Wählen einer Warteschlange: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um eine Warteschlange auszuwählen. Es kann nur eine Warteschlange ausgewählt werden. Die Informationen, die für jede Warteschlange verfügbar sind, werden vom Amazon SQS-Endpunkt abgerufen:
-
Name: Der Warteschlangenname von Amazon SQS.
-
Beschreibung: Die Warteschlangenbeschreibung von Amazon SQS.
-
Hinweis
Wenn die Tabelle nicht mit verfügbaren Warteschlangen gefüllt wird, könnte die Amazon SQS-Verbindung nicht erfolgreich sein. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.
-
-
Empfangsanforderungsversuch-ID: Geben Sie die Empfangsanforderungsversuch-ID ein. Dies ist ein Token, das zur Nachrichten-Deduplizierung verwendet wird.
-
Sichtbarkeitszeitüberschreitung: Geben Sie die Dauer an, in der eine von einer Warteschlange empfangene Nachricht (von einem Verbraucher) für die anderen Nachrichtenverbraucher nicht sichtbar ist. Dies kann von 0 bis 43.200 Sekunden reichen. Weitere Informationen finden Sie unter Amazon SQS Sichtbarkeitszeitüberschreitung.
-
Wartezeit in Sekunden: Geben Sie die maximale Zeit an, die Amazon SQS wartet, bis Nachrichten verfügbar werden, nachdem die Warteschlange eine Empfangsanfrage erhalten hat. Weitere Informationen finden Sie unter Amazon SQS Kurze und Lange Abfragen.
-
Maximale Anzahl von Nachrichten: Geben Sie die maximale Anzahl von Nachrichten ein, die abgerufen werden sollen. Dies kann von 1 bis 10 Nachrichten reichen.
-
Nachrichten automatisch aus der Warteschlange löschen: Wählen Sie diese Option, um empfangene Nachrichten automatisch aus der Warteschlange zu löschen. Diese Option ist standardmäßig ausgewählt.
-
Bei Fehler fortfahren: Wählen Sie diese Option, um die Ausführung der Aktivität fortzusetzen, wenn ein Fehler bei einem Datensatz in einer Batch-Anfrage auftritt. Wenn Fehler auftreten, werden diese im Betriebsprotokoll aufgezeichnet. Diese Option ist standardmäßig ausgewählt.
-
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: Nach Änderungen 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.
Schritt 2: Überprüfen der Datenschemas
Alle von dem Endpunkt generierten Anfrage- oder Antwortschemas werden angezeigt.
-
Datenschemas: Diese Datenschemas werden von angrenzenden Transformationen geerbt und während der Transformationszuordnung erneut angezeigt.
Hinweis
Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.
Der Amazon SQS-Connector verwendet die Amazon SQS API. Weitere Informationen zu den Schema-Knoten und -Feldern finden Sie in der Dokumentation zur ReceiveMessage-Aktion.
Die Anfrage- und Antwortdatenschemas bestehen aus diesen Knoten und Feldern:
-
Anfrage:
Anfrage-Schema Knoten/Feld Beschreibung GetMessagesRequestAnfrage zum Abrufen von Nachrichten aus einer Warteschlange requestKnoten, der die Anfrage darstellt attributeNamesListe der Attribute, die zusammen mit den Nachrichten abgerufen werden sollen #textStandardmäßig auf Alle gesetzt, siehe API-Nachricht für anwendbare Werte maxNumberOfMessagesGanzzahl mit der maximalen Anzahl von Nachrichten, die abgerufen werden sollen messageAttributeNamesListe der Attribute, die innerhalb jeder Nachricht abgerufen werden sollen #textStandardmäßig auf Alle gesetzt, siehe API-Nachricht für anwendbare Werte queueUrlZeichenfolge mit der URL der Warteschlange, aus der Nachrichten abgerufen werden sollen receiveRequestAttemptIdZeichenfolge mit einem Token, das für die Duplikation von FIFO-Warteschlangen-Nachrichten verwendet wird visibilityTimeoutGanzzahl mit den Sichtbarkeitszeitüberschreitungen der Nachrichten in Sekunden waitTimeSecondsGanzzahl mit der Wartezeit für Nachrichten in Sekunden autoDeleteMessagesBoolean, der bestimmt, ob Nachrichten nach dem Abruf gelöscht werden sollen -
Antwort:
Antwort-Schema-Knoten/Feld Beschreibung GetMessagesRequestAntwort auf das Abrufen von Nachrichten aus einer Warteschlange responseKnoten, der die Antwort darstellt errorMessageZeichenfolge, die auf die Fehlermeldung der Antwort gesetzt ist autoDeleteStatusZeichenfolge, die auf den Status des automatischen Löschvorgangs gesetzt ist messagesListe der Nachrichten, die mit der Antwort zurückgegeben werden bodyZeichenfolge, die auf den Inhalt der Nachricht gesetzt ist mD5OfBodyZeichenfolge, die auf den MD5-Hash des nicht URL-kodierten Nachrichteninhalts gesetzt ist mD5OfMessageAttributesZeichenfolge, die auf den MD5-Hash der nicht URL-kodierten Nachrichtenattribute gesetzt ist messageAttributesListe der Attribute, die mit der Nachricht verbunden sind attrNameZeichenfolge, die auf den Namen des Attributs gesetzt ist stringValueZeichenfolge, die auf den Wert des Attributs gesetzt ist dataTypeZeichenfolge, die auf den Datentyp des Attributs gesetzt ist messageIdZeichenfolge, die auf die eindeutige Kennung der Nachricht gesetzt ist receiptHandleZeichenfolge, die auf den Empfangsgriff gesetzt ist, der mit der Nachricht verbunden ist
-
-
Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um Schemas vom Amazon SQS-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 benachbarten 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 Amazon SQS Nachrichten abrufen-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. Weitere Details finden Sie im Aktivitätsaktionsmenü in Connector-Grundlagen.
Amazon SQS Nachrichten abrufen-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, führen Sie die Bereitstellung und Ausführung der Operation durch und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.