Eine Microsoft Teams-Benachrichtigung von einem Studio-Vorgang in Jitterbit Studio versenden

Einführung

Dieses Integrationsentwurfsmuster versendet eine formatierte Nachricht von einem Studio-Vorgang an einen Microsoft Teams-Kanal. Der Vorgang nutzt den Microsoft Teams-Connector, um eine Nachricht über die Microsoft Graph API an ein bestimmtes Team und einen bestimmten Kanal zu posten. Dieses Muster wird häufig verwendet, um ein Team zu benachrichtigen, wenn ein bedeutsames Ereignis eintritt, z. B. wenn eine neue Bestellung empfangen wird, ein Datensatz erstellt wird oder ein Vorgang mit Fehlern abgeschlossen wird.

Vor der Konfiguration des Connectors müssen die Microsoft Teams-Voraussetzungen erfüllt werden. Diese erfordern eine Azure App-Registrierung in Microsoft Entra ID.

Entwurfsmuster

Der Studio-Vorgang folgt dem Transformationsmuster:

Die Quellaktivität stellt die Daten bereit, die zum Erstellen der Nachricht verwendet werden (z. B. ein Datenbankabfrageergebnis, ein Salesforce-Datensatz oder eine Skriptausgabe). Die Transformation konstruiert den Nachrichtentext. Die Microsoft Teams-Aktivität Send Message postet die Nachricht an das ausgewählte Team und den ausgewählten Kanal.

Teil 1: Voraussetzungen erfüllen

Der Microsoft Teams-Connector authentifiziert sich mit OAuth 2.0, was eine App-Registrierung in Microsoft Entra ID (ehemals Azure Active Directory) erfordert.

Führen Sie die Schritte in den Microsoft Teams-Voraussetzungen durch, um:

1. Eine Anwendung im Microsoft Entra ID Portal zu registrieren und die Application (client) ID und Directory (tenant) ID zu notieren.

2. Ein Client-Secret für die Anwendung zu erstellen und dessen Wert zu notieren. Der Wert ist nur bei der ersten Erstellung sichtbar.

3. Die erforderlichen Microsoft Graph API-Berechtigungen zu erteilen und auf Grant admin consent zu klicken.

Halten Sie die Tenant ID, Client ID, den Client Secret-Wert sowie Ihren Microsoft Entra ID-Benutzernamen und Ihr Passwort für die Verbindungskonfiguration bereit.

Teil 2: Die Microsoft Teams-Verbindung konfigurieren

1. Öffnen Sie in Studio Ihr Projekt und klicken Sie auf die Registerkarte Project endpoints and connectors in der Design-Komponentenpalette.

2. Klicken Sie auf den Microsoft Teams-Connector, um die Verbindungskonfiguration zu öffnen.

3. Connection Name: Geben Sie einen Namen wie Microsoft Teams ein.

4. Tenant ID: Geben Sie die Directory (tenant) ID aus Ihrer Microsoft Entra ID-App-Registrierung ein.

5. Client ID: Geben Sie die Application (client) ID aus Ihrer App-Registrierung ein.

6. Client Secret: Geben Sie den Client Secret-Wert aus Ihrer App-Registrierung ein.

   Tipp

   Speichern Sie das Client Secret, den Benutzernamen und das Passwort als Projektvariablen mit versteckten Werten. Dies hält sensible Anmeldedaten aus der Verbindungskonfiguration heraus und macht sie leichter zu wechseln, ohne das Projekt zu bearbeiten.

7. Username: Geben Sie den Benutzernamen ein, den Sie für die Anmeldung bei Microsoft Entra ID verwenden.

8. Password: Geben Sie das Passwort für dieses Konto ein.

9. Klicken Sie auf Test und dann auf Save Changes.

Teil 3: Die Send Message-Aktivität konfigurieren

1. Erweitern Sie in der Design-Komponentenpalette den Microsoft Teams-Endpunkt und ziehen Sie den Aktivitätstyp Send Message auf die Design-Canvas.

2. Doppelklicken Sie auf die Aktivität, um die Konfiguration zu öffnen.

Schritt 1: Einen Namen eingeben und ein Team auswählen

1. Name: Geben Sie einen Namen wie Post Teams Notification ein.

2. Klicken Sie in der Tabelle Select a Team auf eine Zeile, um das Team auszuwählen, das den Zielkanal enthält. Die Tabelle wird vom Microsoft Teams-Endpunkt gefüllt. Wenn die Tabelle leer ist, überprüfen Sie, ob der Verbindungstest erfolgreich war.

3. Klicken Sie auf Weiter.

Schritt 2: Wählen Sie einen Kanal aus

1. Klicken Sie in der Tabelle Kanal auswählen auf eine Zeile, um den Kanal auszuwählen, auf dem gepostet werden soll. Die Tabelle zeigt Kanäle für das Team, das im vorherigen Schritt ausgewählt wurde.

2. Optionale Einstellungen: Wenn Sie HTML-formatierte Nachrichten statt Nur-Text senden möchten, erweitern Sie Optionale Einstellungen und wählen Sie Inhaltstyp: 'HTML'.

3. Klicken Sie auf Weiter.

Schritt 3: Überprüfen Sie die Datenschemas

Der Connector generiert Request- und Response-Schemas vom Microsoft Teams-Endpunkt. Überprüfen Sie diese und klicken Sie auf Fertig.

Das Request-Schema enthält die folgenden Felder unter sendMessageRequest:

• message: Der Textinhalt der Nachricht. Erforderlich.
• contentType: Der Inhaltstyp der Nachricht. Dieses Feld wird automatisch basierend auf der Einstellung Inhaltstyp: 'HTML' aus dem vorherigen Schritt gefüllt.
• attachment: Ein optionales Objekt zum Anhängen einer Datei mit den Feldern fileName und fileData. Dateien größer als 4 MB führen zum Fehler des Vorgangs.

Teil 4: Ordnen Sie die Nachricht in einer Transformation zu

Ordnen Sie in der Transformation, die der Aktivität Nachricht senden vorausgeht, das Feld message des Request-Schemas einem Skript zu, das die Nachrichtenzeichenfolge erstellt.

Um beispielsweise eine Benachrichtigung über eine neue Bestellung zu senden, könnte das Transformationsskript für sendMessageRequest/message wie folgt aussehen:

<trans>
"New order #" + $order_id + " received from " + $customer_name + " for $" + $order_total
</trans>

Dabei sind order_id, customer_name und order_total globale Variablen, die durch ein vorheriges Skript gefüllt oder aus der Quellaktivität zugeordnet werden.

Überprüfen Sie die Integration

Stellen Sie den Vorgang bereit und führen Sie ihn aus, um die Benachrichtigung zu testen. Überprüfen Sie die Vorgangsprotokolle, um zu bestätigen, dass die Aktivität Nachricht senden ohne Fehler abgeschlossen wurde. Wenn die Nachricht nicht im Teams-Kanal angezeigt wird, überprüfen Sie, dass das richtige Team und der richtige Kanal in der Aktivitätskonfiguration ausgewählt wurden und dass die Administratorgenehmigung für alle erforderlichen API-Berechtigungen erteilt wurde.