Yammer Connector
Installation und Konfiguration
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Installation
Vor der Installation des Yammer Connector Plugins muss sichergestellt werden, dass der Mindbreeze Server bereits installiert ist und dieser Connector auch in der Mindbreeze Lizenz inkludiert ist.
Registrierung einer Mindbreeze App in Yammer
Damit der Mindbreeze Yammer Connector auf Yammer Inhalte zugreifen kann, muss zuerst in Yammer eine Mindbreeze Application registriert werden. Grundsätzlich kann jeder Yammer Benutzer Applications registrieren. Es werden jedoch nur Inhalte indiziert, die der Yammer Benutzer sehen kann. Es wird empfohlen, einen eigenen Yammer Benutzer für die Mindbreeze Indizierung anzulegen. Dieser Benutzer muss dann in allen Yammer Gruppen hinzugefügt werden, welche bei der Indizierung von Interesse sind. Das Ergebnis der Registrierung ist ein Authorization Token, mit dem anschließend der Mindbreeze Yammer Connector konfiguriert wird.
Sie können die Registrierung einer Mindbreeze Application wie folgt vornehmen:
- Navigieren Sie mit einem Webbrowser zu https://www.yammer.com/client_applications
- Stellen Sie sicher, dass Sie mit dem für die Indizierung vorgesehenen Benutzer angemeldet sind.
- Klicken Sie auf „Register New App“ und füllen Sie das Formular aus. Z.B.
Application Name | mindbreeze-inspire |
Organization | mycompany |
Support e-mail | support@mycompany.com |
Website | https://www.mycompany.com |
Redirect URI | http://localhost/yammerredirect |
Es ist wichtig, dass Sie bei „Redirect URI“ http://localhost/yammerredirect wählen, dadurch kann der Authorization Token leichter abgerufen werden.
Klicken Sie auf „Continue“. Prüfen Sie, ob die Daten korrekt übernommen wurden.
- Klicken Sie auf den Link „Generate a developer token for this application” unterhalb der Daten der neuen Application.
- Jetzt werden die Felder „Client ID“, „Client Secret“ und „Expected redirect“ angezeigt.
- Im Webbrowser, navigieren Sie zur URL https://www.yammer.com/oauth2/authorize?client_id={{myClientId}}&response_type=code&redirect_uri=http://localhost/yammerredirect wobei Sie {{myClientId}} mit Ihrer konkreten „Client ID“ ersetzen.
- Der Webbrowser leitet Sie weiter auf localhost und zeigt eine Fehlermeldung an (Connection Refused). Die Adressleiste des Webbrowsers zeigt eine URL in folgender Form an: http://localhost/yammerredirect?code={{my-auth-code}} wobei {{my-auth-code}} Ihrem konkreten Autorisierungs-Code entspricht.
- Navigieren Sie nun zur URL https://www.yammer.com/oauth2/access_token.json?client_id={{myClientId}}&client_secret={{myClientSecret}}&code={{myAuthorizationCode}} wobei Sie {{myClientId}} mit Ihrer konkreten „Client ID“ ersetzen, {{myClientSecret}} mit Ihrem konkreten „Client Secret“ ersetzen und {{myAuthorizationCode}} mit Ihrem konkreten Autorisierungs-Code ersetzen, welchen Sie im letzten Schritt bekommen haben.
- Der Webbrowser sollte nun ein JSON anzeigen. Unter access_token -> token finden Sie den Autorisierungs-Token. Dieser Token ist unbegrenzt gültig und wird für die Konfiguration des Mindbreeze Yammer Connectors verwendet. (Siehe Abschnitt „Konfigurationsoptionen“)
Konfigurationsoptionen
Crawler
General Settings
Option | Beschreibung |
Authorization Token | Token, welches bei der App Registrierung erstellt wurde (Siehe Abschnitt „Registrierung einer Mindbreeze App in Yammer“) |
Disable Message Title | Wenn aktiviert, werden für Message-(Posts-)Dokumente keine Titel gesetzt. Falls der Titel nicht benötigt wird, kann dies die Suchrelevanz im Vergleich zu anderen Datenquellen verbessern. |
Max File Size (MB) | Bestimmt die maximale Größe von Dokumenten (in MB), die indiziert werden. Dies betrifft Dokumente vom Typ „Attachment“. Zu große Attachments werden übersprungen. |
Full Crawl Page Size Time Span (Days) | Zum Herunterladen der Threads wird die Yammer Export API verwendet, bei der eine Zeitspanne angegeben werden kann, in welchem Zeitraum die exportierten Messages / Threads erstellt worden sind. Mit dieser Option kann die Anzahl der Tage für diese Zeitspanne konfiguriert werden. |
Include Creator Metadata For Groups | Wenn Name und E-Mail-Adresse der Ersteller der Yammer Gruppen als Metadatum indiziert werden soll. Standardmäßig aktiv. Kann zu leichten Performanceverbesserungen beim Indizieren der Gruppen führen, wenn diese Option deaktiviert wird. |
Messages Since (ISO 8601) | Messages, die älter als das konfigurierte Datum sind, werden nicht indiziert. Das konfigurierte Datum muss im ISO 8601 Format (mit Zeitzone) sein, z.B. 2010-01-01T00:00:00+00:00 |
Read Timeout Minutes | Zeit in Minuten, wie lange der Crawler maximal auf API-Antworten wartet. |
Log Paging Requests To CSV | Wenn aktiviert, werden alle API-Anfragen an Yammer, die Paging verwenden, in einer separaten .csv-Log-Datei protokolliert. Diese Option sollte nur zur Fehlerbehebung im Problemfall verwendet werden. |
Delta Crawling
Enable Delta Crawling | Wenn aktiv, werden bei einem Crawl-Run nur mehr neue Nachrichten (inklusive Anhänge) aus Yammer indiziert. Gruppen werden jedoch weiterhin vollständig gecrawled. Beachten Sie, dass gelöschte Nachrichten bei einem Delta-Crawl-Run nicht erkannt werden können. Bitte stellen Sie sicher, dass Sie einen „Full Crawl Schedule“ aktivieren, damit auch gelöschte Nachrichten behandelt werden. |
Full Crawl Schedule | Wenn die eingetragene Extended Cron Expression getriggert wird, wird beim nächsten Crawl-Run ein Full Crawl-Run durchgeführt (anstatt eines Delta Crawl-Runs). Nur effektiv, wenn „Enable Delta Crawling“ aktiv ist. Eine Dokumentation und Beispiele zu Cron Expressions finden Sie hier. |
SharePoint Online Reference Settings (Advanced Settings)
Die folgenden Optionen können verwendet werden, wenn Sie den SharePoint Online Connector für die Indizierung von in SharePoint Online gespeicherten Anhängen verwenden möchten und nicht den Yammer Connector. Der Yammer Connector setzt dann nur Referenzen von den Yammer-Nachrichten auf die Anhänge.
Um diese Optionen zu verwenden, müssen Sie den Yammer Konnektor im selben Index wie Ihren SharePoint Online Konnektor einrichten.
Die Basis-URL Ihrer SharePoint Online Instanz, z.B. https://mycompany.sharepoint.com | |
Azure AD Endpoint | Die Azure AD Login URL. Diese Option muss nur geändert werden, wenn Sie eine National Cloud verwenden: |
App Only Credentials | Die Client Id und Client Secret der App in SharePoint Online. Erzeugen Sie hierfür ein Credential im Network Tab des Typs OAuth2. Für das Credential sind nur Client ID und Client Secret notwendig. Für Information, wie Sie die App in SharePoint Online erstellen, wenden Sie sich an die Microsoft SharePoint Online Konnektor Dokumentation. User Based Authentication wird für dieses Feature nicht unterstützt. |
SharePoint Online Category Instance | Die Category Instance ihres SharePoint Online Crawlers, der die angehängten Dateien in SharePoint Online indiziert. |
Principal Resolution Service
Option | Beschreibung |
Authorization Token | Token, welches bei der App Registrierung erstellt wurde (Siehe Abschnitt „Registrierung einer Mindbreeze App in Yammer“) |
Troubleshooting
403 Forbidden
Falls Sie im Crawler oder Principal-Resolution-Service-Log Fehler dieser Art bemerken:
Error on requesting url: 'https://www.yammer.com/api/v1/groups/123456/members.json' status: 403 responseContent: 'Forbidden'
Dann deutet dies auf ein Berechtigungsproblem mit dem für das Crawling verwendeten Yammer-Benutzer hin. Eine mögliche Lösung für dieses Problem besteht darin, den "Content Mode" zu ändern. Navigieren Sie dazu in Yammer unter „Edit network admin settings“ zu den „Network Admin“ Einstellungen und anschließend unter „Content and Security“ zu „Content Mode“. Wählen Sie „Private Content Mode“ aus. Dies ermöglicht dem Crawler auf alle notwendigen APIs zuzugreifen, damit beispielsweise Benutzergruppen und Berechtigungen korrekt abgebildet werden können. Wiederholen Sie den Crawl-Run, es sollten nun keine „403 Forbidden“ Fehler mehr auftreten.
Wichtiger Hinweis: Der Mindbreeze Yammer Connector indiziert grundsätzlich keine privaten Yammer Messages (Unabhängig von der Einstellung „Content and Security“). Alle Messages werden geprüft, private Messages werden explizit ignoriert und nicht Indiziert.