Konfigurieren Sie ausgehende Nachrichten mit einer API-Manager API in Jitterbit Design Studio
Einführung
Dieses Integrationsdesignmuster richtet ein Salesforce ein Workflow Regel, das eine ausgehende Nachricht sendet zu einem API-Manager API, wenn sich ein Objekt ändert (in diesem Beispiel das Objekt Account). Ein Design Studio Projekt verarbeitet die ausgehende Salesforce Nachricht, ordnet die Daten des Objekts zu und speichert sie in einer Datenbank.
Notiz
Geänderte Salesforce Objektdatensätze über den API-Manager an eine Datenbank senden ist ein ähnliches Integrationsentwurfsmuster, das Integration Studio.
Um dieses Muster einzurichten, folgen Sie diesen Abschnitten der Reihe nach:
- Teil 1: Richten Sie in Salesforce eine Workflow Regel ein, um eine ausgehende Nachricht zu senden, wenn sich ein Objekt ändert, und laden Sie die WSDL-Datei herunter, die die Nachricht definiert.
- Teil 2: Richten Sie in Design Studio eine Operation ein, um die ausgehende Salesforce Nachricht zu empfangen und die zugeordneten Werte in einer Datenbank zu speichern.
- Teil 3: Richten Sie im API-Manager eine API als Endpoint für Salesforce ein.
- Teil 4: Kehren Sie zu Salesforce zurück, um die Endpoint URL der ausgehenden Nachricht zu aktualisieren, die ausgehende Nachricht zu aktivieren und dann das fertige Integrationsentwurfsmuster zu testen.
Teil 1: Eine Salesforce Workflow Regel einrichten und die WSDL-Datei herunterladen
- Wählen Sie in Salesforce Setup > Plattformtools > Prozessautomatisierung > Workflow.
-
Klicken Sie auf der Seite Workflow-Regeln auf die Schaltfläche Neue Regel (im Bild unten hervorgehoben). Wenn ein Dialogfeld Im Flow Builder ausprobieren geöffnet wird, klicken Sie auf Mit Workflow-Regeln fortfahren.
-
Klicken Sie auf der Seite Neue Workflow Regel auf das Menü Objekt, wählen Sie Konto aus und klicken Sie dann auf Weiter.
-
Geben Sie auf der Seite Konto Werte für Folgendes ein und klicken Sie dann auf Speichern und Weiter:
- Regelname: Der Name Ihrer Wahl.
- Beschreibung: (Optional) Eine Beschreibung für diese Regel.
- Bewertungskriterien: Erstellt und jedes Mal bearbeitet.
- Regelkriterien: Klicken Sie auf Diese Regel ausführen, wenn und wählen Sie dann Formel ergibt „Wahr“ aus.
- Geben Sie im Formelfeld true ein.
-
Klicken Sie auf der Seite Regel bearbeiten auf Workflow Aktion hinzufügen und wählen Sie dann Neue ausgehende Nachricht aus (im Bild unten hervorgehoben).
-
Geben Sie auf der Seite Neue ausgehende Nachricht Werte für Folgendes ein und klicken Sie dann auf Speichern:
- Name: Der Name Ihrer Wahl.
- Eindeutiger Name: Dieser Name wird automatisch basierend auf dem Wert für Name und den Benennungsregeln des Felds generiert.
- Beschreibung: (Optional) Eine Beschreibung für diese ausgehende Nachricht.
- Endpoint URL: example.com. Diese temporäre URL wird später aktualisiert.
- Benutzer zum Senden als: Geben Sie den Benutzer ein, der die ausgehende Nachricht sendet. Der Standardwert ist Ihr Salesforce-Benutzername.
- Geschützte Komponente: Nicht ausgewählt.
- Sitzungs-ID senden: Nicht ausgewählt.
- Zu sendende Kontofelder: Wählen Sie die zu sendenden Objektfelder aus. In diesem Beispiel sind nur Name und Telefon ausgewählt. Das Feld ID wird automatisch ausgewählt, da es das Schlüsselfeld für das Objekt ist.
-
Klicken Sie auf der Seite Regel bearbeiten auf Fertig.
-
Klicken Sie auf der Seite Workflow Regel im Abschnitt Sofortige Workflow Aktionen auf den Beschreibungslink für die ausgehende Nachricht (im Bild unten hervorgehoben).
-
Klicken Sie auf der Seite Workflow Outbound Message Detail der Nachricht auf den Link Click for WSDL in der Zeile mit der Bezeichnung Endpoint WSDL (im Bild unten hervorgehoben).
-
Eine XML-Datei wird in einem neuen Browserfenster geöffnet. Speichern Sie die Datei mit einem
.wsdl
Erweiterung. Abhängig von Ihrem Operationssystem müssen Sie die Dateierweiterung möglicherweise nach dem Herunterladen festlegen.
Teil 2: Design Studio Vorgänge
Definieren Sie die Operation „Salesforce Outbound Message“
-
Erstellen Sie ein neues Design Studio Projekt.
-
Klicken Sie in der Projektelementliste links mit der rechten Maustaste auf Operationen und wählen Sie dann Neue Operation.
- Wählen Sie im Dialogfeld Typ auswählen Script aus und klicken Sie dann auf Weiter.
-
Legen Sie im Fenster Operationen den Operation auf Salesforce Outbound Message fest.
-
Doppelklicken Sie auf die Script-Aktivität der Operation und klicken Sie dann auf Neues Jitterbit Script erstellen.
-
Legen Sie im Fenster Neues Script die folgenden Werte fest, klicken Sie auf Speichern und schließen Sie dann das Script:
- Name: Ausgehende Salesforce Nachricht empfangen
-
Bearbeiten Sie das Script, sodass es Folgendes enthält:
<trans> $org.api.salesforce.request=$jitterbit.api.request.body; </trans>
Dadurch wird eine globale Variable erstellt und setzt ihn auf den Wert der vordefinierten globalen Variable
jitterbit.api.request.body
. -
Klicken Sie im Operation Salesforce Outbound Message auf Speichern.
-
Klicken Sie in der Projektelementliste links mit der rechten Maustaste auf Quellen und wählen Sie dann Neue Quelle.
- Wählen Sie im Dialogfeld Typ auswählen die Option Globale Variable aus und klicken Sie dann auf Weiter.
-
Legen Sie im Fenster Neue Quelle die folgenden Werte fest, klicken Sie auf Speichern und schließen Sie dann das Quellfenster:
- Name: Salesforce API -Anfrage
- Typ: Globale Variable
- Globaler Variablenname: org.api.salesforce.request
Definieren Sie den Operation „API Antwort senden“
-
Erstellen Sie eine neue Operation vom Typ Transformation. Legen Sie den Operation auf API Antwort senden_ fest.
-
Doppelklicken Sie auf Transformation. Klicken Sie im Dialogfeld Transformation auswählen auf Neue Transformation erstellen.
-
Geben Sie im Schritt NAME des Fensters Neue Transformation die folgenden Werte ein und klicken Sie dann auf Weiter >:
- Name: API Antwort senden_.
- Quelle: (Keine).
- Ziel: SOAP/WSDL-Antwort.
-
Wählen Sie im Schritt ZIEL Lokale WSDL-Datei auswählen, klicken Sie auf Durchsuchen..., wählen Sie die zuvor heruntergeladene WSDL-Datei aus, klicken Sie dann auf Weiter > und warten Sie auf die Dateivalidierung.
-
Klicken Sie im Schritt TARGET auf Weiter >.
-
Klicken Sie auf der Seite Optionen auf Fertigstellen.
-
Erweitern Sie im Transformation Send API Response alle Knoten, bis das Element
[EV?] Ack (Boolean)
sichtbar ist, dann doppelklicken Sie darauf. -
Bearbeiten Sie im Formel-Generator das Script wie folgt und klicken Sie dann auf OK, um den Script Editor zu schließen:
<trans> true </trans>
Dies ist die Antwort auf die Salesforce SOAP Anfrage.
-
Klicken Sie im Transformations API -Antwort senden auf Speichern und schließen Sie dann das Fenster.
-
Klicken Sie im Operation API Antwort senden mit der rechten Maustaste auf das Element Ziel, wählen Sie API -Antwort verwenden und klicken Sie dann auf Speichern:
Die Salesforce Outbound Message Operation:
-
Öffnen Sie die Operation Salesforce Outbound Message, wählen Sie den Abwärtspfeil neben dem Operation und wählen Sie dann Bei Erfolg > Operation > Vorhandenes auswählen….
-
Wählen Sie im Dialogfeld Erfolgreichen Vorgang auswählen die Option API Antwort senden aus und klicken Sie dann auf OK.
-
Klicken Sie im Operation Salesforce Outbound Message auf Speichern.
Definieren Sie den Operation „Upsert Database“
-
Erstellen Sie eine neue Operation vom Typ Transformation. Legen Sie den Operation auf Upsert Database fest.
-
Doppelklicken Sie auf die Aktivität Quelle.
-
Wählen Sie im Dialogfeld Quelle auswählen die Option Salesforce API Anforderung aus und klicken Sie dann auf OK.
-
Doppelklicken Sie auf das Ziel-Element.
-
Klicken Sie im Dialogfeld Ziel auswählen auf Neues Ziel erstellen.
-
Legen Sie im Fenster Neues Ziel die folgenden Werte fest, klicken Sie auf Verbindung testen und schließen Sie dann das Fenster Datenbank:
- Name: Datenbank-Endpunkt.
- Typ: Datenbank.
- Verbindungsparameter: Legen Sie die Parameter für Ihre Datenbank fest. (In diesem Beispiel wird eine Verbindung zu einem PostgreSQL -Server gezeigt.)
-
Doppelklicken Sie auf das Element Transformation.
-
Klicken Sie im Dialogfeld Transformation auswählen auf Neue Transformation erstellen.
-
Geben Sie im Fenster Neue Transformation Werte für Folgendes ein und klicken Sie dann auf Weiter >:
- Name: Upsert-Datenbank.
- Quelle: SOAP/WSDL-Anfrage.
-
Wählen Sie im Schritt QUELLE Vorhandene WSDL-Datei auswählen, wählen Sie dann die zuvor hochgeladene WSDL-Datei aus, klicken Sie auf Weiter > und warten Sie auf die Dateivalidierung.
-
Wenn die Datei validiert ist, klicken Sie auf Weiter >.
-
Klicken Sie auf der Optionsseite auf Weiter >.
-
Klicken Sie im Schritt ZIEL auf Tabellenliste herunterladen. Wählen Sie die Zieldatenbanktabelle aus, klicken Sie auf den Pfeil nach rechts, um sie in die Liste Ausgewählte Tabellen zu verschieben, und klicken Sie dann auf Weiter >.
-
Stellen Sie im Schritt TARGET sicher, dass Einfügen/Aktualisieren ausgewählt ist, und klicken Sie dann auf Fertigstellen.
-
Erweitern Sie im Transformation Upsert Database die Quell- und Zielbäume, ordnen Sie Felder per Drag & Drop zu, klicken Sie dann auf Speichern und schließen Sie das Transformation.
-
Klicken Sie im Operation Upsert Database auf Speichern und schließen Sie das Fenster.
- Doppelklicken Sie in der Operation Ausgehende Salesforce-Nachricht auf die Aktivität Ausgehende Salesforce-Nachricht empfangen.
-
Bearbeiten Sie das Script im Script wie folgt, klicken Sie dann auf Speichern und schließen Sie das Fenster:
<trans> $org.api.salesforce.request=$jitterbit.api.request.body; RunOperation("<TAG>Operations/Upsert Database</TAG>") </trans>
-
Klicken Sie im Operation Salesforce Outbound Message auf Speichern.
-
Wählen Sie Aktionen > Bereitstellen. Wählen Sie im Dialogfeld Bereitstellen unter Bereitstellungstyp auswählen Alles aus und klicken Sie dann auf Bereitstellen.
Teil 3: API-Manager API
- Im API-Manager, wählen Sie Meine APIs aus und klicken Sie dann auf Neue API.
-
Geben Sie in Schritt 1 der Seite Neue API veröffentlichen Werte für Folgendes ein und klicken Sie dann auf Weiter:
- API Name: Geben Sie einen Namen für die API ein.
- Umgebung: Wählen Sie die Umfeld aus, in der das Design Studio Projekt bereitgestellt wurde.
- Service-Stamm: Belassen Sie den vom API Namen abgeleiteten Anfangswert.
- Versionsnummer: (Optional) Geben Sie eine API Versionsnummer ein.
- Beschreibung: (Optional) Geben Sie eine Beschreibung für diese API ein.
-
Wählen Sie in Schritt 2 Custom API als Diensttyp aus und klicken Sie dann auf API Dienst hinzufügen. Geben Sie für den neuen API Dienst diese Werte in die folgenden Felder ein, klicken Sie auf Speichern und dann auf Weiter:
-
Anforderungsmethode: Verwenden Sie das Menü, um die POST-Anforderungsmethode für den API Dienst auszuwählen. Standardmäßig ist die Anforderungsmethode auf GET eingestellt.
-
Dienstname: Geben Sie einen Dienstnamen ein.
-
Wählen Sie auf der Tab Vorgang diese Werte aus:
-
Projekt zuweisen: Wählen Sie aus dem Menü Ihr Integration Studio Projekt.
-
Operation(en) zuweisen:
-
Operation: Wählen Sie die Operation Ausgehende Salesforce-Nachricht aus.
-
Antworttyp: Wählen Sie Endziel als Antworttyp.
-
-
-
-
Klicken Sie in Schritt 3 auf Diesen Schritt überspringen.
-
Klicken Sie in Schritt 4 auf Speichern und veröffentlichen.
-
Klicken Sie im Dialogfeld Alles bereit, Ihre API ist live! auf URL kopieren und dann auf Verwerfen.
Teil 4: Aktualisieren Sie die Salesforce Endpoint URL und aktivieren Sie
- Wählen Sie in Salesforce Setup > Plattformtools > Prozessautomatisierung > Workflow Aktionen > Ausgehende Nachrichten.
- Klicken Sie auf der Seite Ausgehende Nachrichten auf Bearbeiten für Ihre ausgehende Nachricht.
-
Ersetzen Sie den Inhalt des Felds Endpoint URL (im Bild unten hervorgehoben) durch die URL, die Sie am Ende des vorherigen Abschnitts kopiert haben, und klicken Sie dann auf Speichern.
-
Klicken Sie im Abschnitt Workflow-Regeln, die diese ausgehende Nachricht verwenden auf Aktivieren für die Regel (im Bild unten hervorgehoben).
Testen der Integration
Um dieses Integrationsentwurfsmuster zu testen, führen Sie die folgenden Schritte aus:
- Öffnen Sie in Salesforce die App Service und wählen Sie die Tab Konten aus.
- Bearbeiten Sie einen Kontokontakt und speichern Sie ihn.
- Melden Sie sich bei Ihrer Datenbank an und Abfrage die Zieltabelle ab.