Konfigurieren von ausgehenden Nachrichten mit einer API-Manager-API in Jitterbit Design Studio
Einführung
Dieses Integrationsdesignmuster richtet eine Salesforce Workflow-Regel ein, die eine ausgehende Nachricht an eine API-Manager API sendet, wenn sich ein Objekt ändert (in diesem Beispiel das Account-Objekt). Ein Design Studio-Projekt verarbeitet die ausgehende Salesforce-Nachricht, mappt die Daten des Objekts und speichert sie in einer Datenbank.
Hinweis
Ändern von Salesforce-Objektaufzeichnungen an eine Datenbank über API-Manager ist ein ähnliches Integrationsdesignmuster, das Studio verwendet.
Um dieses Muster einzurichten, folgen Sie diesen Abschnitten in der angegebenen Reihenfolge:
- 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 im Design Studio eine Betriebskette ein, um die ausgehende Salesforce-Nachricht zu empfangen und die gemappten Werte in einer Datenbank zu speichern.
- Teil 3: Richten Sie im API-Manager eine API als Endpunkt für Salesforce ein.
- Teil 4: Kehren Sie zu Salesforce zurück, um die Endpunkt-URL der ausgehenden Nachricht zu aktualisieren, aktivieren Sie die ausgehende Nachricht und testen Sie das abgeschlossene Integrationsdesignmuster.
Teil 1: Richten Sie eine Salesforce-Workflow-Regel ein und laden Sie die WSDL-Datei herunter
- Wählen Sie in Salesforce Setup > Platform Tools > Process Automation > Workflow Rules.
-
Klicken Sie auf der Seite Workflow-Regeln auf die Schaltfläche Neue Regel (im Bild unten hervorgehoben). Wenn ein Dialogfeld Versuchen Sie es im Flow Builder 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 Account und klicken Sie dann auf Weiter.

-
Auf der Account-Seite Werte für Folgendes eingeben und dann auf Speichern & Weiter klicken:
- Regelname: Ihre Wahl des Namens.
- Beschreibung: (Optional) Eine Beschreibung für diese Regel.
- Bewertungskriterien: Erstellt und Jedes Mal, wenn es bearbeitet wird.
- Regelkriterien: Klicken Sie auf Diese Regel ausführen, wenn, und wählen Sie dann Formel bewertet als wahr.
- Im Formel-Feld true eingeben.

-
Auf der Regel bearbeiten-Seite auf Workflow-Aktion hinzufügen klicken und dann Neue ausgehende Nachricht auswählen (im Bild unten hervorgehoben).

-
Auf der Neue ausgehende Nachricht-Seite Werte für Folgendes eingeben und dann auf Speichern klicken:
- Name: Ihre Wahl des Namens.
- Eindeutiger Name: Dieser Name wird automatisch basierend auf dem Wert für Name und den Benennungsregeln des Feldes generiert.
- Beschreibung: (Optional) Eine Beschreibung für diese ausgehende Nachricht.
- Endpoint-URL: example.com. Diese temporäre URL wird später aktualisiert.
- Benutzer, der senden soll: Geben Sie den Benutzer ein, der die ausgehende Nachricht sendet. Der Wert wird standardmäßig auf Ihren Salesforce-Benutzernamen gesetzt.
- Geschütztes Element: Nicht ausgewählt.
- Sitzungs-ID senden: Nicht ausgewählt.
- Zu sendende Kontofelder: Wählen Sie die Objektfelder aus, die gesendet werden sollen. In diesem Beispiel sind nur Name und Telefon ausgewählt. Das Feld Id wird automatisch ausgewählt, da es das Schlüssel-Feld für das Objekt ist.

-
Auf der Regel bearbeiten-Seite auf Fertig klicken.

-
Auf der Workflow-Regel-Seite im Abschnitt Unmittelbare Workflow-Aktionen auf den Beschreibungslink für die ausgehende Nachricht klicken (im Bild unten hervorgehoben).

-
Auf der Seite Detailseite für Workflow-Outbound-Nachricht der Nachricht klicken Sie auf den Link Klicken Sie hier für WSDL in der Zeile mit der Bezeichnung Endpoint WSDL (im Bild unten hervorgehoben).

-
Eine XML-Datei öffnet sich in einem neuen Browserfenster. Speichern Sie die Datei mit der Endung
.wsdl. Je nach Betriebssystem müssen Sie möglicherweise die Dateiendung nach dem Herunterladen festlegen.
Teil 2: Design Studio-Operationen
Definieren Sie die 'Salesforce Outbound Message'-Operation
-
Erstellen Sie ein neues Design Studio-Projekt.
-
Klicken Sie in der Liste der Projektobjekte auf der linken Seite mit der rechten Maustaste auf Operationen und wählen Sie dann Neue Operation.
- Wählen Sie im Dialogfeld Typ auswählen Skript aus und klicken Sie auf Weiter.
-
Setzen Sie im Fenster Operationen den Namen der Operation auf Salesforce Outbound Message.

-
Doppelklicken Sie auf die Aktivität Skript der Operation und klicken Sie dann auf Neues Jitterbit-Skript erstellen.
-
Setzen Sie im Fenster Neues Skript die Werte für Folgendes, klicken Sie auf Speichern und schließen Sie dann das Skriptfenster:
- Name: Receive Salesforce Outbound Message
-
Bearbeiten Sie das Skript, um Folgendes zu entsprechen:
<trans> $org.api.salesforce.request=$jitterbit.api.request.body; </trans>

Dies erstellt eine globale Variable und setzt sie auf den Wert der vordefinierten globalen Variable
jitterbit.api.request.body. -
Klicken Sie im Fenster der Salesforce Outbound Message-Operation auf Speichern.
-
Klicken Sie im Projektartikelverzeichnis links mit der rechten Maustaste auf Quellen und wählen Sie dann Neue Quelle.
- Wählen Sie im Dialogfeld Typ auswählen Globale Variable aus und klicken Sie auf Weiter.
-
Legen Sie im Fenster Neue Quelle Werte für Folgendes fest, klicken Sie auf Speichern und schließen Sie dann das Quellfenster:
- Name: Salesforce API-Anfrage
- Typ: Globale Variable
- Name der globalen Variable: org.api.salesforce.request

Definieren Sie die Operation 'API-Antwort senden'
-
Erstellen Sie eine neue Operation vom Typ Transformation. Setzen Sie den Operationsnamen auf API-Antwort senden.

-
Doppelklicken Sie auf Transformation. Klicken Sie im Dialogfeld Transformation auswählen auf Neue Transformation erstellen.
-
Geben Sie im Schritt NAME des Fensters Neue Transformation Werte für Folgendes ein und klicken Sie dann auf Weiter >:
- Name: API-Antwort senden.
- Quelle: (Keine).
- Ziel: SOAP/WSDL-Antwort.

-
Wählen Sie im Schritt ZIEL Wählen Sie eine lokale WSDL-Datei aus, klicken Sie auf Durchsuchen..., wählen Sie die zuvor heruntergeladene WSDL-Datei aus und klicken Sie dann auf Weiter > und warten Sie auf die Dateivalidierung.

-
Klicken Sie im Schritt ZIEL auf Weiter >.

-
Klicken Sie auf der Seite Optionen auf Fertigstellen.

-
Erweitern Sie im Fenster der Transformation API-Antwort senden alle Knoten, bis das Element
[EV?] Ack (Boolean)sichtbar ist, und doppelklicken Sie darauf.
-
Im Formel-Builder bearbeiten Sie das Skript, um es wie folgt anzupassen, und klicken Sie dann auf OK, um den Skripteditor zu schließen:
<trans> true </trans>
Dies ist die Antwort auf die Salesforce SOAP-Anfrage.
-
Klicken Sie im Fenster API-Antwort senden auf Speichern und schließen Sie dann das Fenster.
-
Klicken Sie im Fenster API-Antwort senden mit der rechten Maustaste auf das Ziel-Element, wählen Sie API-Antwort verwenden und klicken Sie dann auf Speichern:

Die Salesforce Outbound Message-Operation:

-
Öffnen Sie die Salesforce Outbound Message-Operation, klicken Sie auf den Abwärtspfeil neben dem Operationsnamen und wählen Sie dann Bei Erfolg > Operation > Vorhandene auswählen....

-
Wählen Sie im Dialogfeld Erfolgsoperation auswählen API-Antwort senden aus und klicken Sie dann auf OK.

-
Klicken Sie im Fenster Salesforce Outbound Message auf Speichern.
Definieren Sie die 'Upsert-Datenbank'-Operation
-
Erstellen Sie eine neue Operation vom Typ Transformation. Setzen Sie den Operationsnamen auf Upsert-Datenbank.

-
Doppelklicken Sie auf die Quelle-Aktivität.
-
Wählen Sie im Dialogfeld Quelle auswählen Salesforce API-Anfrage 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 Werte für die folgenden Felder fest, klicken Sie auf Verbindung testen und schließen Sie dann das Datenbank-Fenster:
- Name: Datenbank-Endpunkt.
- Type: Datenbank.
- Connection Parameters: Legen Sie die Parameter für Ihre Datenbank fest. (Eine Verbindung zu einem PostgreSQL-Server wird in diesem Beispiel gezeigt.)

-
Doppelklicken Sie auf das Transformation-Element.

-
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.
- Source: SOAP/WSDL-Anfrage.

-
Wählen Sie im Schritt QUELLE Wählen Sie eine vorhandene WSDL-Datei aus, wählen Sie dann die zuvor hochgeladene WSDL-Datei aus und klicken Sie auf Weiter > und warten Sie auf die Dateivalidierung.

-
Wenn die Datei validiert wurde, klicken Sie auf Weiter >.

-
Klicken Sie auf der Optionsseite auf Weiter >.

-
Klicken Sie im Schritt ZIEL auf Liste der Tabellen herunterladen. Wählen Sie die Zieltabelle der Datenbank aus, klicken Sie auf den rechten Pfeil, um sie in die Liste der Ausgewählten Tabellen zu verschieben, und klicken Sie dann auf Weiter >.

-
Stellen Sie im Schritt ZIEL sicher, dass Einfügen/Aktualisieren ausgewählt ist, und klicken Sie dann auf Fertigstellen.

-
Erweitern Sie im Fenster der Upsert-Datenbank-Transformation die Quell- und Zielbäume, ordnen Sie die Felder durch Ziehen und Ablegen zu, und klicken Sie dann auf Speichern und schließen Sie das Transformationsfenster.

-
Im Fenster der Upsert-Datenbank-Operation klicken Sie auf Speichern und schließen das Fenster.
- In der Salesforce Outbound Message-Operation doppelklicken Sie auf die Aktivität Receive Salesforce Outbound Message.
-
Im Skriptfenster bearbeiten Sie das Skript, um es wie folgt anzupassen, und klicken dann auf Speichern und schließen das Fenster:
<trans> $org.api.salesforce.request=$jitterbit.api.request.body; RunOperation("<TAG>Operations/Upsert Database</TAG>") </trans>
-
Im Fenster der Salesforce Outbound Message-Operation klicken Sie auf Speichern.

-
Wählen Sie Aktionen > Bereitstellen. Im Dialogfeld Bereitstellen wählen Sie unter Wählen Sie einen Bereitstellungstyp Alles aus und klicken dann auf Bereitstellen.

Teil 3: API-Manager-API
- Wählen Sie im API-Manager APIs und klicken Sie dann auf Neue API.
-
Geben Sie im 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 Umgebung aus, in der das Design Studio-Projekt bereitgestellt wurde.
- Service-Root: Lassen Sie den ursprünglichen Wert, der aus dem API-Namen abgeleitet wurde.
- Versionsnummer: (Optional) Geben Sie eine Versionsnummer für die API ein.
- Beschreibung: (Optional) Geben Sie eine Beschreibung für diese API ein.

-
Wählen Sie im Schritt 2 Benutzerdefinierte API als Service-Typ aus und klicken Sie dann auf API-Service hinzufügen. Geben Sie für den neuen API-Service diese Werte für die folgenden Felder ein, klicken Sie auf Speichern und dann auf Weiter:
-
Anforderungsmethode: Verwenden Sie das Menü, um die Anforderungsmethode POST für den API-Service auszuwählen. Standardmäßig ist die Anforderungsmethode auf GET eingestellt.
-
Service-Name: Geben Sie einen Servicenamen ein.
-
-
Im Tab Operation diese Werte auswählen:
-
Projekt zuweisen: Wählen Sie aus dem Menü Ihr Studio-Projekt aus.
-
Operation(en) zuweisen:
-
Operation: Wählen Sie die Salesforce Outbound Message-Operation aus.
-
Antworttyp: Wählen Sie Final Target als Antworttyp aus.
-

-
-
Klicken Sie im Schritt 3 auf Diesen Schritt überspringen.
-
Klicken Sie im Schritt 4 auf Speichern & Veröffentlichen.

-
Klicken Sie im Dialogfeld mit dem Titel Alles bereit, Ihre API ist live! auf URL kopieren, und klicken Sie dann auf Schließen.
Teil 4: Salesforce-Endpunkt-URL aktualisieren und aktivieren
- Wählen Sie in Salesforce Setup > Plattform-Tools > Prozessautomatisierung > Workflow-Aktionen > Outbound-Nachrichten.
- Klicken Sie auf der Seite Outbound-Nachrichten auf Bearbeiten für Ihre Outbound-Nachricht.
-
Ersetzen Sie den Inhalt des Feldes Endpoint-URL (im Bild unten hervorgehoben) durch die am Ende des vorherigen Abschnitts kopierte URL, und klicken Sie dann auf Speichern.

-
Klicken Sie im Abschnitt Workflow-Regeln, die diese Outbound-Nachricht verwenden auf Aktivieren für die Regel (im Bild unten hervorgehoben).

Integration testen
Um dieses Integrationsdesignmuster zu testen, folgen Sie diesen Schritten:
- Öffnen Sie in Salesforce die Service-App und wählen Sie den Tab Konten aus.
- Bearbeiten Sie einen Kontaktdatensatz und speichern Sie ihn.
- Melden Sie sich in Ihrer Datenbank an und führen Sie eine Abfrage auf der Zieltabelle aus.