Was in diesem Artikel steht

Dieser Artikel beschreibt die Automatisierung von Streamboxy aus Salesforce, d.h. die Erstellung oder Konfiguration von Ereignissen, Benutzern, Sitzungsstart usw.

Einen Überblick über alle Funktionen der Salesforce-Integration finden Sie im Artikel Salesforce Integration Overview.

Voraussetzungen für die Integration

Die folgenden Punkte sind für eine STREAMBOXY-Salesforce Integration erforderlich: 

• Vorhandene Salesforce-Umgebung
• Ein STREAMBOXY-Tenant mit gültigen Subscription- und Tenant-Admin-Berechtigungen

Einrichten der Integration

Schritt 1 - STREAMBOXY - Navigieren Sie zum Abschnitt Integrationen

Klicken Sie in den Tenant-Einstellungen in der STREAMBOXY-Backstage auf "Integrationen" in der linken Navigationsleiste. Auf dieser Registerkarte werden alle Plattformen aufgelistet, die derzeit integriert werden können - einschließlich Salesforce.

Klicken Sie auf "Bearbeiten".

Schritt 2 - STREAMBOXY - Aktivieren Sie den Salesforce-Zugriff auf STREAMBOXY

Klicken Sie im Salesforce-Integrationsdialog auf "Salesforce den Zugriff auf Streamboxy (via Exteranl Service) erlauben" und klicken Sie auf "Speichern".

Lassen Sie das Fenster geöffnet oder kopieren Sie die folgenden Werte an einen anderen Ort, da Sie diese bei der Konfiguration der Salesforce-Umgebung benötigen:

• Salesforce Externer Service API Schlüssel
• Salesforce Externer Service Url
• Salesfroce Externer Service - Tenantspezifisches API-Schema (OpenAPI / Swagger)

Schritt 3 - Salesforce - Neues externes Credential erstellen

Zusätzliche Dokumentation zu diesem Schritt finden Sie in der Salesforce-Dokumentation: 
https://help.salesforce.com/s/articleView?language=en_US&id=sf.external_services_define_named_credential.htm&amp%3Btype=5

a) Melden Sie sich in Ihrer Salesforce-Organisation an und öffnen Sie Setup

 

b) Suchen Sie in Setup nach Named Credentials, wechseln Sie zur Registerkarte "External Credentials" und klicken Sie auf "New".

c) Geben Sie die Details des externen Berechtigungsnachweises in das Formular "Neuer externer Berechtigungsnachweis" ein und klicken Sie auf "Speichern".

Bezeichnung: Streamboxy Externer Berechtigungsnachweis

Name: StreamboxyExternalCredential

Authentifizierungsprotokoll: Benutzerdefiniert

Sie können unterschiedliche Werte für die Felder Label und Name eingeben, müssen diese aber im folgenden Schritt konsistent halten.

d) Nun können Sie eine benutzerdefinierte Kopfzeile für die neu erstellte externe Berechtigung erstellen, indem Sie im Abschnitt Benutzerdefinierte Kopfzeilen auf "Neu" klicken.

e) Geben Sie im Formular "Benutzerdefinierte Kopfzeilen" die folgenden Werte ein und klicken Sie auf "Speichern

Name: Autorisierung

Wert: Basic {!$Credential.StreamboxyExternalCredential.ApiKey} (Mit diesem Platzhalter wird der ApiKey-Berechtigungsnachweis dynamisch anhand der im nächsten Schritt erstellten Berechtigungssatzzuordnung ausgewählt)

Wichtig: Wenn Sie einen anderen Namen für den externen Berechtigungsnachweis gewählt haben, müssen Sie den Wert hier entsprechend dem von Ihnen gewählten Namen anpassen

f) Jetzt können Sie eine Berechtigungssatzzuordnung für die externe Berechtigung erstellen und auf Speichern klicken

Berechtigungssatz: 

Wählen Sie den Berechtigungssatz, der auch allen Herausgebern von Salesforce-Flows zugewiesen wird, die die Streamboxy-API-Integration nutzen können sollen.

Wichtig: Wenn der Benutzer, der den Fluss auslöst, nicht über das zugewiesene Berechtigungsset verfügt, schlägt der Fluss fehl.

Sequenznummer: 1

Identitäts-Typ: Named Principal

Authentifizierungsparameter 1 - Name: ApiSchlüssel

Authentifizierungsparameter 1 - Wert: Der Wert "Streamboxy External Service API Key", kopiert aus dem Streamboxy Salesforce Integration Dialog 

g) Die Konfiguration des externen Credentials ist nun abgeschlossen und sollte ähnlich wie der folgende Screenshot aussehen.

Schritt 4 - Salesforce - Neues benanntes Credential erstellen

a) Klicken Sie im Setup erneut auf Named Credentials, bleiben Sie auf der Registerkarte "Named Credentials" und klicken Sie auf "Neu".

b) Füllen Sie das Formular "New Named Credential" mit den folgenden Werten aus und klicken Sie auf Speichern.

Bezeichnung: Streamboxy Named Credential (oder etwas anderes nach Ihrem Geschmack)

Name: StreamboxyNamedCredential (oder ein anderer Name Ihrer Wahl)

Url: Salesforce External Service Url aus dem Streamboxy Salesforce Integration Configuration Dialog

Externer Berechtigungsnachweis: Wählen Sie das im vorherigen Schritt erstellte externe Credential

Formulare im HTTP-Header zulassen: true

Schritt 5 - Salesforce - Neuen Externen Service erstellen

a) Suchen Sie im Setup nach "Externe Services" und klicken Sie auf "Neuer Externer Service".

b) Wählen Sie im Dialog "Externen Service hinzufügen" die Option "Aus API-Spezifikation".

c) Füllen Sie das Formular "Add an External Service" mit den folgenden Werten aus und klicken Sie auf Save & Next.

Externer Dienst Name: StreamboxyExternalService (oder ein anderer Name Ihrer Wahl)

Dienst-Schema: Vollständiges JSON

Wählen Sie einen benannten Berechtigungsnachweis: Der benannte Berechtigungsnachweis, den Sie im vorherigen Schritt erstellt haben

JSON: Fügen Sie hier das JSON aus dem Feld "Salesforce External Service - Tenant Specific API schema (OpenAPI / Swagger)" aus dem Konfigurationsdialog der Streamboxy Salesforce Integration ein.

c) Wählen Sie die Operationen aus, die Sie in Ihrer Integration benötigen (oder einfach alle) und klicken Sie auf Weiter.

Häufig verwendete Operationen (get, put, post, patch, delete) sind:

• Ereignis
• EreignisBenutzer 
• EreignisSitzung
• EreignisSitzungBenutzer
• TenantUser

d) Überprüfen Sie die Aktionen des externen Dienstes und klicken Sie auf "Done".

Schritt 6 - Fertigstellen

Sie haben nun alles eingerichtet, um Streamboxy als externen Dienst zu nutzen.

Verwenden des externen Dienstes

Sie können den externen Service auf verschiedene Arten nutzen, z.B. aus einem Flow heraus, mit Apex Callouts, Einstein Bots usw.

In diesem Artikel finden Sie einige gängige Beispiele für die Verwendung von Flows.

Benutzerdefinierte Eigenschaften und die Salesforce-Integration

Streamboxy unterstützt benutzerdefinierte Eigenschaften, die ähnlich wie benutzerdefinierte Felder in Salesforce funktionieren und zusätzliche Daten für Events, Sessions und Tenant-Benutzer unterstützen.

Custom Properties können für jeden Streamboxy-Tenant individuell definiert werden und sind auch Teil der Swagger-Definition.

Wenn Sie die benutzerdefinierten Eigenschaften in Streamboxy aktualisiert haben, müssen Sie die Definition des externen Service aktualisieren, indem Sie das aktuelle Swagger-JSON aus Streamboxy abrufen und im externen Service aktualisieren.